homeassistant.components.tod.binary_sensor Namespace Reference

Classes
class	TodSensor

Functions
TypeGuard[SunEventType]	_is_sun_event (time|SunEventType sun_event)
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
	_LOGGER = logging.getLogger(__name__)
string	ATTR_AFTER = "after"
string	ATTR_BEFORE = "before"
string	ATTR_NEXT_UPDATE = "next_update"
	PLATFORM_SCHEMA
	SunEventType

Detailed Description

Support for representing current time of the day as binary sensors.

Function Documentation

_is_sun_event()

TypeGuard[SunEventType] homeassistant.components.tod.binary_sensor._is_sun_event ( time | SunEventType  sun_event )

private

Return true if event is sun event not time.

Definition at line 103 of file binary_sensor.py.

async_setup_entry()

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

Initialize Times of the Day config entry.

Definition at line 59 of file binary_sensor.py.

async_setup_platform()

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

Set up the ToD sensors.

Definition at line 81 of file binary_sensor.py.

Variable Documentation

_LOGGER

homeassistant.components.tod.binary_sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 41 of file binary_sensor.py.

ATTR_AFTER

string homeassistant.components.tod.binary_sensor.ATTR_AFTER = "after"

Definition at line 43 of file binary_sensor.py.

ATTR_BEFORE

string homeassistant.components.tod.binary_sensor.ATTR_BEFORE = "before"

Definition at line 44 of file binary_sensor.py.

ATTR_NEXT_UPDATE

string homeassistant.components.tod.binary_sensor.ATTR_NEXT_UPDATE = "next_update"

Definition at line 45 of file binary_sensor.py.

PLATFORM_SCHEMA

homeassistant.components.tod.binary_sensor.PLATFORM_SCHEMA

Initial value:

=  BINARY_SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_AFTER): vol.Any(cv.time, vol.All(vol.Lower, cv.sun_event)),
        vol.Required(CONF_BEFORE): vol.Any(cv.time, vol.All(vol.Lower, cv.sun_event)),
        vol.Required(CONF_NAME): cv.string,
        vol.Optional(CONF_AFTER_OFFSET, default=timedelta(0)): cv.time_period,
        vol.Optional(CONF_BEFORE_OFFSET, default=timedelta(0)): cv.time_period,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
    }
)

Definition at line 47 of file binary_sensor.py.

SunEventType

homeassistant.components.tod.binary_sensor.SunEventType

Definition at line 39 of file binary_sensor.py.