Class: Tinkerforge::BrickletCurrent25

Inherits:
Device
  • Object
show all
Defined in:
lib/tinkerforge/bricklet_current25.rb

Overview

Measures AC/DC current between -25A and +25A

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

24
DEVICE_DISPLAY_NAME =

:nodoc:

'Current25 Bricklet'
CALLBACK_CURRENT =

This callback is triggered periodically with the period that is set by BrickletCurrent25#set_current_callback_period. The parameter is the current of the sensor.

CALLBACK_CURRENT is only triggered if the current has changed since the last triggering.

15
CALLBACK_ANALOG_VALUE =

This callback is triggered periodically with the period that is set by BrickletCurrent25#set_analog_value_callback_period. The parameter is the analog value of the sensor.

CALLBACK_ANALOG_VALUE is only triggered if the current has changed since the last triggering.

16
CALLBACK_CURRENT_REACHED =

This callback is triggered when the threshold as set by BrickletCurrent25#set_current_callback_threshold is reached. The parameter is the current of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by BrickletCurrent25#set_debounce_period.

17
CALLBACK_ANALOG_VALUE_REACHED =

This callback is triggered when the threshold as set by BrickletCurrent25#set_analog_value_callback_threshold is reached. The parameter is the analog value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by BrickletCurrent25#set_debounce_period.

18
CALLBACK_OVER_CURRENT =

