Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vincejv/gpon-parser
Parses and exports GPON Stats from ONT through Rest API (JSON format)
https://github.com/vincejv/gpon-parser
exporter fiber fiberhome golang gpon json ont rest telegraf telegraf-exporter zte
Last synced: 3 months ago
JSON representation
Parses and exports GPON Stats from ONT through Rest API (JSON format)
- Host: GitHub
- URL: https://github.com/vincejv/gpon-parser
- Owner: vincejv
- License: apache-2.0
- Created: 2023-08-22T06:01:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-04T12:46:53.000Z (6 months ago)
- Last Synced: 2024-10-03T09:39:03.772Z (4 months ago)
- Topics: exporter, fiber, fiberhome, golang, gpon, json, ont, rest, telegraf, telegraf-exporter, zte
- Language: Go
- Homepage:
- Size: 76.2 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GPON Parser (GPON Stats exporter)
Supports the following ONT models
* FiberHome HG6245D (Globe Telecom Philippines firmware)
* `ONT_MODEL: hg6245d_globe`
* FiberHome AN5506_04F1A (Globe Telecom Philippines firmware) and other generic FH ONT with generic firmware
* `ONT_MODEL: an5506_stock`
* ZTE F670
* `ONT_MODEL: zte_f670`
* ZTE F660
* `ONT_MODEL: zte_f670`
## Environment variables
* `ONT_WEB_HOST`
* IP address of ONT
* Default: depends on modem
* `ONT_WEB_PORT`
* Port on which ONT Web UI is listening to
* Default: depends on modem
* `ONT_WEB_PROTOCOL`
* Web protocol which the ONT web gui uses, typically set as `http` or `https`
* Default: `http`
* `ONT_WEB_USER`
* ONT Web UI username
* Default: depends on modem
* `ONT_WEB_PASS`
* ONT Web UI password
* Default: depends on modem
* `ONT_TELNET_PORT`
* ONT Web UI password
* Default: `23`
* `LISTEN_PORT`
* Port on which the exporter listens to
* Default: `8092`
* `LISTEN_IP`
* Ip address on which the exporter listens to
* Default: `0.0.0.0`
## Running
Docker Pull
```sh
docker pull vincejv/gpon-parser:latest
```
Docker Run
```sh
docker run -d \
--name gpon-parser \
--restart unless-stopped \
vincejv/gpon-parser:latest
```
Docker Compose
```yaml
version: '3'
services:
gpon-parser:
image: vincejv/gpon-parser:latest
container_name: gpon-parser
restart: unless-stopped
environment:
ONT_MODEL: "zte_f670"
```
## REST API Paths
`/gpon/allInfo`
```json
{
"deviceStats": {
"memoryUsage": 54.885117384596136,
"cpuUsage": 1.31,
"cpuDtlUsage": [
0.1,
2.52
],
"deviceModel": "F660",
"modelSerial": "FHTTXXXXXX",
"softwareVersion": "V1.1.20P3N6B",
"uptime": 86673
},
"opticalStats": {
"rxPower": -26.5757,
"txPower": 2.7781,
"temperature": 44,
"supplyVoltage": 3.229,
"biasCurrent": 13.5
}
}
```
`/gpon/deviceInfo`
```json
{
"memoryUsage": 54.880947416704885,
"cpuUsage": 2.4749999999999996,
"cpuDtlUsage": [
0.1,
4.85
],
"deviceModel": "F660",
"modelSerial": "FHTTXXXXXX",
"softwareVersion": "V1.1.20P3N6B",
"uptime": 86748
}
```
`/gpon/opticalInfo`
```json
{
"rxPower": -26.5757,
"txPower": 2.7781,
"temperature": 44,
"supplyVoltage": 3.229,
"biasCurrent": 13.55
}
```
## Footnotes
### Building the package
```sh
go build -ldflags "-s -w"
```
### Running
```sh
go run .
```
### ARM Build on Windows
```powershell
$env:GOARCH='arm'
$env:GOOS='linux'
```
### ARM Build on Linux
```sh
export GOARCH='arm'
export GOOS='linux'
```