Update Readme.md
This commit is contained in:
40
Readme.md
40
Readme.md
@@ -9,11 +9,11 @@ show notifications, display the weather, monitor stuff, show a clock, serve a we
|
||||
---
|
||||
|
||||
## Info
|
||||
- **This is a hobby project I work on and develop for when I have literally nothing else to do, do not expect regular updates. You are free to clone this and do whatever you like with it**
|
||||
- **Code**: I have a few projects developed for the Cube. You can see the list [here on my Gitea](https://git.kopic.hr/tomislav?tab=repositories&q=cube&sort=recentupdate)
|
||||
- **V2**: There is also a more [powerful version](https://git.kopic.hr/tomislav/SmartCubeV2), it's pretty much the same but with extra features and is using ESP32, I only made one of them and I don't like it yet, it needs work.
|
||||
- **Case**: 3D-printable design included in `/hardware` directory
|
||||
- **Schematics**: and assembly instructions are also in the `/hardware` directory
|
||||
- **This is a hobby project I work on and develop for when I have literally nothing else to do, do not expect regular updates. You are free to clone this and do whatever you like with it**
|
||||
|
||||
---
|
||||
|
||||
@@ -27,27 +27,48 @@ show notifications, display the weather, monitor stuff, show a clock, serve a we
|
||||
| TP4056 Module | 1 | Charging and protection circuit | Does not need to have a USB connector |
|
||||
| Push Buttons | 3 | Tactile push buttons | |
|
||||
| Piezo Buzzer | 1 | 20mm buzzer for audio feedback | |
|
||||
| Resistors (10kΩ) | 3 | Pull-down resistors for buttons | Ensures stable button input |
|
||||
| Resistors (10kΩ) | 3 | Pull-down resistors for buttons | Not reqired if you are using ESP32 |
|
||||
| Wires | Several | For connections | |
|
||||
| Enclosure | 1 | 3D-printed or custom-made case | 3D printable STL files are in `hardware/case/` |
|
||||
| 2x6mm screw | 12 | Small screws for seembling the case | Does not have to be exactly 6mm long |
|
||||
|
||||
---
|
||||
|
||||
## Demo Code Explanation
|
||||
## Demo Code Explanation
|
||||
|
||||
The demo code provided in this repo is the starting point(hello world) for the SmartCube development with Platform.io, it does the basic system initialization, button handling, OLED display output configured and WiFi management:
|
||||
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.
|
||||
|
||||
### 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
|
||||
|
||||
1. **WiFi Management**:
|
||||
- The `cubeWifiManager` class manages WiFi connectivity seamlessly.
|
||||
- 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()` function, executed in the `loop()`, monitors and interprets button presses, differentiating between short and long presses.
|
||||
- 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**:
|
||||
@@ -57,7 +78,10 @@ The demo code provided in this repo is the starting point(hello world) for the S
|
||||
- **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.
|
||||
|
||||
---
|
||||
|
||||
## Pin Connections
|
||||
|
||||
Pin numbers for buttons and other stuff is defined in the [example config](https://git.kopic.hr/tomislav/SmartCubeV1/src/branch/main/src/example_config.h) and the schematic for the [D1 Mini is here](https://git.kopic.hr/tomislav/SmartCubeV1/raw/branch/main/hardware/schematics/esp8266.png):
|
||||
@@ -100,6 +124,4 @@ The OLED display must to be connected via I2C on pins:
|
||||
- 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!
|
||||
|
||||
---
|
||||
For questions or additional details, feel free to reach out! I would love to hear some feedback.
|
||||
Reference in New Issue
Block a user