0.1.0 DRV8825

Author: RobTillaart

libraries/DRV8825/.arduino-ci.yml

@@ -0,0 +1,11 @@
+compile:
+  # Choosing to run compilation tests on 2 different Arduino platforms
+  platforms:
+    - uno
+    # - due
+    # - zero
+    # - leonardo
+    - m4
+    - esp32
+    - esp8266
+    # - mega2560

libraries/DRV8825/.github/workflows/arduino-lint.yml

@@ -0,0 +1,13 @@
+
+name: Arduino-lint
+
+on: [push, pull_request]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: arduino/arduino-lint-action@v1
+        with:
+          library-manager: update
+          compliance: strict

libraries/DRV8825/.github/workflows/arduino_test_runner.yml

@@ -0,0 +1,17 @@
+---
+name: Arduino CI
+
+on: [push, pull_request]
+
+jobs:
+  runTest:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - run: |
+          gem install arduino_ci
+          arduino_ci.rb

libraries/DRV8825/.github/workflows/jsoncheck.yml

@@ -0,0 +1,18 @@
+name: JSON check
+
+on:
+  push:
+    paths:
+      - '**.json'
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: json-syntax-check
+        uses: limitusus/json-syntax-check@v1
+        with:
+          pattern: "\\.json$"
+

libraries/DRV8825/DRV8825.cpp

@@ -0,0 +1,104 @@
+//
+//    FILE: DRV8825.cpp
+//  AUTHOR: Rob Tillaart
+// VERSION: 0.1.0
+// PURPOSE: Arduino library for DRV8825 stepper motor driver
+//    DATE: 2022-07-07
+//     URL: https://github.com/RobTillaart/DRV8825
+
+//  0.1.0   2022-07-07  initial version.
+
+
+#include "DRV8825.h"
+
+
+DRV8825::DRV8825()
+{
+}
+
+
+bool DRV8825::begin(uint8_t dirPin, uint8_t stepPin)
+{
+  _directionPin = dirPin;
+  _stepPin      = stepPin;
+  pinMode(_directionPin, OUTPUT);
+  pinMode(_stepPin, OUTPUT);
+  
+  digitalWrite(_directionPin, LOW);  // TODO check
+  digitalWrite(_stepPin, LOW);       // TODO check
+  return true;
+}
+
+
+void DRV8825::setStepsPerRotation(uint16_t stepsPerRotation)
+{
+  _stepsPerRotation = stepsPerRotation;
+}
+
+
+uint16_t DRV8825::getStepsPerRotation()
+{
+  return _stepsPerRotation;
+}
+
+
+bool DRV8825::setDirection(uint8_t direction)
+{
+  if (direction > 1) return false;
+  _direction = direction;
+  digitalWrite(_directionPin, _direction);
+  delayMicroseconds(_us);
+  return true;
+}
+
+
+uint8_t DRV8825::getDirection()
+{
+  return digitalRead(_directionPin);
+}
+
+
+void DRV8825::step()
+{
+  digitalWrite(_stepPin, HIGH);
+  delayMicroseconds(_us);
+  digitalWrite(_stepPin, LOW);
+  delayMicroseconds(_us);
+
+  if (_stepsPerRotation > 0)
+  {
+    if (_direction == DRV8825_CLOCK_WISE) _steps++;
+    else _steps--;
+  }
+}
+
+
+int32_t DRV8825::resetSteps(int32_t s)
+{
+  int32_t t = _steps;
+  _steps = s;
+  return t;
+}
+
+
+int32_t DRV8825::getSteps()
+{
+  return _steps;
+}
+  
+  
+void DRV8825::setStepPulseLength(uint16_t us)
+{
+  _us = us;
+}
+
+
+uint16_t DRV8825::getStepPulseLength()
+{
+  return _us;
+}
+
+
+//  -- END OF FILE --
+
+

libraries/DRV8825/DRV8825.h

