Sterowanie silnikiem krokowym bipolarnym przez Pololu Tic T249 z obsługą wyłączników krańcowych i procedury homing
Project description
Pololu Tic T249 - Stepper Motor Controller
Kompletne rozwiązanie do sterowania silnikiem krokowym bipolarnym przez Pololu Tic T249 (TB67S249FTG) z pełną obsługą wyłączników krańcowych (limit switches), procedurą homing, oraz nowoczesnym panelem web.
Funkcje
- Panel Web - Intuicyjny interfejs w przeglądarce (Flask)
- Wybór urządzenia USB - Auto-detekcja i ręczny wybór portu USB
- Konfiguracja .env - Łatwa konfiguracja przez zmienne środowiskowe
- Docker - Pełne wsparcie dla Docker i docker-compose
- Testy E2E - Automatyczne testy Playwright
- CLI - Pełna obsługa z linii komend
- Homing - Automatyczne zerowanie pozycji
- Krańcówki - Obsługa sprzętowa (Tic) i programowa (GPIO)
Szybki start
Instalacja (automatyczna)
Wspierane systemy: Debian/Ubuntu/Raspberry Pi OS, Fedora, RHEL/CentOS
# Klonowanie repo
git clone https://github.com/maskservice/rpi-motor-tic249.git
cd rpi-motor-tic249
# Instalacja (z sudo dla udev rules)
sudo make install
# Lub bez sudo (tylko zależności Python)
make install
Instalacja na Fedorze/RHEL
Na systemach Fedora lub RHEL/CentOS używane są pakiety dnf/yum zamiast apt-get:
# Instalacja zależności systemowych na Fedora
sudo dnf install -y libusbx-devel python3-pip python3-virtualenv git
# Na RHEL 8+ / CentOS Stream
sudo dnf install -y libusbx-devel python3-pip python3-virtualenv git
# Na RHEL 7 / CentOS 7
sudo yum install -y libusbx-devel python3-pip python3-virtualenv git
# Następnie standardowa instalacja
make install
Uruchomienie panelu web
# Lokalnie
make web
# W Dockerze
docker-compose up -d
Panel dostępny pod adresem: http://localhost:5000
Tryby obsługi krańcówek
1. Tryb tic — sprzętowy (zalecany)
Wyłączniki podłączone bezpośrednio do pinów Tic T249 (SCL, SDA, TX, RX lub RC). Konfiguracja pinów w Tic Control Center → Advanced → Pin configuration. Wymaga firmware ≥1.06.
Tic automatycznie blokuje ruch w kierunku aktywnego wyłącznika i obsługuje sprzętową procedurę homing (go_home → jedzie do krańcówki → cofa → pozycja = 0).
Tic T249 Pin TX ─── Limit Switch Forward ─── GND
Tic T249 Pin RX ─── Limit Switch Reverse ─── GND
2. Tryb gpio — programowy (Raspberry Pi)
Wyłączniki podłączone do dowolnych pinów GPIO, monitorowane z przerwaniami. Natychmiastowe zatrzymanie silnika (emergency stop) przy aktywacji krańcówki w kierunku ruchu.
RPi GPIO 17 ─── Limit Switch Forward ─── GND (pull-up wewnętrzny)
RPi GPIO 27 ─── Limit Switch Reverse ─── GND (pull-up wewnętrzny)
Wymaga gpiozero lub RPi.GPIO:
pip install gpiozero
Instalacja
sudo apt-get install libusb-1.0-0-dev
pip install -r requirements.txt
# Reguła udev
echo 'SUBSYSTEM=="usb", ATTR{idVendor}=="1ffb", MODE="0666"' | \
sudo tee /etc/udev/rules.d/99-pololu-tic.rules
sudo udevadm control --reload-rules
Użycie — Web Panel
Panel web - funkcje
- Wybór urządzenia USB - Lista wykrytych urządzeń Pololu z możliwością wyboru
- Status w czasie rzeczywistym - Pozycja, prędkość, stan krańcówek (odświeżanie 2x/s)
- Sterowanie - Homing, jog, ruch do pozycji, zasilanie silnika
- Skróty klawiszowe - ← → (jog), Spacja (stop), H (homing)
Konfiguracja przez .env
# Kopiowanie przykładowej konfiguracji
cp .env.example .env
# Edycja ustawień
nano .env
Przykładowa konfiguracja .env:
# Flask
FLASK_HOST=0.0.0.0
FLASK_PORT=5000
# USB - auto-detect gdy puste, lub konkretne wartości
USB_VENDOR_ID=0x1ffb
USB_PRODUCT_ID=0x00c9
# Motor
DEFAULT_MAX_SPEED=2000000
DEFAULT_CURRENT_LIMIT_MA=1000
Docker (zalecane na Fedora i innych systemach)
Docker działa niezależnie od dystrybucji Linux i jest najprostszą metodą uruchomienia projektu na Fedorze, RHEL i innych systemach bez potrzeby instalowania zależności systemowych.
Wymagania
# Fedora - instalacja Docker
sudo dnf install -y docker docker-compose
sudo systemctl start docker
sudo systemctl enable docker
sudo usermod -aG docker $USER
# Wyloguj się i zaloguj ponownie, aby grupa docker zadziałała
Szybki start z Docker
# Uruchomienie pełnego stacku w Docker (alias: make web-docker)
make docker-up
# Lub bezpośrednio
make web-docker
Serwisy dostępne pod:
- Frontend: http://localhost:3000
- Backend API: http://localhost:8000
- MQTT: localhost:1883
Zarządzanie Docker
# Zatrzymanie stacku
make docker-down
# Podgląd logów
make docker-logs
# Rebuild obrazów
make docker-build
Makefile - komendy
Wspierane systemy: Debian/Ubuntu, Raspberry Pi OS, Fedora, RHEL/CentOS
make help # Lista komend
make install # Pełna instalacja (autodetekcja systemu)
make web # Uruchom panel web (natywnie)
make web-docker # Uruchom w Docker (zalecane na Fedora)
make web-stop # Zatrzymaj panel
make detect-usb # Wykryj urządzenia USB
make cli # CLI kontroler
make home # Homing
make status # Status silnika
make docker-up # Uruchom w Docker
docker-down # Zatrzymaj Docker
make test # Testy jednostkowe
make clean # Wyczyść build
CLI Shell (interaktywny)
Interaktywny shell do sterowania silnikiem przez API web panelu:
# Uruchomienie shella (wymaga uruchomionego web panelu)
make shell
# Lub bezpośrednio
bash cli_shell.sh
# Z innym adresem API
API_BASE=http://192.168.1.100:5000 bash cli_shell.sh
Komendy w shellu
tic> status # Status silnika
tic> devices # Lista urządzeń USB
tic> connect 0 # Połącz z urządzeniem #0
tic> home # Homing reverse
tic> home forward # Homing forward
tic> move 1000 # Idź do pozycji 1000
tic> move-rel 500 # Przesuń o +500 kroków
tic> jog forward 100 # Jog forward 100 kroków
tic> jog reverse 200 # Jog reverse 200 kroków
tic> stop # Emergency stop
tic> energize on # Włącz zasilanie silnika
tic> energize off # Wyłącz zasilanie silnika
tic> reciprocate 500 100000 5 0.5 # Ruch P-Z: kroki, prędkość, cykle, pauza
tic> settings # Pokaż ustawienia
tic> logs # Pokaż logi
tic> help # Pomoc
tic> quit # Wyjście
Testy E2E
Uruchomienie testów
# Lokalnie (wymaga playwright)
pip install pytest-playwright
pytest tests/e2e/ -v
# W Dockerze
docker-compose --profile test up
Struktura testów
tests/e2e/
├── test_web_panel.py # Testy UI (Playwright)
└── conftest.py # Konfiguracja pytest
Użycie — CLI
Homing (zerowanie na krańcówce)
# Homing sprzętowy Tic — jedź reverse aż limit switch, cofnij, pozycja=0
python tic_t249_controller.py home-reverse --limit-mode tic
# Homing forward
python tic_t249_controller.py home-forward --limit-mode tic
# Homing GPIO — piny BCM 17 (forward) i 27 (reverse)
python tic_t249_controller.py home-reverse --limit-mode gpio --gpio-fwd 17 --gpio-rev 27
# Z pliku konfiguracji
python tic_t249_controller.py home-reverse --config config.json
python tic_t249_controller.py home-reverse --config config-gpio.json
Wyznaczanie zakresu ruchu
# Jedź do reverse limit (pozycja=0), potem do forward limit → odczytaj zakres
python tic_t249_controller.py demo-range --limit-mode tic
Ruch z ochroną krańcówek
# Ruch do pozycji (Tic blokuje sprzętowo przy limit switch)
python tic_t249_controller.py move -p 5000 --limit-mode tic
# Ruch z soft limitami (przycina do zakresu - margin)
python tic_t249_controller.py move-safe -p 3000
# GPIO — emergency stop jeśli krańcówka aktywna w kierunku ruchu
python tic_t249_controller.py move -p 5000 --limit-mode gpio --gpio-fwd 17 --gpio-rev 27
Status krańcówek
python tic_t249_controller.py limit-status --limit-mode tic
python tic_t249_controller.py status --limit-mode tic
Pozostałe komendy
python tic_t249_controller.py demo-positions
python tic_t249_controller.py demo-velocity
python tic_t249_controller.py demo-homing --limit-mode tic
python tic_t249_controller.py velocity --speed 1000000 --duration 5
python tic_t249_controller.py home # ręczne zerowanie, bez krańcówek
Użycie — Python API
from tic_t249_controller import (
TicT249Controller, MotorConfig, LimitSwitchConfig,
StepMode, HomingDirection,
)
# --- Tryb Tic (sprzętowy) ---
config = MotorConfig(
current_limit_ma=1200,
step_mode=StepMode.SIXTEENTH,
limit_switches=LimitSwitchConfig(mode="tic"),
)
with TicT249Controller(config) as ctrl:
# Homing na reverse limit switch → pozycja = 0
ctrl.go_home(HomingDirection.REVERSE)
# Ruch — Tic automatycznie blokuje przy limit switch
ctrl.move_to(5000)
ctrl.wait_for_position()
# Status krańcówek
status = ctrl.get_limit_switch_status()
print(f"Forward: {status['forward_active']}")
print(f"Reverse: {status['reverse_active']}")
# Wyznacz zakres ruchu
travel = ctrl.find_travel_range()
print(f"Zakres: {travel} kroków")
# Ruch bezpieczny (z soft limitami)
ctrl.move_to_safe(travel // 2)
ctrl.wait_for_position()
# --- Tryb GPIO (Raspberry Pi) ---
config_gpio = MotorConfig(
limit_switches=LimitSwitchConfig(
mode="gpio",
gpio_forward_pin=17,
gpio_reverse_pin=27,
gpio_active_low=True, # NO switch z pull-up
homing_speed_towards=300_000,
homing_speed_away=100_000,
),
)
with TicT249Controller(config_gpio) as ctrl:
ctrl.go_home(HomingDirection.REVERSE)
ctrl.move_to(3000)
ctrl.wait_for_position() # przerywa jeśli krańcówka aktywna
Konfiguracja JSON
config.json (tryb Tic)
{
"limit_switches": {
"mode": "tic",
"homing_speed_towards": 500000,
"homing_speed_away": 200000,
"soft_limit_margin": 50
}
}
config-gpio.json (tryb GPIO)
{
"limit_switches": {
"mode": "gpio",
"gpio_forward_pin": 17,
"gpio_reverse_pin": 27,
"gpio_active_low": true,
"gpio_bounce_time_ms": 5,
"homing_speed_towards": 500000,
"homing_speed_away": 200000,
"soft_limit_margin": 50
}
}
Procedura homing — jak działa
Tryb Tic (sprzętowy)
- Komenda
go_home(direction)→ Tic jedzie w zadanym kierunku - Tic napotyka limit switch → natychmiastowe zatrzymanie (sprzętowe)
- Tic czeka 20 ms
- Tic cofa wolno aż limit switch się dezaktywuje
- Pozycja = 0, flaga "position uncertain" skasowana
Tryb GPIO (programowy)
- Jeśli już na krańcówce → najpierw odjazd
- Ruch wolny w kierunku krańcówki (
homing_speed_towards) - GPIO przerwanie →
halt_and_hold()(natychmiastowy stop) - Cofanie wolne (
homing_speed_away) aż GPIO zwolni halt_and_set_position(0)
Bezpieczeństwo
- Ctrl+C → bezpieczne deenergize (cewki wyłączone)
- GPIO emergency stop → natychmiastowe
halt_and_hold()przy krańcówce - Soft limity →
move_to_safe()przycina pozycję do zakresu ± margines - Nigdy nie odłączaj silnika przy zasilonym sterowniku
- Bez radiatora max ~1800 mA na cewkę
Licencja
Program: MIT (Softreck, softreck.dev) Zależność ticlib: BSD-2-Clause (Julien Phalip) — dozwolona komercyjnie
License
Apache License 2.0 - see LICENSE for details.
Author
Created by Tom Sapletta - tom@sapletta.com
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pololu-0.1.10.tar.gz.
File metadata
- Download URL: pololu-0.1.10.tar.gz
- Upload date:
- Size: 10.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5759be91f4086eeb0e6225272320de4351e90488795341d23ebc6b5d65d8c326
|
|
| MD5 |
980b39e3006b57460430d48ffe3dd09f
|
|
| BLAKE2b-256 |
48ddb3781ec54d11fe67f77018b908db20bfdcafc03f699f4de39b021564ed84
|
File details
Details for the file pololu-0.1.10-py3-none-any.whl.
File metadata
- Download URL: pololu-0.1.10-py3-none-any.whl
- Upload date:
- Size: 10.9 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3e4e67cb889a21ec9be239aa1177cb03c44aa052f049523bc58e307865309f15
|
|
| MD5 |
c4e9c30ce1f01cc352ae5c9a2bf4140f
|
|
| BLAKE2b-256 |
cc1fc6af86bfaff9709d2ff471ec3a0dae420cce4150c0e4504ccdfd818fa7d3
|