Merge pull request #67 from Chr157i4n/dev

version 0.5

.github/ISSUE_TEMPLATE/new_board_request.md

@@ -0,0 +1,18 @@
+---
+name: New Board Request
+about: Create a Request if you want a new board supported
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Info about your board**
+
+- the name and a link to you board
+- a library that can be used to control the gpios of your board
+- a info to the serial port of your board
+
+**Board Identification**
+A method to recognize the new board programmatically. ideally with the output of
+`cat /proc/device-tree/model`

.github/workflows/pylint.yml

@@ -18,10 +18,11 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pylint
+        pip install gpiozero
         pip install RPi.GPIO
         pip install Mock.GPIO
         pip install mock
         pip install pyserial
     - name: Analysing the code with pylint
       run: |
-        pylint $(git ls-files '*.py') --disable=C0103 --extension-pkg-whitelist=RPi
+        pylint $(git ls-files '*.py') --disable=C0103 --disable=W0511 --extension-pkg-whitelist=RPi

.github/workflows/unittest.yml

@@ -17,6 +17,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
+        pip install gpiozero
         pip install RPi.GPIO
         pip install Mock.GPIO
         pip install pyserial

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## version 0.5
+
+- decoupled gpio access from gpio library
+- added support for Raspberry Pi5 (gpiozero)
+- added support for Luckfox Pico (python-periphery)
+
 ## version 0.4.5
 
 - enhancement of logging module

README.md

