homeassistant.components.flic.binary_sensor Namespace Reference

Classes
class	FlicButton

Functions
None	setup_button (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, client, address)
None	setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)
def	start_scanning (config, add_entities, client)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CLICK_TYPE_DOUBLE = "double"
string	CLICK_TYPE_HOLD = "hold"
string	CLICK_TYPE_SINGLE = "single"
list	CLICK_TYPES = [CLICK_TYPE_SINGLE, CLICK_TYPE_DOUBLE, CLICK_TYPE_HOLD]
string	CONF_IGNORED_CLICK_TYPES = "ignored_click_types"
string	DEFAULT_HOST = "localhost"
int	DEFAULT_PORT = 5551
int	DEFAULT_TIMEOUT = 3
string	EVENT_DATA_ADDRESS = "button_address"
string	EVENT_DATA_NAME = "button_name"
string	EVENT_DATA_QUEUED_TIME = "queued_time"
string	EVENT_DATA_TYPE = "click_type"
string	EVENT_NAME = "flic_click"
	PLATFORM_SCHEMA

Detailed Description

Support to use flic buttons as a binary sensor.

Function Documentation

setup_button()

None homeassistant.components.flic.binary_sensor.setup_button	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
			client,
			address
	)

Set up a single button device.

Definition at line 124 of file binary_sensor.py.

setup_platform()

None homeassistant.components.flic.binary_sensor.setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the flic platform.

Definition at line 61 of file binary_sensor.py.

start_scanning()

def homeassistant.components.flic.binary_sensor.start_scanning	(		config,
			add_entities,
			client
	)

Start a new flic client for scanning and connecting to new buttons.

Definition at line 104 of file binary_sensor.py.

Variable Documentation

_LOGGER

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

private

Definition at line 28 of file binary_sensor.py.

CLICK_TYPE_DOUBLE

string homeassistant.components.flic.binary_sensor.CLICK_TYPE_DOUBLE = "double"

Definition at line 33 of file binary_sensor.py.

CLICK_TYPE_HOLD

string homeassistant.components.flic.binary_sensor.CLICK_TYPE_HOLD = "hold"

Definition at line 34 of file binary_sensor.py.

CLICK_TYPE_SINGLE

string homeassistant.components.flic.binary_sensor.CLICK_TYPE_SINGLE = "single"

Definition at line 32 of file binary_sensor.py.

CLICK_TYPES

list homeassistant.components.flic.binary_sensor.CLICK_TYPES = [CLICK_TYPE_SINGLE, CLICK_TYPE_DOUBLE, CLICK_TYPE_HOLD]

Definition at line 35 of file binary_sensor.py.

CONF_IGNORED_CLICK_TYPES

string homeassistant.components.flic.binary_sensor.CONF_IGNORED_CLICK_TYPES = "ignored_click_types"

Definition at line 37 of file binary_sensor.py.

DEFAULT_HOST

string homeassistant.components.flic.binary_sensor.DEFAULT_HOST = "localhost"

Definition at line 39 of file binary_sensor.py.

DEFAULT_PORT

int homeassistant.components.flic.binary_sensor.DEFAULT_PORT = 5551

Definition at line 40 of file binary_sensor.py.

DEFAULT_TIMEOUT

int homeassistant.components.flic.binary_sensor.DEFAULT_TIMEOUT = 3

Definition at line 30 of file binary_sensor.py.

EVENT_DATA_ADDRESS

string homeassistant.components.flic.binary_sensor.EVENT_DATA_ADDRESS = "button_address"

Definition at line 44 of file binary_sensor.py.

EVENT_DATA_NAME

string homeassistant.components.flic.binary_sensor.EVENT_DATA_NAME = "button_name"

Definition at line 43 of file binary_sensor.py.

EVENT_DATA_QUEUED_TIME

string homeassistant.components.flic.binary_sensor.EVENT_DATA_QUEUED_TIME = "queued_time"

Definition at line 46 of file binary_sensor.py.

EVENT_DATA_TYPE

string homeassistant.components.flic.binary_sensor.EVENT_DATA_TYPE = "click_type"

Definition at line 45 of file binary_sensor.py.

EVENT_NAME

string homeassistant.components.flic.binary_sensor.EVENT_NAME = "flic_click"

Definition at line 42 of file binary_sensor.py.

PLATFORM_SCHEMA

homeassistant.components.flic.binary_sensor.PLATFORM_SCHEMA

Initial value:

=  BINARY_SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string,
        vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
        vol.Optional(CONF_DISCOVERY, default=True): cv.boolean,
        vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
        vol.Optional(CONF_IGNORED_CLICK_TYPES): vol.All(
            cv.ensure_list, [vol.In(CLICK_TYPES)]
        ),
    }
)

Definition at line 48 of file binary_sensor.py.