diff --git a/source/_components/sensor.viaggiatreno.markdown b/source/_components/sensor.viaggiatreno.markdown new file mode 100644 index 00000000000..d8ad4e16a00 --- /dev/null +++ b/source/_components/sensor.viaggiatreno.markdown @@ -0,0 +1,62 @@ +--- +layout: page +title: "ViaggiaTreno Italian Railroads" +description: "Instructions on how to integrate Italian Railroads data (from ViaggiaTreno API) into Home Assistant." +date: 2017-11-07 14:35 +sidebar: true +comments: false +sharing: true +footer: true +logo: train.png +ha_category: Transport +ha_iot_class: "Cloud Polling" +ha_release: 0.58 +--- + +The `viaggiatreno` sensor will give you information about configured train ids and stations using the public [ViaggiaTreno](http://viaggiatreno.it) API. + +To activate the sensor you need at least two parameters: the `train_id` and the `station_id`. + +The first is available just looking at the [ViaggiaTreno](http://viaggiatreno.it/) timetable, the latter can be obtained using the dedicated API endpoint: +`http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/autocompletaStazione/` +(e.g., `http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/autocompletaStazione/ROMA` will list all station names (with ids) that starts with *ROMA*). + +

+Note that the `station_id` is referred to the train's **departing station**. If a train number does not match with the station id, no data will be returned to the sensor. +

+ +Then add the data to your `configuration.yaml` file as shown in the example: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: viaggiatreno + train_id: 12279 + station_id: S08409 +``` + +{% configuration %} +train_id: + description: The ID of the train. + required: true + type: int +station_id: + description: The ID of the starting station. + required: true + type: int +train_name: + description: The name of the sensor. Defaults to 'Train from '. + required: false + type: string +{% endconfiguration %} + +

+In a future implementation, the station name could be used to automatically search best-matching station id, without the need to specify it. +

+ +The public timetables are coming from [ViaggiaTreno](http://viaggiatreno.it). + +

+Instructions (in Italian) for the API are available at: +https://github.com/bluviolin/TrainMonitor/wiki/API-del-sistema-Viaggiatreno +