barometer_v2_bricklet

package
v0.0.0-...-368b749 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 27, 2024 License: CC0-1.0 Imports: 5 Imported by: 1

Documentation

Overview

Measures air pressure and altitude changes.

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/BarometerV2_Bricklet_Go.html.

Index

Constants

View Source
const DeviceDisplayName = "Barometer Bricklet 2.0"
View Source
const DeviceIdentifier = 2117

Variables

This section is empty.

Functions

This section is empty.

Types

type BarometerV2Bricklet

type BarometerV2Bricklet struct {
	// contains filtered or unexported fields
}

func New

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*BarometerV2Bricklet) DeregisterAirPressureCallback

func (device *BarometerV2Bricklet) DeregisterAirPressureCallback(registrationId uint64)

Remove a registered Air Pressure callback.

func (*BarometerV2Bricklet) DeregisterAltitudeCallback

func (device *BarometerV2Bricklet) DeregisterAltitudeCallback(registrationId uint64)

Remove a registered Altitude callback.

func (*BarometerV2Bricklet) DeregisterTemperatureCallback

func (device *BarometerV2Bricklet) DeregisterTemperatureCallback(registrationId uint64)

Remove a registered Temperature callback.

func (*BarometerV2Bricklet) GetAPIVersion

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) GetAirPressure

func (device *BarometerV2Bricklet) GetAirPressure() (airPressure int32, err error)

Returns the measured 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 (*BarometerV2Bricklet) GetAirPressureCallbackConfiguration

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) GetAltitude

func (device *BarometerV2Bricklet) GetAltitude() (altitude int32, err error)

Returns the relative altitude of the air pressure sensor. The value is calculated based on the difference between the current air pressure and the reference air pressure that can be set with SetReferenceAirPressure.

If you want to get the value periodically, it is recommended to use the RegisterAltitudeCallback callback. You can set the callback configuration with SetAltitudeCallbackConfiguration.

func (*BarometerV2Bricklet) GetAltitudeCallbackConfiguration

func (device *BarometerV2Bricklet) GetAltitudeCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32, err error)

Returns the callback configuration as set by SetAltitudeCallbackConfiguration.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*BarometerV2Bricklet) GetBootloaderMode

func (device *BarometerV2Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

  • BootloaderModeBootloader
  • BootloaderModeFirmware
  • BootloaderModeBootloaderWaitForReboot
  • BootloaderModeFirmwareWaitForReboot
  • BootloaderModeFirmwareWaitForEraseAndReboot

func (*BarometerV2Bricklet) GetCalibration

func (device *BarometerV2Bricklet) GetCalibration() (measuredAirPressure int32, actualAirPressure int32, err error)

Returns the air pressure one point calibration values as set by SetCalibration.

func (*BarometerV2Bricklet) GetChipTemperature

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) GetIdentity

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) GetMovingAverageConfiguration

func (device *BarometerV2Bricklet) GetMovingAverageConfiguration() (movingAverageLengthAirPressure uint16, movingAverageLengthTemperature uint16, err error)

Returns the moving average configuration as set by SetMovingAverageConfiguration.

func (*BarometerV2Bricklet) GetReferenceAirPressure

func (device *BarometerV2Bricklet) GetReferenceAirPressure() (airPressure int32, err error)

Returns the reference air pressure as set by SetReferenceAirPressure.

func (*BarometerV2Bricklet) GetResponseExpected

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) GetSPITFPErrorCount

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) GetSensorConfiguration

func (device *BarometerV2Bricklet) GetSensorConfiguration() (dataRate DataRate, airPressureLowPassFilter LowPassFilter, err error)

Returns the sensor configuration as set by SetSensorConfiguration.

Associated constants:

  • DataRateOff
  • DataRate1Hz
  • DataRate10Hz
  • DataRate25Hz
  • DataRate50Hz
  • DataRate75Hz
  • LowPassFilterOff
  • LowPassFilter19th
  • LowPassFilter120th

func (*BarometerV2Bricklet) GetStatusLEDConfig

func (device *BarometerV2Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

  • StatusLEDConfigOff
  • StatusLEDConfigOn
  • StatusLEDConfigShowHeartbeat
  • StatusLEDConfigShowStatus

func (*BarometerV2Bricklet) GetTemperature

func (device *BarometerV2Bricklet) GetTemperature() (temperature int32, err error)

Returns the temperature of the air pressure sensor.

This temperature is used internally for temperature compensation of the air pressure measurement. It is not as accurate as the temperature measured by the `temperature_v2_bricklet` or the `temperature_ir_v2_bricklet`.

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 (*BarometerV2Bricklet) GetTemperatureCallbackConfiguration

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) ReadUID

func (device *BarometerV2Bricklet) ReadUID() (uid uint32, err error)

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

func (*BarometerV2Bricklet) RegisterAirPressureCallback

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) RegisterAltitudeCallback

func (device *BarometerV2Bricklet) RegisterAltitudeCallback(fn func(int32)) uint64

This callback is triggered periodically according to the configuration set by SetAltitudeCallbackConfiguration.

The parameter is the same as GetAltitude.

func (*BarometerV2Bricklet) RegisterTemperatureCallback

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) Reset

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) SetAirPressureCallbackConfiguration

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) SetAltitudeCallbackConfiguration

