MQTT - Sound Intensity Bricklet¶

Simple¶

Download (example-simple.txt)

1
2
3
4
5
6

# Change XYZ to the UID of your Sound Intensity Bricklet

setup:
    # Get current intensity
    subscribe to tinkerforge/response/sound_intensity_bricklet/XYZ/get_intensity
    publish '' to tinkerforge/request/sound_intensity_bricklet/XYZ/get_intensity

Callback¶

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

# Change XYZ to the UID of your Sound Intensity Bricklet

setup:
    # Handle incoming intensity callbacks
    subscribe to tinkerforge/callback/sound_intensity_bricklet/XYZ/intensity
    publish '{"register": true}' to tinkerforge/register/sound_intensity_bricklet/XYZ/intensity # Register intensity callback

    # Set period for intensity callback to 0.05s (50ms)
    # Note: The intensity callback is only called every 0.05 seconds
    #       if the intensity has changed since the last call!
    publish '{"period": 50}' to tinkerforge/request/sound_intensity_bricklet/XYZ/set_intensity_callback_period

Threshold¶

Download (example-threshold.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

# Change XYZ to the UID of your Sound Intensity Bricklet

setup:
    # Get threshold callbacks with a debounce time of 1 second (1000ms)
    publish '{"debounce": 1000}' to tinkerforge/request/sound_intensity_bricklet/XYZ/set_debounce_period

    # Handle incoming intensity reached callbacks
    subscribe to tinkerforge/callback/sound_intensity_bricklet/XYZ/intensity_reached
    publish '{"register": true}' to tinkerforge/register/sound_intensity_bricklet/XYZ/intensity_reached # Register intensity_reached callback

    # Configure threshold for intensity "greater than 2000"
    publish '{"option": "greater", "min": 2000, "max": 0}' to tinkerforge/request/sound_intensity_bricklet/XYZ/set_intensity_callback_threshold

Basic Functions¶

request/sound_intensity_bricklet/<UID>/get_intensity¶

Request:	empty payload
Response:	intensity – Type: int, Range: [0 to 212 - 1]

Returns the current sound intensity.

The value corresponds to the upper envelop of the signal of the microphone capsule.

If you want to get the intensity periodically, it is recommended to use the register/sound_intensity_bricklet/<UID>/intensity callback and set the period with request/sound_intensity_bricklet/<UID>/set_intensity_callback_period.

Advanced Functions¶

request/sound_intensity_bricklet/<UID>/get_identity¶

Request:

empty payload

Response:

uid – Type: string, Length: up to 8 connected_uid – Type: string, Length: up to 8 position – Type: char, Range: ["a" to "h", "z"] hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] device_identifier – Type: int, Range: [0 to 216 - 1] _display_name – Type: string

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 is always at position 'z'.

The device identifier numbers can be found here. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the Sound Intensity's name in a human readable form.

Callback Configuration Functions¶

request/sound_intensity_bricklet/<UID>/set_intensity_callback_period¶

Request:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:	no response

Sets the period with which the register/sound_intensity_bricklet/<UID>/intensity callback is triggered periodically. A value of 0 turns the callback off.

The register/sound_intensity_bricklet/<UID>/intensity callback is only triggered if the intensity has changed since the last triggering.

request/sound_intensity_bricklet/<UID>/get_intensity_callback_period¶

Request:	empty payload
Response:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by request/sound_intensity_bricklet/<UID>/set_intensity_callback_period.

request/sound_intensity_bricklet/<UID>/set_intensity_callback_threshold¶

Request:	option – Type: char, Range: See symbols, Default: "x" min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0
Response:	no response

Sets the thresholds for the register/sound_intensity_bricklet/<UID>/intensity_reached 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)

The following symbols are available for this function:

For option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/sound_intensity_bricklet/<UID>/get_intensity_callback_threshold¶

Request:	empty payload
Response:	option – Type: char, Range: See symbols, Default: "x" min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by request/sound_intensity_bricklet/<UID>/set_intensity_callback_threshold.

The following symbols are available for this function:

For option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/sound_intensity_bricklet/<UID>/set_debounce_period¶

Request:	debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Response:	no response

Sets the period with which the threshold callback

• register/sound_intensity_bricklet/<UID>/intensity_reached

is triggered, if the thresholds

• request/sound_intensity_bricklet/<UID>/set_intensity_callback_threshold

keeps being reached.

request/sound_intensity_bricklet/<UID>/get_debounce_period¶

Request:	empty payload
Response:	debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by request/sound_intensity_bricklet/<UID>/set_debounce_period.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

register/sound_intensity_bricklet/<UID>/intensity¶

Register Request:	register – Type: bool
Callback Response:	intensity – Type: int, Range: [0 to 212 - 1]

A callback can be registered for this event by publishing to the .../register/sound_intensity_bricklet/<UID>/intensity[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/sound_intensity_bricklet/<UID>/intensity[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically with the period that is set by request/sound_intensity_bricklet/<UID>/set_intensity_callback_period. The callback payload is the intensity of the sensor.

The register/sound_intensity_bricklet/<UID>/intensity callback is only triggered if the intensity has changed since the last triggering.

register/sound_intensity_bricklet/<UID>/intensity_reached¶

Register Request:	register – Type: bool
Callback Response:	intensity – Type: int, Range: [0 to 212 - 1]

A callback can be registered for this event by publishing to the .../register/sound_intensity_bricklet/<UID>/intensity_reached[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/sound_intensity_bricklet/<UID>/intensity_reached[/<SUFFIX>] topic for each registered suffix.

This callback is triggered when the threshold as set by request/sound_intensity_bricklet/<UID>/set_intensity_callback_threshold is reached. The callback payload is the intensity of the encoder.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by request/sound_intensity_bricklet/<UID>/set_debounce_period.