Merge branch 'main' into multi_device

Author: dala318

.github/labeler.yml

@@ -0,0 +1,4 @@
+dependencies:
+  - changed-files:
+    - any-glob-to-any-file:
+      - '.pre-commit-config.yaml'

.github/workflows/docker.yml

@@ -47,7 +47,7 @@ jobs:
         uses: docker/[email protected]
       -
         name: Build and Push
-        uses: docker/build-push-action@v6.15.0
+        uses: docker/build-push-action@v6.16.0
         with:
           context: .
           tags: |

.github/workflows/labeler.yml

@@ -0,0 +1,13 @@
+name: Add labels
+
+on:
+  - pull_request_target
+
+jobs:
+  labeler:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/[email protected]

.github/workflows/release.yml

@@ -106,7 +106,7 @@ jobs:
             echo "CIBW_BUILD=${{ matrix.pyver }}*" >> $GITHUB_ENV
           fi
       - name: Build wheels
-        uses: pypa/[email protected].2
+        uses: pypa/[email protected].3
         env:
           CIBW_SKIP: cp36-* cp37-* cp38-* pp* ${{ matrix.musl == 'musllinux' && '*manylinux*' || '*musllinux*' }}
           CIBW_BEFORE_ALL_LINUX: apt-get install -y gcc || yum install -y gcc || apk add gcc

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
     - id: pyupgrade
       args: [--py39-plus]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.6
+    rev: v0.11.8
     hooks:
       - id: ruff
         args: [--fix]

aioesphomeapi/_frame_helper/noise_encryption.pxd

@@ -7,7 +7,7 @@ cdef class EncryptCipher:
     cdef object _nonce
     cdef object _encrypt
 
-    cdef bytes encrypt(self, object frame)
+    cpdef bytes encrypt(self, object frame)
 
 cdef class DecryptCipher:
 

aioesphomeapi/api.proto

@@ -31,6 +31,7 @@ service APIConnection {
     option (needs_authentication) = false;
   }
   rpc execute_service (ExecuteServiceRequest) returns (void) {}
+  rpc noise_encryption_set_key (NoiseEncryptionSetKeyRequest) returns (NoiseEncryptionSetKeyResponse) {}
 
   rpc cover_command (CoverCommandRequest) returns (void) {}
   rpc fan_command (FanCommandRequest) returns (void) {}
