Библиотека для упаковки битовых флагов в байтовый массив (экономия места) для Arduino
Совместима со всеми Arduino платформами (используются Arduino-функции)
// указываем количество флагов
BitPack<10> pack; // static буфер внутри
BitPackDyn pack(10); // динамическое выделение
uint8_t buf[2]; // 1 байт - 8 флагов
BitPackExt pack(buf, 10); // 10 флагов// методы
void set(uint16_t num); // установить
void clear(uint16_t num); // сбросить
void toggle(uint16_t num); // переключить
void write(uint16_t num, bool state); // записать
bool read(uint16_t num); // прочитать
void setAll(); // установить все
void clearAll(); // сбросить все
bool copyTo(любой пак); // копировать в
bool copyFrom(любой пак); // копировать из
uint16_t amount(); // количество флагов
uint16_t size(); // размер pack в байтах
uint8_t* pack; // доступ к буферу
// макросы
BP_SET(pack, idx)
BP_CLEAR(pack, idx)
BP_READ(pack, idx)
BP_TOGGLE(pack, idx)
BP_WRITE(pack, idx)
// настройки (до подключения библиотеки)
#define BP_NO_ARRAY // убрать доступ через [] - экономит 2 байта RAMBitPackExt() {}
// передать буфер и его размер в количестве флагов (8 флагов - 1 байт)
BitPackExt(uint8_t* pack, uint16_t amount, bool clear = true);
// передать буфер и его размер в количестве флагов (8 флагов - 1 байт)
void setBuffer(uint8_t* pack, uint16_t amount, bool clear = true);BitPackDyn() {}
// указать количество флагов
BitPackDyn(uint16_t amount);
// указать количество флагов
void init(uint16_t amount);В библиотеке реализован удобный доступ к битам через образение как к массиву []. Этот способ чуть медленнее использования функций set/read/write!
BitPack<10> flags;
flags[0] = 1;
Serial.println(flags[0]);
bool f = flags[0];
BitPack<10> flags2;
flags[0] = flags2[0];
// примечание:
// такое приравнивание некорректно! Используй copyTo/copyFrom
flags = flags2;
flags.copyTo(flags2); // копировать весь пакет// пакет флагов
T flags = 0;
// прочитать бит
bool read(const T x);
// установить биты маской
void set(const T x);
// очистить биты маской
void clear(const T x);
// записать бит
void write(const T x, const bool v);
// получить маску
T mask(const T x);
// стоят все биты в маске
bool isSet(const T x);
// очищены все биты в маске
bool isClear(const T x);
// сравнить маску со значением
bool compare(const T x, const T y);Ещё три пакета фиксированного количества флагов BitFlags8, BitFlags16, BitFlags32 на 8/16/32 флагов соответственно. Они работают чуть иначе, как регистры. Можно ставить и читать несколько флагов за одно действие, что сильно повышает производительность. Для удобства можно объявить флаги как биты:
#define MY_FLAG_0 bit(0)
#define KEK_FLAG bit(1)
#define SOME_F bit(2)
BitFlags8 flags;
flags.set(KEK_FLAG | SOME_F); // установить два флага
if (flags.read(KEK_FLAG | SOME_F)); // проверить два флага
// операция compare берёт маску по первому аргументу и сравнивает со вторым
// фактически смысл такой: определение ситуации, когда из указанных флагов подняты только определённые
// здесь - из флагов KEK_FLAG и SOME_F поднят только SOME_F (KEK_FLAG опущен)
if (flags.compare(KEK_FLAG | SOME_F, SOME_F));Остальные примеры смотри в examples!
#include "BitPack.h"
// указываем количество флагов
BitPack<10> flags;
void setup() {
Serial.begin(9600);
flags.clearAll(); // опустить все
flags.set(1); // поднять флаг
flags.set(3);
flags.write(3, 1);
Serial.println(flags.read(0)); // прочитать флаг
Serial.println(flags.read(1));
Serial.println(flags.read(2));
flags[3] = 0; // можно писать через []
Serial.println(flags[3]); // можно читать через []
BitPack<10> flags2;
flags[0] = flags2[1]; // копировать бит
flags.copyTo(flags2); // копировать весь пакет
}
void loop() {
}- v1.0
- v1.1 - пофикшен доступ через [], добавлены новые инструменты
- v1.1.1 - перезалив
- v1.2 - добавлены copy методы, упрощён доступ через массив
- v1.3 - добавлена отдельная инициализация для BitPackExt и BitPackDyn
- v1.3.1 - добавлен copy и move конструктор для BitPackDyn. Добавлены инструменты BitFlags8, BitFlags16, BitFlags32
- Библиотеку можно найти по названию BitPack и установить через менеджер библиотек в:
- 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: найти библиотеку как при установке и нажать "Обновить"
- Вручную: удалить папку со старой версией, а затем положить на её место новую. "Замену" делать нельзя: иногда в новых версиях удаляются файлы, которые останутся при замене и могут привести к ошибкам!
При нахождении багов создавайте Issue, а лучше сразу пишите на почту alex@alexgyver.ru
Библиотека открыта для доработки и ваших Pull Request'ов!
При сообщении о багах или некорректной работе библиотеки нужно обязательно указывать:
- Версия библиотеки
- Какой используется МК
- Версия SDK (для ESP)
- Версия Arduino IDE
- Корректно ли работают ли встроенные примеры, в которых используются функции и конструкции, приводящие к багу в вашем коде
- Какой код загружался, какая работа от него ожидалась и как он работает в реальности
- В идеале приложить минимальный код, в котором наблюдается баг. Не полотно из тысячи строк, а минимальный код