Class: Tinkerforge::BrickletRemoteSwitchV2

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

Overview

Controls remote mains switches and receives signals from remotes

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

289
DEVICE_DISPLAY_NAME =

:nodoc:

'Remote Switch Bricklet 2.0'
CALLBACK_SWITCHING_DONE =

This callback is triggered whenever the switching state changes from busy to ready, see BrickletRemoteSwitchV2#get_switching_state.

2
CALLBACK_REMOTE_STATUS_A =

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with BrickletRemoteSwitchV2#set_remote_configuration. The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

14
CALLBACK_REMOTE_STATUS_B =

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with BrickletRemoteSwitchV2#set_remote_configuration. The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

15
CALLBACK_REMOTE_STATUS_C =

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with BrickletRemoteSwitchV2#set_remote_configuration. The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

16
FUNCTION_GET_SWITCHING_STATE =

:nodoc:

1
FUNCTION_SET_REPEATS =

:nodoc:

3
FUNCTION_GET_REPEATS =

:nodoc:

4
FUNCTION_SWITCH_SOCKET_A =

:nodoc:

5
FUNCTION_SWITCH_SOCKET_B =

:nodoc:

6
FUNCTION_DIM_SOCKET_B =

:nodoc:

7
FUNCTION_SWITCH_SOCKET_C =

:nodoc:

8
FUNCTION_SET_REMOTE_CONFIGURATION =

:nodoc:

9
FUNCTION_GET_REMOTE_CONFIGURATION =

:nodoc:

10
FUNCTION_GET_REMOTE_STATUS_A =

:nodoc:

11
FUNCTION_GET_REMOTE_STATUS_B =

:nodoc:

12
FUNCTION_GET_REMOTE_STATUS_C =

:nodoc:

13
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
SWITCHING_STATE_READY =

:nodoc:

0
SWITCHING_STATE_BUSY =

:nodoc:

1
SWITCH_TO_OFF =

:nodoc:

0
SWITCH_TO_ON =

:nodoc:

1
REMOTE_TYPE_A =

:nodoc:

0
REMOTE_TYPE_B =

:nodoc:

1
REMOTE_TYPE_C =

:nodoc:

2
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) ⇒ BrickletRemoteSwitchV2

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 109

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

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_SWITCHING_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_REPEATS] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_REPEATS] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SWITCH_SOCKET_A] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_SWITCH_SOCKET_B] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_DIM_SOCKET_B] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_SWITCH_SOCKET_C] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_SET_REMOTE_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_REMOTE_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_REMOTE_STATUS_A] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_REMOTE_STATUS_B] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_REMOTE_STATUS_C] = 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_SWITCHING_DONE] = [8, '']
  @callback_formats[CALLBACK_REMOTE_STATUS_A] = [13, 'C C C S']
  @callback_formats[CALLBACK_REMOTE_STATUS_B] = [17, 'L C C C S']
  @callback_formats[CALLBACK_REMOTE_STATUS_C] = [13, 'k C C S']

  @ipcon.add_device self
end

Instance Method Details

#dim_socket_b(address, unit, dim_value) ⇒ Object

To control a type B dimmer you have to give the address, unit and the dim value you want to set the dimmer to.

