mirror of
https://github.com/esphome/esphome.git
synced 2025-11-09 10:58:46 +00:00
452 lines
16 KiB
Python
452 lines
16 KiB
Python
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
import logging
|
|
|
|
from esphome import automation
|
|
import esphome.codegen as cg
|
|
from esphome.components import esp32_ble
|
|
from esphome.components.esp32 import add_idf_sdkconfig_option
|
|
from esphome.components.esp32_ble import (
|
|
IDF_MAX_CONNECTIONS,
|
|
BTLoggers,
|
|
bt_uuid,
|
|
bt_uuid16_format,
|
|
bt_uuid32_format,
|
|
bt_uuid128_format,
|
|
)
|
|
import esphome.config_validation as cv
|
|
from esphome.const import (
|
|
CONF_ACTIVE,
|
|
CONF_CONTINUOUS,
|
|
CONF_DURATION,
|
|
CONF_ID,
|
|
CONF_INTERVAL,
|
|
CONF_MAC_ADDRESS,
|
|
CONF_MANUFACTURER_ID,
|
|
CONF_MAX_CONNECTIONS,
|
|
CONF_ON_BLE_ADVERTISE,
|
|
CONF_ON_BLE_MANUFACTURER_DATA_ADVERTISE,
|
|
CONF_ON_BLE_SERVICE_DATA_ADVERTISE,
|
|
CONF_SERVICE_UUID,
|
|
CONF_TRIGGER_ID,
|
|
)
|
|
from esphome.core import CORE, CoroPriority, coroutine_with_priority
|
|
from esphome.enum import StrEnum
|
|
from esphome.types import ConfigType
|
|
|
|
AUTO_LOAD = ["esp32_ble"]
|
|
DEPENDENCIES = ["esp32"]
|
|
CODEOWNERS = ["@bdraco"]
|
|
|
|
CONF_ESP32_BLE_ID = "esp32_ble_id"
|
|
CONF_SCAN_PARAMETERS = "scan_parameters"
|
|
CONF_WINDOW = "window"
|
|
CONF_ON_SCAN_END = "on_scan_end"
|
|
CONF_SOFTWARE_COEXISTENCE = "software_coexistence"
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
# Enum for BLE features
|
|
class BLEFeatures(StrEnum):
|
|
ESP_BT_DEVICE = "ESP_BT_DEVICE"
|
|
|
|
|
|
# Dataclass for registration counts
|
|
@dataclass
|
|
class RegistrationCounts:
|
|
listeners: int = 0
|
|
clients: int = 0
|
|
|
|
|
|
# CORE.data keys for state management
|
|
ESP32_BLE_TRACKER_REQUIRED_FEATURES_KEY = "esp32_ble_tracker_required_features"
|
|
ESP32_BLE_TRACKER_REGISTRATION_COUNTS_KEY = "esp32_ble_tracker_registration_counts"
|
|
|
|
|
|
def _get_required_features() -> set[BLEFeatures]:
|
|
"""Get the set of required BLE features from CORE.data."""
|
|
return CORE.data.setdefault(ESP32_BLE_TRACKER_REQUIRED_FEATURES_KEY, set())
|
|
|
|
|
|
def _get_registration_counts() -> RegistrationCounts:
|
|
"""Get the registration counts from CORE.data."""
|
|
return CORE.data.setdefault(
|
|
ESP32_BLE_TRACKER_REGISTRATION_COUNTS_KEY, RegistrationCounts()
|
|
)
|
|
|
|
|
|
def register_ble_features(features: set[BLEFeatures]) -> None:
|
|
"""Register BLE features that a component needs.
|
|
|
|
Args:
|
|
features: Set of BLEFeatures enum members
|
|
"""
|
|
_get_required_features().update(features)
|
|
|
|
|
|
esp32_ble_tracker_ns = cg.esphome_ns.namespace("esp32_ble_tracker")
|
|
ESP32BLETracker = esp32_ble_tracker_ns.class_(
|
|
"ESP32BLETracker",
|
|
cg.Component,
|
|
esp32_ble.GAPEventHandler,
|
|
esp32_ble.GATTcEventHandler,
|
|
cg.Parented.template(esp32_ble.ESP32BLE),
|
|
)
|
|
ESPBTClient = esp32_ble_tracker_ns.class_("ESPBTClient")
|
|
ESPBTDeviceListener = esp32_ble_tracker_ns.class_("ESPBTDeviceListener")
|
|
ESPBTDevice = esp32_ble_tracker_ns.class_("ESPBTDevice")
|
|
ESPBTDeviceConstRef = ESPBTDevice.operator("ref").operator("const")
|
|
adv_data_t = cg.std_vector.template(cg.uint8)
|
|
adv_data_t_const_ref = adv_data_t.operator("ref").operator("const")
|
|
# Triggers
|
|
ESPBTAdvertiseTrigger = esp32_ble_tracker_ns.class_(
|
|
"ESPBTAdvertiseTrigger", automation.Trigger.template(ESPBTDeviceConstRef)
|
|
)
|
|
BLEServiceDataAdvertiseTrigger = esp32_ble_tracker_ns.class_(
|
|
"BLEServiceDataAdvertiseTrigger", automation.Trigger.template(adv_data_t_const_ref)
|
|
)
|
|
BLEManufacturerDataAdvertiseTrigger = esp32_ble_tracker_ns.class_(
|
|
"BLEManufacturerDataAdvertiseTrigger",
|
|
automation.Trigger.template(adv_data_t_const_ref),
|
|
)
|
|
BLEEndOfScanTrigger = esp32_ble_tracker_ns.class_(
|
|
"BLEEndOfScanTrigger", automation.Trigger.template()
|
|
)
|
|
# Actions
|
|
ESP32BLEStartScanAction = esp32_ble_tracker_ns.class_(
|
|
"ESP32BLEStartScanAction", automation.Action
|
|
)
|
|
ESP32BLEStopScanAction = esp32_ble_tracker_ns.class_(
|
|
"ESP32BLEStopScanAction", automation.Action
|
|
)
|
|
|
|
|
|
def validate_scan_parameters(config):
|
|
duration = config[CONF_DURATION]
|
|
interval = config[CONF_INTERVAL]
|
|
window = config[CONF_WINDOW]
|
|
|
|
if window > interval:
|
|
raise cv.Invalid(
|
|
f"Scan window ({window}) needs to be smaller than scan interval ({interval})"
|
|
)
|
|
|
|
if interval.total_milliseconds * 3 > duration.total_milliseconds:
|
|
raise cv.Invalid(
|
|
"Scan duration needs to be at least three times the scan interval to"
|
|
"cover all BLE channels."
|
|
)
|
|
|
|
return config
|
|
|
|
|
|
def validate_max_connections_deprecated(config: ConfigType) -> ConfigType:
|
|
if CONF_MAX_CONNECTIONS in config:
|
|
_LOGGER.warning(
|
|
"The 'max_connections' option in 'esp32_ble_tracker' is deprecated. "
|
|
"Please move it to the 'esp32_ble' component instead."
|
|
)
|
|
return config
|
|
|
|
|
|
def as_hex(value):
|
|
return cg.RawExpression(f"0x{value}ULL")
|
|
|
|
|
|
def as_hex_array(value):
|
|
value = value.replace("-", "")
|
|
cpp_array = [
|
|
f"0x{part}" for part in [value[i : i + 2] for i in range(0, len(value), 2)]
|
|
]
|
|
return cg.RawExpression(f"(uint8_t*)(const uint8_t[16]){{{','.join(cpp_array)}}}")
|
|
|
|
|
|
def as_reversed_hex_array(value):
|
|
value = value.replace("-", "")
|
|
cpp_array = [
|
|
f"0x{part}" for part in [value[i : i + 2] for i in range(0, len(value), 2)]
|
|
]
|
|
return cg.RawExpression(
|
|
f"(uint8_t*)(const uint8_t[16]){{{','.join(reversed(cpp_array))}}}"
|
|
)
|
|
|
|
|
|
CONFIG_SCHEMA = cv.All(
|
|
cv.Schema(
|
|
{
|
|
cv.GenerateID(): cv.declare_id(ESP32BLETracker),
|
|
cv.GenerateID(esp32_ble.CONF_BLE_ID): cv.use_id(esp32_ble.ESP32BLE),
|
|
cv.Optional(CONF_MAX_CONNECTIONS): cv.All(
|
|
cv.positive_int, cv.Range(min=0, max=IDF_MAX_CONNECTIONS)
|
|
),
|
|
cv.Optional(CONF_SCAN_PARAMETERS, default={}): cv.All(
|
|
cv.Schema(
|
|
{
|
|
cv.Optional(
|
|
CONF_DURATION, default="5min"
|
|
): cv.positive_time_period_seconds,
|
|
cv.Optional(
|
|
CONF_INTERVAL, default="320ms"
|
|
): cv.positive_time_period_milliseconds,
|
|
cv.Optional(
|
|
CONF_WINDOW, default="30ms"
|
|
): cv.positive_time_period_milliseconds,
|
|
cv.Optional(CONF_ACTIVE, default=True): cv.boolean,
|
|
cv.Optional(CONF_CONTINUOUS, default=True): cv.boolean,
|
|
}
|
|
),
|
|
validate_scan_parameters,
|
|
),
|
|
cv.Optional(CONF_ON_BLE_ADVERTISE): automation.validate_automation(
|
|
{
|
|
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(
|
|
ESPBTAdvertiseTrigger
|
|
),
|
|
cv.Optional(CONF_MAC_ADDRESS): cv.ensure_list(cv.mac_address),
|
|
}
|
|
),
|
|
cv.Optional(
|
|
CONF_ON_BLE_SERVICE_DATA_ADVERTISE
|
|
): automation.validate_automation(
|
|
{
|
|
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(
|
|
BLEServiceDataAdvertiseTrigger
|
|
),
|
|
cv.Optional(CONF_MAC_ADDRESS): cv.mac_address,
|
|
cv.Required(CONF_SERVICE_UUID): bt_uuid,
|
|
}
|
|
),
|
|
cv.Optional(
|
|
CONF_ON_BLE_MANUFACTURER_DATA_ADVERTISE
|
|
): automation.validate_automation(
|
|
{
|
|
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(
|
|
BLEManufacturerDataAdvertiseTrigger
|
|
),
|
|
cv.Optional(CONF_MAC_ADDRESS): cv.mac_address,
|
|
cv.Required(CONF_MANUFACTURER_ID): bt_uuid,
|
|
}
|
|
),
|
|
cv.Optional(CONF_ON_SCAN_END): automation.validate_automation(
|
|
{cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(BLEEndOfScanTrigger)}
|
|
),
|
|
cv.OnlyWith(CONF_SOFTWARE_COEXISTENCE, "wifi", default=True): bool,
|
|
}
|
|
).extend(cv.COMPONENT_SCHEMA),
|
|
validate_max_connections_deprecated,
|
|
)
|
|
|
|
|
|
FINAL_VALIDATE_SCHEMA = esp32_ble.validate_variant
|
|
|
|
ESP_BLE_DEVICE_SCHEMA = cv.Schema(
|
|
{
|
|
cv.GenerateID(CONF_ESP32_BLE_ID): cv.use_id(ESP32BLETracker),
|
|
}
|
|
)
|
|
|
|
|
|
async def to_code(config):
|
|
# Register the loggers this component needs
|
|
esp32_ble.register_bt_logger(BTLoggers.BLE_SCAN)
|
|
|
|
var = cg.new_Pvariable(config[CONF_ID])
|
|
await cg.register_component(var, config)
|
|
|
|
parent = await cg.get_variable(config[esp32_ble.CONF_BLE_ID])
|
|
esp32_ble.register_gap_event_handler(parent, var)
|
|
esp32_ble.register_gap_scan_event_handler(parent, var)
|
|
esp32_ble.register_gattc_event_handler(parent, var)
|
|
esp32_ble.register_ble_status_event_handler(parent, var)
|
|
cg.add(var.set_parent(parent))
|
|
|
|
params = config[CONF_SCAN_PARAMETERS]
|
|
cg.add(var.set_scan_duration(params[CONF_DURATION]))
|
|
cg.add(var.set_scan_interval(int(params[CONF_INTERVAL].total_milliseconds / 0.625)))
|
|
cg.add(var.set_scan_window(int(params[CONF_WINDOW].total_milliseconds / 0.625)))
|
|
cg.add(var.set_scan_active(params[CONF_ACTIVE]))
|
|
cg.add(var.set_scan_continuous(params[CONF_CONTINUOUS]))
|
|
|
|
# Register ESP_BT_DEVICE feature if any of the automation triggers are used
|
|
if (
|
|
config.get(CONF_ON_BLE_ADVERTISE)
|
|
or config.get(CONF_ON_BLE_SERVICE_DATA_ADVERTISE)
|
|
or config.get(CONF_ON_BLE_MANUFACTURER_DATA_ADVERTISE)
|
|
):
|
|
register_ble_features({BLEFeatures.ESP_BT_DEVICE})
|
|
|
|
registration_counts = _get_registration_counts()
|
|
|
|
for conf in config.get(CONF_ON_BLE_ADVERTISE, []):
|
|
registration_counts.listeners += 1
|
|
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
|
|
if CONF_MAC_ADDRESS in conf:
|
|
addr_list = [it.as_hex for it in conf[CONF_MAC_ADDRESS]]
|
|
cg.add(trigger.set_addresses(addr_list))
|
|
await automation.build_automation(trigger, [(ESPBTDeviceConstRef, "x")], conf)
|
|
for conf in config.get(CONF_ON_BLE_SERVICE_DATA_ADVERTISE, []):
|
|
registration_counts.listeners += 1
|
|
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
|
|
if len(conf[CONF_SERVICE_UUID]) == len(bt_uuid16_format):
|
|
cg.add(trigger.set_service_uuid16(as_hex(conf[CONF_SERVICE_UUID])))
|
|
elif len(conf[CONF_SERVICE_UUID]) == len(bt_uuid32_format):
|
|
cg.add(trigger.set_service_uuid32(as_hex(conf[CONF_SERVICE_UUID])))
|
|
elif len(conf[CONF_SERVICE_UUID]) == len(bt_uuid128_format):
|
|
uuid128 = as_reversed_hex_array(conf[CONF_SERVICE_UUID])
|
|
cg.add(trigger.set_service_uuid128(uuid128))
|
|
if CONF_MAC_ADDRESS in conf:
|
|
cg.add(trigger.set_address(conf[CONF_MAC_ADDRESS].as_hex))
|
|
await automation.build_automation(trigger, [(adv_data_t_const_ref, "x")], conf)
|
|
for conf in config.get(CONF_ON_BLE_MANUFACTURER_DATA_ADVERTISE, []):
|
|
registration_counts.listeners += 1
|
|
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
|
|
if len(conf[CONF_MANUFACTURER_ID]) == len(bt_uuid16_format):
|
|
cg.add(trigger.set_manufacturer_uuid16(as_hex(conf[CONF_MANUFACTURER_ID])))
|
|
elif len(conf[CONF_MANUFACTURER_ID]) == len(bt_uuid32_format):
|
|
cg.add(trigger.set_manufacturer_uuid32(as_hex(conf[CONF_MANUFACTURER_ID])))
|
|
elif len(conf[CONF_MANUFACTURER_ID]) == len(bt_uuid128_format):
|
|
uuid128 = as_reversed_hex_array(conf[CONF_MANUFACTURER_ID])
|
|
cg.add(trigger.set_manufacturer_uuid128(uuid128))
|
|
if CONF_MAC_ADDRESS in conf:
|
|
cg.add(trigger.set_address(conf[CONF_MAC_ADDRESS].as_hex))
|
|
await automation.build_automation(trigger, [(adv_data_t_const_ref, "x")], conf)
|
|
for conf in config.get(CONF_ON_SCAN_END, []):
|
|
registration_counts.listeners += 1
|
|
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
|
|
await automation.build_automation(trigger, [], conf)
|
|
|
|
add_idf_sdkconfig_option("CONFIG_BT_ENABLED", True)
|
|
if config.get(CONF_SOFTWARE_COEXISTENCE):
|
|
add_idf_sdkconfig_option("CONFIG_SW_COEXIST_ENABLE", True)
|
|
# https://github.com/espressif/esp-idf/issues/4101
|
|
# https://github.com/espressif/esp-idf/issues/2503
|
|
# Match arduino CONFIG_BTU_TASK_STACK_SIZE
|
|
# https://github.com/espressif/arduino-esp32/blob/fd72cf46ad6fc1a6de99c1d83ba8eba17d80a4ee/tools/sdk/esp32/sdkconfig#L1866
|
|
add_idf_sdkconfig_option("CONFIG_BT_BTU_TASK_STACK_SIZE", 8192)
|
|
# Note: CONFIG_BT_ACL_CONNECTIONS and CONFIG_BTDM_CTRL_BLE_MAX_CONN are now
|
|
# configured in esp32_ble component based on max_connections setting
|
|
|
|
cg.add_define("USE_OTA_STATE_CALLBACK") # To be notified when an OTA update starts
|
|
cg.add_define("USE_ESP32_BLE_CLIENT")
|
|
|
|
CORE.add_job(_add_ble_features)
|
|
|
|
if config.get(CONF_SOFTWARE_COEXISTENCE):
|
|
cg.add_define("USE_ESP32_BLE_SOFTWARE_COEXISTENCE")
|
|
|
|
|
|
# This needs to be run as a job with very low priority so that all components have
|
|
# chance to call register_ble_tracker and register_client before the list is checked
|
|
# and added to the global defines list.
|
|
@coroutine_with_priority(CoroPriority.FINAL)
|
|
async def _add_ble_features():
|
|
# Add feature-specific defines based on what's needed
|
|
required_features = _get_required_features()
|
|
if BLEFeatures.ESP_BT_DEVICE in required_features:
|
|
cg.add_define("USE_ESP32_BLE_DEVICE")
|
|
cg.add_define("USE_ESP32_BLE_UUID")
|
|
|
|
# Add defines for StaticVector sizing based on registration counts
|
|
# Only define if count > 0 to avoid allocating unnecessary memory
|
|
registration_counts = _get_registration_counts()
|
|
if registration_counts.listeners > 0:
|
|
cg.add_define(
|
|
"ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT", registration_counts.listeners
|
|
)
|
|
if registration_counts.clients > 0:
|
|
cg.add_define(
|
|
"ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT", registration_counts.clients
|
|
)
|
|
|
|
|
|
ESP32_BLE_START_SCAN_ACTION_SCHEMA = cv.Schema(
|
|
{
|
|
cv.GenerateID(): cv.use_id(ESP32BLETracker),
|
|
cv.Optional(CONF_CONTINUOUS, default=False): cv.templatable(cv.boolean),
|
|
}
|
|
)
|
|
|
|
|
|
@automation.register_action(
|
|
"esp32_ble_tracker.start_scan",
|
|
ESP32BLEStartScanAction,
|
|
ESP32_BLE_START_SCAN_ACTION_SCHEMA,
|
|
)
|
|
async def esp32_ble_tracker_start_scan_action_to_code(
|
|
config, action_id, template_arg, args
|
|
):
|
|
paren = await cg.get_variable(config[CONF_ID])
|
|
var = cg.new_Pvariable(action_id, template_arg, paren)
|
|
cg.add(var.set_continuous(config[CONF_CONTINUOUS]))
|
|
return var
|
|
|
|
|
|
ESP32_BLE_STOP_SCAN_ACTION_SCHEMA = automation.maybe_simple_id(
|
|
cv.Schema(
|
|
{
|
|
cv.GenerateID(): cv.use_id(ESP32BLETracker),
|
|
}
|
|
)
|
|
)
|
|
|
|
|
|
@automation.register_action(
|
|
"esp32_ble_tracker.stop_scan",
|
|
ESP32BLEStopScanAction,
|
|
ESP32_BLE_STOP_SCAN_ACTION_SCHEMA,
|
|
)
|
|
async def esp32_ble_tracker_stop_scan_action_to_code(
|
|
config, action_id, template_arg, args
|
|
):
|
|
var = cg.new_Pvariable(action_id, template_arg)
|
|
await cg.register_parented(var, config[CONF_ID])
|
|
return var
|
|
|
|
|
|
async def register_ble_device(
|
|
var: cg.SafeExpType, config: ConfigType
|
|
) -> cg.SafeExpType:
|
|
register_ble_features({BLEFeatures.ESP_BT_DEVICE})
|
|
_get_registration_counts().listeners += 1
|
|
paren = await cg.get_variable(config[CONF_ESP32_BLE_ID])
|
|
cg.add(paren.register_listener(var))
|
|
return var
|
|
|
|
|
|
async def register_client(var: cg.SafeExpType, config: ConfigType) -> cg.SafeExpType:
|
|
register_ble_features({BLEFeatures.ESP_BT_DEVICE})
|
|
_get_registration_counts().clients += 1
|
|
paren = await cg.get_variable(config[CONF_ESP32_BLE_ID])
|
|
cg.add(paren.register_client(var))
|
|
return var
|
|
|
|
|
|
async def register_raw_ble_device(
|
|
var: cg.SafeExpType, config: ConfigType
|
|
) -> cg.SafeExpType:
|
|
"""Register a BLE device listener that only needs raw advertisement data.
|
|
|
|
This does NOT register the ESP_BT_DEVICE feature, meaning ESPBTDevice
|
|
will not be compiled in if this is the only registration method used.
|
|
"""
|
|
_get_registration_counts().listeners += 1
|
|
paren = await cg.get_variable(config[CONF_ESP32_BLE_ID])
|
|
cg.add(paren.register_listener(var))
|
|
return var
|
|
|
|
|
|
async def register_raw_client(
|
|
var: cg.SafeExpType, config: ConfigType
|
|
) -> cg.SafeExpType:
|
|
"""Register a BLE client that only needs raw advertisement data.
|
|
|
|
This does NOT register the ESP_BT_DEVICE feature, meaning ESPBTDevice
|
|
will not be compiled in if this is the only registration method used.
|
|
"""
|
|
_get_registration_counts().clients += 1
|
|
paren = await cg.get_variable(config[CONF_ESP32_BLE_ID])
|
|
cg.add(paren.register_client(var))
|
|
return var
|