go-api-bindings: github.com/Tinkerforge/go-api-bindings/analog_in_v2_bricklet Index | Files

package analog_in_v2_bricklet

import "github.com/Tinkerforge/go-api-bindings/analog_in_v2_bricklet"

Measures DC voltage between 0V and 42V‍.

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

Index

Package Files

analog_in_v2_bricklet.go

Constants

const DeviceDisplayName = "Analog In Bricklet 2.0"
const DeviceIdentifier = 251

type AnalogInV2Bricklet Uses

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

func New Uses

func New(uid string, ipcon *ipconnection.IPConnection) (AnalogInV2Bricklet, error)

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

func (*AnalogInV2Bricklet) DeregisterAnalogValueCallback Uses

func (device *AnalogInV2Bricklet) DeregisterAnalogValueCallback(registrationId uint64)

Remove a registered Analog Value callback.

func (*AnalogInV2Bricklet) DeregisterAnalogValueReachedCallback Uses

func (device *AnalogInV2Bricklet) DeregisterAnalogValueReachedCallback(registrationId uint64)

Remove a registered Analog Value Reached callback.

func (*AnalogInV2Bricklet) DeregisterVoltageCallback Uses

func (device *AnalogInV2Bricklet) DeregisterVoltageCallback(registrationId uint64)

Remove a registered Voltage callback.

func (*AnalogInV2Bricklet) DeregisterVoltageReachedCallback Uses

func (device *AnalogInV2Bricklet) DeregisterVoltageReachedCallback(registrationId uint64)

Remove a registered Voltage Reached callback.

func (*AnalogInV2Bricklet) GetAPIVersion Uses

func (device *AnalogInV2Bricklet) 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 (*AnalogInV2Bricklet) GetAnalogValue Uses

func (device *AnalogInV2Bricklet) GetAnalogValue() (value uint16, err error)

Returns the value as read by a 12-bit 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 (*AnalogInV2Bricklet) GetAnalogValueCallbackPeriod Uses

func (device *AnalogInV2Bricklet) GetAnalogValueCallbackPeriod() (period uint32, err error)

Returns the period as set by SetAnalogValueCallbackPeriod.

func (*AnalogInV2Bricklet) GetAnalogValueCallbackThreshold Uses

func (device *AnalogInV2Bricklet) GetAnalogValueCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

Returns the threshold as set by SetAnalogValueCallbackThreshold.

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*AnalogInV2Bricklet) GetDebouncePeriod Uses

func (device *AnalogInV2Bricklet) GetDebouncePeriod() (debounce uint32, err error)

Returns the debounce period as set by SetDebouncePeriod.

func (*AnalogInV2Bricklet) GetIdentity Uses

func (device *AnalogInV2Bricklet) 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' or 'd'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*AnalogInV2Bricklet) GetMovingAverage Uses

func (device *AnalogInV2Bricklet) GetMovingAverage() (average uint8, err error)

Returns the length of the moving average as set by SetMovingAverage.

func (*AnalogInV2Bricklet) GetResponseExpected Uses

func (device *AnalogInV2Bricklet) 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 send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*AnalogInV2Bricklet) GetVoltage Uses

func (device *AnalogInV2Bricklet) GetVoltage() (voltage uint16, err error)

Returns the measured voltage. The resolution is approximately 10mV.

If you want to get the voltage periodically, it is recommended to use the RegisterVoltageCallback callback and set the period with SetVoltageCallbackPeriod.

func (*AnalogInV2Bricklet) GetVoltageCallbackPeriod Uses

func (device *AnalogInV2Bricklet) GetVoltageCallbackPeriod() (period uint32, err error)

Returns the period as set by SetVoltageCallbackPeriod.

func (*AnalogInV2Bricklet) GetVoltageCallbackThreshold Uses

func (device *AnalogInV2Bricklet) GetVoltageCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

Returns the threshold as set by SetVoltageCallbackThreshold.

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*AnalogInV2Bricklet) RegisterAnalogValueCallback Uses

func (device *AnalogInV2Bricklet) 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 (*AnalogInV2Bricklet) RegisterAnalogValueReachedCallback Uses

func (device *AnalogInV2Bricklet) 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 (*AnalogInV2Bricklet) RegisterVoltageCallback Uses

func (device *AnalogInV2Bricklet) 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.

Der RegisterVoltageCallback callback is only triggered if the voltage has changed since the last triggering.

func (*AnalogInV2Bricklet) RegisterVoltageReachedCallback Uses

func (device *AnalogInV2Bricklet) 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 (*AnalogInV2Bricklet) SetAnalogValueCallbackPeriod Uses

func (device *AnalogInV2Bricklet) 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 (*AnalogInV2Bricklet) SetAnalogValueCallbackThreshold Uses

func (device *AnalogInV2Bricklet) 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 (*AnalogInV2Bricklet) SetDebouncePeriod Uses

func (device *AnalogInV2Bricklet) 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 (*AnalogInV2Bricklet) SetMovingAverage Uses

func (device *AnalogInV2Bricklet) SetMovingAverage(average uint8) (err error)

Sets the length of a https://en.wikipedia.org/wiki/Moving_average for the voltage.

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

func (*AnalogInV2Bricklet) SetResponseExpected Uses

func (device *AnalogInV2Bricklet) 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 send and errors are silently ignored, because they cannot be detected.

func (*AnalogInV2Bricklet) SetResponseExpectedAll Uses

func (device *AnalogInV2Bricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*AnalogInV2Bricklet) SetVoltageCallbackPeriod Uses

func (device *AnalogInV2Bricklet) 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 (*AnalogInV2Bricklet) SetVoltageCallbackThreshold Uses

func (device *AnalogInV2Bricklet) 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 Uses

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
    FunctionSetMovingAverage                Function = 13
    FunctionGetMovingAverage                Function = 14
    FunctionGetIdentity                     Function = 255
    FunctionCallbackVoltage                 Function = 15
    FunctionCallbackAnalogValue             Function = 16
    FunctionCallbackVoltageReached          Function = 17
    FunctionCallbackAnalogValueReached      Function = 18
)

type ThresholdOption Uses

type ThresholdOption = rune
const (
    ThresholdOptionOff     ThresholdOption = 'x'
    ThresholdOptionOutside ThresholdOption = 'o'
    ThresholdOptionInside  ThresholdOption = 'i'
    ThresholdOptionSmaller ThresholdOption = '<'
    ThresholdOptionGreater ThresholdOption = '>'
)

Package analog_in_v2_bricklet imports 4 packages (graph). Updated 2019-12-12. Refresh now. Tools for package owners.