Merge pull request #237 from Polyconseil/bluesystems/battery_charged

Add new `battery_charged` event type reason
openmobilityfoundation · Feb 26, 2019 · 0c703d4 · 0c703d4
2 parents 3d3344b + d12b774
commit 0c703d4
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 1 deletion.
diff --git a/agency/README.md b/agency/README.md
@@ -196,6 +196,7 @@ List of valid vehicle events and the resulting vehicle status if the event is su
 | `event_type`                | description                                                                                          | valid initial `status`                             | `status` on success | status_description                                                      |
 | ---------------------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ------------------- | ----------------------------------------------------------------------- |
 | `service_start`        | Vehicle introduced into service at the beginning of the day (if program does not operate 24/7)       | `unavailable`, `removed`, `elsewhere`              | `available`         | Vehicle is on the street and available for customer use.                |
+| `battery_charged`      | A vehicle becomes available because its battery is charged enough                                    | `unavailable`                                      | `available`         |                                                                         |
 | `trip_end`             | Customer ends trip and reservation                                                                   | `trip`                                             | `available`         |                                                                         |
 | `rebalance_drop_off`   | Vehicle moved for rebalancing                                                                        | `removed`                                          | `available`         |                                                                         |
 | `maintenance_drop_off` | Vehicle introduced into service after being removed for maintenance                                  | `removed`                                          | `available`         |                                                                         |

diff --git a/generate_schema/provider/status_changes.json b/generate_schema/provider/status_changes.json
@@ -120,6 +120,7 @@
                       },
                       "event_type_reason": {
                         "enum": [
+                          "battery_charged",
                           "service_start",
                           "user_drop_off",
                           "rebalance_drop_off",

diff --git a/provider/README.md b/provider/README.md
@@ -292,6 +292,7 @@ When multiple query parameters are specified, they should all apply to the retur
 | `event_type` | Description | `event_type_reason` | Description |
 | ---------- | ---------------------- | ------- | ------------------ |
 | `available` | A device becomes available for customer use | `service_start` | Device introduced into service at the beginning of the day (if program does not operate 24/7) |
+| | | `battery_charged` | A device becomes available because its battery is charged enough |
 | | | `user_drop_off` | User ends reservation |
 | | | `rebalance_drop_off` | Device moved for rebalancing |
 | | | `maintenance_drop_off` | Device introduced into service after being removed for maintenance |

diff --git a/provider/status_changes.json b/provider/status_changes.json
@@ -311,6 +311,7 @@
                       },
                       "event_type_reason": {
                         "enum": [
+                          "battery_charged",
                           "service_start",
                           "user_drop_off",
                           "rebalance_drop_off",
@@ -400,4 +401,4 @@
     }
   },
   "additionalProperties": false
-}
+}