Documentation

Overview

Creates beep and alarm with configurable volume and frequency.

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

Index

Constants

View Source
const DeviceDisplayName = "Piezo Speaker Bricklet 2.0"
View Source
const DeviceIdentifier = 2145

Variables

This section is empty.

Functions

This section is empty.

Types

type AlarmDuration

type AlarmDuration = uint32
const (
	AlarmDurationOff      AlarmDuration = 0
	AlarmDurationInfinite AlarmDuration = 4294967295
)

type BeepDuration

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

type BootloaderMode

type BootloaderMode = uint8
const (
	BootloaderModeBootloader                    BootloaderMode = 0
	BootloaderModeFirmware                      BootloaderMode = 1
	BootloaderModeBootloaderWaitForReboot       BootloaderMode = 2
	BootloaderModeFirmwareWaitForReboot         BootloaderMode = 3
	BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
)

type BootloaderStatus

type BootloaderStatus = uint8
const (
	BootloaderStatusOK                        BootloaderStatus = 0
	BootloaderStatusInvalidMode               BootloaderStatus = 1
	BootloaderStatusNoChange                  BootloaderStatus = 2
	BootloaderStatusEntryFunctionNotPresent   BootloaderStatus = 3
	BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
	BootloaderStatusCRCMismatch               BootloaderStatus = 5
)

type Function

type Function = uint8
const (
	FunctionSetBeep                 Function = 1
	FunctionGetBeep                 Function = 2
	FunctionSetAlarm                Function = 3
	FunctionGetAlarm                Function = 4
	FunctionUpdateVolume            Function = 5
	FunctionUpdateFrequency         Function = 6
	FunctionGetSPITFPErrorCount     Function = 234
	FunctionSetBootloaderMode       Function = 235
	FunctionGetBootloaderMode       Function = 236
	FunctionSetWriteFirmwarePointer Function = 237
	FunctionWriteFirmware           Function = 238
	FunctionSetStatusLEDConfig      Function = 239
	FunctionGetStatusLEDConfig      Function = 240
	FunctionGetChipTemperature      Function = 242
	FunctionReset                   Function = 243
	FunctionWriteUID                Function = 248
	FunctionReadUID                 Function = 249
	FunctionGetIdentity             Function = 255
	FunctionCallbackBeepFinished    Function = 7
	FunctionCallbackAlarmFinished   Function = 8
)

type PiezoSpeakerV2Bricklet

type PiezoSpeakerV2Bricklet 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 (*PiezoSpeakerV2Bricklet) DeregisterAlarmFinishedCallback

func (device *PiezoSpeakerV2Bricklet) DeregisterAlarmFinishedCallback(registrationId uint64)

Remove a registered Alarm Finished callback.

func (*PiezoSpeakerV2Bricklet) DeregisterBeepFinishedCallback

func (device *PiezoSpeakerV2Bricklet) DeregisterBeepFinishedCallback(registrationId uint64)

Remove a registered Beep Finished callback.

func (*PiezoSpeakerV2Bricklet) GetAPIVersion

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

func (device *PiezoSpeakerV2Bricklet) GetAlarm() (startFrequency uint16, endFrequency uint16, stepSize uint16, stepDelay uint16, volume uint8, duration AlarmDuration, durationRemaining AlarmDuration, currentFrequency uint16, err error)

Returns the last alarm settings as set by SetAlarm. If an alarm is currently running it also returns the remaining duration of the alarm as well as the current frequency of the alarm.

If the volume is updated during an alarm (with UpdateVolume) this function returns the updated value.

Associated constants:

* AlarmDurationOff
* AlarmDurationInfinite

func (*PiezoSpeakerV2Bricklet) GetBeep

func (device *PiezoSpeakerV2Bricklet) GetBeep() (frequency uint16, volume uint8, duration BeepDuration, durationRemaining uint32, err error)

Returns the last beep settings as set by SetBeep. If a beep is currently running it also returns the remaining duration of the beep.

If the frequency or volume is updated during a beep (with UpdateFrequency or UpdateVolume) this function returns the updated value.

Associated constants:

* BeepDurationOff
* BeepDurationInfinite

func (*PiezoSpeakerV2Bricklet) GetBootloaderMode

