Class: Tinkerforge::BrickletIndustrialDigitalOut4V2

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

Overview

4 galvanically isolated digital outputs

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2124
DEVICE_DISPLAY_NAME =

:nodoc:

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

6
FUNCTION_SET_VALUE =

:nodoc:

1
FUNCTION_GET_VALUE =

:nodoc:

2
FUNCTION_SET_SELECTED_VALUE =

:nodoc:

3
FUNCTION_SET_MONOFLOP =

:nodoc:

4
FUNCTION_GET_MONOFLOP =

:nodoc:

5
FUNCTION_SET_CHANNEL_LED_CONFIG =

:nodoc:

7
FUNCTION_GET_CHANNEL_LED_CONFIG =

:nodoc:

8
FUNCTION_SET_PWM_CONFIGURATION =

:nodoc:

9
FUNCTION_GET_PWM_CONFIGURATION =

: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_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) ⇒ BrickletIndustrialDigitalOut4V2

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 69

def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_SET_VALUE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SELECTED_VALUE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_SET_MONOFLOP] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_MONOFLOP] = 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_SET_PWM_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_PWM_CONFIGURATION] = 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_MONOFLOP_DONE] = [10, 'C ?']

  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletIndustrialDigitalOut4V2#set_bootloader_mode.



239
240
241
242
243
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 239

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 BrickletIndustrialDigitalOut4V2#set_channel_led_config



176
177
178
179
180
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 176

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.



297
298
299
300
301
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 297

def get_chip_temperature
  check_validity

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



344
345
346
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 344

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end

#get_monoflop(channel) ⇒ Object

Returns (for the given channel) the current value and the time as set by BrickletIndustrialDigitalOut4V2#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.



158
159
160
161
162
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 158

def get_monoflop(channel)
  check_validity

  send_request FUNCTION_GET_MONOFLOP, [channel], 'C', 17, '? L L'
end

#get_pwm_configuration(channel) ⇒ Object

Returns the PWM configuration as set by BrickletIndustrialDigitalOut4V2#set_pwm_configuration.



200
201
202
203
204
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 200

def get_pwm_configuration(channel)
  check_validity

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



217
218
219
220
221
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 217

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



285
286
287
288
289
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 285

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 output on the channels.



117
118
119
120
121
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 117

def get_value
  check_validity

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

#read_uid ⇒ Object

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



328
329
330
331
332
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 328

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.



349
350
351
352
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 349

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!



309
310
311
312
313
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 309

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 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.



232
233
234
235
236
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 232

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



169
170
171
172
173
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 169

def set_channel_led_config(channel, config)
  check_validity

  send_request FUNCTION_SET_CHANNEL_LED_CONFIG, [channel, config], 'C C', 8, ''
end

#set_monoflop(channel, value, time) ⇒ Object

The first parameter is the desired state of the channel (true means output high and false means output low). The second parameter indicates the time that the channel should hold the state.

If this function is called with the parameters (true, 1500): The channel will turn on and in 1.5s it will turn off again.

A PWM for the selected channel will be aborted if this function is called.

A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a IO-4 Bricklet is connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The channel will be high all the time. If now the RS485 connection is lost, the channel will turn low in at most two seconds.



147
148
149
150
151
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 147

def set_monoflop(channel, value, time)
  check_validity

  send_request FUNCTION_SET_MONOFLOP, [channel, value, time], 'C ? L', 8, ''
end

#set_pwm_configuration(channel, frequency, duty_cycle) ⇒ Object

Activates a PWM for the given channel.

To turn the PWM off again, you can set the frequency to 0 or any other function that changes a value of the channel (e.g. BrickletIndustrialDigitalOut4V2#set_selected_value).

The optocoupler of the Industrial Digital Out 4 Bricklet 2.0 has a rise time and fall time of 11.5us (each) at 24V. So the maximum useful frequency value is about 400000 (40kHz).

A running monoflop timer for the given channel will be aborted if this function is called.



193
194
195
196
197
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 193

def set_pwm_configuration(channel, frequency, duty_cycle)
  check_validity

  send_request FUNCTION_SET_PWM_CONFIGURATION, [channel, frequency, duty_cycle], 'C L S', 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 or PWM for the specified channel will be aborted if this function is called.



127
128
129
130
131
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 127

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.



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

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 four channels. A value of true or false outputs logic 1 or logic 0 respectively on the corresponding channel.

Use BrickletIndustrialDigitalOut4V2#set_selected_value to change only one output channel state.

All running monoflop timers and PWMs will be aborted if this function is called.

For example: (True, True, False, False) will turn the channels 0-1 high and the channels 2-3 low.



110
111
112
113
114
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 110

def set_value(value)
  check_validity

  send_request FUNCTION_SET_VALUE, [value], '?4', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

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



251
252
253
254
255
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 251

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



265
266
267
268
269
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 265

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.



320
321
322
323
324
 
# File 'lib/tinkerforge/bricklet_industrial_digital_out_4_v2.rb', line 320

def write_uid(uid)
  check_validity

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