diff --git a/dish_grpc_influx.py b/dish_grpc_influx.py index de46d50..f810e43 100644 --- a/dish_grpc_influx.py +++ b/dish_grpc_influx.py @@ -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 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 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 diff --git a/dish_grpc_mqtt.py b/dish_grpc_mqtt.py index 24563d7..020b23d 100644 --- a/dish_grpc_mqtt.py +++ b/dish_grpc_mqtt.py @@ -4,6 +4,14 @@ 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 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 diff --git a/dish_grpc_sqlite.py b/dish_grpc_sqlite.py index 0731215..6008a07 100644 --- a/dish_grpc_sqlite.py +++ b/dish_grpc_sqlite.py @@ -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 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- 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