Documentation
¶
Overview ¶
300° rotary potentiometer.
See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/RotaryPoti_Bricklet_Go.html.
Index ¶
- Constants
- type Function
- type RotaryPotiBricklet
- func (device *RotaryPotiBricklet) DeregisterAnalogValueCallback(registrationId uint64)
- func (device *RotaryPotiBricklet) DeregisterAnalogValueReachedCallback(registrationId uint64)
- func (device *RotaryPotiBricklet) DeregisterPositionCallback(registrationId uint64)
- func (device *RotaryPotiBricklet) DeregisterPositionReachedCallback(registrationId uint64)
- func (device *RotaryPotiBricklet) GetAPIVersion() [3]uint8
- func (device *RotaryPotiBricklet) GetAnalogValue() (value uint16, err error)
- func (device *RotaryPotiBricklet) GetAnalogValueCallbackPeriod() (period uint32, err error)
- func (device *RotaryPotiBricklet) GetAnalogValueCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)
- func (device *RotaryPotiBricklet) GetDebouncePeriod() (debounce uint32, err error)
- func (device *RotaryPotiBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, ...)
- func (device *RotaryPotiBricklet) GetPosition() (position int16, err error)
- func (device *RotaryPotiBricklet) GetPositionCallbackPeriod() (period uint32, err error)
- func (device *RotaryPotiBricklet) GetPositionCallbackThreshold() (option ThresholdOption, min int16, max int16, err error)
- func (device *RotaryPotiBricklet) GetResponseExpected(functionID Function) (bool, error)
- func (device *RotaryPotiBricklet) RegisterAnalogValueCallback(fn func(uint16)) uint64
- func (device *RotaryPotiBricklet) RegisterAnalogValueReachedCallback(fn func(uint16)) uint64
- func (device *RotaryPotiBricklet) RegisterPositionCallback(fn func(int16)) uint64
- func (device *RotaryPotiBricklet) RegisterPositionReachedCallback(fn func(int16)) uint64
- func (device *RotaryPotiBricklet) SetAnalogValueCallbackPeriod(period uint32) (err error)
- func (device *RotaryPotiBricklet) SetAnalogValueCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)
- func (device *RotaryPotiBricklet) SetDebouncePeriod(debounce uint32) (err error)
- func (device *RotaryPotiBricklet) SetPositionCallbackPeriod(period uint32) (err error)
- func (device *RotaryPotiBricklet) SetPositionCallbackThreshold(option ThresholdOption, min int16, max int16) (err error)
- func (device *RotaryPotiBricklet) SetResponseExpected(functionID Function, responseExpected bool) error
- func (device *RotaryPotiBricklet) SetResponseExpectedAll(responseExpected bool)
- type ThresholdOption
Constants ¶
const DeviceDisplayName = "Rotary Poti Bricklet"
const DeviceIdentifier = 215
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Function ¶
type Function = uint8
const ( FunctionGetPosition Function = 1 FunctionGetAnalogValue Function = 2 FunctionSetPositionCallbackPeriod Function = 3 FunctionGetPositionCallbackPeriod Function = 4 FunctionSetAnalogValueCallbackPeriod Function = 5 FunctionGetAnalogValueCallbackPeriod Function = 6 FunctionSetPositionCallbackThreshold Function = 7 FunctionGetPositionCallbackThreshold Function = 8 FunctionSetAnalogValueCallbackThreshold Function = 9 FunctionGetAnalogValueCallbackThreshold Function = 10 FunctionSetDebouncePeriod Function = 11 FunctionGetDebouncePeriod Function = 12 FunctionGetIdentity Function = 255 FunctionCallbackPosition Function = 13 FunctionCallbackAnalogValue Function = 14 FunctionCallbackPositionReached Function = 15 FunctionCallbackAnalogValueReached Function = 16 )
type RotaryPotiBricklet ¶
type RotaryPotiBricklet struct {
// contains filtered or unexported fields
}
func New ¶
func New(uid string, ipcon *ipconnection.IPConnection) (RotaryPotiBricklet, error)
Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.
func (*RotaryPotiBricklet) DeregisterAnalogValueCallback ¶
func (device *RotaryPotiBricklet) DeregisterAnalogValueCallback(registrationId uint64)
Remove a registered Analog Value callback.
func (*RotaryPotiBricklet) DeregisterAnalogValueReachedCallback ¶
func (device *RotaryPotiBricklet) DeregisterAnalogValueReachedCallback(registrationId uint64)
Remove a registered Analog Value Reached callback.
func (*RotaryPotiBricklet) DeregisterPositionCallback ¶
func (device *RotaryPotiBricklet) DeregisterPositionCallback(registrationId uint64)
Remove a registered Position callback.
func (*RotaryPotiBricklet) DeregisterPositionReachedCallback ¶
func (device *RotaryPotiBricklet) DeregisterPositionReachedCallback(registrationId uint64)
Remove a registered Position Reached callback.
func (*RotaryPotiBricklet) GetAPIVersion ¶
func (device *RotaryPotiBricklet) 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 (*RotaryPotiBricklet) GetAnalogValue ¶
func (device *RotaryPotiBricklet) GetAnalogValue() (value uint16, err error)
Returns the value as read by a 12-bit analog-to-digital converter.
Note
The value returned by GetPosition 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 (*RotaryPotiBricklet) GetAnalogValueCallbackPeriod ¶
func (device *RotaryPotiBricklet) GetAnalogValueCallbackPeriod() (period uint32, err error)
Returns the period as set by SetAnalogValueCallbackPeriod.
func (*RotaryPotiBricklet) GetAnalogValueCallbackThreshold ¶
func (device *RotaryPotiBricklet) GetAnalogValueCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)
Returns the threshold as set by SetAnalogValueCallbackThreshold.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*RotaryPotiBricklet) GetDebouncePeriod ¶
func (device *RotaryPotiBricklet) GetDebouncePeriod() (debounce uint32, err error)
Returns the debounce period as set by SetDebouncePeriod.
func (*RotaryPotiBricklet) GetIdentity ¶
func (device *RotaryPotiBricklet) 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 (*RotaryPotiBricklet) GetPosition ¶
func (device *RotaryPotiBricklet) GetPosition() (position int16, err error)
Returns the position of the rotary potentiometer. The value is between -150° (turned left) and 150° (turned right).
If you want to get the position periodically, it is recommended to use the RegisterPositionCallback callback and set the period with SetPositionCallbackPeriod.
func (*RotaryPotiBricklet) GetPositionCallbackPeriod ¶
func (device *RotaryPotiBricklet) GetPositionCallbackPeriod() (period uint32, err error)
Returns the period as set by SetPositionCallbackPeriod.
func (*RotaryPotiBricklet) GetPositionCallbackThreshold ¶
func (device *RotaryPotiBricklet) GetPositionCallbackThreshold() (option ThresholdOption, min int16, max int16, err error)
Returns the threshold as set by SetPositionCallbackThreshold.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*RotaryPotiBricklet) GetResponseExpected ¶
func (device *RotaryPotiBricklet) 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 (*RotaryPotiBricklet) RegisterAnalogValueCallback ¶
func (device *RotaryPotiBricklet) 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 rotary potentiometer.
The RegisterAnalogValueCallback callback is only triggered if the position has changed since the last triggering.
func (*RotaryPotiBricklet) RegisterAnalogValueReachedCallback ¶
func (device *RotaryPotiBricklet) 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 rotary potentiometer.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.
func (*RotaryPotiBricklet) RegisterPositionCallback ¶
func (device *RotaryPotiBricklet) RegisterPositionCallback(fn func(int16)) uint64
This callback is triggered periodically with the period that is set by SetPositionCallbackPeriod. The parameter is the position of the rotary potentiometer.
The RegisterPositionCallback callback is only triggered if the position has changed since the last triggering.
func (*RotaryPotiBricklet) RegisterPositionReachedCallback ¶
func (device *RotaryPotiBricklet) RegisterPositionReachedCallback(fn func(int16)) uint64
This callback is triggered when the threshold as set by SetPositionCallbackThreshold is reached. The parameter is the position of the rotary potentiometer.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.
func (*RotaryPotiBricklet) SetAnalogValueCallbackPeriod ¶
func (device *RotaryPotiBricklet) 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 (*RotaryPotiBricklet) SetAnalogValueCallbackThreshold ¶
func (device *RotaryPotiBricklet) 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 (*RotaryPotiBricklet) SetDebouncePeriod ¶
func (device *RotaryPotiBricklet) SetDebouncePeriod(debounce uint32) (err error)
Sets the period with which the threshold callbacks
* RegisterPositionReachedCallback, * RegisterAnalogValueReachedCallback
are triggered, if the thresholds
* SetPositionCallbackThreshold, * SetAnalogValueCallbackThreshold
keep being reached.
func (*RotaryPotiBricklet) SetPositionCallbackPeriod ¶
func (device *RotaryPotiBricklet) SetPositionCallbackPeriod(period uint32) (err error)
Sets the period with which the RegisterPositionCallback callback is triggered periodically. A value of 0 turns the callback off.
The RegisterPositionCallback callback is only triggered if the position has changed since the last triggering.
func (*RotaryPotiBricklet) SetPositionCallbackThreshold ¶
func (device *RotaryPotiBricklet) SetPositionCallbackThreshold(option ThresholdOption, min int16, max int16) (err error)
Sets the thresholds for the RegisterPositionReachedCallback callback.
The following options are possible:
Option| Description --- | --- 'x'| Callback is turned off 'o'| Callback is triggered when the position is *outside* the min and max values 'i'| Callback is triggered when the position is *inside* the min and max values '<'| Callback is triggered when the position is smaller than the min value (max is ignored) '>'| Callback is triggered when the position is greater than the min value (max is ignored)
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*RotaryPotiBricklet) SetResponseExpected ¶
func (device *RotaryPotiBricklet) 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 (*RotaryPotiBricklet) SetResponseExpectedAll ¶
func (device *RotaryPotiBricklet) SetResponseExpectedAll(responseExpected bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
type ThresholdOption ¶
type ThresholdOption = rune
const ( ThresholdOptionOff ThresholdOption = 'x' ThresholdOptionOutside ThresholdOption = 'o' ThresholdOptionInside ThresholdOption = 'i' ThresholdOptionSmaller ThresholdOption = '<' ThresholdOptionGreater ThresholdOption = '>' )