homeassistant.components.firmata Namespace Reference

Namespaces
	binary_sensor
	board
	config_flow
	const
	entity
	light
	pin
	sensor
	switch

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry config_entry)

Variables
	_LOGGER = logging.getLogger(__name__)
	ANALOG_PIN_SCHEMA = vol.All(cv.string, vol.Match(r"^A[0-9]+$"))
	BINARY_SENSOR_SCHEMA
	BOARD_CONFIG_SCHEMA
	CONFIG_SCHEMA
string	DATA_CONFIGS = "board_configs"
	LIGHT_SCHEMA
	SENSOR_SCHEMA
	SWITCH_SCHEMA

Detailed Description

Support for Arduino-compatible Microcontrollers through Firmata.

Function Documentation

async_setup()

bool homeassistant.components.firmata.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the Firmata domain.

Definition at line 126 of file __init__.py.

async_setup_entry()

bool homeassistant.components.firmata.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Set up a Firmata board for a config entry.

Definition at line 161 of file __init__.py.

async_unload_entry()

bool homeassistant.components.firmata.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Shutdown and close a Firmata board for a config entry.

Definition at line 211 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.firmata._LOGGER = logging.getLogger(__name__)

private

Definition at line 46 of file __init__.py.

ANALOG_PIN_SCHEMA

homeassistant.components.firmata.ANALOG_PIN_SCHEMA = vol.All(cv.string, vol.Match(r"^A[0-9]+$"))

Definition at line 50 of file __init__.py.

BINARY_SENSOR_SCHEMA

homeassistant.components.firmata.BINARY_SENSOR_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_NAME): cv.string,
        # Both digital and analog pins may be used as digital input
        vol.Required(CONF_PIN): vol.Any(cv.positive_int, ANALOG_PIN_SCHEMA),
        vol.Required(CONF_PIN_MODE): vol.Any(PIN_MODE_INPUT, PIN_MODE_PULLUP),
        vol.Optional(CONF_NEGATE_STATE, default=False): cv.boolean,
    },
    required=True,
)

Definition at line 77 of file __init__.py.

BOARD_CONFIG_SCHEMA

homeassistant.components.firmata.BOARD_CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_SERIAL_PORT): cv.string,
        vol.Optional(CONF_SERIAL_BAUD_RATE): cv.positive_int,
        vol.Optional(CONF_ARDUINO_INSTANCE_ID): cv.positive_int,
        vol.Optional(CONF_ARDUINO_WAIT): cv.positive_int,
        vol.Optional(CONF_SLEEP_TUNE): vol.All(
            vol.Coerce(float), vol.Range(min=0.0001)
        ),
        vol.Optional(CONF_SAMPLING_INTERVAL): cv.positive_int,
        vol.Optional(CONF_SWITCHES): [SWITCH_SCHEMA],
        vol.Optional(CONF_LIGHTS): [LIGHT_SCHEMA],
        vol.Optional(CONF_BINARY_SENSORS): [BINARY_SENSOR_SCHEMA],
        vol.Optional(CONF_SENSORS): [SENSOR_SCHEMA],
    },
    required=True,
)

Definition at line 103 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.firmata.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {DOMAIN: vol.All(cv.ensure_list, [BOARD_CONFIG_SCHEMA])}, extra=vol.ALLOW_EXTRA
)

Definition at line 121 of file __init__.py.

DATA_CONFIGS

string homeassistant.components.firmata.DATA_CONFIGS = "board_configs"

Definition at line 48 of file __init__.py.

LIGHT_SCHEMA

homeassistant.components.firmata.LIGHT_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_NAME): cv.string,
        # Both digital and analog pins may be used as PWM/analog output
        vol.Required(CONF_PIN): vol.Any(cv.positive_int, ANALOG_PIN_SCHEMA),
        vol.Required(CONF_PIN_MODE): PIN_MODE_PWM,
        vol.Optional(CONF_INITIAL_STATE, default=0): cv.positive_int,
        vol.Optional(CONF_MINIMUM, default=0): cv.positive_int,
        vol.Optional(CONF_MAXIMUM, default=255): cv.positive_int,
    },
    required=True,
)

Definition at line 64 of file __init__.py.

SENSOR_SCHEMA

homeassistant.components.firmata.SENSOR_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_NAME): cv.string,
        # Currently only analog input sensor is implemented
        vol.Required(CONF_PIN): ANALOG_PIN_SCHEMA,
        vol.Required(CONF_PIN_MODE): PIN_MODE_ANALOG,
        # Default differential is 40 to avoid a flood of messages on initial setup
        # in case pin is unplugged. Firmata responds really really fast
        vol.Optional(CONF_DIFFERENTIAL, default=40): vol.All(
            cv.positive_int, vol.Range(min=1)
        ),
    },
    required=True,
)

Definition at line 88 of file __init__.py.

SWITCH_SCHEMA

homeassistant.components.firmata.SWITCH_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_NAME): cv.string,
        # Both digital and analog pins may be used as digital output
        vol.Required(CONF_PIN): vol.Any(cv.positive_int, ANALOG_PIN_SCHEMA),
        vol.Required(CONF_PIN_MODE): PIN_MODE_OUTPUT,
        vol.Optional(CONF_INITIAL_STATE, default=False): cv.boolean,
        vol.Optional(CONF_NEGATE_STATE, default=False): cv.boolean,
    },
    required=True,
)

Definition at line 52 of file __init__.py.