jeff/starlink-grpc-tools
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Note detail of where data is recorded per backend

Browse source 
It came up in the course of discussion in issue #20 that I hadn't actually documented this anywhere.
This commit is contained in:
sparky8512 2021-02-27 16:39:28 -08:00
parent be776cde1c
commit 203efaf84d
3 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
dish_grpc_influx.py
View file

@ -5,6 +5,14 @@ This script pulls the current status info and/or metrics computed from the
history data and writes them to the specified InfluxDB database either once history data and writes them to the specified InfluxDB database either once
or in a periodic loop. or in a periodic loop.
Data will be written into the requested database with the following
measurement / series names:
: spacex.starlink.user_terminal.status : Current status data
: spacex.starlink.user_terminal.history : Bulk history data
: spacex.starlink.user_terminal.ping_stats : Ping history statistics
: spacex.starlink.user_terminal.usage : Usage history statistics
NOTE: The Starlink user terminal does not include time values with its NOTE: The Starlink user terminal does not include time values with its
history or status data, so this script uses current system time to compute history or status data, so this script uses current system time to compute
the timestamps it sends to InfluxDB. It is recommended to run this script on the timestamps it sends to InfluxDB. It is recommended to run this script on

8
dish_grpc_mqtt.py
View file

@ -4,6 +4,14 @@
This script pulls the current status info and/or metrics computed from the This script pulls the current status info and/or metrics computed from the
history data and publishes them to the specified MQTT broker either once or history data and publishes them to the specified MQTT broker either once or
in a periodic loop. in a periodic loop.
Data will be published to the following topic names:
: starlink/dish_status/*id_value*/*field_name* : Current status data
: starlink/dish_ping_stats/*id_value*/*field_name* : Ping history statistics
: starlink/dish_usage/*id_value*/*field_name* : Usage history statistics
Where *id_value* is the *id* value from the dish status information.
""" """
import logging import logging

7
dish_grpc_sqlite.py
View file

@ -5,6 +5,13 @@ This script pulls the current status info and/or metrics computed from the
history data and writes them to the specified sqlite database either once or history data and writes them to the specified sqlite database either once or
in a periodic loop. in a periodic loop.
Requested data will be written into the following tables:
: status : Current status data
: history : Bulk history data
: ping_stats : Ping history statistics
: usage : Usage history statistics
Array data is currently written to the database as text strings of comma- Array data is currently written to the database as text strings of comma-
separated values, which may not be the best method for some use cases. If you separated values, which may not be the best method for some use cases. If you
find yourself wishing they were handled better, please open a feature request find yourself wishing they were handled better, please open a feature request