Skip to content

Commit 2b2d688

Browse files
authored
Merge branch 'dev' into patch-2
2 parents d4c6c69 + d7efe78 commit 2b2d688

12 files changed

Lines changed: 658 additions & 11 deletions

agency/README.md

Lines changed: 9 additions & 2 deletions
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]
@@ -372,7 +379,7 @@ The Trips endpoint serves two purposes:
372379
| Field | Type | Required/Optional | Field Description |
373380
|-------------------------------|--------------------------------|------------------------| ----------------- |
374381
| trip_id | UUID | Required | UUID for the trip this payload pertains to |
375-
| journey_id | UUID | Optional | A unique ID for associating collections of trips |
382+
| trip_type | Enum | Optional | The type of the trip |
376383
| trip_attributes | `{ [String]: String}` | Optional | Trip attributes, given as mode-specific key-value pairs |
377384
| provider_id | UUID | Required | Provider which managed this trip |
378385
| reservation_method | Enum | Required | Way the customer created their reservation, see [reservation-method](#reservation-method) |

general-information.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,7 @@ The list of allowed `vehicle_type` values in MDS. Aligning with [GBFS vehicle ty
342342
| car | A passenger car or similar light-duty vehicle |
343343
| scooter | A standing or seated fully-motorized mobility device intended for one rider, capable of travel at low or moderate speeds, and suited for operation in infrastructure shared with motorized bicycles |
344344
| moped | A seated fully-motorized mobility device capable of travel at moderate or high speeds and suited for operation in general urban traffic |
345+
| delivery_robot | A robot intended for transporting goods |
345346
| other | A device that does not fit in the other categories |
346347

347348
[Top][toc]

geography/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Type of geography. These specific types are recommendations based on ones common
128128
| `municipal_boundary` | Edge of a city |
129129
| `policy_zone` | Zone where [Policy](/policy) rules could be in effect, like operating area, distribution/equity zones, no/slow ride zone, no parking, etc |
130130
| `county_boundary` | Edge of a county |
131-
| `stop` | See [Stops](/general-information.ms#stops) |
131+
| `stop` | See [Stops](/general-information.md#stops) |
132132
| `council_district` | City council district |
133133
| `political_district` | Politically defined voting area |
134134
| `neighborhood` | Neighborhood area |

modes/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,14 @@ The `trip_type` field allows the purpose of each trip segment to be described. S
5858

5959
The `trip_attributes` array allows additional mode-specific information about the nature of a trip to be described. It can return a list of JSON-formatted key/value pairs which correspond to the allowed attributes and values for the operative mode. See each [mode definition](#list-of-supported-modes) for details.
6060

61+
_See more available trip attributes for any mode in the [trips endpoint](/provider#trips)._
62+
6163
### Vehicle Attributes
6264

6365
The `vehicle_attributes` array returns a list of JSON-formatted key/value pairs which correspond to the allowed attributes and values for the operative mode. For each mode, the allowed attributes and corresponding values are defined in the [mode definition](#list-of-supported-modes).
6466

67+
_See more available vehicle attributes for any mode in the [vehicles endpoint](/provider#vehicles)._
68+
6569
### Accessibility Options
6670

6771
The `accessibility_options` array returns a list of JSON-formatted key/value pairs which correspond to the allowed accessibility attributes and values for the operative mode. For each mode, the allowed attributes and corresponding values are defined in the [mode definition](#list-of-supported-modes).

0 commit comments

Comments
 (0)