Shell - CO2 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 CO2 Bricklet

# Get current CO2 concentration
tinkerforge call co2-bricklet $uid get-co2-concentration

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 CO2 Bricklet

# Handle incoming CO2 concentration callbacks
tinkerforge dispatch co2-bricklet $uid co2-concentration &

# Set period for CO2 concentration callback to 1s (1000ms)
# Note: The CO2 concentration callback is only called every second
#       if the CO2 concentration has changed since the last call!
tinkerforge call co2-bricklet $uid set-co2-concentration-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 CO2 Bricklet

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

# Handle incoming CO2 concentration reached callbacks
tinkerforge dispatch co2-bricklet $uid co2-concentration-reached &

# Configure threshold for CO2 concentration "greater than 750 ppm"
tinkerforge call co2-bricklet $uid set-co2-concentration-callback-threshold threshold-option-greater 750 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 co2-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

The call command is used to call a function of the CO2 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 CO2 Bricklet and exits

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

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

The dispatch command is used to dispatch a callback of the CO2 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 CO2 Bricklet and exits

tinkerforge call co2-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 co2-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 co2-bricklet <uid> get-co2-concentration¶

Output:	co2-concentration – Type: Int, Unit: 1 ppm, Range: [0 to 10000]

Returns the measured CO2 concentration.

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

Advanced Functions¶

tinkerforge call co2-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 co2-bricklet <uid> set-co2-concentration-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 co2-concentration callback is triggered periodically. A value of 0 turns the callback off.

The co2-concentration callback is only triggered if the CO2 concentration has changed since the last triggering.

tinkerforge call co2-bricklet <uid> get-co2-concentration-callback-period¶

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

Returns the period as set by set-co2-concentration-callback-period.

tinkerforge call co2-bricklet <uid> set-co2-concentration-callback-threshold <option> <min> <max>¶

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

Sets the thresholds for the co2-concentration-reached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the CO2 concentration is outside the min and max values
'i'	Callback is triggered when the CO2 concentration is inside the min and max values
'<'	Callback is triggered when the CO2 concentration is smaller than the min value (max is ignored)
'>'	Callback is triggered when the CO2 concentration 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 co2-bricklet <uid> get-co2-concentration-callback-threshold¶

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

Returns the threshold as set by set-co2-concentration-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 co2-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 callbacks

• co2-concentration-reached,

are triggered, if the thresholds

• set-co2-concentration-callback-threshold,

keep being reached.

tinkerforge call co2-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.

Callbacks¶

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

tinkerforge dispatch co2-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch co2-bricklet <uid> co2-concentration¶

Output:	co2-concentration – Type: Int, Unit: 1 ppm, Range: [0 to 10000]

This callback is triggered periodically with the period that is set by set-co2-concentration-callback-period. The parameter is the CO2 concentration of the sensor.

The co2-concentration callback is only triggered if the CO2 concentration has changed since the last triggering.

tinkerforge dispatch co2-bricklet <uid> co2-concentration-reached¶

Output:	co2-concentration – Type: Int, Unit: 1 ppm, Range: [0 to 10000]

This callback is triggered when the threshold as set by set-co2-concentration-callback-threshold is reached. The parameter is the CO2 concentration.

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