Ruby - Industrial Digital In 4 Bricklet 2.0¶

Simple¶

Download (example_simple.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_digital_in_4_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
idi4 = BrickletIndustrialDigitalIn4V2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get current value
value = idi4.get_value

puts "Channel 0: #{value[0]}"
puts "Channel 1: #{value[1]}"
puts "Channel 2: #{value[2]}"
puts "Channel 3: #{value[3]}"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Edge Count¶

Download (example_edge_count.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_digital_in_4_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
idi4 = BrickletIndustrialDigitalIn4V2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Configure rising edge count (channel 3) with 10ms debounce
idi4.set_edge_count_configuration 3, 0, 10

# Get edge count 10 times with 1s delay
for _ in 0..9
  sleep 1

  # Get current edge count
  count = idi4.get_edge_count 3, false
  puts "Count: #{count}"
end

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Callback¶

Download (example_callback.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_digital_in_4_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
idi4 = BrickletIndustrialDigitalIn4V2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register value callback
idi4.register_callback(BrickletIndustrialDigitalIn4V2::CALLBACK_VALUE) do |channel,
                                                                           changed, value|
  if channel == BrickletIndustrialDigitalIn4V2::CHANNEL_0
    puts "Channel: 0"
  elsif channel == BrickletIndustrialDigitalIn4V2::CHANNEL_1
    puts "Channel: 1"
  elsif channel == BrickletIndustrialDigitalIn4V2::CHANNEL_2
    puts "Channel: 2"
  elsif channel == BrickletIndustrialDigitalIn4V2::CHANNEL_3
    puts "Channel: 3"
  end

  puts "Changed: #{changed}"
  puts "Value: #{value}"
  puts ''
end

# Set period for value (channel 1) callback to 0.1s (100ms)
idi4.set_value_callback_configuration 1, 100, false

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Basic Functions¶

BrickletIndustrialDigitalIn4V2::new(uid, ipcon) → industrial_digital_in_4_v2¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	industrial_digital_in_4_v2 – Type: BrickletIndustrialDigitalIn4V2

Creates an object with the unique device ID uid:

industrial_digital_in_4_v2 = BrickletIndustrialDigitalIn4V2.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected.

BrickletIndustrialDigitalIn4V2#get_value → [bool, ...]¶

Returns:	value – Type: [bool, ...], Length: 4

Returns the input value as bools, true refers to high and false refers to low.

BrickletIndustrialDigitalIn4V2#set_channel_led_config(channel, config) → nil¶

Parameters:	channel – Type: int, Range: See constants config – Type: int, Range: See constants, Default: 3

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".

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

For config:

• BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_OFF = 0
• BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_ON = 1
• BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

BrickletIndustrialDigitalIn4V2#get_channel_led_config(channel) → int¶

Parameters:	channel – Type: int, Range: See constants
Returns:	config – Type: int, Range: See constants, Default: 3

Returns the channel LED configuration as set by #set_channel_led_config

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

For config:

• BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_OFF = 0
• BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_ON = 1
• BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDigitalIn4V2::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions¶

BrickletIndustrialDigitalIn4V2#get_edge_count(channel, reset_counter) → int¶

Parameters:	channel – Type: int, Range: See constants reset_counter – Type: bool
Returns:	count – Type: int, Range: [0 to 232 - 1]

Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with #set_edge_count_configuration.

If you set the reset counter to true, the count is set back to 0 directly after it is read.

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2#set_edge_count_configuration(channel, edge_type, debounce) → nil¶

Parameters:	channel – Type: int, Range: See constants edge_type – Type: int, Range: See constants, Default: 0 debounce – Type: int, Unit: 1 ms, Range: [0 to 255], Default: 100

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.

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

For edge_type:

• BrickletIndustrialDigitalIn4V2::EDGE_TYPE_RISING = 0
• BrickletIndustrialDigitalIn4V2::EDGE_TYPE_FALLING = 1
• BrickletIndustrialDigitalIn4V2::EDGE_TYPE_BOTH = 2

BrickletIndustrialDigitalIn4V2#get_edge_count_configuration(channel) → [int, int]¶

Parameters:	channel – Type: int, Range: See constants
Return Array:	0: edge_type – Type: int, Range: See constants, Default: 0 1: debounce – Type: int, Unit: 1 ms, Range: [0 to 255], Default: 100

Returns the edge type and debounce time for the selected channel as set by #set_edge_count_configuration.

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

For edge_type:

• BrickletIndustrialDigitalIn4V2::EDGE_TYPE_RISING = 0
• BrickletIndustrialDigitalIn4V2::EDGE_TYPE_FALLING = 1
• BrickletIndustrialDigitalIn4V2::EDGE_TYPE_BOTH = 2

BrickletIndustrialDigitalIn4V2#get_spitfp_error_count → [int, int, int, int]¶

Return Array:	0: error_count_ack_checksum – Type: int, Range: [0 to 232 - 1] 1: error_count_message_checksum – Type: int, Range: [0 to 232 - 1] 2: error_count_frame – Type: int, Range: [0 to 232 - 1] 3: error_count_overflow – Type: int, Range: [0 to 232 - 1]

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.

BrickletIndustrialDigitalIn4V2#set_status_led_config(config) → nil¶

Parameters:	config – Type: int, Range: See constants, Default: 3

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.

The following constants are available for this function:

For config:

• BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_OFF = 0
• BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_ON = 1
• BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletIndustrialDigitalIn4V2#get_status_led_config → int¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

For config:

• BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_OFF = 0
• BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_ON = 1
• BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletIndustrialDigitalIn4V2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletIndustrialDigitalIn4V2#get_chip_temperature → int¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

BrickletIndustrialDigitalIn4V2#reset → nil¶

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!

BrickletIndustrialDigitalIn4V2#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Return Array:

0: uid – Type: str, Length: up to 8 1: connected_uid – Type: str, Length: up to 8 2: position – Type: chr, Range: ['a' to 'h', 'z'] 3: hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 4: firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 5: device_identifier – Type: int, Range: [0 to 216 - 1]

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 Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

BrickletIndustrialDigitalIn4V2#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameters:	callback_id – Type: int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletIndustrialDigitalIn4V2#set_value_callback_configuration(channel, period, value_has_to_change) → nil¶

Parameters:	channel – Type: int, Range: See constants period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false

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.

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2#get_value_callback_configuration(channel) → [int, bool]¶

Parameters:	channel – Type: int, Range: See constants
Return Array:	0: period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 1: value_has_to_change – Type: bool, Default: false

Returns the callback configuration for the given channel as set by #set_value_callback_configuration.

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2#set_all_value_callback_configuration(period, value_has_to_change) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false

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.

BrickletIndustrialDigitalIn4V2#get_all_value_callback_configuration → [int, bool]¶

Return Array:	0: period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 1: value_has_to_change – Type: bool, Default: false

Returns the callback configuration as set by #set_all_value_callback_configuration.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:

industrial_digital_in_4_v2.register_callback BrickletIndustrialDigitalIn4V2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters are described below.

BrickletIndustrialDigitalIn4V2::CALLBACK_VALUE¶

Callback Parameters:	channel – Type: int, Range: See constants changed – Type: bool value – Type: bool

This callback is triggered periodically according to the configuration set by #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.

The following constants are available for this function:

For channel:

• BrickletIndustrialDigitalIn4V2::CHANNEL_0 = 0
• BrickletIndustrialDigitalIn4V2::CHANNEL_1 = 1
• BrickletIndustrialDigitalIn4V2::CHANNEL_2 = 2
• BrickletIndustrialDigitalIn4V2::CHANNEL_3 = 3

BrickletIndustrialDigitalIn4V2::CALLBACK_ALL_VALUE¶

Callback Parameters:	changed – Type: [bool, ...], Length: 4 value – Type: [bool, ...], Length: 4

This callback is triggered periodically according to the configuration set by #set_all_value_callback_configuration.

The parameters are the same as #get_value. Additional the changed parameter is true if the value has changed since the last callback.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletIndustrialDigitalIn4V2#get_api_version → [int, ...]¶

Return Array:	0: api_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletIndustrialDigitalIn4V2#get_response_expected(function_id) → bool¶

Parameters:	function_id – Type: int, Range: See constants
Returns:	response_expected – Type: bool

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by #set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_CHANNEL_LED_CONFIG = 9
• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDigitalIn4V2::FUNCTION_RESET = 243
• BrickletIndustrialDigitalIn4V2::FUNCTION_WRITE_UID = 248

BrickletIndustrialDigitalIn4V2#set_response_expected(function_id, response_expected) → nil¶

Parameters:	function_id – Type: int, Range: See constants response_expected – Type: bool

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_CHANNEL_LED_CONFIG = 9
• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletIndustrialDigitalIn4V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletIndustrialDigitalIn4V2::FUNCTION_RESET = 243
• BrickletIndustrialDigitalIn4V2::FUNCTION_WRITE_UID = 248

BrickletIndustrialDigitalIn4V2#set_response_expected_all(response_expected) → nil¶

Parameters:	response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletIndustrialDigitalIn4V2#set_bootloader_mode(mode) → int¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

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.

The following constants are available for this function:

For mode:

• BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_OK = 0
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletIndustrialDigitalIn4V2#get_bootloader_mode → int¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

For mode:

• BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletIndustrialDigitalIn4V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletIndustrialDigitalIn4V2#set_write_firmware_pointer(pointer) → nil¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for #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.

BrickletIndustrialDigitalIn4V2#write_firmware(data) → int¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by #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.

BrickletIndustrialDigitalIn4V2#write_uid(uid) → nil¶

Parameters:	uid – Type: int, Range: [0 to 232 - 1]

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.

BrickletIndustrialDigitalIn4V2#read_uid → int¶

Returns:	uid – Type: int, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

BrickletIndustrialDigitalIn4V2::DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Digital In 4 Bricklet 2.0.

The #get_identity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletIndustrialDigitalIn4V2::DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Industrial Digital In 4 Bricklet 2.0.