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 (as entity), for example as sensor, button, switch, or number. Platforms provide the implementation for a components behavior.

# A component entry is defined under a component key, e.g. switch or
sensor:
  # Each entry selects a platform:
  - platform: <selected platform>
    name: Test Entity

All components share a set of common attributes that can be used to customize their behavior. They also provide common triggers and actions.

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 and Connectivity

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

Platforms

Connectivity