Konnected's new generation device APIs are built on ESPHome
ESPHome is the firmware framework that powers Konnected's newest generation of products and is the underlying platform that serves this API.
ESPHome Overview
ESPHome is a firmware configuration framework that enables device makers, DIYers, and anybody to quickly build powerful IoT devices based on the ESP32 Wi-Fi and Bluetooth SoC by Espressif Systems. Konnected develops, maintains, and distributes open-source ESPHome firmware for all of its products. These firmware configurations are hosted on GitHub at konnected-io/konnected-esphome and are pre-installed on some Konnected devices.
ESPHome Native API vs. Web (REST) API
ESPHome has two distinct APIs, a native API and Web (REST) API. The native API is much more feature-rich, but also much more complex, and is designed for tightly integrated clients that interact directly with all features of ESPHome-based devices. The Web (REST) API, on the other hand, is a simpler auto-generated JSON-based API that is sufficient for basic device integration and control.
This API Reference is based on ESPHome's Web (REST) API and the device-specific endpoints defined by Konnected's firmware builds. Interacting with Konnected devices using the ESPHome Native API is not discussed here.
Customizable (and subject to change)
The open-source and customizable nature of ESPHome means that API endpoints are subject to change if the end-user customizes their device firmware. ESPHome's REST API endpoints are auto-generated based on thedomain and id of exposed components. The entity id in ESPHome's web API is derived from the name of the component, which can be changed by an end-user who customizes and re-builds their firmware (see docs).
The API endpoints documented here are based on Konnected's defaults that are distributed with our pre-built and published firmwares.