rotary_encoder_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

360° rotary encoder with push-button.

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

Index

Constants

View Source
const DeviceDisplayName = "Rotary Encoder Bricklet"
View Source
const DeviceIdentifier = 236

Variables

This section is empty.

Functions

This section is empty.

Types

type Function

type Function = uint8
const (
	FunctionGetCount                  Function = 1
	FunctionSetCountCallbackPeriod    Function = 2
	FunctionGetCountCallbackPeriod    Function = 3
	FunctionSetCountCallbackThreshold Function = 4
	FunctionGetCountCallbackThreshold Function = 5
	FunctionSetDebouncePeriod         Function = 6
	FunctionGetDebouncePeriod         Function = 7
	FunctionIsPressed                 Function = 10
	FunctionGetIdentity               Function = 255
	FunctionCallbackCount             Function = 8
	FunctionCallbackCountReached      Function = 9
	FunctionCallbackPressed           Function = 11
	FunctionCallbackReleased          Function = 12
)

type RotaryEncoderBricklet

type RotaryEncoderBricklet 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 (*RotaryEncoderBricklet) DeregisterCountCallback

func (device *RotaryEncoderBricklet) DeregisterCountCallback(registrationId uint64)

Remove a registered Count callback.

func (*RotaryEncoderBricklet) DeregisterCountReachedCallback

func (device *RotaryEncoderBricklet) DeregisterCountReachedCallback(registrationId uint64)

Remove a registered Count Reached callback.

func (*RotaryEncoderBricklet) DeregisterPressedCallback

func (device *RotaryEncoderBricklet) DeregisterPressedCallback(registrationId uint64)

Remove a registered Pressed callback.

func (*RotaryEncoderBricklet) DeregisterReleasedCallback

func (device *RotaryEncoderBricklet) DeregisterReleasedCallback(registrationId uint64)

Remove a registered Released callback.

func (*RotaryEncoderBricklet) GetAPIVersion

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

func (device *RotaryEncoderBricklet) GetCount(reset bool) (count int32, err error)

Returns the current count of the encoder. If you set reset to true, the count is set back to 0 directly after the current count is read.

The encoder has 24 steps per rotation

Turning the encoder to the left decrements the counter, so a negative count is possible.

func (*RotaryEncoderBricklet) GetCountCallbackPeriod

func (device *RotaryEncoderBricklet) GetCountCallbackPeriod() (period uint32, err error)

Returns the period as set by SetCountCallbackPeriod.

func (*RotaryEncoderBricklet) GetCountCallbackThreshold

func (device *RotaryEncoderBricklet) GetCountCallbackThreshold() (option ThresholdOption, min int32, max int32, err error)

Returns the threshold as set by SetCountCallbackThreshold.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*RotaryEncoderBricklet) GetDebouncePeriod

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

Returns the debounce period as set by SetDebouncePeriod.

func (*RotaryEncoderBricklet) GetIdentity

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

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

func (device *RotaryEncoderBricklet) IsPressed() (pressed bool, err error)

Returns *true* if the button is pressed and *false* otherwise.

It is recommended to use the RegisterPressedCallback and RegisterReleasedCallback callbacks to handle the button.

func (*RotaryEncoderBricklet) RegisterCountCallback

func (device *RotaryEncoderBricklet) RegisterCountCallback(fn func(int32)) uint64

This callback is triggered periodically with the period that is set by SetCountCallbackPeriod. The parameter is the count of the encoder.

The RegisterCountCallback callback is only triggered if the count has changed since the last triggering.

func (*RotaryEncoderBricklet) RegisterCountReachedCallback

func (device *RotaryEncoderBricklet) RegisterCountReachedCallback(fn func(int32)) uint64

This callback is triggered when the threshold as set by SetCountCallbackThreshold is reached. The parameter is the count of the encoder.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.

func (*RotaryEncoderBricklet) RegisterPressedCallback

func (device *RotaryEncoderBricklet) RegisterPressedCallback(fn func()) uint64

This callback is triggered when the button is pressed.

func (*RotaryEncoderBricklet) RegisterReleasedCallback

func (device *RotaryEncoderBricklet) RegisterReleasedCallback(fn func()) uint64

This callback is triggered when the button is released.

func (*RotaryEncoderBricklet) SetCountCallbackPeriod

func (device *RotaryEncoderBricklet) SetCountCallbackPeriod(period uint32) (err error)

Sets the period with which the RegisterCountCallback callback is triggered periodically. A value of 0 turns the callback off.

The RegisterCountCallback callback is only triggered if the count has changed since the last triggering.

func (*RotaryEncoderBricklet) SetCountCallbackThreshold

func (device *RotaryEncoderBricklet) SetCountCallbackThreshold(option ThresholdOption, min int32, max int32) (err error)

Sets the thresholds for the RegisterCountReachedCallback callback.

The following options are possible:

Option| Description
--- | ---
'x'|    Callback is turned off
'o'|    Callback is triggered when the count is *outside* the min and max values
'i'|    Callback is triggered when the count is *inside* the min and max values
'<'|    Callback is triggered when the count is smaller than the min value (max is ignored)
'>'|    Callback is triggered when the count is greater than the min value (max is ignored)

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*RotaryEncoderBricklet) SetDebouncePeriod

func (device *RotaryEncoderBricklet) SetDebouncePeriod(debounce uint32) (err error)

Sets the period with which the threshold callback

* RegisterCountReachedCallback

is triggered, if the thresholds

* SetCountCallbackThreshold

keeps being reached.

func (*RotaryEncoderBricklet) SetResponseExpected

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

func (device *RotaryEncoderBricklet) 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 = '>'
)

Jump to

Keyboard shortcuts

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