Skip to main content

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)

# 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

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

Uruchomienie z docker-compose

# Produkcja
docker-compose up -d

# Ze skonfigurowanym urządzeniem
USB_PRODUCT_ID=0x00c9 docker-compose up -d

# Tryb developerski (hot reload)
docker-compose --profile dev up -d

# Zatrzymanie
docker-compose down

Build obrazu

docker build -t pololu-tic .
docker run -d --privileged -p 5000:5000 pololu-tic

Makefile - komendy

make help           # Lista komend
make install        # Pełna instalacja
make web            # Uruchom panel web
make web-stop       # Zatrzymaj panel
make detect-usb     # Wykryj urządzenia USB
make cli            # CLI kontroler
make home           # Homing
make status         # Status silnika
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)

  1. Komenda go_home(direction) → Tic jedzie w zadanym kierunku
  2. Tic napotyka limit switch → natychmiastowe zatrzymanie (sprzętowe)
  3. Tic czeka 20 ms
  4. Tic cofa wolno aż limit switch się dezaktywuje
  5. Pozycja = 0, flaga "position uncertain" skasowana

Tryb GPIO (programowy)

  1. Jeśli już na krańcówce → najpierw odjazd
  2. Ruch wolny w kierunku krańcówki (homing_speed_towards)
  3. GPIO przerwanie → halt_and_hold() (natychmiastowy stop)
  4. Cofanie wolne (homing_speed_away) aż GPIO zwolni
  5. 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 limitymove_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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pololu-0.1.7.tar.gz (10.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pololu-0.1.7-py3-none-any.whl (10.8 MB view details)

Uploaded Python 3

File details

Details for the file pololu-0.1.7.tar.gz.

File metadata

  • Download URL: pololu-0.1.7.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

Hashes for pololu-0.1.7.tar.gz
Algorithm Hash digest
SHA256 6410d5af73834def29b5d0ea26cebd5d3dffd7f31eaaaefe4ed92859d619807c
MD5 183879176a3f819451cf6fb41158a5d9
BLAKE2b-256 d855206b7f86f4162ff7fa124b928589c4c0ebe6d0a3c5ec02da6dbfb2985f87

See more details on using hashes here.

File details

Details for the file pololu-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: pololu-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 10.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for pololu-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e9a44c984d4e41464b6c97305cc06a89653b8eb56a6156a79f8a844f4a92562d
MD5 9a5a50a9a58ac139f4382ca78b647c13
BLAKE2b-256 f7fee09724d79a1ab38df2d7e600af8c80cbbcfaf79cd86163d1d9558da754c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page