Release 3.1.0

DSorlov · DSorlov · commit c4bd08d76e49 · 2022-03-29T10:40:51.000+02:00
diff --git a/README.md b/README.md
@@ -1,15 +1,14 @@
 [![hacs_badge](https://img.shields.io/badge/hacs-default-orange.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)
-![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)
-![version](https://img.shields.io/badge/version-3.0.5-green.svg)
+![version](https://img.shields.io/badge/version-3.1.0-green.svg)
 ![maintained](https://img.shields.io/maintenance/yes/2022.svg)
 [![maintainer](https://img.shields.io/badge/maintainer-dsorlov-blue.svg)](https://github.com/DSorlov)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-Home Assistant SL Sensor (HASL)
-===============================
+Swedish Public Transport Sensor (HASL) (formerly Home Assistant SL Sensor)
+==========================================================================
 
-This is a platform for Home Assistant that can be used to create "Departure board" or "Traffic Situation" sensors for buses and trains in Stockholm, Sweden. You have to install it as a custom component and you need to get your own API keys from SL / Trafiklab. Originally started with [fredrikbaberg SL sensor](https://github.com/fredrikbaberg/ha-sensor-sl) that was forked into [Home Assistant SL Sensor by DSorlov](https://github.com/DSorlov/hasl-platform) and now moved to its own organisation and life as [Home Assistant SL Sensor Integration](https://github.com/hasl-platform/integration).
+This is a platform for Home Assistant that can be used to create "Departure board" or "Traffic Situation" sensors for buses and trains in Stockholm, Sweden (but also for the rest of Sweden using Resrobot sensors). You have to install it as a custom component and you need to get your own API keys from SL / Trafiklab. Originally started with [fredrikbaberg SL sensor](https://github.com/fredrikbaberg/ha-sensor-sl) that was forked into [Home Assistant SL Sensor by DSorlov](https://github.com/DSorlov/hasl-platform) and now moved to its own organisation and life as [Home Assistant SL Sensor Integration](https://github.com/hasl-platform/integration). The name HASL comes from the time when the project was Home Assistant SL Sensor.
 
 ![card](https://user-images.githubusercontent.com/8133650/56198334-0a150f00-603b-11e9-9e93-92be212d7f7b.PNG)
 
@@ -20,7 +19,7 @@ By using HACS you will also make sure that any new versions are installed by def
 1. Install via [HACS](hacs_install) (recomended) or [manual](manual_install) (not recomended)
 2. Configure using GUI
 3. Get [API keys](trafiklab) for FREE! Which APIs depend on your sensor need!
-4. Find Location IDs via [SL Platsuppslag](https://developer.trafiklab.se/api/sl-platsuppslag/konsol)
+4. Find [Location IDs](locationid) for the selected API.
 5. Configure some [GUI/Lovelace](lovelace_cards) to display in frontend
 6. Enjoy!
 
diff --git a/_config.yml b/_config.yml
@@ -1,6 +1,6 @@
 theme: jekyll-theme-cayman
-title: Home Assistant SL Platform
-description: This site is for documentation for the Home Assistant SL Platform (HASL)
+title: Swedish Public Transport Sensor (HASL)
+description: This site is for documentation for the Swedish Public Transport Sensor (aka HASL) (formerly Home Assistant SL Platform) 
 github:
   zip_url: https://github.com/hasl-platform/integration/zipball/master
   tar_url: https://github.com/hasl-platform/integration/tarball/master
diff --git a/locationid.md b/locationid.md
@@ -0,0 +1,35 @@
+[<<Back to index](/)
+
+## Location IDs
+
+To get data about a specific stop for depatures or other sensors you will need to have a Location ID. Location IDs are NOT interchangeable between SL and ResRobot so depending on your api you will need to lookup locations via api.
+
+## SL API
+
+The IDs you get here is only for use with the SL sensors.
+
+Go to Find Location IDs via [SL Platsuppslag](https://developer.trafiklab.se/api/sl-platsuppslag/konsol)
+
+## Resrobot API 
+
+The IDs you get here is only for use with the Resrobot sensors.
+
+1. Start a browser window and go to the Developer Tools in Home Assistant
+2. Navigate to the Events tab
+3. Start listeningen to `hasl3` events
+4. Start another browser window and go to the Developer Tools in Home Assistant
+5. Navigate to the Services tab
+6. Select the `rr_find_location` service, enter your [API keys](trafiklab) for ["ResRobot v2.1"](https://www.trafiklab.se/api/trafiklab-apis/resrobot-v21/) and a search string. Click Call Service.
+7. Switch to the first browser window and see the response code and get the id for your location. Currently addresses are NOT supported.
+
+## SL API (alternative method)
+
+The IDs you get here is only for use with the SL sensors. This is a bit harder than the first approach but is available to be common with Resrobot.
+
+1. Start a browser window and go to the Developer Tools in Home Assistant
+2. Navigate to the Events tab
+3. Start listeningen to `hasl3` events
+4. Start another browser window and go to the Developer Tools in Home Assistant
+5. Navigate to the Services tab
+6. Select the `sl_find_location` service, enter your [API keys](trafiklab) for ["SL Platsuppslag"](https://developer.trafiklab.se/api/sl-platsuppslag) and a search string. Click Call Service.
+7. Switch to the first browser window and see the response code and get the id for your location.
diff --git a/roadmap.md b/roadmap.md
@@ -4,7 +4,5 @@
 
 - Input validation missing for creating new integration, field syntax validation is already done by HA but perhaps key validation or similar could be peformed?
 - Input validation missing for setting integration options, field syntax validation is already done by HA but perhaps key validation or similar could be peformed?
-- Perhaps integration with uber/scooters/etc? 
-- Implement GTFS Data Flows
 
 If you have ideas please submit an [issue](https://github.com/hasl-sensor/integration/issues) at GitHub or ping me via email, twitter or whatever.
diff --git a/sensors.md b/sensors.md
@@ -11,3 +11,6 @@ One objective during development have been to not touch the existing sensors so
 | :x: | :heavy_check_mark: | Route | Current best route between A and B | Looks up a current route between point A and B. Takes current traffic and deviations into account. |
 | :heavy_check_mark: | :heavy_check_mark: | Traffic Status | High level status for different traffic types | In v2 one combined sensor is created for all traffic types while in v3 a binary_sensor is created for each selected type. |
 | :heavy_check_mark:* | :heavy_check_mark: | Vehicle Locations | How many vehicles and their locations | Was experimental in v2 and data is cleaned up in v3. A separate sensor is created for each type of traffic |
+| :x: | :heavy_check_mark: | RR Departures | Departure information for a given Hållplats | Lookup departures using ResRobot API instead of SL.
+| :x: | :heavy_check_mark: | RR Arrivals | Arrivals information for a given Hållplats | Lookup arrivals using ResRobot API.
+| :x: | :heavy_check_mark: | RR Route | Current best route between A and B | Looks up a current route between point A and B using ResRobot API.
diff --git a/services.md b/services.md
@@ -2,10 +2,11 @@
 
 ## Services and events
 
-HASL implements some services that can be useful for accessing data and using for automations or whatnot. Anyway; there are five services that can be used. They return data by triggering an event on the `hasl3_response` topic.
+HASL implements some services that can be useful for accessing data and using for automations or whatnot. Anyway; there are five services that can be used. They return data by triggering an event on the `hasl3` topic. Commands can also be sent on the bus via `hasl3` top and using `cmd` as parameter specifying the argument.
 
 - `dump_cache` No arguments. Dumps the cache to a file in the Home Assistant configuration directory. Returns the filename of the created file in an event.
 - `get_cache` No arguments. Returns the cache of the created file in an event.
-- `find_location`: Arguments `api_key`, `search_string`. Returns the closest stop to the search string provided.
-- `find_trip_id` Arguments `api_key`, `org`, `dest`. Returns a trip from org to dest.
-- `find_trip_pos` Arguments `api_key`, `orig_lat`, `orig_long`, `dest_lat`, `dest_long`. Returns a trip from org to dest.
+- `sl_find_location`: Arguments `api_key`, `search_string`. Returns the closest stop to the search string provided. Uses the Resrobot API.
+- `sl_find_trip_id` Arguments `api_key`, `org`, `dest`. Returns a trip from org to dest. Uses the Resrobot API.
+- `sl_find_trip_pos` Arguments `api_key`, `orig_lat`, `orig_long`, `dest_lat`, `dest_long`. Returns a trip from org to dest. Uses the Resrobot API.
+- `rr_find_location`: Arguments `api_key`, `search_string`. Returns the closest stop to the search string provided. Uses the Resrobot API.
diff --git a/trafiklab.md b/trafiklab.md
@@ -1,6 +1,22 @@
 [<<Back to index](/)
 
-## Apply for free API keys
+## Types of keys
+
+This project is dependent on a number of APIs to aquire information. The APIs are mostly free but somewhat limited. Read more about that below.
+We now supports using either native SL api for Stockholm, but also Resrobot for the rest of the country (and Stockholm).
+
+If you are in Stockholm I recond using SL as it has more features, however Resrobot also provides intra-regional travel.
+
+## Apply for free API keys (Resrobot)
+
+First, visit [https://www.trafiklab.se/api](https://www.trafiklab.se/api) and create a free account.
+
+They provide multiple APIs, the ones you want is
+1. ["ResRobot v2.1"](https://www.trafiklab.se/api/trafiklab-apis/resrobot-v21/)
+
+When you have your API keys, you're ready to add the component to your Home Assistant either via [HACS](hacs_install) or [manual](manual_install).
+
+## Apply for free API keys (SL)
 
 This project is dependent on a number of APIs to aquire information. The APIs are mostly free but somewhat limited. Read more about that below.
 
@@ -13,12 +29,13 @@ They provide multiple APIs, the ones you want is
 Optionally you can also register for
 1. ["SL Trafikläget 2"](https://www.trafiklab.se/api/sl-trafiklaget-2) to get status sensors.
 2. ["SL Reseplanerare 3.1"](https://www.trafiklab.se/api/trafiklab-apis/sl/route-planner-31/) to use trip planning.
+3. ["SL Platsuppslag"](https://developer.trafiklab.se/api/sl-platsuppslag) to lookup location ids
 
 When you have your API keys, you're ready to add the component to your Home Assistant either via [HACS](hacs_install) or [manual](manual_install).
 
 ## API-call restrictions and optimizations
 
-The `Bronze` level API is limited to 30 API calls per minute, 10.000 per month. With 10.000 calls per month, that allows for less than one call every 4 minute but if you are using multiple sensors this is split between them and each config sensor section can contain a separate pair of api-keys.
+The `Bronze` level API is limited to 30 API calls per minute, 10.000 per month. With 10.000 calls per month for SL and 25.000 for ResRobot, that allows for less than one call every 4 minute but if you are using multiple sensors this is split between them and each config sensor section can contain a separate pair of api-keys.
 
 The calls have been optimized and are beeing locally cached for the specified freshness, if multiple sensors are using the same siteid there will still only be one call. Caching is done in a file (haslcache.json) that will be automatically created in the configuration directory.
 
