Go to file
jptrsn 6dc77df498 Fix to watchdog timeout 2018-10-02 19:17:40 -04:00
.gitignore Added .gitignore 2018-10-01 17:25:29 -04:00
BLEEddystoneTLM.cpp Initial commit 2018-10-01 17:26:07 -04:00
BLEEddystoneTLM.h Initial commit 2018-10-01 17:26:07 -04:00
BLEEddystoneURL.cpp Initial commit 2018-10-01 17:26:07 -04:00
BLEEddystoneURL.h Initial commit 2018-10-01 17:26:07 -04:00
ESP32-mqtt-room.ino Fix to watchdog timeout 2018-10-02 19:17:40 -04:00
LICENSE Initial commit 2018-10-01 16:26:59 -04:00
README.md Fix to watchdog timeout 2018-10-02 19:17:40 -04:00
Settings.h Basic functionality implemented 2018-10-01 20:01:29 -04:00

README.md

ESP32-mqtt-room

An ESP32 based presence detection node for use with the Home Assistant mqtt_room component for localized device presence detection.

This depends heavily on the hard work done by pcbreflux and nkolban both on GitHub and on their YouTube Channels. Specifically, it is a modified version of pcbreflux's ESP32_BLE_beaconscan.

Getting Started

  1. You can get started by cloning this repository to your local machine using git. Alternatively, you can download the zip.
  2. Make a copy of the Settings.h file, and rename it Settings_local.h. Fill in the required information in your local settings file (the local file is ignored by GitHub, so you won't upload your sensitive information).
  3. Set the board variant to ESP32 in the Arduino IDE.

Configuration

Settings are defined in Settings_local.h which is not included in the repo by default. You can make a copy of Settings.h and rename it Settings_local.h in the same folder.

Development Tasks

  • Implement basic BLE packet discovery
  • Implement iBeacon data packet parsing
  • Setup instructions in README.md
  • Match configuration options to Room Assistant
  • Implement Mi Flora data parsing and reporting
  • Whitelist functionality
  • Blacklist functionality
  • Maximum distance limit
  • Scan interval Settings
  • Configuration via Web UI
  • Wifi Manager for managing access point credentials
  • Implement Over-The-Air (OTA) updates
  • Build and upload via PlatformIO