Class: Tinkerforge::BrickletIO16V2
- Defined in:
- lib/tinkerforge/bricklet_io16_v2.rb
Overview
16-channel digital input/output
Constant Summary collapse
- DEVICE_IDENTIFIER =
:nodoc:
2114
- DEVICE_DISPLAY_NAME =
:nodoc:
'IO-16 Bricklet 2.0'
- CALLBACK_INPUT_VALUE =
This callback is triggered periodically according to the configuration set by BrickletIO16V2#set_input_value_callback_configuration.
The parameters are the channel, a value-changed indicator and the actual value for the channel. The ‘changed` parameter is true if the value has changed since the last callback.
15
- CALLBACK_ALL_INPUT_VALUE =
This callback is triggered periodically according to the configuration set by BrickletIO16V2#set_all_input_value_callback_configuration.
The parameters are the same as BrickletIO16V2#get_value. Additional the ‘changed` parameter is true if the value has changed since the last callback.
16
- CALLBACK_MONOFLOP_DONE =
This callback is triggered whenever a monoflop timer reaches 0. The parameters contain the channel and the current value of the channel (the value after the monoflop).
17
- FUNCTION_SET_VALUE =
:nodoc:
1
- FUNCTION_GET_VALUE =
:nodoc:
2
- FUNCTION_SET_SELECTED_VALUE =
:nodoc:
3
- FUNCTION_SET_CONFIGURATION =
:nodoc:
4
- FUNCTION_GET_CONFIGURATION =
:nodoc:
5
- FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION =
:nodoc:
6
- FUNCTION_GET_INPUT_VALUE_CALLBACK_CONFIGURATION =
:nodoc:
7
- FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION =
:nodoc:
8
- FUNCTION_GET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION =
:nodoc:
9
- FUNCTION_SET_MONOFLOP =
:nodoc:
10
- FUNCTION_GET_MONOFLOP =
:nodoc:
11
- FUNCTION_GET_EDGE_COUNT =
:nodoc:
12
- FUNCTION_SET_EDGE_COUNT_CONFIGURATION =
:nodoc:
13
- FUNCTION_GET_EDGE_COUNT_CONFIGURATION =
:nodoc:
14
- FUNCTION_GET_SPITFP_ERROR_COUNT =
:nodoc:
234
- FUNCTION_SET_BOOTLOADER_MODE =
:nodoc:
235
- FUNCTION_GET_BOOTLOADER_MODE =
:nodoc:
236
- FUNCTION_SET_WRITE_FIRMWARE_POINTER =
:nodoc:
237
- FUNCTION_WRITE_FIRMWARE =
:nodoc:
238
- FUNCTION_SET_STATUS_LED_CONFIG =
:nodoc:
239
- FUNCTION_GET_STATUS_LED_CONFIG =
:nodoc:
240
- FUNCTION_GET_CHIP_TEMPERATURE =
:nodoc:
242
- FUNCTION_RESET =
:nodoc:
243
- FUNCTION_WRITE_UID =
:nodoc:
248
- FUNCTION_READ_UID =
:nodoc:
249
- FUNCTION_GET_IDENTITY =
:nodoc:
255
- DIRECTION_IN =
:nodoc:
'i'
- DIRECTION_OUT =
:nodoc:
'o'
- EDGE_TYPE_RISING =
:nodoc:
0
- EDGE_TYPE_FALLING =
:nodoc:
1
- EDGE_TYPE_BOTH =
:nodoc:
2
- BOOTLOADER_MODE_BOOTLOADER =
:nodoc:
0
- BOOTLOADER_MODE_FIRMWARE =
:nodoc:
1
- BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT =
:nodoc:
2
- BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT =
:nodoc:
3
- BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT =
:nodoc:
4
- BOOTLOADER_STATUS_OK =
:nodoc:
0
- BOOTLOADER_STATUS_INVALID_MODE =
:nodoc:
1
- BOOTLOADER_STATUS_NO_CHANGE =
:nodoc:
2
- BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT =
:nodoc:
3
- BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT =
:nodoc:
4
- BOOTLOADER_STATUS_CRC_MISMATCH =
:nodoc:
5
- STATUS_LED_CONFIG_OFF =
:nodoc:
0
- STATUS_LED_CONFIG_ON =
:nodoc:
1
- STATUS_LED_CONFIG_SHOW_HEARTBEAT =
:nodoc:
2
- STATUS_LED_CONFIG_SHOW_STATUS =
:nodoc:
3
Constants inherited from Device
Device::DEVICE_IDENTIFIER_CHECK_MATCH, Device::DEVICE_IDENTIFIER_CHECK_MISMATCH, Device::DEVICE_IDENTIFIER_CHECK_PENDING, 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, #high_level_callbacks, #registered_callbacks, #replaced, #uid
Instance Method Summary collapse
-
#get_all_input_value_callback_configuration ⇒ Object
Returns the callback configuration as set by BrickletIO16V2#set_all_input_value_callback_configuration.
-
#get_bootloader_mode ⇒ Object
Returns the current bootloader mode, see BrickletIO16V2#set_bootloader_mode.
-
#get_chip_temperature ⇒ Object
Returns the temperature as measured inside the microcontroller.
-
#get_configuration(channel) ⇒ Object
Returns the channel configuration as set by BrickletIO16V2#set_configuration.
-
#get_edge_count(channel, reset_counter) ⇒ Object
Returns the current value of the edge counter for the selected channel.
-
#get_edge_count_configuration(channel) ⇒ Object
Returns the edge type and debounce time for the selected channel as set by BrickletIO16V2#set_edge_count_configuration.
-
#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.
-
#get_input_value_callback_configuration(channel) ⇒ Object
Returns the callback configuration as set by BrickletIO16V2#set_input_value_callback_configuration.
-
#get_monoflop(channel) ⇒ Object
Returns (for the given channel) the current value and the time as set by BrickletIO16V2#set_monoflop as well as the remaining time until the value flips.
-
#get_spitfp_error_count ⇒ Object
Returns the error count for the communication between Brick and Bricklet.
-
#get_status_led_config ⇒ Object
Returns the configuration as set by BrickletIO16V2#set_status_led_config.
-
#get_value ⇒ Object
Returns the logic levels that are currently measured on the channels.
-
#initialize(uid, ipcon) ⇒ BrickletIO16V2
constructor
Creates an object with the unique device ID
uid
and adds it to the IP Connectionipcon
. -
#read_uid ⇒ Object
Returns the current UID as an integer.
-
#register_callback(id, &block) ⇒ Object
Registers a callback with ID
id
to the blockblock
. -
#reset ⇒ Object
Calling this function will reset the Bricklet.
-
#set_all_input_value_callback_configuration(period, value_has_to_change) ⇒ Object
The period is the period with which the CALLBACK_ALL_INPUT_VALUE callback is triggered periodically.
-
#set_bootloader_mode(mode) ⇒ Object
Sets the bootloader mode and returns the status after the requested mode change was instigated.
-
#set_configuration(channel, direction, value) ⇒ Object
Configures the value and direction of a specific channel.
-
#set_edge_count_configuration(channel, edge_type, debounce) ⇒ Object
Configures the edge counter for a specific channel.
-
#set_input_value_callback_configuration(channel, period, value_has_to_change) ⇒ Object
This callback can be configured per channel.
-
#set_monoflop(channel, value, time) ⇒ Object
Configures a monoflop of the specified channel.
-
#set_selected_value(channel, value) ⇒ Object
Sets the output value of a specific channel without affecting the other channels.
-
#set_status_led_config(config) ⇒ Object
Sets the status LED configuration.
-
#set_value(value) ⇒ Object
Sets the output value of all sixteen channels.
-
#set_write_firmware_pointer(pointer) ⇒ Object
Sets the firmware pointer for BrickletIO16V2#write_firmware.
-
#write_firmware(data) ⇒ Object
Writes 64 Bytes of firmware at the position as written by BrickletIO16V2#set_write_firmware_pointer before.
-
#write_uid(uid) ⇒ Object
Writes a new UID into flash.
Methods inherited from Device
#check_validity, #dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all
Constructor Details
#initialize(uid, ipcon) ⇒ BrickletIO16V2
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
Instance Method Details
#get_all_input_value_callback_configuration ⇒ Object
Returns the callback configuration as set by BrickletIO16V2#set_all_input_value_callback_configuration.
245 246 247 248 249 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 245 def get_all_input_value_callback_configuration check_validity send_request FUNCTION_GET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION, [], '', 13, 'L ?' end |
#get_bootloader_mode ⇒ Object
Returns the current bootloader mode, see BrickletIO16V2#set_bootloader_mode.
356 357 358 359 360 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 356 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C' end |
#get_chip_temperature ⇒ Object
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!
The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.
414 415 416 417 418 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 414 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' end |
#get_configuration(channel) ⇒ Object
Returns the channel configuration as set by BrickletIO16V2#set_configuration.
197 198 199 200 201 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 197 def get_configuration(channel) check_validity send_request FUNCTION_GET_CONFIGURATION, [channel], 'C', 10, 'k ?' end |
#get_edge_count(channel, reset_counter) ⇒ Object
Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with BrickletIO16V2#set_edge_count_configuration.
If you set the reset counter to true, the count is set back to 0 directly after it is read.
290 291 292 293 294 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 290 def get_edge_count(channel, reset_counter) check_validity send_request FUNCTION_GET_EDGE_COUNT, [channel, reset_counter], 'C ?', 12, 'L' end |
#get_edge_count_configuration(channel) ⇒ Object
Returns the edge type and debounce time for the selected channel as set by BrickletIO16V2#set_edge_count_configuration.
317 318 319 320 321 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 317 def get_edge_count_configuration(channel) check_validity send_request FUNCTION_GET_EDGE_COUNT_CONFIGURATION, [channel], 'C', 10, 'C C' 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’, ‘d’, ‘e’, ‘f’, ‘g’ or ‘h’ (Bricklet Port). A Bricklet connected to an :ref:‘Isolator Bricklet <isolator_bricklet>` is always at position ’z’.
The device identifier numbers can be found :ref:‘here <device_identifier>`. |device_identifier_constant|
461 462 463 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 461 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end |
#get_input_value_callback_configuration(channel) ⇒ Object
Returns the callback configuration as set by BrickletIO16V2#set_input_value_callback_configuration.
222 223 224 225 226 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 222 def get_input_value_callback_configuration(channel) check_validity send_request FUNCTION_GET_INPUT_VALUE_CALLBACK_CONFIGURATION, [channel], 'C', 13, 'L ?' end |
#get_monoflop(channel) ⇒ Object
Returns (for the given channel) the current value and the time as set by BrickletIO16V2#set_monoflop as well as the remaining time until the value flips.
If the timer is not running currently, the remaining time will be returned as 0.
279 280 281 282 283 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 279 def get_monoflop(channel) check_validity send_request FUNCTION_GET_MONOFLOP, [channel], 'C', 17, '? L L' end |
#get_spitfp_error_count ⇒ Object
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
-
ACK checksum errors,
-
message checksum errors,
-
framing errors and
-
overflow errors.
The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.
334 335 336 337 338 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 334 def get_spitfp_error_count check_validity send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L' end |
#get_status_led_config ⇒ Object
Returns the configuration as set by BrickletIO16V2#set_status_led_config
402 403 404 405 406 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 402 def get_status_led_config check_validity send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C' end |
#get_value ⇒ Object
Returns the logic levels that are currently measured on the channels. This function works if the channel is configured as input as well as if it is configured as output.
152 153 154 155 156 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 152 def get_value check_validity send_request FUNCTION_GET_VALUE, [], '', 10, '?16' end |
#read_uid ⇒ Object
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
445 446 447 448 449 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 445 def read_uid check_validity send_request FUNCTION_READ_UID, [], '', 12, 'L' end |
#register_callback(id, &block) ⇒ Object
Registers a callback with ID id
to the block block
.
466 467 468 469 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 466 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end |
#reset ⇒ Object
Calling this function will reset the Bricklet. All configurations will be lost.
After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!
426 427 428 429 430 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 426 def reset check_validity send_request FUNCTION_RESET, [], '', 8, '' end |
#set_all_input_value_callback_configuration(period, value_has_to_change) ⇒ Object
The period is the period with which the CALLBACK_ALL_INPUT_VALUE callback is triggered periodically. A value of 0 turns the callback off.
If the ‘value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn’t change within the period, the callback is triggered immediately on change.
If it is set to false, the callback is continuously triggered with the period, independent of the value.
237 238 239 240 241 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 237 def set_all_input_value_callback_configuration(period, value_has_to_change) check_validity send_request FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, '' end |
#set_bootloader_mode(mode) ⇒ Object
Sets the bootloader mode and returns the status after the requested mode change was instigated.
You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
349 350 351 352 353 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 349 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end |
#set_configuration(channel, direction, value) ⇒ Object
Configures the value and direction of a specific channel. Possible directions are ‘i’ and ‘o’ for input and output.
If the direction is configured as output, the value is either high or low (set as true or false).
If the direction is configured as input, the value is either pull-up or default (set as true or false).
For example:
-
(0, ‘i’, true) will set channel-0 as input pull-up.
-
(1, ‘i’, false) will set channel-1 as input default (floating if nothing is connected).
-
(2, ‘o’, true) will set channel-2 as output high.
-
(3, ‘o’, false) will set channel-3 as output low.
A running monoflop timer for the specific channel will be aborted if this function is called.
190 191 192 193 194 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 190 def set_configuration(channel, direction, value) check_validity send_request FUNCTION_SET_CONFIGURATION, [channel, direction, value], 'C k ?', 8, '' end |
#set_edge_count_configuration(channel, edge_type, debounce) ⇒ Object
Configures the edge counter for a specific channel.
The edge type parameter configures if rising edges, falling edges or both are counted if the channel is configured for input. Possible edge types are:
-
0 = rising
-
1 = falling
-
2 = both
Configuring an edge counter resets its value to 0.
If you don’t know what any of this means, just leave it at default. The default configuration is very likely OK for you.
309 310 311 312 313 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 309 def set_edge_count_configuration(channel, edge_type, debounce) check_validity send_request FUNCTION_SET_EDGE_COUNT_CONFIGURATION, [channel, edge_type, debounce], 'C C C', 8, '' end |
#set_input_value_callback_configuration(channel, period, value_has_to_change) ⇒ Object
This callback can be configured per channel.
The period is the period with which the CALLBACK_INPUT_VALUE callback is triggered periodically. A value of 0 turns the callback off.
If the ‘value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn’t change within the period, the callback is triggered immediately on change.
If it is set to false, the callback is continuously triggered with the period, independent of the value.
214 215 216 217 218 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 214 def set_input_value_callback_configuration(channel, period, value_has_to_change) check_validity send_request FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION, [channel, period, value_has_to_change], 'C L ?', 8, '' end |
#set_monoflop(channel, value, time) ⇒ Object
Configures a monoflop of the specified channel.
The second parameter is the desired value of the specified channel. A true means relay closed and a false means relay open.
The third parameter indicates the time that the channels should hold the value.
If this function is called with the parameters (0, 1, 1500) channel 0 will close and in 1.5s channel 0 will open again
A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a IO-16 Bricklet 2.0 connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and channel 0 closed. Channel 0 will be closed all the time. If now the RS485 connection is lost, then channel 0 will be opened in at most two seconds.
268 269 270 271 272 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 268 def set_monoflop(channel, value, time) check_validity send_request FUNCTION_SET_MONOFLOP, [channel, value, time], 'C ? L', 8, '' end |
#set_selected_value(channel, value) ⇒ Object
Sets the output value of a specific channel without affecting the other channels.
A running monoflop timer for the specific channel will be aborted if this function is called.
- .. note
-
This function does nothing for channels that are configured as input. Pull-up resistors can be switched on with BrickletIO16V2#set_configuration.
166 167 168 169 170 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 166 def set_selected_value(channel, value) check_validity send_request FUNCTION_SET_SELECTED_VALUE, [channel, value], 'C ?', 8, '' end |
#set_status_led_config(config) ⇒ Object
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.
You can also turn the LED permanently on/off or show a heartbeat.
If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
395 396 397 398 399 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 395 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end |
#set_value(value) ⇒ Object
Sets the output value of all sixteen channels. A value of true or false outputs logic 1 or logic 0 respectively on the corresponding channel.
Use BrickletIO16V2#set_selected_value to change only one output channel state.
For example: (True, True, False, False, …, False) will turn the channels 0-1 high and the channels 2-15 low.
All running monoflop timers will be aborted if this function is called.
- .. note
-
This function does nothing for channels that are configured as input. Pull-up resistors can be switched on with BrickletIO16V2#set_configuration.
143 144 145 146 147 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 143 def set_value(value) check_validity send_request FUNCTION_SET_VALUE, [value], '?16', 8, '' end |
#set_write_firmware_pointer(pointer) ⇒ Object
Sets the firmware pointer for BrickletIO16V2#write_firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
368 369 370 371 372 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 368 def set_write_firmware_pointer(pointer) check_validity send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, '' end |
#write_firmware(data) ⇒ Object
Writes 64 Bytes of firmware at the position as written by BrickletIO16V2#set_write_firmware_pointer before. The firmware is written to flash every 4 chunks.
You can only write firmware in bootloader mode.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
382 383 384 385 386 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 382 def write_firmware(data) check_validity send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C' end |
#write_uid(uid) ⇒ Object
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.
We recommend that you use Brick Viewer to change the UID.
437 438 439 440 441 |
# File 'lib/tinkerforge/bricklet_io16_v2.rb', line 437 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end |