Skip to content

Latest commit

 

History

History

apps

README.md

Dokumentacja modułów aplikacyjnych (apps/*)

Indeks dokumentacji wszystkich modułów aplikacyjnych w katalogu apps/

Spis modułów

Komunikacja i NLU

  • chat.md — moduł chat: audio.transcript → OpenAI → tts.speak
  • nlu.md — rozpoznawanie intencji ruchu z transkrypcji głosowych (PL)

Wizja i kamera

  • camera.md — preview kamery z detekcją twarzy na LCD
  • vision.md — detekcja obiektów (HOG, TFLite, ROI)

Interfejs użytkownika

  • draw.md — prymitywy renderowania buźki (arc, eyes, mouth)
  • hw.md — sink LCD do wyświetlania na sprzęcie
  • ui.md — przyciski, konfiguracja UI, emocje buźki
  • launcher.md — menu startowe na 4 przyciski
  • menu.md — menu nawigacyjne (dema, autonomia, teleop)

Ruch i bezpieczeństwo

  • motion.md — bridge ruchu: motion.cmd → XGO adapter
  • safety.md — emergency stop (E-STOP)

Demonstracje

  • demos.md — gotowe demonstracje (trajektorie, lemniskata)

Voice

⚠️ Uwaga: Moduł apps/voice ma dedykowaną pełną dokumentację w docs/modules/voice.md

Konwencje

Każdy dokument modułu zawiera:

  • Opis: Co robi moduł, główne klasy i funkcje
  • Przepływ danych: Wejście → Przetwarzanie → Wyjście
  • Konfiguracja: Parametry ENV/CLI, zależności do plików w config/
  • Przykład użycia: Jak uruchomić moduł (CLI, systemd)
  • Błędy i diagnostyka: Typowe błędy, logi, troubleshooting

Zależności między modułami

Przepływ danych voice → chat/nlu:
  voice (ASR) → audio.transcript → chat → tts.speak
                                  ↘ nlu → motion.cmd

Przepływ UI:
  ui.buttons → launcher/menu → system.mode
  draw + hw.sink_lcd → wyświetlacz fizyczny
  
Przepływ wizji:
  camera → vision.detector → motion commands

Uruchamianie modułów

Większość modułów może być uruchomiona jako:

# Bezpośrednio jako moduł Python
python -m apps.<nazwa>

# Lub przez systemd (jeśli skonfigurowane)
sudo systemctl start rider-<nazwa>.service

Zobacz docs/ops/systemd-scripts.md dla zarządzania usługami.

Related docs:

Ostatnia aktualizacja: 2025-01