Библиотека для управления каскадом сдвиговых регистров 74HC595 для Arduino

• Обращение по номеру пина в каскаде
• Встроенный буфер
• Аппаратный SPI или bit bang режим (любые пины)
• Ускоренный в 5 раз bit bang вывод для AVR Arduino

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

• Установка
• Подключение
• Инициализация
• Использование
• Пример
• Версии
• Баги и обратная связь

• Библиотеку можно найти по названию GyverHC595 и установить через менеджер библиотек в:
  • 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: найти библиотеку как при установке и нажать "Обновить"
• Вручную: удалить папку со старой версией, а затем положить на её место новую. "Замену" делать нельзя: иногда в новых версиях удаляются файлы, которые останутся при замене и могут привести к ошибкам!

• Q0.. Q7 - управляемые выходы
• VCC/GND - питание
• MR - сброс значений при низком сигнале. Подключить к VCC, если сброс не нужен
• OE - пины как активные выходы при низком сигнале, high-z при высоком. Подключить к GND, если не нужно управлять состоянием
• DS - вход данных, DT, (MOSI)
• SHCP - вход тактирования, CLK (SCK)
• STCP - chip select, CS
• Q7S - выход данных (никуда не подключен, если чип один)

Можно соединить несколько микросхем 74HC595 "каскадом":

• Пины SHCP, STCP, VCC, GND, а также OE и MR подключаются параллельно у всех микросхем
• Вход данных DS первой микросхемы подключается к выходу данных с микроконтроллера (пин DT/MOSI)
• Пин Q7S первой микросхемы подключается к DS второй микросхемы, и так далее по цепочке

Использование аппаратного SPI позволяет очень быстро обновлять состояния ног микросхем: на Arduino Nano (16 MHz) при использовании 8 MHz SPI данные на одну микросхему (1 байт) передаются за 1.9 мкс.
Для подключения к аппаратной шине нужно найти на распиновке микроокнтроллера пины MOSI и SCK, подключить их:

• DS - MOSI
• SHCP - SCK
• STCP - любой пин МК, указывается при инициализации

• Arduino NANO
  • [SCK] D13 -> SHCP
  • [MOSI] D11 -> DS
  • [CS] Любой пин -> STCP
• ATmega328
  • [SCK] PB5 -> SHCP
  • [MOSI] PB3 -> DS
  • [CS] Любой пин -> STCP
• esp8266
  • [SCK] GPIO14 -> SHCP
  • [MOSI] GPIO13 -> DS
  • [CS] Любой пин -> STCP

Библиотека поддерживает программный SPI, подключение к любым трём цифровым пинам. Для AVR Arduino используется ускоренный IO, позволяющий передать один байт за 22 мкс (105 мкс при обычном shiftOut()), что примерно соответствует аппаратному SPI на 500 kHz.

GyverHC595<amount, HC_SPI> reg(pinCS);                  // аппаратный SPI, скорость 4MHz (по умолч.)
GyverHC595<amount, HC_SPI, clock> reg(pinCS);           // аппаратный SPI, кастомная скорость
GyverHC595<amount, HC_PINS> reg(pinCS, pinDT, pinCLK);  // программный SPI (bit bang)

// без параметров
GyverHC595<amount, HC_SPI> reg;
GyverHC595<amount, HC_PINS> reg;

// amount - количество чипов 74HC595, подключенных каскадом
// pinCS - пин STCP (12 ножка микросхемы)
// pinDT - пин DS (14 ножка микросхемы)
// pinCLK - пин SHCP (11 ножка микросхемы)

void begin(int CS);                     // инициализация для SPI
void begin(int CS, int DT, int CLK);    // инициализация для bitbang
    
void write(uint16_t num, bool state);   // записать состояние пина под номером
void set(uint16_t num);                 // включить пин под номером
void clear(uint16_t num);               // выключить пин под номером

void setAll();                          // включить все
void clearAll();                        // выключить все
void writeAll(bool state);              // записать состояние всех

bool read(uint16_t num);                // прочитать состояние пина из буфера
void update();                          // обновить состояния пинов
uint8_t buffer[];                       // доступ к буферу
uint16_t amount();                      // количество доступных пинов

// дефайны настроек (перед подключением библиотеки)
#define HC595_DELAY x   // включить задержку в мкс для импульсов CLK в режиме bitbang (по умолч. 0)

Порядок пинов соответствует порядку пинов микросхем 74HC595 (Q0.. Q7) и растёт в сторону удаления от первой микросхемы:

"Номер" в библиотеке:  [0    1    2..  7 ]   [8    10.. 15]   [16.. 23]
Пин микросхемы:        [Q0   Q1   Q2.. Q7]   [Q0   Q2.. Q7]   [Q0.. Q7]
Микросхема по счёту:   [        1        ]   [     2      ]   [   3   ]

Пример выполнения кода:

  reg.write(0, 1);
  reg.write(1, 1);
  reg.set(2);
  reg.set(8);
  reg.update();

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

#include <GyverHC595.h>

GyverHC595<2, HC_SPI, 8000000> reg(10); // аппаратный SPI, кастомная скорость
//GyverHC595<2, HC_PINS> reg(10, 11, 13); // программный SPI (bit bang)

void setup() {
  reg.set(0);       // включить пин 0
  reg.write(8, 1);  // включить пин 8
  reg.write(8, 0);  // выключить пин 8
  
  reg.update();     // обновить
}

void loop() {
}

• v1.0
• v1.1 - улучшена производительность esp8266
• v1.2 - оптимизация, исправлен аппаратный SPI на esp8266, добавлены функции включения/выключения всех ног, инициализация для пустого конструктора

При нахождении багов создавайте Issue, а лучше сразу пишите на почту alex@alexgyver.ru
Библиотека открыта для доработки и ваших Pull Request'ов!

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

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