Библиотека для шагового двигателя Arduino v1.15

ОБНОВЛЕНИЯ


  • v1.13 – исправлены мелкие баги, оптимизация
  • v1.14 – исправлены ошибки разгона и торможения в KEEP_SPEED
  • v1.15 – оптимизация, исправлены мелкие баги, stop() больше не сбрасывает maxSpeed

ТЕОРИЯ


Для подключения шаговых моторов к Arduino нужно использовать драйверы. Очень дешёвые и популярные моторы 28byj-48-5v часто продаются вместе со своим драйвером (транзисторная сборка ULN2003), подключить можно к любым 4-м пинам Ардуино и использовать.

Для работы с большими шаговиками (типа Nema 17) нужно использовать специализированные драйверы, ниже вы найдёте описания и схемы подключения для A4988, DRV8825 и TMC2208, драйверы такого формата подключаются и работают практически одинаково, т.к. разработаны для CNC шилдов и взаимозаменяемы. У этих драйверов нужно настроить ток при помощи крутилки на плате. Это можно сделать “на глаз”, заставив мотор вращаться и регулируя крутилку. Мотор должен вращаться, но не вибрировать как перфоратор и сильно не нагреваться. Лучше настроить ток по опорному напряжению Vref, у каждого драйвера оно считается по своей формуле (см. картинки ниже). Берём ток своего мотора из описания,  подставляем в формулу вместо current, считаем, и накручиваем полученное напряжение крутилкой. Для измерения опорного напряжения нужно подключить щупы вольтметра к самой крутилке и пину GND.

Главное преимущество дорогущих драйверов TMC – отсутствие шума/свиста/вибраций при работе, так как драйвер своими силами интерполирует сигнал до микрошага 1/256.

БИБЛИОТЕКА


GyverStepper v1.15

Производительная библиотека для управления шаговыми моторами с Arduino

  • Поддержка 4х пинового (шаг и полушаг) и STEP-DIR драйверов
  • Автоматическое отключение питания при достижении цели
  • Режимы работы:
    • Вращение с заданной скоростью. Плавный разгон и торможение с ускорением
    • Следование к позиции с ускорением и ограничением скорости
    • Следование к позиции с заданной скоростью (без ускорения)
  • Быстрый алгоритм управления шагами
  • Два алгоритма плавного движения
    • Мой планировщик обеспечивает максимальную производительность: скорость до 30’000 шагов/сек с ускорением (активен по умолчанию)
    • Модифицированный планировщик из AccelStepper: максимальную плавность и скорость до 7’000 шагов/сек с ускорением (для активации пропиши дефайн SMOOTH_ALGORITHM)
  • Поддержка “виртуальных” драйверов

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

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

УСТАНОВКА


  • Библиотеку можно найти и установить через менеджер библиотек по названию GyverStepper в:
    • Arduino IDE (Инструменты/Управлять библиотеками)
    • Arduino IDE v2 (вкладка “Library Manager”)
    • PlatformIO (PIO Home, вкладка “Libraries”)
  • Про ручную установку читай здесь

ДОКУМЕНТАЦИЯ


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


Библиотека поддерживает два типа драйверов:
  • STEPPER2WIRE - специализированный 2-х проводной драйвер для шагового мотора с протоколом STEP-DIR, например A4988, DRV8825, TMC2208 и прочие.
  • STEPPER4WIRE и STEPPER4WIRE_HALF - 4-х проводной драйвер, т.е. полномостовой (например L298N) или транзисторная сборка (например ULN2003).
    • STEPPER4WIRE управляет мотором в полношаговом режиме (выше скорость и момент).
    • STEPPER4WIRE_HALF - в полушаговом (меньше скорость и момент, но больше шагов на оборот и выше точность).
При инициализации указывается тип драйвера, количество шагов на оборот и пины:
  • GStepper< STEPPER2WIRE> stepper(steps, step, dir); // драйвер step-dir
  • GStepper< STEPPER2WIRE> stepper(steps, step, dir, en); // драйвер step-dir + пин enable
  • GStepper< STEPPER4WIRE> stepper(steps, a1, a2, b1, b2); // драйвер 4 пин
  • GStepper< STEPPER4WIRE> stepper(steps, a1, a2, b1, b2, en); // драйвер 4 пин + enable
  • GStepper< STEPPER4WIRE_HALF> stepper(steps, a1, a2, b1, b2); // драйвер 4 пин полушаг
  • GStepper< STEPPER4WIRE_HALF> stepper(steps, a1, a2, b1, b2, en); // драйвер 4 пин полушаг + enable
