boneIO Documentation

Cover Module for controlling up/down roller blinds and venetian blinds with tilt function. It can be used both with a Cover-type device and with a standard relay board.

Web application configuration

Recommended configuration method.

Sample webui configuration

A view allowing for the preview of defined covers, their types, times, and assigned areas.

Areas menu view

Basic Settings

Basic settings view

Option name	Description
Display Name	The name with which the cover will be displayed in the controller's webui, MQTT, and HA.
ID	Technical ID for MQTT topics.
Area	Selection of the appropriate area.
Platform	TIME_BASED and VENETIAN

Platform - You can choose between TIME_BASED and VENETIAN. Different options are available depending on the selection.

Time Based:

Option name	Description
Opening Relay	Selection of the relay used to open the given cover.
Closing Relay	Selection of the relay used to close the given cover.
Opening time	Field allowing for entering the cover's opening time.
Closing time	Field allowing for entering the cover's closing time.

Venetian:

Option name	Description
Opening Relay	Selection of the relay used to open the given cover.
Closing Relay	Selection of the relay used to close the given cover.
Opening time	Field allowing for entering the cover's opening time.
Closing time	Field allowing for entering the cover's closing time.
Tilt Time	Field allowing for entering the cover's tilt time.

Advanced Settings

Advanced settings view

Option name	Description
Device class	The device class visible in HA.
Restore state	After a device restart - restores the previous opening state of the cover.
Show in Home Assistant	Enables autodiscovery and allows it to be shown in HA.

YAML Configuration

Example config

cover:
  - id: Cover08
    platform: time_based
    open_relay: cover_08_up
    close_relay: cover_08_down
    open_time: 30s
    close_time: 30s
    show_in_ha: yes
    restore_state: yes

Time Based configuration variables:

Variable	Required	Type	Default	Description
id	Yes	string	-	Uniquely identifies this device in MQTT and Home Assistant.
platform	Yes	string	-	Platform type: `time_based`
open_relay	Yes	string	-	Relay ID which opens the cover. Must be defined in `output` section.
close_relay	Yes	string	-	Relay ID which closes the cover. Must be defined in `output` section.
open_time	Yes	timeperiod	-	Time to open the cover. Example: `30s`.
close_time	Yes	timeperiod	-	Time to close the cover. Example: `30s`.
device_class	No	string	-	Device class in Home Assistant. Allowed values: `awning`, `blind`, `curtain`, `damper`, `door`, `garage`, `gate`, `shade`, `shutter`, `window`.
show_in_ha	No	boolean	True	Send autodiscovery message to Home Assistant.
restore_state	No	boolean	False	Restore cover state after restart. Saves state in `state.json` file.

Example config

cover:
  - id: Cover07
    platform: venetian
    open_relay: cover_07_up
    close_relay: cover_07_down
    tilt_duration: 1200ms
    open_time: 14s
    close_time: 14s
    show_in_ha: yes
    restore_state: yes

Venetian configuration variables:

Variable	Required	Type	Default	Description
id	Yes	string	-	Uniquely identifies this device in MQTT and Home Assistant.
platform	Yes	string	-	Platform type: `venetian`
open_relay	Yes	string	-	Relay ID which opens the blind. Must be defined in `output` section.
close_relay	Yes	string	-	Relay ID which closes the blind. Must be defined in `output` section.
tilt_duration	Yes	timeperiod	-	Time to tilt the slats. Example: `1200ms`.
open_time	Yes	timeperiod	-	Time to open the blind. Example: `14s`.
close_time	Yes	timeperiod	-	Time to close the blind. Example: `14s`.
device_class	No	string	-	Device class in Home Assistant. Allowed values: `awning`, `blind`, `curtain`, `damper`, `door`, `garage`, `gate`, `shade`, `shutter`, `window`.
show_in_ha	No	boolean	True	Send autodiscovery message to Home Assistant.
restore_state	No	boolean	False	Restore blind state after restart. Saves state in `state.json` file.

Covers