MQTT - Outdoor Weather Bricklet

This is the description of the MQTT API bindings for the Outdoor Weather Bricklet. General information and technical specifications for the Outdoor Weather Bricklet are summarized in its hardware description.

An installation guide for the MQTT API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Callback

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# Change XYZ to the UID of your Outdoor Weather Bricklet

setup:
    # Enable station data callbacks
    publish '{"enable_callback": true}' to tinkerforge/request/outdoor_weather_bricklet/XYZ/set_station_callback_configuration 
    
    # Enable sensor data callbacks
    publish '{"enable_callback": true}' to tinkerforge/request/outdoor_weather_bricklet/XYZ/set_sensor_callback_configuration 
    
    # Handle incoming station data callbacks
    subscribe to tinkerforge/callback/outdoor_weather_bricklet/XYZ/station_data
    publish '{"register": true}' to tinkerforge/register/outdoor_weather_bricklet/XYZ/station_data # Register station_data callback
    
    # Handle incoming sensor data callbacks
    subscribe to tinkerforge/callback/outdoor_weather_bricklet/XYZ/sensor_data
    publish '{"register": true}' to tinkerforge/register/outdoor_weather_bricklet/XYZ/sensor_data # Register sensor_data callback

API

All published payloads to and from the MQTT bindings are in JSON format.

If an error occures, the bindings publish a JSON object containing the error message as attribute "_ERROR". It is published on the corresponding response topic: .../response/... for .../request/... and .../callback/... for .../register/....

Basic Functions

request/outdoor_weather_bricklet/<UID>/get_station_identifiers
Response payload:
  • identifiers -- [int,...]

Returns the identifiers (number between 0 and 255) of all stations that have been seen since the startup of the Bricklet.

Each station gives itself a random identifier on first startup.

Since firmware version 2.0.2 a station is removed from the list if no data was received for 12 hours.

request/outdoor_weather_bricklet/<UID>/get_sensor_identifiers
Response payload:
  • identifiers -- [int,...]

Returns the identifiers (number between 0 and 255) of all sensors that have been seen since the startup of the Bricklet.

Each sensor gives itself a random identifier on first startup.

Since firmware version 2.0.2 a sensor is removed from the list if no data was received for 12 hours.

request/outdoor_weather_bricklet/<UID>/get_station_data
Request payload:
  • identifier -- int
Response payload:
  • temperature -- int
  • humidity -- int
  • wind_speed -- int
  • gust_speed -- int
  • rain -- int
  • wind_direction -- int (has symbols)
  • battery_low -- bool
  • last_change -- int

Returns the last received data for a station with the given identifier. Call request/outdoor_weather_bricklet/<UID>/get_station_identifiers for a list of all available identifiers.

The return values are:

  • Temperature in °C/10,
  • Humidity in %RH,
  • Wind Speed in m/10s,
  • Gust Speed in m/10s,
  • Rain Fall in mm/10,
  • Wind Direction (N, NNE, NE, ENE, E, ESE, SE, SSE, S, SSW, SW, WSW, W, WNW, NW, NNW),
  • Battery Low (true or false) and
  • Last Change (time in seconds since the reception of this data).

The following symbols are available for this function:

for wind_direction:

  • "N" = 0
  • "NNE" = 1
  • "NE" = 2
  • "ENE" = 3
  • "E" = 4
  • "ESE" = 5
  • "SE" = 6
  • "SSE" = 7
  • "S" = 8
  • "SSW" = 9
  • "SW" = 10
  • "WSW" = 11
  • "W" = 12
  • "WNW" = 13
  • "NW" = 14
  • "NNW" = 15
  • "Error" = 255
request/outdoor_weather_bricklet/<UID>/get_sensor_data
Request payload:
  • identifier -- int
Response payload:
  • temperature -- int
  • humidity -- int
  • last_change -- int

Returns the last measured data for a sensor with the given identifier. Call request/outdoor_weather_bricklet/<UID>/get_sensor_identifiers for a list of all available identifiers.

The return values are:

  • Temperature in °C/10,
  • Humidity in %RH and
  • Last Change (time in seconds since the last reception of data).

Advanced Functions

request/outdoor_weather_bricklet/<UID>/get_spitfp_error_count
Response payload:
  • error_count_ack_checksum -- int
  • error_count_message_checksum -- int
  • error_count_frame -- int
  • error_count_overflow -- int

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.

request/outdoor_weather_bricklet/<UID>/set_bootloader_mode
Request payload:
  • mode -- int (has symbols)
Response payload:
  • status -- int (has symbols)

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.

The following symbols are available for this function:

for mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4

for status:

  • "OK" = 0
  • "InvalidMode" = 1
  • "NoChange" = 2
  • "EntryFunctionNotPresent" = 3
  • "DeviceIdentifierIncorrect" = 4
  • "CRCMismatch" = 5
