https://github.com/dmk/simplesp
A MicroPython library for ESP32 with easy-to-use interfaces for common components.
https://github.com/dmk/simplesp
Last synced: 11 months ago
JSON representation
A MicroPython library for ESP32 with easy-to-use interfaces for common components.
- Host: GitHub
- URL: https://github.com/dmk/simplesp
- Owner: dmk
- License: mit
- Created: 2024-08-18T18:49:58.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-18T20:06:29.000Z (almost 2 years ago)
- Last Synced: 2025-02-07T23:25:33.420Z (over 1 year ago)
- Language: Python
- Size: 53.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SimplESP
**SimplESP** is a simple and easy-to-use MicroPython library for the ESP32, providing
basic interfaces for common components such as LEDs, PWM-controlled LEDs, buttons, and
various sensors. This library is designed to be accessible for beginners.
## Features
- **LED Control**: Turn an LED on or off.
- **Dimmable LED Control**: Set brightness for a LED.
- **Button**: A button with a callback.
More features coming later
## Getting Started
### Prerequisites
To get started with SimplESP, you'll need:
- An ESP32 board.
- MicroPython firmware installed on your ESP32.
- Python 3.x installed on your computer.
- Required Python packages listed in `requirements.txt`.
### Installation
1. **Clone the repository:**
```bash
git clone https://github.com/dmk/SimplESP.git
cd SimplESP
```
2. Set up Python environment:
```bash
make setup-python
```
3. Flash MicroPython to the ESP32:
If you haven't already flashed MicroPython onto your ESP32, you can use the following command:
```bash
make flash
```
This will run the `scripts/flash_micropython.sh` script to erase and flash the firmware onto your ESP32.
4. Deploy the SimplESP Library:
TBD