core/homeassistant/components/tcp/binary_sensor.py

39 lines
1.2 KiB
Python

"""Provides a binary sensor which gets its values from a TCP socket."""
from __future__ import annotations
from typing import Final
from homeassistant.components.binary_sensor import (
PLATFORM_SCHEMA as BINARY_SENSOR_PLATFORM_SCHEMA,
BinarySensorEntity,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
from .common import TCP_PLATFORM_SCHEMA
from .const import CONF_VALUE_ON
from .entity import TcpEntity
PLATFORM_SCHEMA: Final = BINARY_SENSOR_PLATFORM_SCHEMA.extend(TCP_PLATFORM_SCHEMA)
def setup_platform(
hass: HomeAssistant,
config: ConfigType,
add_entities: AddEntitiesCallback,
discovery_info: DiscoveryInfoType | None = None,
) -> None:
"""Set up the TCP binary sensor."""
add_entities([TcpBinarySensor(hass, config)])
class TcpBinarySensor(TcpEntity, BinarySensorEntity):
"""A binary sensor which is on when its state == CONF_VALUE_ON."""
@property
def is_on(self) -> bool:
"""Return true if the binary sensor is on."""
return self._state == self._config[CONF_VALUE_ON]