Class: Tinkerforge::BrickletIndustrialDigitalIn4V2

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

Overview

4 galvanically isolated digital inputs

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2100
DEVICE_DISPLAY_NAME =

:nodoc:

'Industrial Digital In 4 Bricklet 2.0'
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.

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

12
FUNCTION_GET_VALUE =

:nodoc:

1
FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION =

:nodoc:

2
FUNCTION_GET_VALUE_CALLBACK_CONFIGURATION =

:nodoc:

3
FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION =

:nodoc:

4
FUNCTION_GET_ALL_VALUE_CALLBACK_CONFIGURATION =

:nodoc:

5
FUNCTION_GET_EDGE_COUNT =

:nodoc:

6
FUNCTION_SET_EDGE_COUNT_CONFIGURATION =

:nodoc:

7
FUNCTION_GET_EDGE_COUNT_CONFIGURATION =

:nodoc:

8
FUNCTION_SET_CHANNEL_LED_CONFIG =

:nodoc:

9
FUNCTION_GET_CHANNEL_LED_CONFIG =

:nodoc:

10
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
CHANNEL_0 =

:nodoc:

0
CHANNEL_1 =

:nodoc:

1
CHANNEL_2 =

:nodoc:

2
CHANNEL_3 =

:nodoc:

3
EDGE_TYPE_RISING =

:nodoc:

0
EDGE_TYPE_FALLING =

:nodoc:

1
EDGE_TYPE_BOTH =

:nodoc:

2
CHANNEL_LED_CONFIG_OFF =

:nodoc:

0
CHANNEL_LED_CONFIG_ON =

:nodoc:

1
CHANNEL_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS =

:nodoc:

3
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

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) ⇒ BrickletIndustrialDigitalIn4V2

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 88

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

Instance Method Details

#get_all_value_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletIndustrialDigitalIn4V2#set_all_value_callback_configuration.



171
172
173
174
175
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 171

def get_all_value_callback_configuration
  check_validity

  send_request FUNCTION_GET_ALL_VALUE_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
end

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletIndustrialDigitalIn4V2#set_bootloader_mode.



266
267
268
269
270
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 266

def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end

#get_channel_led_config(channel) ⇒ Object

Returns the channel LED configuration as set by BrickletIndustrialDigitalIn4V2#set_channel_led_config



227
228
229
230
231
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 227

def get_channel_led_config(channel)
  check_validity

  send_request FUNCTION_GET_CHANNEL_LED_CONFIG, [channel], 'C', 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.



324
325
326
327
328
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 324

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
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 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.



182
183
184
185
186
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 182

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 BrickletIndustrialDigitalIn4V2#set_edge_count_configuration.



209
210
211
212
213
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 209

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|



371
372
373
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 371

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
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.



244
245
246
247
248
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 244

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 BrickletIndustrialDigitalIn4V2#set_status_led_config



312
313
314
315
316
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 312

def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end

#get_value ⇒ Object

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



123
124
125
126
127
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 123

def get_value
  check_validity

  send_request FUNCTION_GET_VALUE, [], '', 9, '?4'
end

#get_value_callback_configuration(channel) ⇒ Object

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



148
149
150
151
152
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 148

def get_value_callback_configuration(channel)
  check_validity

  send_request FUNCTION_GET_VALUE_CALLBACK_CONFIGURATION, [channel], 'C', 13, 'L ?'
end

#read_uid ⇒ Object

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



355
356
357
358
359
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 355

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.



376
377
378
379
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 376

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!



336
337
338
339
340
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 336

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end

#set_all_value_callback_configuration(period, value_has_to_change) ⇒ Object

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.



163
164
165
166
167
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 163

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

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



259
260
261
262
263
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 259

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end

#set_channel_led_config(channel, config) ⇒ Object

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



220
221
222
223
224
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 220

def set_channel_led_config(channel, config)
  check_validity

  send_request FUNCTION_SET_CHANNEL_LED_CONFIG, [channel, config], 'C C', 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. 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.



201
202
203
204
205
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 201

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



305
306
307
308
309
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 305

def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end

#set_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_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.



140
141
142
143
144
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 140

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

#set_write_firmware_pointer(pointer) ⇒ Object

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.



278
279
280
281
282
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 278

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



292
293
294
295
296
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 292

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.



347
348
349
350
351
 
# File 'lib/tinkerforge/bricklet_industrial_digital_in_4_v2.rb', line 347

def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end