Benchmark

Измерение времени выполнения кода для Arduino и измерения количества свободной оперативной памяти

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

• AVR (библиотека использует Timer 1)
• ESP8266
• ESP32

Содержание

• Использование
• Версии
• Установка
• Баги и обратная связь

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

// начать измерение
void benchBegin();

// закончить измерение. Вернёт кол-во тактов. Опционально подключить лог
uint32_t benchEnd(Stream* log = nullptr);
uint32_t benchEnd(Stream& log);

// получить размер свободной памяти
size_t getFreeHeap();

Пример

#include <Benchmark.h>

void setup() {
	Serial.begin(115200);
    benchBegin();
    delay(1);
    benchEnd(Serial);
}
void loop() {}

Версии

• v1.0

Установка

• Библиотеку можно найти по названию Benchmark и установить через менеджер библиотек в:
  • 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, а лучше сразу пишите на почту [email protected]
Библиотека открыта для доработки и ваших Pull Request'ов!

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

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