MBTALive Sensor for Home Assistant

Overview

This Home Assistant integration allows to track live MBTA (Massachusetts Bay Transportation Authority) transits.

Features

• Real-time MBTA transit schedules and predictions.
• Configurable departure, and arrival stops.
• Frequent updates (default scan interval: 30 seconds).

Installation

1. HACS Installation (if not already installed):

   If you don't have HACS (Home Assistant Community Store) installed, follow the instructions on the HACS website to install it.

2. Add this repository to HACS:

   • Open Home Assistant and go to the HACS section.
   • Click the three dots in the top right corner and select "Custom repositories".
   • Add the following URL as a repository: https://github.com/chiabre/MBTAlive.
   • Select the category "Integration".
   • Click "Add".

3. Install the MBTAlive integration:

   • After adding the repository, you should see the MBTAlive integration in the HACS store.
   • Click on the MBTAlive integration.
   • Click "Install".
   • Choose the version you want to install (only 2.X support hacs).
   • Click "Install" again.

4. Configure the integration:

   • After installation, restart Home Assistant.
   • Go to "Settings" -> "Devices & Services".
   • Click "+ Add Integration".
   • Search for "MBTAlive" and select it.
   • Follow the on-screen instructions to configure the integration using the following information
     • Stations names -> to obtain valid names (eg. 'South Station', 'Park Street, etc..) refernce the MBTA website
     • MBTA API key -> to generate a personal API Key:
       • Visit the MBTA API Documentation Page.
       • Sign up for a free account if you haven't already.
       • Once logged in, generate a new API key.

Updating

When a new version of the MBTAlive integration is released, you will be notified in HACS. To update:

1. Go to the HACS section in Home Assistant.
2. Find the MBTAlive integration.
3. Click the update button.
4. Restart Home Assistant after the update is complete.

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions, bug reports, or improvements.

Support

If you have any questions or need help with the MBTAlive integration, please open an issue on this GitHub repository.