home-assistant.io/source/_integrations/viaggiatreno.markdown
2024-11-27 18:57:16 +01:00

2.3 KiB

title, description, ha_category, ha_iot_class, ha_release, ha_domain, ha_platforms, ha_integration_type, related, ha_quality_scale
title description ha_category ha_iot_class ha_release ha_domain ha_platforms ha_integration_type related ha_quality_scale
Trenitalia ViaggiaTreno Instructions on how to integrate Italian Railroads data (from ViaggiaTreno API) into Home Assistant.
Transport
Cloud Polling 0.58 viaggiatreno
sensor
integration
docs title
/docs/configuration/ Configuration file
legacy

The Trenitalia ViaggiaTreno {% term integration %} will give you information about configured train ids and stations using the public ViaggiaTreno API.

To activate the {% term integration %}, 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/infomobilita/resteasy/viaggiatreno/autocompletaStazione/<Station name> (e.g., http://www.viaggiatreno.it/infomobilita/resteasy/viaggiatreno/autocompletaStazione/ROMA will list all station names (with ids) that starts with ROMA).

{% note %} 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. {% endnote %}

Then add the data to your {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

# 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 %}

{% note %} In a future implementation, the station name could be used to automatically search best-matching station id, without the need to specify it. {% endnote %}

The public timetables are coming from ViaggiaTreno.

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