JavaScript - Outdoor Weather Bricklet

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

Examples

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

Callback (Node.js)

Download (ExampleCallback.js)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Outdoor Weather Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var ow = new Tinkerforge.BrickletOutdoorWeather(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Enable station data callbacks
        ow.setStationCallbackConfiguration(true);

        // Enable sensor data callbacks
        ow.setSensorCallbackConfiguration(true);
    }
);

// Register station data callback
ow.on(Tinkerforge.BrickletOutdoorWeather.CALLBACK_STATION_DATA,
    // Callback function for station data callback
    function (identifier, temperature, humidity, windSpeed, gustSpeed, rain,
              windDirection, batteryLow) {
        console.log('Identifier (Station): ' + identifier);
        console.log('Temperature (Station): ' + temperature/10.0 + ' °C');
        console.log('Humidity (Station): ' + humidity + ' %RH');
        console.log('Wind Speed (Station): ' + windSpeed/10.0 + ' m/s');
        console.log('Gust Speed (Station): ' + gustSpeed/10.0 + ' m/s');
        console.log('Rain (Station): ' + rain/10.0 + ' mm');

        if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_N) {
            console.log('Wind Direction (Station): N');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NNE) {
            console.log('Wind Direction (Station): NNE');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NE) {
            console.log('Wind Direction (Station): NE');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_ENE) {
            console.log('Wind Direction (Station): ENE');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_E) {
            console.log('Wind Direction (Station): E');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_ESE) {
            console.log('Wind Direction (Station): ESE');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SE) {
            console.log('Wind Direction (Station): SE');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SSE) {
            console.log('Wind Direction (Station): SSE');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_S) {
            console.log('Wind Direction (Station): S');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SSW) {
            console.log('Wind Direction (Station): SSW');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SW) {
            console.log('Wind Direction (Station): SW');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_WSW) {
            console.log('Wind Direction (Station): WSW');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_W) {
            console.log('Wind Direction (Station): W');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_WNW) {
            console.log('Wind Direction (Station): WNW');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NW) {
            console.log('Wind Direction (Station): NW');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NNW) {
            console.log('Wind Direction (Station): NNW');
        }
        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_ERROR) {
            console.log('Wind Direction (Station): Error');
        }

        console.log('Battery Low (Station): ' + batteryLow);
        console.log();
    }
);