@@ -59,6 +60,7 @@ service APIConnection {
   rpc bluetooth_gatt_write_descriptor(BluetoothGATTWriteDescriptorRequest) returns (void) {}
   rpc bluetooth_gatt_notify(BluetoothGATTNotifyRequest) returns (void) {}
   rpc unsubscribe_bluetooth_le_advertisements(UnsubscribeBluetoothLEAdvertisementsRequest) returns (void) {}
+  rpc bluetooth_scanner_set_mode(BluetoothScannerSetModeRequest) returns (void) {}
 
   rpc subscribe_voice_assistant(SubscribeVoiceAssistantRequest) returns (void) {}
 
@@ -234,7 +236,10 @@ message DeviceInfoResponse {
   // The Bluetooth mac address of the device. For example "AC:BC:32:89:0E:AA"
   string bluetooth_mac_address = 18;
 
-  repeated SubDeviceInfo sub_devices = 19;
+  // Supports receiving and saving api encryption key
+  bool api_encryption_supported = 19;
+
+  repeated SubDeviceInfo sub_devices = 20;
 }
 
 message ListEntitiesRequest {
@@ -653,6 +658,23 @@ message SubscribeLogsResponse {
   bool send_failed = 4;
 }
 
+// ==================== NOISE ENCRYPTION ====================
+message NoiseEncryptionSetKeyRequest {
+  option (id) = 124;
+  option (source) = SOURCE_CLIENT;
+  option (ifdef) = "USE_API_NOISE";
+
+  bytes key = 1;
+}
+
+message NoiseEncryptionSetKeyResponse {
+  option (id) = 125;
+  option (source) = SOURCE_SERVER;
+  option (ifdef) = "USE_API_NOISE";
+
+  bool success = 1;
+}
+
 // ==================== HOMEASSISTANT.SERVICE ====================
 message SubscribeHomeassistantServicesRequest {
   option (id) = 34;
@@ -1496,6 +1518,37 @@ message BluetoothDeviceClearCacheResponse {
   int32 error = 3;
 }
 
+enum BluetoothScannerState {
+  BLUETOOTH_SCANNER_STATE_IDLE = 0;
+  BLUETOOTH_SCANNER_STATE_STARTING = 1;
+  BLUETOOTH_SCANNER_STATE_RUNNING = 2;
+  BLUETOOTH_SCANNER_STATE_FAILED = 3;
+  BLUETOOTH_SCANNER_STATE_STOPPING = 4;
+  BLUETOOTH_SCANNER_STATE_STOPPED = 5;
+}
+
+enum BluetoothScannerMode {
+  BLUETOOTH_SCANNER_MODE_PASSIVE = 0;
+  BLUETOOTH_SCANNER_MODE_ACTIVE = 1;
+}
+
+message BluetoothScannerStateResponse {
+  option(id) = 126;
+  option(source) = SOURCE_SERVER;
+  option(ifdef) = "USE_BLUETOOTH_PROXY";
+
+  BluetoothScannerState state = 1;
+  BluetoothScannerMode mode = 2;
+}
+
+message BluetoothScannerSetModeRequest {
+  option(id) = 127;
+  option(source) = SOURCE_CLIENT;
+  option(ifdef) = "USE_BLUETOOTH_PROXY";
+
+  BluetoothScannerMode mode = 1;
+}
+
 // ==================== VOICE ASSISTANT ====================
 enum VoiceAssistantSubscribeFlag {
   VOICE_ASSISTANT_SUBSCRIBE_NONE = 0;

aioesphomeapi/api_pb2.py

@@ -32,6 +32,8 @@
     BluetoothGATTWriteResponse,
     BluetoothLEAdvertisementResponse,
     BluetoothLERawAdvertisementsResponse,
+    BluetoothScannerSetModeRequest,
+    BluetoothScannerStateResponse,
     ButtonCommandRequest,
     CameraImageRequest,
     CameraImageResponse,
@@ -52,6 +54,8 @@
     ListEntitiesServicesResponse,
     LockCommandRequest,
     MediaPlayerCommandRequest,
+    NoiseEncryptionSetKeyRequest,
+    NoiseEncryptionSetKeyResponse,
     NumberCommandRequest,
     SelectCommandRequest,
     SirenCommandRequest,
@@ -90,6 +94,7 @@
     on_bluetooth_handle_message,
     on_bluetooth_le_advertising_response,
     on_bluetooth_message_types,
+    on_bluetooth_scanner_state_response,
     on_home_assistant_service_response,
     on_state_msg,
     on_subscribe_home_assistant_state_response,
@@ -115,6 +120,8 @@
     BluetoothLEAdvertisement,
     BluetoothProxyFeature,
     BluetoothProxySubscriptionFlag,
+    BluetoothScannerMode,
+    BluetoothScannerStateResponse as BluetoothScannerStateResponseModel,
     ClimateFanMode,
     ClimateMode,
     ClimatePreset,
@@ -130,6 +137,7 @@
     LockCommand,
     LogLevel,
     MediaPlayerCommand,
+    NoiseEncryptionSetKeyResponse as NoiseEncryptionSetKeyResponseModel,
     UpdateCommand,
     UserService,
     UserServiceArgType,
@@ -407,6 +415,25 @@ def subscribe_bluetooth_connections_free(
             (BluetoothConnectionsFreeResponse,),
         )
 
+    def subscribe_bluetooth_scanner_state(
+        self,
+        on_bluetooth_scanner_state: Callable[
+            [BluetoothScannerStateResponseModel], None
+        ],
+    ) -> Callable[[], None]:
+        """Subscribe to Bluetooth scanner state updates."""
+        return self._get_connection().add_message_callback(
+            partial(
+                on_bluetooth_scanner_state_response,
+                on_bluetooth_scanner_state,
+            ),
+            (BluetoothScannerStateResponse,),
+        )
+
+    def bluetooth_scanner_set_mode(self, mode: BluetoothScannerMode) -> None:
+        """Set the Bluetooth scanner mode."""
+        self._get_connection().send_message(BluetoothScannerSetModeRequest(mode=mode))
+
     async def bluetooth_device_connect(  # pylint: disable=too-many-locals, too-many-branches
         self,
         address: int,
@@ -1373,3 +1400,14 @@ def alarm_control_panel_command(
         if code is not None:
             req.code = code
         self._get_connection().send_message(req)
+
+    async def noise_encryption_set_key(
+        self,
+        key: bytes,
+    ) -> bool:
+        """Set the noise encryption key."""
+        req = NoiseEncryptionSetKeyRequest(key=key)
+        resp = await self._get_connection().send_message_await_response(
+            req, NoiseEncryptionSetKeyResponse
+        )
+        return NoiseEncryptionSetKeyResponseModel.from_pb(resp).success

aioesphomeapi/client.py

@@ -22,6 +22,7 @@
     BluetoothGATTReadResponse,
     BluetoothGATTWriteResponse,
     BluetoothLEAdvertisementResponse,
+    BluetoothScannerStateResponse,
     CameraImageResponse,
     HomeassistantServiceResponse,
     SubscribeHomeAssistantStateResponse,
@@ -31,6 +32,7 @@
 from .model import (
     APIVersion,
     BluetoothLEAdvertisement,
+    BluetoothScannerStateResponse as BluetoothScannerStateResponseModel,
     CameraState,
     EntityState,
     HomeassistantServiceCall,
@@ -113,6 +115,13 @@ def on_bluetooth_gatt_notify_data_response(
         on_bluetooth_gatt_notify(handle, bytearray(msg.data))
 
 
+def on_bluetooth_scanner_state_response(
+    on_bluetooth_scanner_state: Callable[[BluetoothScannerStateResponseModel], None],
+    msg: BluetoothScannerStateResponse,
+) -> None:
+    on_bluetooth_scanner_state(BluetoothScannerStateResponseModel.from_pb(msg))
+
+
 def on_subscribe_home_assistant_state_response(
     on_state_sub: Callable[[str, str | None], None],
     on_state_request: Callable[[str, str | None], None] | None,

aioesphomeapi/client_base.py

@@ -30,6 +30,8 @@
     BluetoothGATTWriteResponse,
     BluetoothLEAdvertisementResponse,
     BluetoothLERawAdvertisementsResponse,
+    BluetoothScannerSetModeRequest,
+    BluetoothScannerStateResponse,
     ButtonCommandRequest,
     CameraImageRequest,
     CameraImageResponse,
@@ -89,6 +91,8 @@
     LockStateResponse,
     MediaPlayerCommandRequest,
     MediaPlayerStateResponse,
+    NoiseEncryptionSetKeyRequest,
+    NoiseEncryptionSetKeyResponse,
     NumberCommandRequest,
     NumberStateResponse,
     PingRequest,
@@ -438,6 +442,10 @@ def __init__(self, error: BluetoothGATTError) -> None:
     121: VoiceAssistantConfigurationRequest,
     122: VoiceAssistantConfigurationResponse,
     123: VoiceAssistantSetConfiguration,
+    124: NoiseEncryptionSetKeyRequest,
+    125: NoiseEncryptionSetKeyResponse,
+    126: BluetoothScannerStateResponse,
+    127: BluetoothScannerSetModeRequest,
 }
 
 MESSAGE_NUMBER_TO_PROTO = tuple(MESSAGE_TYPE_TO_PROTO.values())

aioesphomeapi/core.py

@@ -114,6 +114,7 @@ class BluetoothProxyFeature(enum.IntFlag):
     PAIRING = 1 << 3
     CACHE_CLEARING = 1 << 4
     RAW_ADVERTISEMENTS = 1 << 5
+    FEATURE_STATE_AND_MODE = 1 << 6
 
 
 class BluetoothProxySubscriptionFlag(enum.IntFlag):
@@ -1288,6 +1289,30 @@ class BluetoothDeviceRequestType(APIIntEnum):
     CLEAR_CACHE = 6
 
 
+class BluetoothScannerState(APIIntEnum):
+    IDLE = 0
+    STARTING = 1
+    RUNNING = 2
+    FAILED = 3
+    STOPPING = 4
+    STOPPED = 5
+
+
+class BluetoothScannerMode(APIIntEnum):
+    PASSIVE = 0
+    ACTIVE = 1
+
+
+@_frozen_dataclass_decorator
+class BluetoothScannerStateResponse(APIModelBase):
+    state: BluetoothScannerState | None = converter_field(
+        default=BluetoothScannerState.IDLE, converter=BluetoothScannerState.convert
+    )
+    mode: BluetoothScannerMode | None = converter_field(
+        default=BluetoothScannerMode.PASSIVE, converter=BluetoothScannerMode.convert
+    )
+
+
 class VoiceAssistantCommandFlag(enum.IntFlag):
     USE_VAD = 1 << 0
     USE_WAKE_WORD = 1 << 1
@@ -1359,6 +1384,16 @@ class VoiceAssistantSetConfiguration(APIModelBase):
     active_wake_words: list[int] = converter_field(default_factory=list, converter=list)
 
 
+@_frozen_dataclass_decorator
+class NoiseEncryptionSetKeyRequest(APIModelBase):
+    key: bytes = field(default_factory=bytes)  # pylint: disable=invalid-field-call
+
+
+@_frozen_dataclass_decorator
+class NoiseEncryptionSetKeyResponse(APIModelBase):
+    success: bool = False
+
+
 class LogLevel(APIIntEnum):
     LOG_LEVEL_NONE = 0
     LOG_LEVEL_ERROR = 1

aioesphomeapi/model.py

@@ -1,9 +1,9 @@
-pylint==3.3.6
-ruff==0.11.6
+pylint==3.3.7
+ruff==0.11.8
 flake8==7.2.0
 isort==6.0.1
 mypy==1.15.0
-types-protobuf==5.29.1.20250403
+types-protobuf==6.30.2.20250503
 pytest>=6.2.4,<9
 pytest-asyncio==0.26.0
 pytest-codspeed==3.2.0

requirements/test.txt

@@ -40,7 +40,7 @@
     long_description = readme_file.read()
 
 
-VERSION = "30.0.2"
+VERSION = "31.0.0"
 PROJECT_NAME = "aioesphomeapi"
 PROJECT_PACKAGE_NAME = "aioesphomeapi"
 PROJECT_LICENSE = "MIT"

setup.py

@@ -7,6 +7,8 @@
 import pytest
 from pytest_codspeed import BenchmarkFixture  # type: ignore[import-untyped]
 
+from aioesphomeapi._frame_helper.noise_encryption import EncryptCipher
+
 from ..common import (
     MockAPINoiseFrameHelper,
     _extract_encrypted_payload_from_handshake,
@@ -78,10 +80,11 @@ def _empty_writelines(data: Iterable[bytes]):
     helper._writelines = _empty_writelines
 
     payload = b"x" * payload_size
+    encrypt_cipher = EncryptCipher(proto.noise_protocol.cipher_state_encrypt)
 
     @benchmark
     def process_encrypted_packets():
         for _ in range(100):
-            helper.data_received(_make_encrypted_packet(proto, 42, payload))
+            helper.data_received(_make_encrypted_packet(encrypt_cipher, 42, payload))
 
     helper.close()