bartek/hcpy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tweaks to readme

Browse Source
This commit is contained in:
Eric Blade
2023-12-04 13:57:42 -05:00
parent 88b47e98e3
commit b14e62f87c
1 changed files with 236 additions and 238 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

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