segment_display_4x7_bricklet

package
Version: v0.0.0-...-d0a6af2 Latest Latest
Warning

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

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

Documentation

Overview

Four 7-segment displays with switchable colon.

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

Index

Constants

View Source
const DeviceDisplayName = "Segment Display 4x7 Bricklet"
View Source
const DeviceIdentifier = 237

Variables

This section is empty.

Functions

This section is empty.

Types

type Function

type Function = uint8
const (
	FunctionSetSegments             Function = 1
	FunctionGetSegments             Function = 2
	FunctionStartCounter            Function = 3
	FunctionGetCounterValue         Function = 4
	FunctionGetIdentity             Function = 255
	FunctionCallbackCounterFinished Function = 5
)

type SegmentDisplay4x7Bricklet

type SegmentDisplay4x7Bricklet 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 (*SegmentDisplay4x7Bricklet) DeregisterCounterFinishedCallback

func (device *SegmentDisplay4x7Bricklet) DeregisterCounterFinishedCallback(registrationId uint64)

Remove a registered Counter Finished callback.

func (*SegmentDisplay4x7Bricklet) GetAPIVersion

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

func (device *SegmentDisplay4x7Bricklet) GetCounterValue() (value uint16, err error)

Returns the counter value that is currently shown on the display.

If there is no counter running a 0 will be returned.

func (*SegmentDisplay4x7Bricklet) GetIdentity

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

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

func (device *SegmentDisplay4x7Bricklet) GetSegments() (segments [4]uint8, brightness uint8, colon bool, err error)

Returns the segment, brightness and color data as set by SetSegments.

func (*SegmentDisplay4x7Bricklet) RegisterCounterFinishedCallback

func (device *SegmentDisplay4x7Bricklet) RegisterCounterFinishedCallback(fn func()) uint64

This callback is triggered when the counter (see StartCounter) is finished.

func (*SegmentDisplay4x7Bricklet) SetResponseExpected

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

func (device *SegmentDisplay4x7Bricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*SegmentDisplay4x7Bricklet) SetSegments

func (device *SegmentDisplay4x7Bricklet) SetSegments(segments [4]uint8, brightness uint8, colon bool) (err error)

The 7-segment display can be set with bitmaps. Every bit controls one segment:

.. image:: /Images/Bricklets/bricklet_segment_display_4x7_bit_order.png

:scale: 100 %
:alt: Bit order of one segment
:align: center

For example to set a 5 you would want to activate segments 0, 2, 3, 5 and 6. This is represented by the number 0b01101101 = 0x6d = 109.

The brightness can be set between 0 (dark) and 7 (bright). The colon parameter turns the colon of the display on or off.

func (*SegmentDisplay4x7Bricklet) StartCounter

func (device *SegmentDisplay4x7Bricklet) StartCounter(valueFrom int16, valueTo int16, increment int16, length uint32) (err error)

Starts a counter with the *from* value that counts to the *to* value with the each step incremented by *increment*. *length* is the pause between each increment.

Example: If you set *from* to 0, *to* to 100, *increment* to 1 and *length* to 1000, a counter that goes from 0 to 100 with one second pause between each increment will be started.

Using a negative increment allows to count backwards.

You can stop the counter at every time by calling SetSegments.

Jump to

Keyboard shortcuts

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