Ruby - Remote Switch Bricklet 2.0

This is the description of the Ruby API bindings for the Remote Switch Bricklet 2.0. General information and technical specifications for the Remote Switch Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Ruby API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Switch Socket

Download (example_switch_socket.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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_remote_switch_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Remote Switch Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
rs = BrickletRemoteSwitchV2.new UID, ipcon # Create device object

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

# Switch on a type A socket with house code 17 and receiver code 1.
# House code 17 is 10001 in binary (least-significant bit first)
# and means that the DIP switches 1 and 5 are on and 2-4 are off.
# Receiver code 1 is 10000 in binary (least-significant bit first)
# and means that the DIP switch A is on and B-E are off.
rs.switch_socket_a 17, 1, BrickletRemoteSwitchV2::SWITCH_TO_ON

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

Remote Callback

Download (example_remote_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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_remote_switch_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Remote Switch Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
rs = BrickletRemoteSwitchV2.new UID, ipcon # Create device object

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

# Configure to receive from remote type A with minimum repeats set to 1 and enable callback
rs.set_remote_configuration BrickletRemoteSwitchV2::REMOTE_TYPE_A, 1, true

# Register remote status a callback
rs.register_callback(BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_A) do |house_code,
                                                                           receiver_code,
                                                                           switch_to,
                                                                           repeats|
  puts "House Code: #{house_code}"
  puts "Receiver Code: #{receiver_code}"
  puts "Switch To: #{switch_to}"
  puts "Repeats: #{repeats}"
  puts ''
end

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

API

All methods listed below are thread-safe.

Basic Functions

BrickletRemoteSwitchV2::new(uid, ipcon) → remote_switch_v2
Parameters:
  • uid -- str
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

remote_switch_v2 = BrickletRemoteSwitchV2.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected (see examples above).

BrickletRemoteSwitchV2#get_switching_state → int

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

The following constants are available for this function:

  • BrickletRemoteSwitchV2::SWITCHING_STATE_READY = 0
  • BrickletRemoteSwitchV2::SWITCHING_STATE_BUSY = 1
BrickletRemoteSwitchV2#switch_socket_a(house_code, receiver_code, switch_to) → nil
Parameters:
  • house_code -- int
  • receiver_code -- int
  • switch_to -- int

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.

The house code and receiver code have a range of 0 to 31 (5bit).

A detailed description on how you can figure out the house and receiver code can be found here.

The following constants are available for this function:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2#switch_socket_b(address, unit, switch_to) → nil
Parameters:
  • address -- int
  • unit -- int
  • switch_to -- int

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

The address has a range of 0 to 67108863 (26bit) and the unit has a range of 0 to 15 (4bit). 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 here.

The following constants are available for this function:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2#dim_socket_b(address, unit, dim_value) → nil
Parameters:
  • address -- int
  • unit -- int
  • dim_value -- int

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

The address has a range of 0 to 67108863 (26bit), the unit and the dim value has a range of 0 to 15 (4bit).

A detailed description on how you can teach a dimmer the address and unit can be found here.

BrickletRemoteSwitchV2#switch_socket_c(system_code, device_code, switch_to) → nil
Parameters:
  • system_code -- str
  • device_code -- int
  • switch_to -- int

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.

The system code has a range of 'A' to 'P' (4bit) and the device code has a range of 1 to 16 (4bit).

A detailed description on how you can figure out the system and device code can be found here.

The following constants are available for this function:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2#set_remote_configuration(remote_type, minimum_repeats, callback_enabled) → nil
Parameters:
  • remote_type -- int
  • minimum_repeats -- int
  • callback_enabled -- bool

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

Default is ('A', 2, false).

The following constants are available for this function:

  • BrickletRemoteSwitchV2::REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2::REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2::REMOTE_TYPE_C = 2
BrickletRemoteSwitchV2#get_remote_configuration → [int, int, bool]

Returns the remote configuration as set by #set_remote_configuration

The following constants are available for this function:

  • BrickletRemoteSwitchV2::REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2::REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2::REMOTE_TYPE_C = 2

The returned array has the values remote_type, minimum_repeats and callback_enabled.

BrickletRemoteSwitchV2#get_remote_status_a → [int, int, int, int]

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 #set_remote_configuration and ::CALLBACK_REMOTE_STATUS_A callback.

The following constants are available for this function:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1

The returned array has the values house_code, receiver_code, switch_to and repeats.

BrickletRemoteSwitchV2#get_remote_status_b → [int, int, int, int, int]

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 #set_remote_configuration and ::CALLBACK_REMOTE_STATUS_B callback.

The following constants are available for this function:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1

The returned array has the values address, unit, switch_to, dim_value and repeats.

BrickletRemoteSwitchV2#get_remote_status_c → [str, int, int, int]

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 #set_remote_configuration and ::CALLBACK_REMOTE_STATUS_C callback.

The following constants are available for this function:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1

The returned array has the values system_code, device_code, switch_to and repeats.

Advanced Functions

BrickletRemoteSwitchV2#set_repeats(repeats) → nil
Parameters:repeats -- int

Sets the number of times the code is send 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.

The default value is 5.

BrickletRemoteSwitchV2#get_repeats → int

Returns the number of repeats as set by #set_repeats.

BrickletRemoteSwitchV2#get_api_version → [int, int, int]

Returns the version of the API definition (major, minor, revision) 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.

BrickletRemoteSwitchV2#get_response_expected(function_id) → bool
Parameters:function_id -- int

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 send and errors are silently ignored, because they cannot be detected.

See #set_response_expected for the list of function ID constants available for this function.

BrickletRemoteSwitchV2#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id -- int
  • response_expected -- 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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletRemoteSwitchV2::FUNCTION_SET_REPEATS = 3
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_A = 5
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_B = 6
  • BrickletRemoteSwitchV2::FUNCTION_DIM_SOCKET_B = 7
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_C = 8
  • BrickletRemoteSwitchV2::FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BrickletRemoteSwitchV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRemoteSwitchV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRemoteSwitchV2::FUNCTION_RESET = 243
  • BrickletRemoteSwitchV2::FUNCTION_WRITE_UID = 248
BrickletRemoteSwitchV2#set_response_expected_all(response_expected) → nil
Parameters:response_expected -- bool

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

BrickletRemoteSwitchV2#get_spitfp_error_count → [int, int, int, int]

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.

The returned array has the values error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

BrickletRemoteSwitchV2#set_bootloader_mode(mode) → int
Parameters:mode -- int

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:

  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_OK = 0
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletRemoteSwitchV2#get_bootloader_mode → int

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletRemoteSwitchV2#set_write_firmware_pointer(pointer) → nil
Parameters:pointer -- int

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.

BrickletRemoteSwitchV2#write_firmware(data) → int
Parameters:data -- [int, int, ..61x.., int]

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.

BrickletRemoteSwitchV2#set_status_led_config(config) → nil
Parameters:config -- int

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:

  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_ON = 1
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRemoteSwitchV2#get_status_led_config → int

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_ON = 1
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRemoteSwitchV2#get_chip_temperature → int

Returns the temperature in °C 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.

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

BrickletRemoteSwitchV2#write_uid(uid) → nil
Parameters:uid -- int

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.

BrickletRemoteSwitchV2#read_uid → int

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

BrickletRemoteSwitchV2#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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' or 'd'.

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

The returned array has the values uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

BrickletRemoteSwitchV2#register_callback(callback_id) { |param [, ...]| block } → nil
Parameters:callback_id -- int

Registers the given block with the given callback_id.

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

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:

remote_switch_v2.register_callback BrickletRemoteSwitchV2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

BrickletRemoteSwitchV2::CALLBACK_SWITCHING_DONE

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

BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_A
Parameters:
  • house_code -- int
  • receiver_code -- int
  • switch_to -- int
  • repeats -- int

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

The following constants are available for this function:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_B
Parameters:
  • address -- int
  • unit -- int
  • switch_to -- int
  • dim_value -- int
  • repeats -- int

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

The following constants are available for this function:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_C
Parameters:
  • system_code -- str
  • device_code -- int
  • switch_to -- int
  • repeats -- int

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

The following constants are available for this function:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1

Constants

BrickletRemoteSwitchV2::DEVICE_IDENTIFIER

This constant is used to identify a Remote Switch Bricklet 2.0.

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

BrickletRemoteSwitchV2::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Remote Switch Bricklet 2.0.