73 lines
1.5 KiB
Markdown
73 lines
1.5 KiB
Markdown
# SmartCube V1
|
||
|
||
**SmartCube** is a tiny, customizable desk toy built with an ESP8266 D1 Mini. It can display messages on an OLED, monitor battery voltage, control a buzzer, and respond to button presses.
|
||
|
||
---
|
||
|
||
## 1️⃣ Clone the Repository
|
||
|
||
If you are on **Windows**, open **Command Prompt (CMD)**:
|
||
|
||
1. Press **Win + R**, type `cmd`, and press **Enter**.
|
||
2. Navigate to the folder where you want to store the project (optional):
|
||
|
||
```bash
|
||
cd C:\Users\YourUsername\Downloads
|
||
```
|
||
|
||
3. Clone the repo:
|
||
|
||
```bash
|
||
git clone https://git.kopic.hr/tomislav/SmartCube_ESPHome
|
||
cd SmartCube_ESPHome
|
||
```
|
||
|
||
This downloads all the files for your SmartCube.
|
||
|
||
---
|
||
|
||
## 2️⃣ Install Python
|
||
|
||
1. Download Python 3.13+ from [python.org](https://www.python.org/downloads/).
|
||
2. During installation, **check “Add Python to PATH”**.
|
||
3. Verify installation in CMD:
|
||
|
||
```bash
|
||
python --version
|
||
```
|
||
|
||
---
|
||
|
||
## 3️⃣ Install ESPHome
|
||
|
||
Install ESPHome using Python’s package manager:
|
||
|
||
```bash
|
||
pip install esphome
|
||
```
|
||
|
||
Check installation:
|
||
|
||
```bash
|
||
esphome version
|
||
```
|
||
|
||
---
|
||
|
||
## 4️⃣ Flash the SmartCube
|
||
|
||
1. Connect your D1 Mini to your PC using a **data-capable micro-USB cable**.
|
||
|
||
2. Upload the firmware:
|
||
|
||
```bash
|
||
esphome run smartcube.yaml
|
||
```
|
||
|
||
ESPHome will compile and flash the firmware.
|
||
|
||
3. After flashing, the cube will connect to the Wi-Fi you set in the config.
|
||
|
||
* If it fails, it will start a fallback AP named **SmartCube** with password **12345678**.
|
||
* Connect to this AP to configure your Wi-Fi.
|