Shell - Outdoor Weather Bricklet

This is the description of the Shell 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 Shell API bindings is part of their general description.

Examples

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

Callback

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Outdoor Weather Bricklet

# Enable station data callbacks
tinkerforge call outdoor-weather-bricklet $uid set-station-callback-configuration true

# Enable sensor data callbacks
tinkerforge call outdoor-weather-bricklet $uid set-sensor-callback-configuration true

# Handle incoming station data callbacks
tinkerforge dispatch outdoor-weather-bricklet $uid station-data &

# Handle incoming sensor data callbacks
tinkerforge dispatch outdoor-weather-bricklet $uid sensor-data &

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call outdoor-weather-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the Outdoor Weather Bricklet. It can take several options:

  • --help shows help for the specific call command and exits
  • --list-functions shows a list of known functions of the Outdoor Weather Bricklet and exits
tinkerforge dispatch outdoor-weather-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the Outdoor Weather Bricklet. It can take several options:

  • --help shows help for the specific dispatch command and exits
  • --list-callbacks shows a list of known callbacks of the Outdoor Weather Bricklet and exits
tinkerforge call outdoor-weather-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch outdoor-weather-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> -- string
  • <callback> -- string

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits
  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions

tinkerforge call outdoor-weather-bricklet <uid> get-station-identifiers-low-level
Output:
  • identifiers-length -- int
  • identifiers-chunk-offset -- int
  • identifiers-chunk-data -- int,int,..57x..,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.

tinkerforge call outdoor-weather-bricklet <uid> get-sensor-identifiers-low-level
Output:
  • identifiers-length -- int
  • identifiers-chunk-offset -- int
  • identifiers-chunk-data -- int,int,..57x..,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.

tinkerforge call outdoor-weather-bricklet <uid> get-station-data <identifier>
Parameters:
  • <identifier> -- int
Output:
  • 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 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:

  • wind-direction-n = 0, for wind-direction
  • wind-direction-nne = 1, for wind-direction
  • wind-direction-ne = 2, for wind-direction
  • wind-direction-ene = 3, for wind-direction
  • wind-direction-e = 4, for wind-direction
  • wind-direction-ese = 5, for wind-direction
  • wind-direction-se = 6, for wind-direction
  • wind-direction-sse = 7, for wind-direction
  • wind-direction-s = 8, for wind-direction
  • wind-direction-ssw = 9, for wind-direction
  • wind-direction-sw = 10, for wind-direction
  • wind-direction-wsw = 11, for wind-direction
  • wind-direction-w = 12, for wind-direction
  • wind-direction-wnw = 13, for wind-direction
  • wind-direction-nw = 14, for wind-direction
  • wind-direction-nnw = 15, for wind-direction
  • wind-direction-error = 255, for wind-direction
tinkerforge call outdoor-weather-bricklet <uid> get-sensor-data <identifier>
Parameters:
  • <identifier> -- int
Output:
  • temperature -- int
  • humidity -- int
  • last-change -- int

Returns the last measured data for a sensor with the given identifier. Call 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

tinkerforge call outdoor-weather-bricklet <uid> get-spitfp-error-count
Output:
  • 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.

tinkerforge call outdoor-weather-bricklet <uid> set-bootloader-mode <mode>
Parameters:
  • <mode> -- int (has symbols)
Output:
  • 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:

  • bootloader-mode-bootloader = 0, for <mode>
  • bootloader-mode-firmware = 1, for <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, for <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, for <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for <mode>
  • bootloader-status-ok = 0, for status
  • bootloader-status-invalid-mode = 1, for status
  • bootloader-status-no-change = 2, for status
  • bootloader-status-entry-function-not-present = 3, for status
  • bootloader-status-device-identifier-incorrect = 4, for status
  • bootloader-status-crc-mismatch = 5, for status
tinkerforge call outdoor-weather-bricklet <uid> get-bootloader-mode
Output:
  • mode -- int (has symbols)

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for mode
  • bootloader-mode-firmware = 1, for mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, for mode
  • bootloader-mode-firmware-wait-for-reboot = 3, for mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for mode
