Update Readme.md

Readme.md

@@ -17,78 +17,73 @@ show notifications, display the weather, monitor stuff, show a clock, serve a we
 
 ---
 
-## Demo Code Explanation
+### Table of Contents
 
-This repository contains a basic "Hello, World!" project for the SmartCube.
+1. [Bill of Materials](#bill-of-materials)
-
+2. [3D-Printing the Case](#3d-printing-the-case)
-### Getting Started:
+3. [Assembly Instructions](#assembly-instructions)
-
+   * [Body](#body)
-1. Download and install **[VSCode](https://code.visualstudio.com/)** or **[VSCodium](https://vscodium.com/)**.
+   * [Buttons](#buttons)
-2. Install the **[PlatformIO IDE extension](https://platformio.org/platformio-ide)**.
+   * [OLED Display](#oled-display)
-3. Clone this repository and open the project folder in VSCode/VSCodium.
+   * [Buzzer](#buzzer)
-4. PlatformIO will automatically handle environment setup and dependencies when you open the project.
+   * [Battery Setup](#battery-setup)
-
+4. [Schematics](#schematics)
-### Project Structure:
+5. [GPIO Pin Reference Table](#gpio-pin-reference-table)
-
+6. [Demo Code Explanation](#demo-code-explanation)
-All source code is located in the `src/` directory.
+   * [Getting Started](#getting-started)
-You should start by opening **`src/main.cpp`**, which contains the entry point and initialization logic.
+   * [Uploading with PlatformIO](#uploading-with-platformio)
-
+   * [Project Structure](#project-structure)
-### What the Code Does:
+   * [What the Code Does](#what-the-code-does)
-
+   * [Key Features](#key-features)
-This demo handles basic system functionality, including:
+     * [WiFi Management](#wifi-management)
-
+     * [Button Handling](#button-handling)
-* System initialization
+       * [Default Button Actions](#default-button-actions)
-* Button input handling
+7. [Tips and tricks](#tips-and-tricks)
-* OLED display output configuration
-* WiFi management
-
-### Key Features  
-
-1. **WiFi Management**:  
-   - The [cubeWifiManager](https://git.kopic.hr/tomislav/SmartCubeV1/src/branch/main/src/SmartCube/cubeWifiManager.h) class manages WiFi connectivity seamlessly.  
-   - If no known WiFi network is available, it starts a configuration portal and creates an access point (AP), allowing users to connect the SmartCube to a network from another WiFi-enabled device.  
-   - The OLED display shows the access point details, such as the AP name and IP address, making the setup process very easy.
-
-2. **Button Handling**:  
-   - Buttons are mapped to specific GPIO pins: `PIN_BTN_L` (Left), `PIN_BTN_M` (Middle), and `PIN_BTN_R` (Right).  
-   - The [cubeButtonHandler](https://git.kopic.hr/tomislav/SmartCubeV1/src/branch/main/src/SmartCube/cubeButtons.h) function, executed in the [loop()](https://git.kopic.hr/tomislav/SmartCubeV1/src/commit/1cb51f502d92a91c6a83ce6364b434db31bfd864/src/main.cpp#L47), monitors and interprets button presses, differentiating between short and long presses.  
-
-#### Default Button Actions  
-- **Right Button**:  
-  - *Short Press*: Turns the OLED display **on** (if previously off).  
-  - *Long Press*: Turns the OLED display **off**, helping conserve power.  
-
-- **Left + Middle Buttons (Simultaneous Long Press)**:  
-  - Triggers an ESP8266 reboot, effectively restarting the device.  
-
-This is meant to provide a minimal starting point for further development with the SmartCube.
 
 ---
 
 ## Bill of Materials  
 
 | **Component**             | **Quantity** | **Description**                           | **Notes**                                   |  
-|---------------------------|--------------|-------------------------------------------|---------------------------------------------|  
+|---------------------------|--------------|-------------------------------------------|---------------------------------------------| 
-| ESP8266 D1 Mini           | 1            | Microcontroller module                    |                                             |  
+| Enclosure                 | 1            | 3D-printed case                           | 3D printable STL files are in `hardware/case/` |
-| SSD1306 OLED Display      | 1            | 128x64 resolution, I2C interface          |                                             |  
+| ESP8266 D1 Mini           | 1            | Microcontroller module                    |                                             |
-| 14250 Rechargeable Battery| 1            | Lithium-ion battery                       | Make sure you get the rechargeable type, most 14250 are not |  
+| SSD1306 OLED Display      | 1            | 128x64 resolution, I2C interface          |                                             |
-| TP4056 Module             | 1            | Charging and protection circuit           | Does not need to have a USB connector       |  
+| 6x6 Push Buttons          | 3 or 4       | Tactile push buttons                      |                                             |
-| 6x6 Push Buttons          | 3 or 4       | Tactile push buttons                      |                                             |  
+| Resistors (10kΩ)          | 3 or 4       | Pull-down resistors for buttons           | Generally any resistor between 1kΩ and 100kΩ will work |
-| 20mm Piezo Buzzer         | 1            | Caseless buzzer for audio                 |                                             |  
+| 20mm Piezo Buzzer         | 1            | Caseless buzzer for audio                 |                                             |
-| Resistors (10kΩ)          | 3 or 4       | Pull-down resistors for buttons           |                                             |
-| Resistors (220kΩ and 56kΩ)| 1            | Voltage divider                           | For monitoring the battery charge level     |  
 | Wires                     | Several      | Thin wires for connections                | I used wires from inside an old ethernet cable |  
-| Enclosure                 | 1            | 3D-printed case                           | 3D printable STL files are in `hardware/case/` |  
 | 2x6mm screw               | 8            | Small screws for assembling the case      | Does not have to be exactly 6mm long        |  
-| 2x2mm screw               | 4            | Small screws for the front                | Mostly for cosmetic purposes                |  
+| 2x2mm screw               | 4 (Optional) | Small screws for the front                | Mostly for cosmetic purposes                |  
+| 14250 Rechargeable Battery| 1 (Optional) | Lithium-ion battery                       | Make sure it's rechargeable; most 14250 aren't |  
+| TP4056 Module             | 1 (Optional) | Charging and protection circuit           | USB connector not required                  |
+| Resistors (220kΩ and 56kΩ)| 1 (Optional) | Voltage divider                           | For monitoring the battery charge level     |
+| Micro Slider Switch (SS-12D00) | 1 (Optional) | On/Off switch                        | Only needed if installing the battery       |  
+
 
 ![layout](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/pictures/layout.jpg)
-
 ---
 
+### 3D-Printing the Case
+
+The SmartCube case is fully 3D-printable. STL files are included this repository in the `/hardware/case/` directory:
+
+| **File**                                  | **Description**                             |
+| ----------------------------------------- | ------------------------------------------- |
+| `SmartCube_Body_3_button.stl`             | Main cube body with slots for 3 buttons     |
+| `SmartCube_Body_4_button.stl`             | Body variant for 4 buttons                  |
+| `SmartCube_Front.stl`                     | Front panel for OLED display                |
+| `SmartCube_Front_No_Holes.stl`            | Front panel variant without decorative screw holes |
+| `SmartCube_Back_Speaker_Side_Hole.stl`    | Back panel                                  |
+| `SmartCube_Back_Speaker_Power_Switch.stl` | Back panel variant with power switch slot   |
+
+* Use PLA or PETG
+* 0.2 mm layer hight is more than enough, you can print finer if you want to.
+* Supports may be required depending on your printer
+
 ## Assembly Instructions  
 ---
-1.  **Body**
+### Body
 
 Push the ESP8266 microcontroller in the ledge on the bottom [the cube body](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/case/SmartCube_Body_3_button.stl), it should 'click in' with the USB-C port facing the hole.
 
@@ -102,7 +97,7 @@ Body with 3 or 4 button slots is available in the `hardware/case/`
 
 ---
 
-2. **Buttons**
+### Buttons
 
 At this step, glue the buttons into the top slots and solder resistors to their outputs. You can connect the resistor outputs together, and don't forget to attach an extra wire to the button inputs, this will later be used to connect them to the 3.3V line.
 
@@ -122,7 +117,7 @@ Finally, solder the GND wire to the resistor outputs and connect 3.3V to the but
 ![Step5](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/pictures/build5.jpg)
 
 ---
-3. **OLED Display**
+### OLED Display
 
 Screw in the 2x2mm screws and hot glue the SSD1306 to the [front part of the cube](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/case/SmartCube_Front.stl) solder the 4 wires to the OLED display, make sure you have some extra length, 4-5cm should be more than enough
 
@@ -139,7 +134,7 @@ The OLED display must be connected via I2C on pins:
 ![Step8](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/pictures/build8.jpg)
 
 ---
-4. **Buzzer**
+### Buzzer
 
 Glue in the buzzer to the [back part of the cube](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/case/SmartCube_Back_Speaker_Side_Hole.stl) with superglue
 
@@ -150,11 +145,14 @@ As defined in the [example config](https://git.kopic.hr/tomislav/SmartCubeV1/src
 ![Step9](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/pictures/build9.jpg)
 ---
 
-**Battery Setup**
+### Battery Setup
 
 The battery is optional. Your SmartCube will work fine when powered via USB; however, adding one makes it portable (and much cuter).
 
-A single 700 mAh 14250 battery lasts about 24 hours. Keep in mind there's currently no way to manually power the Cube off, it will continue running until the battery is depleted. The TP4056 prevents the cell from being completely drained and should protect it from damage.
+A single 700 mAh 14250 battery lasts about 24 hours.
+The TP4056 prevents the cell from being completely drained and should protect it from damage.
+
+Although it's not shown in any of the pictures or schematics, both the case and the back cover are updated to include a slot for 8.5mm SPDT slider switch(SS-12D00), in case you actually want to have a power switch instead of letting it run until the battery drains.
 
 * Solder the 14250 battery to the **TP4056 input pins**.
 * Wire the **TP4056 output** to the **3.3V pin** on the D1 Mini to power the device.
@@ -172,17 +170,103 @@ A single 700 mAh 14250 battery lasts about 24 hours. Keep in mind there's curren
 ![batt3](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/pictures/batt3.jpg)
 
 ---
+## Schematics
 
-## Notes  
+This is the basic drawing of the circuit without the battery
 
-- This is still a work in progress
+![Basic](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/schematics/schematic1.png)
-- Everything is pretty tightly packed in there and it's a mess. But it's not as hard to make as it looks.
+
+This is the complete circuit including the battery and a voltage divider
+
+![WithBattery](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/schematics/schematic3.png)
+
+---
+
+### GPIO Pin Reference Table
+
+| **Component**           | **GPIO Pin** | **PlatformIO / Code Macro**       |
+| ----------------------- | ------------ | --------------------------------- |
+| Left Button             | D6 (GPIO12)  | `PIN_BTN_L`                       |
+| Middle Button           | D7 (GPIO13)  | `PIN_BTN_M`                       |
+| Right Button            | D8 (GPIO15)  | `PIN_BTN_R`                       |
+| Buzzer                  | D3 (GPIO0)   | `PIN_BUZZER`                      |
+| OLED SDA                | D2 (GPIO4)   | `SDA`                             |
+| OLED SCL                | D1 (GPIO5)   | `SCL`                             |
+| Battery Voltage Divider | A0           | `A0`                              |
+
+---
+
+## Demo Code Explanation
+
+This repository contains a basic "Hello, World!" project for the SmartCube.
+
+### Getting Started:
+
+1. Download and install **[VSCode](https://code.visualstudio.com/)** or **[VSCodium](https://vscodium.com/)**.
+2. Install the **[PlatformIO IDE extension](https://platformio.org/platformio-ide)**.
+3. Clone this repository and open the project folder in VSCode/VSCodium.
+4. PlatformIO will automatically handle environment setup and dependencies when you open the project.
+
+### Uploading with PlatformIO
+
+Once you open this git repository in VSCode and install the PlatformIO extension.
+
+You can click on the PlatformIO icon on the left sidebar
+
+![platformio1](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/pictures/platformio1.png)
+
+In the PlatformIO panel, expand d1_mini_lite → General to reveal the available tasks.
+
+Click Build to compile the firmware, and then click Upload to flash it to your SmartCube.
+
+![platformio2](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/pictures/platformio2.png)
+
+### Project Structure:
+
+All source code is located in the `src/` directory.
+You should start by opening **`src/main.cpp`**, which contains the entry point and initialization logic.
+
+### What the Code Does:
+
+This demo handles basic system functionality, including:
+
+* System initialization
+* Button input handling
+* OLED display output configuration
+* WiFi management
+
+### Key Features  
+
+#### WiFi Management
+   - The [cubeWifiManager](https://git.kopic.hr/tomislav/SmartCubeV1/src/branch/main/src/SmartCube/cubeWifiManager.h) class manages WiFi connectivity seamlessly.  
+   - If no known WiFi network is available, it starts a configuration portal and creates an access point (AP), allowing users to connect the SmartCube to a network from another WiFi-enabled device.  
+   - The OLED display shows the access point details, such as the AP name and IP address, making the setup process very easy.
+
+#### Button Handling
+   - Buttons are mapped to specific GPIO pins: `PIN_BTN_L` (Left), `PIN_BTN_M` (Middle), and `PIN_BTN_R` (Right).  
+   - The [cubeButtonHandler](https://git.kopic.hr/tomislav/SmartCubeV1/src/branch/main/src/SmartCube/cubeButtons.h) function, executed in the [loop()](https://git.kopic.hr/tomislav/SmartCubeV1/src/commit/1cb51f502d92a91c6a83ce6364b434db31bfd864/src/main.cpp#L47), monitors and interprets button presses, differentiating between short and long presses.  
+
+##### Default Button Actions  
+- **Right Button**:  
+  - *Long Press*: Turns the OLED display **on** (if previously off).  
+
+- **Left + Middle Buttons (Simultaneous Long Press)**:  
+  - Triggers an ESP8266 reboot, effectively restarting the device.  
+
+This is meant to provide a minimal starting point for further development with the SmartCube.
+
+---
+## Tips and tricks  
+
+- It's not as hard to make as it looks.
+- Battery is the trickiest part to fit in, it's best to put in the case last.
+- Test if everything works before completely closing the case shut. 
+- Make sure all connections are secure and not short-circuited. 
+- Hot glue is your friend, it will add extra protection from short-circuits and keep wires in place.
+- Everything is pretty tightly packed in there and it can be quite a mess.
 
 ![Packed](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/pictures/IMG_20241213_171725.jpg)
 
-- Ensure all connections are secure and isolated. Hot glue is your friend.
-- Test the circuit thoroughly before placing and gluing it in the enclosure.  
-- Battery is the trickiest part to fit in, it's best to glue the charging module directly to it and put it in the case last
 
 For questions or additional details, feel free to reach out! I would love to hear some feedback.
 Good luck and have fun :)

src/SmartCube/cubeBattery.h

@@ -0,0 +1,22 @@
+#define ADC_PIN A0  // ESP8266 ADC pin
+
+// Tuneable min and max battery voltages
+float VOLTAGE_MAX = 4.2;  // Full battery voltage
+float VOLTAGE_MIN = 3.0;  // Empty battery voltage
+
+const float R1 = 220000.0;  // 220k ohms
+const float R2 = 56000.0;   // 56k ohms
+const float ADC_MAX = 1023.0; // 10-bit ADC resolution
+const float V_REF = 1.0;      // ESP8266 ADC reference voltage
+
+float readBatteryVoltage() {
+  int rawADC = analogRead(ADC_PIN);
+  float voltage = (rawADC / ADC_MAX) * V_REF;
+  return voltage * (R1 + R2) / R2; // Scale to actual battery voltage
+}
+
+int batteryPercentage(float voltage) {
+  if (voltage >= VOLTAGE_MAX) return 100;
+  if (voltage <= VOLTAGE_MIN) return 0;
+  return (voltage - VOLTAGE_MIN) * 100 / (VOLTAGE_MAX - VOLTAGE_MIN); // Linear mapping
+}