@@ -56,6 +56,24 @@ pip3 install TMC-2209-Raspberry-Pi
     sudo raspi-config
     ```
 
+### Board Support
+
+The following table shows the supported boards and which libraries for GPIO access is beeing used for that board.
+
+Library | Installation Parameter | Boards
+-- | -- | --
+RPi.GPIO | RASPBERRY_PI | Pi4, Pi3 etc.
+gpiozero | RASPBERRY_PI5 | Pi5
+Jetson.GPIO | NVIDIA_JETSON | Nvidia Jetson
+pheriphery | LUCKFOX_PICO | Luckfox Pico
+
+Those libraries are needed for this library to work. You can either install the correct library yourself.
+You can also install the needed GPIO library by specifing the Installation Parameter while installing this library:
+
+```shell
+pip3 install TMC-2209-Raspberry-Pi[RASPBERRY_PI]
+```
+
 ## Wiring
 
 Pin TMC2209 | connect to | Function

demo/debug_script_01_uart_connection.py

@@ -9,8 +9,10 @@
 import time
 try:
     from src.TMC_2209.TMC_2209_StepperDriver import *
+    from src.TMC_2209._TMC_2209_GPIO_board import Board
 except ModuleNotFoundError:
     from TMC_2209.TMC_2209_StepperDriver import *
+    from TMC_2209._TMC_2209_GPIO_board import Board
 
 
 print("---")
@@ -25,9 +27,11 @@
 # initiate the TMC_2209 class
 # use your pins for pin_en, pin_step, pin_dir here
 #-----------------------------------------------------------------------
-if BOARD == "RASPBERRY_PI":
+if BOARD == Board.RASPBERRY_PI:
     tmc = TMC_2209(21, 16, 20, skip_uart_init=True)
-elif BOARD == "NVIDIA_JETSON":
+elif BOARD == Board.RASPBERRY_PI5:
+    tmc = TMC_2209(21, 16, 20, serialport="/dev/ttyAMA0", skip_uart_init=True)
+elif BOARD == Board.NVIDIA_JETSON:
     tmc = TMC_2209(13, 6, 5, serialport="/dev/ttyTHS1", skip_uart_init=True)
 else:
     # just in case

demo/demo_script_01_uart_connection.py

@@ -9,8 +9,10 @@
 import time
 try:
     from src.TMC_2209.TMC_2209_StepperDriver import *
+    from src.TMC_2209._TMC_2209_GPIO_board import Board
 except ModuleNotFoundError:
     from TMC_2209.TMC_2209_StepperDriver import *
+    from TMC_2209._TMC_2209_GPIO_board import Board
 
 
 print("---")
@@ -25,9 +27,11 @@
 # initiate the TMC_2209 class
 # use your pins for pin_en, pin_step, pin_dir here
 #-----------------------------------------------------------------------
-if BOARD == "RASPBERRY_PI":
+if BOARD == Board.RASPBERRY_PI:
     tmc = TMC_2209(21, 16, 20)
-elif BOARD == "NVIDIA_JETSON":
+elif BOARD == Board.RASPBERRY_PI5:
+    tmc = TMC_2209(21, 16, 20, serialport="/dev/ttyAMA0")
+elif BOARD == Board.NVIDIA_JETSON:
     tmc = TMC_2209(13, 6, 5, serialport="/dev/ttyTHS1")
 else:
     # just in case

demo/demo_script_02_pin_connection.py

@@ -9,8 +9,10 @@
 import time
 try:
     from src.TMC_2209.TMC_2209_StepperDriver import *
+    from src.TMC_2209._TMC_2209_GPIO_board import Board
 except ModuleNotFoundError:
     from TMC_2209.TMC_2209_StepperDriver import *
+    from TMC_2209._TMC_2209_GPIO_board import Board
 
 
 print("---")
@@ -25,9 +27,11 @@
 # initiate the TMC_2209 class
 # use your pins for pin_en, pin_step, pin_dir here
 #-----------------------------------------------------------------------
-if BOARD == "RASPBERRY_PI":
+if BOARD == Board.RASPBERRY_PI:
     tmc = TMC_2209(21, 16, 20)
-elif BOARD == "NVIDIA_JETSON":
+elif BOARD == Board.RASPBERRY_PI5:
+    tmc = TMC_2209(21, 16, 20, serialport="/dev/ttyAMA0")
+elif BOARD == Board.NVIDIA_JETSON:
     tmc = TMC_2209(13, 6, 5, serialport="/dev/ttyTHS1")
 else:
     # just in case

demo/demo_script_03_basic_movement.py

@@ -9,8 +9,10 @@
 import time
 try:
     from src.TMC_2209.TMC_2209_StepperDriver import *
+    from src.TMC_2209._TMC_2209_GPIO_board import Board
 except ModuleNotFoundError:
     from TMC_2209.TMC_2209_StepperDriver import *
+    from TMC_2209._TMC_2209_GPIO_board import Board
 
 
 print("---")
@@ -25,9 +27,11 @@
 # initiate the TMC_2209 class
 # use your pins for pin_en, pin_step, pin_dir here
 #-----------------------------------------------------------------------
-if BOARD == "RASPBERRY_PI":
+if BOARD == Board.RASPBERRY_PI:
     tmc = TMC_2209(21, 16, 20, loglevel=Loglevel.DEBUG)
-elif BOARD == "NVIDIA_JETSON":
+elif BOARD == Board.RASPBERRY_PI5:
+    tmc = TMC_2209(21, 16, 20, serialport="/dev/ttyAMA0", loglevel=Loglevel.DEBUG)
+elif BOARD == Board.NVIDIA_JETSON:
     tmc = TMC_2209(13, 6, 5, serialport="/dev/ttyTHS1", loglevel=Loglevel.DEBUG)
 else:
     # just in case

demo/demo_script_04_stallguard.py

@@ -9,8 +9,10 @@
 import time
 try:
     from src.TMC_2209.TMC_2209_StepperDriver import *
+    from src.TMC_2209._TMC_2209_GPIO_board import Board
 except ModuleNotFoundError:
     from TMC_2209.TMC_2209_StepperDriver import *
+    from TMC_2209._TMC_2209_GPIO_board import Board
 
 
 print("---")
@@ -25,13 +27,15 @@
 # initiate the TMC_2209 class
 # use your pins for pin_en, pin_step, pin_dir here
 #-----------------------------------------------------------------------
-if BOARD == "NVIDIA_JETSON":
+if BOARD == Board.NVIDIA_JETSON:
     raise NotImplementedError('''
-Not implemented. Needs refinement.\nNvidia Jetson has nuances with the parameter pull_up_down for pin_stallguard:
-https://github.com/NVIDIA/jetson-gpio/issues/5''')
-
-if BOARD == "RASPBERRY_PI":
+        Not implemented. Needs refinement.\n
+        Nvidia Jetson has nuances with the parameter pull_up_down for pin_stallguard:
+        https://github.com/NVIDIA/jetson-gpio/issues/5''')
+if BOARD == Board.RASPBERRY_PI:
     tmc = TMC_2209(21, 16, 20)
+elif BOARD == Board.RASPBERRY_PI5:
+    tmc = TMC_2209(21, 16, 20, serialport="/dev/ttyAMA0")
 else:
     # just in case
     tmc = TMC_2209(21, 16, 20)

demo/demo_script_05_vactual.py

@@ -9,8 +9,10 @@
 import time
 try:
     from src.TMC_2209.TMC_2209_StepperDriver import *
+    from src.TMC_2209._TMC_2209_GPIO_board import Board
 except ModuleNotFoundError:
     from TMC_2209.TMC_2209_StepperDriver import *
+    from TMC_2209._TMC_2209_GPIO_board import Board
 
 
 print("---")
@@ -25,9 +27,11 @@
 # initiate the TMC_2209 class
 # use your pin for pin_en here
 #-----------------------------------------------------------------------
-if BOARD == "RASPBERRY_PI":
+if BOARD == Board.RASPBERRY_PI:
     tmc = TMC_2209(21, 16, 20)
-elif BOARD == "NVIDIA_JETSON":
+elif BOARD == Board.RASPBERRY_PI5:
+    tmc = TMC_2209(21, 16, 20, serialport="/dev/ttyAMA0")
+elif BOARD == Board.NVIDIA_JETSON:
     tmc = TMC_2209(13, 6, 5, serialport="/dev/ttyTHS1")
 else:
     # just in case

demo/demo_script_06_multiple_drivers.py

@@ -3,15 +3,18 @@
 #pylint: disable=unused-import
 #pylint: disable=duplicate-code
 #pylint: disable=broad-exception-raised
+#pylint: disable=no-else-raise
 """
 test file for testing multiple drivers via one UART connection
 """
 
 import time
 try:
     from src.TMC_2209.TMC_2209_StepperDriver import *
+    from src.TMC_2209._TMC_2209_GPIO_board import Board
 except ModuleNotFoundError:
     from TMC_2209.TMC_2209_StepperDriver import *
+    from TMC_2209._TMC_2209_GPIO_board import Board
 
 
 print("---")
@@ -27,10 +30,13 @@
 # use your pins for pin_en, pin_step, pin_dir here
 #-----------------------------------------------------------------------
 # Multiple driver not tested
-if BOARD == "RASPBERRY_PI":
+if BOARD == Board.RASPBERRY_PI:
     tmc1 = TMC_2209(21, 16, 20, driver_address=0)
     tmc2 = TMC_2209(26, 13, 19, driver_address=1)
-elif BOARD == "NVIDIA_JETSON":
+elif BOARD == Board.RASPBERRY_PI5:
+    tmc1 = TMC_2209(21, 16, 20, serialport="/dev/ttyAMA0", driver_address=0)
+    tmc2 = TMC_2209(26, 13, 19, serialport="/dev/ttyAMA0", driver_address=1)
+elif BOARD == Board.NVIDIA_JETSON:
     # tmc1 = TMC_2209(13, 6, 5, serialport="/dev/ttyTHS1", driver_address=0)
     raise Exception("Not tested for Nvidia Jetson, use with caution")
 else:

demo/demo_script_07_threads.py

@@ -9,8 +9,10 @@
 import time
 try:
     from src.TMC_2209.TMC_2209_StepperDriver import *
+    from src.TMC_2209._TMC_2209_GPIO_board import Board
 except ModuleNotFoundError:
     from TMC_2209.TMC_2209_StepperDriver import *
+    from TMC_2209._TMC_2209_GPIO_board import Board
 
 print("---")
 print("SCRIPT START")
@@ -23,9 +25,11 @@
 # initiate the TMC_2209 class
 # use your pins for pin_en, pin_step, pin_dir here
 #-----------------------------------------------------------------------
-if BOARD == "RASPBERRY_PI":
+if BOARD == Board.RASPBERRY_PI:
     tmc1 = TMC_2209(21, 16, 20)
-elif BOARD == "NVIDIA_JETSON":
+elif BOARD == Board.RASPBERRY_PI5:
+    tmc1 = TMC_2209(21, 16, 20, serialport="/dev/ttyAMA0")
+elif BOARD == Board.NVIDIA_JETSON:
     tmc1 = TMC_2209(13, 6, 5, serialport="/dev/ttyTHS1")
 else:
     # just in case

demo/demo_script_08_log_to_file.py

@@ -9,8 +9,10 @@
 import logging
 try:
     from src.TMC_2209.TMC_2209_StepperDriver import *
+    from src.TMC_2209._TMC_2209_GPIO_board import Board
 except ModuleNotFoundError:
     from TMC_2209.TMC_2209_StepperDriver import *
+    from TMC_2209._TMC_2209_GPIO_board import Board
 
 
 
@@ -36,10 +38,13 @@
 # initiate the TMC_2209 class
 # use your pins for pin_en, pin_step, pin_dir here
 #-----------------------------------------------------------------------
-if BOARD == "RASPBERRY_PI":
+if BOARD == Board.RASPBERRY_PI:
     tmc = TMC_2209(21, 16, 20, skip_uart_init=True,
                    loglevel=loglevel, log_handlers=[logging_handler], log_formatter=logformatter)
-elif BOARD == "NVIDIA_JETSON":
+elif BOARD == Board.RASPBERRY_PI5:
+    tmc = TMC_2209(21, 16, 20, serialport="/dev/ttyAMA0", skip_uart_init=True,
+                   loglevel=loglevel, log_handlers=[logging_handler], log_formatter=logformatter)
+elif BOARD == Board.NVIDIA_JETSON:
     tmc = TMC_2209(13, 6, 5, serialport="/dev/ttyTHS1", skip_uart_init=True,
                    loglevel=loglevel, log_handlers=[logging_handler], log_formatter=logformatter)
 else:

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = TMC_2209_Raspberry_Pi
-version = 0.4.5
+version = 0.5
 author = Christian Köhlke
 author_email = christian@koehlke.de
 description = this is a Python libary to drive a stepper motor with a Trinamic TMC2209 stepper driver and a Raspberry Pi
@@ -24,8 +24,17 @@ package_dir =
 packages = find:
 python_requires = >=3.7
 install_requires =
-    RPi.GPIO
     pyserial
 
 [options.packages.find]
-where = src
+where = src
+
+[options.extras_require]
+RASPBERRY_PI =
+    RPi.GPIO
+RASPBERRY_PI5 =
+    gpiozero
+NVIDIA_JETSON =
+    Jetson.GPIO
+LUCKFOX_PICO =
+    python-periphery