Documentation ¶
Overview ¶
Measures dust density.
See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/DustDetector_Bricklet_Go.html.
Index ¶
- Constants
- type DustDetectorBricklet
- func (device *DustDetectorBricklet) DeregisterDustDensityCallback(registrationId uint64)
- func (device *DustDetectorBricklet) DeregisterDustDensityReachedCallback(registrationId uint64)
- func (device *DustDetectorBricklet) GetAPIVersion() [3]uint8
- func (device *DustDetectorBricklet) GetDebouncePeriod() (debounce uint32, err error)
- func (device *DustDetectorBricklet) GetDustDensity() (dustDensity uint16, err error)
- func (device *DustDetectorBricklet) GetDustDensityCallbackPeriod() (period uint32, err error)
- func (device *DustDetectorBricklet) GetDustDensityCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)
- func (device *DustDetectorBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, ...)
- func (device *DustDetectorBricklet) GetMovingAverage() (average uint8, err error)
- func (device *DustDetectorBricklet) GetResponseExpected(functionID Function) (bool, error)
- func (device *DustDetectorBricklet) RegisterDustDensityCallback(fn func(uint16)) uint64
- func (device *DustDetectorBricklet) RegisterDustDensityReachedCallback(fn func(uint16)) uint64
- func (device *DustDetectorBricklet) SetDebouncePeriod(debounce uint32) (err error)
- func (device *DustDetectorBricklet) SetDustDensityCallbackPeriod(period uint32) (err error)
- func (device *DustDetectorBricklet) SetDustDensityCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)
- func (device *DustDetectorBricklet) SetMovingAverage(average uint8) (err error)
- func (device *DustDetectorBricklet) SetResponseExpected(functionID Function, responseExpected bool) error
- func (device *DustDetectorBricklet) SetResponseExpectedAll(responseExpected bool)
- type Function
- type ThresholdOption
Constants ¶
const DeviceDisplayName = "Dust Detector Bricklet"
const DeviceIdentifier = 260
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DustDetectorBricklet ¶
type DustDetectorBricklet struct {
// contains filtered or unexported fields
}
func New ¶
func New(uid string, ipcon *ipconnection.IPConnection) (DustDetectorBricklet, error)
Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.
func (*DustDetectorBricklet) DeregisterDustDensityCallback ¶
func (device *DustDetectorBricklet) DeregisterDustDensityCallback(registrationId uint64)
Remove a registered Dust Density callback.
func (*DustDetectorBricklet) DeregisterDustDensityReachedCallback ¶
func (device *DustDetectorBricklet) DeregisterDustDensityReachedCallback(registrationId uint64)
Remove a registered Dust Density Reached callback.
func (*DustDetectorBricklet) GetAPIVersion ¶
func (device *DustDetectorBricklet) GetAPIVersion() [3]uint8
Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.
func (*DustDetectorBricklet) GetDebouncePeriod ¶
func (device *DustDetectorBricklet) GetDebouncePeriod() (debounce uint32, err error)
Returns the debounce period as set by SetDebouncePeriod.
func (*DustDetectorBricklet) GetDustDensity ¶
func (device *DustDetectorBricklet) GetDustDensity() (dustDensity uint16, err error)
Returns the dust density.
If you want to get the dust density periodically, it is recommended to use the RegisterDustDensityCallback callback and set the period with SetDustDensityCallbackPeriod.
func (*DustDetectorBricklet) GetDustDensityCallbackPeriod ¶
func (device *DustDetectorBricklet) GetDustDensityCallbackPeriod() (period uint32, err error)
Returns the period as set by SetDustDensityCallbackPeriod.
func (*DustDetectorBricklet) GetDustDensityCallbackThreshold ¶
func (device *DustDetectorBricklet) GetDustDensityCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)
Returns the threshold as set by SetDustDensityCallbackThreshold.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*DustDetectorBricklet) GetIdentity ¶
func (device *DustDetectorBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
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 <isolator_bricklet>` is always at position 'z'.
The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|
func (*DustDetectorBricklet) GetMovingAverage ¶
func (device *DustDetectorBricklet) GetMovingAverage() (average uint8, err error)
Returns the length moving average as set by SetMovingAverage.
func (*DustDetectorBricklet) GetResponseExpected ¶
func (device *DustDetectorBricklet) GetResponseExpected(functionID Function) (bool, error)
Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.
For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.
See SetResponseExpected for the list of function ID constants available for this function.
func (*DustDetectorBricklet) RegisterDustDensityCallback ¶
func (device *DustDetectorBricklet) RegisterDustDensityCallback(fn func(uint16)) uint64
This callback is triggered periodically with the period that is set by SetDustDensityCallbackPeriod. The parameter is the dust density of the sensor.
Der RegisterDustDensityCallback callback is only triggered if the dust density value has changed since the last triggering.
func (*DustDetectorBricklet) RegisterDustDensityReachedCallback ¶
func (device *DustDetectorBricklet) RegisterDustDensityReachedCallback(fn func(uint16)) uint64
This callback is triggered when the threshold as set by SetDustDensityCallbackThreshold 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 SetDebouncePeriod.
func (*DustDetectorBricklet) SetDebouncePeriod ¶
func (device *DustDetectorBricklet) SetDebouncePeriod(debounce uint32) (err error)
Sets the period with which the threshold callback
* RegisterDustDensityReachedCallback
is triggered, if the threshold
* SetDustDensityCallbackThreshold
keeps being reached.
func (*DustDetectorBricklet) SetDustDensityCallbackPeriod ¶
func (device *DustDetectorBricklet) SetDustDensityCallbackPeriod(period uint32) (err error)
Sets the period with which the RegisterDustDensityCallback callback is triggered periodically. A value of 0 turns the callback off.
The RegisterDustDensityCallback callback is only triggered if the dust density has changed since the last triggering.
func (*DustDetectorBricklet) SetDustDensityCallbackThreshold ¶
func (device *DustDetectorBricklet) SetDustDensityCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)
Sets the thresholds for the RegisterDustDensityReachedCallback 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)
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*DustDetectorBricklet) SetMovingAverage ¶
func (device *DustDetectorBricklet) SetMovingAverage(average uint8) (err error)
Sets the length of a https://en.wikipedia.org/wiki/Moving_average 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.
func (*DustDetectorBricklet) SetResponseExpected ¶
func (device *DustDetectorBricklet) SetResponseExpected(functionID Function, responseExpected bool) error
Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.
func (*DustDetectorBricklet) SetResponseExpectedAll ¶
func (device *DustDetectorBricklet) SetResponseExpectedAll(responseExpected bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
type Function ¶
type Function = uint8
const ( FunctionGetDustDensity Function = 1 FunctionSetDustDensityCallbackPeriod Function = 2 FunctionGetDustDensityCallbackPeriod Function = 3 FunctionSetDustDensityCallbackThreshold Function = 4 FunctionGetDustDensityCallbackThreshold Function = 5 FunctionSetDebouncePeriod Function = 6 FunctionGetDebouncePeriod Function = 7 FunctionSetMovingAverage Function = 10 FunctionGetMovingAverage Function = 11 FunctionGetIdentity Function = 255 FunctionCallbackDustDensity Function = 8 FunctionCallbackDustDensityReached Function = 9 )
type ThresholdOption ¶
type ThresholdOption = rune
const ( ThresholdOptionOff ThresholdOption = 'x' ThresholdOptionOutside ThresholdOption = 'o' ThresholdOptionInside ThresholdOption = 'i' ThresholdOptionSmaller ThresholdOption = '<' ThresholdOptionGreater ThresholdOption = '>' )