Shell - PTC Bricklet¶

Simple¶

Download (example-simple.sh)

1
2
3
4
5
6
7

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your PTC Bricklet

# Get current temperature
tinkerforge call ptc-bricklet $uid get-temperature

Callback¶

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your PTC Bricklet

# Handle incoming temperature callbacks
tinkerforge dispatch ptc-bricklet $uid temperature &

# Set period for temperature callback to 1s (1000ms)
# Note: The temperature callback is only called every second
#       if the temperature has changed since the last call!
tinkerforge call ptc-bricklet $uid set-temperature-callback-period 1000

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Threshold¶

Download (example-threshold.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your PTC Bricklet

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call ptc-bricklet $uid set-debounce-period 10000

# Handle incoming temperature reached callbacks
tinkerforge dispatch ptc-bricklet $uid temperature-reached &

# Configure threshold for temperature "greater than 30 °C"
tinkerforge call ptc-bricklet $uid set-temperature-callback-threshold threshold-option-greater 3000 0

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call ptc-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the PTC Bricklet. It can take several options:

• --help shows help for the specific call command and exits
• --list-functions shows a list of known functions of the PTC Bricklet and exits

tinkerforge dispatch ptc-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the PTC Bricklet. It can take several options:

• --help shows help for the specific dispatch command and exits
• --list-callbacks shows a list of known callbacks of the PTC Bricklet and exits

tinkerforge call ptc-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

• --help shows help for the specific function and exits

Getter functions can take the following options:

• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

• --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch ptc-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: String

The <callback> to be dispatched can take several options:

• --help shows help for the specific callback and exits
• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions¶

tinkerforge call ptc-bricklet <uid> get-temperature¶

Output:	temperature – Type: Int, Unit: 1/100 °C, Range: [-24600 to 84900]

Returns the temperature of connected sensor.

If you want to get the temperature periodically, it is recommended to use the temperature callback and set the period with set-temperature-callback-period.

tinkerforge call ptc-bricklet <uid> is-sensor-connected¶

Output:	connected – Type: Bool

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.

tinkerforge call ptc-bricklet <uid> set-wire-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols, Default: 2
Output:	no output

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

The following symbols are available for this function:

For <mode>:

• wire-mode-2 = 2
• wire-mode-3 = 3
• wire-mode-4 = 4

tinkerforge call ptc-bricklet <uid> get-wire-mode¶

Output:	mode – Type: Int, Range: See symbols, Default: 2

Returns the wire mode as set by set-wire-mode

The following symbols are available for this function:

For mode:

• wire-mode-2 = 2
• wire-mode-3 = 3
• wire-mode-4 = 4

Advanced Functions¶

tinkerforge call ptc-bricklet <uid> get-resistance¶

Output:	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 resistance periodically, it is recommended to use the resistance callback and set the period with set-resistance-callback-period.

tinkerforge call ptc-bricklet <uid> set-noise-rejection-filter <filter>¶

Parameters:	<filter> – Type: Int, Range: See symbols, Default: 0
Output:	no output

Sets the noise rejection filter to either 50Hz (0) or 60Hz (1). Noise from 50Hz or 60Hz power sources (including harmonics of the AC power's fundamental frequency) is attenuated by 82dB.

The following symbols are available for this function:

For <filter>:

• filter-option-50hz = 0
• filter-option-60hz = 1

tinkerforge call ptc-bricklet <uid> get-noise-rejection-filter¶

Output:	filter – Type: Int, Range: See symbols, Default: 0

Returns the noise rejection filter option as set by set-noise-rejection-filter

The following symbols are available for this function:

For filter:

• filter-option-50hz = 0
• filter-option-60hz = 1

tinkerforge call ptc-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, 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] firmware-version – Type: Int Array, 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] 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. 

Callback Configuration Functions¶

tinkerforge call ptc-bricklet <uid> set-temperature-callback-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

Sets the period with which the temperature callback is triggered periodically. A value of 0 turns the callback off.

The temperature callback is only triggered if the temperature has changed since the last triggering.

tinkerforge call ptc-bricklet <uid> get-temperature-callback-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-temperature-callback-period.

tinkerforge call ptc-bricklet <uid> set-resistance-callback-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

