Skip to content

Commit 09f03a1

Browse files
authored
Update readme with detailed install instructions (#154)
For folks new to the embedded world, the install instructions are incomplete. Adding pointers to the ESP-IDF SDK.
1 parent 4c85750 commit 09f03a1

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,22 +66,35 @@ is published.
6666
`BatteryLevel`
6767
* For BeeWi Smart Door sensors: `Status` and `Battery`
6868
* For Xiaomi LYWSD03MMC Temperature Sensors running the ATC1441 firmware:
69-
`MACAddress`, `MessageCounter`, `Temperature`, `Humidity`, `BatteryLevel`
69+
`MACAddress`, `MessageCounter`, `Temperature`, `Humidity`, `BatteryLevel`
7070
and `BatteryVolts` (_See https://github.com/atc1441/ATC_MiThermometer_)
7171

7272
**Note:** Broadcaster topics are published without the retained flag regardless
7373
of what's defined in the configuration file.
7474

7575
## Compiling
7676

77-
Download the repository and its dependencies:
77+
1. Install `ESP-IDF`
78+
79+
You will first need to install the
80+
[Espressif IoT Development Framework](https://github.com/espressif/esp-idf).
81+
The [Installation Instructions](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html)
82+
have all of the details. Make sure to follow ALL the steps, up to and including step 4 where you set up the tools and
83+
the `get_idf` alias.
84+
85+
2. Download the repository and its dependencies:
86+
7887
```bash
7988
git clone --recursive https://github.com/shmuelzon/esp32-ble2mqtt
8089
```
90+
91+
3. Modify the config.json and flash
92+
8193
Modify the [configuration file](#configuration) to fit your environment, build
8294
and flash (make sure to modify the serial device your ESP32 is connected to):
95+
8396
```bash
84-
idf.py flash -p /dev/ttyS1
97+
idf.py build flash
8598
```
8699

87100
## Remote Logging

0 commit comments

Comments
 (0)