Skip to content

GTFS-RT multi-coach occupancy - Merge Lyft proposal with TfNSW and LIRR proposals #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
barbeau wants to merge 7 commits into from
Closed

GTFS-RT multi-coach occupancy - Merge Lyft proposal with TfNSW and LIRR proposals #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d2ab9ad
multi car crowding - spec proposal
lfontolliet Jul 27, 2020
0bf5bf3
removed text
lfontolliet Jul 27, 2020
074dc7f
modified comment
lfontolliet Jul 27, 2020
3aaebe7
Merge branch 'multi-car-crowding' of https://github.com/lfontolliet/t…
barbeau Aug 5, 2020
def775c
Merge with TfNSW and LIRR proposals
barbeau Aug 5, 2020
154bbb8
Fix formatting
barbeau Aug 5, 2020
08cc128
Add CoachStatus in Element Index + add missing code text
timMillet Aug 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion gtfs-realtime/proto/gtfs-realtime.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,6 @@ message VehiclePosition {

// The vehicle is not accepting additional passengers.
NOT_ACCEPTING_PASSENGERS = 6;

}
optional OccupancyStatus occupancy_status = 9;

Expand All @@ -432,6 +431,47 @@ message VehiclePosition {
// This field is still experimental, and subject to change. It may be formally adopted in the future.
optional uint32 occupancy_percentage = 10;

// Coach-specific status, used for vehicles composed of several carriages
// This message is still experimental, and subject to change. It may be formally adopted in the future.
message CoachStatus {
// Identifies the order of this coach with respect to the other
// coaches in the vehicle's list of CoachStatus. This value is required
// and must be non-negative, and there cannot be duplicate values in the list of
// CoachStatus. The values must be set such that the lowest value
// corresponds to the first coach in the direction of travel, the
// second-lowest value corresponds to the second coach in the direction
// of travel and so forth. For example, the first coach in the direction
// of travel could have a coach_sequence of 4, the second coach could
// have a coach_sequence of 10, the third coach could have a
// coach_sequence of 105, and so forth.
optional uint32 coach_sequence = 1;

// Occupancy status for this coach, in this vehicle. If OccupancyStatus is unknown,
// this field should not be provided.
optional OccupancyStatus occupancy_status = 2;

// Occupancy percentage for this coach, in this vehicle
// Follows the same rules as "VehiclePosition.occupancy_percentage"
// If occupancy_percentage is unknown, this field should not be provided.
optional uint32 occupancy_percentage = 3;

// The extensions namespace allows 3rd-party developers to extend the
// GTFS Realtime Specification in order to add and evaluate new features and
// modifications to the spec.
extensions 1000 to 1999;

// The following extension IDs are reserved for private use by any organization.
extensions 9000 to 9999;
}

// Status of the multiple coaches/carriages of this vehicle, ordered by CoachStatus.coach_sequence
// with the first occurrence represents the first coach of the vehicle, given the current direction of travel.
// The number of occurrences of the coach_status field represents the number of coaches of the vehicle.
// If a coach has no data, it should still be included in this list with a coach_sequence but without
// the remaining fields for which data is lacking.
// This field is still experimental, and subject to change. It may be formally adopted in the future.
repeated CoachStatus coach_status = 11;

// The extensions namespace allows 3rd-party developers to extend the
// GTFS Realtime Specification in order to add and evaluate new features and
// modifications to the spec.
Expand Down
25 changes: 20 additions & 5 deletions gtfs-realtime/spec/en/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ Fields labeled as **experimental** are subject to change and not yet formally ad
* [VehicleStopStatus](#enum-vehiclestopstatus)
* [CongestionLevel](#enum-congestionlevel)
* [OccupancyStatus](#enum-occupancystatus)
* [CoachStatus](#message-coachstatus)
* [Alert](#message-alert)
* [TimeRange](#message-timerange)
* [EntitySelector](#message-entityselector)
Expand Down Expand Up @@ -228,10 +229,10 @@ Realtime positioning information for a given vehicle.
| **stop_id** | [string](https://developers.google.com/protocol-buffers/docs/proto#scalar) | Optional | One | Identifies the current stop. The value must be the same as in stops.txt in the corresponding GTFS feed. |
| **current_status** | [VehicleStopStatus](#enum-vehiclestopstatus) | Optional | One | The exact status of the vehicle with respect to the current stop. Ignored if current_stop_sequence is missing. |
| **timestamp** | [uint64](https://developers.google.com/protocol-buffers/docs/proto#scalar) | Optional | One | Moment at which the vehicle's position was measured. In POSIX time (i.e., number of seconds since January 1st 1970 00:00:00 UTC). |
| **congestion_level** | [CongestionLevel](#enum-congestionlevel) | Optional | One |
| _**occupancy_status**_ | _[OccupancyStatus](#enum-occupancystatus)_ | _Optional_ | One | The degree of passenger occupancy of the vehicle.<br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future.|
| **occupancy_percentage** | [uint32](https://developers.google.com/protocol-buffers/docs/proto#scalar) | Optional | One | A percentage value representing the degree of passenger occupancy of the vehicle. The value 100 should represent total the maximum occupancy the vehicle was designed for, including both seating and standing capacity, and current operating regulations allow. It's not impossible that the value goes over 100 if there are currently more passenger than the vehicle was designed for. The precision of occupancy_percentage should be low enough that you can't track a single person boarding and alighting for privacy reasons.<br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future. |

| **congestion_level** | [CongestionLevel](#enum-congestionlevel) | Optional | One |
| **occupancy_status** | [OccupancyStatus](#enum-occupancystatus) | Optional | One | The degree of passenger occupancy of the vehicle. If `coach_status` is populated with per-coach `occupancy_status`, then this field should describe the entire vehicle with all coaches considered. <br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future.|
| **occupancy_percentage** | [uint32](https://developers.google.com/protocol-buffers/docs/proto#scalar) | Optional | One | A percentage value representing the degree of passenger occupancy of the vehicle. The value 100 should represent total the maximum occupancy the vehicle was designed for, including both seating and standing capacity, and current operating regulations allow. It's not impossible that the value goes over 100 if there are currently more passenger than the vehicle was designed for. The precision of occupancy_percentage should be low enough that you can't track a single person boarding and alighting for privacy reasons. If `coach_status` is populated with per-coach `occupancy_percentage`, then this field should describe the entire vehicle with all coaches considered. <br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future. |
| **coach_status** | [CoachStatus](#enum-coachstatus) | Optional | Many | Status of the multiple coaches/carriages of this vehicle, ordered by `CoachStatus.coach_sequence` with the first occurrence represents the first coach of the vehicle, given the current direction of travel. The number of occurrences of the `coach_status` field represents the number of coaches of the vehicle. If a coach has no data, it should still be included in this list with a `coach_sequence` but without the remaining fields for which data is lacking. <br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future.|

## _enum_ VehicleStopStatus

Expand All @@ -257,7 +258,7 @@ Congestion level that is affecting this vehicle.
| **CONGESTION** |
| **SEVERE_CONGESTION** |

## _enum OccupancyStatus_
## _enum_ OccupancyStatus

The degree of passenger occupancy for the vehicle.

Expand All @@ -275,6 +276,20 @@ The degree of passenger occupancy for the vehicle.
| _**FULL**_ | _The vehicle is considered full by most measures, but may still be allowing passengers to board._ |
| _**NOT_ACCEPTING_PASSENGERS**_ | _The vehicle can not accept passengers._ |

## _message_ CoachStatus

Coach-specific status, used for vehicles composed of several carriages

**Caution:** this message is still **experimental**, and subject to change. It may be formally adopted in the future.<br>.

#### Fields

| _**Field Name**_ | _**Type**_ | _**Required**_ | _**Cardinality**_ | _**Description**_ |
|------------------|------------|----------------|-------------------|-------------------|
| **coach_sequence** | [uint32](https://developers.google.com/protocol-buffers/docs/proto#scalar) | Required | One | Identifies the order of this coach with respect to the other coaches in the vehicle's list of `CoachStatus`. This value is required and must be non-negative, and there cannot be duplicate values in the list of `CoachStatus`. The values must be set such that the lowest value corresponds to the first coach in the direction of travel, the second-lowest value corresponds to the second coach in the direction of travel and so forth. For example, the first coach in the direction of travel could have a `coach_sequence` of 4, the second coach could have a `coach_sequence` of 10, the third coach could have a `coach_sequence` of 105, and so forth. <br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future. |
| **occupancy_status** | [OccupancyStatus](#enum-occupancystatus) | Optional | One | Occupancy status for this coach, in this vehicle. If `OccupancyStatus` is unknown, this field should not be provided. <br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future. |
| **occupancy_percentage** | [uint32](https://developers.google.com/protocol-buffers/docs/proto#scalar) | Optional | One | Occupancy percentage for this coach, in this vehicle. Follows the same rules as `VehiclePosition.occupancy_percentage`. If `occupancy_percentage` is unknown, this field should not be provided. <br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future. |

## _message_ Alert

An alert, indicating some sort of incident in the public transit network.
Expand Down