A detailed description on how you can teach a dimmer the address and unit can be found :ref:‘here <remote_switch_bricklet_type_b_address_and_unit>`.



207
208
209
210
211
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 207

def dim_socket_b(address, unit, dim_value)
  check_validity

  send_request FUNCTION_DIM_SOCKET_B, [address, unit, dim_value], 'L C C', 8, ''
end

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletRemoteSwitchV2#set_bootloader_mode.



325
326
327
328
329
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 325

def get_bootloader_mode
  check_validity

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



383
384
385
386
387
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 383

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|



430
431
432
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 430

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

#get_remote_configuration ⇒ Object

Returns the remote configuration as set by BrickletRemoteSwitchV2#set_remote_configuration



238
239
240
241
242
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 238

def get_remote_configuration
  check_validity

  send_request FUNCTION_GET_REMOTE_CONFIGURATION, [], '', 12, 'C S ?'
end

#get_remote_status_a ⇒ Object

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

Repeats == 0 means there was no button press. Repeats >= 1 means there was a button press with the specified house/receiver code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see BrickletRemoteSwitchV2#set_remote_configuration and CALLBACK_REMOTE_STATUS_A callback.



254
255
256
257
258
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 254

def get_remote_status_a
  check_validity

  send_request FUNCTION_GET_REMOTE_STATUS_A, [], '', 13, 'C C C S'
end

#get_remote_status_b ⇒ Object

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified address/unit. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see BrickletRemoteSwitchV2#set_remote_configuration and CALLBACK_REMOTE_STATUS_B callback.



271
272
273
274
275
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 271

def get_remote_status_b
  check_validity

  send_request FUNCTION_GET_REMOTE_STATUS_B, [], '', 17, 'L C C C S'
end

#get_remote_status_c ⇒ Object

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified system/device code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see BrickletRemoteSwitchV2#set_remote_configuration and CALLBACK_REMOTE_STATUS_C callback.



286
287
288
289
290
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 286

def get_remote_status_c
  check_validity

  send_request FUNCTION_GET_REMOTE_STATUS_C, [], '', 13, 'k C C S'
end

#get_repeats ⇒ Object

Returns the number of repeats as set by BrickletRemoteSwitchV2#set_repeats.



172
173
174
175
176
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 172

def get_repeats
  check_validity

  send_request FUNCTION_GET_REPEATS, [], '', 9, 'C'
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.



303
304
305
306
307
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 303

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



371
372
373
374
375
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 371

def get_status_led_config
  check_validity

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

#get_switching_state ⇒ Object

Returns the current switching state. If the current state is busy, the Bricklet is currently sending a code to switch a socket. It will not accept any calls of switch socket functions until the state changes to ready.

How long the switching takes is dependent on the number of repeats, see BrickletRemoteSwitchV2#set_repeats.



153
154
155
156
157
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 153

def get_switching_state
  check_validity

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

#read_uid ⇒ Object

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



414
415
416
417
418
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 414

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.



435
436
437
438
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 435

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!



395
396
397
398
399
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 395

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.



318
319
320
321
322
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 318

def set_bootloader_mode(mode)
  check_validity

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

#set_remote_configuration(remote_type, minimum_repeats, callback_enabled) ⇒ Object

Sets the configuration for receiving data from a remote of type A, B or C.

  • Remote Type: A, B or C depending on the type of remote you want to receive.

  • Minimum Repeats: The minimum number of repeated data packets until the callback is triggered (if enabled).

  • Callback Enabled: Enable or disable callback (see CALLBACK_REMOTE_STATUS_A callback, CALLBACK_REMOTE_STATUS_B callback and CALLBACK_REMOTE_STATUS_C callback).



231
232
233
234
235
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 231

def set_remote_configuration(remote_type, minimum_repeats, callback_enabled)
  check_validity

  send_request FUNCTION_SET_REMOTE_CONFIGURATION, [remote_type, minimum_repeats, callback_enabled], 'C S ?', 8, ''
end

#set_repeats(repeats) ⇒ Object

Sets the number of times the code is sent when one of the Switch Socket functions is called. The repeats basically correspond to the amount of time that a button of the remote is pressed.

Some dimmers are controlled by the length of a button pressed, this can be simulated by increasing the repeats.



165
166
167
168
169
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 165

def set_repeats(repeats)
  check_validity

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



364
365
366
367
368
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 364

def set_status_led_config(config)
  check_validity

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

#set_write_firmware_pointer(pointer) ⇒ Object

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



337
338
339
340
341
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 337

def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end

#switch_socket_a(house_code, receiver_code, switch_to) ⇒ Object

To switch a type A socket you have to give the house code, receiver code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the house and receiver code can be found :ref:‘here <remote_switch_bricklet_type_a_house_and_receiver_code>`.



183
184
185
186
187
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 183

def switch_socket_a(house_code, receiver_code, switch_to)
  check_validity

  send_request FUNCTION_SWITCH_SOCKET_A, [house_code, receiver_code, switch_to], 'C C C', 8, ''
end

#switch_socket_b(address, unit, switch_to) ⇒ Object

To switch a type B socket you have to give the address, unit and the state (on or off) you want to switch to.

To switch all devices with the same address use 255 for the unit.

A detailed description on how you can teach a socket the address and unit can be found :ref:‘here <remote_switch_bricklet_type_b_address_and_unit>`.



196
197
198
199
200
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 196

def switch_socket_b(address, unit, switch_to)
  check_validity

  send_request FUNCTION_SWITCH_SOCKET_B, [address, unit, switch_to], 'L C C', 8, ''
end

#switch_socket_c(system_code, device_code, switch_to) ⇒ Object

To switch a type C socket you have to give the system code, device code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the system and device code can be found :ref:‘here <remote_switch_bricklet_type_c_system_and_device_code>`.



218
219
220
221
222
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 218

def switch_socket_c(system_code, device_code, switch_to)
  check_validity

  send_request FUNCTION_SWITCH_SOCKET_C, [system_code, device_code, switch_to], 'k C C', 8, ''
end

#write_firmware(data) ⇒ Object

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



351
352
353
354
355
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 351

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.



406
407
408
409
410
 
# File 'lib/tinkerforge/bricklet_remote_switch_v2.rb', line 406

def write_uid(uid)
  check_validity

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