// Register sensor data callback
ow.on(Tinkerforge.BrickletOutdoorWeather.CALLBACK_SENSOR_DATA,
    // Callback function for sensor data callback
    function (identifier, temperature, humidity) {
        console.log('Identifier (Sensor): ' + identifier);
        console.log('Temperature (Sensor): ' + temperature/10.0 + ' °C');
        console.log('Humidity (Sensor): ' + humidity + ' %RH');
        console.log();
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Callback (HTML)

Download (ExampleCallback.html), Test (ExampleCallback.html)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Outdoor Weather Bricklet Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var ow = new Tinkerforge.BrickletOutdoorWeather(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Enable station data callbacks
                        ow.setStationCallbackConfiguration(true);

                        // Enable sensor data callbacks
                        ow.setSensorCallbackConfiguration(true);
                    }
                );

                // Register station data callback
                ow.on(Tinkerforge.BrickletOutdoorWeather.CALLBACK_STATION_DATA,
                    // Callback function for station data callback
                    function (identifier, temperature, humidity, windSpeed, gustSpeed, rain,
                              windDirection, batteryLow) {
                        textArea.value += 'Identifier (Station): ' + identifier + '\n';
                        textArea.value += 'Temperature (Station): ' + temperature/10.0 + ' °C\n';
                        textArea.value += 'Humidity (Station): ' + humidity + ' %RH\n';
                        textArea.value += 'Wind Speed (Station): ' + windSpeed/10.0 + ' m/s\n';
                        textArea.value += 'Gust Speed (Station): ' + gustSpeed/10.0 + ' m/s\n';
                        textArea.value += 'Rain (Station): ' + rain/10.0 + ' mm\n';

                        if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_N) {
                            textArea.value += 'Wind Direction (Station): N\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NNE) {
                            textArea.value += 'Wind Direction (Station): NNE\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NE) {
                            textArea.value += 'Wind Direction (Station): NE\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_ENE) {
                            textArea.value += 'Wind Direction (Station): ENE\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_E) {
                            textArea.value += 'Wind Direction (Station): E\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_ESE) {
                            textArea.value += 'Wind Direction (Station): ESE\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SE) {
                            textArea.value += 'Wind Direction (Station): SE\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SSE) {
                            textArea.value += 'Wind Direction (Station): SSE\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_S) {
                            textArea.value += 'Wind Direction (Station): S\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SSW) {
                            textArea.value += 'Wind Direction (Station): SSW\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_SW) {
                            textArea.value += 'Wind Direction (Station): SW\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_WSW) {
                            textArea.value += 'Wind Direction (Station): WSW\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_W) {
                            textArea.value += 'Wind Direction (Station): W\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_WNW) {
                            textArea.value += 'Wind Direction (Station): WNW\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NW) {
                            textArea.value += 'Wind Direction (Station): NW\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_NNW) {
                            textArea.value += 'Wind Direction (Station): NNW\n';
                        }
                        else if(windDirection === Tinkerforge.BrickletOutdoorWeather.WIND_DIRECTION_ERROR) {
                            textArea.value += 'Wind Direction (Station): Error\n';
                        }

                        textArea.value += 'Battery Low (Station): ' + batteryLow + '\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );

                // Register sensor data callback
                ow.on(Tinkerforge.BrickletOutdoorWeather.CALLBACK_SENSOR_DATA,
                    // Callback function for sensor data callback
                    function (identifier, temperature, humidity) {
                        textArea.value += 'Identifier (Sensor): ' + identifier + '\n';
                        textArea.value += 'Temperature (Sensor): ' + temperature/10.0 + ' °C\n';
                        textArea.value += 'Humidity (Sensor): ' + humidity + ' %RH\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

API

Generally, every function of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback function is called with the results as arguments, if the function returns its results asynchronously. The errorCallback is called with an error code in case of an error. The error code can be one of the following values:

  • IPConnection.ERROR_ALREADY_CONNECTED = 11
  • IPConnection.ERROR_NOT_CONNECTED = 12
  • IPConnection.ERROR_CONNECT_FAILED = 13
  • IPConnection.ERROR_INVALID_FUNCTION_ID = 21
  • IPConnection.ERROR_TIMEOUT = 31
  • IPConnection.ERROR_INVALID_PARAMETER = 41
  • IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
  • IPConnection.ERROR_UNKNOWN_ERROR = 43
  • IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
  • IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions

new BrickletOutdoorWeather(uid, ipcon)
Parameters:
  • uid – Type: string
  • ipcon – Type: IPConnection
Returns:
  • outdoorWeather – Type: BrickletOutdoorWeather

Creates an object with the unique device ID uid:

var outdoorWeather = new BrickletOutdoorWeather("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected (see examples above).

BrickletOutdoorWeather.getStationIdentifiers([returnCallback][, errorCallback])
Callback Parameters:
  • identifiers – Type: [int, ...], Length: variable, Range: [0 to 255]
Returns:
  • undefined

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.

BrickletOutdoorWeather.getSensorIdentifiers([returnCallback][, errorCallback])
Callback Parameters:
  • identifiers – Type: [int, ...], Length: variable, Range: [0 to 255]
Returns:
  • undefined

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.

BrickletOutdoorWeather.getStationData(identifier[, returnCallback][, errorCallback])
Parameters:
  • identifier – Type: int, Range: [0 to 255]
Callback Parameters:
  • temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 650]
  • humidity – Type: int, Unit: 1 %, Range: [10 to 99]
  • windSpeed – Type: int, Unit: 1/10 m/s, Range: [0 to 232 - 1]
  • gustSpeed – Type: int, Unit: 1/10 m/s, Range: [0 to 232 - 1]
  • rain – Type: int, Unit: 1/10 mm, Range: [0 to 232 - 1]
  • windDirection – Type: int, Range: See constants
  • batteryLow – Type: boolean
  • lastChange – Type: int, Unit: 1 s, Range: [0 to 216 - 1]
Returns:
  • undefined

Returns the last received data for a station with the given identifier. Call getStationIdentifiers() for a list of all available identifiers.

The return values are:

  • Temperature,
  • Humidity,
  • Wind Speed,
  • Gust Speed,
  • Rain Fall,
  • Wind Direction,
  • Battery Low (true if battery is low) and
  • Last Change (seconds since the reception of this data).

The following constants are available for this function:

For wind_direction:

  • BrickletOutdoorWeather.WIND_DIRECTION_N = 0
  • BrickletOutdoorWeather.WIND_DIRECTION_NNE = 1
  • BrickletOutdoorWeather.WIND_DIRECTION_NE = 2
  • BrickletOutdoorWeather.WIND_DIRECTION_ENE = 3
  • BrickletOutdoorWeather.WIND_DIRECTION_E = 4
  • BrickletOutdoorWeather.WIND_DIRECTION_ESE = 5
  • BrickletOutdoorWeather.WIND_DIRECTION_SE = 6
  • BrickletOutdoorWeather.WIND_DIRECTION_SSE = 7
  • BrickletOutdoorWeather.WIND_DIRECTION_S = 8
  • BrickletOutdoorWeather.WIND_DIRECTION_SSW = 9
  • BrickletOutdoorWeather.WIND_DIRECTION_SW = 10
  • BrickletOutdoorWeather.WIND_DIRECTION_WSW = 11
  • BrickletOutdoorWeather.WIND_DIRECTION_W = 12
  • BrickletOutdoorWeather.WIND_DIRECTION_WNW = 13
  • BrickletOutdoorWeather.WIND_DIRECTION_NW = 14
  • BrickletOutdoorWeather.WIND_DIRECTION_NNW = 15
  • BrickletOutdoorWeather.WIND_DIRECTION_ERROR = 255
BrickletOutdoorWeather.getSensorData(identifier[, returnCallback][, errorCallback])
Parameters:
  • identifier – Type: int, Range: [0 to 255]
Callback Parameters:
  • temperature – Type: int, Unit: 1/10 °C, Range: [-215 to 215 - 1]
  • humidity – Type: int, Unit: 1 %, Range: [0 to 255]
  • lastChange – Type: int, Unit: 1 s, Range: [0 to 216 - 1]
Returns:
  • undefined

Returns the last measured data for a sensor with the given identifier. Call getSensorIdentifiers() for a list of all available identifiers.

The return values are:

  • Temperature,
  • Humidity and
  • Last Change (seconds since the last reception of data).

Advanced Functions

BrickletOutdoorWeather.getSPITFPErrorCount([returnCallback][, errorCallback])
Callback Parameters:
  • errorCountAckChecksum – Type: int, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: int, Range: [0 to 232 - 1]
  • errorCountFrame – Type: int, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: int, Range: [0 to 232 - 1]
Returns:
  • undefined

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.

BrickletOutdoorWeather.setBootloaderMode(mode[, returnCallback][, errorCallback])
Parameters:
  • mode – Type: int, Range: See constants
Callback Parameters:
  • status – Type: int, Range: See constants
Returns:
  • undefined

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 constants are available for this function:

For mode:

  • BrickletOutdoorWeather.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletOutdoorWeather.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • BrickletOutdoorWeather.BOOTLOADER_STATUS_OK = 0
  • BrickletOutdoorWeather.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletOutdoorWeather.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletOutdoorWeather.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletOutdoorWeather.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletOutdoorWeather.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletOutdoorWeather.getBootloaderMode([returnCallback][, errorCallback])
Callback Parameters:
  • mode – Type: int, Range: See constants
Returns:
  • undefined

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For mode:

  • BrickletOutdoorWeather.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletOutdoorWeather.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletOutdoorWeather.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])
Parameters:
  • pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Callback Parameters:
  • undefined
Returns:
  • undefined

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.

BrickletOutdoorWeather.writeFirmware(data[, returnCallback][, errorCallback])
Parameters:
  • data – Type: [int, ...], Length: 64, Range: [0 to 255]
Callback Parameters:
  • status – Type: int, Range: [0 to 255]
Returns:
  • undefined

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.

BrickletOutdoorWeather.setStatusLEDConfig(config[, returnCallback][, errorCallback])
Parameters:
  • config – Type: int, Range: See constants, Default: 3
Callback Parameters:
  • undefined
Returns:
  • undefined

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 constants are available for this function:

For config:

  • BrickletOutdoorWeather.STATUS_LED_CONFIG_OFF = 0
  • BrickletOutdoorWeather.STATUS_LED_CONFIG_ON = 1
  • BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletOutdoorWeather.getStatusLEDConfig([returnCallback][, errorCallback])
Callback Parameters:
  • config – Type: int, Range: See constants, Default: 3
Returns:
  • undefined

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For config:

  • BrickletOutdoorWeather.STATUS_LED_CONFIG_OFF = 0
  • BrickletOutdoorWeather.STATUS_LED_CONFIG_ON = 1
  • BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletOutdoorWeather.getChipTemperature([returnCallback][, errorCallback])
Callback Parameters:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]
Returns:
  • undefined

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.

BrickletOutdoorWeather.reset([returnCallback][, errorCallback])
Callback Parameters:
  • undefined
Returns:
  • undefined

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!

BrickletOutdoorWeather.writeUID(uid[, returnCallback][, errorCallback])
Parameters:
  • uid – Type: int, Range: [0 to 232 - 1]
Callback Parameters:
  • undefined
Returns:
  • undefined

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.

BrickletOutdoorWeather.readUID([returnCallback][, errorCallback])
Callback Parameters:
  • uid – Type: int, Range: [0 to 232 - 1]
Returns:
  • undefined

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

BrickletOutdoorWeather.getIdentity([returnCallback][, errorCallback])
Callback Parameters:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • hardwareVersion – 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]
  • firmwareVersion – 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]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]
