tilt_bricklet

package
Version: v0.0.0-...-8a98e63 Latest Latest
Warning

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

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

Documentation

Overview

Detects inclination of Bricklet (tilt switch open/closed).

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

Index

Constants

View Source
const DeviceDisplayName = "Tilt Bricklet"
View Source
const DeviceIdentifier = 239

Variables

This section is empty.

Functions

This section is empty.

Types

type Function

type Function = uint8
const (
	FunctionGetTiltState               Function = 1
	FunctionEnableTiltStateCallback    Function = 2
	FunctionDisableTiltStateCallback   Function = 3
	FunctionIsTiltStateCallbackEnabled Function = 4
	FunctionGetIdentity                Function = 255
	FunctionCallbackTiltState          Function = 5
)

type TiltBricklet

type TiltBricklet 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 (*TiltBricklet) DeregisterTiltStateCallback

func (device *TiltBricklet) DeregisterTiltStateCallback(registrationId uint64)

Remove a registered Tilt State callback.

func (*TiltBricklet) DisableTiltStateCallback

func (device *TiltBricklet) DisableTiltStateCallback() (err error)

Disables the RegisterTiltStateCallback callback.

func (*TiltBricklet) EnableTiltStateCallback

func (device *TiltBricklet) EnableTiltStateCallback() (err error)

Enables the RegisterTiltStateCallback callback.

func (*TiltBricklet) GetAPIVersion

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

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

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

func (device *TiltBricklet) GetTiltState() (state TiltState, err error)

Returns the current tilt state. The state can either be

* 0 = Closed: The ball in the tilt switch closes the circuit. * 1 = Open: The ball in the tilt switch does not close the circuit. * 2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).

.. image:: /Images/Bricklets/bricklet_tilt_mechanics.jpg

:scale: 100 %
:alt: Tilt states
:align: center
:target: ../../_images/Bricklets/bricklet_tilt_mechanics.jpg

Associated constants:

  • TiltStateClosed
  • TiltStateOpen
  • TiltStateClosedVibrating

func (*TiltBricklet) IsTiltStateCallbackEnabled

func (device *TiltBricklet) IsTiltStateCallbackEnabled() (enabled bool, err error)

Returns *true* if the RegisterTiltStateCallback callback is enabled.

func (*TiltBricklet) RegisterTiltStateCallback

func (device *TiltBricklet) RegisterTiltStateCallback(fn func(TiltState)) uint64

This callback provides the current tilt state. It is called every time the state changes.

See GetTiltState for a description of the states.

func (*TiltBricklet) SetResponseExpected

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

func (device *TiltBricklet) SetResponseExpectedAll(responseExpected bool)

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

type TiltState

type TiltState = uint8
const (
	TiltStateClosed          TiltState = 0
	TiltStateOpen            TiltState = 1
	TiltStateClosedVibrating TiltState = 2
)

Jump to

Keyboard shortcuts

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