homeassistant.components.group.binary_sensor Namespace Reference

Classes
class	BinarySensorGroup

Functions
BinarySensorGroup	async_create_preview_binary_sensor (HomeAssistant hass, str name, dict[str, Any] validated_config)
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
string	CONF_ALL = "all"
string	DEFAULT_NAME = "Binary Sensor Group"
	PLATFORM_SCHEMA
string	REG_KEY = f"{BINARY_SENSOR_DOMAIN}_registry"

Detailed Description

Platform allowing several binary sensor to be grouped into one binary sensor.

Function Documentation

async_create_preview_binary_sensor()

BinarySensorGroup homeassistant.components.group.binary_sensor.async_create_preview_binary_sensor	(	HomeAssistant	hass,
		str	name,
		dict[str, Any]	validated_config
	)

Create a preview sensor.

Definition at line 92 of file binary_sensor.py.

async_setup_entry()

None homeassistant.components.group.binary_sensor.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Initialize Binary Sensor Group config entry.

Definition at line 70 of file binary_sensor.py.

async_setup_platform()

None homeassistant.components.group.binary_sensor.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the Binary Sensor Group platform.

Definition at line 50 of file binary_sensor.py.

Variable Documentation

CONF_ALL

string homeassistant.components.group.binary_sensor.CONF_ALL = "all"

Definition at line 36 of file binary_sensor.py.

DEFAULT_NAME

string homeassistant.components.group.binary_sensor.DEFAULT_NAME = "Binary Sensor Group"

Definition at line 34 of file binary_sensor.py.

PLATFORM_SCHEMA

homeassistant.components.group.binary_sensor.PLATFORM_SCHEMA

Initial value:

=  BINARY_SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_ENTITIES): cv.entities_domain(BINARY_SENSOR_DOMAIN),
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
        vol.Optional(CONF_DEVICE_CLASS): DEVICE_CLASSES_SCHEMA,
        vol.Optional(CONF_ALL): cv.boolean,
    }
)

Definition at line 39 of file binary_sensor.py.

REG_KEY

string homeassistant.components.group.binary_sensor.REG_KEY = f"{BINARY_SENSOR_DOMAIN}_registry"

Definition at line 37 of file binary_sensor.py.