homebridge-konnected

First off, apologies to anyone who thought this project was dead. Now, back on track with another update that fixes some very overdue changes that help with upgrading to the latest versions of NodeJS (v20 🎉) and various other node dependencies and security fixes.

Supported/Tested Versions:

NodeJS: v19+
Homebridge: v1.7.0

Bugs and Issues:

If you're having issues with the plugin and things are not working as expected, please report an issue here.

Changelog:

• Updates README with Discussions Forum link and cleans up links to Konnected.io unmanaged repo (5eb8577)
• Update bug-report.md (6b28857)
• Updates README Wiki links (b848626)
• Updates VS Code ESLint settings, console output, and TypeScript compiler options. (c007a1c)
• Updates node_module dependencies and resolves Dependabot alerts. (691af9b)
• Improves code to "next" ES module-based standards. (e6d47e0)
• Cleanup of logging and renaming of symbol for semantics. (e1c42aa)
• Ensure URL spec format for urls. (9230111)
• Corrects requirement for async/await in promise for fetch request. (5de1284)
• Resolves #40 in response to breaking changes with Node 19+ http agent keep-alive defaults which caused implications with the node-fetch module used. (30dbac9)

Changelog:

• Updates package.json with new URLs location for homepage, repository and bugs. (784d4f2)

This release addresses some organizational changes with regards to the plugin. We see the move away from the officially hosted Konnected repository into my own personal repository based on my own efforts separate from the Konnected organization.

Since I am the original author of the plugin, I will continue to develop this as robustly as I have from the beginning. I will also be able to provide better control over what the public wants versus the corporate direction that Konnected is interested in going.

Nothing has changed from a functionality perspective in this release.

Changelog:

• Stops tracking nodemon.json changes, these are established now and static. (7fc1349)
• Merge branch 'master' of https://github.com/mkormendy/homebridge-konnected (0fe8848)
• Update issue templates (b06fe93)
• Update issue templates (f27d1d6)
• Updates README with links to personal repository and also moves information out and into that repository's wiki. (f372b76)
• Updates branding banner to reprioritize brands. (dee196b)
• Modifies gitignore changes. (a46b312)

It's been a while for a new release, this one fixes a few items, cleans things up and adds a new exit delay feature.

Bugs and Issues:

If you're having issues with the plugin and things are not working as expected, please report an issue here.

Changelog:

