Skip to content

Commit

Permalink
Update Changelog and Notes on Breaking Changes
Browse files Browse the repository at this point in the history
Closes #544
  • Loading branch information
krkeegan committed Jan 17, 2025
1 parent 1abdad8 commit 2fe0d1b
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 17 deletions.
41 changes: 41 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,46 @@
# Revision Change History

## [1.3.1]

- Also update scenes pathname on migration
- Update changelog, oops

## [1.3.0] - Potential Breaking Change for Home Assistant Users

This release migrates the configuration files from the global `/config` directory to an addon specific `/config` directory. The migration script will attempt to update your log file and storage directories, but it may not work. Please check the log files after installing this update and specifically check the values of:

```
logging:
file: <<check this value>>
insteon:
storage: <<check this value>>
```

Within the addon the config files are located at `/config` which was previously `/config/insteon-mqtt`. Within the VSCode addon, addon config directories are mounted under `/addons_configs` and the InsteonMQTT config file can be found at `/83fc19e1_insteon-mqtt/config.yaml`

The benefit of this change, is that your config files will now be backed up with the addon.

### Fixes for other Home Assistant Deprecations

Home Assistant continues to evolve and some of the prior ways of doing things have been deprecated or entirely removed. This release contains a number of fixes that may have prevented users from installing the InsteonMQTT addon.

### New Home Assistant Config Buttons in Device Config

This release adds a number of configuration buttons to each entity that allow the user to perform many common tasks as shown in this screenshot:

![image](https://github.com/user-attachments/assets/ac8423f7-f4ad-4d6e-a706-643ca7315ea6)

### What's Changed
* Don't prune blank entity names in overridden discovery data by @tstabrawa in https://github.com/TD22057/insteon-mqtt/pull/523
* If not all DB records are received, try one-by-one by @tstabrawa in https://github.com/TD22057/insteon-mqtt/pull/531
* Allow Installation of Insteon_MQTT Module via Pip in Addon by @krkeegan in https://github.com/TD22057/insteon-mqtt/pull/537
* Migrate to Paho API Version 2 by @krkeegan in https://github.com/TD22057/insteon-mqtt/pull/538
* Enable Optional Encryption Without CA_Cert by @krkeegan in https://github.com/TD22057/insteon-mqtt/pull/539
* Remove Battery Devices from *_All Commands by @krkeegan in https://github.com/TD22057/insteon-mqtt/pull/540
* Migrate HomeAssistant Config Files Location by @krkeegan in https://github.com/TD22057/insteon-mqtt/pull/541
* Add MQTT Discovery Entities for Config Buttons in Home Assistant by @krkeegan in https://github.com/TD22057/insteon-mqtt/pull/542

## [1.2.0]

### Fixes
Expand Down
19 changes: 2 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ Version: 1.3.0 ([History](CHANGELOG.md))

### Recent Breaking Changes

- 0.9.1 - A Yaml validation routine was added. If you have an error in your
config.yaml file, you will get an error on startup.
- 1.3.0 - The config files moved locations, see [notes](CHANGELOG.md#130).

# Quickstart

Expand Down Expand Up @@ -111,18 +110,4 @@ future enhancements:
Thanks to [Insteon terminal](https://github.com/pfrommerd/insteon-terminal),
without the work that went into that repo, it would have taken me
forever to get this to work. I learned all of the command protocols
and database managemenet commands from inspecting that code.

# Old Breaking Changes

- 0.8.3 - HomeAssistant version 2021.4.0 now only supports percentages for fan
speeds. This means any fan entities in HomeAssistant that were configured
to use "low", "medium", and "high" for the fan speed will no longer work.
See [config-example.yaml](https://github.com/TD22057/insteon-mqtt/blob/master/config-example.yaml)
under the `mqtt -> fan` section for a suggest configuration in
HomeAssistant. __Users not using HomeAssistant are unaffected.__
- 0.7.4 - IOLinc, the scene_topic has been elimited, please see the documentation
for the replaces functionality.
- 0.7.2 - KeypadLinc now supports both dimmer and on/off device types. This required
changing the KeypadLinc inputs in the MQTT portion of the config.yaml file.
See the file in the repository for the new input fields. ([Issue #33][I33]).
and database management commands from inspecting that code.

0 comments on commit 2fe0d1b

Please sign in to comment.