Sets the period with which the resistance callback is triggered periodically. A value of 0 turns the callback off.

The resistance callback is only triggered if the resistance has changed since the last triggering.

tinkerforge call ptc-bricklet <uid> get-resistance-callback-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-resistance-callback-period.

tinkerforge call ptc-bricklet <uid> set-temperature-callback-threshold <option> <min> <max>¶

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0 <max> – Type: Int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
Output:	no output

Sets the thresholds for the temperature-reached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the temperature is outside the min and max values
'i'	Callback is triggered when the temperature is inside the min and max values
'<'	Callback is triggered when the temperature is smaller than the min value (max is ignored)
'>'	Callback is triggered when the temperature is greater than the min value (max is ignored)

The following symbols are available for this function:

For <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call ptc-bricklet <uid> get-temperature-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0 max – Type: Int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by set-temperature-callback-threshold.

The following symbols are available for this function:

For option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call ptc-bricklet <uid> set-resistance-callback-threshold <option> <min> <max>¶

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0 <max> – Type: Int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0
Output:	no output

Sets the thresholds for the resistance-reached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the temperature is outside the min and max values
'i'	Callback is triggered when the temperature is inside the min and max values
'<'	Callback is triggered when the temperature is smaller than the min value (max is ignored)
'>'	Callback is triggered when the temperature is greater than the min value (max is ignored)

The following symbols are available for this function:

For <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call ptc-bricklet <uid> get-resistance-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0 max – Type: Int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by set-resistance-callback-threshold.

The following symbols are available for this function:

For option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call ptc-bricklet <uid> set-debounce-period <debounce>¶

Parameters:	<debounce> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Output:	no output

Sets the period with which the threshold callback

• temperature-reached,
• resistance-reached

is triggered, if the threshold

• set-temperature-callback-threshold,
• set-resistance-callback-threshold

keeps being reached.

tinkerforge call ptc-bricklet <uid> get-debounce-period¶

Output:	debounce – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by set-debounce-period.

tinkerforge call ptc-bricklet <uid> set-sensor-connected-callback-configuration <enabled>¶

Parameters:	<enabled> – Type: Bool, Default: false
Output:	no output

If you enable this callback, the sensor-connected callback is triggered every time a Pt sensor is connected/disconnected.

New in version 2.0.2 (Plugin).

tinkerforge call ptc-bricklet <uid> get-sensor-connected-callback-configuration¶

Output:	enabled – Type: Bool, Default: false

Returns the configuration as set by set-sensor-connected-callback-configuration.

New in version 2.0.2 (Plugin).

Callbacks¶

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch ptc-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch ptc-bricklet <uid> temperature¶

Output:	temperature – Type: Int, Unit: 1/100 °C, Range: [-24600 to 84900]

This callback is triggered periodically with the period that is set by set-temperature-callback-period. The parameter is the temperature of the connected sensor.

The temperature callback is only triggered if the temperature has changed since the last triggering.

tinkerforge dispatch ptc-bricklet <uid> temperature-reached¶

Output:	temperature – Type: Int, Unit: 1/100 °C, Range: [-24600 to 84900]

This callback is triggered when the threshold as set by set-temperature-callback-threshold is reached. The parameter is the temperature of the connected sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set-debounce-period.

tinkerforge dispatch ptc-bricklet <uid> resistance¶

Output:	resistance – Type: Int, Unit: ? Ω, Range: [-231 to 231 - 1]

This callback is triggered periodically with the period that is set by set-resistance-callback-period. The parameter is the resistance of the connected sensor.

The resistance callback is only triggered if the resistance has changed since the last triggering.

tinkerforge dispatch ptc-bricklet <uid> resistance-reached¶

Output:	resistance – Type: Int, Unit: ? Ω, Range: [-231 to 231 - 1]

This callback is triggered when the threshold as set by set-resistance-callback-threshold is reached. The parameter is the resistance of the connected sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set-debounce-period.

tinkerforge dispatch ptc-bricklet <uid> sensor-connected¶

Output:	connected – Type: Bool

This callback is triggered periodically according to the configuration set by set-sensor-connected-callback-configuration.

The parameter is the same as is-sensor-connected.

New in version 2.0.2 (Plugin).