Где steps - количество шагов на один оборот вала для расчётов с градусами, step, dir, a1, a2, b1, b2 - любые GPIO на МК, en - пин отключения драйвера EN, любой GPIO на МК. Пин en опциональный, можно не указывать. Для 4-х пиновых драйверов: a1 и a2 - первая обмотка (первая фаза), b1 и b2 - вторая обмотка (вторая фаза). При использовании мотора 28byj-48 с родным драйвером нужно поменять крайние пины местами (например, подключаем D2-IN1, D3-IN2, D4-IN3, D5-IN4, но в программе меняем 5 и 2: stepper(2048, 5, 3, 4, 2);, потому что на драйвере фазы выведены через одну, вот картинка). При подключении через мостовой драйвер - подключать и указывать пины по порядку выхода фаз из мотора (см. последнюю схему выше). Количество шагов на оборот нужно для работы функций, которые устанавливают или читают параметр в градусах. Если они не нужны - количество шагов можно поставить любое (единичку). Если нужно - количество шагов нужно указывать с учётом редукторов и микрошагов:
  • Пример 1: есть мотор NEMA 17, он имеет 200 полных шагов на оборот (по документации). Подключен через драйвер с настроенным микрошагом 1/16. При создании объекта библиотеки нужно указать 200*16 шагов.
  • Пример 2: есть мотор 28byj-48-5v, имеет 32 полных шага на оборот и редуктор с соотношением 63.68395:1. Подключен через микросхему ULN2003. Итоговое количество шагов на оборот составляет 63.68395*32 == 2038 для режима полного шага (STEPPER4WIRE).
  • Пример 3: подключим тот же самый мотор 28byj-48-5v, но в режиме полушага (STEPPER4WIRE_HALF). Количество шагов на оборот удвоится (32*2 == 64) и, с учётом редуктора, станет равным 4076.

Время шага [NEW!]


Для драйверов STEP-DIR сделана задержка между переключением состояния пина STEP, эта задержка является минимальной, т.е. она может быть больше, чем нужно, но если будет меньше - возможна нестабильная работа драйвера. По умолчанию она составляет 4 микросекунды, но разным драйверам она нужна разная (для других драйверов см. даташит):
  • A4988 - 1 мкс
  • DRV8825 - 4 мкс
  • TB6500 - 1 мкс
Также увеличение задержки может повысить стабильность работы при использовании длинных неэкранированных проводов от микроконтроллера к драйверу (к пину STEP). Для изменения величины задержки сделай дефайн DRIVER_STEP_TIME перед подключением библиотеки:
#define DRIVER_STEP_TIME 10  // меняем задержку на 10 мкс
#include "GyverStepper.h"

Медленные скорости (new!)


В версии 1.6 скорость во всех режимах может быть задана в виде десятичной дроби (тип float), то есть меньше одного шага в секунду. Минимальная скорость ограничена разрешением используемой в библиотеке micros() и составляет 1 шаг в час. Для удобного задания медленных скоростей появились макросы degPerMinute() и degPerHour(), которые нужно использовать совместно с setSpeedDeg() и setMaxSpeedDeg():
stepper.setMaxSpeedDeg(degPerMinute(360));  // скорость 360 градусов в минуту для режима FOLLOW_POS

Тик и тайминги


Самый главный метод библиотеки - tick(), при активной работе мотора его нужно вызывать как можно чаще. Тик имеет встроенный таймер на micros() и работает по нему. Если в коде программы присутствуют задержки на большее время, чем нужно мотору на текущей скорости, скорость мотора будет ограничена этой задержкой. Узнать минимальный период вызова tick() (при установленной скорости) можно при помощи getMinPeriod(), который вернёт его в микросекундах. Также можно напрямую опрашивать переменную stepTime, в которой хранится текущий период. Эти инструменты можно использовать для организации работы шаговика в прерывании таймера (см. пример timerISR). Также .tick() возвращает true, если мотор движется к цели или крутится по KEEP_SPEED и false, если мотор остановлен или приехал. Метод getState() возвращает текущее состояние мотора аналогично tick().

