VE.Direct-webui

Webbased User Interface to visualize the data collected by VE.Direct-Text-Reader

Prerequisites

This program is meant to run on a linux based computer. Something like a Raspberry Pi or similar system is more than sufficient.

VE.Direct-Text-Reader (database)

This is the front end to the database containing the records of any device information collected by VE.Direct-Text-Reader.
Therefore the PHP process needs read access to that database.

PHP 8.5

This project was developed for PHP 8.5 older and newer versions may work but are not tested.

Webserver

You need a webserver running PHP. This may be something lightweight like caddy. The program does not offer a web server service on its own.

Installation

Option 1: move this directory to your webserver (it may be any sub-folder inside your webserver's directory structure) Option 2: configure your webserver to serve the files from this directory

Configuration

Path to database

For the frontend to work you need to configure the path to the database where VE.Direct-Text-Reader records all the data.
To do so, open config.json and edit the entry databaseaccording to your setup. You may use absolute or relative file paths. If you are using relative paths, ensure the path is relative to the main directory, not the public directory.

Show product images

We didn't as Victron Energy for the permission to use any of their product fotos. Therefore, product images are not part of this software and product pictures are disabled in the UI by default.
You may take your own pictures to show in your installation. To do so, you need to take 2 steps:

  1. save your pictures to the folder images and rename it to {PID}.jpg or {PID}.png. Where {PID} needs to be replaced with the product ID of your product. (you can find that in the user interface)
  2. open the file config.json and change the setting showProductImages to true

Access the user interface

To access the user interface open it on your favourite web browser.

S
Description
Webbased User Interface to visualize the data collected by VE.Direct-Text-Reader
Readme GPL-3.0 72 KiB
Languages
JavaScript 68.5%
PHP 15.6%
CSS 9.3%
HTML 6.6%