commit d0f15d0b0bd2547d2fc2d33c7460a69f386305fb
parent 6f2b51ef6cdd05169c2326f802a48a06e8e99d5a
Author: Andreas HABEGGER <andreas.habegger@bfh.ch>
Date: Thu, 16 Oct 2025 17:16:33 +0200
An initial version of directory structure details added
Diffstat:
| M | README.md | | | 31 | +++++++++++++++++++++++-------- |
1 file changed, 23 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# XTOTP Generator Device
+# XTOTP Generator Firmware
-# 🚧 Project xOTP Generator — Under Construction 🚧
+# 🚧 Project xOTP Generator Firmware — Under Construction 🚧
> **Status:** 🛠️ This project is currently under active development.
> Features, structure, and documentation are subject to change.
@@ -12,10 +12,25 @@
## 🧱 Overview
-Welcome to **Project xOTP Generator**!
-This repository is currently a work in progress. The goal of this project is to **[briefly describe the purpose or goal — e.g.]**.
+Welcome to **Project xOTP Generator Firmware** repository!
+This repository is currently a work in progress.
-A more detailed README.md with installation, usage, and contribution guidelines will be available once the initial version is ready.
+### Structure
+ * **`xotp_app/`:** This folder contains the firmware application, including the controller state machine.
+ The application depends on three third-party libraries: pbmLib, tinytime, and baseXConverter.
+ The controller can operate in two modes:
+ - xOTP Generator Device Firmware – running on top of the hardware BSP (Board Support Package) of the actual xOTP device.
+ - Mockup Mode – running on a simulated BSP for testing and demonstration purposes without requiring the physical hardware.
+
+ When using the mockup BSP, the system emulates the basic hardware functions, allowing development and testing of the firmware in a mocked environment on a GNU/Linux based system.
+
+ * **`bsp_mockup/`:** This folder contains mockup functions of the hardware device allowing to test the *xotp_app* without the need of a physical hardware device.
+ This is manly used for demonstration purposes as well as testing new features.
+
+ * **`bsp_xotp-hw/`:** This folder contains the hardware device interface with its drivers; low level calls and an abstraction of CMSIS based LL and HAL library bindings.
+ It is an encapsulated unit that follows the IOC pattern to decouple the user application and the hardware specific code.
+
+ * **`third_party/`:**
---
@@ -39,9 +54,9 @@ Once the foundation is ready, we’ll open issues and contribution guidelines.
## 📬 Contact
For questions or collaboration ideas, reach out to:
-**Adrian STEINER** — [adrian.steiner@bfh.ch]
-**Andreas HABEGGER** — [andreas.habegger@bfh.ch]
-**Christian GROTHOFF** — [christian.grothoff@bfh.ch]
+ - **Adrian STEINER** — [adrian.steiner@bfh.ch]
+ - **Andreas HABEGGER** — [andreas.habegger@bfh.ch]
+ - **Christian GROTHOFF** — [christian.grothoff@bfh.ch]
---