Returns:
  • undefined

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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletOutdoorWeather.on(callback_id, function)
Parameters:
  • callback_id – Type: int
  • function – Type: function
Returns:
  • undefined

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletOutdoorWeather.setStationCallbackConfiguration(enableCallback[, returnCallback][, errorCallback])
Parameters:
  • enableCallback – Type: boolean, Default: false
Callback Parameters:
  • undefined
Returns:
  • undefined

Turns callback for station data on or off.

BrickletOutdoorWeather.getStationCallbackConfiguration([returnCallback][, errorCallback])
Callback Parameters:
  • enableCallback – Type: boolean, Default: false
Returns:
  • undefined

Returns the configuration as set by setStationCallbackConfiguration().

BrickletOutdoorWeather.setSensorCallbackConfiguration(enableCallback[, returnCallback][, errorCallback])
Parameters:
  • enableCallback – Type: boolean, Default: false
Callback Parameters:
  • undefined
Returns:
  • undefined

Turns callback for sensor data on or off.

BrickletOutdoorWeather.getSensorCallbackConfiguration([returnCallback][, errorCallback])
Callback Parameters:
  • enableCallback – Type: boolean, Default: false
Returns:
  • undefined

Returns the configuration as set by setSensorCallbackConfiguration().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

outdoorWeather.on(BrickletOutdoorWeather.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

The available constants with inherent number and type of parameters 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.

BrickletOutdoorWeather.CALLBACK_STATION_DATA
Callback Parameters:
  • identifier – Type: int, Range: [0 to 255]
  • temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 650]
  • humidity – Type: int, Unit: 1 %, Range: [10 to 99]
  • windSpeed – Type: int, Unit: 1/10 m/s, Range: [0 to 232 - 1]
  • gustSpeed – Type: int, Unit: 1/10 m/s, Range: [0 to 232 - 1]
  • rain – Type: int, Unit: 1/10 mm, Range: [0 to 232 - 1]
  • windDirection – Type: int, Range: See constants
  • batteryLow – Type: boolean

