Skip to content

Commit

Permalink
docs: add admin, setup and auth mode
Browse files Browse the repository at this point in the history
  • Loading branch information
marc-rossbach-in-tech committed Sep 21, 2021
1 parent ea661c0 commit 0209b6b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The hardware is based on of the shelf components and requires no custom PCB desi
* DFRobot FireBeetle ESP32 IOT Microcontroller
* Waveshare 7.5inch e-Paper B V1 (640x384)
* 3000 mAh LiPo Battery
* RFID RC522 Reader
* RFID RC522 Reader to read Mifare S50 keycards for administration and authorization
* Mechanical endstop to wake ESP when card is inserted
* 3mm red LED with 47µF Capacitor and N-Channel FET to keep LED state when ESP is in deep sleep
* 2x tactile switch buttons (12x12x7.3mm)
Expand All @@ -32,5 +32,25 @@ How the components are interconnected, is documented here: [smartsign_schematic.
## Firmware
The firmware is written in C++ and based on PlatformIO. Before you can build the project, you have to create a settings file by renaming the file [`.\lib\SmartSign\GlobalSettings.h.default`](lib/SmartSign/GlobalSettings.h.default) to `.\lib\SmartSign\GlobalSettings.h`.

In `GlobalSettings.h` change the `ADMIN_CARD_ID` value to match the id of the smartcard you want to use to enter the administration mode. All other parameters in this file are default values and can be changed during runtime in the setup mode via web-interface.
In `GlobalSettings.h` change the `ADMIN_CARD_ID` value to match the id of the keycard you want to use to enter the administration mode. All other parameters in this file are default values and can be changed during runtime in the setup mode via web-interface.

## Administration-Mode
You can enter the administration mode, by inserting the **administration keycard** into the cardslot:

![](docs/images/smartcard_admin.png)

The administration screen provides information about the current battery voltage, WiFi status and NTP time. When the battery voltage falls below 3.6 volt you should consider recharging the device.

![](docs/images/screen_admin.png)

## Setup-Mode
You can enter the setup mode by pressing button B in the administration mode. In this mode, the SmartSign creates a temporary WiFi hotspot with a random name and random password. Whe connecting to this WiFi with your smartphone or computer, you gain access to a property page where you can change the settings specified in [`.\lib\SmartSign\GlobalSettings.h`](lib/SmartSign/GlobalSettings.h.default). The most important settings are the WiFi credentials, the name of the schedule and the Azure client and tenant ids (more on this [here](https://docs.microsoft.com/en-us/graph/tutorials/dotnet-core?view=graph-rest-beta&tutorial-step=2)).

![](docs/images/screen_setup.png)![](docs/images/setup_web_interface.png)

## Authorization-Mode
Before the SmartSign can show schedules of your outlook calendar, you have to authorize the device to access you calendar. You can enter the authorization mode from the administration mode by pressing button A. Another way to enter the authorization mode is to insert a card that is dedicated to enter this mode. You can configure this option by setting the **User Card** in the setup mode.

![](docs/images/smartcard_user.png)

![](docs/images/screen_auth.png)
Binary file modified docs/images/setup_web_interface.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0209b6b

Please sign in to comment.