voltage_bricklet

package
Version: v0.0.0-...-57cfa29 Latest Latest
Warning

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

Go to latest
Published: Aug 22, 2022 License: CC0-1.0 Imports: 5 Imported by: 0

Documentation

Overview

Measures DC voltage between 0V and 50V‍.

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

Index

Constants

View Source
const DeviceDisplayName = "Voltage Bricklet"
View Source
const DeviceIdentifier = 218

Variables

This section is empty.

Functions

This section is empty.

Types

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

type VoltageBricklet

type VoltageBricklet 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 (*VoltageBricklet) DeregisterAnalogValueCallback

func (device *VoltageBricklet) DeregisterAnalogValueCallback(registrationId uint64)

Remove a registered Analog Value callback.

func (*VoltageBricklet) DeregisterAnalogValueReachedCallback

func (device *VoltageBricklet) DeregisterAnalogValueReachedCallback(registrationId uint64)

Remove a registered Analog Value Reached callback.

func (*VoltageBricklet) DeregisterVoltageCallback

func (device *VoltageBricklet) DeregisterVoltageCallback(registrationId uint64)

Remove a registered Voltage callback.

func (*VoltageBricklet) DeregisterVoltageReachedCallback

func (device *VoltageBricklet) DeregisterVoltageReachedCallback(registrationId uint64)

Remove a registered Voltage Reached callback.

func (*VoltageBricklet) GetAPIVersion

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

func (device *VoltageBricklet) 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 (*VoltageBricklet) GetAnalogValueCallbackPeriod

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

Returns the period as set by SetAnalogValueCallbackPeriod.

func (*VoltageBricklet) GetAnalogValueCallbackThreshold

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

Returns the threshold as set by SetAnalogValueCallbackThreshold.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*VoltageBricklet) GetDebouncePeriod

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

Returns the debounce period as set by SetDebouncePeriod.

func (*VoltageBricklet) GetIdentity

func (device *VoltageBricklet) 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 (*VoltageBricklet) GetResponseExpected

func (device *VoltageBricklet) 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 (*VoltageBricklet) GetVoltage

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

Returns the voltage of the sensor.

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

func (*VoltageBricklet) GetVoltageCallbackPeriod

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

Returns the period as set by SetVoltageCallbackPeriod.

func (*VoltageBricklet) GetVoltageCallbackThreshold

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

Returns the threshold as set by SetVoltageCallbackThreshold.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*VoltageBricklet) RegisterAnalogValueCallback

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

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

func (device *VoltageBricklet) 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 (*VoltageBricklet) RegisterVoltageReachedCallback

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

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

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

func (device *VoltageBricklet) 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 (*VoltageBricklet) SetResponseExpected

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

func (device *VoltageBricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*VoltageBricklet) SetVoltageCallbackPeriod

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

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

Jump to

Keyboard shortcuts

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