Reports the station data every time a new data packet is received. See getStationData() for information about the data.

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

Turn the callback on/off with setStationCallbackConfiguration() (by default it is turned off).

The following constants are available for this function:

For wind_direction:

  • BrickletOutdoorWeather.WIND_DIRECTION_N = 0
  • BrickletOutdoorWeather.WIND_DIRECTION_NNE = 1
  • BrickletOutdoorWeather.WIND_DIRECTION_NE = 2
  • BrickletOutdoorWeather.WIND_DIRECTION_ENE = 3
  • BrickletOutdoorWeather.WIND_DIRECTION_E = 4
  • BrickletOutdoorWeather.WIND_DIRECTION_ESE = 5
  • BrickletOutdoorWeather.WIND_DIRECTION_SE = 6
  • BrickletOutdoorWeather.WIND_DIRECTION_SSE = 7
  • BrickletOutdoorWeather.WIND_DIRECTION_S = 8
  • BrickletOutdoorWeather.WIND_DIRECTION_SSW = 9
  • BrickletOutdoorWeather.WIND_DIRECTION_SW = 10
  • BrickletOutdoorWeather.WIND_DIRECTION_WSW = 11
  • BrickletOutdoorWeather.WIND_DIRECTION_W = 12
  • BrickletOutdoorWeather.WIND_DIRECTION_WNW = 13
  • BrickletOutdoorWeather.WIND_DIRECTION_NW = 14
  • BrickletOutdoorWeather.WIND_DIRECTION_NNW = 15
  • BrickletOutdoorWeather.WIND_DIRECTION_ERROR = 255
