@mschaeffler/node-red-bthome 1.6.1

A Node Red node to decrypt and decode BT-Home frames

npm install @mschaeffler/node-red-bthome

@mschaeffler/node-red-bthome

A Node Red node to decrypt and decode raw data frames from BT-Home sensors.

At the moment these sensors are implemented and tested:

• Shelly BLU Door/Window
• Shelly BLU H&T
• Shelly BLU Button 1
• Shelly BLU Button Tough 1
• Shelly BLU RC Button 4
• Shelly BLU Wall Switch 4
• Shelly BLU Motion
• Shelly BLU Distance
• Shelly BLU Remote
• Ecowitt WS90 powered by Shelly

Capture of Raw Frames

The raw data frames are captured by Shelly devices with Bluetooth (Gen2 up to Gen4) and then sent via MQTT to Node-Red.

This is the script to be used.

Encryption

This node can decrypt encrypted messages, if the AES key is set in the devices parameter.

Install

$ npm install @mschaeffler/node-red-bthome

bthome Node

This node decodes the raw frames.

Input

msg.payload

Only the first two values are needed, the others are optional.

This is an example of such a message payload:

{
    "addr":    "11:22:33:44:55:66",
    "rssi":    -85,
    "time":    1745395033113,
    "gateway": "Shelly Gateway",
    "data":    [68,0,164,1,100,46,56,69,43,255]
}

Outputs

There are two output ports:

1. one for meassurement values (states)
2. one for actions done with the devices (events)

State

Events

Parameters

Device-Configuration

With this JSON string the installed BT-Home devices are configured:

{
    "<mac address of the device>": { "topic": "<name of the device>", "key": "<encryption key, if device is encrypted>" }
}

An example for such a config from the unit tests:

{
    "11:22:33:44:55:66": { "topic": "dev_unencrypted_1" },
    "00:01:02:03:04:05": { "topic": "dev_unencrypted_2" },
    "00:10:20:30:40:50": { "topic": "dev_encrypted_1", "key": "00112233445566778899AABBCCDDEEFF" },
    "00:00:00:00:00:00": { "topic": "dev_encrypted_2", "key": [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16] }
}

Context storage

All recorded data can be stored in a flow context variable for

• initialisation
• statistics
• visualisation

Example:

{
    "dev_unencrypted_1":
    {
        "pid":       164,
        "time":      1745395033113,
        "encrypted": false,
        "battery":   100,
        "gw":        { "Shelly Gateway": { "time": 1745395033113, "rssi":-85 } },
        "data":      { "humidity":56, "temperature":-21.3 }
    }
}

If content storage is active, statistical data is also stored in a variable with the suffix -stat:

{ ok:0, err:0, old:0, dup:0 }

ws90 Node

This node does additional calulations with the data from an "Ecowitt WS90 powered by Shelly" weather station.

Normally this data is decoded by the bthome node.

Similar calculations are done by the Ecowitt base stations.

Input

This is an example of such a message payload:

{
    "lux":           3630,
    "moisture":      false,
    "wind":          [1.5,1.5],
    "uv":            0,
    "direction":     174,
    "pressure":      948.2,
    "dewpoint":      -0.43,
    "humidity":      99,
    "temperature":   -0.3,
    "precipitation": 121.5
}

Outputs

There are 12 output ports:

values are only sent out, if they are changed

style classes

Some values have style classes for the dashboard 2 attached.

This classes should be defined (for an example check the ui-template in the examples):

• greenValue
• yellowValue
• redValue
• blueValue

Parameters

Example Flow

example flow

CSS template

Author

Mathias Schäffler

License

LGPL-2.1