UNPKG

signalk-victron-ble

Version:

Simple Signal K Node server plugin to read data from Victron devices using Instant Data over BLE

github.com/stefanor/signalk-victron-ble

stefanor/signalk-victron-ble

66 lines (52 loc) • 2.29 kB
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
# signalk-victron-ble A SignalK plugin that reads Victron data over Instant Readout Bluetooth Low Energy (BLE) messages. This is built on top of the [victron_ble](https://github.com/keshavdv/victron-ble) Python library, by Keshav Varma. Currently supported: * BMV 712 Battery Monitors. * Battery Sense. * BlueSolar MPPT chargers (with VE.Direct Bluetooth dongle) * Inverters (untested). * Lynx Smart BMS. * MultiPlus inverters (with VE.Bus Bluetooth dongle, untested) * MultiPlus RS hybrid inverters (untested). * Orion Smart DC/DC chargers/converters. * Orion XS DC/DC chargers/converters. * Smart Lithum batteries. * Smart Shunts. * Smart Solar MPPT chargers. * Smart Chargers. ## Installation - Before installing, you need to have `python3` installed, with a working `venv` module. - On Debian/Ubuntu/Raspberry Pi OS, this means installing the `python3-venv` package. - Supported Python 3 versions: >= 3.9 - Install this plugin through SignalK / npm. - Use the native Victron app to obtain advertisement keys for communicating with your Victron devices. There are instructions for this [here](https://github.com/keshavdv/victron-ble#usage). - Configure each Victron device in the SignalK plugin settings: - Decide on a SignalK ID for the battery/device/bus, e.g. `house`. - Provide the Bluetooth MAC address of the device. - Provide the advertisement key for the device. - If appropriate, provide a `secondary battery` ID. e.g. `start` for a BMV that is connected to a house bank and start bank. - Restart SignalK. ## Development - clone the plugin from Github - `npm link` in the plugin directory - `npm link signalk-victron-ble` in your server directory ## License Copyright 2022-2023 Stefano Rivera <stefano@rivera.za.net> Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.