nathan/invertergui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README auto formatting

Browse Source
This commit is contained in:
Nicholas Thompson
2019-03-09 15:57:34 +02:00
committed by ncthompson
parent 9c8d7d6260
commit d30e0ecedd
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -31,6 +31,7 @@ This project makes use of [Go Modules](https://github.com/golang/go/wiki/Modules
## Port 8080 ## Port 8080
The default HTTP server port is hosted on port 8080. This exposes the HTTP server that hosts the: The default HTTP server port is hosted on port 8080. This exposes the HTTP server that hosts the:
- Web GUI - Web GUI
- Munin Plugin - Munin Plugin
- Prometheus Monitor - Prometheus Monitor
@@ -40,6 +41,7 @@ The default HTTP server port is hosted on port 8080. This exposes the HTTP serve
The GUI location is at the root (http://localhost:8080/) of the HTTP server. The GUI location is at the root (http://localhost:8080/) of the HTTP server.
Example output: Example output:
``` ```
Date: Mon, 17 Dec 2018 18:14:51 +0000 Date: Mon, 17 Dec 2018 18:14:51 +0000
LEDs: LEDs:
@@ -66,6 +68,7 @@ Battery Charge: 100.000 %
The Munin plugin location is at /munin (http://localhost:8080/munin). The Munin plugin location is at /munin (http://localhost:8080/munin).
Example output: Example output:
``` ```
multigraph in_batvolt multigraph in_batvolt
volt.value 13.154 volt.value 13.154
@@ -94,10 +97,11 @@ freqout.value 50.026
The Prometheus endpoint is at the default /metrics path (http://localhost:8080/metrics). The Prometheus endpoint is at the default /metrics path (http://localhost:8080/metrics).
Sample Prometheus yaml entry: Sample Prometheus yaml entry:
```yml ```yml
- job_name: 'victron' - job_name: "victron"
static_configs: static_configs:
- targets: ['localhost:8080'] - targets: ["localhost:8080"]
``` ```
The metrics that are tracked: The metrics that are tracked:
@@ -254,6 +258,7 @@ process_virtual_memory_bytes 1.15101696e+08
The intertergui application makes use of a serial tty device to monitor the Multiplus. The intertergui application makes use of a serial tty device to monitor the Multiplus.
Example Example
``` ```
-dev=/dev/ttyUSB0 -dev=/dev/ttyUSB0
``` ```