Shell - Particulate Matter 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 Particulate Matter Bricklet

# Get current PM concentration
tinkerforge call particulate-matter-bricklet $uid get-pm-concentration

Callback¶

Download (example-callback.sh)

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

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

uid=XYZ # Change XYZ to the UID of your Particulate Matter Bricklet

# Handle incoming PM concentration callbacks
tinkerforge dispatch particulate-matter-bricklet $uid pm-concentration &

# Set period for PM concentration callback to 1s (1000ms)
tinkerforge call particulate-matter-bricklet $uid set-pm-concentration-callback-configuration 1000 false

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 particulate-matter-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

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

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

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

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

tinkerforge call particulate-matter-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 particulate-matter-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 particulate-matter-bricklet <uid> get-pm-concentration¶

Output:	pm10 – Type: Int, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm25 – Type: Int, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm100 – Type: Int, Unit: 1 µg/m³, Range: [0 to 216 - 1]

Returns the particulate matter concentration, broken down as:

• PM_1.0,
• PM_2.5 and
• PM_10.0.

If the sensor is disabled (see set-enable) then the last known good values from the sensor are returned.

If you want to get the values periodically, it is recommended to use the pm-concentration callback. You can set the callback configuration with set-pm-concentration-callback-configuration.

tinkerforge call particulate-matter-bricklet <uid> get-pm-count¶

Output:	greater03um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater05um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater10um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater25um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater50um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater100um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1]

Returns the number of particulates in 100 ml of air, broken down by their diameter:

• greater 0.3µm,
• greater 0.5µm,
• greater 1.0µm,
• greater 2.5µm,
• greater 5.0µm and
• greater 10.0µm.

If the sensor is disabled (see set-enable) then the last known good value from the sensor is returned.

If you want to get the values periodically, it is recommended to use the pm-count callback. You can set the callback configuration with set-pm-count-callback-configuration.

Advanced Functions¶

tinkerforge call particulate-matter-bricklet <uid> set-enable <enable>¶

Parameters:	<enable> – Type: Bool, Default: true
Output:	no output

Enables/Disables the fan and the laser diode of the sensors.

The sensor takes about 30 seconds after it is enabled to settle and produce stable values.

The laser diode has a lifetime of about 8000 hours. If you want to measure in an interval with a long idle time (e.g. hourly) you should turn the laser diode off between the measurements.

tinkerforge call particulate-matter-bricklet <uid> get-enable¶

Output:	enable – Type: Bool, Default: true

Returns the state of the sensor as set by set-enable.

tinkerforge call particulate-matter-bricklet <uid> get-sensor-info¶

Output:	sensor-version – Type: Int, Range: [0 to 255] last-error-code – Type: Int, Range: [0 to 255] framing-error-count – Type: Int, Range: [0 to 255] checksum-error-count – Type: Int, Range: [0 to 255]

Returns information about the sensor:

• the sensor version number,
• the last error code reported by the sensor (0 means no error) and
• the number of framing and checksum errors that occurred in the communication with the sensor.

tinkerforge call particulate-matter-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1] error-count-message-checksum – Type: Int, Range: [0 to 232 - 1] error-count-frame – Type: Int, Range: [0 to 232 - 1] error-count-overflow – Type: Int, 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.

tinkerforge call particulate-matter-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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

The following symbols are available for this function:

For <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call particulate-matter-bricklet <uid> get-status-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call particulate-matter-bricklet <uid> get-chip-temperature¶

Output:	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.

tinkerforge call particulate-matter-bricklet <uid> reset¶

Output:	no output

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!

tinkerforge call particulate-matter-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 particulate-matter-bricklet <uid> set-pm-concentration-callback-configuration <period> <value-has-to-change>¶

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

The period is the period with which the pm-concentration callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

tinkerforge call particulate-matter-bricklet <uid> get-pm-concentration-callback-configuration¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value-has-to-change – Type: Bool, Default: false

Returns the callback configuration as set by set-pm-concentration-callback-configuration.

tinkerforge call particulate-matter-bricklet <uid> set-pm-count-callback-configuration <period> <value-has-to-change>¶

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

The period is the period with which the pm-count callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

tinkerforge call particulate-matter-bricklet <uid> get-pm-count-callback-configuration¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value-has-to-change – Type: Bool, Default: false

Returns the callback configuration as set by set-pm-count-callback-configuration.

Callbacks¶

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

tinkerforge dispatch particulate-matter-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch particulate-matter-bricklet <uid> pm-concentration¶

Output:	pm10 – Type: Int, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm25 – Type: Int, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm100 – Type: Int, Unit: 1 µg/m³, Range: [0 to 216 - 1]

This callback is triggered periodically according to the configuration set by set-pm-concentration-callback-configuration.

The parameters are the same as get-pm-concentration.

tinkerforge dispatch particulate-matter-bricklet <uid> pm-count¶

Output:	greater03um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater05um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater10um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater25um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater50um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater100um – Type: Int, Unit: 10000 1/m³, Range: [0 to 216 - 1]

This callback is triggered periodically according to the configuration set by set-pm-count-callback-configuration.

The parameters are the same as get-pm-count.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

tinkerforge call particulate-matter-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	status – Type: Int, Range: See symbols

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following symbols are available for this function:

For <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call particulate-matter-bricklet <uid> get-bootloader-mode¶

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

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call particulate-matter-bricklet <uid> set-write-firmware-pointer <pointer>¶

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

Sets the firmware pointer for write-firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call particulate-matter-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	status – Type: Int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call particulate-matter-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 232 - 1]
Output:	no output

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

tinkerforge call particulate-matter-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 232 - 1]

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