https://github.com/sermatec-opensource/sermatec-inverter
LAN communication docs and scripts for the Sermatec solar inverter.
https://github.com/sermatec-opensource/sermatec-inverter
protocol sermatec solar solar-inverter
Last synced: 3 months ago
JSON representation
LAN communication docs and scripts for the Sermatec solar inverter.
- Host: GitHub
- URL: https://github.com/sermatec-opensource/sermatec-inverter
- Owner: sermatec-opensource
- License: mit
- Created: 2022-08-25T09:02:50.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T09:24:11.000Z (almost 2 years ago)
- Last Synced: 2026-01-14T12:23:07.357Z (5 months ago)
- Topics: protocol, sermatec, solar, solar-inverter
- Language: Python
- Homepage:
- Size: 769 KB
- Stars: 4
- Watchers: 6
- Forks: 2
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Sermatec Solar Inverter
This repository contains local API documentation for the Sermatec solar inverter and communication scripts.
Whole communication with the inverter runs through the UART-TCP converter USR-WIFI232-B2, which supports 802.11 b/g/n. It works either in a station mode (for connection to the home AP) or in a access point mode (local connection mode in the official ap). See docs below for more technical information.
## Index
### Generic contribution guide
If you want to contribute, please check the guidelines first: [`CONTRIBUTING.md`](docs/CONTRIBUTING.md).
### (Obsolete) Reverse-engineering (development) guides
~~If you want to help with decoding the proprietary Sermatec protocol, choose if you want to use the physical Android device or a virtual one and continue with the appropriate guide.~~
This is no longer needed due to protocol description extracted from the official app. However, the guides may be still useful for another project, so I preserve them here.
- [`RE_AVD.md`](docs/RE_AVD.md): Android virtual device configuration.
- [`RE_PHYSICAL_DEVICE.md`](docs/RE_PHYSICAL_DEVICE.md): Physical device configuration.
- [`RE_DATA_INSPECTION.md`](docs/RE_DATA_INSPECTION.md): Data inspection guide.
### Inverter and protocol docs
This is available in [separate repository](https://github.com/sermatec-opensource/docs).
## Console interface usage
The script takes very few args to run:
1. the ip of your inverter.
2. operation to do
- `get`: retrieve data from inverter, must be followed by type of data:
- systemInformation, batteryStatus, gridPVStatus, runningStatus, workingParameters, load, bmsStatus
- `customget`: sent custom query command, must be followed by command code (single byte, decimal or hex):
- e.g. `0x98`
- use with care, may cause unexpected/dangerous behaviour
- `set`: set configuration data
- *experimental support, may be dangerous and screw things up*,
- syntax: `set `,
- see section [Configurable parameters](#configurable-parameters) for supported parameters and their allowed values,
- some parameters require to shut down the inverter before configuring,
- the script should refuse setting of invalid values, but either way, be very **VERY** careful.
The script also takes few optional args:
1. the `-v` flag to have a verbose output.
2. the `--port` arg to use a different port than default 8899 for inverter connection.
3. the `-h` or `--help` flag to display the help about the command
4. the `--raw` arg to not parse a response from the inverter (only raw data will be shown, useful for debugging, testing and development)
5. the `--protocolFilePath` arg to supply a custom path to JSON describing the protocol. Usually not needed.
### Examples
Having battery info on an inverter with 10.0.0.254 ip:
```bash
python3 -m src.sermatec_inverter 10.0.0.254 get batteryStatus
```
Having grid info using the verbose mode with a 192.168.0.254 inverter with port 8900:
```bash
python3 -m src.sermatec_inverter -v --port=8900 192.168.0.254 get gridPVStatus
```
### Configurable parameters
| Tag | Description | Supported values | Inverter has to be shut down |
|-----|-------------|------------------| ---------------------------- |
| `onOff` | Turn inverter on or off. | 1: on, 0: off | no |
| `operatingMode` | Change inverter operating mode. | "General Mode", "Energy Storage Mode", "Micro-grid", "Peak-Valley", "AC Coupling" | no |
| `antiBackflow` | Enable backflow protection. | 1: on, 0: off | yes |
| `soc` | Change lower-limit of on-grid battery SOC | 10-100 | no |
## Download
### *Newest version:* Source
```
git clone https://github.com/andreondra/sermatec-inverter.git
cd sermatec-inverter
python3 -m src.sermatec_inverter --help
```
### *Docker / Docker-compose:*
This method require to have both `docker` and `docker compose` setup on your computer (`docker compose` is now embedded officially when you install docker).
Refer to this [official documentation](https://docs.docker.com/get-docker/) to have it installed.
Once done: you can use the docker-compose to run the app in a controlled environment:
```bash
git clone https://github.com/andreondra/sermatec-inverter.git
cd sermatec-inverter
docker compose run python-bash
```
Once the container started, you'll be in a bash environment with all your need for working and running the script:
```bash
python3 -m sermatec_inverter --help
```
### *Old stable version:* PyPI package
```
pip install sermatec-inverter
python3 -m sermatec_inverter --help
```
## License
The project is licensed under the MIT License. (C) Ondrej Golasowski