AsyncStream  1.1.0
AsyncStream Documentation

arduino-library-badge Foo Foo Foo

Foo

AsyncStream

Библиотека для асинхронного чтения объектов Stream (Serial итд)

  • Неблокирующее чтение в свой буфер
  • Указание символа терминатора

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

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

Содержание

Установка

  • Библиотеку можно найти по названию AsyncStream и установить через менеджер библиотек в:
    • 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 библиотеку… и указать скачанный архив
  • Читай более подробную инструкцию по установке библиотек здесь

    Обновление

  • Рекомендую всегда обновлять библиотеку: в новых версиях исправляются ошибки и баги, а также проводится оптимизация и добавляются новые фичи
  • Через менеджер библиотек IDE: найти библиотеку как при установке и нажать "Обновить"
  • Вручную: удалить папку со старой версией, а затем положить на её место новую. "Замену" делать нельзя: иногда в новых версиях удаляются файлы, которые останутся при замене и могут привести к ошибкам!

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

// <размер буфера>
// Stream обработчик (Serial, SoftwareSerial итд)
// терминатор (символ конца приёма) - по умолчанию ';' (вырезается из буфера!)
// таймаут в мс - по умолчанию 50
AsyncStream<100> serial(&Serial);
AsyncStream<100> serial(&Serial, '\n');
AsyncStream<100> serial(&Serial, '\n', 20);

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

void setTimeout(uint16_t tout); // установить таймаут
void setEOL(char ter); // установить символ конца
bool available(); // данные приняты
char buf; // доступ к буферу

Пример

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

#include <AsyncStream.h>
AsyncStream<100> serial(&Serial, '\n');
void setup() {
Serial.begin(9600);
// serial.setTimeout(100); // установить другой таймаут
// serial.setEOL(';'); // установить другой терминатор (EOL)
}
// строка для теста (отправь в сериал)
// 1234,3.14,hello,4567,lolkek,qwerty
void loop() {
if (serial.available()) { // если данные получены
Serial.println(serial.buf); // выводим их (как char*)
}
}

Версии

  • v1.0
  • v1.1 - исправлен баг

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

При нахождении багов создавайте Issue, а лучше сразу пишите на почту alex@alexgyver.ru

Библиотека открыта для доработки и ваших Pull Request'ов!

При сообщении о багах или некорректной работе библиотеки нужно обязательно указывать:

  • Версия библиотеки
  • Какой используется МК
  • Версия SDK (для ESP)
  • Версия Arduino IDE
  • Корректно ли работают ли встроенные примеры, в которых используются функции и конструкции, приводящие к багу в вашем коде
  • Какой код загружался, какая работа от него ожидалась и как он работает в реальности
  • В идеале приложить минимальный код, в котором наблюдается баг. Не полотно из тысячи строк, а минимальный код