пятница, 4 ноября 2016 г.

Библиотека OLED_StatusIcons

OLED_StatusIcons

описание дополнения библиотеки OLED_I2C для отображения значков в строке состояния на русском языке



Введение: 

    Эта библиотека является дополнением к библиотеке OLED_I2C и сама по себе работать не будет. 
   Предназначена для отображения значков в строке состояния OLED-дисплея. Строка состояния может располагаться в верхней или нижней части дисплея, но иконки должны быть расположены все на одной линии. Библиотека поддерживает значки размером 8x8 и 16x16 пикселей. Обратите внимание, что одновременно допускается использовать значки только одного размера.
    Иконки для данной библиотеки могут быть сделаны самостоятельно. Они должны быть монохромными и иметь размер 8х8 или 16х16 пикселей. Другие размеры не поддерживаются.

Поддерживаемые значки:




Определенные литералы:

Размер иконок
ICONSIZE_8X8: 1
ICONSIZE_16X16: 2

Выравнивание иконок
ICONPOSITION_TOP_RIGHT:         0 (выравнивание по верхнему правому углу)
ICONPOSITION_TOP_LEFT:            1 (выравнивание по верхнему левому углу)
ICONPOSITION_BOTTOM_RIGHT: 2 (выравнивание по нижнему правому углу)
ICONPOSITION_BOTTOM_LEFT:   3 (выравнивание по нижнему левому углу)




Функции:

OLED_StatusIcons(OLED, size, position);
Инициализация библиотеки
Параметры: 
OLED: ранее инициализированная функция OLED библиотеки OLED_I2C
size: размер значков (ICONSIZE_8X8 или ICONSIZE_16X16)
position: выравнивание значков (ICONPOSITION_TOP_RIGHT, ICONPOSITION_TOP_LEFT, ICONPOSITION_BOTTOM_RIGHT или ICONPOSITION_BOTTOM_LEFT)
Пример: OLED_StatusIcons myIcons(&myOLED, ICONSIZE_8X8, ICONPOSITION_BOTTOM_LEFT); // Запуск библиотеки
Примечание: Обратите внимание на то, что перед именем OLED обьекта ставится символ ‘&’

begin();
Инициализация строки состояния
Параметры: Нет
Пример: myIcons.begin(); // Инициализация строки состояния

updateSpeed(ms);
Скорость обновления строки состояния
Параметры: 
ms: время в миллисекундах между обновлениями (100-10000). По умолчанию 1000
Пример: myIcons.updateSpeed(1000); // Установить частоту обновления 1 раз в 1000мс

enableStatusbar();
Включение управляемой прерываниями строки состояния
Параметры: Нет
Пример: myIcons.enableStatusbar(); // Включить управляемую прерываниями строку состояния

disableStatusbar();
Отключение управляемой прерываниями строки состояния
Параметры: Нет
Пример: myIcons.disableStatusbar(); // Отключить управляемую прерываниями строку состояния

refreshStatusbar();
Принудительное обновление строки состояния
Параметры: Нет
Пример: myIcons.refreshStatusbar(); // Немедленно обновить строку состояния
Примечание: При очистке дисплея строка состояния также очищается и будет такой оставаться в течение некоторого времени до следующего цикла обновления. Для немедленной перерисовки строки состояния необходимо использовать функцию refreshStatusbar().

createIcon(position, bitmap [, enabled]);
Создание нового значка в строке состояния
Параметры: 
position: позиция нового значка (0-13 для значка 8x8 и 0-6 для значка 16x16)
bitmap: массив, содержащий растровое изображение для данного значка
enabled: <необязательный параметр> Отчет о создании значка: false (по умолчанию) или true
Возврат: (булевое значение) true (истинно) если иконка успешно создана, иначе - false (ложно)
Пример: myIcons.createIcon(0, power_8, true); // Создать иконку в положении, наиболее близкому к выбранному краю и включить ее
Примечание: Позиция 0 всегда ближе всего к выбранному краю выравнивания.
Новый значок в той же позиции, где уже есть значок создать нельзя.

deleteIcon(position);
Удаление значка в строке состояния
Параметры: 
position: позиция значка для удаления
Возврат: (булевое значение) true (истинно) если значок успешно удален, иначе - false (ложно)
Пример: myIcons.deleteIcon(0); // удалить значок в позиции 0

enableIcon(position);
Включить/показать значок в строке состояния
Параметры: 
position: позиция значка для включения/отображения
Пример: myIcons.enableIcon(0); // включить/отобразить значок в позиции 0

disableIcon(position);
Отключение/скрытия значка в строке состояния
Parameters: 
position: позиция значка для отключения/скрытия
Пример: myIcons.disableIcon(0); // отключить/скрыть значок в позиции 0

changeIcon(position, bitmap);
Замена растрового изображения для существующего значка
Параметры: 
position: положение значка, которым будет заменен стандартный растровый рисунок
bitmap: массив, содержащий растровое изображение для данного значка
Пример: myIcons.changeIcon(0, mail_8); // Замена растрового изображения для значка, находящегося в позиции 0

Комментариев нет:

Отправить комментарий