https://github.com/h0llyw00dzz/esp8266-totp

https://github.com/h0llyw00dzz/esp8266-totp

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/h0llyw00dzz/esp8266-totp
• Owner: H0llyW00dzZ
• License: bsd-3-clause
• Created: 2024-10-20T15:33:06.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-11-04T22:13:54.000Z (11 months ago)
• Last Synced: 2025-07-30T08:05:25.160Z (2 months ago)
• Language: C++
• Size: 15.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ESP8266 Arduino TOTP (Experimental)

> [!WARNING]  

> This is experimental and might not work as expected.

## Overview

This project demonstrates how to implement a Time-based One-Time Password (TOTP) generator using an ESP8266 board with Arduino. The system connects to Wi-Fi, synchronizes time using an NTP client, and generates OTPs based on a shared secret. Additionally, it supports displaying the generated OTP on an OLED display.

## Features

- Connects to Wi-Fi and synchronizes with an NTP server.

- Decodes a Base32 encoded secret for TOTP generation.

- Generates and displays a TOTP every 30 seconds.

- Displays the TOTP on an OLED screen for easy viewing.

## Hardware Requirements

- ESP8266 board (e.g., NodeMCU, Wemos D1 Mini)

- OLED display (e.g., SSD1306)

- Jumper wires for connections

## Wiring Diagram

- Connect the OLED display to the ESP8266 as follows:

  - **VCC** to **3V3**

  - **GND** to **GND**

  - **SDA** to **D2** (or any other GPIO pin)

  - **SCL** to **D1** (or any other GPIO pin)

## Usage

1. **Configure Wi-Fi Credentials**:

   - Open the sketch and replace `your_SSID` and `your_PASSWORD` with your Wi-Fi credentials.

2. **Set Base32 Secret**:

   - Replace `BASE32EncodedSecret` with your actual Base32 encoded secret.

3. **Upload Code**:

   - Connect your ESP8266 board to your computer.

   - Select the correct board and port in the Arduino IDE.

   - Upload the code to the board.

4. **Monitor Output**:

   - Open the Serial Monitor in Arduino IDE to view the generated OTPs.

   - The generated OTP will also be displayed on the OLED screen.

## Libraries Required

Make sure to install the following libraries via the Arduino Library Manager:

- **Adafruit GFX Library**

- **Adafruit SSD1306**

- **ESP8266WiFi**

- **NTPClient**

- **Hash**

- **TOTP**

- **Base32-Decode**

## License

This project is licensed under the [BSD 3-Clause License](LICENSE).

## Acknowledgments

- Based on libraries and examples from the Arduino community.