Gyver433

Библиотека для радиомодулей 433 МГц и Arduino

Супер лёгкая либа, заведётся даже на тини13 (отправка)
Поддержка кривых китайских модулей
Интерфейс Manchester Coding (v1.1)
Встроенный CRC контроль целостности (CRC8 или XOR)
Ускоренный алгоритм IO для AVR Arduino
Опционально работа в прерывании (приём данных)

Совместимость

Совместима со всеми Arduino платформами (используются Arduino-функции)

Установка

Библиотеку можно найти по названию Gyver433 и установить через менеджер библиотек в:
- Arduino IDE
- Arduino IDE v2
- PlatformIO
Скачать библиотеку .zip архивом для ручной установки:
- Распаковать и положить в C:\Program Files (x86)\Arduino\libraries (Windows x64)
- Распаковать и положить в C:\Program Files\Arduino\libraries (Windows x32)
- Распаковать и положить в Документы/Arduino/libraries/
- (Arduino IDE) автоматическая установка из .zip: Скетч/Подключить библиотеку/Добавить .ZIP библиотеку… и указать скачанный архив
Читай более подробную инструкцию по установке библиотек здесь

Инициализация

//Классы:
Gyver433_RX // приёмник
Gyver433_TX // передатчик

Gyver433_xx<пин, буфер, CRC> xx;
// пин: цифровой пин
// буфер: размер буфера в байтах. На "ручную" отправку буфер не нужен (пример raw_tx). По умолч. 64 байта
// CRC: проверка целостности данных: G433_CRC8 (надёжный), G433_XOR (лёгкий), G433_NOCRC (отключено). По умолч. G433_CRC8

// Дефайны-настройки перед подключением библиотеки
#define G433_SLOW_MODE      // "медленный режим" для синих модулей SYN480R
#define G433_SPEED 1000     // скорость 100-8000 бит/с, по умолч. 2000 бит/с

Использование

// ========= Gyver433_TX =========
void sendData(T &data);                 // отправить данные любого типа (CRC добавляется автоматически)
void write(uint8_t* buf, uint8_t size); // отправить массив байт указанного размера (CRC не добавляется)
uint8_t buffer[];                       // доступ к буферу для отладки

// ========= Gyver433_RX =========
uint16_t tick();            // неблокирующий приём, вернёт кол-во успешно принятых байт
uint16_t tickWait();        // блокирующий приём (более надёжный), вернёт кол-во успешно принятых байт
uint16_t tickISR();         // тикер для прерывания по CHANGE (см. пример isr_rx)
bool readData(T &data);     // прочитает буфер в любой тип данных (в указанную переменную)
uint16_t getSize();         // получить размер принятых данных
uint16_t gotData();         // вернёт количество успешно принятых в tickISR() байт (см. пример isr_rx)
uint8_t buffer[];           // доступ к буферу для отладки

// ============= CRC =============
// можно использовать встроенные функции для генерации байта CRC для ручной упаковки пакетов
uint8_t G433_crc8(uint8_t *buffer, uint8_t size);       // ручной CRC8
uint8_t G433_crc_xor(uint8_t *buffer, uint8_t size);    // ручной CRC XOR

Примеры

Остальные примеры смотри в examples!

Отправка

#define G433_SLOW_MODE
#include <Gyver433.h>
Gyver433_TX<2, 20> tx;  // указали пин и размер буфера

void setup() {
}

char data[] = "Hello from #xx"; // строка для отправки
byte count = 0;                 // счётчик для отправки

void loop() {
  // добавляем счётчик в строку
  data[12] = (count / 10) + '0';
  data[13] = (count % 10) + '0';
  if (++count >= 100) count = 0;
  tx.sendData(data);
  delay(100);
}

Приём

#define G433_SLOW_MODE
#include <Gyver433.h>
Gyver433_RX<2, 20> rx;  // указали пин и размер буфера

void setup() {
  Serial.begin(9600);
}

void loop() {
  if (rx.tickWait()) {
    Serial.write(rx.buffer, rx.size);
    Serial.println();
  }
}

Приём в прерывании

#define G433_SLOW_MODE
#include <Gyver433.h>
Gyver433_RX<2, 20> rx;  // указали пин и размер буфера

void setup() {
  Serial.begin(9600);  
  attachInterrupt(0, isr, CHANGE);  // прерывание пина радио по CHANGE
}

void isr() {
  rx.tickISR();  // спец тикер вызывается в прерывании
}

void loop() {
  // вернёт количество удачно принятых в прерывании байт  
  if (rx.gotData()) {
    Serial.write(rx.buffer, rx.size);
    Serial.println();
  }  
  delay(200);   // имитация загруженного кода
}

Версии

v1.0
v1.1 - оптимизация, новый интерфейс, поддержка дешёвых синих модулей, работа в прерывании

Баги и обратная связь

При нахождении багов создавайте Issue, а лучше сразу пишите на почту alex@alexgyver.ru
Библиотека открыта для доработки и ваших Pull Request'ов!

6.9 KiB Raw Blame History