Update protobuf and dependencies

Author: jonthornton

mtaproto/feedresponse.py

@@ -7,7 +7,7 @@
 class FeedResponse(object):
 
     def __init__(self, response_string):
-        self._pb_data = nyct_subway_pb2.gtfs_realtime_pb2.FeedMessage()
+        self._pb_data = nyct_subway_pb2.gtfs__realtime__pb2.FeedMessage()
         self._pb_data.ParseFromString(response_string)
 
     def __getattr__(self, name):

mtaproto/gtfs-realtime.proto

@@ -1,17 +1,26 @@
-// Copyright 2011 Google Inc
+// Copyright 2015 The GTFS Specifications Authors.
 //
-// The content of this file is licensed under the Creative Commons Attribution
-// 3.0 License.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
 //
-// Protocol definition file for GTFS-realtime.
+//     http://www.apache.org/licenses/LICENSE-2.0
 //
-// GTFS-realtime lets transit agencies provide consumers with realtime
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Protocol definition file for GTFS Realtime.
+//
+// GTFS Realtime lets transit agencies provide consumers with realtime
 // information about disruptions to their service (stations closed, lines not
 // operating, important delays etc), location of their vehicles and expected
 // arrival times.
 //
 // This protocol is published at:
-// https://developers.google.com/transit/gtfs-realtime/
+// https://github.com/google/transit/tree/master/gtfs-realtime
 
 syntax = "proto2";
 option java_package = "com.google.transit.realtime";
@@ -22,30 +31,32 @@ package transit_realtime;
 // obtained as a response to an appropriate HTTP GET request.
 // A realtime feed is always defined with relation to an existing GTFS feed.
 // All the entity ids are resolved with respect to the GTFS feed.
