deviceagent

type Agent struct {
	// contains filtered or unexported fields
}

type AssistRequest struct {
	RequestID string `json:"request_id"`
	SessionID string `json:"session_id"`
	CommandID string `json:"command_id"`
	DeviceID  string `json:"device_id"`
	RoomID    string `json:"room_id"`
	Text      string `json:"text"`
	Locale    string `json:"locale"`
}

type AssistResponse struct {
	Status         string `json:"status"`
	RequestID      string `json:"request_id"`
	ConversationID string `json:"conversation_id,omitempty"`
	ResponseType   string `json:"response_type,omitempty"`
	Speech         string `json:"speech,omitempty"`
	ActionExecuted string `json:"action_executed"` // yes | no | unknown
	Replayed       bool   `json:"replayed"`
	ErrorCode      string `json:"error_code,omitempty"`
	ReasonCode     string `json:"reason_code,omitempty"`
	Retryable      bool   `json:"retryable"`
	UserGuidance   string `json:"user_guidance,omitempty"`
}

type AudioDevice struct {
	ID        string `json:"id"`
	Name      string `json:"name,omitempty"`
	Kind      string `json:"kind"` // microphone | speaker
	Transport string `json:"transport,omitempty"`
}

type BridgeCapabilities struct {
	HomeAssistant CapabilityState `json:"home_assistant"`
	TTS           CapabilityState `json:"tts"`
}

type BridgeError struct {
	ErrorCode      string `json:"error_code"`
	ReasonCode     string `json:"reason_code"`
	Retryable      bool   `json:"retryable"`
	ActionExecuted string `json:"action_executed"`
	UserGuidance   string `json:"user_guidance"`
}

type Capabilities struct {
	Dictation     bool `json:"dictation"`
	Assist        bool `json:"assist"`
	VoiceAgent    bool `json:"voice_agent"`
	WakewordLocal bool `json:"wakeword_local"`
	TTS           bool `json:"tts"`
	BargeIn       bool `json:"barge_in"`
	// Deprecated: pairing readiness is attested by the server response and is
	// never serialized from the device.
	LocalPairing bool `json:"-"`
}

type CapabilityState struct {
	Status     string `json:"status"`
	ReasonCode string `json:"reason_code,omitempty"`
}

type Config struct {
	ServerURL string
	// Deprecated: v1 authenticates only with PairingToken. Setting this field
	// makes New fail closed.
	ServerToken string
	// Deprecated: Home Assistant authority and credentials are server-owned.
	// Setting any of these fields makes New fail closed.
	HomeAssistantURL   string
	HomeAssistantToken string
	HomeAssistantAgent string
	// Deprecated: v1 owns its redirect and local-dial policy. Supplying a
	// custom client makes New fail closed.
	HTTPClient               *http.Client
	PairingToken             string
	ExpectedServerInstanceID string
	ExpectedPairingID        string
	UserAgent                string
	Device                   DeviceDescriptor
	Capabilities             Capabilities
	Health                   Health
	Locale                   string
}

type CycleOptions struct {
	RequestID string
	SessionID string
	CommandID string
	Text      string
	Locale    string
}

type CycleResult struct {
	RequestID      string  `json:"request_id"`
	SessionID      string  `json:"session_id"`
	SpokenText     string  `json:"spoken_text"`
	ConversationID string  `json:"conversation_id,omitempty"`
	ResponseType   string  `json:"response_type,omitempty"`
	TTSProvider    string  `json:"tts_provider,omitempty"`
	Replayed       bool    `json:"replayed"`
	Events         []Event `json:"events"`
	// Deprecated: raw Home Assistant responses never cross the v1 boundary.
	HomeAssistantRaw string `json:"-"`
}

type DeviceDescriptor struct {
	AgentID       string      `json:"agent_id"`
	DeviceID      string      `json:"device_id"`
	DisplayName   string      `json:"display_name,omitempty"`
	RoomID        string      `json:"room_id"`
	CaptureDevice AudioDevice `json:"capture_device"`
	OutputDevice  AudioDevice `json:"output_device"`
	Wakeword      Wakeword    `json:"wakeword"`
}

type ErrorEnvelope struct {
	Error BridgeError `json:"error"`
}

type Event struct {
	Type          string            `json:"type"`
	Surface       string            `json:"surface"`
	Mode          string            `json:"mode"`
	RequestID     string            `json:"request_id,omitempty"`
	SessionID     string            `json:"session_id,omitempty"`
	DeviceID      string            `json:"device_id"`
	RoomID        string            `json:"room_id"`
	CapturePolicy string            `json:"capture_policy,omitempty"`
	Transport     string            `json:"transport,omitempty"`
	Text          string            `json:"text,omitempty"`
	SpeakText     string            `json:"speak_text,omitempty"`
	ReasonCode    string            `json:"reason_code,omitempty"`
	At            time.Time         `json:"at"`
	Metadata      map[string]string `json:"metadata,omitempty"`
}

type EventAck struct {
	Status string `json:"status"`
}

type HTTPError struct {
	Method     string
	Path       string
	StatusCode int
	Envelope   ErrorEnvelope
}

type Health struct {
	Status       string `json:"status"`
	CaptureReady bool   `json:"capture_ready"`
	OutputReady  bool   `json:"output_ready"`
	WakeReady    bool   `json:"wake_ready"`
}

type Registration struct {
	Version      string           `json:"version"`
	RegisteredAt time.Time        `json:"registered_at"`
	Device       DeviceDescriptor `json:"device"`
	Capabilities Capabilities     `json:"capabilities"`
	Health       Health           `json:"health"`
	// Deprecated: v1 never accepts device-asserted pairing state.
	Pairing Pairing `json:"-"`
}

type RegistrationAck struct {
	Status           string             `json:"status"`
	PairingID        string             `json:"pairing_id"`
	ServerInstanceID string             `json:"server_instance_id"`
	ServerTime       string             `json:"server_time,omitempty"`
	Capabilities     BridgeCapabilities `json:"capabilities"`
}

type TTSRequest struct {
	RequestID string `json:"request_id"`
	Format    string `json:"format"`
}

type TTSResponse struct {
	RequestID   string `json:"request_id"`
	AudioBase64 string `json:"audio_base64"`
	Format      string `json:"format"`
	SampleRate  int    `json:"sample_rate"`
	DurationMS  int64  `json:"duration_ms"`
	Provider    string `json:"provider"`
	Voice       string `json:"voice,omitempty"`
}

type Wakeword struct {
	Enabled bool   `json:"enabled"`
	Phrase  string `json:"phrase,omitempty"`
	Backend string `json:"backend,omitempty"`
	Status  string `json:"status"`
}