From 7785a061d792054e131ea1c079663ea4093d5b2f Mon Sep 17 00:00:00 2001
From: Dan Jones <danjon@noc.ac.uk>
Date: Fri, 2 Feb 2024 10:25:42 +0000
Subject: [PATCH] fix: remove placeholder comments
---
formats/alert.py | 4 ++--
formats/platform_status.py | 8 +-------
2 files changed, 3 insertions(+), 9 deletions(-)
diff --git a/formats/alert.py b/formats/alert.py
index 33fdfa8..bfdc287 100644
--- a/formats/alert.py
+++ b/formats/alert.py
@@ -10,7 +10,7 @@ alert_schema = {
"example": "alert",
"enum": ["alert"],
},
- "code": { # changed from alert_ID because reasons
+ "code": {
"type": "integer",
"description": "Alert code",
"example": 345,
@@ -26,7 +26,7 @@ alert_schema = {
"description": "Timestamp for onboard platform status message",
"example": "2022-12-21T00:00:00Z",
},
- "subsystem": { # changed from suggested "source" could be device / subsystem or something
+ "subsystem": {
"type": "string",
"description": "System that generated the alert",
"example": "Onboard Fault Monitor",
diff --git a/formats/platform_status.py b/formats/platform_status.py
index c0c5691..81b452f 100644
--- a/formats/platform_status.py
+++ b/formats/platform_status.py
@@ -170,17 +170,12 @@ platform_status_schema = {
"description": "Battery remaining % provided by respective C2",
"example": 80.2,
},
- # Battery power (kw / float)
- "battery_output": { # changed from battery_power
+ "battery_output": {
"type": "number",
"format": "float",
"description": "Battery output in kW",
"example": 80.2,
},
- # Bunkers remaining capacity (litres, float)
- # Bunkers percentage full (percentage, float)
- # battery_remaining_capacity is % full if we want both these fields
- # these names are going to cause confusion
"fuel_remaining_capacity": {
"type": "number",
"format": "float",
@@ -193,7 +188,6 @@ platform_status_schema = {
"description": "Litres of liquid fuel",
"example": 12.5,
},
- # Endurance (hours, float)
"endurance": {
"type": "number",
"format": "float",
--
GitLab