Skip to content

ogerardin/ha-cfl-commute

 
 

Repository files navigation

HACS-Custom GitHub Release License

CFL Commute

This is a Home Assistant integration for tracking Luxembourg CFL train commutes. Monitor trains, get disruption alerts, and automate your commuting routine.

Features

  • Real-time Train Tracking: Monitor upcoming trains between any two Luxembourg stations
  • Smart Update Intervals: Automatically adjusts polling frequency based on time of day (peak/off-peak/night)
  • Disruption Detection: Binary sensor that alerts on cancellations or significant delays
  • Rich Sensor Data: Comprehensive attributes including platforms, delays, calling points, and more
  • Multi-Route Support: Configure multiple commutes (e.g., morning and evening journeys)
  • UI Configuration: Easy setup through Home Assistant's config flow interface
  • HACS Compatible: Simple installation via Home Assistant Community Store

Requirements

Installation

Choose one of the following methods (easiest first).

Using HACS (easy method)

  1. Follow this link:
    Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.
  2. Confirm adding custom repository
  3. Click on "Download" button (bottom right) and confirm
  4. When it's downloaded, you will have a notification in "Settings" that tells you to restart HA. Accept the suggestion and let HA restart

Using HACS (manually adding custom repo)

  1. Open HACS
  2. Click on "⋮" (top right), then "Custom repositories"
  3. Fill in as follows:
    • Repository: https://github.com/ogerardin/ha-cfl-commute
    • Type: 'Integration'
  4. Click "ADD"; after a few seconds the new integration appears under the "New" heading
  5. Click on "⋮" on the corresponding row, then "Download" and confirm
  6. When it's downloaded, you will have a notification in "Settings" that tells you to restart HA. Accept the suggestion and let HA restart

Manual installation

  1. Copy custom_components/cfl_commute to config/custom_components/
  2. Restart HA

What next?

Support

Acknowledgments

This integration was forked from adamf83/my-rail-commute (UK National Rail), thanks to the author for inspiration.

Real time data is obtained from mobiliteit.lu HAFAS OpenData API:

License

This project is licensed under the MIT License - see the LICENSE file for details.

Disclaimer

This is an unofficial integration and is not affiliated with, endorsed by, or connected to CFL (Chemins de Fer Luxembourgeois) or mobiliteit.lu. Use at your own risk.

Train times and information are provided by the mobiliteit.lu HAFAS API. While we strive for accuracy, always verify critical journey information through official channels.

About

Home Assistant integration for Luxembourg CFL train commutes

Topics

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages

  • Python 95.7%
  • Shell 4.3%