tinkerforge call outdoor-weather-bricklet <uid> set-write-firmware-pointer <pointer>
Parameters:
  • <pointer> -- int
Output:

no output

Sets the firmware pointer for 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.

tinkerforge call outdoor-weather-bricklet <uid> write-firmware <data>
Parameters:
  • <data> -- int,int,..61x..,int
Output:
  • status -- int

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

tinkerforge call outdoor-weather-bricklet <uid> set-status-led-config <config>
Parameters:
  • <config> -- int (has symbols)
Output:

no output

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:

  • status-led-config-off = 0, for <config>
  • status-led-config-on = 1, for <config>
  • status-led-config-show-heartbeat = 2, for <config>
  • status-led-config-show-status = 3, for <config>
tinkerforge call outdoor-weather-bricklet <uid> get-status-led-config
Output:
  • config -- int (has symbols)

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

  • status-led-config-off = 0, for config
  • status-led-config-on = 1, for config
  • status-led-config-show-heartbeat = 2, for config
  • status-led-config-show-status = 3, for config
tinkerforge call outdoor-weather-bricklet <uid> get-chip-temperature
Output:
  • 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.

tinkerforge call outdoor-weather-bricklet <uid> reset
Output:no output

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!

tinkerforge call outdoor-weather-bricklet <uid> write-uid <uid>
Parameters:
  • <uid> -- int
Output:

no output

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.

tinkerforge call outdoor-weather-bricklet <uid> read-uid
Output:
  • uid -- int

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

tinkerforge call outdoor-weather-bricklet <uid> get-identity
Output:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (has symbols)

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

Callback Configuration Functions

tinkerforge call outdoor-weather-bricklet <uid> set-station-callback-configuration <enable-callback>
Parameters:
  • <enable-callback> -- bool
Output:

no output

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

tinkerforge call outdoor-weather-bricklet <uid> get-station-callback-configuration
Output:
  • enable-callback -- bool

Returns the configuration as set by set-station-callback-configuration.

tinkerforge call outdoor-weather-bricklet <uid> set-sensor-callback-configuration <enable-callback>
Parameters:
  • <enable-callback> -- bool
Output:

no output

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

tinkerforge call outdoor-weather-bricklet <uid> get-sensor-callback-configuration
Output:
  • enable-callback -- bool

Returns the configuration as set by set-sensor-callback-configuration.

Callbacks

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch outdoor-weather-bricklet <uid> example

The available callbacks are described below.

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.

tinkerforge dispatch outdoor-weather-bricklet <uid> station-data
Output:
  • identifier -- int
  • temperature -- int
  • humidity -- int
  • wind-speed -- int
  • gust-speed -- int
  • rain -- int
  • wind-direction -- int (has symbols)
  • battery-low -- bool

Reports the station data every time a new data packet is received. See 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 set-station-callback-configuration (by default it is turned off).

The following symbols are available for this function:

  • wind-direction-n = 0, for wind-direction
  • wind-direction-nne = 1, for wind-direction
  • wind-direction-ne = 2, for wind-direction
  • wind-direction-ene = 3, for wind-direction
  • wind-direction-e = 4, for wind-direction
  • wind-direction-ese = 5, for wind-direction
  • wind-direction-se = 6, for wind-direction
  • wind-direction-sse = 7, for wind-direction
  • wind-direction-s = 8, for wind-direction
  • wind-direction-ssw = 9, for wind-direction
  • wind-direction-sw = 10, for wind-direction
  • wind-direction-wsw = 11, for wind-direction
  • wind-direction-w = 12, for wind-direction
  • wind-direction-wnw = 13, for wind-direction
  • wind-direction-nw = 14, for wind-direction
  • wind-direction-nnw = 15, for wind-direction
  • wind-direction-error = 255, for wind-direction
tinkerforge dispatch outdoor-weather-bricklet <uid> sensor-data
Output:
  • identifier -- int
  • temperature -- int
  • humidity -- int

Reports the sensor data every time a new data packet is received. See 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 set-sensor-callback-configuration (by default it is turned off).