Documentation ¶
Overview ¶
Measures DC voltage between 0V and 45V.
See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/AnalogIn_Bricklet_Go.html.
Index ¶
- Constants
- type AnalogInBricklet
- func (device *AnalogInBricklet) DeregisterAnalogValueCallback(registrationId uint64)
- func (device *AnalogInBricklet) DeregisterAnalogValueReachedCallback(registrationId uint64)
- func (device *AnalogInBricklet) DeregisterVoltageCallback(registrationId uint64)
- func (device *AnalogInBricklet) DeregisterVoltageReachedCallback(registrationId uint64)
- func (device *AnalogInBricklet) GetAPIVersion() [3]uint8
- func (device *AnalogInBricklet) GetAnalogValue() (value uint16, err error)
- func (device *AnalogInBricklet) GetAnalogValueCallbackPeriod() (period uint32, err error)
- func (device *AnalogInBricklet) GetAnalogValueCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)
- func (device *AnalogInBricklet) GetAveraging() (average uint8, err error)
- func (device *AnalogInBricklet) GetDebouncePeriod() (debounce uint32, err error)
- func (device *AnalogInBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, ...)
- func (device *AnalogInBricklet) GetRange() (range_ Range, err error)
- func (device *AnalogInBricklet) GetResponseExpected(functionID Function) (bool, error)
- func (device *AnalogInBricklet) GetVoltage() (voltage uint16, err error)
- func (device *AnalogInBricklet) GetVoltageCallbackPeriod() (period uint32, err error)
- func (device *AnalogInBricklet) GetVoltageCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)
- func (device *AnalogInBricklet) RegisterAnalogValueCallback(fn func(uint16)) uint64
- func (device *AnalogInBricklet) RegisterAnalogValueReachedCallback(fn func(uint16)) uint64
- func (device *AnalogInBricklet) RegisterVoltageCallback(fn func(uint16)) uint64
- func (device *AnalogInBricklet) RegisterVoltageReachedCallback(fn func(uint16)) uint64
- func (device *AnalogInBricklet) SetAnalogValueCallbackPeriod(period uint32) (err error)
- func (device *AnalogInBricklet) SetAnalogValueCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)
- func (device *AnalogInBricklet) SetAveraging(average uint8) (err error)
- func (device *AnalogInBricklet) SetDebouncePeriod(debounce uint32) (err error)
- func (device *AnalogInBricklet) SetRange(range_ Range) (err error)
- func (device *AnalogInBricklet) SetResponseExpected(functionID Function, responseExpected bool) error
- func (device *AnalogInBricklet) SetResponseExpectedAll(responseExpected bool)
- func (device *AnalogInBricklet) SetVoltageCallbackPeriod(period uint32) (err error)
- func (device *AnalogInBricklet) SetVoltageCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)
- type Function
- type Range
- type ThresholdOption
Constants ¶
const DeviceDisplayName = "Analog In Bricklet"
const DeviceIdentifier = 219
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AnalogInBricklet ¶
type AnalogInBricklet struct {
// contains filtered or unexported fields
}
func New ¶
func New(uid string, ipcon *ipconnection.IPConnection) (AnalogInBricklet, error)
Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.
func (*AnalogInBricklet) DeregisterAnalogValueCallback ¶
func (device *AnalogInBricklet) DeregisterAnalogValueCallback(registrationId uint64)
Remove a registered Analog Value callback.
func (*AnalogInBricklet) DeregisterAnalogValueReachedCallback ¶
func (device *AnalogInBricklet) DeregisterAnalogValueReachedCallback(registrationId uint64)
Remove a registered Analog Value Reached callback.
func (*AnalogInBricklet) DeregisterVoltageCallback ¶
func (device *AnalogInBricklet) DeregisterVoltageCallback(registrationId uint64)
Remove a registered Voltage callback.
func (*AnalogInBricklet) DeregisterVoltageReachedCallback ¶
func (device *AnalogInBricklet) DeregisterVoltageReachedCallback(registrationId uint64)
Remove a registered Voltage Reached callback.
func (*AnalogInBricklet) GetAPIVersion ¶
func (device *AnalogInBricklet) 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 (*AnalogInBricklet) GetAnalogValue ¶
func (device *AnalogInBricklet) GetAnalogValue() (value uint16, err error)
Returns the value as read by a 12-bit analog-to-digital converter.
Note
The value returned by GetVoltage is averaged over several samples to yield less noise, while GetAnalogValue gives back raw unfiltered analog values. The only reason to use GetAnalogValue is, if you need the full resolution of the analog-to-digital converter.
If you want the analog value periodically, it is recommended to use the RegisterAnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod.
func (*AnalogInBricklet) GetAnalogValueCallbackPeriod ¶
func (device *AnalogInBricklet) GetAnalogValueCallbackPeriod() (period uint32, err error)
Returns the period as set by SetAnalogValueCallbackPeriod.
func (*AnalogInBricklet) GetAnalogValueCallbackThreshold ¶
func (device *AnalogInBricklet) GetAnalogValueCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)
Returns the threshold as set by SetAnalogValueCallbackThreshold.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AnalogInBricklet) GetAveraging ¶
func (device *AnalogInBricklet) GetAveraging() (average uint8, err error)
Returns the averaging configuration as set by SetAveraging.
.. versionadded:: 2.0.3$nbsp;(Plugin)
func (*AnalogInBricklet) GetDebouncePeriod ¶
func (device *AnalogInBricklet) GetDebouncePeriod() (debounce uint32, err error)
Returns the debounce period as set by SetDebouncePeriod.
func (*AnalogInBricklet) GetIdentity ¶
func (device *AnalogInBricklet) 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 (*AnalogInBricklet) GetRange ¶
func (device *AnalogInBricklet) GetRange() (range_ Range, err error)
Returns the measurement range as set by SetRange.
.. versionadded:: 2.0.1$nbsp;(Plugin)
Associated constants:
- RangeAutomatic
- RangeUpTo6V
- RangeUpTo10V
- RangeUpTo36V
- RangeUpTo45V
- RangeUpTo3V
func (*AnalogInBricklet) GetResponseExpected ¶
func (device *AnalogInBricklet) 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 (*AnalogInBricklet) GetVoltage ¶
func (device *AnalogInBricklet) GetVoltage() (voltage uint16, err error)
Returns the voltage of the sensor. The resolution between 0 and 6V is about 2mV. Between 6 and 45V the resolution is about 10mV.
If you want to get the voltage periodically, it is recommended to use the RegisterVoltageCallback callback and set the period with SetVoltageCallbackPeriod.
func (*AnalogInBricklet) GetVoltageCallbackPeriod ¶
func (device *AnalogInBricklet) GetVoltageCallbackPeriod() (period uint32, err error)
Returns the period as set by SetVoltageCallbackPeriod.
func (*AnalogInBricklet) GetVoltageCallbackThreshold ¶
func (device *AnalogInBricklet) GetVoltageCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)
Returns the threshold as set by SetVoltageCallbackThreshold.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AnalogInBricklet) RegisterAnalogValueCallback ¶
func (device *AnalogInBricklet) RegisterAnalogValueCallback(fn func(uint16)) uint64
This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod. The parameter is the analog value of the sensor.
The RegisterAnalogValueCallback callback is only triggered if the voltage has changed since the last triggering.
func (*AnalogInBricklet) RegisterAnalogValueReachedCallback ¶
func (device *AnalogInBricklet) RegisterAnalogValueReachedCallback(fn func(uint16)) uint64
This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold is reached. The parameter is the analog value of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.
func (*AnalogInBricklet) RegisterVoltageCallback ¶
func (device *AnalogInBricklet) RegisterVoltageCallback(fn func(uint16)) uint64
This callback is triggered periodically with the period that is set by SetVoltageCallbackPeriod. The parameter is the voltage of the sensor.
The RegisterVoltageCallback callback is only triggered if the voltage has changed since the last triggering.
func (*AnalogInBricklet) RegisterVoltageReachedCallback ¶
func (device *AnalogInBricklet) RegisterVoltageReachedCallback(fn func(uint16)) uint64
This callback is triggered when the threshold as set by SetVoltageCallbackThreshold is reached. The parameter is the voltage of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.
func (*AnalogInBricklet) SetAnalogValueCallbackPeriod ¶
func (device *AnalogInBricklet) SetAnalogValueCallbackPeriod(period uint32) (err error)
Sets the period with which the RegisterAnalogValueCallback callback is triggered periodically. A value of 0 turns the callback off.
The RegisterAnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.
func (*AnalogInBricklet) SetAnalogValueCallbackThreshold ¶
func (device *AnalogInBricklet) SetAnalogValueCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)
Sets the thresholds for the RegisterAnalogValueReachedCallback callback.
The following options are possible:
Option| Description --- | --- 'x'| Callback is turned off 'o'| Callback is triggered when the analog value is *outside* the min and max values 'i'| Callback is triggered when the analog value is *inside* the min and max values '<'| Callback is triggered when the analog value is smaller than the min value (max is ignored) '>'| Callback is triggered when the analog value is greater than the min value (max is ignored)
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AnalogInBricklet) SetAveraging ¶
func (device *AnalogInBricklet) SetAveraging(average uint8) (err error)
Set the length of a averaging for the voltage value.
Setting the length to 0 will turn the averaging completely off. If the averaging is off, there is more noise on the data, but the data is without delay.
.. versionadded:: 2.0.3$nbsp;(Plugin)
func (*AnalogInBricklet) SetDebouncePeriod ¶
func (device *AnalogInBricklet) SetDebouncePeriod(debounce uint32) (err error)
Sets the period with which the threshold callbacks
* RegisterVoltageReachedCallback, * RegisterAnalogValueReachedCallback
are triggered, if the thresholds
* SetVoltageCallbackThreshold, * SetAnalogValueCallbackThreshold
keep being reached.
func (*AnalogInBricklet) SetRange ¶
func (device *AnalogInBricklet) SetRange(range_ Range) (err error)
Sets the measurement range. Possible ranges:
* 0: Automatically switched * 1: 0V - 6.05V, ~1.48mV resolution * 2: 0V - 10.32V, ~2.52mV resolution * 3: 0V - 36.30V, ~8.86mV resolution * 4: 0V - 45.00V, ~11.25mV resolution * 5: 0V - 3.3V, ~0.81mV resolution, new in version 2.0.3$nbsp;(Plugin)
.. versionadded:: 2.0.1$nbsp;(Plugin)
Associated constants:
- RangeAutomatic
- RangeUpTo6V
- RangeUpTo10V
- RangeUpTo36V
- RangeUpTo45V
- RangeUpTo3V
func (*AnalogInBricklet) SetResponseExpected ¶
func (device *AnalogInBricklet) 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 (*AnalogInBricklet) SetResponseExpectedAll ¶
func (device *AnalogInBricklet) SetResponseExpectedAll(responseExpected bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
func (*AnalogInBricklet) SetVoltageCallbackPeriod ¶
func (device *AnalogInBricklet) SetVoltageCallbackPeriod(period uint32) (err error)
Sets the period with which the RegisterVoltageCallback callback is triggered periodically. A value of 0 turns the callback off.
The RegisterVoltageCallback callback is only triggered if the voltage has changed since the last triggering.
func (*AnalogInBricklet) SetVoltageCallbackThreshold ¶
func (device *AnalogInBricklet) SetVoltageCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)
Sets the thresholds for the RegisterVoltageReachedCallback callback.
The following options are possible:
Option| Description --- | --- 'x'| Callback is turned off 'o'| Callback is triggered when the voltage is *outside* the min and max values 'i'| Callback is triggered when the voltage is *inside* the min and max values '<'| Callback is triggered when the voltage is smaller than the min value (max is ignored) '>'| Callback is triggered when the voltage is greater than the min value (max is ignored)
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
type Function ¶
type Function = uint8
const ( FunctionGetVoltage Function = 1 FunctionGetAnalogValue Function = 2 FunctionSetVoltageCallbackPeriod Function = 3 FunctionGetVoltageCallbackPeriod Function = 4 FunctionSetAnalogValueCallbackPeriod Function = 5 FunctionGetAnalogValueCallbackPeriod Function = 6 FunctionSetVoltageCallbackThreshold Function = 7 FunctionGetVoltageCallbackThreshold Function = 8 FunctionSetAnalogValueCallbackThreshold Function = 9 FunctionGetAnalogValueCallbackThreshold Function = 10 FunctionSetDebouncePeriod Function = 11 FunctionGetDebouncePeriod Function = 12 FunctionSetRange Function = 17 FunctionGetRange Function = 18 FunctionSetAveraging Function = 19 FunctionGetAveraging Function = 20 FunctionGetIdentity Function = 255 FunctionCallbackVoltage Function = 13 FunctionCallbackAnalogValue Function = 14 FunctionCallbackVoltageReached Function = 15 FunctionCallbackAnalogValueReached Function = 16 )
type ThresholdOption ¶
type ThresholdOption = rune
const ( ThresholdOptionOff ThresholdOption = 'x' ThresholdOptionOutside ThresholdOption = 'o' ThresholdOptionInside ThresholdOption = 'i' ThresholdOptionSmaller ThresholdOption = '<' ThresholdOptionGreater ThresholdOption = '>' )