/vedirect

Simple VE.Direct reader for Python

Primary LanguagePythonOtherNOASSERTION

VEDirect

This is a Python library for decoding the Victron Energy VE.Direct text protocol used in their range of MPPT solar charge controllers, battery monitors, and inverters.
This is a fork of a forked version of a package originally created by Janne Kario (https://github.com/karioja/vedirect).

This fork adds micropython support. It may need pytomicropy.

Installation

To install directly from GitHub:

$ python3 -m pip install "git+https://github.com/nznobody/vedirect"

If you have cloned or forked the repo already to your local directory and want to use it in live (editable mode):

$ python3 -m pip install -e .

Note in both cases above, the dependencies needed to run the examples are also installed.

Use

from vedirect import VEDirect
ve = VEDirect("COM5")
# Or on micropython, e.g. Fipy
ve = VEDirect("1")
res = ve.read_data_single()
# Or use a custom / already opened port (caution! Not well tested)
from machine import UART
alt_uart = UART(1, baudrate=19200, pins=(None,'P22'))  # RX only on pin22
ve = VEDirect(alt_uart, timeout=5)
res = ve.read_data_single()