Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/friedjof/esp32-433api
This is a 433MHz web-API for the esp32 microcontroller
https://github.com/friedjof/esp32-433api
433mhz api arduino esp32 platformio wifi
Last synced: 3 days ago
JSON representation
This is a 433MHz web-API for the esp32 microcontroller
- Host: GitHub
- URL: https://github.com/friedjof/esp32-433api
- Owner: Friedjof
- Created: 2022-10-04T11:25:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-03T20:23:29.000Z (about 2 years ago)
- Last Synced: 2024-12-05T09:16:06.879Z (2 months ago)
- Topics: 433mhz, api, arduino, esp32, platformio, wifi
- Language: C++
- Homepage:
- Size: 44.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ESP32 433API
This projekt links an API to a 433MHz transmitter. This is based on the [ESP32](https://www.espressif.com/en/products/hardware/esp32/overview).
## Hardware
- ESP32
- 433MHz transmitter
## Endpoints
### `/`
- GET: returns the WiFi status
### `/styles`
- GET: returns the styles for the web interface
### `/logs`
- GET: returns the logs
- `?key=your-api-key`: returns the logs
- `?clear`: clears the logs
### `/config`
- GET: set or return the config
- `?ssid=your-ssid&password=your-password`: set the WiFi config
- `?show`: returns the config
### `/transmit`
- GET: transmit a code
- `?key=your-api-key`: authorization
- `&msg=your-message`: the message to transmit
- `type=your-type`: the type of the message (`hex` & `bin` are supported)
## Software
- [PlatformIO](https://platformio.org/)
- [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer)
- […]
## Development
### Setup
Visual Studio Code with PlatformIO
- install PlatformIO
Move directory data-sample to data
```bash
mv data-sample data
```
Edit data/config.json
```json
{
"wifi": {
"ssid": "myssid",
"password": "mypassword",
"hostname": "your-hostname",
"port": 80
},
"microcontroller": {
"serial_baudrate": 9600
},
"transmitter": {
"pin": 27,
"protocol": 1,
"pulse_length": 500
},
"api": {
"key": "your-api-key"
}
}
```
### Build filesystem and upload
```bash
pio run -t buildfs && pio run -t uploadfs
```
### Build and upload
```bash
pio run -t upload
```
### Monitor
```bash
pio device monitor
```
## License
[MIT](LICENSE)
## Author
[Friedjof Noweck](https://github.com/Friedjof)