Skip to content

Commit

Permalink
more wording tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
KazWolfe authored Jun 7, 2024
1 parent b56c631 commit b5f2d6d
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
15 changes: 12 additions & 3 deletions docs/developer/packet-reference/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,7 @@ that are currently known. These only apply to packets [`0x41` - Set Request][set
| [0xA9][ag-A9] | Thermostat State Download | Kumo -> MHK |
| [0xAA][ag-AA] | Unknown Kumo Packet | MHK -> Kumo |
| [0xAB][ag-AB] | Unknown Kumo Packet | Kumo -> MHK |
| [0xC9][ag-C9] | Identify Base Capabilities | HP -> Kumo/MHK |
| 0xCA | Unknown | Unknown |
| [0xCD][ag-CD] | Unknown Identify Packet | Unknown |

[set-request]: 0x41-set-request/index.mdx
[get-response]: 0x62-get-response/index.mdx
Expand All @@ -98,5 +96,16 @@ that are currently known. These only apply to packets [`0x41` - Set Request][set
[ag-A9]: 0x62-get-response/0xA9-thermostat-state-download.md
[ag-AA]: 0x41-set-request/0xAA-unknown-kumo-packet.md
[ag-AB]: 0x62-get-response/0xAB-unknown-kumo-packet.md

The following command IDs are used as part of the identify cycle:

| Command ID | Name | Communication Flow | Notes |
|---------------|----------------------------|--------------------|---------------------------------|
| [0xC9][ag-C9] | Identify Base Capabilities | HP -> Kumo/MHK | |
| [0xCD][ag-CD] | Unknown Identify Packet | Unknown | |
| 0xCE | Unknown Identify Packet | Unknown | Extracted from KirigamineRemote |
| 0xD0 | Unknown Identify Packet | Unknown | Extracted from KirigamineRemote |
| 0xD1 | Unknown Identify Packet | Unknown | Extracted from KirigamineRemote |

[ag-C9]: 0x7B-identify-response/0xC9-base-capabilities.md
[ac-CD]: 0x7B-identify-response/0xCD-unknown-identify-packet.md
[ag-CD]: 0x7B-identify-response/0xCD-unknown-identify-packet.md
5 changes: 4 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: /
# mUART Project Home

Mitsubishi UART (otherwise known as mUART) is a project to reverse engineer the CN105 protocol used by Mitsubishi
Electric heat pumps and to create a first-class ESPHome component for those heat pumps.
Electric air-to-air heat pumps for the purposes of creating a first-class ESPHome component.

:::tip
In a rush? Check out the [user docs](user) to get started, or the [developer docs](developer) to get hacking!
Expand All @@ -18,6 +18,9 @@ and feature-complete ESPHome component for heat pump control. The project also n
thermostats similar to [akamali/mhk1_mqtt](https://github.com/akamali/mhk1_mqtt), but built in a ESPHome-native way with
a closer focus on hardware interoperability.

This library aims to support most air-to-air heat pumps supported by Kumo Cloud (and likely MELCloud/MELView), with
a focus on providing feature parity with these commercial offerings.

## Features

* Supports adding additional ESPHome sensors as remote temperature sources
Expand Down

0 comments on commit b5f2d6d

Please sign in to comment.