@mschaeffler/node-red-bthome 1.4.0

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.

image of example flow

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

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

Input

msg.	type	description
payload	object	data from Shelly script
resync	boolean	if set to yes, allow all packed ids; to resync after some issue

msg.payload

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

msg.payload	type	description
addr	string	mac of the BT-Home device (needed)
data	array of bytes	raw BT-Home message (needed)
rssi	number	signal strength
time	number	Javscript timestamp of the reception
gateway	string	name of the geteway

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:

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

State

msg.	type	description
topic	string	`State-Prefix` + name of the device
payload	object	decoded state data

Events

msg.	type	description
topic	string	`Event-Prefix` + name of the device
payload	object	data of the decoded event

Parameters

config	type	description
Devices	JSON	configuration of the BT-Home devices
counter is time	Boolean	the counter in encrypted messages is checked again the actual time
Status-Prefix	string	prefix for the topic for state output
Event-Prefix	string	prefix for the topic for event output
Context-Variable	string	name of the variable in flow context storage
Contextstore	string	context store to be used

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 }

Example Flow

example flow

Author

Mathias Schäffler

License

LGPL-2.1

Node Info

Version: 1.4.0

Updated 2 weeks, 4 days ago

License: LGPL-2.1

Rating: not yet rated

View on npm

View on GitHub

View Scorecard 12

Actions

Downloads

8 in the last week

Nodes

bthome

Keywords

node-red
BT-Home
bthome
Shelly BLU
BLE

Maintainers

mschaeffler