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 TCP/IP protocol for the Dust Detector Bricklet. General information and technical specifications for the Dust Detector Bricklet are summarized in its hardware description.
A general description of the TCP/IP protocol structure can be found here.
Function ID: | 1 |
---|---|
Request: | empty payload |
Response: |
|
Returns the dust density in µg/m³.
If you want to get the dust density periodically, it is recommended to use the callback CALLBACK_DUST_DENSITY and set the period with set_dust_density_callback_period.
Function ID: | 10 |
---|---|
Request: |
|
Response: | no response |
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.
Function ID: | 11 |
---|---|
Request: | empty payload |
Response: |
|
Returns the length moving average as set by set_moving_average.
Function ID: | 255 |
---|---|
Request: | empty payload |
Response: |
|
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.
Function ID: | 2 |
---|---|
Request: |
|
Response: | no response |
Sets the period in ms with which the CALLBACK_DUST_DENSITY callback is triggered periodically. A value of 0 turns the callback off.
CALLBACK_DUST_DENSITY is only triggered if the dust density has changed since the last triggering.
The default value is 0.
Function ID: | 3 |
---|---|
Request: | empty payload |
Response: |
|
Returns the period as set by set_dust_density_callback_period.
Function ID: | 4 |
---|---|
Request: |
|
Response: | no response |
Sets the thresholds for the CALLBACK_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).
Function ID: | 5 |
---|---|
Request: | empty payload |
Response: |
|
Returns the threshold as set by set_dust_density_callback_threshold.
Function ID: | 6 |
---|---|
Request: |
|
Response: | no response |
Sets the period in ms with which the threshold callback
is triggered, if the threshold
keeps being reached.
The default value is 100.
Function ID: | 7 |
---|---|
Request: | empty payload |
Response: |
|
Returns the debounce period as set by set_debounce_period.
Function ID: | 8 |
---|---|
Response: |
|
This callback is triggered periodically with the period that is set by set_dust_density_callback_period. The response value is the dust density of the sensor.
CALLBACK_DUST_DENSITY is only triggered if the dust density value has changed since the last triggering.
Function ID: | 9 |
---|---|
Response: |
|
This callback is triggered when the threshold as set by set_dust_density_callback_threshold is reached. The response value 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.