|
1 | 1 | # Overview |
2 | 2 |
|
3 | | -The Open Authenticator is an open source TOTP based hardware authenticator using ESP32. In layman's terms, this does what Google Authenticator or Authy does. |
| 3 | +<br /> |
| 4 | + |
| 5 | +<p align="center"> |
| 6 | + <a href="https://github.com/Open-Authenticator"> |
| 7 | + <img src="./assets/open-autheticator-logo.png" alt="Logo" width="200" height="200"> |
| 8 | + </a> |
| 9 | +</p> |
| 10 | + |
| 11 | +<p align="center"> |
| 12 | +<img alt="GitHub watchers" src="https://img.shields.io/github/watchers/open-authenticator/open-authenticator-app?style=plastic"> |
| 13 | +<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/open-authenticator/open-authenticator-app?style=plastic"> |
| 14 | +<img alt="GitHub forks" src="https://img.shields.io/github/forks/open-authenticator/open-authenticator-app?style=plastic"> |
| 15 | +<img alt="GitHub issues" |
| 16 | +src="https://img.shields.io/github/issues/open-authenticator/open-authenticator-app?style=plastic"> |
| 17 | +<img alt="GitHub forks" src="https://img.shields.io/github/forks/open-authenticator/open-authenticator-app?style=plastic"> |
| 18 | +<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/open-authenticator/open-authenticator-app?style=plastic"> |
| 19 | +<img alt="GitHub license" src="https://img.shields.io/github/license/open-authenticator/open-authenticator-app?style=plastic"> |
| 20 | +</p> |
| 21 | + |
| 22 | +The Open Authenticator is an open source TOTP based hardware authenticator using |
| 23 | +ESP32. In layman's terms, this does what Google Authenticator or Authy does. |
| 24 | +This uses a custom built pcb and a 3d case, also it uses a firmware built for |
| 25 | +this purpose using esp-idf, uses lvgl as the GUI library. |
| 26 | + |
| 27 | +The features of open authenticator's [printer circuit board](https://github.com/Open-Authenticator/hardware-design) are: |
| 28 | + |
| 29 | +* Small form factor of 82mm x 42mm |
| 30 | +* Uses ESP32-WROOM-32D module |
| 31 | +* Uses 128x64 0.96" inch OLED panel |
| 32 | +* Uses DS3231 RTC with battery backup (CR2032) for timekeeping |
| 33 | +* Powered by 3.7V 300 mAh LiPo battery |
| 34 | +* Uses MCP73831 for charging LiPo battery |
| 35 | +* Uses TPS63001 Buck Boost Converter IC for efficient 3.3V power supply, with input range from 1.8V - 5.5V |
| 36 | +* Uses TPS22919 Load switch to control power to OLED and RTC chip |
| 37 | +* Autoselect power source, i.e., battery or USB |
| 38 | +* USB Type-C for charging only (no data pins connected) |
| 39 | + |
| 40 | +## Media Coverage |
| 41 | + |
| 42 | +* Hackster.io: [TOTP-Based Open Hardware Authenticator Powered by an ESP32 Microcontroller](https://www.hackster.io/news/totp-based-open-hardware-authenticator-powered-by-an-esp32-microcontroller-c770f10008af) |
| 43 | + |
| 44 | +## Gallery |
| 45 | + |
| 46 | +## Project logs |
| 47 | + |
| 48 | +* Hackaday: [https://hackaday.io/project/176959-open-authenticator](https://hackaday.io/project/176959-open-authenticator) |
| 49 | +## Join the Discussion: |
| 50 | + |
| 51 | +* Discord: [https://discord.gg/kVDdB9kAEP](https://discord.gg/kVDdB9kAEP) |
| 52 | +## Repositories |
| 53 | + |
| 54 | +* PCB Design: [https://github.com/Open-Authenticator/hardware-design](https://github.com/Open-Authenticator/hardware-design) |
| 55 | +* Firmware: [https://github.com/Open-Authenticator/open-authenticator-app](https://github.com/Open-Authenticator/open-authenticator-app) |
| 56 | +* 3D-Case: [https://github.com/Open-Authenticator/3d-case](https://github.com/Open-Authenticator/3d-case) |
| 57 | + |
| 58 | +## Ordering |
| 59 | +### PCB |
| 60 | + |
| 61 | +<a href="https://oshpark.com/shared_projects/kZuvm8FV"><img src="https://oshpark.com/packs/media/images/badge-5f4e3bf4bf68f72ff88bd92e0089e9cf.png" alt="Order from OSH Park"></img></a> |
| 62 | + |
| 63 | +### Components |
| 64 | + |
| 65 | +* [Bill of Material](https://docs.google.com/spreadsheets/d/1dUZdB7LErKdkV40vjPda2T-85nJA-UcwpFP-PLhwYTE/edit?usp=sharing) |
| 66 | + |
| 67 | +## Sponsors |
| 68 | + |
| 69 | +* [OSHPark](https://oshpark.com/) - Thanks to OSHPark for sponsoring first prototype |
| 70 | +* [PCBWay](https://www.pcbway.com/) - Thanks to PCBway for sponsoring the final prototype |
| 71 | +* [Asahitec](https://www.asahitec.in/index.html) - Thanks for discounts on stencil |
| 72 | + |
| 73 | +<img src="./assets/pcbway_logo.png" width=160 height=67> |
| 74 | +<img src="./assets/oshpark_logo.png" width=128 height=128> |
| 75 | +<img src="./assets/asahitec_logo.jpg" width=153 height=94> |
0 commit comments