tjbot-ce 3.0.0__py3-none-any.whl

tjbot/__init__.py

@@ -0,0 +1,29 @@
+# Copyright 2026-present TJBot Contributors. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from .tjbot import TJBot
+
+
+def __getattr__(name: str):
+    if name == "TJBot":
+        from .tjbot import TJBot
+
+        return TJBot
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+__all__ = ["TJBot"]

tjbot/camera/__init__.py

@@ -0,0 +1,17 @@
+# Copyright 2026-present TJBot Contributors. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .camera import CameraController
+
+__all__ = ["CameraController"]

tjbot/camera/camera.py

@@ -0,0 +1,168 @@
+# Copyright 2026-present TJBot Contributors. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import subprocess
+import tempfile
+from typing import Tuple, Optional
+import logging
+from ..utils.errors import TJBotError
+
+
+logger = logging.getLogger(__name__)
+
+
+class CameraController:
+    """
+    TJBot Camera Controller.
+    Handles camera initialization and photo capture using rpicam-still.
+    """
+
+    def __init__(self):
+        self.resolution: Tuple[int, int] = (1920, 1080)
+        self.vertical_flip = False
+        self.horizontal_flip = False
+        self.capture_timeout = 500
+        self.zero_shutter_lag = False
+
+    def initialize(
+        self,
+        resolution: Tuple[int, int],
+        vertical_flip: bool,
+        horizontal_flip: bool,
+        capture_timeout: int = 500,
+        zero_shutter_lag: bool = False,
+    ) -> None:
+        """
+        Initialize camera settings.
+        :param resolution: (width, height) tuple.
+        :param vertical_flip: Whether to flip vertically.
+        :param horizontal_flip: Whether to flip horizontally.
+        """
+        self.resolution = resolution
+        self.vertical_flip = vertical_flip
+        self.horizontal_flip = horizontal_flip
+        self.capture_timeout = capture_timeout
+        self.zero_shutter_lag = zero_shutter_lag
+
+        logger.debug(
+            "Initialized camera with config: resolution=%sx%s, vertical_flip=%s, horizontal_flip=%s, capture_timeout=%sms, zero_shutter_lag=%s",
+            resolution[0],
+            resolution[1],
+            vertical_flip,
+            horizontal_flip,
+            capture_timeout,
+            zero_shutter_lag,
+        )
+
+    def build_camera_args(
+        self, output_path: str, encoding: Optional[str] = None
+    ) -> list[str]:
+        """
+        Build rpicam-still command arguments.
+        :param output_path: Output path or '-' for stdout.
+        :param encoding: Optional encoding format (for example 'jpg').
+        :return: List of command-line arguments.
+        """
+        args = [
+            "--output",
+            output_path,
+            "--width",
+            str(self.resolution[0]),
+            "--height",
+            str(self.resolution[1]),
+            "--nopreview",
+            "--camera",
+            "0",
+        ]
+
+        if encoding:
+            args.extend(["--encoding", encoding])
+
+        if self.vertical_flip:
+            args.append("--vflip")
+        if self.horizontal_flip:
+            args.append("--hflip")
+
+        if self.capture_timeout == 0:
+            args.append("--immediate")
+        else:
+            args.extend(["--timeout", str(self.capture_timeout)])
+
+        if self.zero_shutter_lag:
+            args.append("--zsl")
+
+        logger.debug("Built camera args: %s", " ".join(args))
+        return args
+
+    def capture_photo(self, at_path: Optional[str] = None) -> str:
+        """
+        Capture a photo by invoking rpicam-still.
+        :param at_path: Optional path to save the photo. If None, a temporary file will be used.
+        :return: Path to the saved photo.
+        """
+        if not at_path:
+            fd, at_path = tempfile.mkstemp(prefix="tjbot", suffix=".jpg")
+            os.close(fd)
+
+        logger.info("Capturing image at path: %s", at_path)
+        cmd = ["rpicam-still", *self.build_camera_args(at_path)]
+
+        try:
+            result = subprocess.run(
+                cmd,
+                check=True,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+            )
+            logger.debug(
+                "rpicam-still stdout: %s", result.stdout.decode(errors="replace")
+            )
+            return at_path
+        except (subprocess.CalledProcessError, FileNotFoundError) as err:
+            stderr = ""
+            if isinstance(err, subprocess.CalledProcessError):
+                stderr = (err.stderr or b"").decode(errors="replace")
+            message = stderr or str(err)
+            logger.error("rpicam-still error: %s", message)
+            raise TJBotError(message) from err
+
+    def capture_photo_buffer(self) -> bytes:
+        """
+        Capture a photo and return it as bytes.
+        :return: Photo bytes.
+        """
+        logger.info("Capturing image to buffer")
+        cmd = ["rpicam-still", *self.build_camera_args("-", "jpg")]
+
+        try:
+            result = subprocess.run(
+                cmd,
+                check=True,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+            )
+            logger.debug("Captured image buffer (%s bytes)", len(result.stdout))
+            return result.stdout
+        except (subprocess.CalledProcessError, FileNotFoundError) as err:
+            stderr = ""
+            if isinstance(err, subprocess.CalledProcessError):
+                stderr = (err.stderr or b"").decode(errors="replace")
+            message = stderr or str(err)
+            logger.error("rpicam-still error: %s", message)
+            raise TJBotError(message) from err
+
+    def cleanup(self) -> None:
+        """Clean up resources (no-op for direct process invocation)."""
+        logger.debug("CameraController cleanup (no-op for rpicam-still)")

