Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loafoe/prometheus-solaxrt-exporter
Prometheus exporter for real-time Solax inverter data
https://github.com/loafoe/prometheus-solaxrt-exporter
prometheus-exporter solax solax-inverter solax-power solaxpower
Last synced: about 1 month ago
JSON representation
Prometheus exporter for real-time Solax inverter data
- Host: GitHub
- URL: https://github.com/loafoe/prometheus-solaxrt-exporter
- Owner: loafoe
- License: mit
- Created: 2022-09-21T15:25:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T07:05:49.000Z (about 2 months ago)
- Last Synced: 2024-11-12T07:34:24.937Z (about 2 months ago)
- Topics: prometheus-exporter, solax, solax-inverter, solax-power, solaxpower
- Language: Go
- Homepage:
- Size: 162 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# prometheus-solaxrt-exporter
Prometheus exporter for real-time Solax Inverter data readouts
## Usage
This exporter is only tested with an X1-Boost-Mini Inverter with a Pocket Wifi dongle. The host should have a direct Wifi connection to the Pocket Wifi network. In practice, this means you'll probably want a dedicated compute module (Raspberry Pi) connected to this network. The default `http://5.8.8.8` hardcoded IP address is unfortunately publicly routable (pointing to a host in Russia of all places!).
> The exporter contains code which ensures direct connectivity to the Pocket Wifi before attempting to query the real-time API endpoint.
## Install
Using Go 1.19 or newer
```shell
go install github.com/loafoe/prometheus-solaxrt-exporter@latest
```
## Usage
### Run exporter
```shell
prometheus-solaxcloud-exporter -listen 0.0.0.0:8886
```
### Ship to prometheus
You can use something like Grafana-agent to ship data to a remote write endpoint. Example:
```yml
metrics:
configs:
- name: default
scrape_configs:
- job_name: 'solaxcloud_exporter'
scrape_interval: 2s
static_configs:
- targets: ['localhost:8886']
remote_write:
- url: https://prometheus.example.com/api/v1/write
basic_auth:
username: scraper
password: S0m3pAssW0rdH3Re
```
## Acknowledgement
API field mappings discovered from project https://github.com/squishykid/solax -- kudos!
## License
License is MIT