Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rbroker committed May 20, 2023
1 parent 26bc222 commit 7a3db97
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 43 deletions.
85 changes: 42 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ Uses the CN105 connector on the Cased Flow Temp Controller (FTC6 in my setup) to

<p float="left">
<img src="img/config_page.png" height="640" />
<img src="img/diagnostics_page.png" height="640" />
<img src="img/hp_state.png" height="640" />
</p>

![HomeAssistant MQTT Auto Discovery](img/ha_discover.png)

## Hardware Dependencies
- ESP32-compatible development board (I'm using a generic ESP32S2 Dev Module)
- Will almost certainly exceed the memory budgets on an ESP8266.
- ESP32-compatible development board (I'm using a LOLIN S2 Mini)
- Will almost certainly exceed the memory budgets on an ESP8266, as I've not been super careful about memory usage.
- CN105 female connector + pigtails, as described [here](https://github.com/SwiCago/HeatPump#Demo-Circuit).

## Library Dependencies
Expand Down Expand Up @@ -41,101 +41,100 @@ Setting a device password will cause the web interface to require the password t

It's strongly recommended to enable this setting in case the device falls back to broadcasting an open access point, as it will retain other configuration values (MQTT passwords, server, Wifi SSID/Password) which may then be readable by anyone.

*Default*: `""`

*Required*: No
| Default | Required |
| ------- | -------- |
| `""` | No |

### Serial Rx Port
The GPIO pin number which should be used for Serial data receive.

*Default*: `33`

*Required*: Yes
| Default | Required |
| ------- | -------- |
| 33 | Yes |

### Serial Tx Port
The GPIO pin number which should be used for Serial data transmit.

*Default*: `34`

*Required*: Yes

| Default | Required |
| ------- | -------- |
| 34 | Yes |
### Serial Tx Port
The GPIO pin number which should be used for the status LED. The following flashing patterns are possible:

- 2 short flashes, followed by one long flash: Serial connection to the Heat Pump has not been established.
- Steady long flashes: Network connection to the MQTT server has not been established
- Constantly lit: Status is OK

*Default*: `15`

*Required*: No
| Default | Required |
| ------- | -------- |
| 15 | No |

### Dump Serial Packets
Dump packets sent to/received from the heat pump to the diagnostic log window on the Diagnostics page.

*Default*: `Off`

*Required*: No
| Default | Required |
| ------- | -------- |
| Off | No |

### WiFi SSID
The SSID of the WiFi network which you'd like the device to connect to. When the diagnostics page is loaded, the device will automatically initiate a scan for available WiFi networks and populate the menu when it completes.

Note: If this setting or "WiFi Password" are unset, the device will continue to boot into a captive portal access point.

*Default*: `""`

*Required*: Yes
| Default | Required |
| ------- | -------- |
| `""` | Yes |

### WiFi Password
The passphrase/password which should be used when connecting to the previously specified WiFi SSID.

Note: If this setting or "WiFi SSID" are unset, the device will continue to boot into a captive portal access point.

*Default*: `""`

*Required*: Yes
| Default | Required |
| ------- | -------- |
| `""` | Yes |

### Hostname
The network hostname the device will use to identify itself.

*Default*: `ecodan_ha_local`

*Required*: No
| Default | Required |
| ----------------- | -------- |
| `ecodan_ha_local` | No |

### MQTT Server
The IP address or hostname of the MQTT server on your local network.

*Default*: `""`

*Required*: Yes
| Default | Required |
| ------- | -------- |
| `""` | No |

### MQTT Port
The port on which your MQTT server is listening.

*Default*: `1883`

*Required*: Yes
| Default | Required |
| ------- | -------- |
| 1883 | No |

### MQTT User
The username which should be used when connecting to the specified MQTT Server.

*Default*: `""`

*Required*: Yes
| Default | Required |
| ------- | -------- |
| `""` | No |

### MQTT Password
The password for the given MQTT User.

*Default*: `""`

*Required*: Yes
| Default | Required |
| ------- | -------- |
| `""` | No |

### MQTT Topic
The topic value which the server should use to filter messages related to this heat pump.

*Default*: `ecodan_hp`

*Required*: Yes
| Default | Required |
| ----------- | -------- |
| `ecodan_hp` | Yes |

## See Also
There are a number of existing solutions for connecting to Mitsubish heat pump models via the CN105 connector, I wouldn't have been able to put this together without work already done here:
Expand Down
Binary file modified img/config_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed img/diagnostics_page.png
Binary file not shown.
Binary file modified img/ha_discover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/hp_state.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7a3db97

Please sign in to comment.