Skip to content

Latest commit

 

History

History
464 lines (350 loc) · 19.6 KB

CHANGELOG.md

File metadata and controls

464 lines (350 loc) · 19.6 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[3.1.3] (2024-03-06)

Fixes

Buying time: use the newer API URL until its shutdown at end of 2024-03 @systemcrash

[3.1.2] (2024-03-06)

Fixes

Fixes spelling/grammar fixes thanks @systemcrash

[3.1.1] (2023-09-10)

Fixes

Fixes hasl-sensor/integration#56 Setup fails with Home Assistant 2023.6.0, thanks @morlic

[3.1] (2022-09-10)

This is major release adding Resrobot functionality BUT with some known upgrade issues due to some bad decisions earlier in development. During some cases the automatic upgrade of sensors might fail and to restore a broken sensor it must be fully removed and then recreated manually. Sorry.

BREAKING CHANGES

  • During some cases the automatic upgrade of sensors might fail, to restore a broken sensor it must be fully removed and then recreated manually. Sorry.
  • Service find_location renamed to sl_find_location
  • Service find_trip_id renamed to sl_find_trip_id
  • Service find_trip_pos renamed to sl_find_trip_pos

ADDED

  • API Communication for Resrobot 2.1
  • Departure sensor using Resrobot API
  • Arrival sensor using Resrobot API
  • Route sensor using Resrobot API
  • Lookup services for Resrobot locations

3.1.0b2 (2022-08-18)

Fixes

  • Fixes hasl-sensor/integration#43 Warning on deprecated 'async_get_registry' being used
  • Removed localized titles in en.json and sv.json due to hassfest validation failing

3.1.0b1 (2022-03-25)

Project will change name to Swedish Public Transit Sensor (HASL) because Resrobot supports the whole country however for Stockholm region it is still recommended to use SL-specific APIs since they contain a lot of extra data.

Breaking Changes

  • Service find_location renamed to sl_find_location
  • Service find_trip_id renamed to sl_find_trip_id
  • Service find_trip_pos renamed to sl_find_trip_pos

Added

  • API Communication for Resrobot 2.1
  • Departure sensor using Resrobot API
  • Arrival sensor using Resrobot API
  • Route sensor using Resrobot API
  • Lookup service for Resrobot locations

Changed

  • Updated translation for names ad descriptions and strings where applicable

3.0.6 (2022-03-25)

Added

  • Errors are now logged to error and not just to debug so you know whats wrong when it fails
  • If sensor data is empty, force refresh even if interval is not up yet

Fixes

3.0.5 (2022-03-17)

Fixes

Changes

  • Sensor will now show unavailable until sensor data is initiated
  • Configuration now stored in data and not options inside of configuration object
  • Implemented separate configuration schema versioning (restarting with schema version 2. Everything earlier is to be treated as version 1)
  • Now configures integration in one step when adding new integration
  • Harmonizing version settings between slapi and core as these will never differ anymore

3.0.4 (2022-03-07)

Fixes

3.0.3 (2022-02-26)

Fixes

  • Fixed broken route sensor when prognosis fails (seems to be flaky so it is removed for now)

3.0.2 (2022-02-17)

Added

  • Added first and last leg details as attributes for route sensor
  • Added possibility to use longitude,latitude pairs as locations in route sensor
  • Starting address/location is detailed in attributes for route sensor
  • Swedish translation for GUI
  • Added stoplists to results for RP3 for route planner
  • Added prognosisType for each leg and stoplist in haslworker for route planner

Fixes

  • Fixed broken counter for number of transfers in route sensor
  • Fixes #26: version number fixed in hacs.json
  • Fixes #29: filtering in departure sensor updated
  • Fixed broken prognosisType for route sensor (thanks @clearminds)
  • Fixed broken stoplist for route sensor (thanks @clearminds)

Changes

  • Combining location id and longitude,latitude pars as locations in route sensor
  • Route sensor total time does include estimated walking time however walking is not shown as first or last leg in route sensor

3.0.1 (2022-01-05)

Fixes

  • #22 fixed broken filtering on no lines being filtered

3.0.0 (2022-01-03)

Official first release of version 3 branch. This also means that version 2 and older is now deprecated.

3.0.0-beta.4 (2021-12-28)

Fixes

  • #17 fixed. Logic logically logical now. Thnx @FredHags
  • #18 fixed. Renamed
  • #13 Removed strange errors being logged.
  • Fixed errors in SLAPI causing requests to fail
  • Fixed broken data validation on some sensor data types

Changes

  • Raised the required HA version to 2021.12

3.0.0-beta.3 (2021-06-21)