func (device *PiezoSpeakerV2Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot

func (*PiezoSpeakerV2Bricklet) GetChipTemperature

func (device *PiezoSpeakerV2Bricklet) GetChipTemperature() (temperature int16, err error)

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

func (*PiezoSpeakerV2Bricklet) GetIdentity

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

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

func (device *PiezoSpeakerV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

* ACK checksum errors, * message checksum errors, * framing errors and * overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

func (*PiezoSpeakerV2Bricklet) GetStatusLEDConfig

func (device *PiezoSpeakerV2Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*PiezoSpeakerV2Bricklet) ReadUID

func (device *PiezoSpeakerV2Bricklet) ReadUID() (uid uint32, err error)

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

func (*PiezoSpeakerV2Bricklet) RegisterAlarmFinishedCallback

func (device *PiezoSpeakerV2Bricklet) RegisterAlarmFinishedCallback(fn func()) uint64

This callback is triggered if a alarm set by SetAlarm is finished

func (*PiezoSpeakerV2Bricklet) RegisterBeepFinishedCallback

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

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

func (*PiezoSpeakerV2Bricklet) Reset

func (device *PiezoSpeakerV2Bricklet) Reset() (err error)

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

func (*PiezoSpeakerV2Bricklet) SetAlarm

func (device *PiezoSpeakerV2Bricklet) SetAlarm(startFrequency uint16, endFrequency uint16, stepSize uint16, stepDelay uint16, volume uint8, duration AlarmDuration) (err error)

Creates an alarm (a tone that goes back and force between two specified frequencies).

The following parameters can be set:

* Start Frequency: Start frequency of the alarm. * End Frequency: End frequency of the alarm. * Step Size: Size of one step of the sweep between the start/end frequencies. * Step Delay: Delay between two steps (duration of time that one tone is used in a sweep). * Duration: Duration of the alarm.

A duration of 0 stops the current alarm if any is ongoing. A duration of 4294967295 results in an infinite alarm.

Below you can find two sets of example settings that you can try out. You can use these as a starting point to find an alarm signal that suits your application.

Example 1: 10 seconds of loud annoying fast alarm

* Start Frequency = 800 * End Frequency = 2000 * Step Size = 10 * Step Delay = 1 * Volume = 10 * Duration = 10000

Example 2: 10 seconds of soft siren sound with slow build-up

* Start Frequency = 250 * End Frequency = 750 * Step Size = 1 * Step Delay = 5 * Volume = 0 * Duration = 10000

The following conditions must be met:

* Start Frequency: has to be smaller than end frequency * End Frequency: has to be bigger than start frequency * Step Size: has to be small enough to fit into the frequency range * Step Delay: has to be small enough to fit into the duration

Associated constants:

* AlarmDurationOff
* AlarmDurationInfinite

func (*PiezoSpeakerV2Bricklet) SetBeep

func (device *PiezoSpeakerV2Bricklet) SetBeep(frequency uint16, volume uint8, duration BeepDuration) (err error)

Beeps with the given frequency and volume for the duration.

A duration of 0 stops the current beep if any is ongoing. A duration of 4294967295 results in an infinite beep.

Associated constants:

* BeepDurationOff
* BeepDurationInfinite

func (*PiezoSpeakerV2Bricklet) SetBootloaderMode

func (device *PiezoSpeakerV2Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot
* BootloaderStatusOK
* BootloaderStatusInvalidMode
* BootloaderStatusNoChange
* BootloaderStatusEntryFunctionNotPresent
* BootloaderStatusDeviceIdentifierIncorrect
* BootloaderStatusCRCMismatch

func (*PiezoSpeakerV2Bricklet) SetResponseExpected

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

func (device *PiezoSpeakerV2Bricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*PiezoSpeakerV2Bricklet) SetStatusLEDConfig

func (device *PiezoSpeakerV2Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*PiezoSpeakerV2Bricklet) SetWriteFirmwarePointer

func (device *PiezoSpeakerV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*PiezoSpeakerV2Bricklet) UpdateFrequency

func (device *PiezoSpeakerV2Bricklet) UpdateFrequency(frequency uint16) (err error)

Updates the frequency of an ongoing beep.

func (*PiezoSpeakerV2Bricklet) UpdateVolume

func (device *PiezoSpeakerV2Bricklet) UpdateVolume(volume uint8) (err error)

Updates the volume of an ongoing beep or alarm.

func (*PiezoSpeakerV2Bricklet) WriteFirmware

func (device *PiezoSpeakerV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*PiezoSpeakerV2Bricklet) WriteUID

func (device *PiezoSpeakerV2Bricklet) WriteUID(uid uint32) (err error)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

type StatusLEDConfig

type StatusLEDConfig = uint8
const (
	StatusLEDConfigOff           StatusLEDConfig = 0
	StatusLEDConfigOn            StatusLEDConfig = 1
	StatusLEDConfigShowHeartbeat StatusLEDConfig = 2
	StatusLEDConfigShowStatus    StatusLEDConfig = 3
)