Note
This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.
This is the description of the Shell API bindings for the Dust Detector Bricklet. General information and technical specifications for the Dust Detector Bricklet are summarized in its hardware description.
An installation guide for the Shell API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the Dust Detector Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Dust Detector Bricklet. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
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 send and errors are silently ignored, because they cannot be detected.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Output: |
|
---|
Returns the dust density in µg/m³.
If you want to get the dust density periodically, it is recommended to use the callback dust-density and set the period with set-dust-density-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the length of a moving averaging for the dust_density.
Setting the length to 0 will turn the averaging completely off. With less averaging, there is more noise on the data.
The range for the averaging is 0-100.
The default value is 100.
Output: |
|
---|
Returns the length moving average as set by set-moving-average.
Output: |
|
---|
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' or 'd'.
The device identifier numbers can be found here.
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the dust-density callback is triggered periodically. A value of 0 turns the callback off.
dust-density is only triggered if the dust density has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by set-dust-density-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the thresholds for the dust-density-reached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the dust density value is outside the min and max values |
'i' | Callback is triggered when the dust density value is inside the min and max values |
'<' | Callback is triggered when the dust density value is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the dust density value is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following symbols are available for this function:
Output: |
|
---|
Returns the threshold as set by set-dust-density-callback-threshold.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the threshold callback
is triggered, if the threshold
keeps being reached.
The default value is 100.
Output: |
|
---|
Returns the debounce period as set by set-debounce-period.
Callbacks can be used to receive time critical or recurring data from the device:
tinkerforge dispatch dust-detector-bricklet <uid> example
The available callbacks are described below.
Note
Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.
Output: |
|
---|
This callback is triggered periodically with the period that is set by set-dust-density-callback-period. The parameter is the dust density of the sensor.
dust-density is only triggered if the dust density value has changed since the last triggering.
Output: |
|
---|
This callback is triggered when the threshold as set by set-dust-density-callback-threshold is reached. The parameter is the dust density of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by set-debounce-period.