-//
-// A feed depends on some external configuration:
-// - The corresponding GTFS feed.
-// - Feed application (updates, positions or alerts). A feed should contain only
-//   items of one specified application; all the other entities will be ignored.
-// - Polling frequency
+// Note that "required" and "optional" as stated in this file refer to Protocol
+// Buffer cardinality, not semantic cardinality.  See reference.md at
+// https://github.com/google/transit/tree/master/gtfs-realtime for field
+// semantic cardinality.
 message FeedMessage {
-
   // Metadata about this feed and feed message.
   required FeedHeader header = 1;
 
   // Contents of the feed.
   repeated FeedEntity entity = 2;
+
+  // 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;
 }
 
 // Metadata about a feed, included in feed messages.
 message FeedHeader {
   // Version of the feed specification.
-  // The current version is 1.0.
+  // The current version is 2.0.
   required string gtfs_realtime_version = 1;
 
   // Determines whether the current fetch is incremental.  Currently,
   // DIFFERENTIAL mode is unsupported and behavior is unspecified for feeds
-  // that use this mode.  There are discussions on the GTFS-realtime mailing
+  // that use this mode.  There are discussions on the GTFS Realtime mailing
   // list around fully specifying the behavior of DIFFERENTIAL mode and the
   // documentation will be updated when those discussions are finalized.
   enum Incrementality {
@@ -60,10 +71,9 @@ message FeedHeader {
   optional uint64 timestamp = 3;
 
   // The extensions namespace allows 3rd-party developers to extend the
-  // GTFS-realtime specification in order to add and evaluate new features and
+  // GTFS Realtime specification in order to add and evaluate new features and
   // modifications to the spec.
   extensions 1000 to 1999;
-
 }
 
 // A definition (or update) of an entity in the transit feed.
@@ -87,6 +97,11 @@ message FeedEntity {
   optional TripUpdate trip_update = 3;
   optional VehiclePosition vehicle = 4;
   optional Alert alert = 5;
+
+  // 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;
 }
 
 //
@@ -162,7 +177,7 @@ message TripUpdate {
     optional int32 uncertainty = 3;
 
     // The extensions namespace allows 3rd-party developers to extend the
-    // GTFS-realtime specification in order to add and evaluate new features
+    // GTFS Realtime Specification in order to add and evaluate new features
     // and modifications to the spec.
     extensions 1000 to 1999;
   }
@@ -207,10 +222,9 @@ message TripUpdate {
         [default = SCHEDULED];
 
     // The extensions namespace allows 3rd-party developers to extend the
-    // GTFS-realtime specification in order to add and evaluate new features
+    // GTFS Realtime Specification in order to add and evaluate new features
     // and modifications to the spec.
     extensions 1000 to 1999;
-
   }
 
   // Updates to StopTimes for the trip (both future, i.e., predictions, and in
@@ -238,11 +252,30 @@ message TripUpdate {
   // time (i.e., the number of seconds since January 1st 1970 00:00:00 UTC).
   optional uint64 timestamp = 4;
 
+  // The current schedule deviation for the trip.  Delay should only be
+  // specified when the prediction is given relative to some existing schedule
+  // in GTFS.
+  //
+  // Delay (in seconds) can be positive (meaning that the vehicle is late) or
+  // negative (meaning that the vehicle is ahead of schedule). Delay of 0
+  // means that the vehicle is exactly on time.
+  //
+  // Delay information in StopTimeUpdates take precedent of trip-level delay
+  // information, such that trip-level delay is only propagated until the next
+  // stop along the trip with a StopTimeUpdate delay value specified.
+  //
+  // Feed providers are strongly encouraged to provide a TripUpdate.timestamp
+  // value indicating when the delay value was last updated, in order to
+  // evaluate the freshness of the data.
+  //
+  // NOTE: This field is still experimental, and subject to change. It may be
+  // formally adopted in the future.
+  optional int32 delay = 5;
+
   // The extensions namespace allows 3rd-party developers to extend the
-  // GTFS-realtime specification in order to add and evaluate new features and
+  // GTFS Realtime Specification in order to add and evaluate new features and
   // modifications to the spec.
   extensions 1000 to 1999;
-
 }
 
 // Realtime positioning information for a given vehicle.
@@ -296,8 +329,45 @@ message VehiclePosition {
   }
   optional CongestionLevel congestion_level = 6;
 
+  // The degree of passenger occupancy of the vehicle. This field is still
+  // experimental, and subject to change. It may be formally adopted in the
+  // future.
+  enum OccupancyStatus {
+    // The vehicle is considered empty by most measures, and has few or no
+    // passengers onboard, but is still accepting passengers.
+    EMPTY = 0;
+
+    // The vehicle has a relatively large percentage of seats available.
+    // What percentage of free seats out of the total seats available is to be
+    // considered large enough to fall into this category is determined at the
+    // discretion of the producer.
+    MANY_SEATS_AVAILABLE = 1;
+
+    // The vehicle has a relatively small percentage of seats available.
+    // What percentage of free seats out of the total seats available is to be
+    // considered small enough to fall into this category is determined at the
+    // discretion of the feed producer.
+    FEW_SEATS_AVAILABLE = 2;
+
+    // The vehicle can currently accommodate only standing passengers.
+    STANDING_ROOM_ONLY = 3;
+
+    // The vehicle can currently accommodate only standing passengers
+    // and has limited space for them.
+    CRUSHED_STANDING_ROOM_ONLY = 4;
+
+    // The vehicle is considered full by most measures, but may still be
+    // allowing passengers to board.
+    FULL = 5;
+
+    // The vehicle is not accepting additional passengers.
+    NOT_ACCEPTING_PASSENGERS = 6;
+
+  }
+  optional OccupancyStatus occupancy_status = 9;
+
   // The extensions namespace allows 3rd-party developers to extend the
-  // GTFS-realtime specification in order to add and evaluate new features and
+  // GTFS Realtime Specification in order to add and evaluate new features and
   // modifications to the spec.
   extensions 1000 to 1999;
 }
@@ -359,10 +429,9 @@ message Alert {
   optional TranslatedString description_text = 11;
 
   // The extensions namespace allows 3rd-party developers to extend the
-  // GTFS-realtime specification in order to add and evaluate new features
+  // GTFS Realtime Specification in order to add and evaluate new features
   // and modifications to the spec.
   extensions 1000 to 1999;
-
 }
 
 //
@@ -381,6 +450,11 @@ message TimeRange {
   // 00:00:00 UTC).
   // If missing, the interval ends at plus infinity.
   optional uint64 end = 2;
+
+  // 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;
 }
 
 // A position.
@@ -404,7 +478,7 @@ message Position {
   optional float speed = 5;
 
   // The extensions namespace allows 3rd-party developers to extend the
-  // GTFS-realtime specification in order to add and evaluate new features and
+  // GTFS Realtime Specification in order to add and evaluate new features and
   // modifications to the spec.
   extensions 1000 to 1999;
 }
@@ -420,20 +494,35 @@ message Position {
 //   addition, absolute arrival/departure times must be provided.
 message TripDescriptor {
   // The trip_id from the GTFS feed that this selector refers to.
-  // For non frequency expanded trips, this field is enough to uniquely identify
-  // the trip. For frequency expanded, start_time and start_date might also be
+  // For non frequency-based trips, this field is enough to uniquely identify
+  // the trip. For frequency-based trip, start_time and start_date might also be
   // necessary.
   optional string trip_id = 1;
 
   // The route_id from the GTFS that this selector refers to.
   optional string route_id = 5;
 
-  // The scheduled start time of this trip instance.
-  // This field should be given only if the trip is frequency-expanded in the
-  // GTFS feed. The value must precisely correspond to start_time specified for
-  // the route in the GTFS feed plus some multiple of headway_secs.
-  // Format of the field is same as that of GTFS/frequencies.txt/start_time,
-  // e.g., 11:15:35 or 25:15:35.
+  // The direction_id from the GTFS feed trips.txt file, indicating the
+  // direction of travel for trips this selector refers to. This field is
+  // still experimental, and subject to change. It may be formally adopted in
+  // the future.
+  optional uint32 direction_id = 6;
+
+  // The initially scheduled start time of this trip instance.
+  // When the trip_id corresponds to a non-frequency-based trip, this field
+  // should either be omitted or be equal to the value in the GTFS feed. When
+  // the trip_id correponds to a frequency-based trip, the start_time must be
+  // specified for trip updates and vehicle positions. If the trip corresponds
+  // to exact_times=1 GTFS record, then start_time must be some multiple
+  // (including zero) of headway_secs later than frequencies.txt start_time for
+  // the corresponding time period. If the trip corresponds to exact_times=0,
+  // then its start_time may be arbitrary, and is initially expected to be the
+  // first departure of the trip. Once established, the start_time of this
+  // frequency-based trip should be considered immutable, even if the first
+  // departure time changes -- that time change may instead be reflected in a
+  // StopTimeUpdate.
+  // Format and semantics of the field is same as that of
+  // GTFS/frequencies.txt/start_time, e.g., 11:15:35 or 25:15:35.
   optional string start_time = 2;
   // The scheduled start date of this trip instance.
   // Must be provided to disambiguate trips that are so late as to collide with
@@ -466,15 +555,13 @@ message TripDescriptor {
 
     // A trip that existed in the schedule but was removed.
     CANCELED = 3;
-
   }
   optional ScheduleRelationship schedule_relationship = 4;
 
   // The extensions namespace allows 3rd-party developers to extend the
-  // GTFS-realtime specification in order to add and evaluate new features and
+  // GTFS Realtime Specification in order to add and evaluate new features and
   // modifications to the spec.
   extensions 1000 to 1999;
-
 }
 
 // Identification information for the vehicle performing the trip.
@@ -492,7 +579,7 @@ message VehicleDescriptor {
   optional string license_plate = 3;
 
   // The extensions namespace allows 3rd-party developers to extend the
-  // GTFS-realtime specification in order to add and evaluate new features and
+  // GTFS Realtime Specification in order to add and evaluate new features and
   // modifications to the spec.
   extensions 1000 to 1999;
 }
@@ -511,10 +598,9 @@ message EntitySelector {
   optional string stop_id = 5;
 
   // The extensions namespace allows 3rd-party developers to extend the
-  // GTFS-realtime specification in order to add and evaluate new features and
+  // GTFS Realtime Specification in order to add and evaluate new features and
   // modifications to the spec.
   extensions 1000 to 1999;
-
 }
 
 // An internationalized message containing per-language versions of a snippet of
@@ -535,7 +621,17 @@ message TranslatedString {
     // no i18n is done at all for the feed. At most one translation is
     // allowed to have an unspecified language tag.
     optional string language = 2;
+
+    // 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;
   }
   // At least one translation must be provided.
   repeated Translation translation = 1;
+
+  // 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;
 }