Changed

  • Replaced all bare except:
  • #9 fixed. Implemented skeleton async_migrate_entry

3.0.0-beta.2 (2021-06-14)

Fixes

  • #7 fixed. Too many programming languages I guess... =)
  • #6 fixed. Fault management implemented.
  • Fixed double type datetime.datetime vs datetime in haslworker

3.0.0-beta.1 (2021-06-11)

Generally stuff could be really broken right now and I'm working on lots of stuff all over the code. Forked from 2.2.3 but changes from later versions are implemented as needed.

Changed (summarized)

  • Moving into the new organization on github and renaming to integration
  • Changed domain from hasl to hasl3
  • Removed dependency on external hasl-communication-library and replaced by internal slapi dependency instead
  • Using httpx async in slapi library
  • Added GUI configuration for the integration
  • Metadata added to the home assistant wheels repo, PR #48 and #57
  • Icons added to the home assistant brands repo, PR #1606 and #1626
  • Changed the unique naming of all entities generated to be truly unique and stay the same over time
  • Allow use of multiple API-keys for different sensors using multiple integrations
  • Enforce time based caching between all integrations to reduce wear on the API-keys
  • Workers to handle updates etc are now run on one minute intervals using call-backs to be friendlier on hass
  • Sensors are "just" retrieving data from the workers data instead of directly interfacing the APIs.
  • Devices are now created for each integration to be used for future automation etc
  • Departures entity is now providing Deviation data only if a Deviation integration is configured with the same stops/lines to decrease complexity but maintaining compatibility both with new and old architecture.
  • Deviation sensors are now available as separate entities/sensors if needed and are leveraged by the Departures sensors if they exist.
  • A common in-memory structure for all data is now done using a worker holding data for all instances instead of writing to disk
  • Updated hacs.json and info.md to be updated for v3
  • Service for dumping the cache to disk have been implemented
  • Fixed lots of bugs related to data not being available yet (async issues)
  • Generic extensible queuing system built in
  • Services for location lookup and trip planning implemented
  • Traffic status now is one sensor per traffic type to make it simpler to display status
  • All sensortypes works and returns some kind of data if configured with valid data
  • Added dependency on jsonpickle as the built-in json serializer kind of sucks
  • Added version field to manifest
  • Added system health checks
  • Services now response on the event bus by hasl3_response
  • Services can be called via the event bus on hasl3_execute with argument cmd= and then the rest of the argument as when normally using when calling a service
  • Binary sensor logging and fault management implemented
  • Slapi and haslworker logging and fault management implemented
  • Sensor logging and fault management implemented
  • Changed fork from DSorlov to hasl-sensor

2.2.7 (2021-06-08)

Changed

  • Workaround fix for timezone error

2.2.6 (2021-05-18)

Changed

  • Fixed version numbers discrepancies

2.2.5 (2021-05-10)

Changed

  • Updated manifest.json

2.2.4 (2020-05-23)

Changed

  • Documentation updates

2.2.3 (2020-03-04)

Changed

  • Bug fixes

2.2.2 (2020-03-01)

Changed

  • Release with right branch

2.2.1 (2020-03-01)

Changed

  • PR #44 #49 Fixed bug where no departures were returned if no lines specified @Ziqqo @lindell
  • PR #49 Minutes from expected time @lindell
  • Updated HACS configuration

2.2.0 (2019-07-18)

BREAKING CHANGES

  • config entries have been changed to a true string array and should now be specified according to lines: ['123X','124']

Changed

  • Fix #36 platform not found
  • Fix #37 lines in 2.1.3
  • Moved the cache file from config dir into the .storage folder
  • Fixed documentation error (said TI2KEY instead of TL2KEY)

Added

  • Added services Platsupplslag and Reseplaneraren as services (preview, no docs yet)

2.1.3 (2019-07-15)

Changed

  • Replaced custom updater with HACS

2.1.2 (2019-07-15)

Changed

  • Replaced custom updater with HACS
  • Minor changed in documentation
  • Fixed bad custom_updater.json file

2.1.1 (2019-06-04)

Changed

  • Fix #32 error management fails
  • Fix #27 implemented filtering on "lines" for departure sensors

2.1.0 (2019-05-21)

BREAKING CHANGES

  • comb sensor is now departures, will remove comb in 2.5.0. Please change your config.
  • tl2 sensor is now status, will remove tl2 in 2.5.0. Please change your config.

Changed

  • Fix #23 timewindow not working
  • Fix #24 default scan_interval documentation bug
  • Fix #25 stupid bug introduced by DSorlov =)
  • PEP8 Compliance
  • Branched all display cards to new project hasl-cards.
  • Renamed repository from ha-sensor-sl to hasl-platform to conform to new naming.
  • Updated massive amounts of links and documentation
  • Many stability improvements and minor bug fixes

