homeassistant.components.bayesian.binary_sensor Namespace Reference

Classes
class	BayesianBinarySensor

Functions
dict[str, Any]	_above_greater_than_below (dict[str, Any] config)
list[dict]	_no_overlapping (list[dict] configs)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
float	update_probability (float prior, float prob_given_true, float prob_given_false)

Variables
	_LOGGER = logging.getLogger(__name__)
	NUMERIC_STATE_SCHEMA
	PLATFORM_SCHEMA
	STATE_SCHEMA
	TEMPLATE_SCHEMA

Detailed Description

Use Bayesian Inference to trigger a binary sensor.

Function Documentation

_above_greater_than_below()

dict[str, Any] homeassistant.components.bayesian.binary_sensor._above_greater_than_below ( dict[str, Any]  config )

private

Definition at line 71 of file binary_sensor.py.

_no_overlapping()

list[dict] homeassistant.components.bayesian.binary_sensor._no_overlapping ( list[dict]  configs )

private

Definition at line 110 of file binary_sensor.py.

async_setup_platform()

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

Set up the Bayesian Binary sensor.

Definition at line 189 of file binary_sensor.py.

update_probability()

float homeassistant.components.bayesian.binary_sensor.update_probability	(	float	prior,
		float	prob_given_true,
		float	prob_given_false
	)

Update probability using Bayes' rule.

Definition at line 180 of file binary_sensor.py.

Variable Documentation

_LOGGER

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

private

Definition at line 68 of file binary_sensor.py.

NUMERIC_STATE_SCHEMA

homeassistant.components.bayesian.binary_sensor.NUMERIC_STATE_SCHEMA

Initial value:

=  vol.All(
    vol.Schema(
        {
            CONF_PLATFORM: CONF_NUMERIC_STATE,
            vol.Required(CONF_ENTITY_ID): cv.entity_id,
            vol.Optional(CONF_ABOVE): vol.Coerce(float),
            vol.Optional(CONF_BELOW): vol.Coerce(float),
            vol.Required(CONF_P_GIVEN_T): vol.Coerce(float),
            vol.Optional(CONF_P_GIVEN_F): vol.Coerce(float),
        },
        required=True,
    ),
    _above_greater_than_below,
)

Definition at line 94 of file binary_sensor.py.

PLATFORM_SCHEMA

homeassistant.components.bayesian.binary_sensor.PLATFORM_SCHEMA

Initial value:

=  BINARY_SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_UNIQUE_ID): cv.string,
        vol.Optional(CONF_DEVICE_CLASS): cv.string,
        vol.Required(CONF_OBSERVATIONS): vol.Schema(
            vol.All(
                cv.ensure_list,
                [vol.Any(TEMPLATE_SCHEMA, STATE_SCHEMA, NUMERIC_STATE_SCHEMA)],
                _no_overlapping,
            )
        ),
        vol.Required(CONF_PRIOR): vol.Coerce(float),
        vol.Optional(
            CONF_PROBABILITY_THRESHOLD, default=DEFAULT_PROBABILITY_THRESHOLD
        ): vol.Coerce(float),
    }
)

Definition at line 160 of file binary_sensor.py.

STATE_SCHEMA

homeassistant.components.bayesian.binary_sensor.STATE_SCHEMA

Initial value:

=  vol.Schema(
    {
        CONF_PLATFORM: CONF_STATE,
        vol.Required(CONF_ENTITY_ID): cv.entity_id,
        vol.Required(CONF_TO_STATE): cv.string,
        vol.Required(CONF_P_GIVEN_T): vol.Coerce(float),
        vol.Optional(CONF_P_GIVEN_F): vol.Coerce(float),
    },
    required=True,
)

Definition at line 139 of file binary_sensor.py.

TEMPLATE_SCHEMA

homeassistant.components.bayesian.binary_sensor.TEMPLATE_SCHEMA

Initial value:

=  vol.Schema(
    {
        CONF_PLATFORM: CONF_TEMPLATE,
        vol.Required(CONF_VALUE_TEMPLATE): cv.template,
        vol.Required(CONF_P_GIVEN_T): vol.Coerce(float),
        vol.Optional(CONF_P_GIVEN_F): vol.Coerce(float),
    },
    required=True,
)

Definition at line 150 of file binary_sensor.py.