Skip to content

Графический движок на символах: полноценное рисование, индикаторы загрузки, графики для Arduino

License

Notifications You must be signed in to change notification settings

GyverLibs/CharDisplay

Repository files navigation

latest PIO Foo Foo Foo

Foo

CharDisplay

Библиотека для создания символьной графики:

  • CharMatrix - Матрица для полноценного рисования (4 стиля)
  • CharBar - Полосы загрузки (10 стилей)
  • CharPlot - График (4 стиля + 2 стиля заполнения + 2 стиля рамки)

Отлично подходит для визуализации данных в отчётах при отправке на почту или через Телеграм-бота
Внимание! Нормально отображается не везде, нужен моноширинный шрифт.

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

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

Зависимости

Содержание

CharMatrix

matrix

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

CharMatrix<стиль> disp(ширина, высота);

// стили:
CHAR_X1
CHAR_X2
CHAR_X4
CHAR_X8

Перед подключением библиотеки можно указать символы, которыми выводить стиль CHAR_X1. Например:

#define CM_X1_CLEAR ' '
#define CM_X1_FILL '#'

// #define CM_X1_CLEAR "[]"
// #define CM_X1_FILL "██"

#include <CharMatrix.h>
CharMatrix<CHAR_X1> disp(32, 12);

Рисование

Наследуется из GyverGFX

Вывод

// напечатать в Print
size_t printTo(Print& p);

// вывести как String
String render();

CharPlot

plots

String CharPlot<стиль>(float*, ширина (размер массива), высота);
String CharPlot<стиль>(float*, ширина (размер массива), высота, fill);
String CharPlot<стиль>(float*, ширина (размер массива), высота, fill, border);

// fill (0, 1) - заполнять пустоты пробелами или точками (умолч. 1)
// border (0, 1) - сплошной или двойной стиль рамки (умолч. 0)

// стили:
LINE_X1
LINE_X2
COLON_X2
COLON_X1

CharBar

bars

String CharBar<стиль>(размер, заполнение 0-100);

// стили:
BAR_SQUARE
BAR_SQUARE2
BAR_SQUARE3
BAR_DIAMOND
BAR_RECT
BAR_RECT2
BAR_BLOCK
BAR_BLOCK2
BAR_CIRCLE
BAR_CIRCLE2

Версии

  • v1.0
  • v1.0.1 - перезалив
  • v1.1.0 - улучшен ускорен CharMatrix, добавлен вывод в Print

Установка

  • Библиотеку можно найти по названию CharDisplay и установить через менеджер библиотек в:
    • 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
  • Корректно ли работают ли встроенные примеры, в которых используются функции и конструкции, приводящие к багу в вашем коде
  • Какой код загружался, какая работа от него ожидалась и как он работает в реальности
  • В идеале приложить минимальный код, в котором наблюдается баг. Не полотно из тысячи строк, а минимальный код

About

Графический движок на символах: полноценное рисование, индикаторы загрузки, графики для Arduino

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages