5efa9c37d6
- Created detailed documentation for the device_manager, model, model_extra, osc, overlay, overlay_image, transcription, translation, transliteration, utils, watchdog, and websocket modules. - Added a comprehensive run events payloads document outlining the payloads sent during various run events in the controller. - Included runtime instructions and dependencies for setting up the project in a Windows environment. - Introduced a mypy configuration file to manage type checking and ignore errors in specific modules temporarily.
1.8 KiB
1.8 KiB
システム図
以下はシステム構成の概要（Mermaid シーケンス図とテキスト版の両方）です。Mermaid がサポートされているビューアでは下のシーケンス図が描画されます。
sequenceDiagram
participant GUI as GUI (stdin/stdout)
participant Main as mainloop
participant Controller as Controller
participant Model as Model
participant Recorder as Recorder
participant Transcriber as Transcriber
participant Translator as Translator
participant Overlay as Overlay
participant OSC as OSC
participant WS as WebSocket
GUI->>Main: send JSON endpoint
Main->>Controller: dispatch
Controller->>Model: startMicTranscript(callback)
Recorder->>Transcriber: audio data
Transcriber->>Controller: result (text, language)
Controller->>Translator: getInputTranslate(text)
Translator-->>Controller: translations
Controller->>Overlay: updateOverlay(translation)
Controller->>OSC: sendMessage(osc_message)
Controller->>WS: websocketSendMessage(event)
Controller-->>GUI: run(status, endpoint, result)
テキスト版（簡易）
Main process (mainloop.py)
- stdin -> JSON コマンド -> Main.receiver -> queue
- Main.handler -> Controller (コマンド実行)
- run(status, endpoint, result) -> stdout (GUI に通知)
Controller
- config (読み書き)
- model (起動/停止/アクション)
Model サブシステム
- device_manager (デバイス列挙/監視)
- transcription (recorder -> transcriber)
- translation (Translator)
- overlay (OverlayImage -> Overlay)
- osc (OSCHandler)
- websocket (WebSocketServer)
データフロー（代表）: 録音 -> audio_queue -> AudioTranscriber -> Controller.micMessage -> Translator -> (OSC / Overlay / WebSocket / ログ)