Documentation

Overview

Measures sound intensity.

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

Index

Constants

View Source
const DeviceDisplayName = "Sound Intensity Bricklet"
View Source
const DeviceIdentifier = 238

Variables

This section is empty.

Functions

This section is empty.

Types

type Function

type Function = uint8
const (
	FunctionGetIntensity                  Function = 1
	FunctionSetIntensityCallbackPeriod    Function = 2
	FunctionGetIntensityCallbackPeriod    Function = 3
	FunctionSetIntensityCallbackThreshold Function = 4
	FunctionGetIntensityCallbackThreshold Function = 5
	FunctionSetDebouncePeriod             Function = 6
	FunctionGetDebouncePeriod             Function = 7
	FunctionGetIdentity                   Function = 255
	FunctionCallbackIntensity             Function = 8
	FunctionCallbackIntensityReached      Function = 9
)

type SoundIntensityBricklet

type SoundIntensityBricklet 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 (*SoundIntensityBricklet) DeregisterIntensityCallback

func (device *SoundIntensityBricklet) DeregisterIntensityCallback(registrationId uint64)

Remove a registered Intensity callback.

func (*SoundIntensityBricklet) DeregisterIntensityReachedCallback

func (device *SoundIntensityBricklet) DeregisterIntensityReachedCallback(registrationId uint64)

Remove a registered Intensity Reached callback.

func (*SoundIntensityBricklet) GetAPIVersion

func (device *SoundIntensityBricklet) 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 (*SoundIntensityBricklet) GetDebouncePeriod

func (device *SoundIntensityBricklet) GetDebouncePeriod() (debounce uint32, err error)

Returns the debounce period as set by SetDebouncePeriod.

func (*SoundIntensityBricklet) GetIdentity

func (device *SoundIntensityBricklet) 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 (*SoundIntensityBricklet) GetIntensity

func (device *SoundIntensityBricklet) GetIntensity() (intensity uint16, err error)

Returns the current sound intensity.

The value corresponds to the https://en.wikipedia.org/wiki/Envelope_(waves) of the signal of the microphone capsule.

If you want to get the intensity periodically, it is recommended to use the RegisterIntensityCallback callback and set the period with SetIntensityCallbackPeriod.

func (*SoundIntensityBricklet) GetIntensityCallbackPeriod

func (device *SoundIntensityBricklet) GetIntensityCallbackPeriod() (period uint32, err error)

Returns the period as set by SetIntensityCallbackPeriod.

func (*SoundIntensityBricklet) GetIntensityCallbackThreshold

func (device *SoundIntensityBricklet) GetIntensityCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

Returns the threshold as set by SetIntensityCallbackThreshold.

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*SoundIntensityBricklet) GetResponseExpected

func (device *SoundIntensityBricklet) 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 (*SoundIntensityBricklet) RegisterIntensityCallback

func (device *SoundIntensityBricklet) RegisterIntensityCallback(fn func(uint16)) uint64

This callback is triggered periodically with the period that is set by SetIntensityCallbackPeriod. The parameter is the intensity of the sensor.

The RegisterIntensityCallback callback is only triggered if the intensity has changed since the last triggering.

func (*SoundIntensityBricklet) RegisterIntensityReachedCallback

func (device *SoundIntensityBricklet) RegisterIntensityReachedCallback(fn func(uint16)) uint64

This callback is triggered when the threshold as set by SetIntensityCallbackThreshold is reached. The parameter is the intensity of the encoder.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.

func (*SoundIntensityBricklet) SetDebouncePeriod

func (device *SoundIntensityBricklet) SetDebouncePeriod(debounce uint32) (err error)

Sets the period with which the threshold callback

* RegisterIntensityReachedCallback

is triggered, if the thresholds

* SetIntensityCallbackThreshold

keeps being reached.

func (*SoundIntensityBricklet) SetIntensityCallbackPeriod

func (device *SoundIntensityBricklet) SetIntensityCallbackPeriod(period uint32) (err error)

Sets the period with which the RegisterIntensityCallback callback is triggered periodically. A value of 0 turns the callback off.

The RegisterIntensityCallback callback is only triggered if the intensity has changed since the last triggering.

func (*SoundIntensityBricklet) SetIntensityCallbackThreshold

func (device *SoundIntensityBricklet) SetIntensityCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)

Sets the thresholds for the RegisterIntensityReachedCallback callback.

The following options are possible:

Option| Description
--- | ---
'x'|    Callback is turned off
'o'|    Callback is triggered when the intensity is *outside* the min and max values
'i'|    Callback is triggered when the intensity is *inside* the min and max values
'<'|    Callback is triggered when the intensity is smaller than the min value (max is ignored)
'>'|    Callback is triggered when the intensity is greater than the min value (max is ignored)

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*SoundIntensityBricklet) SetResponseExpected

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

func (device *SoundIntensityBricklet) SetResponseExpectedAll(responseExpected bool)

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

type ThresholdOption

type ThresholdOption = rune
const (
	ThresholdOptionOff     ThresholdOption = 'x'
	ThresholdOptionOutside ThresholdOption = 'o'
	ThresholdOptionInside  ThresholdOption = 'i'
	ThresholdOptionSmaller ThresholdOption = '<'
	ThresholdOptionGreater ThresholdOption = '>'
)