Skip to content

Commit 5c1240a

Browse files
authored
Added battery/fuel capacity/percent
1 parent aa254e1 commit 5c1240a

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

agency/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,10 @@ A vehicle record is as follows:
8888
| `state` | Enum | Current vehicle state. See [Vehicle State][vehicle-states] |
8989
| `prev_events` | Enum[] | Last [Vehicle Event][vehicle-events] |
9090
| `updated` | [timestamp][ts] | Date of last event update |
91+
| `battery_capacity` | Integer | Required if Available | Capacity of battery expressed as milliamp hours (mAh) |
92+
| `fuel_capacity` | Integer | Required if Available | Capacity of fuel tank (liquid, solid, gaseous) expressed in liters |
93+
| `battery_percent` | Integer | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 100 |
94+
| `fuel_percent` | Integer | Required if Applicable | Percent fuel in vehicle, expressed between 0 and 100 |
9195

9296
404 Failure Response:
9397

@@ -112,6 +116,8 @@ Body Params:
112116
| `mode` | Enum | Required | [Mobility Mode][modes] |
113117
| `propulsion_types` | Enum[] | Required | Array of [Propulsion Type][propulsion-types]; allows multiple values |
114118
| `vehicle_attributes` | Conditionally Required | Array of [vehicle attributes](/modes/#vehicle-attributes) | Vehicle attributes appropriate for the current [mode][modes] |
119+
| `battery_capacity` | Integer | Required if Available | Capacity of battery expressed as milliamp hours (mAh) |
120+
| `fuel_capacity` | Integer | Required if Available | Capacity of fuel tank (liquid, solid, gaseous) expressed in liters |
115121

116122
201 Success Response:
117123

@@ -251,7 +257,8 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
251257
| `gps.accuracy` | Float | Required if Available | Horizontal accuracy, in meters |
252258
| `gps.hdop` | Float | Required if Available | Horizontal GPS or GNSS accuracy value (see [hdop][hdop]) |
253259
| `gps.satellites` | Integer | Required if Available | Number of GPS or GNSS satellites
254-
| `charge` | Float | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 1 |
260+
| `battery_percent` | Integer | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 100 |
261+
| `fuel_percent` | Integer | Required if Applicable | Percent fuel in vehicle, expressed between 0 and 100 |
255262
| `stop_id` | UUID | Required if Applicable | Stop that the vehicle is currently located at. Only applicable for _docked_ Micromobility. See [Stops][stops] |
256263

257264
[Top][toc]

0 commit comments

Comments
 (0)