piezo_speaker_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

Creates beep with configurable frequency.

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

Index

Constants

View Source
const DeviceDisplayName = "Piezo Speaker Bricklet"
View Source
const DeviceIdentifier = 242

Variables

This section is empty.

Functions

This section is empty.

Types

type BeepDuration

type BeepDuration = uint32
const (
	BeepDurationOff      BeepDuration = 0
	BeepDurationInfinite BeepDuration = 4294967295
)

type Function

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

type PiezoSpeakerBricklet

type PiezoSpeakerBricklet 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 (*PiezoSpeakerBricklet) Beep

func (device *PiezoSpeakerBricklet) Beep(duration BeepDuration, frequency uint16) (err error)

Beeps with the given frequency for the given duration.

.. versionchanged:: 2.0.2$nbsp;(Plugin)

A duration of 0 stops the current beep if any, the frequency parameter is
ignored. A duration of 4294967295 results in an infinite beep.

The Piezo Speaker Bricklet can only approximate the frequency, it will play the best possible match by applying the calibration (see Calibrate).

Associated constants:

* BeepDurationOff
* BeepDurationInfinite

func (*PiezoSpeakerBricklet) Calibrate

func (device *PiezoSpeakerBricklet) Calibrate() (calibration bool, err error)

The Piezo Speaker Bricklet can play 512 different tones. This function plays each tone and measures the exact frequency back. The result is a mapping between setting value and frequency. This mapping is stored in the EEPROM and loaded on startup.

The Bricklet should come calibrated, you only need to call this function (once) every time you reflash the Bricklet plugin.

Returns *true* after the calibration finishes.

func (*PiezoSpeakerBricklet) DeregisterBeepFinishedCallback

func (device *PiezoSpeakerBricklet) DeregisterBeepFinishedCallback(registrationId uint64)

Remove a registered Beep Finished callback.

func (*PiezoSpeakerBricklet) DeregisterMorseCodeFinishedCallback

func (device *PiezoSpeakerBricklet) DeregisterMorseCodeFinishedCallback(registrationId uint64)

Remove a registered Morse Code Finished callback.

func (*PiezoSpeakerBricklet) GetAPIVersion

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

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

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

func (device *PiezoSpeakerBricklet) MorseCode(morse string, frequency uint16) (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 (*PiezoSpeakerBricklet) RegisterBeepFinishedCallback

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

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

func (*PiezoSpeakerBricklet) RegisterMorseCodeFinishedCallback

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

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

func (*PiezoSpeakerBricklet) SetResponseExpected

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

func (device *PiezoSpeakerBricklet) SetResponseExpectedAll(responseExpected bool)

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

Jump to

Keyboard shortcuts

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