v1.0.1

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:

1. Shut down Homebridge.
2. Close down your HomeKit app on your phone or desktop.
3. Delete the cachedAccessories file.
4. Launch Homebridge.
5. 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.
6. Save the settings in Config UI X to rebuild the config.json file.
7. 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. (955be4a)
• Fixes triggerable modes option in the example config.json in the README file. (c222f29)
• Merge branch 'master' of https://github.com/konnected-io/homebridge-konnected (b019d69)
• Rename on_pullRequest.yml to on_push-pullRequest.yml (c380af8)
• Update on_pullRequest.yml (ecf83ce)
• Updates the README with instructions and details for the new features in the latest update. (ac78207)
• Refactors, updates, adds, removes features, process, and logic required to provide a security system in HomeKit with Homebridge, this plugin and Konnected Alarm Panels. (7f370ae)
• Updates the interfaces for the different types common for this plugin's objects. (fe1c18e)
• Updates and refactors the constants based on changes in the main platform and platform accessory files. (6bb0018)
• Updates the npm package dependencies for this plugin. (cd4c252)
• Updates the Config UI X form schema.json file to include options for the new security system to operate beepers, sirens, and sensors. (5c8f195)
• Adds git documenting to the VS Code workspace settings. (13a7757)
• Adds warnings tracing to the node monitor config. (37e54a0)
• Updates debugging console to use an external terminal for multi-screen dev environments. (e030717)
• Updates TypeScript configuration. (e0c5ffb)
• Update and rename build.yml to on_pullRequest.yml (7485262)

v0.1.2-beta

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.

v0.1.2

Changelog:

• Adds items to the Upcoming Features section and cleans up expectation for HOOBS in the future. (fea06d6)
• Example cleanup. (b6ccf08)
• Adds trigger definition to Readme. Removes switch output from invert as that can be defined in the appropriate trigger setting. (d2f62b8)
• Removes problematic badge for TypeScript in the Readme (wasn't really necessary in the first place). (dab8bc2)
• Adds response logic to listening server for Konnected panels when they first boot up to get/set initial state of switch/actuators. (25474dd)
• Cleans up code and renames variables to be more semantic during the code processing. (27fc0a7)
• Adds actuator/switch trigger logic for provisioning. (8145fa6)
• Adds switch property to the interface definition of the runtime zone cache. (96fede9)
• Adds trigger property to the interface definition of the runtime zone cache. (609346c)
• Adds actuator/switch trigger value when on in Config UI X schema. (61875a8)

v0.1.1-beta

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

v0.1.0-beta

This release contains continued work that orchestrates the registration of V1/V2 and Pro Konnected zones to HomeKit accessories.
Notable functionality:

• Sensor support all available sensors provided by Konnected currently.
• Actuators, both stateful and momentary.
• Ability to remove, rename, add, and update zones as needed.
• Hints and Config UI X interface updates to make it easier to provision panels.

Caveat functionality:

• Upon Homebridge startup, the state of a sensor or switch is defaulted to 0 or false (closed state for most sensors or a temperature/humidity value of 0, and actuator states of 0). Don't be alarmed! (pun intended 😉) Closing the Home app on your iPhone/iPad and re-opening it will trigger an update for active states as they are updated by the Konnected alarm panel.
• HOOBS functionality is spotty and still UNSUPPORTED. While the plugin appears to work in HOOBS, the configuration is a painful process. Fortunately we've been in touch with the developers working on the HOOBS web interface. They are planning to release a major version with new functionality and have incorporated our feedback on the configuration UI aspect. If you are a HOOBS user, keep an eye out for a release in the future which should have some parity with the configuration UI similar to what Homebridge users experience using the Config UI X plugin.

Things on the roadmap that are being worked on:

• A proper alarm switch and controller in HomeKit.
• Research into providing Home/Stay/Night modes and selecting zones that are active in each (E.g., only perimeter sensors trigger at night).
• Ability to invert the sensor state for sensors that operate inversely.
• Noonlight integration for 24/7 smart home monitoring.

Plugin Support: https://help.konnected.io/discussions/forums/32000043024

v0.0.5-alpha

This release contains continued work that orchestrates the registration of V1/V2 and Pro Konnected zones to HomeKit accessories.
Notable functionality:

• Panels can be discovered and provisioned.
• Panels are now populated in the Homebridge config.json based on their discovery.
• Config UI X has an interface that can add and assign* the zones which show up in HomeKit.

*Caveat functionality:

• Zones can only be assigned as Contact Sensors.
• Added a warning in the logs when a Konnected panel has been registered with Konnected Cloud - by virtue, a Homebridge plugin will likely never support this.
• If you add a zone and then change it to another zone, the original zone will persist (this will be fixed in the next release).

Things that still are not available:

• All other zone types are not available to be assigned to a zone (coming in next release).
• An alarm controller in HomeKit.