https://github.com/daringcuteseal/breezoduino
An Arduino library for communicating with Breezo instances. Compatible with ESP8266 and ESP-32 boards.
https://github.com/daringcuteseal/breezoduino
arduino esp esp-arduino esp32 esp8266
Last synced: 3 months ago
JSON representation
An Arduino library for communicating with Breezo instances. Compatible with ESP8266 and ESP-32 boards.
- Host: GitHub
- URL: https://github.com/daringcuteseal/breezoduino
- Owner: DaringCuteSeal
- License: mit
- Created: 2025-03-17T08:05:48.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-18T01:09:32.000Z (4 months ago)
- Last Synced: 2025-03-18T01:33:44.607Z (4 months ago)
- Topics: arduino, esp, esp-arduino, esp32, esp8266
- Homepage:
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Breezoduino
Breezoduino is a lightweight ESP8266/ESP32 library that makes sending data to [Breezo](https://github.com/daringcuteseal/breezo) instances _as easy as a breeze_.
Designed for resource-constrained devices, Breezoduino helps you build JSON-like payloads and handle HTTP requests without the usual overhead.
✨ **Features**
* Ultra-lightweight. But to clarify, we _do_ use **floats** here.
* Effortless HTTP requests to servers running Breezo instance.
* Modern and readable: no `#define REQUEST_OK 1` garbage, just enums.
* Plug-and-play: no complex config, just call and send. Compatibility guaranteed!*
*as long as you don't send garbage data.
# Quick Usage
## Installation
TODO
## Making Requests
Include the header:
```cpp
#include
```
And also include the batteries:
```cpp
using breezoduino::Breezo;
using breezoduino::TempUnit;
using breezoduino::ConcentrationUnit;
using breezoduino::ResponseStatus;
```
Create the client instance (can be a global variable):
```cpp
Breezo client("https://breezo.site.me");
```
Create a request (these are all the available data types):
```cpp
void setup() {
const new_request = client.newRequest();
new_request.addTemp("temp", 100.0, TempUnit::Celcius); // i live in a mysterious place
new_request.addConcentration("co2", 1000.0, ConcentrationUnit::PPM); // well i'm a plant actually
new_request.addRatio("humidity", 1.0); // HOTTT!!
}
```
Send it:
```cpp
const result = client.send(new_request);
if (result.status == ResponseStatus.OK) {
Serial.printf("Sent request! entry ID: %s", result.id);
} else {
Serial.printf("Failed to send request! Error: ", result.message);
}
```
# Complete API Reference
Refer to the [API documentation](api-docs.md) to see what's available.