• Adds new variables and logic for exit delay feature. (https://github.com/mkormendy/homebridge-konnected/commit/65dc4c11abb8a418550b1161b15dee82fbe45db8)
• Fixes typing for error handling to satisfy TypeScript hinting. (https://github.com/mkormendy/homebridge-konnected/commit/e42a7f201cc1fa513aaaf73bee73789f4592d0f9)
• Adds better logic for IP and port changes when writing to the homebridge config file. (https://github.com/mkormendy/homebridge-konnected/commit/108ac13624ba7dd613a2ce04628f3a1e01e18779)
• Cleans up and makes log output more consistent. (https://github.com/mkormendy/homebridge-konnected/commit/f81a8f58124c99d2065e91a99520c993617b92f4)
• Cleans up and makes log output more consistent. (https://github.com/mkormendy/homebridge-konnected/commit/4b64b772f35c2f8a2631220a4702629ab5f0116d)
• Adjusts log output verbiage to clarify factory resets for panels previously provisioned with another platform. (https://github.com/mkormendy/homebridge-konnected/commit/763e44e9f42427a14306762563ed14c8f80867c5)
• Refactors unifies binary states to fix issues with sensor state logic. (https://github.com/mkormendy/homebridge-konnected/commit/bc2234406fc5b1b9d343027d9f16daa076b56b7b)
• Fixes entry delay configuration defaults and assignment. (https://github.com/mkormendy/homebridge-konnected/commit/a1938ecaf7114acc92e2100d077f6d6e48d60e88)
• Adds reference for interactive help on Discord, contributions and thanks to bottom of README markdown file. (https://github.com/mkormendy/homebridge-konnected/commit/e613265cb205655743da440e69828302af0de15a)
• Updates verbiage for the plugin's Advanced section of the configuration documentation. (https://github.com/mkormendy/homebridge-konnected/commit/db1454f5c38c671c93625d1238fef58abd0232d4)
• Adds new documentation points for exit delay feature as shown in the example configuration. (https://github.com/mkormendy/homebridge-konnected/commit/2b6fbf4ef4e36e7aaa0647085221ba7912a85120)
• Adds new exit delay feature to the example configuration. (https://github.com/mkormendy/homebridge-konnected/commit/a3ff00d3d9a4b78e10c0e20d757190d9cd128d38)
• Updates upcoming features list. (https://github.com/mkormendy/homebridge-konnected/commit/424b0362d222423c45f5e0973ca581b84b790d0d)
• Updates feature set list. (https://github.com/mkormendy/homebridge-konnected/commit/e2e1d03650f8b583320849d9c20118fe03d05763)
• Updates badges at top of README markdown file and also verbiage for promo code. (https://github.com/mkormendy/homebridge-konnected/commit/f065ec416d0f20dccb60e3d168f4acb25a86ea58)
• Updates package.json with repo and links for submitting issues (used in Homebridge UI). (https://github.com/mkormendy/homebridge-konnected/commit/50608ff3ea66511e91c2ba1b1a19ad204db32eeb)
• Adjusts recommended example values for beeper pulses to coincide with firmware timings. (https://github.com/mkormendy/homebridge-konnected/commit/c8ffc6999ef23a345cb3f4d0d41fea511e9fe145)
• Updates Homebridge UI configuration screen to accommodate new Exit delay settings. (https://github.com/mkormendy/homebridge-konnected/commit/5c9cb51cad21ed45fdfa5470b9d899f3b6179ba5)
• Adds vscode launch notes. (https://github.com/mkormendy/homebridge-konnected/commit/d03aa95b4e94f33d12f4e731676bdc2f07697c35)
• Renames method to fix typo. (https://github.com/mkormendy/homebridge-konnected/commit/b2f4bace0773e2b0adbbd69128898b517b7334f9)
• docs: Updates CHANGELOG with proper details. (https://github.com/mkormendy/homebridge-konnected/commit/9a501fb3cb42d80009a8eec5b641b59141ef05f6)

Changelog:

• build: Adds release-it configuration block to package.json to modify CHANGELOG.md on publish. (https://github.com/mkormendy/homebridge-konnected/commit/343227b3d7a02e32229b6227ccccc29d748eb8b9)

Changelog:

• docs: Adds the CHANGELOG.md file to the repository, commits start using the Angular/ConventionalCommits commit conventions (https://github.com/mkormendy/homebridge-konnected/commit/672960b062669f269bd2fb77d11a33a6d56eab3e)
• Logging cleanup. (https://github.com/mkormendy/homebridge-konnected/commit/06cea66ad27ac93bc52a8b656a1a5ff0770ef7c3)
• Adds system environment variables for excluding panels when developing. (https://github.com/mkormendy/homebridge-konnected/commit/c0fcc0547b2501728695d737a8620a7b2c91d7b9)
• Updates README with a screen capture of Konnected accessories being operated in HomeKit. (https://github.com/mkormendy/homebridge-konnected/commit/6d320c0f30bc7ebf0c0c8aed5faa40633d9c8f71)

Changelog:

• Turns off solid/momentary beeper if Security System is disarmed before the entry delay completes and the Security System is triggered. (https://github.com/mkormendy/homebridge-konnected/commit/bc5ce4a1f04209300ef23c40e509d2c90f44210f)

Changelog:

• Fixes entry delay default of having a constantly 'on' state for beepers that don't have any custom momentary settings. (https://github.com/mkormendy/homebridge-konnected/commit/2949256f078d556e0a5c1f4847a1b4c1cedf5891)
• Fixes multiple sensor triggering, current Security System state assignments, and renames variable for semantics. (https://github.com/mkormendy/homebridge-konnected/commit/3c3d0d43ad39cf5782cf356a8ac67fc47e2a91a2)
• Resorts funding options. (https://github.com/mkormendy/homebridge-konnected/commit/c6284198891ff78de35952a90728160c0fa26cab)
• Removes processing of temperature and humidity sensor actions. (https://github.com/mkormendy/homebridge-konnected/commit/f659a08cd6ed03950277411cc6971fed1b246b72)

Changelog:

• Fixes location of call to process sensor accessory actions. (https://github.com/mkormendy/homebridge-konnected/commit/16b33177e292007f6a7950c698400ffbf494b82f)
• Fixes invalid value for characteristic properties on the security system service. (https://github.com/mkormendy/homebridge-konnected/commit/008cd1a0d49b594da4575ad117be982d7a954774)
• Corrects typo and terminology. (https://github.com/mkormendy/homebridge-konnected/commit/b122a5ca8e80dccd106d168f99ce0e19d11dd9bd)

Changelog:

• Adjusts instructions for Triggerable Modes for HOOBS configuration user interface. (https://github.com/mkormendy/homebridge-konnected/commit/b9ab7520e9ce116a954f5a63e04cbb463ee68c80)

Changelog:

• Fixes field and section titles for HOOBS configuration user interface. (https://github.com/mkormendy/homebridge-konnected/commit/d0a552ff47320b402e67744bd24d0cbea264adc5)

Changelog:

• README formatting cleanup. (https://github.com/mkormendy/homebridge-konnected/commit/b9480f561ae9c06f83f34eeaf0bdb67f8e3c5366)
• Clarifies instructions for required panel IP and Port fields in the plugin's configuration. (https://github.com/mkormendy/homebridge-konnected/commit/5f315b3d1b8654856d3c1cf22fda186d3ef9e82f)
• Refactors config.json update method, per @mkellsy's suggestions. (https://github.com/mkormendy/homebridge-konnected/commit/aa34f46fa54d8e6af3bc332d38871e51f35d89ea)
• Code cleanup, removes empty line gaps. (https://github.com/mkormendy/homebridge-konnected/commit/abdf8d2beb366c577e0b6b5943d1f43e680835c6)
• Updates README features and hero image alt text. (https://github.com/mkormendy/homebridge-konnected/commit/bc7334e425a79f91f109be3012ddc864c3c0575d)
• Adds funding options to the plugin. Please fund my work if you use this plugin! https://github.com/sponsors/mkormendy (https://github.com/mkormendy/homebridge-konnected/commit/6ac566e86627fbd8fdaec68b76550b1113e63337)
• Adds more keywords to the package for better search terms. (https://github.com/mkormendy/homebridge-konnected/commit/4378e30e6670ac11ec0f9d1752360e986e2807a7)
• Updates the author and contributor details. (https://github.com/mkormendy/homebridge-konnected/commit/77b80a350704471120b01fc89b42899321b2a04c)
• Cleans up package name and description to be more consistent with all Homebridge plugins. (https://github.com/mkormendy/homebridge-konnected/commit/afc9fd2ec579f2dc45163108db2291c670fa998c)
• Removes ending the NodeJS process prematurely. (https://github.com/mkormendy/homebridge-konnected/commit/968d6fc952825a558a44bd2c6e586241a77813b6)

⚠️ Breaking Changes:

Apologies again, but there were some issues with the way that actuator/switches had their states triggered on the boards and the code has been refactored to make this feature more succinct and also semantic to the user. In particular, if you have a switch that needs to change its trigger state (not the same as triggerable mode - that's different) from "high" to "low" --- instead of using "1" or "0", you instead use "high" or "low" respectively.

As usual, please refer to the README documentation for the details.

Changelog:

• Updates the README with details about temperature/humidity sensor interval polling and security system modes. (https://github.com/mkormendy/homebridge-konnected/commit/5d0d0243d4799f5b892aa3b5a3b54012d8f3f8ff)
• Updates the plugin's configuration instructions regarding the Security System modes for sensors and switches. (https://github.com/mkormendy/homebridge-konnected/commit/b72465741bf3de5409793888630d1d51a95245eb)
• Code formatting cleanup. (https://github.com/mkormendy/homebridge-konnected/commit/bb8d0ee8f2c71eb47760ebfa0a5248baa0eb0777)
• Renames inbound sensor update payload variable to be more semantic. (https://github.com/mkormendy/homebridge-konnected/commit/0fde4aa00f780dc63ee4ff17214662b32e9ce713)
• Code cleanup in the zone configuration with trigger object properties. (https://github.com/mkormendy/homebridge-konnected/commit/ac66208032430bc162b01ec2e6fc98290db4a875)
• UI X configuration schema grammar/formatting cleanup. (https://github.com/mkormendy/homebridge-konnected/commit/0301958b9f6e768cea9857b84e63117b6f5c4acb)
• Removes warnings tracing from the node monitor config (which blocked debugging). (https://github.com/mkormendy/homebridge-konnected/commit/969e7f2e3b9a374636745f52c36187bac96dea85)
• Removes panic button feature from list (there's already a switch for the siren - we can use that). (https://github.com/mkormendy/homebridge-konnected/commit/86eac320f1c7f1faf66440f3db36adfd01ba2cc6)
• Adds shopping discount message to the README for Konnected users. (https://github.com/mkormendy/homebridge-konnected/commit/6457c8194e09bc3d30cffd5eda21e5bceca709e9)
• Fixes header splash image URL link to point to Konnected's main website with utm parameter for analytics. (https://github.com/mkormendy/homebridge-konnected/commit/e5bb9ad54c818637f4280d645c53c73813ec4038)
• Adjusts the messaging of the triggerable modes for switches in the plugin configuration screen in Config UI X. (https://github.com/mkormendy/homebridge-konnected/commit/1ca8e24a2dee5efa9cf93d43151b85531ff95072)
• Creates constant for reverse constant lookup for future use. (https://github.com/mkormendy/homebridge-konnected/commit/ec8d20f3b5c7db7247f878b576d759389723cf84)
• Interface object comments. (https://github.com/mkormendy/homebridge-konnected/commit/3181f1292d008e09306999ac998929eb149edcb2)
• Comment cleanup. Code cleanup. Method parameter reorganizing. Adjusts debug log assignment. (https://github.com/mkormendy/homebridge-konnected/commit/e198e9d4c14beea52b08ddff1a230817ca40208b)
• Renames zonesCheck variable to have more semantic existingPayloadZones meaning. (https://github.com/mkormendy/homebridge-konnected/commit/9ef778fe8bd4f2a6ee1715761467fd4e72d82114)
• Removes unused code blocks and comments. (https://github.com/mkormendy/homebridge-konnected/commit/06b17334d1ac620c0a57d4d3de251ed408755b5d)
• Cleans up state values and assignment for momentary switches. (https://github.com/mkormendy/homebridge-konnected/commit/19c4b51647f59fad30b7a15ea3618b018b6aa91f)
• Removes redundant array variable and replaces with existing array with the same value(s). (https://github.com/mkormendy/homebridge-konnected/commit/ab5eec1fab5ce04b82470b69d36d9b13f95f5944)
• Removes redundant accessory UUID checks. Enforces state assignments to runtime cache for non security accessories. Enforces passed in accessory state as correct type. (https://github.com/mkormendy/homebridge-konnected/commit/cdd4a95ec1094d6c11ac7fb9be84b47de4b9c4d7)
• Refactors and merges the Security System controller method to include the trigger method - more logical. (https://github.com/mkormendy/homebridge-konnected/commit/7d5e0edaf7a2333e64c9c8bf38bcc8fc2c0deee2)
• Refactors switch trigger options to be more semantic. (https://github.com/mkormendy/homebridge-konnected/commit/9aa4e25a7d69fcddd8b156baaf2b6520bb5243ea)
• Fixes an issue with the reading of the config.json file when panels are found but don't have any zones assigned yet. (https://github.com/mkormendy/homebridge-konnected/commit/1c5eae58624a528acc6e9fd4af3fa51d66fde48e)

Welcome to the official out-of-beta release of the Konnected Homebridge plugin for their Security Alarm Panels! 🎉🎉🎉

⚠️ Breaking Changes:

There have been slight changes to the config.json structure for this plugin. Please refer to the README documentation for the altered structure.

We're noticing that some users are being afflicted with stale configuration settings in the Homebridge config.json file, that were set and present from the previous version:

• sensors have old "switchSettings": {...} which shouldn't be there for sensors - remove that entire "switchSettings": {...} object block
• sensors may have the old "invert": true/false setting in the wrong location, it should exist under the "binarySensorSettings": {...} - move the invert setting to be inside that
• switches may have "binarySensorSettings": {...} which shouldn't be there for switches - remove that entire "binarySensorSettings": {...} object block
• beeper/siren/strobe switches may have "trigger": 1 in them. That is the default trigger for switches anyhow, so they aren't needed there. remove the "trigger": 1 setting from switches if they are meant to be triggered high.
• beeper/siren/strobe switches don't need "triggerableModes": [...] and don't really have any sort of purpose here (that's why it's experimental)

In this specific case, what might be best is to back-up the Homebridge config.json file (simple copy and paste it to a basic text file and save that somewhere of reference). Then, re-build the configuration from scratch starting off with:

{
  "name":"Konnected",
  "platform":"konnected"
}

Then use the Config UI X interface to set up the zones again. That may be tedious, but the structure of the config.json file shouldn't be changing for this plugin significantly anymore – just additions of new settings.

Recommended Steps For This Release:

• Shut down Homebridge.
• Close down your HomeKit app on your phone or desktop.
• Delete the cachedAccessories file.
• Launch Homebridge.
• If you are using the Config UI X plugin, revisit the zones you may have possibly configured and make sure that you review their configuration and that they are functioning as you intend.
• Save the settings in Config UI X to rebuild the config.json file.
• Reboot Homebridge. (you may need to reboot it once-more for the settings to be properly cached)

Changelog:

The following items were performed in this release:

• Cleans up the package-lock file with updated packages. (https://github.com/mkormendy/homebridge-konnected/commit/955be4ad106ccbefde373beca7424d1aeb568771)
• Fixes triggerable modes option in the example config.json in the README file. (https://github.com/mkormendy/homebridge-konnected/commit/c222f29ca6c304e46680945a7896e3648f93b74e)
• Merge branch 'master' of https://github.com/mkormendy/homebridge-konnected (https://github.com/mkormendy/homebridge-konnected/commit/b019d694529b3d819cd6a01bd047dd69b866e698)
• Rename on_pullRequest.yml to on_push-pullRequest.yml (https://github.com/mkormendy/homebridge-konnected/commit/c380af882148b72c11daa9c20733855388d40f95)
• Update on_pullRequest.yml (https://github.com/mkormendy/homebridge-konnected/commit/ecf83cef4259f1c1683f669007c4716ec75ec464)
• Updates the README with instructions and details for the new features in the latest update. (https://github.com/mkormendy/homebridge-konnected/commit/ac782075b46d49080a470261d252bcb38d62c286)
• Refactors, updates, adds, removes features, process, and logic required to provide a security system in HomeKit with Homebridge, this plugin and Konnected Alarm Panels. (https://github.com/mkormendy/homebridge-konnected/commit/7f370ae9998d95681687f0f014738fb9bf833718)
• Updates the interfaces for the different types common for this plugin's objects. (https://github.com/mkormendy/homebridge-konnected/commit/fe1c18e9507b62aa58a0889a6b4f76405ab92831)
• Updates and refactors the constants based on changes in the main platform and platform accessory files. (https://github.com/mkormendy/homebridge-konnected/commit/6bb0018c1ee5c1b7bf401298270f3a8d5cb09b1e)
• Updates the npm package dependencies for this plugin. (https://github.com/mkormendy/homebridge-konnected/commit/cd4c252923bafeb830b6fe8a1d580ea027a432a5)
• Updates the Config UI X form schema.json file to include options for the new security system to operate beepers, sirens, and sensors. (https://github.com/mkormendy/homebridge-konnected/commit/5c8f1951db4b0e3066fdcf31645ff5954126bc85)
• Adds git documenting to the VS Code workspace settings. (https://github.com/mkormendy/homebridge-konnected/commit/13a7757098fdaa94dd7c0b03e832a987533fd304)
• Adds warnings tracing to the node monitor config. (https://github.com/mkormendy/homebridge-konnected/commit/37e54a07ddb6b3eaf61acec340f7be725a262975)
• Updates debugging console to use an external terminal for multi-screen dev environments. (https://github.com/mkormendy/homebridge-konnected/commit/e03071776ec108ab2bbdb9c8b683f65f8cd4987e)
• Updates TypeScript configuration. (https://github.com/mkormendy/homebridge-konnected/commit/e0c5ffbf1b617996c224e5facf744dac171f613a)
• Update and rename build.yml to on_pullRequest.yml (https://github.com/mkormendy/homebridge-konnected/commit/7485262e4103c17e73484d8402f60ab3be548a42)

Changelog:

• Reinforcing correct zone state values and adds the ability to invert the value of a zone's state.
• Revises and makes debugging output more semantic.
• Adds a TypeScript interface for the zone states runtime cache commonly used throughout the code.
• Cleans up and renames the humidity / temperature sensor symbols.
• Code comment revisions.
• Readme cleanup.

Changelog:

• Adds items to the Upcoming Features section and cleans up expectation for HOOBS in the future. (https://github.com/mkormendy/homebridge-konnected/commit/fea06d6ae4f998081b06f0a1732a0015aad8d779)
• Example cleanup. (https://github.com/mkormendy/homebridge-konnected/commit/b6ccf08637e8afef4caa5d23144327216792578e)
• Adds trigger definition to Readme. Removes switch output from invert as that can be defined in the appropriate trigger setting. (https://github.com/mkormendy/homebridge-konnected/commit/d2f62b80d0c27b9a9db41d45f620d8d995216b4a)
• Removes problematic badge for TypeScript in the Readme (wasn't really necessary in the first place). (https://github.com/mkormendy/homebridge-konnected/commit/dab8bc20c6ab7e9182a95cc290326c9cef17fabd)
• Adds response logic to listening server for Konnected panels when they first boot up to get/set initial state of switch/actuators. (https://github.com/mkormendy/homebridge-konnected/commit/25474ddc8f82c59f7c6c9e5c09405e29aff7f8ab)
• Cleans up code and renames variables to be more semantic during the code processing. (https://github.com/mkormendy/homebridge-konnected/commit/27fc0a7f988232a3c64e6b3f81b01e503cc02295)
• Adds actuator/switch trigger logic for provisioning. (https://github.com/mkormendy/homebridge-konnected/commit/8145fa69f00f5b29b23e2f487d3500a96427b6ed)
• Adds switch property to the interface definition of the runtime zone cache. (https://github.com/mkormendy/homebridge-konnected/commit/96fede94000a22f70f7dd4b3b68f2841c275b366)
• Adds trigger property to the interface definition of the runtime zone cache. (https://github.com/mkormendy/homebridge-konnected/commit/609346c5fb587809058ddbdfbcc46208e15621d9)
• Adds actuator/switch trigger value when on in Config UI X schema. (https://github.com/mkormendy/homebridge-konnected/commit/61875a8be68722e341d1be9f683a4522d21e9a3d)

Code cleanup, documentation cleanup, and minor non-showstopper changes.