From 9dd56230bbd9dcd449c782bbb32ad5f6cc5f4554 Mon Sep 17 00:00:00 2001 From: Mikalai Kukhta Date: Wed, 18 Dec 2024 14:39:26 +0100 Subject: [PATCH] update README - mark as maintained - update minimal HASS version - expand maintainers section - [for beta] temporary add reference to departure v4 card --- README.md | 34 +++++++++++++++++++++++++--------- hacs.json | 2 +- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 28b3a5b..d9ae841 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ -![maintained](https://img.shields.io/maintenance/yes/2022.svg) +![maintained](https://img.shields.io/maintenance/yes/2024.svg) [![hacs_badge](https://img.shields.io/badge/hacs-default-green.svg)](https://github.com/custom-components/hacs) -[![ha_version](https://img.shields.io/badge/home%20assistant-2021.12%2B-green.svg)](https://www.home-assistant.io) -![version](https://img.shields.io/badge/version-3.1.3-green.svg) -[![maintainer](https://img.shields.io/badge/maintainer-dsorlov-blue.svg)](https://github.com/DSorlov) +[![ha_version](https://img.shields.io/badge/home%20assistant-2024.4%2B-green.svg)](https://www.home-assistant.io) +![version](https://img.shields.io/badge/version-3.2.0b0-yellow.svg) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) Swedish Public Transport Sensor (HASL) @@ -10,25 +9,42 @@ Swedish Public Transport Sensor (HASL) ## Project formerly known as "Home Assistant SL integration" -This is an Home Assistant integration providing sensors for [Stockholms Lokaltrafik (SL)](https://sl.se/) primarily, though it does support [Resrobot](https://resrobot.se/) and journeys in the whole country. This integration provides intelligent sensors for departures, deviations, vehicle locations, traffic status and route monitoring using the SL official APIs and departures, arrivals and route monitoring using Resrobot. It also provides services for Location ID lookup and Trip Planing. You will still need to get your own API keys from SL / Trafiklab (see docs for [HASL](https://hasl.sorlov.com)) for *some* of the API endpoints. +This is an Home Assistant integration providing sensors for [Stockholms Lokaltrafik (SL)](https://sl.se/) primarily, though it does support [Resrobot](https://resrobot.se/) and journeys in the whole country. This integration provides intelligent sensors for departures, deviations, vehicle locations, traffic status and route monitoring using the SL official APIs and departures, arrivals and route monitoring using Resrobot. It also provides services for Location ID lookup and Trip Planing. You will still need to get your own API keys from SL / Trafiklab (see docs for [HASL](https://hasl.sorlov.com)) for *some* of the API endpoints. Full and detailed documentation [is available](http://hasl.sorlov.com). ## Install using HACS * If you haven't already, you must have [HACS installed](https://hacs.xyz/docs/setup/download). -* Go into _HACS_ and search for _HASL_ under the _Integrations_ headline. You will need to restart Home Assistant to finish the process. +* Go into _HACS_ and search for _HASL_ under the _Integrations_ headline. Install the integration. + * You will need to restart Home Assistant to finish the process. * Once that is done reload your GUI (caching issues preventing the integration to be shown). * Go to _Integrations_ and add _HASL integrations_. -* Get API keys at TrafikLab. Read details in [documentation](https://hasl.sorlov.com/trafiklab) -* [Location IDs](https://hasl.sorlov.com/locationid) can be found using services + * For some of the integrations you might needd to obtain an API key from TrafikLab. Read details in [documentation](https://hasl.sorlov.com/trafiklab) + * For some integrations you might need to enter [Location IDs](https://hasl.sorlov.com/locationid). You can use `sl_find_location` service for this + * Perhaps add some GUI/Lovelace components as examples shows in the [documentation](https://hasl.sorlov.com/lovelace_cards) -* Enjoy and [buy me a coffee](https://www.buymeacoffee.com/sorlov) if you like my work +* Enjoy! ## Visualization +### [TEMPORARY] v3.2.0b+ + +While in beta, only the [HASL Departure Card v4](https://github.com/NecroKote/HA-hasl3-departure-card) is available +![HASL Departure Card v4](https://private-user-images.githubusercontent.com/1721257/313788625-2a4208f1-9007-4888-b084-32468d734a3c.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzQ1MjgwODUsIm5iZiI6MTczNDUyNzc4NSwicGF0aCI6Ii8xNzIxMjU3LzMxMzc4ODYyNS0yYTQyMDhmMS05MDA3LTQ4ODgtYjA4NC0zMjQ2OGQ3MzRhM2MucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MTIxOCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDEyMThUMTMxNjI1WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ODI2ZTM5OGZlMjgzNmE3ZWE0ZTFmY2U3NGVhZTUyNzRkMTEwMDQ3ODFmZWQ5MTMzMGQyYjNkMGE1YzYyNjdhMSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.EgZQsRZhzjP_GDrMaPyBGXs7V1kZ_oTFUXQcyXAE11c) + +The "Disruptions" card is currently in development + +### legacy versions + The sensors should be able to be used multiple cards in hasl-cards ([departure-card](https://github.com/hasl-platform/lovelace-hasl-departure-card), [traffic-status-card](https://github.com/hasl-platform/lovelace-hasl-traffic-status-card)) . There are several cards for different sensors and presentation options for each sensor type. [More examples](https://hasl.sorlov.com/lovelace_cards) can be found in the [documentation](https://hasl.sorlov.com/). ![card](https://user-images.githubusercontent.com/8133650/56198334-0a150f00-603b-11e9-9e93-92be212d7f7b.PNG) +## Support the developers + +If you enjoy this integration, consider supporting the developers to help keep it running smoothly and enhance future updates. + +- [@DSorlov](https://www.buymeacoffee.com/sorlov) - author of the original +- [@NecroKote](https://buymeacoffee.com/mkukhta) - maintainer diff --git a/hacs.json b/hacs.json index af2629a..acee7e0 100644 --- a/hacs.json +++ b/hacs.json @@ -3,6 +3,6 @@ "content_in_root": false, "country": "SE", "render_readme": false, - "homeassistant": "2021.12.0", + "homeassistant": "2024.4.0", "zip_release": false } \ No newline at end of file