tjbot/config/__init__.py

@@ -0,0 +1,49 @@
+# Copyright 2026-present TJBot Contributors. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .config_types import (
+    TJBotConfigSchema,
+    LogConfig,
+    HardwareConfig,
+    ListenConfig,
+    SeeConfig,
+    SeeBackendConfig,
+    SeeBackendLocalConfig,
+    SeeBackendGoogleCloudConfig,
+    SeeBackendAzureConfig,
+    ShineConfig,
+    SpeakConfig,
+    WaveConfig,
+    STTBackendConfig,
+    TTSBackendConfig,
+)
+from .tjbot_config import TJBotConfig
+
+__all__ = [
+    "TJBotConfig",
+    "TJBotConfigSchema",
+    "LogConfig",
+    "HardwareConfig",
+    "ListenConfig",
+    "SeeConfig",
+    "SeeBackendConfig",
+    "SeeBackendLocalConfig",
+    "SeeBackendGoogleCloudConfig",
+    "SeeBackendAzureConfig",
+    "ShineConfig",
+    "SpeakConfig",
+    "WaveConfig",
+    "STTBackendConfig",
+    "TTSBackendConfig",
+]

tjbot/config/config_types.py

@@ -0,0 +1,251 @@
+# Copyright 2026-present TJBot Contributors. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import Any, Dict, List, Literal, Optional, Tuple
+
+from pydantic import BaseModel, ConfigDict, Field
+from ..utils.logging import TJBotLogLevel
+
+
+class TJBotBaseModel(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+
+class LogConfig(TJBotBaseModel):
+    level: Optional[TJBotLogLevel] = "info"
+
+
+class VADConfig(TJBotBaseModel):
+    enabled: Optional[bool] = True
+    model: Optional[str] = None
+    model_url: Optional[str] = Field(default=None, alias="modelUrl")
+
+
+class STTBackendLocalConfig(TJBotBaseModel):
+    model: Optional[str] = None
+    model_url: Optional[str] = Field(default=None, alias="modelUrl")
+    vad: Optional[VADConfig] = None
+
+
+class STTBackendIBMWatsonConfig(TJBotBaseModel):
+    model: Optional[str] = None
+    inactivity_timeout: Optional[int] = Field(default=None, alias="inactivityTimeout")
+    background_audio_suppression: Optional[float] = Field(
+        default=None, alias="backgroundAudioSuppression"
+    )
+    interim_results: Optional[bool] = Field(default=None, alias="interimResults")
+    credentials_path: Optional[str] = Field(default=None, alias="credentialsPath")
+
+
+class STTBackendGoogleCloudConfig(TJBotBaseModel):
+    model: Optional[str] = None
+    language_code: Optional[str] = Field(default=None, alias="languageCode")
+    credentials_path: Optional[str] = Field(default=None, alias="credentialsPath")
+    encoding: Optional[str] = None
+    sample_rate_hertz: Optional[int] = Field(default=None, alias="sampleRateHertz")
+    audio_channel_count: Optional[int] = Field(default=None, alias="audioChannelCount")
+    enable_automatic_punctuation: Optional[bool] = Field(
+        default=None, alias="enableAutomaticPunctuation"
+    )
+    interim_results: Optional[bool] = Field(default=None, alias="interimResults")
+    region: Optional[str] = None
+    profanity_filter: Optional[bool] = Field(default=None, alias="profanityFilter")
+
+
+class STTBackendAzureConfig(TJBotBaseModel):
+    language: Optional[str] = None
+    credentials_path: Optional[str] = Field(default=None, alias="credentialsPath")
+    interim_results: Optional[bool] = Field(default=None, alias="interimResults")
+
+
+class STTBackendConfig(TJBotBaseModel):
+    type: Optional[
+        Literal["none", "local", "ibm-watson-stt", "google-cloud-stt", "azure-stt"]
+    ] = "local"
+    local: Optional[STTBackendLocalConfig] = None
+    ibm_watson_stt: Optional[STTBackendIBMWatsonConfig] = Field(
+        default=None, alias="ibm-watson-stt"
+    )
+    google_cloud_stt: Optional[STTBackendGoogleCloudConfig] = Field(
+        default=None, alias="google-cloud-stt"
+    )
+    azure_stt: Optional[STTBackendAzureConfig] = Field(default=None, alias="azure-stt")
+
+
+class ListenConfig(TJBotBaseModel):
+    device: Optional[str] = None
+    microphone_rate: Optional[int] = Field(default=44100, alias="microphoneRate")
+    microphone_channels: Optional[int] = Field(default=2, alias="microphoneChannels")
+    model: Optional[str] = None
+    backend: Optional[STTBackendConfig] = None
+
+
+class SeeBackendLocalConfig(TJBotBaseModel):
+    object_detection_model: Optional[str] = Field(
+        default=None, alias="objectDetectionModel"
+    )
+    image_classification_model: Optional[str] = Field(
+        default=None, alias="imageClassificationModel"
+    )
+    face_detection_model: Optional[str] = Field(
+        default=None, alias="faceDetectionModel"
+    )
+    object_detection_confidence: Optional[float] = Field(
+        default=None, alias="objectDetectionConfidence"
+    )
+    image_classification_confidence: Optional[float] = Field(
+        default=None, alias="imageClassificationConfidence"
+    )
+    face_detection_confidence: Optional[float] = Field(
+        default=None, alias="faceDetectionConfidence"
+    )
+
+
+class SeeBackendGoogleCloudConfig(TJBotBaseModel):
+    credentials_path: Optional[str] = Field(default=None, alias="credentialsPath")
+    object_detection_confidence: Optional[float] = Field(
+        default=None, alias="objectDetectionConfidence"
+    )
+    image_classification_confidence: Optional[float] = Field(
+        default=None, alias="imageClassificationConfidence"
+    )
+    face_detection_confidence: Optional[float] = Field(
+        default=None, alias="faceDetectionConfidence"
+    )
+
+
+class SeeBackendAzureConfig(TJBotBaseModel):
+    credentials_path: Optional[str] = Field(default=None, alias="credentialsPath")
+    object_detection_confidence: Optional[float] = Field(
+        default=None, alias="objectDetectionConfidence"
+    )
+    image_classification_confidence: Optional[float] = Field(
+        default=None, alias="imageClassificationConfidence"
+    )
+
+
+class SeeBackendConfig(TJBotBaseModel):
+    type: Optional[Literal["none", "local", "google-cloud-vision", "azure-vision"]] = (
+        "none"
+    )
+    local: Optional[SeeBackendLocalConfig] = None
+    google_cloud_vision: Optional[SeeBackendGoogleCloudConfig] = Field(
+        default=None, alias="google-cloud-vision"
+    )
+    azure_vision: Optional[SeeBackendAzureConfig] = Field(
+        default=None, alias="azure-vision"
+    )
+
+
+class SeeConfig(TJBotBaseModel):
+    camera_resolution: Optional[Tuple[int, int]] = Field(
+        default=(1920, 1080), alias="cameraResolution"
+    )
+    vertical_flip: Optional[bool] = Field(default=False, alias="verticalFlip")
+    horizontal_flip: Optional[bool] = Field(default=False, alias="horizontalFlip")
+    capture_timeout: Optional[int] = Field(default=None, alias="captureTimeout")
+    zero_shutter_lag: Optional[bool] = Field(default=None, alias="zeroShutterLag")
+    backend: Optional[SeeBackendConfig] = None
+
+
+class LEDNeopixelConfig(TJBotBaseModel):
+    gpio_pin: Optional[int] = Field(default=None, alias="gpioPin")
+    spi_interface: Optional[str] = Field(default=None, alias="spiInterface")
+    use_grb_format: Optional[bool] = Field(default=False, alias="useGRBFormat")
+
+
+class LEDCommonAnodeConfig(TJBotBaseModel):
+    red_pin: Optional[int] = Field(default=None, alias="redPin")
+    green_pin: Optional[int] = Field(default=None, alias="greenPin")
+    blue_pin: Optional[int] = Field(default=None, alias="bluePin")
+
+
+class ShineConfig(TJBotBaseModel):
+    has_neopixel_led: Optional[bool] = Field(default=False, alias="hasNeopixelLED")
+    has_common_anode_led: Optional[bool] = Field(
+        default=False, alias="hasCommonAnodeLED"
+    )
+    neopixel: Optional[LEDNeopixelConfig] = None
+    common_anode: Optional[LEDCommonAnodeConfig] = Field(
+        default=None, alias="commonanode"
+    )
+
+
+class TTSBackendLocalConfig(TJBotBaseModel):
+    model: Optional[str] = None
+    model_url: Optional[str] = Field(default=None, alias="modelUrl")
+
+
+class TTSBackendIBMWatsonConfig(TJBotBaseModel):
+    voice: Optional[str] = None
+    credentials_path: Optional[str] = Field(default=None, alias="credentialsPath")
+
+
+class TTSBackendGoogleCloudConfig(TJBotBaseModel):
+    voice: Optional[str] = None
+    language_code: Optional[str] = Field(default=None, alias="languageCode")
+    credentials_path: Optional[str] = Field(default=None, alias="credentialsPath")
+
+
+class TTSBackendAzureConfig(TJBotBaseModel):
+    voice: Optional[str] = None
+    credentials_path: Optional[str] = Field(default=None, alias="credentialsPath")
+
+
+class TTSBackendConfig(TJBotBaseModel):
+    type: Optional[
+        Literal["none", "local", "ibm-watson-tts", "google-cloud-tts", "azure-tts"]
+    ] = "local"
+    local: Optional[TTSBackendLocalConfig] = None
+    ibm_watson_tts: Optional[TTSBackendIBMWatsonConfig] = Field(
+        default=None, alias="ibm-watson-tts"
+    )
+    google_cloud_tts: Optional[TTSBackendGoogleCloudConfig] = Field(
+        default=None, alias="google-cloud-tts"
+    )
+    azure_tts: Optional[TTSBackendAzureConfig] = Field(default=None, alias="azure-tts")
+
+
+class SpeakConfig(TJBotBaseModel):
+    device: Optional[str] = None
+    backend: Optional[TTSBackendConfig] = None
+
+
+class WaveConfig(TJBotBaseModel):
+    gpio_chip: Optional[int] = Field(default=0, alias="gpioChip")
+    servo_pin: Optional[int] = Field(default=18, alias="servoPin")
+
+
+class HardwareConfig(TJBotBaseModel):
+    speaker: Optional[bool] = False
+    microphone: Optional[bool] = False
+    led: Optional[bool] = False
+    servo: Optional[bool] = False
+    camera: Optional[bool] = False
+
+
+STTEngineConfig = Dict[str, Any]
+TTSEngineConfig = Dict[str, Any]
+
+
+class TJBotConfigSchema(TJBotBaseModel):
+    log: Optional[LogConfig] = Field(default_factory=LogConfig)
+    hardware: Optional[HardwareConfig] = Field(default_factory=HardwareConfig)
+    listen: Optional[ListenConfig] = Field(default_factory=ListenConfig)
+    see: Optional[SeeConfig] = Field(default_factory=SeeConfig)
+    shine: Optional[ShineConfig] = Field(default_factory=ShineConfig)
+    speak: Optional[SpeakConfig] = Field(default_factory=SpeakConfig)
+    wave: Optional[WaveConfig] = Field(default_factory=WaveConfig)
+    recipe: Optional[Dict[str, Any]] = Field(default_factory=dict)
+    models: Optional[List[Dict[str, Any]]] = Field(default_factory=list)