Skip to content

Latest commit

 

History

History
853 lines (613 loc) · 34.6 KB

CHANGELOG.md

File metadata and controls

853 lines (613 loc) · 34.6 KB
Raw

Revision Change History

[1.2.0]

Fixes

  • Fix error description #488
  • Allow scenes.yaml file to be empty Thanks @kpfleming #497
  • Fixes for HomeAssitant changes #505
  • Suppress runtime error in Web UI #515
  • Change default Friendly Name of devices in Home Assitant Discovery to comply with new standards. If you have defined your own templates, you may need to adjust the name field. See (HomeAssistant Entity Naming Guidelines) (Change in MQTT Naming) #516
  • Fix Bug cuasing switches turned off to be reported as on. Thanks @tstabrawa #517
  • Allow for use of mode strings "instant", "fast", "normal" ... as described in the documentation. #519
  • Reverse dusk and dawn signal. #520
  • Prevent Refresh Commands from piling up on battery devices. Thanks @tstabrawa #521

Additions

  • New improvements to the Home Assistant Discovery Platform system. Now allows for overriding values for an individual device. Thanks @kpfleming (Documentation)

[1.1.1]

Fixes

  • Fix error which caused changing the state of one keypadlinc button, to turn off all other keypadlinc buttons (#463)
  • Fix error where the on_only and night_only flags for the motion sensor were reversed. (#464)

Additions

  • Significantly improvement in readabilty and content of the helptext for the commandline interface. (#465)

[1.1.0]

Fixes

  • Fixes a problem wherein the modem might not receive commands from secondary groups on multigroup controllers (keypadlincs, remotes, motion sensors). If you are having an issue like this. After updating, run pair on the affected multigroup controller. (#453)

Additions

  • Adds an availability topic to the topics published on MQTT. It will publish online when InsteonMQTT comes online and offline whenever InsteonMQTT goes offline even if as a result of a crash. This has been added into the default discovery templates for HomeAssistant. So you should now see your devices as unavailable if InsteonMQTT is offline. (#448)
  • If a level is now sent as part of the scene command, the device state will now properly report that level. (#449)

[1.0.2]

Fixes

  • Fix problem with heartbeat sensors in HomeAssistant displaying "invalid timestamp". (PR 443)
  • Fix problem with fan always reporting 'off' state in HomeAssistant. (thanks to @tstabrawa)(PR 441)
  • Fix possible error with KPL switch devices where all leds turn off at once. (PR 439)
  • Fix an error causing the discovery template to advertise the wrong topic for leak devices. (PR 444)
  • Add support for encrypted MQTT connections using the command line. (PR 445)

[1.0.1]

Additions

  • As promised @lnr0626 added support for the Resume_Dim feature for non-i2cs devices. (PR 423)
  • Added support for encrypted MQTT Broker connections. (PR 435)
  • Add instructions for using older (~2012) model 2242-222 hubs. Thanks @tbirdsaw. (PR 432)
  • Added document with example Home Assistant configs for those using manual configurations. (PR 431)

Fixes

  • Adds minimum and maximum temperature to default discovery template used for thermostats. (PR 434)

[1.0.0]

With the addition of the Discovery Platform in the last minor release, the improved config file design added by this release, and the numerous other additions and fixes added by everyone, it seemed about time to call this a version 1 product. 🎉 🎉 🎉

Additions

  • There is now a base config file that will be updated as part of the distribution. Now, the only settings you need to define in your config.yaml, are those that are unique to your installation, or those settings you wish to override. For most users, you config.yaml file can now be 10x smaller! (PR 414)
  • The base config file has been updated to provide device attributes in the state topics for devices. Similarly, the default discovery entity configurations have also been updated so that device attributes are now ingested into Home Assistant. Attributes such as reason, mode, timestamp, and others added in the future, are now available in HomeAssistant using the default InsteonMQTT setup. (PR 417)
  • Adds Resume_Dim feature. For dimmable devices when this flag is enabled, when the device is turned on from its button, it will resume the same brightness level it previously had before being turned off. Currently only works on i2CS devices, will be extended to i2 devices in the future. Thanks @lnr0626 (PR 411)
  • Adds the ability to send arbitrary insteon messages to a device for development purposes. This is a huge win for development. Thanks @lnr0626 (PR 413)

Fixes

  • Fix failure to create initial config.yaml file in HomeAssistant Supervisor installation. Thanks @lnr0626 (PR 406)
  • Update .gitignore to skip files created by testing. Thanks @lnr0626 (PR 407)
  • Adds a file necessary for a unit test that was accidentally left out. Thanks @lnr0626 (PR 410)

[0.9.2]

Hotfix

  • Allows the use of domain names for the broker and hub addresses. I created a bug in 0.9.1, my fault for not thinking of this. (PR 404)

Fixes

  • Adjusts the docker build script to one that works. (PR 402)

[0.9.1]

Additions

  • Validate the user config file before starting. This should help catch some bugs, and provides clear concise descriptions of mistakes. (PR 397) ** Potential Breaking Change ** If you have an error in your config.yaml file you will get an error when trying to startup after upgrading.

Fixes

  • Add support for on and off command for the fan group on fan_linc devices Thanks @lnr0626 (PR 399,PR 400)

[0.9.0]

Discovery Platform!

  • Added support for the HomeAssistant Discovery Protocol. This allows users to avoid defining insteon entities in their HomeAssistant configuration.

    NOTE Migrating from a functional installation to the Discovery Platform will be tedious and may not add much functionality. The next minor release of InsteonMQTT should improve this slightly, as it will apply default config settings, so you won't have to do as much copy and pasting. It may be worth waiting until then if you are interested in migrating.

Additions

  • Added join_all and pair_all commands to improve the experience when initializing a network or setting up many devices. Note, the skip battery devices option was removed from the refresh_all and get_engine_all commands. (PR 389)
  • Add a {{timestamp}} variable to templating. Will output the current timestamp. Useful for testing whether a received state change was triggered by a change, or is simply a retained mqtt message that has been resent because of a restart. (PR 393)

Fixes

  • Fix cyclic import error(PR 388)
  • Save DB Delta on Refresh(PR 392)

[0.8.3]

Breaking Change in HomeAssistant

  • 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 under the mqtt -> fan section for a suggest configuration in HomeAssistant. Thanks @Juggler00 (PR 378)

Additions

  • Adds and advanced option for setting the minimum hop count for specific devices. See min_hops (PR 376)

  • Adds a bunch of documentation including Templating Guide and Debugging as well as additions to other existing pages. Also reorganized the documentation to try and make it easier to find.

[0.8.2]

Fixes

  • Corrects a bug which prevented Keypadlincs of the Switch variety from reporting their state via the MQTT state topic. (PR 368)

Additions

  • Adds logging of Paho MQTT client. (PR 369)

[0.8.1]

Fixes

  • Alters the link delete functionality on the Modem. Solves an issue where some were not able to delete a link on the Modem. (thanks @zimmer62) (PR 363)

  • Change the name of the example config file to avoid warnings with Home Assistant Supervisor. (PR 364)

[0.8.0]

This update is the culmination of a significant refactor of the underlying code including PRs #308, #320, #325, #330, and #334 as well as other smaller PRs. These changes began back in 0.7.6 and should be transparent to the end user. But they should make the underlying code easier to maintain and simpler to add new devices and features. This is the reason for the jump to 0.8.0.

Additions

  • Added support for hidden door sensors. (thanks @tommycw1) (PR 324)

  • Adds a version command to the modem command topic {"cmd":"version"} and to the command line insteon-mqtt config.yaml -v. Both will return the version of Insteon-MQTT. (PR 355)

  • Adds get_flags suppport to the modem. Only needed for debugging. (PR 359)

Fixes

  • Fixed an error where setting the MQTT id would prevent subscribing to MQTT topics. (thanks @kpfleming)(PR 352)

  • Updates hassio config to comply with changes in API keys. (PR 344)

  • Fix small bug in BroadcastCmdResponse handler that likely never affected anyone. (PR 354)

[0.7.6]

A few new features and some significant bug fixes. A significant refactor of the underlying codebase for better stability and feature support. Likely one more refactor release still to come.

Additions

  • Enable passing ramp_rate with set and level commands. Currently only newer (last 4ish years?) KeyPadLinc Dimmers are known to support this. (thanks to @tommycw1 and @tstabrawa)(PR 213)

  • Improved Scene command, now supports level for devices. (PR 308)

  • There is no longer a need to set the Modem hex address in config.yaml. (PR 303)

  • Better error reporting when MQTT payload does not match template. (PR 300)

Fixes

  • Better error reporting to user when bad flags are used in set_flags. (PR 313)

  • Fix error with backlight setting (thanks @tommycw1)(PR 299)

  • Small correction to write_time to allow dynamic calculation of time. (PR 302)

  • Better logging on Stack Errors. (PR 306)

  • Fixed error where 'device' reason was not set by default in scene command. (PR 308)

  • Fix bug where multiple new Modem controller entries would end up with the same group number. (PR 326)

[0.7.5]

This is another significant update that both improves the user experience, adds a number of features, and improves the performance and reliability of the program.

Additions

  • Support for using an Insteon Hub as a modem. It comes with some caveats but it works well, please see Hub Instructions (PR 201)

  • Significantly improved Home Assistant Add-on installation! Instructions Includes update notifications, nicer icons, and better integration into Home Assistant. PR 290

  • A new Web Command Line Interface for Home Assistant Installations. No more entering commands via MQTT topics and payloads. PR 238

  • More pyTests, up to 76% coverage now. (PR 262 & PR 268)

  • Significant improvement to the Modem database handling. There is no longer a requirement to perform the command refresh modem for anything with the exception, that if you want to use sync to delete extra links off the modem, you will need to perform a refresh so that the extraneous links can be identified. Commands will no longer fail because the modem database is out of date. (PR 279)

  • Enable querying the battery on 2842 & 2844 Motion sensors. Helpful if using battery chemistry that varies from the OEM batteries. Voltage will be queried no more frequently than every 4 days. (PR 282 & PR 288)

  • Better handling of local device on_levels. If known, on_level is now accurately reported when the device turns on. Local on_level is retrieved with get_flags or set with set_flags. (thanks @tstabrawa)(PR 285)

Fixes

  • Allow for used last entries in DB. Improve compatibility with devices setup by ISY. (PR 255)

  • Improved message handling and processing of Pre_NAK messages. (PR 236)

  • Don't treat broadcast messages from different groups as duplicate. Fixes a bug where sequential presses of a button on a keypadlinc may not emit mqtt messages as they should. (thanks @tstabrawa)(PR 256)

  • Catch and delay on PLM reporting busy. (PR 261)

  • Tweak some of the logging to be more clear for users. (PR 272 & PR 275)

  • Refactor code around Pair(). Add significant amount of unit tests. (PR 277)

  • Improved message timing after receiving a broadcast command from a device. (PR 284)

  • Fixed a few rare errors with the Serial interface. (thanks @MrGibbage) (I 292)

[0.7.4]

Additions

  • Major improvements to the IOLinc support. In short all functions of the device should now be supported. Including momentary modes in which the relay opens for a defined period of time before closing again. Specific topics have been added for the relay and the sensor so they can both be tracked individually. (PR 197) BREAKING CHANGE - the scene_topic has been elimited, please see the notes below for replacement functionality. Please see notes in:

    • config.yaml - specifically the IOLinc sections in both the device and mqtt sections
    • MQTT Doc - note the new set_flags options for IOLinc and the IOLinc section

  • A new queueing system for battery devices (PR240):

    • Messages sent to the device will be queued until the device is awake
    • When the device sends a message, the modem will attempt to immediately send the oldest outgoing message. This only works for some devices.
    • Added an 'awake' command, to identify when a battery device has been manually awaken via holding the set button. This will cause all queued and future messages to be sent to the device for up to three minutes

  • Added support for querying the battery on a mini-remote. The battery state will be automatically queried when the device wakes up if is has been 4 days since the last battery check and will emit messages on the battery topic. (PR 244)

  • Added support for Smartenit EZIO4O 4 relay output module (thanks @embak) (PR 219)

  • Device names are now printed when printing the database. This makes reading the database output much easier. (PR 239)

  • Added ability to set the default ramp rate of a dimmer using the ramp_rate flag. (thanks @jordanrounds)(PR 235)

Fixes

  • Major fixes to a number of bugs in the Scenes management functions. (thanks @tstabrawa)(PR 234)

  • Database delta is updated on database writes. This eliminates a number of unnecessary refresh requirements, particularly around pairing. (PR 248)

  • Minor fix to the calculation of hops on resent messages. (PR 259)

[0.7.3]

Fixing a number of small bugs in preparation for upcoming releases which will add new features.

Additions

  • Added MQTT broker ID optional config input to allow the user to input the MQTT broker ID the client will use (thanks @kpfleming) (PR #220)

Fixes

  • Increase timeout for DB Refresh and allow retry for initial request. (PR #237)

  • Detect disconnections during poll() calls (thanks @kpfleming) (PR 227)

  • Modem Responder Group from Thermostat Should be 0x01 ([PR #198][P198]) (Issue 154)

  • Fixed device db find command to check the local group so multiple responsders can be created. (Issue #181)

  • Fixed a bug in the modem database class when removing an entry (thanks @krkeegan) (PR#196)

  • Changed the MQTT Remote to never mark messages for retain so the broker doesn't get out of sync with the device. (Issue #I210)

[0.7.2]

Fixes

  • Fixed an issue causing 100% cpu usage introduced in the scene sync code. ([Issue #195)I195)

[0.7.1]

Fixes

  • Fixed a coding bug when running sync-all (Issue #192) (thanks @krkeegan)

  • Fixed a coding bug when running sync on the modem (Issue #193) (thanks @krkeegan)

[0.7.0]

Additions

  • Thanks to @krkeegan, scene management and syncing are now supported. This allows you to define all of your Insteon scenes in a configuration file and have the system sync your devices to that file. (Issue #25, Issue #179)

  • Enable software control of motion sensor flags (Issue #184) (thanks @krkeegan)

  • Added support for single button remotes (Issue #185) (thanks @krkeegan)

  • Added an option to skip battery devices when doing a refresh and a new command to get the engine version (for older I1 devices) (Issue #189) (thanks @krkeegan)

Fixes

  • Fixed an error in the Thermostat MQTT code preventing user specified topics (Issue #182) (thanks @krkeegan)

  • Fixed issues with handling housekeeping messages sent to the model during a scene command. (Issue #183) (thanks @krkeegan)

[0.6.9]

Additions

  • Added a catalog of known device category and sub-category information. Just used for display in the get-model command for now. (thanks @mooshee)

  • Added an optional reason string to the state change reporting payloads and as an optional input for input commands. This allows for automations to change behavior based on why something changed. (Issue #138)

  • Added KeypadLinc low level set_flags commands to modify: load (de)attached, button follow masks, button off masks, non-toggle buttons. (thanks @jrevans).

  • Added KeypadLinc support for turning of the backlight completely (thanks @jrevans).

Fixes

  • Fixed bug in message emits for battery sensors. (Issue #157)

  • Fixed bug in thermostat not reporting humidity changes (Issue #160)

  • Updated hassio config file to include the required arch listing. (Issue #139)

  • Added docker builds for hassio from my repo (td22057) (Issue #148)

  • Fixed bug in motion sensor replies to a model info request (Issue #163).

  • Fixed bug in thermostat ambient temperature calculation (Issue #142) (thanks @krkeegan).

  • Fixed bug in KeypadLinc, FanLinc, and Outlet for non-group 1 links (Issue #159) (thanks @chris153002).

[0.6.8]

Fixes

  • Fixed incorrect handling of FanLinc speed change (Issue #126)

  • Fixed incorrect exception log statement in Protocol (Issue #132)

  • Fixed incorrect scene names in the config loader for IOLinc, Outlet, and Switch. This prevented customizing the MQTT scene topic and payload for those devices (Issue #130)

  • Fixed incorrect set-backlight command parsing (Issue #136)

[0.6.7]

Fixes

[0.6.6]

Fixes

  • Fixed incorrect Switch.set() calling sequence. (Issue #119)

[0.6.5]

Additions

  • Initial support for Insteon thermostats has been added (thanks @krkeegan).

  • Support for fast on and off commands and reporting has been added. The on/off mode (normal, fast, instant) is now a command input as well as an output flag in the state templates. This allows double-clicking of switches to be used in automation triggers (thanks @NickWaterton). (Issue #66).

  • Added support for manual mode state reporting (holding buttons down). Supported by dimmer, keypadlinc, remote, and switch (thanks @NickWaterton). (Issue #104).

  • New command 'get_model' added to the command line tool to retrieve and save the Insteon device cat, sub_cat, and firmware revision (thanks @krkeegan). (Issue #55).

  • New command 'join' added to the command line tool to perform a two-way pairing and refresh to link a device to the modem. This combines the previous linknig and pair command into a single command (thanks @krkeegan). (Issue #97).

  • New improved NAK error response codes makes it easier to understand errors when the devices can't communicate (thanks @krkeegan). (Issue #95).

  • Added a new command line input (get-devices) to get a list of the curren Insteon devices in JSON format. (Issue #84).

  • Added a new command line input to factory reset the modem.

Fixes

  • Added better messages when the pair command fails because the modem db is out of date (Issue #69).

  • Updated docs and example config file because of breaking HomeAssistant MQTT light change for dimmers (Issue #88).

[0.6.4]

Additions

  • Added on_level flag support for dimmers and KeyPadLinc's to set the light level when the on button is pressed (Issue #70).

Fixes

  • Multiple output messages queued to the Insteon devices causes some messages to be lost (Issue #86).

[0.6.3]

Additions

  • Added on_level flag support for dimmers and KeyPadLinc's to set the light level when the on button is pressed (Issue #70).

Breaking Changes

  • 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).

Additions

  • HassIO and docker support and is now available. See the main doc page for a link to the docs (thanks @lnr0626) (Issue #63, PR #76).

  • Added on/off outlet support (Issue #48).

  • Added support for older I1 devices (thanks @krkeegan). This should allow refresh command and database manipulation for 5+ year old devices. (Issue #17).

  • Added support for automatic maximum hop computations in messages. This should reduce delays and load on the insteon network (thanks @krkeegan). (Issue #43).

  • Added support for waiting to write messages until the maximum number of hops have elapsed. This should reduce subtle bugs where the Insteon network could get overloaded by sending messages to quickly. (thanks @krkeegan). (Issue #45]I45).

[0.6.2]

Additions

  • Added leak sensor heartbeat reporting support (thanks @djfjeff).

  • Added get_engine() command to find the Insteon device engine revision (thanks @krkeegan).

  • Added automatic message de-duplication (thanks @krkeegan)

Fixes

  • Fixed a bug where the MQTT client might close in an area that triggered an exception instead of a reconnect (Issue #32).

  • Fixed bug where the KeypadLinc was using the wrong handler for input MQTT scene simulation commands (Issue #34).

  • Fixed bug where the FanLinc would not report speed changes at all (Issue #37).

  • Fixed issues with the leak sensor topic documentation (thanks @djfjeff).

  • Fixed a bug in the command line script that would not read the MQTT user name from the config.yaml file (Issue #59).

[0.6.1]

Fixes

  • Fixed ordering of config.yaml in command line examples (Issue #27 and Issue #28).

  • Changed default retain flag to True in config file (Issue #29).

Additions

  • Switch, Dimmer, and KeypadLinc LED backlight levels can be changed with the set-flags command using the keyword "backlight" (Issue #13).

[0.6]

Additions

  • Battery powered devices will now attempt to download the all link database if it doesn't exist locally when a broadcast message from that device is seen (since the device is awake). This way you can trip a battery device (motino sensor or push a remote button) and it will initiate a database download.

  • Added FanLinc support (Issue #4). Thanks to @masterdka for testing.

  • Added battery powered sensors (door and window sensors) support (Issue #5).

  • Added leak sensor support (Issue #6).

  • Added KeypadLinc support (Issue #8).

  • Added IOLinc support (Issue #12).

  • Added reply system to the command line tool. Messages are now sent from the server back to the command line tool to indicate the result of running the command.

  • Added !include tag support to the yaml loader which reads the configuration file to allow the file to be split into multiple files (Issue #11).

  • Added linking command to put a modem/device into linking mode without touching it. This lets a new device be added purely through software commands (Issue #7).

  • Updated the modem db delete commands so that specific records can be removed. Removed the modem only db_delete command and replaced it with db_del_ctrl_of and db_del_resp_of just like the devices.

  • Low level MQTT commands now accept "nice" names from the config file for all inputs including the topic. "modem" is the nice name for the PLM modem.

  • Added support for simulating button presses on devices to trigger device scenes (Issue #9).

  • Added support for triggering virtual scenes defined on the modem. (Issue #24).

  • Added support for creating multi-group controller/responder links to allow linking between different buttons on multi-button devices. (Issue #20).

Fixes

  • Issue #21: Fixed incorrect device database entries being created on the last record of the database.

[0.5.2] - 2017-12-22

Fixes

  • Issue #16: Python3.4 doesn't allow circular imports

[0.5.1] - 2017-12-07

Fixes

  • Issue #3: Dimmer on/off topic using wrong template from config file

[0.5.0] - 2017-12-06

  • Initial release