mirror of
https://github.com/esphome/esphome.git
synced 2025-04-02 08:58:17 +01:00
ba1222eae4
* esp32_ble_tracker: introduce UUID comparison function * ble_presence, ble_rssi: use new UUID comparison function * esp32_ble_tracker: introduce automation on BLE advertising * test2.yaml: remove deep_sleep due to firmware size restrictions
170 lines
7.7 KiB
Python
170 lines
7.7 KiB
Python
import re
|
|
import esphome.codegen as cg
|
|
import esphome.config_validation as cv
|
|
from esphome import automation
|
|
from esphome.const import CONF_ID, ESP_PLATFORM_ESP32, CONF_INTERVAL, \
|
|
CONF_DURATION, CONF_TRIGGER_ID, CONF_MAC_ADDRESS, CONF_SERVICE_UUID, CONF_MANUFACTURER_ID, \
|
|
CONF_ON_BLE_ADVERTISE, CONF_ON_BLE_SERVICE_DATA_ADVERTISE, \
|
|
CONF_ON_BLE_MANUFACTURER_DATA_ADVERTISE
|
|
from esphome.core import coroutine
|
|
|
|
ESP_PLATFORMS = [ESP_PLATFORM_ESP32]
|
|
AUTO_LOAD = ['xiaomi_ble', 'ruuvi_ble']
|
|
|
|
CONF_ESP32_BLE_ID = 'esp32_ble_id'
|
|
CONF_SCAN_PARAMETERS = 'scan_parameters'
|
|
CONF_WINDOW = 'window'
|
|
CONF_ACTIVE = 'active'
|
|
esp32_ble_tracker_ns = cg.esphome_ns.namespace('esp32_ble_tracker')
|
|
ESP32BLETracker = esp32_ble_tracker_ns.class_('ESP32BLETracker', cg.Component)
|
|
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))
|
|
|
|
|
|
def validate_scan_parameters(config):
|
|
duration = config[CONF_DURATION]
|
|
interval = config[CONF_INTERVAL]
|
|
window = config[CONF_WINDOW]
|
|
|
|
if window > interval:
|
|
raise cv.Invalid("Scan window ({}) needs to be smaller than scan interval ({})"
|
|
"".format(window, 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
|
|
|
|
|
|
bt_uuid16_format = 'XXXX'
|
|
bt_uuid32_format = 'XXXXXXXX'
|
|
bt_uuid128_format = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
|
|
|
|
|
|
def bt_uuid(value):
|
|
in_value = cv.string_strict(value)
|
|
value = in_value.upper()
|
|
|
|
if len(value) == len(bt_uuid16_format):
|
|
pattern = re.compile("^[A-F|0-9]{4,}$")
|
|
if not pattern.match(value):
|
|
raise cv.Invalid(
|
|
f"Invalid hexadecimal value for 16 bit UUID format: '{in_value}'")
|
|
return value
|
|
if len(value) == len(bt_uuid32_format):
|
|
pattern = re.compile("^[A-F|0-9]{8,}$")
|
|
if not pattern.match(value):
|
|
raise cv.Invalid(
|
|
f"Invalid hexadecimal value for 32 bit UUID format: '{in_value}'")
|
|
return value
|
|
if len(value) == len(bt_uuid128_format):
|
|
pattern = re.compile(
|
|
"^[A-F|0-9]{8,}-[A-F|0-9]{4,}-[A-F|0-9]{4,}-[A-F|0-9]{4,}-[A-F|0-9]{12,}$")
|
|
if not pattern.match(value):
|
|
raise cv.Invalid(
|
|
f"Invalid hexadecimal value for 128 UUID format: '{in_value}'")
|
|
return value
|
|
raise cv.Invalid(
|
|
"Service UUID must be in 16 bit '{}', 32 bit '{}', or 128 bit '{}' format".format(
|
|
bt_uuid16_format, bt_uuid32_format, bt_uuid128_format))
|
|
|
|
|
|
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(
|
|
'(uint8_t*)(const uint8_t[16]){{{}}}'.format(','.join(reversed(cpp_array))))
|
|
|
|
|
|
CONFIG_SCHEMA = cv.Schema({
|
|
cv.GenerateID(): cv.declare_id(ESP32BLETracker),
|
|
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,
|
|
}), 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.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('scan_interval'): cv.invalid("This option has been removed in 1.14 (Reason: "
|
|
"it never had an effect)"),
|
|
}).extend(cv.COMPONENT_SCHEMA)
|
|
|
|
ESP_BLE_DEVICE_SCHEMA = cv.Schema({
|
|
cv.GenerateID(CONF_ESP32_BLE_ID): cv.use_id(ESP32BLETracker),
|
|
})
|
|
|
|
|
|
def to_code(config):
|
|
var = cg.new_Pvariable(config[CONF_ID])
|
|
yield cg.register_component(var, config)
|
|
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]))
|
|
for conf in config.get(CONF_ON_BLE_ADVERTISE, []):
|
|
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
|
|
if CONF_MAC_ADDRESS in conf:
|
|
cg.add(trigger.set_address(conf[CONF_MAC_ADDRESS].as_hex))
|
|
yield automation.build_automation(trigger, [(ESPBTDeviceConstRef, 'x')], conf)
|
|
for conf in config.get(CONF_ON_BLE_SERVICE_DATA_ADVERTISE, []):
|
|
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_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))
|
|
yield automation.build_automation(trigger, [(adv_data_t_const_ref, 'x')], conf)
|
|
for conf in config.get(CONF_ON_BLE_MANUFACTURER_DATA_ADVERTISE, []):
|
|
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_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))
|
|
yield automation.build_automation(trigger, [(adv_data_t_const_ref, 'x')], conf)
|
|
|
|
|
|
@coroutine
|
|
def register_ble_device(var, config):
|
|
paren = yield cg.get_variable(config[CONF_ESP32_BLE_ID])
|
|
cg.add(paren.register_listener(var))
|
|
yield var
|