MirrorSave
/
ESPresense
mirror of https://github.com/ESPresense/ESPresense.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
11 Commits 21 Branches 197 Tags 20 MiB
C 52.6%
C++ 30.3%
Svelte 13.1%
TypeScript 3.5%
JavaScript 0.2%
Other 0.1%
Go to file
jptrsn 3c24cea706 platformio functionality - moved libraries into folder 2018-10-12 21:37:56 -04:00
.idea platformio functionality - moved libraries into folder 2018-10-12 21:37:56 -04:00
lib platformio functionality - moved libraries into folder 2018-10-12 21:37:56 -04:00
.gitignore platformio functionality - moved libraries into folder 2018-10-12 21:37:56 -04:00
.travis.yml Initial PlatformIO and Travis support 2018-10-05 21:41:25 +01:00
ESP32-mqtt-room.ino platformio functionality - moved libraries into folder 2018-10-12 21:37:56 -04:00
LICENSE Initial commit 2018-10-01 16:26:59 -04:00
README.md platformio functionality - moved libraries into folder 2018-10-12 21:37:56 -04:00
Settings.h Updated formatting 2018-10-03 16:53:25 -04:00
Settings_CI.h Initial PlatformIO and Travis support 2018-10-05 21:41:25 +01:00
partitions_singleapp.csv 2M board maybe? 2018-10-05 22:12:45 +01:00
platformio.ini platformio functionality - moved libraries into folder 2018-10-12 21:37:56 -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

You can get started by cloning this repository to your local machine using git. Alternatively, you can download the zip. To get the code onto your device, you can load it via the Arduino IDE or, thanks to some great work by kylegordon, you can now build and upload using PlatformIO.

  1. 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).

Configuration

  1. Settings are defined in Settings_local.h which is not included in the repo by default. Make a copy of Settings.h and rename it Settings_local.h in the same folder. Fill in your required settings.

Build and Upload

  1. Open the ESP32-mqtt-room.ino file in the Arduino IDE, and set the board variant to ESP32. You'll need to use the large partition scheme to get it to fit your board.
  2. Compile and upload. Ensure that you've got all required libraries installed (and do not use the beta version of any of them).

TBC

Future 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