ciris-agent 1.7.7__py3-none-any.whl

ciris_adapters/home_assistant/manifest.json

@@ -0,0 +1,203 @@
+{
+  "module": {
+    "name": "home_assistant",
+    "version": "1.0.0",
+    "description": "Enhanced Home Assistant integration with CIRIS multi-modal capabilities including event detection and camera frame extraction",
+    "author": "CIRIS Team",
+    "safe_domain": true
+  },
+  "services": [
+    {
+      "type": "TOOL",
+      "priority": "NORMAL",
+      "class": "home_assistant.tool_service.HAToolService",
+      "capabilities": [
+        "execute_tool",
+        "get_available_tools",
+        "ha_device_control",
+        "ha_automation_trigger",
+        "ha_sensor_query",
+        "ha_notification",
+        "ha_camera_analyze",
+        "provider:home_assistant"
+      ]
+    },
+    {
+      "type": "COMMUNICATION",
+      "priority": "NORMAL",
+      "class": "home_assistant.communication_service.HACommunicationService",
+      "capabilities": [
+        "send_message",
+        "fetch_messages",
+        "ha_event_stream",
+        "ha_camera_events",
+        "ha_tts",
+        "provider:home_assistant"
+      ]
+    }
+  ],
+  "capabilities": [
+    "ha_chat_bridge",
+    "ha_device_control",
+    "ha_automation_trigger",
+    "ha_sensor_data",
+    "ha_event_detection",
+    "ha_camera_frames",
+    "provider:home_assistant",
+    "modality:vision:camera",
+    "modality:event:motion",
+    "modality:event:person",
+    "modality:event:vehicle",
+    "domain:home_automation"
+  ],
+  "prohibited_capabilities": [
+    "medical",
+    "health",
+    "clinical",
+    "patient",
+    "vital",
+    "diagnosis",
+    "treatment"
+  ],
+  "interactive_config": {
+    "required": false,
+    "workflow_type": "discovery_then_config",
+    "steps": [
+      {
+        "step_id": "discover",
+        "step_type": "discovery",
+        "title": "Discover Home Assistant",
+        "description": "Find Home Assistant instances on your network via mDNS or enter URL manually",
+        "discovery_method": "mdns"
+      },
+      {
+        "step_id": "oauth",
+        "step_type": "oauth",
+        "title": "Authenticate with Home Assistant",
+        "description": "Sign in to your Home Assistant instance using OAuth2",
+        "oauth_config": {
+          "provider_name": "Home Assistant",
+          "authorization_path": "/auth/authorize",
+          "token_path": "/auth/token",
+          "client_id_source": "indieauth",
+          "scopes": [],
+          "pkce_required": true
+        },
+        "depends_on": ["discover"]
+      },
+      {
+        "step_id": "select_features",
+        "step_type": "select",
+        "title": "Select Features",
+        "description": "Choose which Home Assistant features to enable",
+        "options_method": "get_config_options",
+        "depends_on": ["oauth"]
+      },
+      {
+        "step_id": "select_cameras",
+        "step_type": "select",
+        "title": "Select Cameras",
+        "description": "Choose which cameras to use for event detection (optional)",
+        "options_method": "get_config_options",
+        "depends_on": ["oauth"],
+        "optional": true
+      },
+      {
+        "step_id": "confirm",
+        "step_type": "confirm",
+        "title": "Confirm Configuration",
+        "description": "Review and apply your Home Assistant configuration"
+      }
+    ],
+    "completion_method": "apply_config"
+  },
+  "dependencies": {
+    "protocols": [
+      "ciris_engine.protocols.services.CommunicationService",
+      "ciris_engine.protocols.adapters.configurable.ConfigurableAdapterProtocol"
+    ],
+    "schemas": [
+      "ciris_engine.schemas.services.core",
+      "ciris_engine.schemas.runtime.manifest"
+    ],
+    "external": {
+      "aiohttp": ">=3.8.0",
+      "opencv-python": ">=4.5.0",
+      "numpy": ">=1.20.0",
+      "zeroconf": ">=0.80.0"
+    }
+  },
+  "exports": {
+    "service_class": "home_assistant.service.HAIntegrationService",
+    "configurable": "home_assistant.configurable.HAConfigurableAdapter",
+    "schemas": [
+      "home_assistant.schemas.DetectionEvent",
+      "home_assistant.schemas.CameraFrame",
+      "home_assistant.schemas.HADeviceState"
+    ],
+    "capabilities": [
+      "ha_chat_bridge",
+      "ha_device_control",
+      "ha_automation_trigger",
+      "ha_sensor_data",
+      "ha_event_detection",
+      "ha_camera_frames"
+    ]
+  },
+  "configuration": {
+    "homeassistant_url": {
+      "type": "string",
+      "env": "HOME_ASSISTANT_URL",
+      "default": "http://homeassistant.local:8123",
+      "description": "Home Assistant instance URL"
+    },
+    "homeassistant_token": {
+      "type": "string",
+      "env": "HOME_ASSISTANT_TOKEN",
+      "default": null,
+      "description": "Home Assistant access token (obtained via OAuth2)"
+    },
+    "homeassistant_refresh_token": {
+      "type": "string",
+      "env": "HOME_ASSISTANT_REFRESH_TOKEN",
+      "default": null,
+      "description": "Home Assistant refresh token for token renewal"
+    },
+    "go2rtc_server_url": {
+      "type": "string",
+      "env": "GO2RTC_SERVER_URL",
+      "default": "http://127.0.0.1:8554",
+      "description": "go2rtc server URL for WebRTC camera streams"
+    },
+    "webrtc_camera_urls": {
+      "type": "string",
+      "env": "WEBRTC_CAMERA_URLS",
+      "default": "",
+      "description": "Comma-separated camera definitions: name:rtsp_url,name2:rtsp_url2"
+    },
+    "event_detection_sensitivity": {
+      "type": "float",
+      "env": "EVENT_DETECTION_SENSITIVITY",
+      "default": 0.7,
+      "description": "Sensitivity threshold for event detection (0.0-1.0)"
+    },
+    "cache_ttl_seconds": {
+      "type": "integer",
+      "default": 30,
+      "description": "Entity cache time-to-live in seconds"
+    },
+    "enabled_features": {
+      "type": "array",
+      "default": ["device_control", "automation_trigger", "sensor_data", "notifications"],
+      "description": "List of enabled HA features"
+    }
+  },
+  "metadata": {
+    "api": "Home Assistant WebSocket/REST API",
+    "requires_api_key": true,
+    "safe_domain": "home_automation",
+    "hardware_notes": "Designed for CIRISHome hardware stack: Jetson + HA Yellow + Voice PE",
+    "critical_note": "Actively filters out medical capabilities",
+    "oauth_note": "Uses IndieAuth-style OAuth2 per https://developers.home-assistant.io/docs/auth_api/"
+  }
+}

