diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md new file mode 100644 index 0000000..bfde942 --- /dev/null +++ b/docs/USER_GUIDE.md @@ -0,0 +1,69 @@ +# TorqueVault User Guide + +TorqueVault is an application used to communicate with digital torque wrenches via Bluetooth Low Energy (BLE). The application communicates with a backend server via a RESTful API to get data and upload measurement values obtained from the wrenches. + +
+ DTS Logo +
+ +--- + +## 1. Login Screen +Authentication interface for securing access to the application. +* **Server Configuration:** Entry of the backend API server URL for synchronization. +* **Authentication Methods:** + * **Credentials:** Login using a registered username and password. + * **API Key:** Alternative login method using a unique API token. + +![Login Screen](./screenshots/Screenshot_Login_With_Password.png) + +## 2. Scanner Screen +Facilitates the discovery of nearby tools. +* **Search:** Automatic scanning for active Bluetooth torque devices. +* **Signal Strength:** Proximity indication via the signal icon (RSSI). +* **Connect:** Tap a device name to initiate a connection. The device is automatically bonded upon the first successful connection. + +![Scanner Screen](./screenshots/Screenshot_Scanner.png) + +## 3. Home Screen +Primary dashboard for active tool management. +* **Overview:** Display of all currently connected devices. +* **Quick Access:** One-tap entry to the communication screen of any connected tool. + +![Home Screen](./screenshots/Screenshot_Home.png) + +## 4. Communication Screen +Direct interaction interface for selected tools. +* **UART Data Exchange:** Display of UART commands exchanged between the torque wrench and the application. +* **Command Transmission:** Ability to send specific instructions or protocol commands. + +![Communication Screen](./screenshots/Screenshot_Communication.png) + +## 5. Bonded Devices Screen +Management of previously paired tools. +* **Bonded devices:** List of all previously paired devices. +* **Device management:** Option to remove obsolete tool records via the delete icon. +* **Auto-Connect Capability:** Automatic reconnection for bonded tools within range if the "Auto-Connect" option is enabled in the Settings screen. + +![Bonded Devices](./screenshots/Screenshot_Bonded_Devices.png) + +## 6. Logs Screen +Tracking of system activity and communication logs for the current session. This screen is hidden by default and can be enabled via the "Show logs" option in the Settings screen. +* **Session Logs:** Detailed log of application activities and data exchanges. +* **Filter Options:** Categorization between system messages and tool data. +* **Data Export:** Capability to share logs in Text or CSV format for diagnostic purposes. + +![Logs Screen](./screenshots/Screenshot_Logs.png) + +## 7. Settings Screen +Application-wide configuration. +* **Theme Selection:** Toggle between Light and Dark visual modes. +* **Connection Policy:** Management of the auto-connect feature for bonded tools. +* **Server:** Configuration of the backend server URL to get work orders and upload measurement data. + +![Settings Screen](./screenshots/Screenshot_Settings.png) + +--- +*Developed by Digitool Solutions* + +*Last updated: Aug 19, 2026* diff --git a/docs/screenshots/Screenshot_Bonded_Devices.png b/docs/screenshots/Screenshot_Bonded_Devices.png new file mode 100644 index 0000000..9a7f9d1 Binary files /dev/null and b/docs/screenshots/Screenshot_Bonded_Devices.png differ diff --git a/docs/screenshots/Screenshot_Communication.png b/docs/screenshots/Screenshot_Communication.png new file mode 100644 index 0000000..034cac6 Binary files /dev/null and b/docs/screenshots/Screenshot_Communication.png differ diff --git a/docs/screenshots/Screenshot_Home.png b/docs/screenshots/Screenshot_Home.png new file mode 100644 index 0000000..262abdf Binary files /dev/null and b/docs/screenshots/Screenshot_Home.png differ diff --git a/docs/screenshots/Screenshot_Login_With_API_Key.png b/docs/screenshots/Screenshot_Login_With_API_Key.png new file mode 100644 index 0000000..b11da70 Binary files /dev/null and b/docs/screenshots/Screenshot_Login_With_API_Key.png differ diff --git a/docs/screenshots/Screenshot_Login_With_Password.png b/docs/screenshots/Screenshot_Login_With_Password.png new file mode 100644 index 0000000..897cf9a Binary files /dev/null and b/docs/screenshots/Screenshot_Login_With_Password.png differ diff --git a/docs/screenshots/Screenshot_Logs.png b/docs/screenshots/Screenshot_Logs.png new file mode 100644 index 0000000..e0b9ced Binary files /dev/null and b/docs/screenshots/Screenshot_Logs.png differ diff --git a/docs/screenshots/Screenshot_Scanner.png b/docs/screenshots/Screenshot_Scanner.png new file mode 100644 index 0000000..01272d0 Binary files /dev/null and b/docs/screenshots/Screenshot_Scanner.png differ diff --git a/docs/screenshots/Screenshot_Settings.png b/docs/screenshots/Screenshot_Settings.png new file mode 100644 index 0000000..964cdc0 Binary files /dev/null and b/docs/screenshots/Screenshot_Settings.png differ