Siri Updater

Support for consuming SIRI ET and SX messages. The updater is developed to support the Nordic SIRI profile which is a subset of the SIRI specification.

Contact Info

Lasse Tyrihjell, Entur, Norway

Documentation

This updater consumes SIRI real time information. It is developed by Entur and supports the Nordic Profile for SIRI. It should be possible to develop it further to support a broader set of the SIRI specification.

For more documentation goto the Entur Real-Time Data documentation and the Norwegian SIRI profile .

Configuration

To enable the SIRI updater you need to add it to the updaters section of the router-config.json.

Siri-ET via HTTPS

Config Parameter	Type	Summary	Req./Opt.	Default Value	Since
type = "siri-et-updater"	`enum`	The type of the updater.	Required		1.5
blockReadinessUntilInitialized	`boolean`	Whether catching up with the updates should block the readiness check from returning a 'ready' result.	Optional	`false`	2.0
feedId	`string`	The ID of the feed to apply the updates to.	Required		2.0
frequency	`duration`	How often the updates should be retrieved.	Optional	`"PT1M"`	2.0
fuzzyTripMatching	`boolean`	If the fuzzy trip matcher should be used to match trips.	Optional	`false`	2.0
previewInterval	`duration`	TODO	Optional		2.0
requestorRef	`string`	The requester reference.	Optional		2.0
timeout	`duration`	The HTTP timeout to download the updates.	Optional	`"PT15S"`	2.0
url	`string`	The URL to send the HTTP requests to.	Required		2.0
headers	`map of string`	HTTP headers to add to the request. Any header key, value can be inserted.	Optional		2.3

Parameter details

Since version: 2.3 ∙ Type: map of string ∙ Cardinality: Optional
Path: /updaters/[8]

HTTP headers to add to the request. Any header key, value can be inserted.

Example configuration

// router-config.json
{
  "updaters" : [
    {
      "type" : "siri-et-updater",
      "url" : "https://example.com/some/path",
      "feedId" : "feed_id",
      "timeout" : "30s",
      "headers" : {
        "Authorization" : "Some-Token"
      }
    }
  ]
}

Siri-SX via HTTPS

Config Parameter	Type	Summary	Req./Opt.	Default Value	Since
type = "siri-sx-updater"	`enum`	The type of the updater.	Required		1.5
blockReadinessUntilInitialized	`boolean`	Whether catching up with the updates should block the readiness check from returning a 'ready' result.	Optional	`false`	2.0
earlyStart	`duration`	This value is subtracted from the actual validity defined in the message.	Optional	`"PT0S"`	2.0
feedId	`string`	The ID of the feed to apply the updates to.	Required		2.0
frequency	`duration`	How often the updates should be retrieved.	Optional	`"PT1M"`	2.0
requestorRef	`string`	The requester reference.	Optional		2.0
timeout	`duration`	The HTTP timeout to download the updates.	Optional	`"PT15S"`	2.0
url	`string`	The URL to send the HTTP requests to.	Required		2.0
headers	`map of string`	HTTP headers to add to the request. Any header key, value can be inserted.	Optional		2.3

Parameter details

earlyStart

Since version: 2.0 ∙ Type: duration ∙ Cardinality: Optional ∙ Default value: "PT0S"
Path: /updaters/[9]

This value is subtracted from the actual validity defined in the message.

Normally the planned departure time is used, so setting this to 10s will cause the SX-message to be included in trip-results 10 seconds before the the planned departure time.

Since version: 2.3 ∙ Type: map of string ∙ Cardinality: Optional
Path: /updaters/[9]

HTTP headers to add to the request. Any header key, value can be inserted.

Example configuration

// router-config.json
{
  "updaters" : [
    {
      "type" : "siri-sx-updater",
      "url" : "https://example.com/some/path",
      "feedId" : "feed_id",
      "timeout" : "30s",
      "headers" : {
        "Key" : "Value"
      }
    }
  ]
}

Changelog

Initial version of SIRI updater (October 2019)
Include situations with no or no handled entity selectors with Unknown EntitySelector (December 2021, https://github.com/opentripplanner/OpenTripPlanner/pull/3780)