diff --git a/docs/developer/packet-reference/0x41-set-request/0x01-set-settings.md b/docs/developer/packet-reference/0x41-set-request/0x01-set-settings.md index e175ef2..ba116d8 100644 --- a/docs/developer/packet-reference/0x41-set-request/0x01-set-settings.md +++ b/docs/developer/packet-reference/0x41-set-request/0x01-set-settings.md @@ -1,26 +1,29 @@ -# Command `0x01`: Set Settings +# Command `0x01` - Set Settings -This command is used to issue a new operation state to the heat pump. It controls core behaviors like power, mode, +This command is used to issue a new operation state to the heat pump. It controls core behaviors like power, mode, target temperature, and similar. -| Byte | Purpose | Possible Values | Supported by mUART | Notes | -|------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------|--------------------|----------------------------------------------------------------| -| 0 | Command Type | 0x01 | Yes | -| 1-2 | Update Flags | Traditional hex flags | Partially | Indicates which parameters to update. | -| 3 | Power | 0x00: Off
0x01: On
0x02: Test Mode | No | Update flag 0x0001 | -| 4 | Operating Mode | See below | No | Update flag 0x0002 | -| 5 | Legacy Target Temperature | See [[Temperature Units\|Special Data Types#Temperature Units]] | | Update flag 0x0004 | -| 6 | Fan | See below | | Update flag 0x0008
Not all values supported for all units. | -| 7 | Vertical Vane | 0x00: Auto
0x01 - 0x05: Position X
0x07: Swing | | Update flag 0x0010
Defaults to 0x5 on air handlers (?) | +| Byte | Purpose | Possible Values | Supported by mUART | Notes | +|------|---------------------------|-------------------------------------------------|--------------------|----------------------------------------------------------------| +| 0 | Command Type | 0x01 | Yes | +| 1-2 | Update Flags | Traditional hex flags | Partially | Indicates which parameters to update. | +| 3 | Power | 0x00: Off
0x01: On
0x02: Test Mode | No | Update flag 0x0001 | +| 4 | Operating Mode | See [Operating Modes](#operating-modes) | No | Update flag 0x0002 | +| 5 | Legacy Target Temperature | See [Legacy Setpoint Temperatures][legacy-temp] | | Update flag 0x0004 | +| 6 | Fan | See [Fan Modes](#fan-modes) | | Update flag 0x0008
Not all values supported for all units. | +| 7 | Vertical Vane | See [Vertical Vane](#vertical-vane) | | Update flag 0x0010
Defaults to 0x5 on air handlers (?) | | 8 | | 9 | | 10 | -| 11 | Prohibit Flags | See below | | Update Flag 0x0040 | +| 11 | Prohibit Flags | See [Prohibit Flags](#prohibit-flags) | | Update Flag 0x0040 | | 12 | -| 13 | Horizontal Vane | 0x00: Auto
0x01: Full Left
0x02: Left
0x03: Center
0x04: Right
0x05: Full Right
0x08: Split
0x0C: Swing | | Update Flag 0x0100 | -| 14 | Target Temperature | Varies
See [[Temperature Units\|Special Data Types#Temperature Units]] | | Update Flag 0x0004.
Takes priority over legacy temperature | +| 13 | Horizontal Vane | See [Vertical Vane](#vertical-vane) | | Update Flag 0x0100 | +| 14 | Target Temperature | See [Enhanced Temperatures][enhanced-temp] | | Update Flag 0x0004.
Takes priority over legacy temperature | | 15 | +[legacy-temp]: /developer/data-types/temperature-units#legacy-setpoint-temperatures +[enhanced-temp]: /developer/data-types/temperature-units#enhanced-temperatures + ### Sample Packets ``` @@ -29,18 +32,18 @@ target temperature, and similar. ## Operating Modes -| Value | Name | Notes | -|-------|------------|--------------------------------------------------| -| 1 | Heat | | -| 2 | Dehumidify | | -| 3 | Cool | | -| 7 | Fan | | -| 8 | Auto | Chooses mode based on current temp and setpoint. | -| 9 | i-see Heat | Cannot be set | -| 10 | i-see Dry | Cannot be set | -| 11 | i-see Cool | Cannot be set | -| 33 | Auto Heat | Cannot be set, Kumo only? | -| 35 | Auto Cool | Cannot be set, Kumo only? | +| Value | Name | Settable | Notes | +|-------|------------|----------|---------------------------------| +| 1 | Heat | Yes | | +| 2 | Dehumidify | Yes | | +| 3 | Cool | Yes | | +| 7 | Fan | Yes | | +| 8 | Auto | Yes | | +| 9 | i-see Heat | No | | +| 10 | i-see Dry | No | | +| 11 | i-see Cool | No | | +| 33 | Auto Heat | No | Only reported in Kumo Cloud API | +| 35 | Auto Cool | No | Only reported in Kumo Cloud API | Operating mode 8 will use the current temperature of the room as well as the current setpoint to determine whether to heat or cool. Mode 8 will be returned regardless of the status of the i-see feature. @@ -66,14 +69,44 @@ Supported fan modes can be extracted from the Extended Connect Response packet. | 5 | High | | 6 | Very High (Powerful) | +## Vertical Vane + +| Value | Name | +|-------|------------------| +| 0 | Auto Position | +| 1 | Position 1 (0°) | +| 2 | Position 2 | +| 3 | Position 3 (45°) | +| 4 | Position 4 | +| 5 | Position 5 (90°) | +| 7 | Swing Mode | + +If set on a dual vane unit, both the left and right vanes will update in sync. There is not currently a known way to +set each vane side independently. + ## Prohibit Flags The exact intent of this byte is unknown, but it appears to prevent certain changes from being made so long as the prohibit flags are in place. - | Bit | Purpose | Supported by mUART | Notes | |------|---------------------|--------------------|-------| | 0x01 | Lock Power | | | | 0x02 | Lock Operating Mode | | | -| 0x04 | Lock Temperature | | | \ No newline at end of file +| 0x04 | Lock Temperature | | | + +## Horizontal Vane + +| Value | Name | Symbol | +|-------|------------|--------| +| 0 | Auto | | +| 1 | Full Left | `<<` | +| 2 | Left | `<` | +| 3 | Center | `\|` | +| 4 | Right | `>` | +| 5 | Full Right | `>>` | +| 8 | Split | `<>` | +| 13 | Swing Mode | | + +Note that auto mode may not be supported on all units, and appears to get overwritten with relative frequency (but +*does* appear to otherwise work). \ No newline at end of file diff --git a/docs/developer/packet-reference/0x41-set-request/0x07-set-remote-temperature.md b/docs/developer/packet-reference/0x41-set-request/0x07-set-remote-temperature.md index 1f2d728..9fbcb7c 100644 --- a/docs/developer/packet-reference/0x41-set-request/0x07-set-remote-temperature.md +++ b/docs/developer/packet-reference/0x41-set-request/0x07-set-remote-temperature.md @@ -1,13 +1,16 @@ -# Command `0x07`: Set Remote Temperature +# Command `0x07` - Set Remote Temperature This command is normally issued by a MHK thermostat and sent to the heat pump to control the room temperature. -| Byte | Purpose | Possible Values | Supported by mUART | Notes | -|------|-----------------------------|-------------------------------------------------------------------------------------|--------------------|-------| -| 0 | Command Type | 0x07 | Yes | | -| 1 | Flags | 0x00 Use Internal
0x01 Remote Temp | Yes | -| 2 | Remote Temperature | See [[Legacy Current Temperatures\|Special Data Types#Legacy Current Temperatures]] | ? | -| 3 | Extended Remote Temperature | See [[Enhanced Temperatures\|Special Data Types#Enhanced Temperatures]] | Yes | +| Byte | Purpose | Possible Values | Supported by mUART | Notes | +|------|-----------------------------|------------------------------------------------|--------------------|-------| +| 0 | Command Type | 0x07 | Yes | | +| 1 | Flags | 0x00 Use Internal
0x01 Remote Temp | Yes | +| 2 | Remote Temperature | See [Legacy Current Temperatures][legacy-temp] | Yes | +| 3 | Extended Remote Temperature | See [Enhanced Temperatures][enhanced-temp] | Yes | -When decoding this value, byte 3 takes predecence over byte 2. When sending this packet, it appears to be safe to just +When decoding this value, byte 3 takes precedence over byte 2. When sending this packet, it appears to be safe to just send byte 3 though be aware that this may cause an issue with older units. + +[legacy-temp]: /developer/data-types/temperature-units#legacy-current-temperatures +[enhanced-temp]: /developer/data-types/temperature-units#enhanced-temperatures \ No newline at end of file diff --git a/docs/developer/packet-reference/0x41-set-request/0x08-set-run-status.md b/docs/developer/packet-reference/0x41-set-request/0x08-set-run-state.md similarity index 62% rename from docs/developer/packet-reference/0x41-set-request/0x08-set-run-status.md rename to docs/developer/packet-reference/0x41-set-request/0x08-set-run-state.md index b816bba..6affbfb 100644 --- a/docs/developer/packet-reference/0x41-set-request/0x08-set-run-status.md +++ b/docs/developer/packet-reference/0x41-set-request/0x08-set-run-state.md @@ -1,9 +1,11 @@ -# Command `0x08` - Set Run Status +# Command `0x08` - Set Run State -Seems to correlate (at least partially) with command 0x09. Name/other flags TBD. +Seems to correlate (at least partially) with [`0x62 0x09` - Get Run State][get-run-state]. Name/other flags TBD. | Byte | Purpose | Possible Values | Supported by mUART | Notes | |------|--------------|------------------------|--------------------|---------------------------------------| | 0 | Command Type | 0x01 | Yes | | 1-2 | Update Flags | Traditional hex flags | Partially | Indicates which parameters to update. | -| 3 | Filter Reset | 0x00: No
0x01: Yes | | Update flag 0x0001 | \ No newline at end of file +| 3 | Filter Reset | 0x00: No
0x01: Yes | | Update flag 0x0001 | + +[get-run-state]: /developer/packet-reference/0x62-get-response/0x09-get-run-state \ No newline at end of file diff --git a/docs/developer/packet-reference/0x41-set-request/0x1F-0x21-set-functions.md b/docs/developer/packet-reference/0x41-set-request/0x1F-0x21-set-functions.md index 9d78d09..cca4a5b 100644 --- a/docs/developer/packet-reference/0x41-set-request/0x1F-0x21-set-functions.md +++ b/docs/developer/packet-reference/0x41-set-request/0x1F-0x21-set-functions.md @@ -12,10 +12,13 @@ only functions to update need be sent), clients should take care to get active f change, and then send this command. Likewise, clients should take care to only send packets for the relevant page for their units (e.g. do not send a set for a function normally in Page 2 as Page 1). -Settings may be retrieved via [[Get Request 0x20 and 0x22\|(0x62) Get Response#Type 0x20 and 0x22 - Get Functions]]. +Settings may be retrieved via [`0x62 0x20` - Get Functions][get-functions]. -| Byte | Purpose | Possible Values | Supported by mUART | Notes | -|------|-------------------|-----------------------------------------------------------------|--------------------|------------------------------------------| -| 0 | Command Type | 0x1F, 0x21 | No | -| 1-14 | Function Settings | See [[Function Settings\|Special-Data-Types#function-settings]] | | New settings to apply | -| 15 | End Byte | 0x00 | | Unsure if 0x00 has a specific value here | +| Byte | Purpose | Possible Values | Supported by mUART | Notes | +|------|-------------------|----------------------------------------|--------------------|------------------------------------------| +| 0 | Command Type | 0x1F, 0x21 | No | +| 1-14 | Function Settings | See [Function Settings][function-type] | | New settings to apply | +| 15 | End Byte | 0x00 | | Unsure if 0x00 has a specific value here | + +[get-functions]: /developer/packet-reference/0x62-get-response/0x20-0x22-get-functions +[function-type]: /developer/data-types/function-settings \ No newline at end of file diff --git a/docs/developer/packet-reference/0x41-set-request/0xA6-kumo-sensor-status.md b/docs/developer/packet-reference/0x41-set-request/0xA6-kumo-sensor-status.md index ff7b171..fa44e58 100644 --- a/docs/developer/packet-reference/0x41-set-request/0xA6-kumo-sensor-status.md +++ b/docs/developer/packet-reference/0x41-set-request/0xA6-kumo-sensor-status.md @@ -46,4 +46,4 @@ Unconfirmed, needs validation from people who have relevant hardware. |------|------------------------------------------------------------------------------------------| | 0x01 | [MHK2](https://mylinkdrive.com/USA/Controls/MHK2?product&categoryName=Controls)/MHK1 (?) | | 0x02 | Outdoor Sensor (MOS1?) | -| 0x04 | [Indoor Sensor](https://mylinkdrive.com/USA/Controls/PAC_USWHS003_TH_1) | +| 0x04 | [Indoor Sensor](https://mylinkdrive.com/USA/Controls/PAC_USWHS003_TH_1) (?) | diff --git a/docs/developer/packet-reference/0x41-set-request/0xA8-unknown-kumo-packet.md b/docs/developer/packet-reference/0x41-set-request/0xA8-unknown-kumo-packet.md index e556ef1..0bd5d71 100644 --- a/docs/developer/packet-reference/0x41-set-request/0xA8-unknown-kumo-packet.md +++ b/docs/developer/packet-reference/0x41-set-request/0xA8-unknown-kumo-packet.md @@ -2,19 +2,22 @@ Sent from the MHK2 to a Kumo Cloud unit, captured via logic analyzer. -| Byte | Purpose | Possible Values | Supported by mUART | Notes | -|------|------------------------|---------------------------------------------------|--------------------|-------------------------------------| -| 0 | Command Type | 0xA8 | No | | -| 1 | Flags | Traditional hex flags | | Determines which fields to process | -| 2-5 | Thermostat Time (?) | See [[Timestamps\|Special Data Types#Timestamps]] | | Flag 0x01 | -| 6 | ??? | 0x00, 0x01 | | Flag 0x02 | -| 7 | ??? | 0x00, 0x01, 0x02 | | Flag 0x04 | -| 8 | Auto Heat Setpoint (?) | Varies | | Flag 0x08
Resets if invalid (?) | -| 9 | Auto Cool Setpoint (?) | Varies | | Flag 0x10
Resets if invalid (?) | -| 10 | ??? | 0x00, 0x01 | | Flag 0x20 | -| 11 | ??? | 0x00, 0x01 | | Flag 0x40 | +| Byte | Purpose | Possible Values | Supported by mUART | Notes | +|------|------------------------|-----------------------------|--------------------|-------------------------------------| +| 0 | Command Type | 0xA8 | No | | +| 1 | Flags | Traditional hex flags | | Determines which fields to process | +| 2-5 | Thermostat Time (?) | See [Timestamps][timestamp] | | Flag 0x01 | +| 6 | ??? | 0x00, 0x01 | | Flag 0x02 | +| 7 | ??? | 0x00, 0x01, 0x02 | | Flag 0x04 | +| 8 | Auto Heat Setpoint (?) | Varies | | Flag 0x08
Resets if invalid (?) | +| 9 | Auto Cool Setpoint (?) | Varies | | Flag 0x10
Resets if invalid (?) | +| 10 | ??? | 0x00, 0x01 | | Flag 0x20 | +| 11 | ??? | 0x00, 0x01 | | Flag 0x40 | + +[timestamp]: /developer/data-types/timestamps + +### Sample Packets -Sample Packets: ``` [FC 41 01 30 10] A8 01 1C DD 51 E0 00 00 00 00 00 00 00 00 00 00 [AB] [FC 41 01 30 10] A8 01 1C DD 51 EA 00 00 00 00 00 00 00 00 00 00 [A1] diff --git a/docs/developer/packet-reference/0x42-get-request.md b/docs/developer/packet-reference/0x42-get-request.md index 02b5f8c..6ba0f58 100644 --- a/docs/developer/packet-reference/0x42-get-request.md +++ b/docs/developer/packet-reference/0x42-get-request.md @@ -1,8 +1,8 @@ # Packet `0x42`: Get Request This packet appears to be a generic "get" command to the HVAC unit, and is used to query information about the heat -pump. This packet type is analogous to an HTTP `GET` request. The response to this packet will be a (0x62) Get Response -packet. +pump. This packet type is analogous to an HTTP `GET` request. The response to this packet will be a +[`0x62` - Get Response][get-response] packet. The first byte of this packet contains the command type to retrieve information about, which is also used as a disambiguator. This field does not appear to normally have a body under standard operating conditions - except for @@ -13,5 +13,7 @@ disambiguator. This field does not appear to normally have a body under standard | 0 | CommandType | Multiple | Partial | | 1-15 | Body? | N/A | N/A | Typically all zeroes | -The command types for this packet are listed in the (0x62) Get Response page, as bodies usually aren't relevant -here. \ No newline at end of file +The command types for this packet are listed in the [`0x62` - Get Response][get-response], as bodies usually aren't +relevant here. + +[get-response]: 0x62-get-response \ No newline at end of file diff --git a/docs/developer/packet-reference/0x5A-connect-request.md b/docs/developer/packet-reference/0x5A-connect-request.md index 41391f4..3720394 100644 --- a/docs/developer/packet-reference/0x5A-connect-request.md +++ b/docs/developer/packet-reference/0x5A-connect-request.md @@ -2,7 +2,7 @@ This packet appears to be sent by the thermostat as part of establishing communication to a heat pump or Kumo Cloud unit. It appears to be an initial communication handshake attempt. The other device will respond with a -(0x7A) Connect Response when it is available. +[`0x7A` - Connect Response](0x7A-connect-response) when it is available. | Byte | Purpose | Possible Values | Supported by mUART | Notes | |------|--------------|-----------------|--------------------|-------| diff --git a/docs/developer/packet-reference/0x5B-extended-connect-request.md b/docs/developer/packet-reference/0x5B-extended-connect-request.md index f81481f..235eafb 100644 --- a/docs/developer/packet-reference/0x5B-extended-connect-request.md +++ b/docs/developer/packet-reference/0x5B-extended-connect-request.md @@ -1,7 +1,8 @@ # Packet `0x5B`: Extended Connect Request Appears to be a request for information about the device on the other side as part of auto-configuration. Sent by the -thermostat to the heat pump/Kumo unit. A response is expected in the form of a (0x7B) Extended Connect Response packet. +thermostat to the heat pump/Kumo unit. A response is expected in the form of a +[`0x7B` - Extended Connect Response](0x7B-extended-connect-response) packet. | Byte | Purpose | Possible Values | Supported by mUART | Notes | |------|--------------|-----------------|--------------------|-------| diff --git a/docs/developer/packet-reference/0x61-set-response.md b/docs/developer/packet-reference/0x61-set-response.md index 46e066a..b7c1d83 100644 --- a/docs/developer/packet-reference/0x61-set-response.md +++ b/docs/developer/packet-reference/0x61-set-response.md @@ -1,7 +1,7 @@ # Packet `0x61`: Set Response -This packet appears to serve as an acknowledgement to a (0x41) Set Request packet. It does not appear to contain any -sort of identification of which packet it is responding to. +This packet appears to serve as an acknowledgement to a [`0x41` - Set Request](0x41-set-request) packet. It does not +appear to contain any sort of identification of which packet it is responding to. | Byte | Purpose | Possible Values | Supported by mUART | Notes | |------|--------------|------------------------|--------------------|-------| diff --git a/docs/developer/packet-reference/0x62-get-response/0x02-get-settings.md b/docs/developer/packet-reference/0x62-get-response/0x02-get-settings.md index a35423d..99b043c 100644 --- a/docs/developer/packet-reference/0x62-get-response/0x02-get-settings.md +++ b/docs/developer/packet-reference/0x62-get-response/0x02-get-settings.md @@ -1,8 +1,8 @@ # Command `0x02` - Get Current Settings This packet's structure and contained information is very similar to that of -[`0x41 0x01` - Set Settings](/developer/packet-reference/0x41-set-request/0x01-set-settings), and a significant amount -of data appears to be shared. Please consult that page for additional information about the below fields. +[`0x41 0x01` - Set Settings][set-settings], and a significant amount of data appears to be shared. Please consult that +page for additional information about the below fields. | Byte | Purpose | Possible Values | Supported by mUART | Notes | |------|---------------------------|-----------------|--------------------|-------| @@ -21,6 +21,8 @@ of data appears to be shared. Please consult that page for additional informatio | 14 | | 15 | +[set-settings]: /developer/packet-reference/0x41-set-request/0x01-set-settings + ## Horizontal Vanes For currently unknown reasons, certain units will have the most significant bit (0x80) set for the horizontal vane diff --git a/docs/developer/packet-reference/0x62-get-response/0x03-get-temperatures.md b/docs/developer/packet-reference/0x62-get-response/0x03-get-temperatures.md index b3eeb27..f93a7f9 100644 --- a/docs/developer/packet-reference/0x62-get-response/0x03-get-temperatures.md +++ b/docs/developer/packet-reference/0x62-get-response/0x03-get-temperatures.md @@ -2,21 +2,24 @@ This command is used to retrieve temperature information from the heat pump. -| Byte | Purpose | Possible Values | Supported by mUART | Notes | -|-------|----------------------------|-------------------------------------------------------------------------------------|--------------------|--------------------------------------------------------------------------------| -| 0 | Command | 0x03 | Yes | -| 3 | Current Legacy Temperature | See [[Legacy Current Temperatures\|Special Data Types#Legacy Current Temperatures]] | | | -| 5 | Outdoor Unit Temperature | See [[Enhanced Temperatures\|Special Data Types#Enhanced Temperatures]] | | Rounded to nearest whole °C
If 0x00, unsupported. | -| 6 | Current Temperature | See [[Enhanced Temperatures\|Special Data Types#Enhanced Temperatures]] | | | -| 7 | ??? | See [[Enhanced Temperatures\|Special Data Types#Enhanced Temperatures]] | | Claimed to be the most recent value, but observations do not match that. | -| 8 | ??? | 0x00, 0xFE | | || -| 9 | ??? | 0x42, 0x00 | | || -| 11-13 | Timestamp? | Scalar | | Appears to be minutes since an unknown event.
Not sent for all unit types. | +| Byte | Purpose | Possible Values | Supported by mUART | Notes | +|-------|----------------------------|------------------------------------------------|--------------------|--------------------------------------------------------------------------------| +| 0 | Command | 0x03 | Yes | +| 3 | Current Legacy Temperature | See [Legacy Current Temperatures][legacy-temp] | | | +| 5 | Outdoor Unit Temperature | See [Enhanced Temperatures][enhanced-temp] | | Rounded to nearest whole °C
If 0x00, unsupported. | +| 6 | Current Temperature | See [Enhanced Temperatures][enhanced-temp] | | | +| 7 | ??? | See [Enhanced Temperatures][enhanced-temp] | | Claimed to be the most recent value, but observations do not match that. | +| 8 | ??? | 0x00, 0xFE | | | +| 9 | ??? | 0x42, 0x00 | | | +| 11-13 | Timestamp? | Scalar | | Appears to be minutes since an unknown event.
Not sent for all unit types. | Bytes 6 and 7 are particularly confusing. First off, byte 7 is not sent by all units. SwiCago's thread has identified Byte 7 to be the "most recent" reading, while Byte 6 is the last reading. While this works for external temperature sensors, it does not work for the internal sensor - see below sample packet where it goes from 0xA9 to 0xAC and -completely ignores the 0xB0). Kumo's code claims that byte 6 is `room_temp_a`, and does not use byte 7 at all. +completely ignores the 0xB0. Kumo's code claims that byte 6 is `room_temp_a`, and does not use byte 7 at all. + +[legacy-temp]: /developer/data-types/temperature-units#legacy-current-temperatures +[enhanced-temp]: /developer/data-types/temperature-units#enhanced-temperatures ### Sample Packets diff --git a/docs/developer/packet-reference/0x62-get-response/0x05-get-timer-info.md b/docs/developer/packet-reference/0x62-get-response/0x05-get-timer-info.md index 190591b..c91d4de 100644 --- a/docs/developer/packet-reference/0x62-get-response/0x05-get-timer-info.md +++ b/docs/developer/packet-reference/0x62-get-response/0x05-get-timer-info.md @@ -1,7 +1,8 @@ # Command `0x05` - Get Timer Info :::note -This packet's information was pulled from [SwiCago's HeatPump](https://github.com/SwiCago/HeatPump/) library. It has yet to be verified. +This packet's information was pulled from [SwiCago's HeatPump](https://github.com/SwiCago/HeatPump/) library. It has yet +to be verified. ::: diff --git a/docs/developer/packet-reference/0x62-get-response/0x09-get-run-state.md b/docs/developer/packet-reference/0x62-get-response/0x09-get-run-state.md index 6aeb041..0c7d287 100644 --- a/docs/developer/packet-reference/0x62-get-response/0x09-get-run-state.md +++ b/docs/developer/packet-reference/0x62-get-response/0x09-get-run-state.md @@ -4,12 +4,12 @@ This command returns information about the heat pump's current run status. It is unclear if this is called as part of normal operation. -| Byte | Purpose | Possible Values | Supported by mUART | Notes | -|------|------------------|--------------------------------------------------------------------------|--------------------|-------------------------------------------------------------------------------------------| -| 0 | CommandType | 0x09 | | -| 3 | Status Flags | See Below | | A bitmask of flags indicating the heat pump's current status. | -| 4 | Actual Fan Speed | See Below | | The speed the fan is currently operating at (may be different from fan setting in `0x02`) | -| 5 | Auto Mode? | 0x00 - N/A
0x01 - Cool
0x02 - Heat
0x40 - ???
0x41 - ??? | No | Per swicago lib, idle mode but has other values. | +| Byte | Purpose | Possible Values | Supported by mUART | Notes | +|------|------------------|---------------------------------------------|--------------------|-------------------------------------------------------------------------------------------| +| 0 | CommandType | 0x09 | | +| 3 | Status Flags | See [Status Flags](#status-flags) | | A bitmask of flags indicating the heat pump's current status. | +| 4 | Actual Fan Speed | See [Actual Fan Speeds](#actual-fan-speeds) | | The speed the fan is currently operating at (may be different from fan setting in `0x02`) | +| 5 | Auto Mode? | See [Auto Mode](#auto-modes) | No | Per swicago lib, idle mode but has other values. | ### Example Packets @@ -45,3 +45,13 @@ below). Active research about these values is currently being tracked as part of | 4 | Powerful | High | | 5 | Super Powerful | Powerful | | 6 | Super Quiet | Quiet | + +## Auto Modes + +| Value | Name | +|-------|------| +| 0x00 | N/A | +| 0x01 | Cool | +| 0x02 | Heat | +| 0x41 | ??? | +| 0x42 | ??? | \ No newline at end of file diff --git a/docs/developer/packet-reference/0x62-get-response/0x20-0x22-get-functions.md b/docs/developer/packet-reference/0x62-get-response/0x20-0x22-get-functions.md index f2e2c38..d78f159 100644 --- a/docs/developer/packet-reference/0x62-get-response/0x20-0x22-get-functions.md +++ b/docs/developer/packet-reference/0x62-get-response/0x20-0x22-get-functions.md @@ -3,11 +3,13 @@ Sent as a response to requesting current installer functions from the heat pump. Command `0x20` denotes the first page of 14 functions, while command `0x21` denotes the second page. -Settings may be edited via [`0x41 0x1F` - Set Functions](/developer/packet-reference/0x41-set-request/0x1F-0x21-set-functions), but care +Settings may be edited via [`0x41 0x1F` - Set Functions][set-functions], but care must be taken when using this function. | Byte | Purpose | Possible Values | Supported by mUART | Notes | |------|-------------------|-----------------------------------------------------------------|--------------------|------------------------------------------| | 0 | Command Type | 0x20, 0x22 | No | | 1-14 | Function Settings | See [[Function Settings\|Special-Data-Types#function-settings]] | | | -| 15 | End Byte | 0x00 | | Unsure if 0x00 has a specific value here | \ No newline at end of file +| 15 | End Byte | 0x00 | | Unsure if 0x00 has a specific value here | + +[set-functions]: /developer/packet-reference/0x41-set-request/0x1F-0x21-set-functions diff --git a/docs/developer/packet-reference/0x62-get-response/0xA9-kumo-adapter-state.md b/docs/developer/packet-reference/0x62-get-response/0xA9-kumo-adapter-state.md index 37260c3..b54dafe 100644 --- a/docs/developer/packet-reference/0x62-get-response/0xA9-kumo-adapter-state.md +++ b/docs/developer/packet-reference/0x62-get-response/0xA9-kumo-adapter-state.md @@ -8,17 +8,18 @@ The below table is speculative and not confirmed. Implementations should not use these definitions until they've been verified more closely. ::: -| Byte | Purpose | Possible Values | Supported by mUART | Notes | -|------|--------------------|---------------------------------------------------|--------------------|-------| -| 0 | CommandType | 0xA9 | | | -| 1-4 | Adapter Timestamp | See [[Timestamps\|Special Data Types#Timestamps]] | | | -| 5 | ??? | 0x00 | | | -| 6 | ??? | 0x00, 0x01 | | | -| 7 | Auto Heat Setpoint | Enhanced Temperature | No | | -| 8 | Auto Cool Setpoint | Enhanced Temperature | No | | -| 10 | ??? | 0x00, 0x07 | | | -| 12 | ??? | 0x00 | | | - +| Byte | Purpose | Possible Values | Supported by mUART | Notes | +|------|--------------------|---------------------------------|--------------------|-------| +| 0 | CommandType | 0xA9 | | | +| 1-4 | Adapter Timestamp | See See [Timestamps][timestamp] | | | +| 5 | ??? | 0x00 | | | +| 6 | ??? | 0x00, 0x01 | | | +| 7 | Auto Heat Setpoint | Enhanced Temperature | No | | +| 8 | Auto Cool Setpoint | Enhanced Temperature | No | | +| 10 | ??? | 0x00, 0x07 | | | +| 12 | ??? | 0x00 | | | + +[timestamp]: /developer/data-types/timestamps ### Sample Packets diff --git a/docs/developer/packet-reference/0x7A-connect-response.md b/docs/developer/packet-reference/0x7A-connect-response.md index bf0138e..6cc8132 100644 --- a/docs/developer/packet-reference/0x7A-connect-response.md +++ b/docs/developer/packet-reference/0x7A-connect-response.md @@ -1,7 +1,7 @@ # Packet `0x7A`: Connect Response -This packet appears to be sent as a response to a (0x5A) Connect Request packet. It does not appear to contain any -information beyond finishing a connection handshake. +This packet appears to be sent as a response to a [`0x5A` - Connect Request](0x5A-connect-request) packet. It does not +appear to contain any information beyond finishing a connection handshake. | Byte | Purpose | Possible Values | Supported by mUART | Notes | |------|---------|-----------------|--------------------|-------| diff --git a/docs/developer/packet-reference/0x7B-extended-connect-response.md b/docs/developer/packet-reference/0x7B-extended-connect-response.md index d567d72..0d7471f 100644 --- a/docs/developer/packet-reference/0x7B-extended-connect-response.md +++ b/docs/developer/packet-reference/0x7B-extended-connect-response.md @@ -1,7 +1,8 @@ # Packet `0x7B`: Extended Connect Response -A response to an extended connect request, as sent in a (0x5B) Extended Connect Request packet. Appears to be used to -identify information about the unit that the thermostat is connected to. +A response to an extended connect request, as sent in a +[`0x5B` - Extended Connect Request](0x5B-extended-connect-request) packet. Appears to be used to identify information +about the unit that the thermostat is connected to. | Byte | Purpose | Possible Values | Supported by mUART | Notes | |------|-------------------|-----------------|--------------------|-------| @@ -9,6 +10,8 @@ identify information about the unit that the thermostat is connected to. | 1-6 | TBD | 0x03 | | | 7-15 | Unit Capabilities | (See below) | | +## Unit Capabilities + | Byte | Bitmask | Purpose | Notes | |------|---------|----------------------------------------|------------------------------------------------------------| | 7 | 0x01 | ??? | Observed true | @@ -44,14 +47,6 @@ identify information about the unit that the thermostat is connected to. Bytes 10-15 appear to only be sent if the extended temperature range is supported by the unit. -### Sample Packets - -``` -[FC.7B.01.30.10] C9.03.00.20.00.0A.07.05.E4.25.A6.BC.94.B8.A6.B8 2D // SVZ-KP30NA -[FC.7B.01.30.10] C9.03.00.20.00.14.07.75.0C.05.A0.BE.94.BE.A0.BE A9 // MSZ-GL06NA -[FC.7B.01.30.10] C9.03.00.09.04.14.07.75.00.00.00.00.00.00.00.00 DB // MSZ-GE35VA -``` - ## Determining Fan Speeds The number of allowed fan speeds is determined by fan bits A, B, and C, as calculated below: @@ -88,4 +83,12 @@ Known fan speed values (and model numbers associated with certain fan speed valu | 3 | SVZ-KP30NA | 0x02 (Low)
0x03 (Medium)
0x05 (High) | | 5 | MSZ-GS12NA | 0x01 (Quiet)
0x02 (Low)
0x03 (Medium)
0x05 (High)
0x06 (Very High) | -![image](https://github.com/Sammy1Am/mitsubishi-uart/assets/5192145/ffed7a33-2eb9-4d34-83e0-924df8ac5642) \ No newline at end of file +![image](https://github.com/Sammy1Am/mitsubishi-uart/assets/5192145/ffed7a33-2eb9-4d34-83e0-924df8ac5642) + +## Sample Packets + +``` +[FC.7B.01.30.10] C9.03.00.20.00.0A.07.05.E4.25.A6.BC.94.B8.A6.B8 2D // SVZ-KP30NA +[FC.7B.01.30.10] C9.03.00.20.00.14.07.75.0C.05.A0.BE.94.BE.A0.BE A9 // MSZ-GL06NA +[FC.7B.01.30.10] C9.03.00.09.04.14.07.75.00.00.00.00.00.00.00.00 DB // MSZ-GE35VA +```