This is the description of the openHAB API bindings for the Solid State Relay Bricklet 2.0. General information and technical specifications for the Solid State Relay Bricklet 2.0 are summarized in its hardware description.
An installation guide for the openHAB API bindings is part of their general description.
Required firmware version:
Firmware update supported:
Channels: Actions: Parameters:
- Status LED Config – Type: Choice, Default: Show Status
- 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.
- Options: Off, On, Show Heartbeat, Show Status
Switches the relay. A running monoflop timer for the relay will be aborted if the relay is toggled by this channel.
Triggers a monoflop as configured
- Commands (String)
- Accepts any string
- Monoflop Duration – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
- The time (in ms) that the relay should hold the configured value.
- Monoflop Value – Type: boolean, Default: true
- The desired value of the specified channel. Activated means relay closed and Deactivated means relay open.
Actions can be used in rules by creating an action object. All actions return a Map<String, Object>. Returned values can be accessed by name, sometimes the type deduction needs some hints, as shown below:
val actions = getActions("tinkerforge", "tinkerforge:brickletsolidstaterelayv2:[UID]") val hwVersion = actions.brickletSolidStateRelayV2GetIdentity().get("hardwareVersion") as short logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))
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.
Returns the state of the relay, true means on and false means off.
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.
Returns the current state and the time as set by Monoflop Relay 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.
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.
Returns the configuration as set by the thing configuration
The following constants are available for this function:
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
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.
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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.
The device identifier numbers can be found here.