aboutsummaryrefslogtreecommitdiffstats
path: root/build/generated/source/proto/main/doc/ v2c.md
diff options
context:
space:
mode:
authorJames Simon <jamsimox@amazon.com>2023-09-13 07:46:36 -0400
committerJames Simon <jamsimox@amazon.com>2023-09-13 07:46:36 -0400
commit318c653ef9f761a27abbc952ee77a82176d224be (patch)
tree852a6208ce6a22f6a619442f8390465c8eb01700 /build/generated/source/proto/main/doc/ v2c.md
parent57e11c93c40098dac59e31501bb1dc360e56acb0 (diff)
Newest Commit
Signed-off-by: James Simon <jamsimox@amazon.com> Change-Id: I9786889a4335d4b79b02ec3d505882fc85e71601
Diffstat (limited to 'build/generated/source/proto/main/doc/ v2c.md')
-rw-r--r--build/generated/source/proto/main/doc/ v2c.md121
1 files changed, 79 insertions, 42 deletions
diff --git a/build/generated/source/proto/main/doc/ v2c.md b/build/generated/source/proto/main/doc/ v2c.md
index 0d16428..44187a6 100644
--- a/build/generated/source/proto/main/doc/ v2c.md
+++ b/build/generated/source/proto/main/doc/ v2c.md
@@ -15,15 +15,17 @@
- [ResponseStatusEnum](#messages-ResponseStatusEnum)
- [messages/VehicleRemoteHvac.proto](#messages_VehicleRemoteHvac-proto)
- - [CabinPreConditionReponse](#messages-CabinPreConditionReponse)
- - [CabinPreconditionRequest](#messages-CabinPreconditionRequest)
- - [SetAcStatusReply](#messages-SetAcStatusReply)
- - [SetAcStatusRequest](#messages-SetAcStatusRequest)
- - [SetTemperatureReply](#messages-SetTemperatureReply)
- - [SetTemperatureRequest](#messages-SetTemperatureRequest)
+ - [CabinConditionStatusPublish](#messages-hvac-CabinConditionStatusPublish)
+ - [CabinTemperature](#messages-hvac-CabinTemperature)
+ - [HVACState](#messages-hvac-HVACState)
+ - [HVACZone](#messages-hvac-HVACZone)
+ - [PreconditionRequest](#messages-hvac-PreconditionRequest)
+ - [PreconditionResponse](#messages-hvac-PreconditionResponse)
+ - [Temperature](#messages-hvac-Temperature)
- - [AcStatusEnum](#messages-AcStatusEnum)
- - [SetTempStatusEnum](#messages-SetTempStatusEnum)
+ - [HVACState.State](#messages-hvac-HVACState-State)
+ - [HVACZone.Zone](#messages-hvac-HVACZone-Zone)
+ - [PreconditionResponse.Status](#messages-hvac-PreconditionResponse-Status)
- [vss/vspec.proto](#vss_vspec-proto)
- [Vehicle](#vss-Vehicle)
@@ -451,94 +453,113 @@ services deeper in the vehicle or the cloud services.
-<a name="messages-CabinPreConditionReponse"></a>
+<a name="messages-hvac-CabinConditionStatusPublish"></a>
-### CabinPreConditionReponse
+### CabinConditionStatusPublish
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| messageHeader | [VehicleMessageHeading](#messages-VehicleMessageHeading) | | |
-| setAcStatusReply | [SetAcStatusReply](#messages-SetAcStatusReply) | | |
-| setTemperatureReply | [SetTemperatureReply](#messages-SetTemperatureReply) | | |
+| event_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | Time of the event |
+| hvac_state | [HVACState](#messages-hvac-HVACState) | | Current state of the HVAC |
+| cabin_temperature | [CabinTemperature](#messages-hvac-CabinTemperature) | | Current cabin temperature |
-<a name="messages-CabinPreconditionRequest"></a>
+<a name="messages-hvac-CabinTemperature"></a>
-### CabinPreconditionRequest
+### CabinTemperature
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| messageHeader | [VehicleMessageHeading](#messages-VehicleMessageHeading) | | |
-| setAcStatus | [SetAcStatusRequest](#messages-SetAcStatusRequest) | | |
-| setTemp | [SetTemperatureRequest](#messages-SetTemperatureRequest) | | |
+| temperature | [Temperature](#messages-hvac-Temperature) | | Current cabin temperature |
+| zone | [HVACZone](#messages-hvac-HVACZone) | | Zone of the reported temperature |
-<a name="messages-SetAcStatusReply"></a>
+<a name="messages-hvac-HVACState"></a>
+
+### HVACState
-### SetAcStatusReply
-@brief
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| status | [AcStatusEnum](#messages-AcStatusEnum) | | |
+| state | [HVACState.State](#messages-hvac-HVACState-State) | | Current state of the HVAC |
+| current_zone | [HVACZone](#messages-hvac-HVACZone) | | Current active zone |
-<a name="messages-SetAcStatusRequest"></a>
+<a name="messages-hvac-HVACZone"></a>
-### SetAcStatusRequest
+### HVACZone
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| desiredStatus | [AcStatusEnum](#messages-AcStatusEnum) | | The desired status of A/C |
+| zone | [HVACZone.Zone](#messages-hvac-HVACZone-Zone) | | HVAC Zone |
+| target_temperature | [Temperature](#messages-hvac-Temperature) | | Target temperature |
+
+<a name="messages-hvac-PreconditionRequest"></a>
-<a name="messages-SetTemperatureReply"></a>
+### PreconditionRequest
-### SetTemperatureReply
-@brief
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| tempStatus | [SetTempStatusEnum](#messages-SetTempStatusEnum) | | |
+| hvac_zones | [HVACZone](#messages-hvac-HVACZone) | repeated | List of HVAC zones to precondition |
+| start_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | For scheduled preconditioning, set the start_time to the desired future time. For on-demand preconditioning, leave the start_time unset. |
+
+<a name="messages-hvac-PreconditionResponse"></a>
-<a name="messages-SetTemperatureRequest"></a>
+### PreconditionResponse
-### SetTemperatureRequest
-@brief
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
-| temperature | [float](#float) | | The desired cabin temperature in degree Celsius |
+| status | [PreconditionResponse.Status](#messages-hvac-PreconditionResponse-Status) | | Status of the precondition request |
+| message | [string](#string) | | Optional message |
+
+
+
+
+
+
+<a name="messages-hvac-Temperature"></a>
+
+### Temperature
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| value | [float](#float) | | Temperature value |
+| unit | [string](#string) | | Temperature unit (e.g., &#34;Celsius&#34;, &#34;Fahrenheit&#34;) |
@@ -547,28 +568,44 @@ services deeper in the vehicle or the cloud services.
-<a name="messages-AcStatusEnum"></a>
+<a name="messages-hvac-HVACState-State"></a>
+
+### HVACState.State
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| OFF | 0 | |
+| HEATING | 1 | |
+| COOLING | 2 | |
+| IDLE | 3 | |
+
+
+
+<a name="messages-hvac-HVACZone-Zone"></a>
-### AcStatusEnum
+### HVACZone.Zone
| Name | Number | Description |
| ---- | ------ | ----------- |
-| ON | 0 | |
-| OFF | 1 | |
-| UKNONWN_ERROR | 2 | |
+| DRIVER | 0 | |
+| PASSENGER | 1 | |
+| REAR_LEFT | 2 | |
+| REAR_RIGHT | 3 | |
-<a name="messages-SetTempStatusEnum"></a>
+<a name="messages-hvac-PreconditionResponse-Status"></a>
-### SetTempStatusEnum
+### PreconditionResponse.Status
| Name | Number | Description |
| ---- | ------ | ----------- |
-| TEMP_SUCCESS | 0 | |
-| TEMP_ERROR | 1 | |
+| SUCCESS | 0 | |
+| FAILURE | 1 | |
+| PENDING | 2 | |