2019-07-19 20:09:56 +02:00
See the pretty documentation at [https://jptrsn.github.io/ESP32-mqtt-room/ ](https://jptrsn.github.io/ESP32-mqtt-room/ )
2019-06-28 16:42:16 +02:00
2018-10-01 22:26:59 +02:00
# ESP32-mqtt-room
2021-03-15 21:25:24 +01:00
[](https://github.com/DTTerastar/ESP32-mqtt-room/actions/workflows/main.yml)
2018-10-17 16:00:35 +02:00
An ESP32 based presence detection node for use with the [Home Assistant ](https://www.home-assistant.io/ ) [`mqtt_room` component ](https://www.home-assistant.io/components/sensor.mqtt_room/ ) for localized device presence detection.
2018-10-02 02:01:29 +02:00
2019-07-19 20:09:56 +02:00
## Release Notes
View the [release notes here ](./releaseNotes ).
2019-06-28 16:42:16 +02:00
## Credits
2019-07-03 21:57:51 +02:00
This project would not have been possible without the help of a variety of [folks on GitHub and YouTube. ](https://jptrsn.github.io/ESP32-mqtt-room/index.html#credits )
2018-10-03 01:17:40 +02:00
## Getting Started
2019-07-03 21:57:51 +02:00
A full list of instructions is available in the [documentation ](https://jptrsn.github.io/ESP32-mqtt-room/index.html#getting-started ).
2018-12-10 22:29:24 +01:00
2018-12-10 19:54:02 +01:00
## Home Assistant Configuration
2019-07-03 21:57:51 +02:00
See the [documentation for configuring Home Assistant. ](https://jptrsn.github.io/ESP32-mqtt-room/home_assistant.html )
2018-12-10 19:54:02 +01:00
## Trackable Devices
2019-07-03 21:57:51 +02:00
* [Beacon Hardware ](https://jptrsn.github.io/ESP32-mqtt-room/beacons.html )
* [Android devices ](https://jptrsn.github.io/ESP32-mqtt-room/android.html )
* [iOS devices ](https://jptrsn.github.io/ESP32-mqtt-room/index.html#tracking-iphone )
* [Other devices ](https://jptrsn.github.io/ESP32-mqtt-room/beacons.html#non-beacon-hardware )
2018-12-10 19:54:02 +01:00
2019-06-28 16:42:16 +02:00
## Development Tasks
2018-12-10 19:54:02 +01:00
2019-06-28 16:42:16 +02:00
### To do
2019-08-14 17:36:30 +02:00
See the [list of open issues tagged as enhancement ](https://github.com/jptrsn/ESP32-mqtt-room/labels/enhancement ). You can also view the state of development tasks [by viewing the development tasks project board ](https://github.com/jptrsn/ESP32-mqtt-room/projects/1 ).
2018-10-03 22:53:25 +02:00
2019-06-28 16:42:16 +02:00
### Completed
2018-10-03 01:17:40 +02:00
- [x] Implement basic BLE packet discovery
- [x] Implement iBeacon data packet parsing
2018-10-17 16:00:35 +02:00
- [x] Setup instructions in README.md
2019-06-25 15:13:22 +02:00
- [x] Address watchdog issue
- [x] Maximum distance limit (rounded to two decimal places)
2018-10-17 16:00:35 +02:00
- [x] Scan interval Settings
2018-12-10 22:29:24 +01:00
- [x] Implement Over-The-Air (OTA) updates
2018-10-17 16:00:35 +02:00
- [x] Build and upload via [PlatformIO ](platformio.org )
