https://github.com/adamwych/vastra-radiator-valve

Node.js library to query and configure Vastra's smart radiator valves
https://github.com/adamwych/vastra-radiator-valve

nodejs vastra

Last synced: about 1 month ago
JSON representation

Node.js library to query and configure Vastra's smart radiator valves

• Host: GitHub
• URL: https://github.com/adamwych/vastra-radiator-valve
• Owner: adamwych
• License: mit
• Created: 2023-12-23T00:58:23.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-25T08:32:14.000Z (about 1 year ago)
• Last Synced: 2024-12-13T20:28:29.520Z (2 months ago)
• Topics: nodejs, vastra
• Language: TypeScript
• Homepage:
• Size: 69.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vastra-radiator-valve

Node.js library to query and configure Vastra's smart radiator valves.

**Note:**

This is not an official library, the protocol was reverse-engineered. I am not responsible for any problems that might arise after using this library.

I recommend capturing a full snapshot of the internal state of the valve using `RadiatorValve.requestStateSnapshot()` (should be 240 bytes) before doing any unusual things. This way you might be able to upload the entire state back to the device in case you accidentally put it into a bad state.

## Getting started

1. Install the package by running `yarn add vastra-radiator-valve` or `npm install --save vastra-radiator-valve`.

2. Wait for dependencies to be downloaded and compiled (might take some time).

   2.5. If you're using Node.js >= 19 and see errors when building the `usb` dependency, ignore them, everything should still work fine.

3. Take a look at the example below or at other examples in the `examples` folder.

```ts

import {

  NobleBluetoothCentral,

  RadiatorValveScanner,

} from "vastra-radiator-valve";

const bluetooth = await NobleBluetoothCentral.create();

const scanner = new RadiatorValveScanner(bluetooth, {

  // Additional settings...

});

// Scan nearby Bluetooth devices and return first found valve.

const valve = await scanner.findOne();

// Now you can query information from the valve, configure it etc.

const currentTemperature = await valve.getCurrentTemperature();

// Make sure to disconnect once you are done.

await valve.disconnect();

```

## Supported platforms

The library uses [Noble](https://github.com/abandonware/noble) to communicate with peripherals. As per their README:

> macOS / Mac OS X, Linux, FreeBSD and Windows are currently the only supported OSes.

You can implement a custom Bluetooth bridge by implementing the `IGattCentral` interface and passing it to `new RadiatorValveScanner(yourBluetoothBridge)`.

Tested using Node.js 18 on macOS and Raspbian.

**Note**: If you're planning on running this on a Raspberry Pi Zero v1 then beware - it has a very weak Bluetooth chip, so the connection is slow and unstable. Raspberry 3 A+ works much better.

## License

MIT.