Skip to content

Home Assistant custom integration of STIB/MIVB opendata services

License

Notifications You must be signed in to change notification settings

helldog136/ha-stib-mivb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

stib-mvib-sensor

This code can be used to add a custom sensor for STIB/MVIB public transport of Brussels (Belgium) to Home Assistant.

This Project is an adaptation of github.com/bollewolle/delijn-sensor, kudos to him/her for the work done.

Note: the idea is to eventually add this to the code of Home Assistant itself

Options

Name Type Requirement Description
platform string Required stib-mvib
client_id string Required The client_id generated in a developer account at opendata.stib-mivb.be.
client_secret string Required The client_secret generated in a developer account at opendata.stib-mivb.be.
lang string Optional (default:'fr') The display language of destinations and service messages ('fr' OR 'nl')
stops object Required List of stops to display next passages of.

stops object

Name Type Requirement Description
stop_name string Required Name of the Stop to retrieve the next passages of. Ie. De Brouckere
filtered_out_stop_ids list Optional List of specific stop_ids that must NOT be contained inside of the passages. These can be found by searching a stop here (https://opendata.bruxelles.be/explore/dataset/stib-stops/table/).
max_passages number Optional Set a maximum number of passages to return in the sensor (maximum is 20 by default).

Installation

Step 1

Install stib-mvib-sensor by copying stib-mvib.py from this repo to <config directory>/custom_components/sensor/stib-mvib.py of your Home Assistant instance.

Example:

wget https://github.com/helldog136/stib-mvib-sensor/raw/master/stib-mvib.py
mv stib-mvib.py ~/.homeassistant//custom_components/sensor/

Step 2

Set up the STIB/MVIB custom sensor.

Example:

sensor:
  - platform: stib-mvib
    client_id: '<put your opendata.stib-mivb.be client_id here>'
    client_secret: '<put your opendata.stib-mivb.be client_secret here>'
    lang: 'fr'
    stops:
    - stop_name: 'Scherdemael'
      line_filter:
      - line_nr: 46
        destination: 'GLIBERT'
      max_passages: 5
    - stop_name: 'De Brouckere'
      line_filter:
      - line_nr: 5
        destination: 'ERASME'
      - line_nr: 81
        destination: 'MARIUS RENARD'
      max_passages: 3

Note: replace with the client_id/secret you generated with you opendata.stib-mivb.be developer account.

Credits

This Project is an adaptation of github.com/bollewolle/delijn-sensor, kudos to him/her for the work done. Thanks to the codes of RMV and Ruter Public Transport for all the initial work and inspiration.

About

Home Assistant custom integration of STIB/MIVB opendata services

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages