tinance2-doorbot/README

23 lines
1.3 KiB
Text
Raw Normal View History

2023-06-12 17:17:28 +00:00
This project is a card reader system for Techinc that uses a WIEGAND based reader and allows platform.io based user flags to allow change of certain features.
# Currently supported flags:
-DBOARD1 : Used to set Pins for BOARD1 config
-DBOARD2 : Used to set Pins for BOARD2 config
-DRELAY1 : Enable the First Relay
-DRELAY2 : Not implemented yet
-DWIFI : Enable WIFI and use secrets.h to manage.
-DWEB_SERVER : Enable Web Server
-DSERIAL_DEBUG : Enable Serial Console output and debug.
-DWEB_SERIAL_DEBUG : Enable Web Serial console to monitor for issues (does not support auth, needs -DWEB_SERVER)
-DNET_FAIL_SAFE : If WIFI disconnects release door / relay.
-DWEB_OTA_UPDATE : Present Web Interface on /update for managing firmware over the air (needs -DWEB_SERVER)
-DLOCAL_ACL : Enable local ACL list
-DLOCAL_ACL_API : Enable API for managing ACL's (needs -DWEB_SERVER and -DLOCAL_ACL)
-DLATCH_DOOR : Release RELAY1 for a a certain amount of time in this case its 1 second
-DTOGGLE_DOOR : Instead of Relasing relay for 1 second keep it in the opposite state to what it was at the time the card was scanned.
# Important Notes:
* The webserver uses Spiffs to manage the HTML files for the web server you need to run ("Upload Filesystem Image" step via serial or use the OTA upgrade and run "Upload Filesystem Image OTA" step and uplaod it.)