Documentation ¶
Overview ¶
Measures acceleration in three axis.
See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/Accelerometer_Bricklet_Go.html.
Index ¶
- Constants
- type AccelerometerBricklet
- func (device *AccelerometerBricklet) DeregisterAccelerationCallback(registrationId uint64)
- func (device *AccelerometerBricklet) DeregisterAccelerationReachedCallback(registrationId uint64)
- func (device *AccelerometerBricklet) GetAPIVersion() [3]uint8
- func (device *AccelerometerBricklet) GetAcceleration() (x int16, y int16, z int16, err error)
- func (device *AccelerometerBricklet) GetAccelerationCallbackPeriod() (period uint32, err error)
- func (device *AccelerometerBricklet) GetAccelerationCallbackThreshold() (option ThresholdOption, minX int16, maxX int16, minY int16, maxY int16, ...)
- func (device *AccelerometerBricklet) GetConfiguration() (dataRate DataRate, fullScale FullScale, filterBandwidth FilterBandwidth, ...)
- func (device *AccelerometerBricklet) GetDebouncePeriod() (debounce uint32, err error)
- func (device *AccelerometerBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, ...)
- func (device *AccelerometerBricklet) GetResponseExpected(functionID Function) (bool, error)
- func (device *AccelerometerBricklet) GetTemperature() (temperature int16, err error)
- func (device *AccelerometerBricklet) IsLEDOn() (on bool, err error)
- func (device *AccelerometerBricklet) LEDOff() (err error)
- func (device *AccelerometerBricklet) LEDOn() (err error)
- func (device *AccelerometerBricklet) RegisterAccelerationCallback(fn func(int16, int16, int16)) uint64
- func (device *AccelerometerBricklet) RegisterAccelerationReachedCallback(fn func(int16, int16, int16)) uint64
- func (device *AccelerometerBricklet) SetAccelerationCallbackPeriod(period uint32) (err error)
- func (device *AccelerometerBricklet) SetAccelerationCallbackThreshold(option ThresholdOption, minX int16, maxX int16, minY int16, maxY int16, ...) (err error)
- func (device *AccelerometerBricklet) SetConfiguration(dataRate DataRate, fullScale FullScale, filterBandwidth FilterBandwidth) (err error)
- func (device *AccelerometerBricklet) SetDebouncePeriod(debounce uint32) (err error)
- func (device *AccelerometerBricklet) SetResponseExpected(functionID Function, responseExpected bool) error
- func (device *AccelerometerBricklet) SetResponseExpectedAll(responseExpected bool)
- type DataRate
- type FilterBandwidth
- type FullScale
- type Function
- type ThresholdOption
Constants ¶
const DeviceDisplayName = "Accelerometer Bricklet"
const DeviceIdentifier = 250
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccelerometerBricklet ¶
type AccelerometerBricklet struct {
// contains filtered or unexported fields
}
func New ¶
func New(uid string, ipcon *ipconnection.IPConnection) (AccelerometerBricklet, error)
Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.
func (*AccelerometerBricklet) DeregisterAccelerationCallback ¶
func (device *AccelerometerBricklet) DeregisterAccelerationCallback(registrationId uint64)
Remove a registered Acceleration callback.
func (*AccelerometerBricklet) DeregisterAccelerationReachedCallback ¶
func (device *AccelerometerBricklet) DeregisterAccelerationReachedCallback(registrationId uint64)
Remove a registered Acceleration Reached callback.
func (*AccelerometerBricklet) GetAPIVersion ¶
func (device *AccelerometerBricklet) 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 (*AccelerometerBricklet) GetAcceleration ¶
func (device *AccelerometerBricklet) GetAcceleration() (x int16, y int16, z int16, err error)
Returns the acceleration in x, y and z direction. The values are given in gₙ/1000 (1gₙ = 9.80665m/s²). The range is configured with SetConfiguration.
If you want to get the acceleration periodically, it is recommended to use the RegisterAccelerationCallback callback and set the period with SetAccelerationCallbackPeriod.
func (*AccelerometerBricklet) GetAccelerationCallbackPeriod ¶
func (device *AccelerometerBricklet) GetAccelerationCallbackPeriod() (period uint32, err error)
Returns the period as set by SetAccelerationCallbackPeriod.
func (*AccelerometerBricklet) GetAccelerationCallbackThreshold ¶
func (device *AccelerometerBricklet) GetAccelerationCallbackThreshold() (option ThresholdOption, minX int16, maxX int16, minY int16, maxY int16, minZ int16, maxZ int16, err error)
Returns the threshold as set by SetAccelerationCallbackThreshold.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AccelerometerBricklet) GetConfiguration ¶
func (device *AccelerometerBricklet) GetConfiguration() (dataRate DataRate, fullScale FullScale, filterBandwidth FilterBandwidth, err error)
Returns the configuration as set by SetConfiguration.
Associated constants:
- DataRateOff
- DataRate3Hz
- DataRate6Hz
- DataRate12Hz
- DataRate25Hz
- DataRate50Hz
- DataRate100Hz
- DataRate400Hz
- DataRate800Hz
- DataRate1600Hz
- FullScale2g
- FullScale4g
- FullScale6g
- FullScale8g
- FullScale16g
- FilterBandwidth800Hz
- FilterBandwidth400Hz
- FilterBandwidth200Hz
- FilterBandwidth50Hz
func (*AccelerometerBricklet) GetDebouncePeriod ¶
func (device *AccelerometerBricklet) GetDebouncePeriod() (debounce uint32, err error)
Returns the debounce period as set by SetDebouncePeriod.
func (*AccelerometerBricklet) GetIdentity ¶
func (device *AccelerometerBricklet) 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 (*AccelerometerBricklet) GetResponseExpected ¶
func (device *AccelerometerBricklet) 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 (*AccelerometerBricklet) GetTemperature ¶
func (device *AccelerometerBricklet) GetTemperature() (temperature int16, err error)
Returns the temperature of the accelerometer.
func (*AccelerometerBricklet) IsLEDOn ¶
func (device *AccelerometerBricklet) IsLEDOn() (on bool, err error)
Returns *true* if the LED is enabled, *false* otherwise.
func (*AccelerometerBricklet) LEDOff ¶
func (device *AccelerometerBricklet) LEDOff() (err error)
Disables the LED on the Bricklet.
func (*AccelerometerBricklet) LEDOn ¶
func (device *AccelerometerBricklet) LEDOn() (err error)
Enables the LED on the Bricklet.
func (*AccelerometerBricklet) RegisterAccelerationCallback ¶
func (device *AccelerometerBricklet) RegisterAccelerationCallback(fn func(int16, int16, int16)) uint64
This callback is triggered periodically with the period that is set by SetAccelerationCallbackPeriod. The parameters are the X, Y and Z acceleration. The range is configured with SetConfiguration.
The RegisterAccelerationCallback callback is only triggered if the acceleration has changed since the last triggering.
func (*AccelerometerBricklet) RegisterAccelerationReachedCallback ¶
func (device *AccelerometerBricklet) RegisterAccelerationReachedCallback(fn func(int16, int16, int16)) uint64
This callback is triggered when the threshold as set by SetAccelerationCallbackThreshold is reached. The parameters are the X, Y and Z acceleration. The range is configured with SetConfiguration.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.
func (*AccelerometerBricklet) SetAccelerationCallbackPeriod ¶
func (device *AccelerometerBricklet) SetAccelerationCallbackPeriod(period uint32) (err error)
Sets the period with which the RegisterAccelerationCallback callback is triggered periodically. A value of 0 turns the callback off.
The RegisterAccelerationCallback callback is only triggered if the acceleration has changed since the last triggering.
func (*AccelerometerBricklet) SetAccelerationCallbackThreshold ¶
func (device *AccelerometerBricklet) SetAccelerationCallbackThreshold(option ThresholdOption, minX int16, maxX int16, minY int16, maxY int16, minZ int16, maxZ int16) (err error)
Sets the thresholds for the RegisterAccelerationReachedCallback callback.
The following options are possible:
Option| Description --- | --- 'x'| Callback is turned off 'o'| Callback is triggered when the acceleration is *outside* the min and max values 'i'| Callback is triggered when the acceleration is *inside* the min and max values '<'| Callback is triggered when the acceleration is smaller than the min value (max is ignored) '>'| Callback is triggered when the acceleration is greater than the min value (max is ignored)
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AccelerometerBricklet) SetConfiguration ¶
func (device *AccelerometerBricklet) SetConfiguration(dataRate DataRate, fullScale FullScale, filterBandwidth FilterBandwidth) (err error)
Configures the data rate, full scale range and filter bandwidth. Possible values are:
* Data rate of 0Hz to 1600Hz. * Full scale range of ±2gₙ up to ±16gₙ. * Filter bandwidth between 50Hz and 800Hz.
Decreasing data rate or full scale range will also decrease the noise on the data.
Associated constants:
- DataRateOff
- DataRate3Hz
- DataRate6Hz
- DataRate12Hz
- DataRate25Hz
- DataRate50Hz
- DataRate100Hz
- DataRate400Hz
- DataRate800Hz
- DataRate1600Hz
- FullScale2g
- FullScale4g
- FullScale6g
- FullScale8g
- FullScale16g
- FilterBandwidth800Hz
- FilterBandwidth400Hz
- FilterBandwidth200Hz
- FilterBandwidth50Hz
func (*AccelerometerBricklet) SetDebouncePeriod ¶
func (device *AccelerometerBricklet) SetDebouncePeriod(debounce uint32) (err error)
Sets the period with which the threshold callback
* RegisterAccelerationReachedCallback
is triggered, if the threshold
* SetAccelerationCallbackThreshold
keeps being reached.
func (*AccelerometerBricklet) SetResponseExpected ¶
func (device *AccelerometerBricklet) 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 (*AccelerometerBricklet) SetResponseExpectedAll ¶
func (device *AccelerometerBricklet) SetResponseExpectedAll(responseExpected bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
type FilterBandwidth ¶
type FilterBandwidth = uint8
const ( FilterBandwidth800Hz FilterBandwidth = 0 FilterBandwidth400Hz FilterBandwidth = 1 FilterBandwidth200Hz FilterBandwidth = 2 FilterBandwidth50Hz FilterBandwidth = 3 )
type Function ¶
type Function = uint8
const ( FunctionGetAcceleration Function = 1 FunctionSetAccelerationCallbackPeriod Function = 2 FunctionGetAccelerationCallbackPeriod Function = 3 FunctionSetAccelerationCallbackThreshold Function = 4 FunctionGetAccelerationCallbackThreshold Function = 5 FunctionSetDebouncePeriod Function = 6 FunctionGetDebouncePeriod Function = 7 FunctionGetTemperature Function = 8 FunctionSetConfiguration Function = 9 FunctionGetConfiguration Function = 10 FunctionLEDOn Function = 11 FunctionLEDOff Function = 12 FunctionIsLEDOn Function = 13 FunctionGetIdentity Function = 255 FunctionCallbackAcceleration Function = 14 FunctionCallbackAccelerationReached Function = 15 )
type ThresholdOption ¶
type ThresholdOption = rune
const ( ThresholdOptionOff ThresholdOption = 'x' ThresholdOptionOutside ThresholdOption = 'o' ThresholdOptionInside ThresholdOption = 'i' ThresholdOptionSmaller ThresholdOption = '<' ThresholdOptionGreater ThresholdOption = '>' )