Home Assistant is an open-source home automation platform that you can run yourself on a Raspberry Pi or a spare computer in your home. Home Assistant is an open-source alternative to commercial smart home hubs like SmartThings.
Konnected + Home Assistant Public Beta
Konnected's Home Assistant integration is still under active development! Until the Konnected integration is accepted into a future Home Assistant official release, you must use our fork of the Home Assistant software to participate in the public beta. Our pull request to Home Assistant is open now! Please thumbs-up or make a comment on the PR to encourage acceptance by the Home Assistant core team.
Set up your Home Assistant installation for Konnected
- Read and understand the updating Home Assistant documentation to learn how to update Home Assistant. This article assumes that you already have a working Home Assistant installation or you can install it yourself following Home Assistant's installation instructions.
While in beta, Konnected will not work using the HASS.io containerized installation method. We recommend installing Home Assistant using Hassbian if you're using a Raspberry Pi, as this still allows you to customize the installation source.
- Update your Home Assistant installation to use the
pip3 install --upgrade git+git://github.com/konnected-io/home-assistant.git@konnected
- Edit your Home Assistant
configuration.ymland add a
konnectedsection to configure your Konnected devices and the sensors attached to each zone/pin. The configuration structure looks like this:
konnected: auth_token: insert-a-random-string-here devices: - id: 8bcd53 sensors: - zone: 1 type: door name: 'Front Door' - zone: 3 type: motion name: 'Test Motion' switches: - zone: out name: siren - id: 438a38 sensors: - pin: 1 type: motion name: 'Office Motion' - pin: 2 type: door name: 'Office Door' switches: - pin: 5 name: 'Garage Door' activation: low
The auth_token key can be any random string. This is used to ensure that only those devices which you have configured can authenticate to Home Assistant to change a device state. For security, we recommend using secrets.yml to specify this.
deviceskey under the
konnectedsection represents a list of Konnected devices that you have on your network. Each NodeMCU WiFi module is considered a device.
idis based on the MAC address of the WiFi module with colons/punctuation removed. You can either use the full 12-character (3 byte) MAC address, or just the last 6 characters for brevity. You can find the MAC address when you connect the device to WiFi it's part of the SSID broadcast, or by looking in your router's listing of devices connected to your WiFi.
Nested under the devices list should be a section for sensors and optionally switches.
For sensors, use
zone(for the Konnected branded Alarm Panel hardware) or
pin(for the generic NodeMCU pinout) to specify the sensors connected to each zone/pin. Do NOT use both
pinin the same device configuration. T
ypecan be any of the Binary Sensor types built in to Home Assistant. Name is a descriptive name that you choose that represents your device. Sensors can be attached to zones 1 - 6 on the Konnected branded hardware which correspond to pins D1, D2, D5, D6, D7 and RX respectively on the generic NodeMCU breakout board. Note that when specifying pins, use only the digit. Pin RX is represented as 9.
For switches, use zone or pin similarly to specify the device connected to each. In the case of actuators, a type is not needed, it will show up as a generic on/off switch in Home Assistant. You can also specify an activation key which can be either "low" or "high" (or 0 or 1) to specify the activation state of the attached device (default is high). On the Konnected branded boards, use zone: out to represent the dedicated siren output or OUT terminal. On the generic NodeMCU board, pins D1, D2, D5, D6, D7 and D8 are usable as actuators.
Ensure that your Konnected devices are connected to your WiFi network and restart Home Assistant. Within a minute or two Home Assistant should discover your devices on the network and automatically sync your configuration settings from Home Assistant to the Konnected device. Your configured sensors should appear automatically on the Home Assistant dashboard. After the initial sync, the Konnected device will instantly update Home Assistant any time the sensor status changes!
Known Issues and Limitations
- Version 2.1.1 or newer of the Konnected device software is required for Home Assistant discovery to work.
Feedback & Questions
Open Source Contributions
We welcome open source contributions from developers like you! If you're interested in helping with the Konnected Home Assistant integration, feel free to dive into the code and submit a pull request or contact us first for guidance and ideas of what to work on. Notable contributions will be rewarded with free Konnected swag, hardware, and/or public praise!
- Konnected's Home Assistant fork -- active development here
- Konnected Python library
- Konnected NodeMCU software
Next Step: Overview Video of the Hardware Installation