Added

  • Implemented basic error handling as exceptions are now raised from communications library.
  • Implemented new sensor based on real-time train location API (EXPERIMENTAL!)

2.0.2 (2019-04-30)

Changed

  • Fixed #19 Small changes for custom_updater

2.0.1 (2019-04-30)

Changed

  • Fixed #18 missing indentation in sensor.py

2.0.0 (2019-04-30)

BREAKING CHANGES

  • Changed structure in configuration to be more standardized, avoid key duplication etc
  • Cannot be used pre 0.92 as dependency code has moved (or at least I have not tried it)
  • New install location for the auto-updater (changed from folder sl to hasl)
  • Rename of sl-card.js to hasl-comb-card.js

Changed

  • Changed naming of a few functions to make it more clean
  • Fixed issue #16: sync_interval not working
  • Fixed issue #11: wrong time shown, thanks to [@isabellaalstrom] for suggesting fix
  • Language is now picked from config first, then from browser, and then default sv-SE
  • Icon changed to mdi:bus if no deviations, otherwise mdi:bus-alert
  • Recommended install directory is now 'hasl' instead of 'sl' to align naming
  • Fixed the auto-updater URLs (dev branch will be off but who cares, dev should not be used in prod)
  • Using HASL 2.0.0 Communications Library with support for Trafikläget2 API from SL
  • Implemented a request minimization strategy for API-calls / using caching (haslcache.json) when using multiple sensors for same stops

Added

  • Config 'property' in comb sensor to set which property that is reported as default state
  • Config 'always_show_time' in hasl-comb-card.js to force also showing time when less than 60 minutes to departure when 'timeleft' is set
  • Added init.py and manifest.json to support 0.92+ version of home assistant, thanks to [@dimmanramone]
  • Added property deviation_count to comb sensor to show number of deviations in total
  • New sensor type TL2 for displaying traffic status messages for the Trafikläget2 API
  • Service for force clearing of cache (adds services.json, mostly for troubleshooting)

1.0.3 (2019-04-16)

Changed

  • Missing default value for direction parameter
  • Integrated magic to better show time left to departure from fork lokanx-home-assistant
  • Added support for languages (sv-SE and en-EN) in sl-card.js

1.0.2 (2019-04-16)

Changed

  • Fix for naming of unique_id for certain cases (still not good however)
  • sl-card.js enhanced and styled by @dimmanramone! Huge thanks!!

1.0.1 (2019-04-15)

Changed

  • Fixed documentation about interval being changed to scan_interval this to better support the Home Assistant standard.
  • Fixed direction parameter that had been hard-coded for some strange reason. Blaming it on someone else. =)

1.0.0 (2019-04-12)

Added

  • Added configuration for TimeWindow
  • Added friendly_name (and removed name)
  • Updated sl-card.js to support time or minutes departures
  • Exposed unique_id for each sensor
  • Added multiple properties to the sensor output

Changed

  • Moved communication to external PyPi library (HASL)
  • Changed default repo from dev to hasl
  • Cleaned up the code
  • Using constant keywords from HomeAssistant
  • If update error occurs now deliver '-' as value instead of -1

Removed

  • name configuration (replaced by friendly_name)

0.0.8 (2019-04-11)

Changed

  • Moved /sensor/sl.py to /sl/sensor.py
  • Fixed bad formatting of custom_updater files
  • Fixed custom_updater instructions in readme
  • Fixed broken encoding issues for rendering in sl-card.js

0.0.7 (2018-12-13)

Added

  • Rendering of deviations
  • Parameters to customize card

Changed

  • Rendering strategy

0.0.6 (2018-11-16)

Added

  • Added output of icons

Changed

  • Bug fixes in lookup
  • Changed rendering in lovelace card

0.0.5 (2018-11-16)

Added

Changed

  • Logging strings changed to indicate which API failed
  • User Agent String conforms to standard
  • Now renders the next hour of departures

Removed

  • JavaScript output

0.0.4 (2018-09-30)

Added

  • Use a binary_sensor to enable/disable API-calls
  • Log error code and message once in case of error at API call
  • Support for custom_updater

Changed

  • Log error message instead of just reporting failure.
  • Changed fork from fredrikbaberg to DSorlov

0.0.3 (2018-09-30)

Changed

  • Only log errors once

0.0.2 (2018-09-29)

Changed

  • Log error code.
  • Changed fork from fuffenz to fredrikbaberg

0.0.1 (2018-05-08)

Initial release

  • This is a great day indeed.