Features

UbiHome is built in a modular way. The modules can be split into the following categories:

Components

Make data or actions available in a structured way, for example as sensor, button, switch, or number. Platforms provide the implementation for component behavior.

A component entry is defined under a component key (for example sensor: or switch:), and each entry selects a platform.

All components share a set of common attributes that can be used to customize their behavior.

Entities

Binary Sensor Track on/off states or occupancy.

Button Trigger an action on the device.

Switch Switch something on or off.

Number Set or read numeric values with min/max/step constraints.

Sensor Make data available as a sensor.

Text Sensor Make text values available as a sensor.

Component Features

Actions Trigger actions from state changes. This even works offline!

Filters Modify component values (for example `round`, `delayed_on`).

Platforms

Platforms extend the functionality of UbiHome. They implement how Components interact with the system or connectivity to external systems. Use the built-in platforms to access device sensors (e.g. GPIO), execute commands or create your own component.

GPIO Access and control GPIO pins.

Shell Execute any command when retrieving data or on trigger.

Many more... See the side navigation for more platforms.

Connectivity

Connect with Home Assistant via the native API, use MQTT or the built-in web server (REST API).

Native API Use ESPHome's native API to connect to your device

MQTT Connect to any MQTT broker

MDNS Advertise the device and its services via mDNS

Web Server (REST API) Trigger an action via the web server and its REST API.

HTTP Call any HTTP endpoint to trigger.

platform.