Class: Tinkerforge::BrickletIndustrialDualACIn

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

Overview

2 inputs that can detect AC voltages of up to 230V

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2174
DEVICE_DISPLAY_NAME =

:nodoc:

'Industrial Dual AC In Bricklet'
CALLBACK_VALUE =

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

8
CALLBACK_ALL_VALUE =

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

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

9
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_SET_CHANNEL_LED_CONFIG =

:nodoc:

6
FUNCTION_GET_CHANNEL_LED_CONFIG =

:nodoc:

7
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_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) ⇒ BrickletIndustrialDualACIn

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 80

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_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, '?2 ?2']

  @ipcon.add_device self
end

Instance Method Details

#get_all_value_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletIndustrialDualACIn#set_all_value_callback_configuration.



160
161
162
163
164
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 160

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



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

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



178
179
180
181
182
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 178

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.



275
276
277
278
279
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 275

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|



322
323
324
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 322

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.



195
196
197
198
199
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 195

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



263
264
265
266
267
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 263

def get_status_led_config
  check_validity

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

#get_value ⇒ Object

Returns the input values as bools, true refers to “AC voltage detected” and false refers to no AC “voltage detected”.



112
113
114
115
116
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 112

def get_value
  check_validity

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

#get_value_callback_configuration(channel) ⇒ Object

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



137
138
139
140
141
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 137

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.



306
307
308
309
310
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 306

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.



327
328
329
330
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 327

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!



287
288
289
290
291
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 287

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.



152
153
154
155
156
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 152

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.



210
211
212
213
214
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 210

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



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

def set_channel_led_config(channel, config)
  check_validity

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



256
257
258
259
260
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 256

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.



129
130
131
132
133
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 129

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



229
230
231
232
233
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 229

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



243
244
245
246
247
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 243

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.



298
299
300
301
302
 
# File 'lib/tinkerforge/bricklet_industrial_dual_ac_in.rb', line 298

def write_uid(uid)
  check_validity

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