From 12b0921d9e6a4d1e5ba8bde76912cd42a959c5e1 Mon Sep 17 00:00:00 2001 From: djnitehawk Date: Thu, 13 Mar 2025 10:30:31 +0530 Subject: [PATCH] first release --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cc9ad29..0945b86 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,17 @@ This application allows you to monitor Felicity inverters in realtime via a RJ45 to USB cable as an alternative to the wifi module and cloud based apps. -For this to work, you need to connect a linux computer such as a raspberry/orange pi or any other linux computer to the inverter via USB to the inverters RJ45 marked RS232 which is typically on the left next to the BMS port. This application has not been tested on Windows/Mac but might work if you can figure out the correct drivers and COM port names. +For this to work, you need to connect a computer such as a raspberry/orange pi or any other computer (Linux or Windows) to the inverter via USB to the inverters RJ45 port marked RS232 which is typically on the left next to the BMS port. This application has not been tested on MacOs but might work if you can figure out the correct drivers and port names. -Once your inverter is connected via data cable, a new device path should appear either in `/dev/hidrawX` or `/dev/ttyUSBX`. Open up the `appsettings.json` file and make sure the `DeviceAddress` setting correctly points to your USB device such as `/dev/ttyUSB1`. +Once your inverter is connected via data cable, a new device should appear on Linux at `/dev/ttyUSBX` or `COMX` in Windows. Open up the `appsettings.json` file and make sure the `DeviceAddress` setting correctly points to your USB device such as `/dev/ttyUSB1` or `COM1`. After the correct USB device path is setup, all you have to do is execute the `InverterMon.Server` executable. The binaries can be downloaded from the [releases section](https://github.com/dj-nitehawk/Felicity-Inverter-Monitor/releases). Make sure to choose the correct architecture (x64/arm) for your machine. -After the application has started successfully, you can simply open up a web browser and navigate to `http://ip.address.of.machine` to see the dashboard. It may take up to 5 seconds for the data to show up initially. +After the application has started successfully, you can simply open up a web browser and navigate to `http://ip.address.of.machine` or `http://localhost` if the app is running in the same machine, to see the dashboard. It may take up to 5 seconds for the data to show up initially. If you have a firewall, please open port `80` to facilitate communication. -In order to make the application/server automatically start at boot, follow the below procedure to create a `systemd` service. +In order to make the application/server automatically start at boot on Linux, follow the below procedure to create a `systemd` service. # Auto Start Configuration Steps @@ -29,8 +29,6 @@ add the following text to the end: KERNEL=="ttyUSB1", SYMLINK="ttyUSB1", TAG+="systemd" ``` -if your device is mounted as a **hidraw** device, change the value above to `hidrawX`. - create a new file for the service `sudo nano /etc/systemd/system/invertermon.service` @@ -38,7 +36,7 @@ create a new file for the service copy/paste the following: ```ini [Unit] -Description=Hybrid Inverter Monitor +Description=Felicity Inverter Monitor #change here if device is hidraw After=dev-ttyUSB1.device