Смена направления


Можно глобально (для всех режимов) сменить направление вращения мотора при помощи reverse(true).

Режимы работы


Библиотека имеет два режима работы с мотором, устанавливается при помощи setRunMode(mode), где mode:
  • FOLLOW_POS - режим плавного движения к заданной позиции с ускорением и ограничением скорости.
  • KEEP_SPEED - режим вращения с заданной скоростью (знак скорости задаёт направление вращения).

Режим FOLLOW_POS


В этом режиме мотор следует на указанную позицию в шагах или градусах. Для её установки есть следующие методы:
  • setTarget(pos) - установка абсолютной целевой позиции в шагах, принимает положительные и отрицательные значения (тип данных long).
  • setTarget(pos, type) - то же самое, но можно указать тип позиции type - абсолютная ABSOLUTE или относительная RELATIVE.
  • setTargetDeg(pos) - установка абсолютной целевой позиции в градусах, принимает положительные и отрицательные дробные значения (тип данных float).
  • setTargetDeg(pos, type) - то же самое, но можно указать тип позиции type - абсолютная ABSOLUTE или относительная RELATIVE.
Примечание: абсолютная позиция - говоришь мотору повернуться на 300 шагов, он повернётся на позицию 300. При повторном вызове  ничего не произойдёт. Относительная - говоришь повернуться на 300 - он повернётся на 300 относительно текущей позиции. Если вызвать ещё раз через некоторое время - цель сместится относительно текущей позиции вала. Установленную целевую позицию можно прочитать:
  • getTarget() - возвращает тип данных long
  • getTargetDeg() - возвращает тип данных float
Дополнительно можно настроить максимальную скорость и ускорение при движении к целевой позиции:
  • setMaxSpeed(speed) - установка максимальной скорости по модулю в шагах/секунду, тип данных float. По умолчанию 300.
  • setMaxSpeedDeg(speed) - установка максимальной скорости по модулю в градусах/секунду, тип данных float.
  • setAcceleration(accel) - установка ускорения по модулю в шагах/сек/сек, тип данных float. По умолчанию 300.
  • setAccelerationDeg(accel) - установка ускорения по модулю в градусах/сек/сек, тип данных float.
Примечание: при установке ускорения в ноль 0 мотор будет двигаться к позиции с максимальной скоростью, заданной в setMaxSpeed(). Также можно вручную установить текущую позицию мотора в шагах и градусах при помощи:
  • setCurrent(long pos);
  • setCurrentDeg(float pos);
И прочитать её:
  • getCurrent();
  • getCurrentDeg();

Режим KEEP_SPEED


В этом режиме мотор просто крутится с заданной скоростью. Скорость задаётся при помощи
  • setSpeed(speed) - в шагах/секунду, положительные и отрицательные целые значения, тип данных float.
  • setSpeedDeg(speed) - в градусах/секунду, положительные и отрицательные дробные значения, тип данных float.
(New!) Вторым аргументом можно передать включение плавного изменения скорости, по умолчанию стоит false (NO_SMOOTH). Смотри пример accelDeccelButton
  • setSpeed(speed, smooth) - в шагах/секунду, положительные и отрицательные целые значения, тип данных float. smooth - SMOOTH или NO_SMOOTH
  • setSpeedDeg(speed, smooth) - в градусах/секунду, положительные и отрицательные дробные значения, тип данных float. smooth - SMOOTH или NO_SMOOTH
Установленную скорость можно прочитать:
  • getSpeed() - возвращает тип данных float
  • getSpeedDeg() - возвращает тип данных float

Алгоритм планировщика скорости


В библиотеке реализовано два алгоритма планирования скорости для режима плавного движения к позиции с ненулевым ускорением:
  • Мой алгоритм: скорость планируется с фиксированным периодом, что сильно разгружает процессор и позволяет работать на скоростях до 30'000 шагов в секунду (полностью загрузив процессор) без наличия посторонних задержек в коде. Сильная экономия процессорного времени оставляет возможность спокойно выполнять параллельно другой код и управлять несколькими моторами в разных режимах на хороших скоростях, и "ещё останется". Немного "резковат" при торможении. Активен по умолчанию.
  • Модифицированный алгоритм из библиотеки AccelStepper: скорость планируется каждый шаг, что очень сильно нагружает процессор и ограничивает скорость до 7'000 шагов в секунду (полностью загрузив процессор) без наличия посторонних задержек в коде (в оригинальной библиотеке - 5'000 шагов/сек). Разгоняется и тормозит максимально плавно. Для активации нужно прописать дефайн #define SMOOTH_ALGORITHM перед подключением библиотеки в коде (см. пример smoothAlgorithm) или раскомментировать данный дефайн в файле библиотеки GyverStepper.h, находится сразу после описания.

