home-assistant.io/source/_integrations/viaggiatreno.markdown
c0ffeeca7 a4a68172c0
u-z integrations: apply sentence-style caps to categories (#29907)
* u-z integrations: apply sentence-style caps to categories

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Add references to glossary terms

* Update source/_integrations/universal.markdown

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Update source/_integrations/universal.markdown

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* linter: change vizio to VIZIO

- as per product website https://www.vizio.com/en/smartcast

* remove term refs from YAML

* VIZIO: change spelling according to website

- https://www.vizio.com/en/t

* Update source/_integrations/vizio.markdown

* Update source/_integrations/universal.markdown

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Update source/_integrations/unifiprotect.markdown

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Apply suggestions from code review

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Apply suggestions from code review

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Fix some more to sentence-style caps

* Update source/_integrations/unifiprotect.markdown

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Update source/_integrations/unifiprotect.markdown

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Update source/_integrations/unifiprotect.markdown

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

---------

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
2023-11-19 14:43:27 +01:00

2.1 KiB

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

The Trenitalia ViaggiaTreno {% term integration %} 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/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 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