Skip to content

GitLab

Merged
Created by Dan Jones@danjonOwner

Resolve "SPINE Support"

3 unresolved threads
Compare
and
3 files
+ 17
- 21
Show latest version
for‎mats‎
aler‎t.py‎ +5 -5
platform_‎status.py‎ +3 -5
tests/f‎ixtures‎
schem‎as.py‎ +9 -11
formats/alert.py
+ 5
- 5
Show all unchanged lines Show 20 lines
"example": "alert",
"enum": ["alert"],
},
"code": { # changed from alert_ID because reasons
"code": { # changed from alert_ID because reasons
"type": "integer",
"description": "Alert code",
"example": 345,
Show 20 lines Show all unchanged lines Show 20 lines
"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": { # changed from suggested "source" could be device / subsystem or something
"type": "string",
"description": "System that generated the alert",
"example": "Onboard Fault Monitor",
"example": "Onboard Fault Monitor",
},
"summary": {
"type": "string",
Show 20 lines Show all unchanged lines Show 20 lines
"details": {
"type": "string",
"description": "Detailed reason for the alert ",
"example": "Discrepancy between rudder and actuator positions" +
" : Rudder Pos=10.31°, Steering Actuator Pos=28.65°, Discrepancy=18.33°",
"example": "Discrepancy between rudder and actuator positions"
+ " : Rudder Pos=10.31°, Steering Actuator Pos=28.65°, Discrepancy=18.33°",
},
"severity": {
"type": "string",
Show 20 lines Show all unchanged lines
formats/platform_status.py
+ 3
- 5
Show all unchanged lines Show 20 lines
"description": "Battery remaining % provided by respective C2",
"example": 80.2,
},
# Battery power (kw / float)
"battery_output": { # changed from battery_power
"battery_output": { # changed from battery_power
"type": "number",
"format": "float",
"description": "Battery output in kW",
Show 20 lines Show all unchanged lines Show 20 lines
},
# Bunkers remaining capacity (litres, float)
# Bunkers percentage full (percentage, float)
# battery_remaining_capacity is % full if we want both these fields
# battery_remaining_capacity is % full if we want both these fields
# these names are going to cause confusion
"fuel_remaining_capacity": {
"type": "number",
Show 20 lines Show all unchanged lines Show 20 lines
"endurance": {
"type": "number",
"format": "float",
"description": "Estimate of hours of operation remaining "
"description": "Estimate of hours of operation remaining "
+ "based on present output or performance",
"example": 7.4,
},
"sensor_config": sensor_schema,
},
"required": [
Show 20 lines Show all unchanged lines
tests/fixtures/schemas.py
+ 9
- 11
Show all unchanged lines Show 20 lines
"description": "Battery remaining % provided by respective C2",
"example": 80.2,
},
# Battery power (kw / float)
"battery_output": { # changed from battery_power
"battery_output": { # changed from battery_power
"type": "number",
"format": "float",
"description": "Battery output in kW",
Show 20 lines Show all unchanged lines Show 20 lines
},
# Bunkers remaining capacity (litres, float)
# Bunkers percentage full (percentage, float)
# battery_remaining_capacity is % full if we want both these fields
# battery_remaining_capacity is % full if we want both these fields
# these names are going to cause confusion
"fuel_remaining_capacity": {
"type": "number",
Show 20 lines Show all unchanged lines Show 20 lines
"endurance": {
"type": "number",
"format": "float",
"description": "Estimate of hours of operation remaining "
"description": "Estimate of hours of operation remaining "
+ "based on present output or performance",
"example": 7.4,
},
"sensor_config": sensor_schema,
},
"required": [
Show 20 lines Show all unchanged lines Show 20 lines
"example": "alert",
"enum": ["alert"],
},
"code": { # changed from alert_ID because reasons
"code": { # changed from alert_ID because reasons
"type": "integer",
"description": "Alert code",
"example": 345,
Show 20 lines Show all unchanged lines Show 20 lines
"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": { # changed from suggested "source" could be device / subsystem or something
"type": "string",
"description": "System that generated the alert",
"example": "Onboard Fault Monitor",
"example": "Onboard Fault Monitor",
},
"summary": {
"type": "string",
Show 20 lines Show all unchanged lines Show 20 lines
"details": {
"type": "string",
"description": "Detailed reason for the alert ",
"example": "Discrepancy between rudder and actuator positions" +
" : Rudder Pos=10.31°, Steering Actuator Pos=28.65°, Discrepancy=18.33°",
"example": "Discrepancy between rudder and actuator positions"
+ " : Rudder Pos=10.31°, Steering Actuator Pos=28.65°, Discrepancy=18.33°",
},
"severity": {
"type": "string",
Show 20 lines Show all unchanged lines Show 20 lines
"code",
"severity",
],
}
\ No newline at end of file
}