Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets (Discontinued) / PTC Bricklet 2.0

openHAB - PTC Bricklet 2.0

Warning

The openHAB bindings are still in beta, but the development was stopped.

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

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

Thing

UID:
  • tinkerforge:brickletptcv2:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Wire Mode – Type: Choice, Default: 2-wire
  • The wire mode of the sensor. Possible values are 2, 3 and 4 which correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper configuration on the Bricklet.
  • Options: 2-wire, 3-wire, 4-wire

  • Temperature Moving Average Length – Type: integer, Default: 40, Min: 1, Max: 1000
  • Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.\n\nNew data is gathered every 20ms. With a moving average of length 1000 the resulting averaging window has a length of 20s. If you want to do long term measurements the longest moving average will give the cleanest results.

  • Noise Rejection Filter Frequency – Type: Choice, Default: 50Hz
  • Sets the noise rejection filter to either 50 Hz or 60 Hz. Noise from 50 Hz or 60 Hz power sources (including harmonics of the AC power’s fundamental frequency) is attenuated by 82dB
  • Options: 50Hz, 60Hz

  • Sensor Type – Type: Choice, Default: Pt100
  • The type of the sensor. The value has to match the jumper configuration on the Bricklet or else the calculated resistance will not be correct.
  • Options: Pt100, Pt1000

  • Status LED Configuration – 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

Channels

Temperature

Temperature of the connected sensor

Type:
  • Number:Temperature
UID:
  • tinkerforge:brickletptcv2:[UID]:BrickletPTCV2Temperature
Read only:
  • Yes
Unit:
  • Celsius
Range:
  • -246 Celsius to 849 Celsius (Step 0.01 Celsius)
Parameters:
  • 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.
Resistance

The value as measured by the MAX31865 precision delta-sigma ADC. Configure the thing to Pt 100 or Pt 1000, to make sure the conversion is correct.

Type:
  • Number:ElectricResistance
UID:
  • tinkerforge:brickletptcv2:[UID]:BrickletPTCV2Resistance
Read only:
  • Yes
Unit:
  • Ohm
Parameters:
  • 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.
Sensor Connected

Indicates if the sensor is connected correctly. If this is disabled, there is either no Pt100 or Pt1000 sensor connected, the sensor is connected incorrectly or the sensor itself is faulty.

Type:
  • Contact
UID:
  • tinkerforge:brickletptcv2:[UID]:BrickletPTCV2SensorConnected
Read only:
  • No

Actions

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:brickletptcv2:[UID]")
val hwVersion = actions.brickletPTCV2GetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletPTCV2GetTemperature()
Return Map:
  • temperature – Type: int, Unit: 1/100 °C, Range: [-24600 to 84900]

Returns the temperature of the connected sensor.

If you want to get the value periodically, it is recommended to use the Temperature channel. You can set the channel configuration with the configuration of Temperature.

brickletPTCV2IsSensorConnected()
Return Map:
  • connected – Type: boolean

Returns true if the sensor is connected correctly.

If this function returns false, there is either no Pt100 or Pt1000 sensor connected, the sensor is connected incorrectly or the sensor itself is faulty.

If you want to get the status automatically, it is recommended to use the Sensor Connected channel.

brickletPTCV2GetWireMode()
Return Map:
  • mode – Type: int, Range: See constants, Default: 2

Returns the wire mode as set by the thing configuration

The following constants are available for this function:

For mode:

  • val WIRE_MODE_2 = 2
  • val WIRE_MODE_3 = 3
  • val WIRE_MODE_4 = 4
brickletPTCV2GetResistance()
Return Map:
  • resistance – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1]

Returns the value as measured by the MAX31865 precision delta-sigma ADC.

The value can be converted with the following formulas:

  • Pt100: resistance = (value * 390) / 32768
  • Pt1000: resistance = (value * 3900) / 32768

If you want to get the value periodically, it is recommended to use the Resistance channel. You can set the channel configuration with the configuration of Resistance.

brickletPTCV2GetMovingAverageConfiguration()
Return Map:
  • movingAverageLengthResistance – Type: int, Range: [1 to 1000], Default: 1
  • movingAverageLengthTemperature – Type: int, Range: [1 to 1000], Default: 40

Returns the moving average configuration as set by the thing configuration.

Advanced Actions

brickletPTCV2GetNoiseRejectionFilter()
Return Map:
  • filter – Type: int, Range: See constants, Default: 0

Returns the noise rejection filter option as set by the thing configuration

The following constants are available for this function:

For filter:

  • val FILTER_OPTION_50HZ = 0
  • val FILTER_OPTION_60HZ = 1
brickletPTCV2GetChipTemperature()
Return Map:
  • 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.

brickletPTCV2GetStatusLEDConfig()
Return Map:
  • config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by the thing configuration

The following constants are available for this function:

For config:

  • val STATUS_LED_CONFIG_OFF = 0
  • val STATUS_LED_CONFIG_ON = 1
  • val STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • val STATUS_LED_CONFIG_SHOW_STATUS = 3
brickletPTCV2GetSPITFPErrorCount()
Return Map:
  • errorCountAckChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, 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.

brickletPTCV2Reset()

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!

brickletPTCV2GetIdentity()
Return Map:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • deviceIdentifier – 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. 

Internal Actions

brickletPTCV2ReadUID()
Return Map:
  • uid – Type: long, Range: [0 to 232 - 1]

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