Update readme
49
Readme.md
@@ -84,31 +84,37 @@ This is meant to provide a minimal starting point for further development with t
|
|||||||
|
|
||||||
## Assembly Instructions
|
## Assembly Instructions
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
1. 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 sould 'click in' with the USB-C port facing the hole.
|
1. 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 sould 'click in' with the USB-C port facing the hole.
|
||||||
Body with 3 or 4 button slots is available in the `hardware/case/`
|
Body with 3 or 4 button slots is available in the `hardware/case/`
|
||||||
|
|
||||||
2. **Buttons**: You can also glue in the buttons to the top slots at this step
|

|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
3. **OLED Display**: Crew in or 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 lenght, 4-5cm sould be more than enough
|
2. **Buttons**: You can glue in the buttons to the top slots at this step and solder the resistors to them
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
4. **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)
|

|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
5. Solder all of the components to the microcontroller:
|
|
||||||
## Pin Connections
|
|
||||||
|
|
||||||
|
Solder all of the buttons to the microcontroller:
|
||||||
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):
|
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):
|
||||||
You don't have to follow my pin definition exactly but I find this the easiest way to assemble and fit everything in. 3 Button variant is the standard. If you are gonna go with the 4 button variant you will need to define this yourself.
|
You don't have to follow my pin definition exactly but I find this the easiest way to assemble and fit everything in. 3 Button variant is the standard. If you are gonna go with the 4 button variant you will need to define this yourself.
|
||||||
|
|
||||||
- Button Left (PIN_BTN_L): GPIO12
|

|
||||||
- Button Middle (PIN_BTN_M): GPIO13
|
|
||||||
- Button Right (PIN_BTN_R): GPIO15
|
- Button Left (PIN_BTN_L): (D6) GPIO12
|
||||||
- Piezo Buzzer (PIN_BUZZER): GPIO0
|
- Button Middle (PIN_BTN_M): (D7) GPIO13
|
||||||
|
- Button Right (PIN_BTN_R): (D8) GPIO15
|
||||||
|
|
||||||
|
3. **OLED Display**: Crew in or 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 lenght, 4-5cm sould be more than enough
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
The OLED display must to be connected via I2C on pins:
|
The OLED display must to be connected via I2C on pins:
|
||||||
- **SDA**: D2 (GPIO4)
|
- **SDA**: D2 (GPIO4)
|
||||||
@@ -116,13 +122,23 @@ The OLED display must to be connected via I2C on pins:
|
|||||||
- **GND**: GND
|
- **GND**: GND
|
||||||
- **VCC**: 3.3V pin or directly to the TP4056 output
|
- **VCC**: 3.3V pin or directly to the TP4056 output
|
||||||
|
|
||||||
6. **Power Supply Setup**:
|

|
||||||
|
|
||||||
|
4. **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)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
5. **Power Supply Setup**:
|
||||||
- Battery is not required and you can skip this step if you want to but it is much cuter when it's portable. A single 600mAh 14250 lasts about 24 hours.
|
- Battery is not required and you can skip this step if you want to but it is much cuter when it's portable. A single 600mAh 14250 lasts about 24 hours.
|
||||||
- Solder the 14250 battery to the TP4056 module input pins.
|
- Solder the 14250 battery to the TP4056 module input pins.
|
||||||
- Wire the output of the TP4056 to the **3.3V pin** on the D1 Mini to power the device.
|
- Wire the output of the TP4056 to the **3.3V pin** on the D1 Mini to power the device.
|
||||||
- Connect the **5V output pin** from the D1 Mini to the **input port** on the TP4056 module to allow charging trough the Data USB port on the ESP8266.
|
- Connect the **5V output pin** from the D1 Mini to the **input port** on the TP4056 module to allow charging trough the Data USB port on the ESP8266.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -136,7 +152,6 @@ The OLED display must to be connected via I2C on pins:
|
|||||||
- Test the circuit thoroughly before placing and glueing it in the enclosure.
|
- Test the circuit thoroughly before placing and glueing 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
|
- 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.
|
For questions or additional details, feel free to reach out! I would love to hear some feedback.
|
||||||
Good luck and have fun :)
|
Good luck and have fun :)
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 2.2 MiB |
Before Width: | Height: | Size: 2.2 MiB |
Before Width: | Height: | Size: 2.2 MiB |
Before Width: | Height: | Size: 2.0 MiB |
Before Width: | Height: | Size: 2.1 MiB |
Before Width: | Height: | Size: 2.2 MiB |
Before Width: | Height: | Size: 3.8 MiB |
Before Width: | Height: | Size: 4.0 MiB |
BIN
hardware/pictures/batt1.jpg
Normal file
After Width: | Height: | Size: 2.8 MiB |
BIN
hardware/pictures/batt2.jpg
Normal file
After Width: | Height: | Size: 3.2 MiB |
BIN
hardware/pictures/batt3.jpg
Normal file
After Width: | Height: | Size: 1.9 MiB |
BIN
hardware/pictures/build1.jpg
Normal file
After Width: | Height: | Size: 2.9 MiB |
BIN
hardware/pictures/build2.jpg
Normal file
After Width: | Height: | Size: 2.6 MiB |
BIN
hardware/pictures/build3.jpg
Normal file
After Width: | Height: | Size: 3.1 MiB |
BIN
hardware/pictures/build4.jpg
Normal file
After Width: | Height: | Size: 2.6 MiB |
BIN
hardware/pictures/build5.jpg
Normal file
After Width: | Height: | Size: 3.1 MiB |
BIN
hardware/pictures/build6.jpg
Normal file
After Width: | Height: | Size: 3.0 MiB |
BIN
hardware/pictures/build7.jpg
Normal file
After Width: | Height: | Size: 2.7 MiB |
BIN
hardware/pictures/build8.jpg
Normal file
After Width: | Height: | Size: 3.1 MiB |
BIN
hardware/pictures/build9.jpg
Normal file
After Width: | Height: | Size: 2.2 MiB |
BIN
hardware/pictures/layout.jpg
Normal file
After Width: | Height: | Size: 3.2 MiB |