This is the description of the openHAB API bindings for the Thermocouple Bricklet. General information and technical specifications for the Thermocouple Bricklet 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:
- Average Length – Type: Choice, Default: 16
- Available averaging sizes are 1, 2, 4, 8 and 16 samples. The conversion time depends on the averaging and filter configuration, it can be calculated as follows:
- 60Hz: time = 82 + (samples - 1) * 16.67
- 50Hz: time = 98 + (samples - 1) * 20
- Options: 1, 2, 4, 8, 16
- Thermocouple Type – Type: Choice, Default: K
- As thermocouple type you can use B, E, J, K, N, R, S and T. If you have a different thermocouple or a custom thermocouple you can also use G8 and G32. With these types the returned value will not be in °C/100, it will be calculated by the following formulas:
where Vin is the thermocouple input voltage.
- G8: value = 8 * 1.6 * 2^17 * Vin
- G32: value = 32 * 1.6 * 2^17 * Vin
- Options: B, E, J, K, N, R, S, T, G8, G32
- Frequency Filter – Type: Choice, Default: 50Hz
- The frequency filter can be either configured to 50Hz or to 60Hz. You should configure it according to your utility frequency.
- Options: 50Hz, 60Hz
The temperature of the thermocouple.
- -210 Celsius to 1800 Celsius (Step 0.01 Celsius)
- Update Interval – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
- Specifies the update interval in milliseconds. A value of 0 disables automatic updates.
Over/Under Voltage happens for voltages below 0V or above 3.3V. In this case it is very likely that your thermocouple is defective.
An Open Circuit error indicates that there is no thermocouple connected.
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:brickletthermocouple:[UID]") val hwVersion = actions.brickletThermocoupleGetIdentity().get("hardwareVersion") as short logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))
Returns the temperature of the thermocouple.
Returns the configuration as set by the thing configuration.
The following constants are available for this function:
Returns the current error state. There are two possible errors:
Over/Under Voltage happens for voltages below 0V or above 3.3V. In this case it is very likely that your thermocouple is defective. An Open Circuit error indicates that there is no thermocouple connected.
You can use the
Over/Under Voltage channel to automatically get triggered
when the error state changes.
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 as position 'z'.
The device identifier numbers can be found here.