Skip to content

Commit 49b2b34

Browse files
author
omk
committed
WIP4
1 parent 5482277 commit 49b2b34

File tree

3 files changed

+21
-5
lines changed

3 files changed

+21
-5
lines changed

README.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,20 @@ This project aims to customize and integrate an **Air Wick air freshener** into
2121
## Modifications
2222
A detailed guide on disassembling the Air Wick device and making the necessary modifications can be found **[here](docs/airwick_mod.md)**.
2323

24-
## Installation
25-
## Build
24+
## Notes
25+
26+
- Since the device operates in **sleep mode**, there may be a delay of **up to 10 seconds** before executing the spray command after it is sent.
27+
- By default, the spray interval is set to **120 minutes**. You can change this value in the **Exposes** tab in **zigbee2mqtt**. Setting the value to **0** disables automatic spraying.
28+
- The battery status report is sent **once per hour**.
29+
- The **Reset** command in the **Exposes** tab is used to reset the spray counter.
30+
- Holding the **BOOT** button for approximately **1.5 seconds** will reset the device and put it into pairing mode.
2631

32+
## Build
2733

2834
This project can be built with the [ESP-IDF build system](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html)
2935

36+
To compile the firmware, **ESP-IDF v5.3.2** is required. Make sure you have the correct version installed before building the project.
37+
3038
Configure:
3139

3240
idf.py set-target esp32h2
@@ -35,11 +43,12 @@ Build:
3543

3644
idf.py build
3745

38-
Flash::
46+
Flash:
3947

4048
idf.py flash
4149

42-
### Zigbee2MQTT
50+
## Zigbee2MQTT
51+
4352
This project is supported via an **external converter**. To integrate it into **Zigbee2MQTT**, follow these steps:
4453

4554
```bash
@@ -56,8 +65,15 @@ external_converters:
5665
5766
Save the file and restart **Zigbee2MQTT** to apply changes.
5867
68+
## Exposes
69+
<p align="left"> <img src="docs/images/z2m_exposes.png" width="900"></p>
70+
71+
## Bind
5972
Once the device is paired successfully, make sure to check the **Bind** tab. The settings should appear as shown in the screenshot.
6073
<p align="left"> <img src="docs/images/z2m_bind.png" width="900"></p>
74+
75+
## Reporting
76+
6177
Additionally, check the **Reports** tab and ensure that all reports are disabled.
6278
<p align="left"> <img src="docs/images/z2m_reporting.png" width="900"></p>
6379

docs/images/z2m_exposes.png

189 KB
Loading

main/idf_component.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ dependencies:
66
espressif/button: "3.4.0"
77
## IDF version
88
idf:
9-
version: ">=5.1.0"
9+
version: "=5.3.2"

0 commit comments

Comments
 (0)