ciris_adapters/home_assistant/schemas.py

@@ -0,0 +1,129 @@
+"""
+Pydantic schemas for Home Assistant integration.
+
+Provides type-safe data structures for events, camera frames, and device states.
+"""
+
+from datetime import datetime
+from enum import Enum
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, Field
+
+
+class EventType(str, Enum):
+    """Types of events that can be detected."""
+
+    PERSON = "person"
+    VEHICLE = "vehicle"
+    ANIMAL = "animal"
+    PACKAGE = "package"
+    MOTION = "motion"
+    ACTIVITY = "activity"
+
+
+class HAEventType(str, Enum):
+    """Home Assistant camera event types."""
+
+    CAMERA_PERSON = "camera_person"
+    CAMERA_VEHICLE = "camera_vehicle"
+    CAMERA_ANIMAL = "camera_animal"
+    CAMERA_PACKAGE = "camera_package"
+    CAMERA_MOTION = "camera_motion"
+    CAMERA_ACTIVITY = "camera_activity"
+
+
+class DetectionEvent(BaseModel):
+    """Represents a detected event from camera analysis."""
+
+    event_type: EventType = Field(..., description="Type of event detected")
+    camera_name: str = Field(..., description="Name of the camera that detected the event")
+    confidence: float = Field(..., ge=0.0, le=1.0, description="Confidence score 0-1")
+    timestamp: datetime = Field(default_factory=datetime.now, description="When the event was detected")
+    zones: List[str] = Field(default_factory=list, description="Detection zones triggered")
+    description: str = Field("", description="Human-readable description of the event")
+    ha_event_type: HAEventType = Field(default=HAEventType.CAMERA_MOTION, description="HA event type mapping")
+
+    class Config:
+        """Pydantic configuration."""
+
+        use_enum_values = True
+
+
+class CameraFrame(BaseModel):
+    """Represents extracted camera frame data."""
+
+    camera_name: str = Field(..., description="Name of the camera")
+    timestamp: datetime = Field(default_factory=datetime.now, description="When the frame was captured")
+    width: int = Field(..., gt=0, description="Frame width in pixels")
+    height: int = Field(..., gt=0, description="Frame height in pixels")
+    channels: int = Field(default=3, description="Number of color channels")
+    brightness: float = Field(default=0.0, ge=0.0, le=255.0, description="Average brightness")
+    motion_detected: bool = Field(default=False, description="Whether motion was detected")
+    frame_index: int = Field(default=0, ge=0, description="Index of this frame in sequence")
+
+    class Config:
+        """Pydantic configuration."""
+
+        arbitrary_types_allowed = True
+
+
+class CameraStatus(BaseModel):
+    """Status of a camera."""
+
+    camera_name: str = Field(..., description="Name of the camera")
+    stream_url: str = Field(..., description="RTSP stream URL")
+    is_online: bool = Field(default=False, description="Whether camera is accessible")
+    last_check: Optional[datetime] = Field(default=None, description="Last status check time")
+
+
+class CameraAnalysisResult(BaseModel):
+    """Result of camera feed analysis."""
+
+    camera_name: str = Field(..., description="Name of the analyzed camera")
+    duration_seconds: int = Field(..., ge=0, description="Duration of analysis")
+    frames_analyzed: int = Field(default=0, ge=0, description="Number of frames processed")
+    motion_detected: bool = Field(default=False, description="Whether motion was detected")
+    objects_detected: List[str] = Field(default_factory=list, description="Objects found in frames")
+    average_brightness: float = Field(default=0.0, ge=0.0, description="Average frame brightness")
+    error: Optional[str] = Field(default=None, description="Error message if analysis failed")
+
+
+class HADeviceState(BaseModel):
+    """Home Assistant device state."""
+
+    entity_id: str = Field(..., description="Home Assistant entity ID")
+    state: str = Field(..., description="Current state value")
+    friendly_name: str = Field(default="", description="Human-readable name")
+    last_changed: Optional[datetime] = Field(default=None, description="When state last changed")
+    last_updated: Optional[datetime] = Field(default=None, description="When state was last updated")
+    attributes: Dict[str, Any] = Field(default_factory=dict, description="Entity attributes")
+    domain: str = Field(default="", description="Entity domain (light, switch, etc.)")
+
+
+class HAAutomationResult(BaseModel):
+    """Result of triggering a Home Assistant automation."""
+
+    entity_id: str = Field(..., description="Entity that was triggered")
+    action: str = Field(..., description="Action that was performed")
+    success: bool = Field(..., description="Whether the action succeeded")
+    timestamp: datetime = Field(default_factory=datetime.now, description="When the action was performed")
+    error: Optional[str] = Field(default=None, description="Error message if action failed")
+
+
+class HANotification(BaseModel):
+    """Home Assistant notification to send."""
+
+    title: str = Field(..., description="Notification title")
+    message: str = Field(..., description="Notification message")
+    target: Optional[str] = Field(default=None, description="Target device/service")
+    data: Dict[str, Any] = Field(default_factory=dict, description="Additional notification data")
+
+
+class EventSubscription(BaseModel):
+    """Subscription to Home Assistant events."""
+
+    event_types: List[EventType] = Field(default_factory=list, description="Event types to subscribe to")
+    cameras: List[str] = Field(default_factory=list, description="Cameras to monitor (empty = all)")
+    callback_url: Optional[str] = Field(default=None, description="Webhook URL for event delivery")
+    sensitivity: float = Field(default=0.7, ge=0.0, le=1.0, description="Detection sensitivity")