BrickletOutdoorWeather.CALLBACK_SENSOR_DATA
Callback Parameters:
  • identifier – Type: int, Range: [0 to 255]
  • temperature – Type: int, Unit: 1/10 °C, Range: [-215 to 215 - 1]
  • humidity – Type: int, Unit: 1 %, Range: [0 to 255]

Reports the sensor data every time a new data packet is received. See getSensorData() for information about the data.

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

Turn the callback on/off with setSensorCallbackConfiguration() (by default it is turned off).

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletOutdoorWeather.getAPIVersion()
Returns:
  • apiVersion – 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]

Returns the version of the API definition 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.

BrickletOutdoorWeather.getResponseExpected(functionId[, errorCallback])
Parameters:
  • functionId – Type: int, Range: See constants
Returns:
  • responseExpected – Type: boolean

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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • BrickletOutdoorWeather.FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
  • BrickletOutdoorWeather.FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
  • BrickletOutdoorWeather.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletOutdoorWeather.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletOutdoorWeather.FUNCTION_RESET = 243
  • BrickletOutdoorWeather.FUNCTION_WRITE_UID = 248
BrickletOutdoorWeather.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameters:
  • functionId – Type: int, Range: See constants
  • responseExpected – Type: boolean
Returns:
  • undefined

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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • BrickletOutdoorWeather.FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
  • BrickletOutdoorWeather.FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
  • BrickletOutdoorWeather.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletOutdoorWeather.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletOutdoorWeather.FUNCTION_RESET = 243
  • BrickletOutdoorWeather.FUNCTION_WRITE_UID = 248
BrickletOutdoorWeather.setResponseExpectedAll(responseExpected)
Parameters:
  • responseExpected – Type: boolean
Returns:
  • undefined

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

Constants

BrickletOutdoorWeather.DEVICE_IDENTIFIER

This constant is used to identify a Outdoor Weather Bricklet.

The getIdentity() function and the IPConnection.CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletOutdoorWeather.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Outdoor Weather Bricklet.