Ruby - Solid State Relay Bricklet 2.0¶

Simple¶

Download (example_simple.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

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_solid_state_relay_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Solid State Relay Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
ssr = BrickletSolidStateRelayV2.new UID, ipcon # Create device object

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

# Turn relay on/off 10 times with 1 second delay
for _ in 0..4
  sleep 1
  ssr.set_state true
  sleep 1
  ssr.set_state false
end

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

Basic Functions¶

BrickletSolidStateRelayV2::new(uid, ipcon) → solid_state_relay_v2¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	solid_state_relay_v2 – Type: BrickletSolidStateRelayV2

Creates an object with the unique device ID uid:

solid_state_relay_v2 = BrickletSolidStateRelayV2.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected.

BrickletSolidStateRelayV2#set_state(state) → nil¶

Parameters:	state – Type: bool, Default: false

Sets the state of the relays true means on and false means off.

A running monoflop timer will be aborted if this function is called.

BrickletSolidStateRelayV2#get_state → bool¶

Returns:	state – Type: bool, Default: false

Returns the state of the relay, true means on and false means off.

Advanced Functions¶

BrickletSolidStateRelayV2#set_monoflop(state, time) → nil¶

Parameters:	state – Type: bool time – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]

The first parameter is the desired state of the relay (true means on and false means off). The second parameter indicates the time that the relay should hold the state.

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

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

BrickletSolidStateRelayV2#get_monoflop → [bool, int, int]¶

Return Array:	0: state – Type: bool 1: time – Type: int, Unit: 1 ms, Range: [0 to 232 - 1] 2: time_remaining – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]

Returns the current state and the time as set by #set_monoflop as well as the remaining time until the state flips.

If the timer is not running currently, the remaining time will be returned as 0.

BrickletSolidStateRelayV2#get_spitfp_error_count → [int, int, int, int]¶

Return Array:	0: error_count_ack_checksum – Type: int, Range: [0 to 232 - 1] 1: error_count_message_checksum – Type: int, Range: [0 to 232 - 1] 2: error_count_frame – Type: int, Range: [0 to 232 - 1] 3: error_count_overflow – Type: int, Range: [0 to 232 - 1]

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.

BrickletSolidStateRelayV2#set_status_led_config(config) → nil¶

Parameters:	config – Type: int, Range: See constants, Default: 3

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:

For config:

• BrickletSolidStateRelayV2::STATUS_LED_CONFIG_OFF = 0
• BrickletSolidStateRelayV2::STATUS_LED_CONFIG_ON = 1
• BrickletSolidStateRelayV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletSolidStateRelayV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletSolidStateRelayV2#get_status_led_config → int¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

For config:

• BrickletSolidStateRelayV2::STATUS_LED_CONFIG_OFF = 0
• BrickletSolidStateRelayV2::STATUS_LED_CONFIG_ON = 1
• BrickletSolidStateRelayV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletSolidStateRelayV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletSolidStateRelayV2#get_chip_temperature → int¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

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

BrickletSolidStateRelayV2#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Return Array:

0: uid – Type: str, Length: up to 8 1: connected_uid – Type: str, Length: up to 8 2: position – Type: chr, Range: ['a' to 'h', 'z'] 3: hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 4: firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 5: device_identifier – Type: int, Range: [0 to 216 - 1]

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 Isolator Bricklet is always at position 'z'.

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

Callback Configuration Functions¶

BrickletSolidStateRelayV2#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameters:	callback_id – Type: 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:

solid_state_relay_v2.register_callback BrickletSolidStateRelayV2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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

BrickletSolidStateRelayV2::CALLBACK_MONOFLOP_DONE¶

Callback Parameters:	state – Type: bool

This callback is triggered whenever the monoflop timer reaches 0. The parameter is the current state of the relay (the state after the monoflop).

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletSolidStateRelayV2#get_api_version → [int, ...]¶

Return Array:	0: api_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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.

BrickletSolidStateRelayV2#get_response_expected(function_id) → bool¶

Parameters:	function_id – Type: int, Range: See constants
Returns:	response_expected – Type: bool

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

The following constants are available for this function:

For function_id:

• BrickletSolidStateRelayV2::FUNCTION_SET_STATE = 1
• BrickletSolidStateRelayV2::FUNCTION_SET_MONOFLOP = 3
• BrickletSolidStateRelayV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletSolidStateRelayV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletSolidStateRelayV2::FUNCTION_RESET = 243
• BrickletSolidStateRelayV2::FUNCTION_WRITE_UID = 248

BrickletSolidStateRelayV2#set_response_expected(function_id, response_expected) → nil¶

Parameters:	function_id – Type: int, Range: See constants response_expected – Type: 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

• BrickletSolidStateRelayV2::FUNCTION_SET_STATE = 1
• BrickletSolidStateRelayV2::FUNCTION_SET_MONOFLOP = 3
• BrickletSolidStateRelayV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletSolidStateRelayV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletSolidStateRelayV2::FUNCTION_RESET = 243
• BrickletSolidStateRelayV2::FUNCTION_WRITE_UID = 248

BrickletSolidStateRelayV2#set_response_expected_all(response_expected) → nil¶

Parameters:	response_expected – Type: bool

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletSolidStateRelayV2#set_bootloader_mode(mode) → int¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

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:

For mode:

• BrickletSolidStateRelayV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletSolidStateRelayV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletSolidStateRelayV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletSolidStateRelayV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletSolidStateRelayV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletSolidStateRelayV2::BOOTLOADER_STATUS_OK = 0
• BrickletSolidStateRelayV2::BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletSolidStateRelayV2::BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletSolidStateRelayV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletSolidStateRelayV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletSolidStateRelayV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletSolidStateRelayV2#get_bootloader_mode → int¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

For mode:

• BrickletSolidStateRelayV2::BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletSolidStateRelayV2::BOOTLOADER_MODE_FIRMWARE = 1
• BrickletSolidStateRelayV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletSolidStateRelayV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletSolidStateRelayV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletSolidStateRelayV2#set_write_firmware_pointer(pointer) → nil¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]

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.

BrickletSolidStateRelayV2#write_firmware(data) → int¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

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.

BrickletSolidStateRelayV2#write_uid(uid) → nil¶

Parameters:	uid – Type: int, Range: [0 to 232 - 1]

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.

BrickletSolidStateRelayV2#read_uid → int¶

Returns:	uid – Type: int, Range: [0 to 232 - 1]

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

Constants¶

BrickletSolidStateRelayV2::DEVICE_IDENTIFIER¶

This constant is used to identify a Solid State Relay Bricklet 2.0.

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

BrickletSolidStateRelayV2::DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Solid State Relay Bricklet 2.0.