Skip to content

Latest commit

 

History

History
96 lines (64 loc) · 7.34 KB

README.md

File metadata and controls

96 lines (64 loc) · 7.34 KB
Raw

Konnected for ESPHome

This repository houses the officially supported ESPHome firmware configuration files and recipes for Konnected products. Konnected is a U.S. based maker of IoT hardware and software that integrates traditional wired alarm systems and garage door openers into your smart home.

Quick Start

  1. Get started quickly by flashing your Konnected device with ESPHome firmware using Konnected's web-based tool.
  2. Power on the device.
  3. On your computer or mobile device, connect to the device's captive portal WiFi setup network named "alarm-panel-XXXXXX" or "garage-door-XXXXXX" (depending on the product) where XXXXXX is a unique hexadecimal number. For ethernet devices, plug in the Ethernet cable and skip to step 5.
  4. Select your home WiFi network and enter your WiFi password in the captive portal.
  5. Discover the Konnected device in Home Assistant > Settings > Devices & Services
  6. (Optional) Discover the device and customize the firmware in ESPHome Dashboard (see ESPHome add-on).

Changes and Release Notes

See releases for release notes and downloadable pre-built flashable images.

Made for ESPHome

Konnected's products are made with ESP32 and ESP8266 microcontrollers with integrated USB interfaces, and are completely open to end-user servicing and customization, making them ideal products for ESPHome firmware. Since 2023, Konnected maintains and distributes ESPHome configuration recipies for all products. These firmwares are for Home Assistant users who want a plug-and-play solution. More advanced users can import Konnected's ESPHome configurations into their ESPHome Dashboard and easily customize, build, and update their device(s) with a few simple edits of the well-commented configuration files and packages provided by Konnected.

Works with Home Assistant

Use these ESPHome firmware configurations for easy and plug-and-play setup in Home Assistant that's local, fast, and completely customizable.

In This Repository

This repository houses several complete firmware configuration YAML templates for various Konnected devices at the top level. These are the main firmware templates imported by the dashboard_import feature when used with ESPHome Dashboard.

alarm-panel-pro-esp32.yaml

Konnected's flagship Alarm Panel Pro is an ESP32 powered wired alarm panel with Wifi, Ethernet and PoE.

https://konnected.io/products/konnected-alarm-panel-pro-12-zone-kit

Setup Required:

When using this template, you must make a few configuration choices, detailed below.

  1. WiFi or Ethernet. Under PACKAGES, un-comment either the wifi or ethernet package depending on the desired connection type. Note: Either wifi or ethernet component must be enabled, but both cannot be enabled.
  2. Ethernet type. (If ethernet is selected in the step above) Under GENERAL SETTING > ETHERNET CONFIG uncomment one of the ethernet_type: substitution variables. Choose LAN8720 for the Alarm Panel Pro up to v1.7. Choose RTL8201 for the Alarm Panel Pro v1.8 and above. The hardware version is displayed on the front of the device underneath the logo.

alarm-panel-esp8266.yaml

Konnected's original 6-zone Alarm Panel and Alarm Panel Add-on is a compact WiFi-only modular wired alarm panel, infinitely expandable for any size system.

https://konnected.io/products/konnected-alarm-panel-wired-alarm-system-conversion-kit

This firmware config will also run on a NodeMCU module and Konnected's v1 (2018-2020) Alarm Panel product.

garage-door-esp8266.yaml

A smart garage door opener based on the ESP8266 (model: GDOv1-S).

https://konnected.io/products/smart-garage-door-opener

garage-door-esp32.yaml

An improved smart garage door opener retrofit based on the ESP32-S3-Mini (GDOv2-S).

(coming soon)

Customization

Customize your ESPHome based firmware to your own needs by making simple edits to the firmware configuration file in the ESPHome Dashboard.

Substitution Variables

name

A unique name for this device. If you have multiple Konnected panels, choose a different name for each. The name can only include lowercase letters, numbers, and hyphens.

friendly_name

A human-readable name, for example "Alarm Panel", used to identify the device in Home Assistant front-end. If you have multiple Konnected devices, it's recommended to set a different friendly name for each.

sensor_debounce_time

Sensors use a debouncing filter to prevent transient sensor state changes or flickers from triggering a false sensor event. Default: 200ms

warning_beep_pulse_time

Duration of a warning beep pulse.

warning_beep_pause_time

Quiet pause time between warning beeps.

warning_beep_internal_only

Whether the warning beep entity should be only used internally, or should also be exposed to the API / Home Assistant.

warning_beep_pin

The zone that the piezo buzzer is wired to for warning beep.

Possible values (ESP8266): $zone1 thru $zone5 or $out

Possible values (ESP32): $zone1 thru $zone8 or $alarm1, alarm2, $out1, $out2

Packages

The firmware configuration is organized into packages of functionality for different device features. These are defined in the packages folder of this repository.

Commment-out or remove package lines from this file that you don't want or need. For example, if you do not want a warning beep entity created, comment-out the warning_beep package by putting a # at the front of the line. See Konnected's support pages for more information:

To customize functionality from packages, copy and paste the package contents (from Github) into your device configuration file and comment-out or remove the package import line. Then you can customize the functionality that came from this package for your device.

Get Help

Konnected customers are welcome to contact Konnected Support at help.konnected.io or by email: help@konnected.io for help with your ESPHome firmware on a genuine Konnected device.