home-assistant.io/source/_components/viaggiatreno.markdown
2019-04-03 10:16:08 -07:00

2.2 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_iot_class, ha_release, redirect_from
layout title description date sidebar comments sharing footer logo ha_category ha_iot_class ha_release redirect_from
page ViaggiaTreno Italian Railroads Instructions on how to integrate Italian Railroads data (from ViaggiaTreno API) into Home Assistant. 2017-11-07 14:35 true false true true train.png Transport Cloud Polling 0.58
/components/sensor.viaggiatreno/

The viaggiatreno sensor will give you information about configured train ids and stations using the public ViaggiaTreno 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 timetable, the latter can be obtained using the dedicated API endpoint: http://www.viaggiatreno.it/viaggiatrenonew/resteasy/viaggiatreno/autocompletaStazione/<Station name> (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:

# 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: integer station_id: description: The ID of the starting station. required: true type: integer 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.

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