request/outdoor_weather_bricklet/<UID>/get_bootloader_mode
Response payload:
  • mode -- int (has symbols)

Returns the current bootloader mode, see request/outdoor_weather_bricklet/<UID>/set_bootloader_mode.

The following symbols are available for this function:

for mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4
request/outdoor_weather_bricklet/<UID>/set_write_firmware_pointer
Request payload:
  • pointer -- int

Sets the firmware pointer for request/outdoor_weather_bricklet/<UID>/write_firmware. 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.

request/outdoor_weather_bricklet/<UID>/write_firmware
Request payload:
  • data -- [int,... (x64)]
Response payload:
  • status -- int

Writes 64 Bytes of firmware at the position as written by request/outdoor_weather_bricklet/<UID>/set_write_firmware_pointer 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.

request/outdoor_weather_bricklet/<UID>/set_status_led_config
Request payload:
  • config -- int (has symbols)

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.

The following symbols are available for this function:

for config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/outdoor_weather_bricklet/<UID>/get_status_led_config
Response payload:
  • config -- int (has symbols)

Returns the configuration as set by request/outdoor_weather_bricklet/<UID>/set_status_led_config

The following symbols are available for this function:

for config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/outdoor_weather_bricklet/<UID>/get_chip_temperature
Response payload:
  • temperature -- int

Returns the temperature in °C 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.

request/outdoor_weather_bricklet/<UID>/reset

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!

request/outdoor_weather_bricklet/<UID>/write_uid
Request payload:
  • uid -- int

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.

request/outdoor_weather_bricklet/<UID>/read_uid
Response payload:
  • uid -- int

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

request/outdoor_weather_bricklet/<UID>/get_identity
Response payload:
  • uid -- string
  • connected_uid -- string
  • position -- char
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (has symbols)
  • _display_name -- 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' or 'd'.

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 Outdoor Weather's name in a human readable form.

Callback Configuration Functions

request/outdoor_weather_bricklet/<UID>/set_station_callback_configuration
Request payload:
  • enable_callback -- bool

Turns callback for station data on or off. Default is off.

request/outdoor_weather_bricklet/<UID>/get_station_callback_configuration
Response payload:
  • enable_callback -- bool

Returns the configuration as set by request/outdoor_weather_bricklet/<UID>/set_station_callback_configuration.

request/outdoor_weather_bricklet/<UID>/set_sensor_callback_configuration
Request payload:
  • enable_callback -- bool

Turns callback for sensor data on or off. Default is off.

request/outdoor_weather_bricklet/<UID>/get_sensor_callback_configuration
Response payload:
  • enable_callback -- bool

Returns the configuration as set by request/outdoor_weather_bricklet/<UID>/set_sensor_callback_configuration.

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.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

register/outdoor_weather_bricklet/<UID>/station_data
Request payload:
  • register -- bool
Response payload:
  • identifier -- int
  • temperature -- int
  • humidity -- int
  • wind_speed -- int
  • gust_speed -- int
  • rain -- int
  • wind_direction -- int (has symbols)
  • battery_low -- bool

A callback can be registered for this event by publishing to the .../register/outdoor_weather_bricklet/<UID>/station_data[/<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/outdoor_weather_bricklet/<UID>/station_data[/<SUFFIX>] topic for each registered suffix.

Reports the station data every time a new data packet is received. See request/outdoor_weather_bricklet/<UID>/get_station_data for information about the data.

For each station the callback will be triggered about every 45 seconds.

Turn the callback on/off with request/outdoor_weather_bricklet/<UID>/set_station_callback_configuration (by default it is turned off).

The following symbols are available for this function:

for wind_direction:

  • "N" = 0
  • "NNE" = 1
  • "NE" = 2
  • "ENE" = 3
  • "E" = 4
  • "ESE" = 5
  • "SE" = 6
  • "SSE" = 7
  • "S" = 8
  • "SSW" = 9
  • "SW" = 10
  • "WSW" = 11
  • "W" = 12
  • "WNW" = 13
  • "NW" = 14
  • "NNW" = 15
  • "Error" = 255
register/outdoor_weather_bricklet/<UID>/sensor_data
Request payload:
  • register -- bool
Response payload:
  • identifier -- int
  • temperature -- int
  • humidity -- int

A callback can be registered for this event by publishing to the .../register/outdoor_weather_bricklet/<UID>/sensor_data[/<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/outdoor_weather_bricklet/<UID>/sensor_data[/<SUFFIX>] topic for each registered suffix.

Reports the sensor data every time a new data packet is received. See request/outdoor_weather_bricklet/<UID>/get_sensor_data for information about the data.

For each station the callback will be called about every 45 seconds.

Turn the callback on/off with request/outdoor_weather_bricklet/<UID>/set_sensor_callback_configuration (by default it is turned off).