@@ -0,0 +1,62 @@
+#pragma once
+//
+//    FILE: DRV8825.h
+//  AUTHOR: Rob Tillaart
+// VERSION: 0.1.0
+// PURPOSE: Arduino library for DRV8825 stepper motor driver
+//    DATE: 2022-07-07
+//     URL: https://github.com/RobTillaart/DRV8825
+
+
+#include "Arduino.h"
+
+
+#define DRV8825_LIB_VERSION              (F("0.1.0"))
+
+
+//  setDirection
+const uint8_t DRV8825_CLOCK_WISE         = 0;  //  LOW
+const uint8_t DRV8825_COUNTERCLOCK_WISE  = 1;  //  HIGH
+
+
+class DRV8825
+{
+public:
+  DRV8825();
+
+  bool     begin(uint8_t dirPin, uint8_t stepPin);
+
+  //       DIRECTION
+  //       0 = DRV8825_CLOCK_WISE
+  //       1 = DRV8825_COUNTERCLOCK_WISE
+  //       returns false if parameter out of range.
+  bool     setDirection(uint8_t direction = DRV8825_CLOCK_WISE);
+  uint8_t  getDirection();
+
+  //       STEPS
+  void     setStepsPerRotation(uint16_t stepsPerRotation);
+  uint16_t getStepsPerRotation();
+  void     step();
+  int32_t  resetSteps(int32_t s = 0 );
+  int32_t  getSteps();
+
+  //       CONFIGURATION
+  //       step pulse length is in microseconds
+  //       default 1.9 us
+  void     setStepPulseLength(uint16_t us = 2);
+  uint16_t getStepPulseLength();
+
+
+private:
+  uint16_t _stepsPerRotation = 0;
+  uint8_t  _directionPin     = 255;
+  uint8_t  _stepPin          = 255;
+  uint8_t  _direction        = DRV8825_CLOCK_WISE;
+  int32_t  _steps            = 0;
+  uint16_t _us               = 2;
+};
+
+
+//  -- END OF FILE --
+
+

libraries/DRV8825/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-2022 Rob Tillaart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

libraries/DRV8825/README.md

@@ -0,0 +1,112 @@
+
+[![Arduino CI](https://github.com/RobTillaart/DRV8825/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
+[![Arduino-lint](https://github.com/RobTillaart/DRV8825/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/DRV8825/actions/workflows/arduino-lint.yml)
+[![JSON check](https://github.com/RobTillaart/DRV8825/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/DRV8825/actions/workflows/jsoncheck.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/DRV8825/blob/master/LICENSE)
+[![GitHub release](https://img.shields.io/github/release/RobTillaart/DRV8825.svg?maxAge=3600)](https://github.com/RobTillaart/DRV8825/releases)
+
+
+# DRV8825
+
+Arduino library for DRV8825 stepper motor driver.
+
+
+## Description
+
+**DRV8825** is a library for DRV8825 stepper motor driver.
+
+**Warning: experimental**
+
+The 8825 stepper motor driver control a stepper motor with
+a direction signal and a step pulse. 
+
+
+## Hardware connection
+
+See datasheet.
+
+
+## Interface
+
+
+### Constants
+
+```cpp
+//  setDirection
+const uint8_t DRV8825_CLOCK_WISE         = 0;  //  LOW
+const uint8_t DRV8825_COUNTERCLOCK_WISE  = 1;  //  HIGH
+```
+
+### Constructor
+
+- **DRV8825()** Constructor.
+
+ with steps per rotation as parameter.
+This parameter is optional and if set to zero, steps will not be counted.
+- **bool begin(uint8_t dirPin, uint8_t stepPin)** set the direction and step pin.
+Both pins are initially set to LOW.
+
+
+### Direction
+
+To define in which way the motor will turn.
+
+- **void setDirection(uint8_t direction = DRV8825_CLOCK_WISE)** idem.
+- **uint8_t getDirection()** returns DRV8825_CLOCK_WISE (0) or
+DRV8825_COUNTERCLOCK_WISE (1).
+
+
+### Steps
+
+- **void setStepsPerRotation(uint16_t stepsPerRotation)** specifies the steps per rotation for the specific stepper motor. 
+If set to zero, the steps will not be counted.
+- **uint16_t getStepsPerRotation()** returns the value set before
+or zero default.
+- **void step()** The workhorse, will give a pulse on the STEP pin.
+- **int32_t resetSteps(int32_t s = 0; )** 
+- **int32_t getSteps()** returns the sum of the steps made. 
+CW = + and CWW = - so one can go back to a relative position.
+
+The combination getSteps with stepsPerRotation indicates the position of the motor.
+
+
+## Operational
+
+The base functions are:
+
+```cpp
+DRV8825 stpr;
+
+void setup()
+{
+  Serial.begin(115200);
+  ...
+  stpr.begin(4, 5);  // direction + step pin
+  stpr.setDirection(DRV8825_CLOCK_WISE);
+  ...
+}
+
+void loop()
+{
+...
+  stpr.step;
+...
+}
+```
+
+See examples.
+
+
+## Future
+
+Ideas are kept here so they won't get lost.
+
+- redo interface
+  - stepCW() + stepCCW();  or just CW(); and CCW();
+  - left() + right();
+  - step(nr of steps)  blocking!!
+- add position
+  - = steps % steps/rotation
+- base class DIRSTEP
+  - 8825 as derived?
+  - other too