joystick_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

2-axis joystick with push-button.

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

Index

Constants

View Source
const DeviceDisplayName = "Joystick Bricklet"
View Source
const DeviceIdentifier = 210

Variables

This section is empty.

Functions

This section is empty.

Types

type Function

type Function = uint8
const (
	FunctionGetPosition                     Function = 1
	FunctionIsPressed                       Function = 2
	FunctionGetAnalogValue                  Function = 3
	FunctionCalibrate                       Function = 4
	FunctionSetPositionCallbackPeriod       Function = 5
	FunctionGetPositionCallbackPeriod       Function = 6
	FunctionSetAnalogValueCallbackPeriod    Function = 7
	FunctionGetAnalogValueCallbackPeriod    Function = 8
	FunctionSetPositionCallbackThreshold    Function = 9
	FunctionGetPositionCallbackThreshold    Function = 10
	FunctionSetAnalogValueCallbackThreshold Function = 11
	FunctionGetAnalogValueCallbackThreshold Function = 12
	FunctionSetDebouncePeriod               Function = 13
	FunctionGetDebouncePeriod               Function = 14
	FunctionGetIdentity                     Function = 255
	FunctionCallbackPosition                Function = 15
	FunctionCallbackAnalogValue             Function = 16
	FunctionCallbackPositionReached         Function = 17
	FunctionCallbackAnalogValueReached      Function = 18
	FunctionCallbackPressed                 Function = 19
	FunctionCallbackReleased                Function = 20
)

type JoystickBricklet

type JoystickBricklet 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 (*JoystickBricklet) Calibrate

func (device *JoystickBricklet) Calibrate() (err error)

Calibrates the middle position of the joystick. If your Joystick Bricklet does not return x=0 and y=0 in the middle position, call this function while the joystick is standing still in the middle position.

The resulting calibration will be saved on the EEPROM of the Joystick Bricklet, thus you only have to calibrate it once.

func (*JoystickBricklet) DeregisterAnalogValueCallback

func (device *JoystickBricklet) DeregisterAnalogValueCallback(registrationId uint64)

Remove a registered Analog Value callback.

func (*JoystickBricklet) DeregisterAnalogValueReachedCallback

func (device *JoystickBricklet) DeregisterAnalogValueReachedCallback(registrationId uint64)

Remove a registered Analog Value Reached callback.

func (*JoystickBricklet) DeregisterPositionCallback

func (device *JoystickBricklet) DeregisterPositionCallback(registrationId uint64)

Remove a registered Position callback.

func (*JoystickBricklet) DeregisterPositionReachedCallback

func (device *JoystickBricklet) DeregisterPositionReachedCallback(registrationId uint64)

Remove a registered Position Reached callback.

func (*JoystickBricklet) DeregisterPressedCallback

func (device *JoystickBricklet) DeregisterPressedCallback(registrationId uint64)

Remove a registered Pressed callback.

func (*JoystickBricklet) DeregisterReleasedCallback

func (device *JoystickBricklet) DeregisterReleasedCallback(registrationId uint64)

Remove a registered Released callback.

func (*JoystickBricklet) GetAPIVersion

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

func (device *JoystickBricklet) GetAnalogValue() (x uint16, y uint16, err error)

Returns the values as read by a 12-bit analog-to-digital converter.

Note

The values returned by GetPosition are 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 values periodically, it is recommended to use the RegisterAnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod.

func (*JoystickBricklet) GetAnalogValueCallbackPeriod

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

Returns the period as set by SetAnalogValueCallbackPeriod.

func (*JoystickBricklet) GetAnalogValueCallbackThreshold

func (device *JoystickBricklet) GetAnalogValueCallbackThreshold() (option ThresholdOption, minX uint16, maxX uint16, minY uint16, maxY uint16, err error)

Returns the threshold as set by SetAnalogValueCallbackThreshold.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*JoystickBricklet) GetDebouncePeriod

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

Returns the debounce period as set by SetDebouncePeriod.

func (*JoystickBricklet) GetIdentity

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

func (device *JoystickBricklet) GetPosition() (x int16, y int16, err error)

Returns the position of the joystick. The middle position of the joystick is x=0, y=0. The returned values are averaged and calibrated (see Calibrate).

If you want to get the position periodically, it is recommended to use the RegisterPositionCallback callback and set the period with SetPositionCallbackPeriod.

func (*JoystickBricklet) GetPositionCallbackPeriod

func (device *JoystickBricklet) GetPositionCallbackPeriod() (period uint32, err error)

Returns the period as set by SetPositionCallbackPeriod.

func (*JoystickBricklet) GetPositionCallbackThreshold

func (device *JoystickBricklet) GetPositionCallbackThreshold() (option ThresholdOption, minX int16, maxX int16, minY int16, maxY int16, err error)

Returns the threshold as set by SetPositionCallbackThreshold.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*JoystickBricklet) GetResponseExpected

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

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

func (device *JoystickBricklet) RegisterAnalogValueCallback(fn func(uint16, uint16)) uint64

This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod. The parameters are the analog values of the joystick.

The RegisterAnalogValueCallback callback is only triggered if the values have changed since the last triggering.

func (*JoystickBricklet) RegisterAnalogValueReachedCallback

func (device *JoystickBricklet) RegisterAnalogValueReachedCallback(fn func(uint16, uint16)) uint64

This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold is reached. The parameters are the analog values of the joystick.

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

func (*JoystickBricklet) RegisterPositionCallback

func (device *JoystickBricklet) RegisterPositionCallback(fn func(int16, int16)) uint64

This callback is triggered periodically with the period that is set by SetPositionCallbackPeriod. The parameter is the position of the joystick.

The RegisterPositionCallback callback is only triggered if the position has changed since the last triggering.

func (*JoystickBricklet) RegisterPositionReachedCallback

func (device *JoystickBricklet) RegisterPositionReachedCallback(fn func(int16, int16)) uint64

This callback is triggered when the threshold as set by SetPositionCallbackThreshold is reached. The parameters are the position of the joystick.

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

func (*JoystickBricklet) RegisterPressedCallback

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

This callback is triggered when the button is pressed.

func (*JoystickBricklet) RegisterReleasedCallback

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

This callback is triggered when the button is released.

func (*JoystickBricklet) SetAnalogValueCallbackPeriod

func (device *JoystickBricklet) 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 values have changed since the last triggering.

func (*JoystickBricklet) SetAnalogValueCallbackThreshold

func (device *JoystickBricklet) SetAnalogValueCallbackThreshold(option ThresholdOption, minX uint16, maxX uint16, minY uint16, maxY 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 values are *outside* the min and max values
'i'|    Callback is triggered when the analog values are *inside* the min and max values
'<'|    Callback is triggered when the analog values are smaller than the min values (max is ignored)
'>'|    Callback is triggered when the analog values are greater than the min values (max is ignored)

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*JoystickBricklet) SetDebouncePeriod

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

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

func (device *JoystickBricklet) SetPositionCallbackThreshold(option ThresholdOption, minX int16, maxX int16, minY int16, maxY 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 values (max is ignored)
'>'|    Callback is triggered when the position is greater than the min values (max is ignored)

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*JoystickBricklet) SetResponseExpected

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

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