dbus-victron-virtual
v0.1.5
Published
Add interoperability with victron dbus to a given dbus interface
Downloads
578
Readme
About
[!WARNING]
This package is under active development. I believe it is ready for "bleeding edge" use, but its API may have to change, based on findings and bugs. Please use with caution.
dbus-victron-virtual
is a wrapper around
dbus-native, which allows you to
connect to dbus, and
simplify integrating with the Victron
infrastructure: To do this, dbus-victron-virtual
provides functions to
- expose your dbus interface as a Victron service, by implementing the dbus interface
com.victronenergy.BusItem
, - emit the Victron-specific event
ItemsChanged
, and - define and modify settings which are then available through Victron's settings interface.
See dbus-victron-virtual
in action here.
This package may be for you if
- you want to define virtual devices for testing on a Victron device, like a Victron Cerbo GX, e.g. to use it in Node-RED, or
- you need to integrate a device via dbus that is not (yet) supported by Victron natively.
Usage
Prerequisites
You have a NodeJS project you want to run on Venus OS, and you want to communicate with the local dbus.
Setup Up
- Add this package as a dependency:
npm add dbus-victron-virtual
. - Use this package, by importing or requiring it:
const { addVictronInterfaces } = require('dbus-victron-virtual');
- Make sure you understand how to use this package by studying the example.
- Have fun.
Development
Prerequisites
You can develop on a device that runs Venus OS. This way, the dbus environment as required by this package will be available. Alternatively, you can develop in any environment that support node 18 or higher, but you won't be able to run integration tests.
Steps
- clone the repository
npm install
npm run test
- run tests and include running integration tests with
DBUS_SESSION_BUS_ADDRESS=unix:socket=/var/run/dbus/system_bus_socket TEST_INTEGRATION=1 npm run test
The implementation is in ./src/index.js
, tests are in ./src/__tests__
.
Test coverage stats for unit and integration tests (append -- --coverage
to the test command):
----------|---------|----------|---------|---------|----------------------------- File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s ----------|---------|----------|---------|---------|----------------------------- All files | 87.32 | 73.91 | 100 | 86.76 | index.js | 87.32 | 73.91 | 100 | 86.76 | 26,35,39-43,107-108,145,169 ----------|---------|----------|---------|---------|-----------------------------