Skip to content

Latest commit

 

History

History
115 lines (75 loc) · 2.75 KB

README.md

File metadata and controls

115 lines (75 loc) · 2.75 KB
Raw

Badge Connect library (Binary version)

This library is designed to provide a simple API in order to communicate electronic badges over a WiFi mesh network. It works using the ESPNOW protocol developed by Espressif Systems.

Features

  • Send and receive messages between badges (messages can be of any data type)
  • Set the badge's type (e.g. "BSides", "DragonJAR", "Ekoparty", and "BugCON")
  • Get the badge's type

Requirements

  • At least two ESP32 development boards
  • ESP-IDF installed in your computer
  • make installed in your computer (optional)

Installation

Add badge_connect_bin as a git submodule in your project.

git submodule add https://github.com/ElectronicCats/badge_connect_bin.git firmware/components/badge_connect

Usage

  1. Include the library in your source code.
#include "badge_connect.h"
  1. Initialize the library in your code.
badge_connect_init();
  1. Implement the callback function that will be called when a message is received.
void receive_data_cb(badge_connect_recv_msg_t* msg) {
    // Do something with the received message
}
  1. Register the callback function.
badge_connect_register_recv_cb(receive_data_cb);
  1. Set the badge's type, choose one of the following:
badge_connect_set_bsides_badge();
badge_connect_set_dragonjar_badge();
badge_connect_set_ekoparty_badge();
badge_connect_set_bugcon_badge();
  1. Send a message to another badge.
char* data = "Hello, world!";
badge_connect_send(data, strlen(data));
  1. Compile and flash!

Examples

There is a folder called examples in this repository, you can use the Makefile in each example to compile and flash the firmware.

  1. Get idf.py to your terminal session, if you followed the Espressif IDF installation guide, use get_idf.
get_idf
  1. Go to the example folder you want to compile. For example, the send_int one.
cd examples/send_int
  1. Set the board type you are using, skip if you are using an ESP32. For example, ESP32-C6.
idf.py set-target esp32c6
  1. Set the serial port where the board is connected. For example, /dev/ttyUSB0.
export PORT=/dev/ttyUSB0
  1. Compile, flash, and monitor the output.
make all

License

Electronic Cats invests time and resources in providing this open-source design, please support Electronic Cats and open-source hardware by purchasing products from Electronic Cats!

Designed by Electronic Cats.

This library is released under a GNU AGPL v3.0 license. See the LICENSE file for more information.

Electronic Cats is a registered trademark, please do not use if you sell these PCBs.

June 2024