This callback is triggered when an over current is measured (see BrickletCurrent25#is_over_current).

19
FUNCTION_GET_CURRENT =

:nodoc:

1
FUNCTION_CALIBRATE =

:nodoc:

2
FUNCTION_IS_OVER_CURRENT =

:nodoc:

3
FUNCTION_GET_ANALOG_VALUE =

:nodoc:

4
FUNCTION_SET_CURRENT_CALLBACK_PERIOD =

:nodoc:

5
FUNCTION_GET_CURRENT_CALLBACK_PERIOD =

:nodoc:

6
FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD =

:nodoc:

7
FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD =

:nodoc:

8
FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD =

:nodoc:

9
FUNCTION_GET_CURRENT_CALLBACK_THRESHOLD =

:nodoc:

10
FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD =

:nodoc:

11
FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD =

:nodoc:

12
FUNCTION_SET_DEBOUNCE_PERIOD =

:nodoc:

13
FUNCTION_GET_DEBOUNCE_PERIOD =

:nodoc:

14
FUNCTION_GET_IDENTITY =

:nodoc:

255
THRESHOLD_OPTION_OFF =

:nodoc:

'x'
THRESHOLD_OPTION_OUTSIDE =

:nodoc:

'o'
THRESHOLD_OPTION_INSIDE =

:nodoc:

'i'
THRESHOLD_OPTION_SMALLER =

:nodoc:

'<'
THRESHOLD_OPTION_GREATER =

:nodoc:

'>'

Constants inherited from Device

Device::RESPONSE_EXPECTED_ALWAYS_FALSE, Device::RESPONSE_EXPECTED_ALWAYS_TRUE, Device::RESPONSE_EXPECTED_FALSE, Device::RESPONSE_EXPECTED_INVALID_FUNCTION_ID, Device::RESPONSE_EXPECTED_TRUE

Instance Attribute Summary

Attributes inherited from Device

#callback_formats, #expected_response_function_id, #expected_response_sequence_number, #registered_callbacks, #uid

Instance Method Summary collapse

Methods inherited from Device

#dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletCurrent25

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 78

def initialize(uid, ipcon)
  super uid, ipcon

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_CURRENT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_CALIBRATE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_IS_OVER_CURRENT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CURRENT_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_CURRENT_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_CURRENT_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[CALLBACK_CURRENT] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[CALLBACK_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[CALLBACK_CURRENT_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[CALLBACK_ANALOG_VALUE_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[CALLBACK_OVER_CURRENT] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_CURRENT] = 's'
  @callback_formats[CALLBACK_ANALOG_VALUE] = 'S'
  @callback_formats[CALLBACK_CURRENT_REACHED] = 's'
  @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
  @callback_formats[CALLBACK_OVER_CURRENT] = ''
end

Instance Method Details

#calibrate ⇒ Object

Calibrates the 0 value of the sensor. You have to call this function when there is no current present.

The zero point of the current sensor is depending on the exact properties of the analog-to-digital converter, the length of the Bricklet cable and the temperature. Thus, if you change the Brick or the environment in which the Bricklet is used, you might have to recalibrate.

The resulting calibration will be saved on the EEPROM of the Current Bricklet.



132
133
134
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 132

def calibrate
  send_request(FUNCTION_CALIBRATE, [], '', 0, '')
end

#get_analog_value ⇒ Object

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

.. note

The value returned by BrickletCurrent25#get_current is averaged over several samples to yield less noise, while BrickletCurrent25#get_analog_value gives back raw unfiltered analog values. The only reason to use BrickletCurrent25#get_analog_value is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the callback CALLBACK_ANALOG_VALUE and set the period with BrickletCurrent25#set_analog_value_callback_period.



156
157
158
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 156

def get_analog_value
  send_request(FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S')
end

#get_analog_value_callback_period ⇒ Object

Returns the period as set by BrickletCurrent25#set_analog_value_callback_period.



188
189
190
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 188

def get_analog_value_callback_period
  send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 4, 'L')
end

#get_analog_value_callback_threshold ⇒ Object

Returns the threshold as set by BrickletCurrent25#set_analog_value_callback_threshold.



232
233
234
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 232

def get_analog_value_callback_threshold
  send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 5, 'k S S')
end

#get_current ⇒ Object

Returns the current of the sensor. The value is in mA and between -25000mA and 25000mA.

If you want to get the current periodically, it is recommended to use the callback CALLBACK_CURRENT and set the period with BrickletCurrent25#set_current_callback_period.



117
118
119
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 117

def get_current
  send_request(FUNCTION_GET_CURRENT, [], '', 2, 's')
end

#get_current_callback_period ⇒ Object

Returns the period as set by BrickletCurrent25#set_current_callback_period.



172
173
174
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 172

def get_current_callback_period
  send_request(FUNCTION_GET_CURRENT_CALLBACK_PERIOD, [], '', 4, 'L')
end

#get_current_callback_threshold ⇒ Object

Returns the threshold as set by BrickletCurrent25#set_current_callback_threshold.



210
211
212
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 210

def get_current_callback_threshold
  send_request(FUNCTION_GET_CURRENT_CALLBACK_THRESHOLD, [], '', 5, 'k s s')
end

#get_debounce_period ⇒ Object

Returns the debounce period as set by BrickletCurrent25#set_debounce_period.



254
255
256
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 254

def get_debounce_period
  send_request(FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L')
end

#get_identity ⇒ Object

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be ‘a’, ‘b’, ‘c’ or ‘d’.

The device identifier numbers can be found :ref:‘here <device_identifier>`. |device_identifier_constant|



266
267
268
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 266

def get_identity
  send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
end

#is_over_current ⇒ Object

Returns true if more than 25A were measured.

.. note

To reset this value you have to power cycle the Bricklet.



140
141
142
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 140

def is_over_current
  send_request(FUNCTION_IS_OVER_CURRENT, [], '', 1, '?')
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



271
272
273
274
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 271

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#set_analog_value_callback_period(period) ⇒ Object

Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered periodically. A value of 0 turns the callback off.

CALLBACK_ANALOG_VALUE is only triggered if the analog value has changed since the last triggering.

The default value is 0.



183
184
185
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 183

def set_analog_value_callback_period(period)
  send_request(FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD, [period], 'L', 0, '')
end

#set_analog_value_callback_threshold(option, min, max) ⇒ Object

Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.

The following options are possible:

"Option", "Description"

"'x'",    "Callback is turned off"
"'o'",    "Callback is triggered when the analog value is *outside* the min and max values"
"'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
"'<'",    "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
"'>'",    "Callback is triggered when the analog value is greater than the min value (max is ignored)"

The default value is (‘x’, 0, 0).



227
228
229
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 227

def set_analog_value_callback_threshold(option, min, max)
  send_request(FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, '')
end

#set_current_callback_period(period) ⇒ Object

Sets the period in ms with which the CALLBACK_CURRENT callback is triggered periodically. A value of 0 turns the callback off.

CALLBACK_CURRENT is only triggered if the current has changed since the last triggering.

The default value is 0.



167
168
169
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 167

def set_current_callback_period(period)
  send_request(FUNCTION_SET_CURRENT_CALLBACK_PERIOD, [period], 'L', 0, '')
end

#set_current_callback_threshold(option, min, max) ⇒ Object

Sets the thresholds for the CALLBACK_CURRENT_REACHED callback.

The following options are possible:

"Option", "Description"

"'x'",    "Callback is turned off"
"'o'",    "Callback is triggered when the current is *outside* the min and max values"
"'i'",    "Callback is triggered when the current is *inside* the min and max values"
"'<'",    "Callback is triggered when the current is smaller than the min value (max is ignored)"
"'>'",    "Callback is triggered when the current is greater than the min value (max is ignored)"

The default value is (‘x’, 0, 0).



205
206
207
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 205

def set_current_callback_threshold(option, min, max)
  send_request(FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 0, '')
end

#set_debounce_period(debounce) ⇒ Object

Sets the period in ms with which the threshold callbacks

  • CALLBACK_CURRENT_REACHED,

  • CALLBACK_ANALOG_VALUE_REACHED

are triggered, if the thresholds

  • BrickletCurrent25#set_current_callback_threshold,

  • BrickletCurrent25#set_analog_value_callback_threshold

keep being reached.

The default value is 100.



249
250
251
 
# File 'lib/tinkerforge/bricklet_current25.rb', line 249

def set_debounce_period(debounce)
  send_request(FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, '')
end