go-api-bindings: github.com/Tinkerforge/go-api-bindings/piezo_buzzer_bricklet Index | Files

package piezo_buzzer_bricklet

import "github.com/Tinkerforge/go-api-bindings/piezo_buzzer_bricklet"

Creates 1kHz beep.

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

Index

Package Files

piezo_buzzer_bricklet.go

Constants

const DeviceDisplayName = "Piezo Buzzer Bricklet"
const DeviceIdentifier = 214

type Function Uses

type Function = uint8
const (
    FunctionBeep                      Function = 1
    FunctionMorseCode                 Function = 2
    FunctionGetIdentity               Function = 255
    FunctionCallbackBeepFinished      Function = 3
    FunctionCallbackMorseCodeFinished Function = 4
)

type PiezoBuzzerBricklet Uses

type PiezoBuzzerBricklet struct {
    // contains filtered or unexported fields
}

func New Uses

func New(uid string, ipcon *ipconnection.IPConnection) (PiezoBuzzerBricklet, error)

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*PiezoBuzzerBricklet) Beep Uses

func (device *PiezoBuzzerBricklet) Beep(duration uint32) (err error)

Beeps for the given duration.

func (*PiezoBuzzerBricklet) DeregisterBeepFinishedCallback Uses

func (device *PiezoBuzzerBricklet) DeregisterBeepFinishedCallback(registrationId uint64)

Remove a registered Beep Finished callback.

func (*PiezoBuzzerBricklet) DeregisterMorseCodeFinishedCallback Uses

func (device *PiezoBuzzerBricklet) DeregisterMorseCodeFinishedCallback(registrationId uint64)

Remove a registered Morse Code Finished callback.

func (*PiezoBuzzerBricklet) GetAPIVersion Uses

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

func (device *PiezoBuzzerBricklet) 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always as position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*PiezoBuzzerBricklet) GetResponseExpected Uses

func (device *PiezoBuzzerBricklet) 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 (*PiezoBuzzerBricklet) MorseCode Uses

func (device *PiezoBuzzerBricklet) MorseCode(morse string) (err error)

Sets morse code that will be played by the piezo buzzer. The morse code is given as a string consisting of . (dot), - (minus) and (space) for *dits*, *dahs* and *pauses*. Every other character is ignored.

For example: If you set the string ...---..., the piezo buzzer will beep nine times with the durations short short short long long long short short short.

func (*PiezoBuzzerBricklet) RegisterBeepFinishedCallback Uses

func (device *PiezoBuzzerBricklet) RegisterBeepFinishedCallback(fn func()) uint64

This callback is triggered if a beep set by Beep is finished

func (*PiezoBuzzerBricklet) RegisterMorseCodeFinishedCallback Uses

func (device *PiezoBuzzerBricklet) RegisterMorseCodeFinishedCallback(fn func()) uint64

This callback is triggered if the playback of the morse code set by MorseCode is finished.

func (*PiezoBuzzerBricklet) SetResponseExpected Uses

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

func (device *PiezoBuzzerBricklet) SetResponseExpectedAll(responseExpected bool)

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

Package piezo_buzzer_bricklet imports 5 packages (graph). Updated 2020-08-05. Refresh now. Tools for package owners.