github/esphome
2
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2026-08-31 01:56:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

[api] Rename encode_short_string to write_short_string

Browse Source
This commit is contained in:
J. Nick Koston
2026-04-03 14:15:19 -10:00
parent dd08d7631e
commit 80502e8c39
3 changed files with 52 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esphome/components/api/api_pb2.cpp
+50 -50
View File
@@ -207,9 +207,9 @@ uint32_t DeviceInfoResponse::calculate_size() const {
}
#ifdef USE_BINARY_SENSOR
void ListEntitiesBinarySensorResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
buffer.encode_string(5, this->device_class);
buffer.encode_bool(6, this->is_status_binary_sensor);
buffer.encode_bool(7, this->disabled_by_default);
@@ -259,9 +259,9 @@ uint32_t BinarySensorStateResponse::calculate_size() const {
#endif
#ifdef USE_COVER
void ListEntitiesCoverResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
buffer.encode_bool(5, this->assumed_state);
buffer.encode_bool(6, this->supports_position);
buffer.encode_bool(7, this->supports_tilt);
@@ -356,9 +356,9 @@ bool CoverCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_FAN
void ListEntitiesFanResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
buffer.encode_bool(5, this->supports_oscillation);
buffer.encode_bool(6, this->supports_speed);
buffer.encode_bool(7, this->supports_direction);
@@ -486,9 +486,9 @@ bool FanCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_LIGHT
void ListEntitiesLightResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
for (const auto &it : *this->supported_color_modes) {
buffer.encode_uint32(12, static_cast<uint32_t>(it), true);
}
@@ -682,9 +682,9 @@ bool LightCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_SENSOR
void ListEntitiesSensorResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -740,9 +740,9 @@ uint32_t SensorStateResponse::calculate_size() const {
#endif
#ifdef USE_SWITCH
void ListEntitiesSwitchResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -815,9 +815,9 @@ bool SwitchCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_TEXT_SENSOR
void ListEntitiesTextSensorResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -1268,9 +1268,9 @@ uint32_t ExecuteServiceResponse::calculate_size() const {
#endif
#ifdef USE_CAMERA
void ListEntitiesCameraResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
buffer.encode_bool(5, this->disabled_by_default);
#ifdef USE_ENTITY_ICON
buffer.encode_string(6, this->icon);
@@ -1329,9 +1329,9 @@ bool CameraImageRequest::decode_varint(uint32_t field_id, proto_varint_value_t v
#endif
#ifdef USE_CLIMATE
void ListEntitiesClimateResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
buffer.encode_bool(5, this->supports_current_temperature);
buffer.encode_bool(6, this->supports_two_point_target_temperature);
for (const auto &it : *this->supported_modes) {
@@ -1562,9 +1562,9 @@ bool ClimateCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_WATER_HEATER
void ListEntitiesWaterHeaterResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(4, this->icon);
#endif
@@ -1674,9 +1674,9 @@ bool WaterHeaterCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value
#endif
#ifdef USE_NUMBER
void ListEntitiesNumberResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -1759,9 +1759,9 @@ bool NumberCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_SELECT
void ListEntitiesSelectResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -1848,9 +1848,9 @@ bool SelectCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_SIREN
void ListEntitiesSirenResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -1960,9 +1960,9 @@ bool SirenCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_LOCK
void ListEntitiesLockResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -2053,9 +2053,9 @@ bool LockCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_BUTTON
void ListEntitiesButtonResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -2123,9 +2123,9 @@ uint32_t MediaPlayerSupportedFormat::calculate_size() const {
return size;
}
void ListEntitiesMediaPlayerResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -2945,9 +2945,9 @@ bool VoiceAssistantSetConfiguration::decode_length(uint32_t field_id, ProtoLengt
#endif
#ifdef USE_ALARM_CONTROL_PANEL
void ListEntitiesAlarmControlPanelResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -3033,9 +3033,9 @@ bool AlarmControlPanelCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit
#endif
#ifdef USE_TEXT
void ListEntitiesTextResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -3122,9 +3122,9 @@ bool TextCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_DATETIME_DATE
void ListEntitiesDateResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -3205,9 +3205,9 @@ bool DateCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_DATETIME_TIME
void ListEntitiesTimeResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -3288,9 +3288,9 @@ bool TimeCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_EVENT
void ListEntitiesEventResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -3344,9 +3344,9 @@ uint32_t EventResponse::calculate_size() const {
#endif
#ifdef USE_VALVE
void ListEntitiesValveResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -3431,9 +3431,9 @@ bool ValveCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_DATETIME_DATETIME
void ListEntitiesDateTimeResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -3504,9 +3504,9 @@ bool DateTimeCommandRequest::decode_32bit(uint32_t field_id, Proto32Bit value) {
#endif
#ifdef USE_UPDATE
void ListEntitiesUpdateResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(5, this->icon);
#endif
@@ -3645,9 +3645,9 @@ uint32_t ZWaveProxyRequest::calculate_size() const {
#endif
#ifdef USE_INFRARED
void ListEntitiesInfraredResponse::encode(ProtoWriteBuffer &buffer) const {
buffer.encode_short_string(10, this->object_id);
buffer.write_short_string(10, this->object_id);
buffer.write_tag_and_fixed32(21, this->key);
buffer.encode_short_string(26, this->name);
buffer.write_short_string(26, this->name);
#ifdef USE_ENTITY_ICON
buffer.encode_string(4, this->icon);
#endif
esphome/components/api/proto.h
+1 -1
View File
@@ -242,7 +242,7 @@ class ProtoWriteBuffer {
}
/// Write tag + 1-byte length + raw string data. For strings with max_data_length < 128.
/// Tag must be a single-byte varint (< 128). Always encodes (no zero check).
inline void encode_short_string(uint8_t tag, const StringRef &ref) ESPHOME_ALWAYS_INLINE {
inline void write_short_string(uint8_t tag, const StringRef &ref) ESPHOME_ALWAYS_INLINE {
this->debug_check_bounds_(2 + ref.size());
uint8_t *__restrict__ pos = this->pos_;
*pos++ = tag;
script/api_protobuf/api_protobuf.py
+1 -1
View File
@@ -1078,7 +1078,7 @@ class PointerToStringBufferType(PointerToBufferTypeBase):
if max_len is not None and max_len < 128 and self.force:
tag = self.calculate_tag()
if tag < 128:
return f"buffer.encode_short_string({tag}, this->{self.field_name});"
return f"buffer.write_short_string({tag}, this->{self.field_name});"
if result := self._encode_bytes_with_precomputed_tag(
f"this->{self.field_name}.c_str()",
f"this->{self.field_name}.size()",