Documentation ¶
Overview ¶
Measures IAQ index, temperature, humidity and air pressure.
See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/AirQuality_Bricklet_Go.html.
Index ¶
- Constants
- type Accuracy
- type AirQualityBricklet
- func (device *AirQualityBricklet) DeregisterAirPressureCallback(registrationId uint64)
- func (device *AirQualityBricklet) DeregisterAllValuesCallback(registrationId uint64)
- func (device *AirQualityBricklet) DeregisterHumidityCallback(registrationId uint64)
- func (device *AirQualityBricklet) DeregisterIAQIndexCallback(registrationId uint64)
- func (device *AirQualityBricklet) DeregisterTemperatureCallback(registrationId uint64)
- func (device *AirQualityBricklet) GetAPIVersion() [3]uint8
- func (device *AirQualityBricklet) GetAirPressure() (airPressure int32, err error)
- func (device *AirQualityBricklet) GetAirPressureCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, ...)
- func (device *AirQualityBricklet) GetAllValues() (iaqIndex int32, iaqIndexAccuracy Accuracy, temperature int32, humidity int32, ...)
- func (device *AirQualityBricklet) GetAllValuesCallbackConfiguration() (period uint32, valueHasToChange bool, err error)
- func (device *AirQualityBricklet) GetBackgroundCalibrationDuration() (duration Duration, err error)
- func (device *AirQualityBricklet) GetBootloaderMode() (mode BootloaderMode, err error)
- func (device *AirQualityBricklet) GetChipTemperature() (temperature int16, err error)
- func (device *AirQualityBricklet) GetHumidity() (humidity int32, err error)
- func (device *AirQualityBricklet) GetHumidityCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, ...)
- func (device *AirQualityBricklet) GetIAQIndex() (iaqIndex int32, iaqIndexAccuracy Accuracy, err error)
- func (device *AirQualityBricklet) GetIAQIndexCallbackConfiguration() (period uint32, valueHasToChange bool, err error)
- func (device *AirQualityBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, ...)
- func (device *AirQualityBricklet) GetResponseExpected(functionID Function) (bool, error)
- func (device *AirQualityBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, ...)
- func (device *AirQualityBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)
- func (device *AirQualityBricklet) GetTemperature() (temperature int32, err error)
- func (device *AirQualityBricklet) GetTemperatureCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, ...)
- func (device *AirQualityBricklet) GetTemperatureOffset() (offset int32, err error)
- func (device *AirQualityBricklet) ReadUID() (uid uint32, err error)
- func (device *AirQualityBricklet) RegisterAirPressureCallback(fn func(int32)) uint64
- func (device *AirQualityBricklet) RegisterAllValuesCallback(fn func(int32, Accuracy, int32, int32, int32)) uint64
- func (device *AirQualityBricklet) RegisterHumidityCallback(fn func(int32)) uint64
- func (device *AirQualityBricklet) RegisterIAQIndexCallback(fn func(int32, Accuracy)) uint64
- func (device *AirQualityBricklet) RegisterTemperatureCallback(fn func(int32)) uint64
- func (device *AirQualityBricklet) RemoveCalibration() (err error)
- func (device *AirQualityBricklet) Reset() (err error)
- func (device *AirQualityBricklet) SetAirPressureCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, ...) (err error)
- func (device *AirQualityBricklet) SetAllValuesCallbackConfiguration(period uint32, valueHasToChange bool) (err error)
- func (device *AirQualityBricklet) SetBackgroundCalibrationDuration(duration Duration) (err error)
- func (device *AirQualityBricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)
- func (device *AirQualityBricklet) SetHumidityCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, ...) (err error)
- func (device *AirQualityBricklet) SetIAQIndexCallbackConfiguration(period uint32, valueHasToChange bool) (err error)
- func (device *AirQualityBricklet) SetResponseExpected(functionID Function, responseExpected bool) error
- func (device *AirQualityBricklet) SetResponseExpectedAll(responseExpected bool)
- func (device *AirQualityBricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)
- func (device *AirQualityBricklet) SetTemperatureCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, ...) (err error)
- func (device *AirQualityBricklet) SetTemperatureOffset(offset int32) (err error)
- func (device *AirQualityBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
- func (device *AirQualityBricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
- func (device *AirQualityBricklet) WriteUID(uid uint32) (err error)
- type BootloaderMode
- type BootloaderStatus
- type Duration
- type Function
- type StatusLEDConfig
- type ThresholdOption
Constants ¶
const DeviceDisplayName = "Air Quality Bricklet"
const DeviceIdentifier = 297
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AirQualityBricklet ¶
type AirQualityBricklet struct {
// contains filtered or unexported fields
}
func New ¶
func New(uid string, ipcon *ipconnection.IPConnection) (AirQualityBricklet, error)
Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.
func (*AirQualityBricklet) DeregisterAirPressureCallback ¶
func (device *AirQualityBricklet) DeregisterAirPressureCallback(registrationId uint64)
Remove a registered Air Pressure callback.
func (*AirQualityBricklet) DeregisterAllValuesCallback ¶
func (device *AirQualityBricklet) DeregisterAllValuesCallback(registrationId uint64)
Remove a registered All Values callback.
func (*AirQualityBricklet) DeregisterHumidityCallback ¶
func (device *AirQualityBricklet) DeregisterHumidityCallback(registrationId uint64)
Remove a registered Humidity callback.
func (*AirQualityBricklet) DeregisterIAQIndexCallback ¶
func (device *AirQualityBricklet) DeregisterIAQIndexCallback(registrationId uint64)
Remove a registered IAQ Index callback.
func (*AirQualityBricklet) DeregisterTemperatureCallback ¶
func (device *AirQualityBricklet) DeregisterTemperatureCallback(registrationId uint64)
Remove a registered Temperature callback.
func (*AirQualityBricklet) GetAPIVersion ¶
func (device *AirQualityBricklet) 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 (*AirQualityBricklet) GetAirPressure ¶
func (device *AirQualityBricklet) GetAirPressure() (airPressure int32, err error)
Returns air pressure.
If you want to get the value periodically, it is recommended to use the RegisterAirPressureCallback callback. You can set the callback configuration with SetAirPressureCallbackConfiguration.
func (*AirQualityBricklet) GetAirPressureCallbackConfiguration ¶
func (device *AirQualityBricklet) GetAirPressureCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32, err error)
Returns the callback configuration as set by SetAirPressureCallbackConfiguration.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AirQualityBricklet) GetAllValues ¶
func (device *AirQualityBricklet) GetAllValues() (iaqIndex int32, iaqIndexAccuracy Accuracy, temperature int32, humidity int32, airPressure int32, err error)
Returns all values measured by the Air Quality Bricklet. The values are IAQ (Indoor Air Quality) Index (higher value means greater level of air pollution), IAQ Index Accuracy, Temperature, Humidity and Air Pressure.
.. image:: /Images/Misc/bricklet_air_quality_iaq_index.png
:scale: 100 % :alt: Air Quality Index description :align: center :target: ../../_images/Misc/bricklet_air_quality_iaq_index.png
Associated constants:
- AccuracyUnreliable
- AccuracyLow
- AccuracyMedium
- AccuracyHigh
func (*AirQualityBricklet) GetAllValuesCallbackConfiguration ¶
func (device *AirQualityBricklet) GetAllValuesCallbackConfiguration() (period uint32, valueHasToChange bool, err error)
Returns the callback configuration as set by SetAllValuesCallbackConfiguration.
func (*AirQualityBricklet) GetBackgroundCalibrationDuration ¶
func (device *AirQualityBricklet) GetBackgroundCalibrationDuration() (duration Duration, err error)
Returns the background calibration duration as set by SetBackgroundCalibrationDuration.
.. versionadded:: 2.0.3$nbsp;(Plugin)
Associated constants:
- Duration4Days
- Duration28Days
func (*AirQualityBricklet) GetBootloaderMode ¶
func (device *AirQualityBricklet) GetBootloaderMode() (mode BootloaderMode, err error)
Returns the current bootloader mode, see SetBootloaderMode.
Associated constants:
- BootloaderModeBootloader
- BootloaderModeFirmware
- BootloaderModeBootloaderWaitForReboot
- BootloaderModeFirmwareWaitForReboot
- BootloaderModeFirmwareWaitForEraseAndReboot
func (*AirQualityBricklet) GetChipTemperature ¶
func (device *AirQualityBricklet) GetChipTemperature() (temperature int16, err error)
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.
func (*AirQualityBricklet) GetHumidity ¶
func (device *AirQualityBricklet) GetHumidity() (humidity int32, err error)
Returns relative humidity.
If you want to get the value periodically, it is recommended to use the RegisterHumidityCallback callback. You can set the callback configuration with SetHumidityCallbackConfiguration.
func (*AirQualityBricklet) GetHumidityCallbackConfiguration ¶
func (device *AirQualityBricklet) GetHumidityCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32, err error)
Returns the callback configuration as set by SetHumidityCallbackConfiguration.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AirQualityBricklet) GetIAQIndex ¶
func (device *AirQualityBricklet) GetIAQIndex() (iaqIndex int32, iaqIndexAccuracy Accuracy, err error)
Returns the IAQ index and accuracy. The higher the IAQ index, the greater the level of air pollution.
.. image:: /Images/Misc/bricklet_air_quality_iaq_index.png
:scale: 100 % :alt: IAQ index description :align: center :target: ../../_images/Misc/bricklet_air_quality_iaq_index.png
If you want to get the value periodically, it is recommended to use the RegisterIAQIndexCallback callback. You can set the callback configuration with SetIAQIndexCallbackConfiguration.
Associated constants:
- AccuracyUnreliable
- AccuracyLow
- AccuracyMedium
- AccuracyHigh
func (*AirQualityBricklet) GetIAQIndexCallbackConfiguration ¶
func (device *AirQualityBricklet) GetIAQIndexCallbackConfiguration() (period uint32, valueHasToChange bool, err error)
Returns the callback configuration as set by SetIAQIndexCallbackConfiguration.
func (*AirQualityBricklet) GetIdentity ¶
func (device *AirQualityBricklet) 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 (*AirQualityBricklet) GetResponseExpected ¶
func (device *AirQualityBricklet) 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 (*AirQualityBricklet) GetSPITFPErrorCount ¶
func (device *AirQualityBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
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.
func (*AirQualityBricklet) GetStatusLEDConfig ¶
func (device *AirQualityBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)
Returns the configuration as set by SetStatusLEDConfig
Associated constants:
- StatusLEDConfigOff
- StatusLEDConfigOn
- StatusLEDConfigShowHeartbeat
- StatusLEDConfigShowStatus
func (*AirQualityBricklet) GetTemperature ¶
func (device *AirQualityBricklet) GetTemperature() (temperature int32, err error)
Returns temperature.
If you want to get the value periodically, it is recommended to use the RegisterTemperatureCallback callback. You can set the callback configuration with SetTemperatureCallbackConfiguration.
func (*AirQualityBricklet) GetTemperatureCallbackConfiguration ¶
func (device *AirQualityBricklet) GetTemperatureCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32, err error)
Returns the callback configuration as set by SetTemperatureCallbackConfiguration.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AirQualityBricklet) GetTemperatureOffset ¶
func (device *AirQualityBricklet) GetTemperatureOffset() (offset int32, err error)
Returns the temperature offset as set by SetTemperatureOffset.
func (*AirQualityBricklet) ReadUID ¶
func (device *AirQualityBricklet) ReadUID() (uid uint32, err error)
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
func (*AirQualityBricklet) RegisterAirPressureCallback ¶
func (device *AirQualityBricklet) RegisterAirPressureCallback(fn func(int32)) uint64
This callback is triggered periodically according to the configuration set by SetAirPressureCallbackConfiguration.
The parameter is the same as GetAirPressure.
func (*AirQualityBricklet) RegisterAllValuesCallback ¶
func (device *AirQualityBricklet) RegisterAllValuesCallback(fn func(int32, Accuracy, int32, int32, int32)) uint64
This callback is triggered periodically according to the configuration set by SetAllValuesCallbackConfiguration.
The parameters are the same as GetAllValues.
func (*AirQualityBricklet) RegisterHumidityCallback ¶
func (device *AirQualityBricklet) RegisterHumidityCallback(fn func(int32)) uint64
This callback is triggered periodically according to the configuration set by SetHumidityCallbackConfiguration.
The parameter is the same as GetHumidity.
func (*AirQualityBricklet) RegisterIAQIndexCallback ¶
func (device *AirQualityBricklet) RegisterIAQIndexCallback(fn func(int32, Accuracy)) uint64
This callback is triggered periodically according to the configuration set by SetIAQIndexCallbackConfiguration.
The parameters are the same as GetIAQIndex.
func (*AirQualityBricklet) RegisterTemperatureCallback ¶
func (device *AirQualityBricklet) RegisterTemperatureCallback(fn func(int32)) uint64
This callback is triggered periodically according to the configuration set by SetTemperatureCallbackConfiguration.
The parameter is the same as GetTemperature.
func (*AirQualityBricklet) RemoveCalibration ¶
func (device *AirQualityBricklet) RemoveCalibration() (err error)
Deletes the calibration from flash. After you call this function, you need to power cycle the Air Quality Bricklet.
On the next power up the Bricklet will start a new calibration, as if it was started for the very first time.
The calibration is based on the data of the last four days, so it takes four days until a full calibration is re-established.
.. versionadded:: 2.0.3$nbsp;(Plugin)
func (*AirQualityBricklet) Reset ¶
func (device *AirQualityBricklet) Reset() (err error)
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!
func (*AirQualityBricklet) SetAirPressureCallbackConfiguration ¶
func (device *AirQualityBricklet) SetAirPressureCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32) (err error)
The period is the period with which the RegisterAirPressureCallback 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.
It is furthermore possible to constrain the callback with thresholds.
The `option`-parameter together with min/max sets a threshold for the RegisterAirPressureCallback callback.
The following options are possible:
Option| Description --- | --- 'x'| Threshold is turned off 'o'| Threshold is triggered when the value is *outside* the min and max values 'i'| Threshold is triggered when the value is *inside* or equal to the min and max values '<'| Threshold is triggered when the value is smaller than the min value (max is ignored) '>'| Threshold is triggered when the value is greater than the min value (max is ignored)
If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AirQualityBricklet) SetAllValuesCallbackConfiguration ¶
func (device *AirQualityBricklet) SetAllValuesCallbackConfiguration(period uint32, valueHasToChange bool) (err error)
The period is the period with which the RegisterAllValuesCallback 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 at least one of the values has changed. If the values 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.
func (*AirQualityBricklet) SetBackgroundCalibrationDuration ¶
func (device *AirQualityBricklet) SetBackgroundCalibrationDuration(duration Duration) (err error)
The Air Quality Bricklet uses an automatic background calibration mechanism to calculate the IAQ Index. This calibration mechanism considers a history of measured data. The duration of this history can be configured to either be 4 days or 28 days.
If you keep the Bricklet mostly at one place and it does not get moved around to different environments, we recommend that you use a duration of 28 days.
If you change the duration, the current calibration will be discarded and the calibration will start from beginning again. The configuration of the duration is saved in flash, so you should only have to call this function once in the lifetime of the Bricklet.
The Bricklet has to be power cycled after this function is called for a duration change to take effect.
Before firmware version 2.0.3 this was not configurable and the duration was 4 days.
The default value (since firmware version 2.0.3) is 28 days.
.. versionadded:: 2.0.3$nbsp;(Plugin)
Associated constants:
- Duration4Days
- Duration28Days
func (*AirQualityBricklet) SetBootloaderMode ¶
func (device *AirQualityBricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)
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.
Associated constants:
- BootloaderModeBootloader
- BootloaderModeFirmware
- BootloaderModeBootloaderWaitForReboot
- BootloaderModeFirmwareWaitForReboot
- BootloaderModeFirmwareWaitForEraseAndReboot
- BootloaderStatusOK
- BootloaderStatusInvalidMode
- BootloaderStatusNoChange
- BootloaderStatusEntryFunctionNotPresent
- BootloaderStatusDeviceIdentifierIncorrect
- BootloaderStatusCRCMismatch
func (*AirQualityBricklet) SetHumidityCallbackConfiguration ¶
func (device *AirQualityBricklet) SetHumidityCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32) (err error)
The period is the period with which the RegisterHumidityCallback 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.
It is furthermore possible to constrain the callback with thresholds.
The `option`-parameter together with min/max sets a threshold for the RegisterHumidityCallback callback.
The following options are possible:
Option| Description --- | --- 'x'| Threshold is turned off 'o'| Threshold is triggered when the value is *outside* the min and max values 'i'| Threshold is triggered when the value is *inside* or equal to the min and max values '<'| Threshold is triggered when the value is smaller than the min value (max is ignored) '>'| Threshold is triggered when the value is greater than the min value (max is ignored)
If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AirQualityBricklet) SetIAQIndexCallbackConfiguration ¶
func (device *AirQualityBricklet) SetIAQIndexCallbackConfiguration(period uint32, valueHasToChange bool) (err error)
The period is the period with which the RegisterIAQIndexCallback 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 at least one of the values has changed. If the values 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.
func (*AirQualityBricklet) SetResponseExpected ¶
func (device *AirQualityBricklet) 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 (*AirQualityBricklet) SetResponseExpectedAll ¶
func (device *AirQualityBricklet) SetResponseExpectedAll(responseExpected bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
func (*AirQualityBricklet) SetStatusLEDConfig ¶
func (device *AirQualityBricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)
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.
Associated constants:
- StatusLEDConfigOff
- StatusLEDConfigOn
- StatusLEDConfigShowHeartbeat
- StatusLEDConfigShowStatus
func (*AirQualityBricklet) SetTemperatureCallbackConfiguration ¶
func (device *AirQualityBricklet) SetTemperatureCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32) (err error)
The period is the period with which the RegisterTemperatureCallback 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.
It is furthermore possible to constrain the callback with thresholds.
The `option`-parameter together with min/max sets a threshold for the RegisterTemperatureCallback callback.
The following options are possible:
Option| Description --- | --- 'x'| Threshold is turned off 'o'| Threshold is triggered when the value is *outside* the min and max values 'i'| Threshold is triggered when the value is *inside* or equal to the min and max values '<'| Threshold is triggered when the value is smaller than the min value (max is ignored) '>'| Threshold is triggered when the value is greater than the min value (max is ignored)
If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AirQualityBricklet) SetTemperatureOffset ¶
func (device *AirQualityBricklet) SetTemperatureOffset(offset int32) (err error)
Sets a temperature offset. A offset of 10 will decrease the measured temperature by 0.1 °C.
If you install this Bricklet into an enclosure and you want to measure the ambient temperature, you may have to decrease the measured temperature by some value to compensate for the error because of the heating inside of the enclosure.
We recommend that you leave the parts in the enclosure running for at least 24 hours such that a temperature equilibrium can be reached. After that you can measure the temperature directly outside of enclosure and set the difference as offset.
This temperature offset is used to calculate the relative humidity and IAQ index measurements. In case the Bricklet is installed in an enclosure, we recommend to measure and set the temperature offset to improve the accuracy of the measurements.
func (*AirQualityBricklet) SetWriteFirmwarePointer ¶
func (device *AirQualityBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
Sets the firmware pointer for WriteFirmware. 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.
func (*AirQualityBricklet) WriteFirmware ¶
func (device *AirQualityBricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer 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.
func (*AirQualityBricklet) WriteUID ¶
func (device *AirQualityBricklet) WriteUID(uid uint32) (err error)
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.
type BootloaderMode ¶
type BootloaderMode = uint8
const ( BootloaderModeBootloader BootloaderMode = 0 BootloaderModeFirmware BootloaderMode = 1 BootloaderModeBootloaderWaitForReboot BootloaderMode = 2 BootloaderModeFirmwareWaitForReboot BootloaderMode = 3 BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4 )
type BootloaderStatus ¶
type BootloaderStatus = uint8
const ( BootloaderStatusOK BootloaderStatus = 0 BootloaderStatusInvalidMode BootloaderStatus = 1 BootloaderStatusNoChange BootloaderStatus = 2 BootloaderStatusEntryFunctionNotPresent BootloaderStatus = 3 BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4 BootloaderStatusCRCMismatch BootloaderStatus = 5 )
type Function ¶
type Function = uint8
const ( FunctionGetAllValues Function = 1 FunctionSetTemperatureOffset Function = 2 FunctionGetTemperatureOffset Function = 3 FunctionSetAllValuesCallbackConfiguration Function = 4 FunctionGetAllValuesCallbackConfiguration Function = 5 FunctionGetIAQIndex Function = 7 FunctionSetIAQIndexCallbackConfiguration Function = 8 FunctionGetIAQIndexCallbackConfiguration Function = 9 FunctionGetTemperature Function = 11 FunctionSetTemperatureCallbackConfiguration Function = 12 FunctionGetTemperatureCallbackConfiguration Function = 13 FunctionGetHumidity Function = 15 FunctionSetHumidityCallbackConfiguration Function = 16 FunctionGetHumidityCallbackConfiguration Function = 17 FunctionGetAirPressure Function = 19 FunctionSetAirPressureCallbackConfiguration Function = 20 FunctionGetAirPressureCallbackConfiguration Function = 21 FunctionRemoveCalibration Function = 23 FunctionSetBackgroundCalibrationDuration Function = 24 FunctionGetBackgroundCalibrationDuration Function = 25 FunctionGetSPITFPErrorCount Function = 234 FunctionSetBootloaderMode Function = 235 FunctionGetBootloaderMode Function = 236 FunctionSetWriteFirmwarePointer Function = 237 FunctionWriteFirmware Function = 238 FunctionSetStatusLEDConfig Function = 239 FunctionGetStatusLEDConfig Function = 240 FunctionGetChipTemperature Function = 242 FunctionReset Function = 243 FunctionWriteUID Function = 248 FunctionReadUID Function = 249 FunctionGetIdentity Function = 255 FunctionCallbackAllValues Function = 6 FunctionCallbackIAQIndex Function = 10 FunctionCallbackTemperature Function = 14 FunctionCallbackHumidity Function = 18 FunctionCallbackAirPressure Function = 22 )
type StatusLEDConfig ¶
type StatusLEDConfig = uint8
const ( StatusLEDConfigOff StatusLEDConfig = 0 StatusLEDConfigOn StatusLEDConfig = 1 StatusLEDConfigShowHeartbeat StatusLEDConfig = 2 StatusLEDConfigShowStatus StatusLEDConfig = 3 )
type ThresholdOption ¶
type ThresholdOption = rune
const ( ThresholdOptionOff ThresholdOption = 'x' ThresholdOptionOutside ThresholdOption = 'o' ThresholdOptionInside ThresholdOption = 'i' ThresholdOptionSmaller ThresholdOption = '<' ThresholdOptionGreater ThresholdOption = '>' )