func (device *BarometerV2Bricklet) SetAltitudeCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32) (err error)

The period is the period with which the RegisterAltitudeCallback 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 RegisterAltitudeCallback 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 (*BarometerV2Bricklet) SetBootloaderMode

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) SetCalibration

func (device *BarometerV2Bricklet) SetCalibration(measuredAirPressure int32, actualAirPressure int32) (err error)

Sets the one point calibration (OPC) values for the air pressure measurement.

Before the Bricklet can be calibrated any previous calibration has to be removed by setting “measured air pressure“ and “actual air pressure“ to 0.

Then the current air pressure has to be measured using the Bricklet (“measured air pressure“) and with an accurate reference barometer (“actual air pressure“) at the same time and passed to this function.

After proper calibration the air pressure measurement can achieve an accuracy up to 0.2 hPa.

The calibration is saved in the EEPROM of the Bricklet and only needs to be configured once.

func (*BarometerV2Bricklet) SetMovingAverageConfiguration

func (device *BarometerV2Bricklet) SetMovingAverageConfiguration(movingAverageLengthAirPressure uint16, movingAverageLengthTemperature uint16) (err error)

Sets the length of a https://en.wikipedia.org/wiki/Moving_average for the air pressure and temperature measurements.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

If you want to do long term measurements the longest moving average will give the cleanest results.

func (*BarometerV2Bricklet) SetReferenceAirPressure

func (device *BarometerV2Bricklet) SetReferenceAirPressure(airPressure int32) (err error)

Sets the reference air pressure for the altitude calculation. Setting the reference to the current air pressure results in a calculated altitude of 0mm. Passing 0 is a shortcut for passing the current air pressure as reference.

Well known reference values are the Q codes https://en.wikipedia.org/wiki/QNH and https://en.wikipedia.org/wiki/Mean_sea_level_pressure#Mean_sea_level_pressure used in aviation.

func (*BarometerV2Bricklet) SetResponseExpected

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) SetResponseExpectedAll

func (device *BarometerV2Bricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

func (*BarometerV2Bricklet) SetSensorConfiguration

func (device *BarometerV2Bricklet) SetSensorConfiguration(dataRate DataRate, airPressureLowPassFilter LowPassFilter) (err error)

Configures the data rate and air pressure low pass filter. The low pass filter cut-off frequency (if enabled) can be set to 1/9th or 1/20th of the configure data rate to decrease the noise on the air pressure data.

The low pass filter configuration only applies to the air pressure measurement. There is no low pass filter for the temperature measurement.

A higher data rate will result in a less precise temperature because of self-heating of the sensor. If the accuracy of the temperature reading is important to you, we would recommend the 1Hz data rate.

Associated constants:

  • DataRateOff
  • DataRate1Hz
  • DataRate10Hz
  • DataRate25Hz
  • DataRate50Hz
  • DataRate75Hz
  • LowPassFilterOff
  • LowPassFilter19th
  • LowPassFilter120th

func (*BarometerV2Bricklet) SetStatusLEDConfig

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) SetTemperatureCallbackConfiguration

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) SetWriteFirmwarePointer

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) WriteFirmware

func (device *BarometerV2Bricklet) 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 (*BarometerV2Bricklet) WriteUID

func (device *BarometerV2Bricklet) 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 DataRate

type DataRate = uint8
const (
	DataRateOff  DataRate = 0
	DataRate1Hz  DataRate = 1
	DataRate10Hz DataRate = 2
	DataRate25Hz DataRate = 3
	DataRate50Hz DataRate = 4
	DataRate75Hz DataRate = 5
)

type Function

type Function = uint8
const (
	FunctionGetAirPressure                      Function = 1
	FunctionSetAirPressureCallbackConfiguration Function = 2
	FunctionGetAirPressureCallbackConfiguration Function = 3
	FunctionGetAltitude                         Function = 5
	FunctionSetAltitudeCallbackConfiguration    Function = 6
	FunctionGetAltitudeCallbackConfiguration    Function = 7
	FunctionGetTemperature                      Function = 9
	FunctionSetTemperatureCallbackConfiguration Function = 10
	FunctionGetTemperatureCallbackConfiguration Function = 11
	FunctionSetMovingAverageConfiguration       Function = 13
	FunctionGetMovingAverageConfiguration       Function = 14
	FunctionSetReferenceAirPressure             Function = 15
	FunctionGetReferenceAirPressure             Function = 16
	FunctionSetCalibration                      Function = 17
	FunctionGetCalibration                      Function = 18
	FunctionSetSensorConfiguration              Function = 19
	FunctionGetSensorConfiguration              Function = 20
	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
	FunctionCallbackAirPressure                 Function = 4
	FunctionCallbackAltitude                    Function = 8
	FunctionCallbackTemperature                 Function = 12
)

type LowPassFilter

type LowPassFilter = uint8
const (
	LowPassFilterOff LowPassFilter = 0
	//Deprecated: Use 1_9th instead.
	LowPassFilter19th  LowPassFilter = 1
	LowPassFilter1_9th LowPassFilter = 1
	//Deprecated: Use 1_20th instead.
	LowPassFilter120th  LowPassFilter = 2
	LowPassFilter1_20th LowPassFilter = 2
)

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 = '>'
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL