Merge pull request #32 from ericblade/main

fixup README issues
This commit is contained in:
Trammell Hudson
2023-12-04 20:00:26 +01:00
committed by GitHub

View File

@@ -16,19 +16,18 @@ and should prevent most any random attacker on your network from being able to
## Setup
```
pip3 -r requirements.txt
```python3
pip3 install -r requirements.txt
```
Install the Python dependencies; the `sslpsk` one is a little weird
and we might need to revisit it later.
## Authenticate to the cloud servers
![laptop in a clothes washer with a display DoorState:Closed](images/doorclose.jpg)
```
```bash
hc-login $USERNAME $PASSWORD > config.json
```
@@ -44,10 +43,9 @@ the resulting configuration JSON file *should* be sufficient to
connect to the devices on your local network, assuming that
your mDNS or DNS server resolves the names correctly.
## Home Connect to MQTT
```
```bash
hc2mqtt config.json
```
@@ -71,7 +69,7 @@ library.
Example message published to `homeconnect/dishwasher`:
```
```json
{
"state": "Run",
"door": "Closed",
@@ -87,7 +85,7 @@ Example message published to `homeconnect/dishwasher`:
<details>
<summary>Full state information</summary>
```
```json
{
'AllowBackendConnection': False,
'BackendConnected': False,
@@ -152,8 +150,8 @@ Example message published to `homeconnect/dishwasher`:
'SilenceOnDemand': False
}
```
</details>
</details>
### Clothes washer
@@ -167,7 +165,7 @@ binary data over the websocket (type 0x82).
Example message published to `homeconnect/washer`:
```
```json
{
"state": "Ready",
"door": "Closed",
@@ -183,7 +181,7 @@ Example message published to `homeconnect/washer`:
<details>
<summary>Full state information</summary>
```
```json
{
'BackendConnected': False,
'CustomerEnergyManagerPaired': False,
@@ -245,8 +243,8 @@ Example message published to `homeconnect/washer`:
'SelectedProgram': 28718
}
```
</details>
</details>
### Coffee Machine
@@ -257,7 +255,7 @@ The coffee machine needs a better mapping to MQTT messages.
<details>
<summary>Full state information</summary>
```
```json
{
'LastSelectedBeverage': 8217,
'LocalControlActive': False,
@@ -350,8 +348,8 @@ The coffee machine needs a better mapping to MQTT messages.
'ProcessPhase': 'None'
}
```
</details>
</details>
## FRIDA tools