uploaded 5 months ago
ESP-IDF component for Blues Notecard with I2C and UART support
readme
# ESP-IDF Notecard Component
An ESP-IDF component for integrating Espressif devices with the Blues [Notecard](https://blues.com/products/notecard/).
## Installation
```bash
idf.py add-dependency "blues/note-espidf"
```
## Usage
The component can be used to communicate with the Notecard using I2C or UART.
The GPIO pins can either be set within application code or via `menuconfig`.
### Basic Example
```c
#include "notecard.h"
void app_main(void) {
// Initialize with default I2C configuration
notecard_config_t config = NOTECARD_I2C_CONFIG_DEFAULT();
// or with UART
// notecard_config_t config = NOTECARD_UART_CONFIG_DEFAULT();
ESP_ERROR_CHECK(notecard_init(&config));
// Send a request using note-c API
J *req = NoteNewRequest("hub.set");
JAddStringToObject(req, "product", "com.your-company:your-product");
JAddStringToObject(req, "mode", "continuous");
if (!NoteRequest(req)) {
ESP_LOGE("app", "hub.set failed");
}
}
```
## Configuration
The component can be further configured with `menuconfig`.
```bash
idf.py menuconfig
Component config ---> Notecard Configuration
```
## Examples
For examples, see the [examples](examples) directory.
Examples are designed to run on:
- [Adafruit ESP32 Feather V2](https://learn.adafruit.com/adafruit-esp32-feather-v2?view=all)
- [Notecard](https://blues.com/products/notecard/)
- [Notecarrier F](https://blues.com/products/notecarrier/notecarrier-f/)
If you wish to use a different ESP32 board (or different ESP32 chip), you will need to adjust the GPIO pins used for the Notecard.
See the [Kconfig](Kconfig) file for the default I2C and UART GPIO pins.
## Documentation
For more information, visit [Blues Developer Documentation](https://dev.blues.io/).
Links
- Homepage
- Documentation
-
Repository
f6e6cfcb6c6f1eef99ef056b4a74bd2a6ef40556
Maintainer
- Support <support@blues.com>
License: MIT
To add this component to your project, run:
download archive
idf.py add-dependency "blues/notecard^0.1.1"
Stats
-
Archive size ~ 1.05 MB
-
Downloaded in total 8 times
-
This version: 0 times
Badge
