Upstream
/
aioesphomeapi
mirror of https://github.com/esphome/aioesphomeapi.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

init

This commit is contained in:
Darter 2024-02-12 11:12:33 +01:00
parent 41eeabcc08
commit 70fdc32ec0
9 changed files with 633 additions and 1617 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
aioesphomeapi/api.proto
View File

@ -39,6 +39,7 @@ service APIConnection {
rpc camera_image (CameraImageRequest) returns (void) {}
rpc climate_command (ClimateCommandRequest) returns (void) {}
rpc number_command (NumberCommandRequest) returns (void) {}
rpc datetime_command (DatetimeCommandRequest) returns (void) {}
rpc select_command (SelectCommandRequest) returns (void) {}
rpc text_command (TextCommandRequest) returns (void) {}
rpc siren_command (SirenCommandRequest) returns (void) {}
@ -954,6 +955,50 @@ message NumberCommandRequest {
float state = 2;
}
// ==================== DATETIME ====================
enum DatetimeMode {
DATETIME_MODE_AUTO = 0;
}
message ListEntitiesDatetimeResponse {
option (id) = 100;
option (source) = SOURCE_SERVER;
option (ifdef) = "USE_DATETIME";
string object_id = 1;
fixed32 key = 2;
string name = 3;
string unique_id = 4;
string icon = 5;
bool disabled_by_default = 6;
EntityCategory entity_category = 7;
string unit_of_measurement = 8;
DatetimeMode mode = 9;
}
message DatetimeStateResponse {
option (id) = 101;
option (source) = SOURCE_SERVER;
option (ifdef) = "USE_DATETIME";
option (no_delay) = true;
fixed32 key = 1;
float state = 2;
// If the dattime does not have a valid state yet.
// Equivalent to `!obj->has_state()` - inverse logic to make state packets smaller
bool missing_state = 3;
}
message DatetimeCommandRequest {
option (id) = 102;
option (source) = SOURCE_CLIENT;
option (ifdef) = "USE_DATETIME";
option (no_delay) = true;
fixed32 key = 1;
float state = 2;
}
// ==================== SELECT ====================
message ListEntitiesSelectResponse {
option (id) = 52;

57
aioesphomeapi/api_options_pb2.py
View File

@ -2,13 +2,12 @@
# -*- coding: utf-8 -*-
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: api_options.proto
# Protobuf Python Version: 5.26.0-rc2
"""Generated protocol buffer code."""
from google.protobuf.internal import enum_type_wrapper
from google.protobuf import descriptor as _descriptor
from google.protobuf import descriptor_pool as _descriptor_pool
from google.protobuf import message as _message
from google.protobuf import reflection as _reflection
from google.protobuf import symbol_database as _symbol_database
from google.protobuf.internal import builder as _builder
# @@protoc_insertion_point(imports)
_sym_db = _symbol_database.Default()
@ -19,47 +18,13 @@ from google.protobuf import descriptor_pb2 as google_dot_protobuf_dot_descriptor
DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x11\x61pi_options.proto\x1a google/protobuf/descriptor.proto\"\x06\n\x04void*F\n\rAPISourceType\x12\x0f\n\x0bSOURCE_BOTH\x10\x00\x12\x11\n\rSOURCE_SERVER\x10\x01\x12\x11\n\rSOURCE_CLIENT\x10\x02:E\n\x16needs_setup_connection\x12\x1e.google.protobuf.MethodOptions\x18\x8e\x08 \x01(\x08:\x04true:C\n\x14needs_authentication\x12\x1e.google.protobuf.MethodOptions\x18\x8f\x08 \x01(\x08:\x04true:/\n\x02id\x12\x1f.google.protobuf.MessageOptions\x18\x8c\x08 \x01(\r:\x01\x30:M\n\x06source\x12\x1f.google.protobuf.MessageOptions\x18\x8d\x08 \x01(\x0e\x32\x0e.APISourceType:\x0bSOURCE_BOTH:/\n\x05ifdef\x12\x1f.google.protobuf.MessageOptions\x18\x8e\x08 \x01(\t:3\n\x03log\x12\x1f.google.protobuf.MessageOptions\x18\x8f\x08 \x01(\x08:\x04true:9\n\x08no_delay\x12\x1f.google.protobuf.MessageOptions\x18\x90\x08 \x01(\x08:\x05\x66\x61lse')
_APISOURCETYPE = DESCRIPTOR.enum_types_by_name['APISourceType']
APISourceType = enum_type_wrapper.EnumTypeWrapper(_APISOURCETYPE)
SOURCE_BOTH = 0
SOURCE_SERVER = 1
SOURCE_CLIENT = 2
NEEDS_SETUP_CONNECTION_FIELD_NUMBER = 1038
needs_setup_connection = DESCRIPTOR.extensions_by_name['needs_setup_connection']
NEEDS_AUTHENTICATION_FIELD_NUMBER = 1039
needs_authentication = DESCRIPTOR.extensions_by_name['needs_authentication']
ID_FIELD_NUMBER = 1036
id = DESCRIPTOR.extensions_by_name['id']
SOURCE_FIELD_NUMBER = 1037
source = DESCRIPTOR.extensions_by_name['source']
IFDEF_FIELD_NUMBER = 1038
ifdef = DESCRIPTOR.extensions_by_name['ifdef']
LOG_FIELD_NUMBER = 1039
log = DESCRIPTOR.extensions_by_name['log']
NO_DELAY_FIELD_NUMBER = 1040
no_delay = DESCRIPTOR.extensions_by_name['no_delay']
_VOID = DESCRIPTOR.message_types_by_name['void']
void = _reflection.GeneratedProtocolMessageType('void', (_message.Message,), {
'DESCRIPTOR' : _VOID,
'__module__' : 'api_options_pb2'
# @@protoc_insertion_point(class_scope:void)
})
_sym_db.RegisterMessage(void)
if _descriptor._USE_C_DESCRIPTORS == False:
google_dot_protobuf_dot_descriptor__pb2.MethodOptions.RegisterExtension(needs_setup_connection)
google_dot_protobuf_dot_descriptor__pb2.MethodOptions.RegisterExtension(needs_authentication)
google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(id)
google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(source)
google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(ifdef)
google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(log)
google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(no_delay)
DESCRIPTOR._options = None
_APISOURCETYPE._serialized_start=63
_APISOURCETYPE._serialized_end=133
_VOID._serialized_start=55
_VOID._serialized_end=61
_globals = globals()
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'api_options_pb2', _globals)
if not _descriptor._USE_C_DESCRIPTORS:
DESCRIPTOR._loaded_options = None
_globals['_APISOURCETYPE']._serialized_start=63
_globals['_APISOURCETYPE']._serialized_end=133
_globals['_VOID']._serialized_start=55
_globals['_VOID']._serialized_end=61
# @@protoc_insertion_point(module_scope)

2096
aioesphomeapi/api_pb2.py
View File

File diff suppressed because one or more lines are too long

4
aioesphomeapi/client.py
View File

@ -51,6 +51,7 @@ from .api_pb2 import ( # type: ignore
LockCommandRequest,
MediaPlayerCommandRequest,
NumberCommandRequest,
DatetimeCommandRequest,
SelectCommandRequest,
SirenCommandRequest,
SubscribeBluetoothConnectionsFreeRequest,
@ -1100,6 +1101,9 @@ class APIClient:
async def number_command(self, key: int, state: float) -> None:
self._get_connection().send_message(NumberCommandRequest(key=key, state=state))
async def datetime_command(self, key: int, state: str) -> None:
self._get_connection().send_message(DatetimeCommandRequest(key=key, state=state))
async def select_command(self, key: int, state: str) -> None:
self._get_connection().send_message(SelectCommandRequest(key=key, state=state))

6
aioesphomeapi/core.py
View File

@ -65,6 +65,7 @@ from .api_pb2 import ( # type: ignore
ListEntitiesLockResponse,
ListEntitiesMediaPlayerResponse,
ListEntitiesNumberResponse,
ListEntitiesDatetimeResponse,
ListEntitiesRequest,
ListEntitiesSelectResponse,
ListEntitiesSensorResponse,
@ -79,6 +80,8 @@ from .api_pb2 import ( # type: ignore
MediaPlayerStateResponse,
NumberCommandRequest,
NumberStateResponse,
DatetimeCommandRequest,
DatetimeStateResponse,
PingRequest,
PingResponse,
SelectCommandRequest,
@ -354,4 +357,7 @@ MESSAGE_TYPE_TO_PROTO = {
97: ListEntitiesTextResponse,
98: TextStateResponse,
99: TextCommandRequest,
100: ListEntitiesDatetimeResponse,
101: DatetimeStateResponse,
102: DatetimeCommandRequest,
}

20
aioesphomeapi/model.py
View File

@ -637,6 +637,24 @@ class NumberState(EntityState):
missing_state: bool = False
# ==================== DATETIME ====================
class DatetimeMode(APIIntEnum):
AUTO = 0
@_frozen_dataclass_decorator
class DatetimeInfo(EntityInfo):
mode: DatetimeMode | None = converter_field(
default=DatetimeMode.AUTO, converter=DatetimeMode.convert
)
@_frozen_dataclass_decorator
class DatetimeState(EntityState):
state: str = ""
missing_state: bool = False
# ==================== SELECT ====================
@_frozen_dataclass_decorator
class SelectInfo(EntityInfo):
@ -806,6 +824,7 @@ COMPONENT_TYPE_TO_INFO: dict[str, type[EntityInfo]] = {
"camera": CameraInfo,
"climate": ClimateInfo,
"number": NumberInfo,
"datetime": DatetimeInfo,
"select": SelectInfo,
"siren": SirenInfo,
"button": ButtonInfo,
@ -1153,6 +1172,7 @@ _TYPE_TO_NAME = {
FanInfo: "fan",
LightInfo: "light",
NumberInfo: "number",
DatetimeInfo: "datetime",
SelectInfo: "select",
SensorInfo: "sensor",
SirenInfo: "siren",

6
aioesphomeapi/model_conversions.py
View File

@ -20,6 +20,7 @@ from .api_pb2 import ( # type: ignore
ListEntitiesLockResponse,
ListEntitiesMediaPlayerResponse,
ListEntitiesNumberResponse,
ListEntitiesDatetimeResponse,
ListEntitiesSelectResponse,
ListEntitiesSensorResponse,
ListEntitiesServicesResponse,
@ -30,6 +31,7 @@ from .api_pb2 import ( # type: ignore
LockStateResponse,
MediaPlayerStateResponse,
NumberStateResponse,
DatetimeStateResponse,
SelectStateResponse,
SensorStateResponse,
SirenStateResponse,
@ -60,6 +62,8 @@ from .model import (
MediaPlayerInfo,
NumberInfo,
NumberState,
DatetimeInfo,
DatetimeState,
SelectInfo,
SelectState,
SensorInfo,
@ -80,6 +84,7 @@ SUBSCRIBE_STATES_RESPONSE_TYPES: dict[Any, type[EntityState]] = {
FanStateResponse: FanState,
LightStateResponse: LightState,
NumberStateResponse: NumberState,
DatetimeStateResponse: DatetimeState,
SelectStateResponse: SelectState,
SensorStateResponse: SensorState,
SirenStateResponse: SirenState,
@ -99,6 +104,7 @@ LIST_ENTITIES_SERVICES_RESPONSE_TYPES: dict[Any, type[EntityInfo] | None] = {
ListEntitiesFanResponse: FanInfo,
ListEntitiesLightResponse: LightInfo,
ListEntitiesNumberResponse: NumberInfo,
ListEntitiesDatetimeResponse: DatetimeInfo,
ListEntitiesSelectResponse: SelectInfo,
ListEntitiesSensorResponse: SensorInfo,
ListEntitiesSirenResponse: SirenInfo,

9
tests/test_client.py
View File

@ -55,6 +55,7 @@ from aioesphomeapi.api_pb2 import (
LockCommandRequest,
MediaPlayerCommandRequest,
NumberCommandRequest,
DatetimeCommandRequest,
SelectCommandRequest,
SirenCommandRequest,
SubscribeHomeAssistantStateResponse,
@ -616,6 +617,14 @@ async def test_number_command(
await auth_client.number_command(**cmd)
send.assert_called_once_with(NumberCommandRequest(**req))
async def test_datetime_command(
auth_client: APIClient, cmd: dict[str, Any], req: dict[str, Any]
) -> None:
send = patch_send(auth_client)
await auth_client.datetime_command(**cmd)
send.assert_called_once_with(DatetimeCommandRequest(**req))
@pytest.mark.asyncio
@pytest.mark.parametrize(

7
tests/test_model.py
View File

@ -28,6 +28,7 @@ from aioesphomeapi.api_pb2 import (
ListEntitiesLockResponse,
ListEntitiesMediaPlayerResponse,
ListEntitiesNumberResponse,
ListEntitiesDatetimeResponse,
ListEntitiesSelectResponse,
ListEntitiesSensorResponse,
ListEntitiesServicesArgument,
@ -37,6 +38,7 @@ from aioesphomeapi.api_pb2 import (
LockStateResponse,
MediaPlayerStateResponse,
NumberStateResponse,
DatetimeStateResponse,
SelectStateResponse,
SensorStateResponse,
ServiceArgType,
@ -83,6 +85,8 @@ from aioesphomeapi.model import (
MediaPlayerInfo,
NumberInfo,
NumberState,
DatetimeInfo,
DatetimeState,
SelectInfo,
SelectState,
SensorInfo,
@ -242,6 +246,8 @@ def test_api_version_ord():
(ClimateState, ClimateStateResponse),
(NumberInfo, ListEntitiesNumberResponse),
(NumberState, NumberStateResponse),
(DatetimeInfo, ListEntitiesDatetimeResponse),
(DatetimeState, DatetimeStateResponse),
(SelectInfo, ListEntitiesSelectResponse),
(SelectState, SelectStateResponse),
(HomeassistantServiceCall, HomeassistantServiceResponse),
@ -358,6 +364,7 @@ def test_user_service_conversion():
FanInfo,
LightInfo,
NumberInfo,
DatetimeInfo,
SelectInfo,
SensorInfo,
SirenInfo,