class Tinkerforge::BrickletIndustrialDigitalIn4V2
4 galvanically isolated digital inputs
Constants
- CALLBACK_ALL_VALUE
This callback is triggered periodically according to the configuration set by
BrickletIndustrialDigitalIn4V2#set_all_value_callback_configuration
.The parameters are the same as
BrickletIndustrialDigitalIn4V2#get_value
. Additional the `changed` parameter is true if the value has changed since the last callback.- CALLBACK_VALUE
This callback is triggered periodically according to the configuration set by
BrickletIndustrialDigitalIn4V2#set_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.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 87 def initialize(uid, ipcon) super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME @api_version = [2, 0, 0] @response_expected[FUNCTION_GET_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_VALUE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_ALL_VALUE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_EDGE_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_EDGE_COUNT_CONFIGURATION] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_EDGE_COUNT_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_CHANNEL_LED_CONFIG] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_CHANNEL_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE @callback_formats[CALLBACK_VALUE] = [11, 'C ? ?'] @callback_formats[CALLBACK_ALL_VALUE] = [10, '?4 ?4'] @ipcon.add_device self end
Public Instance Methods
Returns the callback configuration as set by BrickletIndustrialDigitalIn4V2#set_all_value_callback_configuration
.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 170 def get_all_value_callback_configuration check_validity send_request FUNCTION_GET_ALL_VALUE_CALLBACK_CONFIGURATION, [], '', 13, 'L ?' end
Returns the current bootloader mode, see BrickletIndustrialDigitalIn4V2#set_bootloader_mode
.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 265 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C' end
Returns the channel LED configuration as set by BrickletIndustrialDigitalIn4V2#set_channel_led_config
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 226 def get_channel_led_config(channel) check_validity send_request FUNCTION_GET_CHANNEL_LED_CONFIG, [channel], 'C', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 323 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' end
Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with BrickletIndustrialDigitalIn4V2#set_edge_count_configuration
.
If you set the reset counter to true, the count is set back to 0 directly after it is read.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 181 def get_edge_count(channel, reset_counter) check_validity send_request FUNCTION_GET_EDGE_COUNT, [channel, reset_counter], 'C ?', 12, 'L' end
Returns the edge type and debounce time for the selected channel as set by BrickletIndustrialDigitalIn4V2#set_edge_count_configuration
.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 208 def get_edge_count_configuration(channel) check_validity send_request FUNCTION_GET_EDGE_COUNT_CONFIGURATION, [channel], 'C', 10, 'C C' end
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|
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 370 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
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.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 243 def get_spitfp_error_count check_validity send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L' end
Returns the configuration as set by BrickletIndustrialDigitalIn4V2#set_status_led_config
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 311 def get_status_led_config check_validity send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C' end
Returns the input value as bools, true refers to high and false refers to low.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 122 def get_value check_validity send_request FUNCTION_GET_VALUE, [], '', 9, '?4' end
Returns the callback configuration for the given channel as set by BrickletIndustrialDigitalIn4V2#set_value_callback_configuration
.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 147 def get_value_callback_configuration(channel) check_validity send_request FUNCTION_GET_VALUE_CALLBACK_CONFIGURATION, [channel], 'C', 13, 'L ?' end
Returns the current UID as an integer. Encode as Base58
to get the usual string version.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 354 def read_uid check_validity send_request FUNCTION_READ_UID, [], '', 12, 'L' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 375 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
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!
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 335 def reset check_validity send_request FUNCTION_RESET, [], '', 8, '' end
The period is the period with which the CALLBACK_ALL_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.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 162 def set_all_value_callback_configuration(period, value_has_to_change) check_validity send_request FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, '' end
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.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 258 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end
Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to “Channel Status”. In this mode the LED is on if the channel is high and off otherwise.
By default all channel LEDs are configured as “Channel Status”.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 219 def set_channel_led_config(channel, config) check_validity send_request FUNCTION_SET_CHANNEL_LED_CONFIG, [channel, config], 'C C', 8, '' end
Configures the edge counter for a specific channel.
The edge type parameter configures if rising edges, falling edges or both are counted. 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.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 200 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
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.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 304 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end
This callback can be configured per channel.
The period is the period with which the CALLBACK_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.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 139 def set_value_callback_configuration(channel, period, value_has_to_change) check_validity send_request FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION, [channel, period, value_has_to_change], 'C L ?', 8, '' end
Sets the firmware pointer for BrickletIndustrialDigitalIn4V2#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.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 277 def set_write_firmware_pointer(pointer) check_validity send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, '' end
Writes 64 Bytes of firmware at the position as written by BrickletIndustrialDigitalIn4V2#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.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 291 def write_firmware(data) check_validity send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb, line 346 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end