Остановка и сброс


  • stop() - плавная остановка с заданным в setAcceleration() ускорением от текущего положения мотора. Можно вызвать в режиме KEEP_SPEED для плавной остановки вращения! Смотри пример accelDeccelButton
  • brake() - резкая остановка мотора. Если активен autoPower(true) - мотор будет отключен.
  • reset() - brake() + сброс текущей позиции в 0. Удобно для остановки и калибровки начала координат по концевику (смотри пример endSwitch).

Управление питанием


Питанием мотора/драйвера можно управлять вручную при помощи enable() и disable(). Данные методы включают и выключают пин Enable (если он указан при инициализации), а также снимают и возвращают питание на управляющие выводы (для 4х пинового драйвера). Поведением пина EN (если он указан при инициализации) можно управлять при помощи invertEn(true) и invertEn(false). По умолчанию установлено enable(false) переводит пин en в низкое состояние. В библиотеке реализовано автоматическое управление питанием, включается при помощи autoPower(true), по умолчанию оно отключено. В режиме FOLLOW_POS при достижении целевой позиции мотор будет автоматически отключен (будет вызван disable()). При дальнейшей установке новой позиции мотор будет автоматически включен (будет вызван enable()).
// Примечание: далее по тексту под "по умолчанию" имеется в виду "даже если не вызывать функцию"

// Здесь происходит движение мотора, вызывать как можно чаще!
// Имеет встроенный таймер
// Возвращает true, если мотор движется к цели или крутится по KEEP_SPEED
bool tick();

// Возвращает то же самое, что tick, т.е. крутится мотор или нет
bool getState();

// Инвертировать направление мотора - true (по умолч. false)
void reverse(bool dir);

// инвертировать поведение EN пина - true (по умолч. false)
void invertEn(bool rev);

// Установка режима работы, mode:
// FOLLOW_POS - следование к позиции setTarget(...)
// KEEP_SPEED - удержание скорости setSpeed(...)
void setRunMode(GS_runMode mode);

// Установка текущей позиции мотора в шагах и градусах
void setCurrent(long pos);
void setCurrentDeg(float pos);

// Чтение текущей позиции мотора в шагах и градусах
long getCurrent();
float getCurrentDeg();

// установка целевой позиции в шагах и градусах (для режима FOLLOW_POS)
// type - ABSOLUTE или RELATIVE, по умолчанию стоит ABSOLUTE
void setTarget(long pos);
void setTarget(long pos, GS_posType type);
void setTargetDeg(float pos);
void setTargetDeg(float pos, GS_posType type);

// Получение целевой позиции в шагах и градусах
long getTarget();
float getTargetDeg();

// Установка максимальной скорости (по модулю) в шагах/секунду и градусах/секунду (для режима FOLLOW_POS)
// по умолч. 300
void setMaxSpeed(float speed);
void setMaxSpeedDeg(float speed);

// Установка ускорения в шагах и градусах в секунду (для режима FOLLOW_POS).
// При значении 0 ускорение отключается и мотор работает 
// по профилю постоянной максимальной скорости setMaxSpeed().
// По умолч. 300
void setAcceleration(int accel);
void setAccelerationDeg(float accel);

// Автоотключение EN при достижении позиции - true (по умолч. false)
void autoPower(bool mode);

// Плавная остановка с заданным ускорением
void stop();

// Жёсткая остановка
void brake();

// Жёсткая остановка + сброс позиции в 0 (для концевиков)
void reset();

// Установка целевой скорости в шагах/секунду и градусах/секунду (для режима KEEP_SPEED)
void setSpeed(float speed);
void setSpeedDeg(float speed);

// Получение целевой скорости в шагах/секунду и градусах/секунду (для режима KEEP_SPEED)
float getSpeed();
float getSpeedDeg();

// Включить мотор (пин EN)
void enable();

// Выключить мотор (пин EN)
void disable();

// Возвращает минимальный период тика мотора в микросекундах при настроенной setMaxSpeed() скорости.
// Можно использовать для настройки прерываний таймера, в обработчике которого будет лежать tick() (см. пример timerISR)
uint16_t getMinPeriod();

// Текущий период "тика" для отладки и всего такого
uint16_t stepTime;

ПРИМЕРЫ


Остальные примеры смотри в папке examples библиотеки, также примеры можно открыть из Arduino IDE/Файл/Примеры

// демо - основные возможности библиотеки

#include 
GStepper stepper(2048, 5, 3, 4, 2);
// мотор с драйвером ULN2003 подключается по порядку пинов, но крайние нужно поменять местами
// то есть у меня подключено D2-IN1, D3-IN2, D4-IN3, D5-IN4, но в программе поменял 5 и 2

// создание объекта
// steps - шагов на один оборот вала (для расчётов с градусами)
// step, dir, pin1, pin2, pin3, pin4 - любые GPIO
// en - пин отключения драйвера, любой GPIO
//GStepper stepper(steps, step, dir);                   // драйвер step-dir
//GStepper stepper(steps, step, dir, en);               // драйвер step-dir + пин enable
//GStepper stepper(steps, pin1, pin2, pin3, pin4);      // драйвер 4 пин
//GStepper stepper(steps, pin1, pin2, pin3, pin4, en);  // драйвер 4 пин + enable
//GStepper stepper(steps, pin1, pin2, pin3, pin4);     // драйвер 4 пин полушаг
//GStepper stepper(steps, pin1, pin2, pin3, pin4, en); // драйвер 4 пин полушаг + enable

void setup() {
  Serial.begin(115200);
  // режим поддержания скорости
  stepper.setRunMode(KEEP_SPEED);

  // можно установить скорость
  stepper.setSpeed(120);    // в шагах/сек
  stepper.setSpeedDeg(80);  // в градусах/сек

  // режим следования к целевй позиции
  stepper.setRunMode(FOLLOW_POS);

  // можно установить позицию
  stepper.setTarget(-2024);    // в шагах
  stepper.setTargetDeg(-360);  // в градусах

  // установка макс. скорости в градусах/сек
  stepper.setMaxSpeedDeg(400);
  
  // установка макс. скорости в шагах/сек
  stepper.setMaxSpeed(400);

  // установка ускорения в градусах/сек/сек
  stepper.setAccelerationDeg(300);

  // установка ускорения в шагах/сек/сек
  stepper.setAcceleration(300);

  // отключать мотор при достижении цели
  stepper.autoPower(true);

  // включить мотор (если указан пин en)
  stepper.enable();
}

void loop() {
  // просто крутим туды-сюды
  if (!stepper.tick()) {
    static bool dir;
    dir = !dir;
    stepper.setTarget(dir ? -1024 : 1024);
  }
}
// пример с использованием "внешнего" драйвера, который может быть
// подключен к расширителю портов.

// в качестве примера использую digitalWrite и родные пины
#define PIN_A 2
#define PIN_B 4
#define PIN_C 3
#define PIN_D 5

#include 
GStepper stepper(2048);

void setup() {
  Serial.begin(9600);
  // выходы
  pinMode(PIN_A, 1);
  pinMode(PIN_B, 1);
  pinMode(PIN_C, 1);
  pinMode(PIN_D, 1);
  
  stepper.setRunMode(KEEP_SPEED); // режим поддержания скорости
  stepper.setSpeedDeg(100);       // в градусах/сек
  stepper.setAcceleration(500);

  // подключить свою функцию-обработчик шага
  stepper.attachStep(step);
  
  // подключить свою функцию-обработчик для управления питанием
  stepper.attachPower(pwr);

  stepper.autoPower(1);   // включаем авто выкл питания
}

// наша функция-обработчик. Будет вызываться на каждом шагу
// у STEPPER4WIRE val содержит состояния обмоток как 0bABCD
// у STEPPER2WIRE val содержит 0 или 1 как DIR, STEP нужно дёрнуть самому
void step(byte val) {
  // дёргаем вручную пины
  digitalWrite(PIN_D, val & 1);
  val >>= 1;
  digitalWrite(PIN_C, val & 1);
  val >>= 1;
  digitalWrite(PIN_B, val & 1);
  val >>= 1;
  digitalWrite(PIN_A, val & 1);
}

void pwr(bool val) {
  // тут val будет 0 или 1 в зависимости от питания. Подавай на EN
  Serial.println(val);
}

void loop() {
  stepper.tick();

  // разгон и остановка каждые 3 секунды
  static uint32_t tmr;
  if (millis() - tmr >= 3000) {
    tmr = millis();
    static bool dir = 1;
    dir = !dir;
    if (!dir) stepper.stop();
    else stepper.setSpeedDeg(100);
  }
}
// крутим мотор туда-сюда плавно с ускорением

#include 
GStepper stepper(2048, 5, 3, 4, 2);
// мотор с драйвером ULN2003 подключается по порядку пинов, но крайние нужно поменять местами
// то есть у меня подключено D2-IN1, D3-IN2, D4-IN3, D5-IN4, но в программе поменял 5 и 2

void setup() {
  Serial.begin(115200);

  // режим следования к целевй позиции
  stepper.setRunMode(FOLLOW_POS);

  // установка макс. скорости в шагах/сек
  stepper.setMaxSpeed(400);

  // установка ускорения в шагах/сек/сек
  stepper.setAcceleration(500);
}

void loop() {
  // просто крутим туды-сюды
  if (!stepper.tick()) {
    static bool dir;
    dir = !dir;
    stepper.setTarget(dir ? -400 : 400);
  }

  // график положения
  static uint32_t tmr2;
  if (millis() - tmr2 > 20) {
    tmr2 = millis();
    Serial.println(stepper.getCurrent());
  }
}
// управляем скоростью из СОМ порта
// отправь q для тормоза
// отправь w для плавной остановки
// отправь e для скорости 5 град/сек
// отправь r для скорости 100 град/сек

#include 
GStepper stepper(2048, 5, 3, 4, 2);

void setup() {
  Serial.begin(9600);
  stepper.setRunMode(KEEP_SPEED); // режим поддержания скорости
  stepper.setSpeedDeg(5);         // в градусах/сек
}

void loop() {
  stepper.tick();
  if (Serial.available()) {
    char ch = Serial.read();
    if (ch == 'q') stepper.brake();
    if (ch == 'w') stepper.stop();
    if (ch == 'e') stepper.setSpeedDeg(5);
    if (ch == 'r') stepper.setSpeedDeg(100);
  }
}
// крутим мотор туда-сюда плавно с ускорением

#include "GyverStepper.h"
// подключим три мотора
// у первого и второго управление EN не подключаем
GStepper stepper1(100, 2, 3);
GStepper stepper2(100, 4, 5);
GStepper stepper3(100, 6, 7, 8);

void setup() {
  // мотор 1 просто вращается
  stepper1.setRunMode(KEEP_SPEED);
  stepper1.setSpeed(300);

  // мотор 2 будет делать sweep по проверке tick
  stepper2.setRunMode(FOLLOW_POS);
  stepper2.setMaxSpeed(1000);
  stepper2.setAcceleration(300);

  // мотор 3 будет перемещаться на случайную позицию
  stepper3.setRunMode(FOLLOW_POS);
  stepper3.setMaxSpeed(1000);
  stepper3.setAcceleration(300);
  stepper3.autoPower(true);
  stepper3.enable();
}

void loop() {
  // первый мотор
  stepper1.tick();
  
  // второй крутим туды-сюды (-1000, 1000)
  if (!stepper2.tick()) {
    static bool dir;
    dir = !dir;
    stepper2.setTarget(dir ? -1000 : 1000);
  }

  // третий по таймеру
  // будет отключаться при остановке
  stepper3.tick();
  static uint32_t tmr;
  if (millis() - tmr > 5000) {   // каждые 5 секунд
    tmr = millis();
    stepper3.setTarget(random(0, 2000));  // рандом 0-2000
  }
}

ПОДДЕРЖАТЬ


Вы можете поддержать меня за создание доступных проектов с открытым исходным кодом, полный список реквизитов есть вот здесь.

guest
2 комментариев
Старые
Новые Популярные
Межтекстовые Отзывы
Посмотреть все комментарии