deviceagent

package

Go to main page

Versions in this module

v0

v0.51.2

Jul 24, 2026

v0.51.1

Jul 22, 2026

Changes in this version

+ const CapabilityReady

+ const CapabilityUnavailable

+ const CapabilityUnverified

+ const CurrentProtocolVersion

+ const ServerInstanceHeader

+ var ErrAssistResponseMismatch = errors.New("speechkit deviceagent: assist response does not match the request")

+ var ErrHomeAssistantBridgeUnavailable = errors.New("speechkit deviceagent: Home Assistant bridge is not ready")

+ var ErrInsecureServerTransport = errors.New("speechkit deviceagent: plaintext HTTP is allowed only for a loopback server")

+ var ErrLegacyClientConfig = errors.New(...)

+ var ErrMissingCommandID = errors.New("speechkit deviceagent: command_id is required")

+ var ErrMissingExpectedPairingID = errors.New("speechkit deviceagent: expected_pairing_id is required")

+ var ErrMissingExpectedServerInstance = errors.New("speechkit deviceagent: expected_server_instance_id is required")

+ var ErrMissingPairingToken = errors.New("speechkit deviceagent: pairing_token is required")

+ var ErrPairingIdentityMismatch = errors.New("speechkit deviceagent: pairing epoch identity mismatch")

+ var ErrPairingTokenInvalid = errors.New("speechkit deviceagent: pairing_token must be a bounded bearer credential")

+ var ErrPairingTokenTooShort = errors.New("speechkit deviceagent: pairing_token must contain at least 32 bytes")

+ var ErrResponseTooLarge = errors.New("speechkit deviceagent: server response exceeds the protocol limit")

+ var ErrServerIdentityMismatch = errors.New("speechkit deviceagent: server instance identity mismatch")

+ var ErrServerIdentityMissing = errors.New("speechkit deviceagent: server instance identity header is missing")

+ var ErrTTSBridgeUnavailable = errors.New("speechkit deviceagent: TTS bridge is not ready")

+ type AssistRequest struct

+ CommandID string

+ DeviceID string

+ Locale string

+ RequestID string

+ RoomID string

+ SessionID string

+ Text string

+ type AssistResponse struct

+ ActionExecuted string

+ ConversationID string

+ ErrorCode string

+ ReasonCode string

+ Replayed bool

+ RequestID string

+ ResponseType string

+ Retryable bool

+ Speech string

+ Status string

+ UserGuidance string

+ type BridgeCapabilities struct

+ HomeAssistant CapabilityState

+ TTS CapabilityState

+ type BridgeError struct

+ ActionExecuted string

+ ErrorCode string

+ ReasonCode string

+ Retryable bool

+ UserGuidance string

+ type CapabilityState struct

+ ReasonCode string

+ Status string

type Config

+ Capabilities Capabilities

+ ExpectedPairingID string

+ ExpectedServerInstanceID string

+ Health Health

+ PairingToken string

type CycleOptions

+ CommandID string

+ RequestID string

type CycleResult

+ ConversationID string

+ Replayed bool

+ RequestID string

+ ResponseType string

+ type ErrorEnvelope struct

+ Error BridgeError

type Event

+ RequestID string

+ type EventAck struct

+ Status string

+ type HTTPError struct

+ Envelope ErrorEnvelope

+ Method string

+ Path string

+ StatusCode int

+ func (e *HTTPError) Error() string

type RegistrationAck

+ Capabilities BridgeCapabilities

+ ServerInstanceID string

+ type TTSRequest struct

+ Format string

+ RequestID string

+ type TTSResponse struct

+ AudioBase64 string

+ DurationMS int64

+ Format string

+ Provider string

+ RequestID string

+ SampleRate int

+ Voice string

v0.48.1

Jun 28, 2026

v0.48.0

Jun 28, 2026

Changes in this version

+ const ProtocolVersion

+ var ErrMissingAssistText = errors.New("speechkit deviceagent: assist text is required")

+ var ErrMissingHomeAssistantToken = errors.New("speechkit deviceagent: home_assistant_token is required")

+ var ErrMissingHomeAssistantURL = errors.New("speechkit deviceagent: home_assistant_url is required")

+ var ErrMissingServerURL = errors.New("speechkit deviceagent: server_url is required")

+ type Agent struct

+ func New(cfg Config) (*Agent, error)

+ func (a *Agent) Publish(ctx context.Context, ev Event) error

+ func (a *Agent) Register(ctx context.Context) (*RegistrationAck, error)

+ func (a *Agent) RunFakeAssistCycle(ctx context.Context, opts CycleOptions) (*CycleResult, error)

+ type AudioDevice struct

+ ID string

+ Kind string

+ Name string

+ Transport string

+ type Capabilities struct

+ Assist bool

+ BargeIn bool

+ Dictation bool

+ LocalPairing bool

+ TTS bool

+ VoiceAgent bool

+ WakewordLocal bool

+ type Config struct

+ Device DeviceDescriptor

+ HTTPClient *http.Client

+ HomeAssistantAgent string

+ HomeAssistantToken string

+ HomeAssistantURL string

+ Locale string

+ ServerToken string

+ ServerURL string

+ UserAgent string

+ type CycleOptions struct

+ Locale string

+ SessionID string

+ Text string

+ type CycleResult struct

+ Events []Event

+ HomeAssistantRaw string

+ SessionID string

+ SpokenText string

+ TTSProvider string

+ type DeviceDescriptor struct

+ AgentID string

+ CaptureDevice AudioDevice

+ DeviceID string

+ DisplayName string

+ OutputDevice AudioDevice

+ RoomID string

+ Wakeword Wakeword

+ type Event struct

+ At time.Time

+ CapturePolicy string

+ DeviceID string

+ Metadata map[string]string

+ Mode string

+ ReasonCode string

+ RoomID string

+ SessionID string

+ SpeakText string

+ Surface string

+ Text string

+ Transport string

+ Type string

+ type Health struct

+ CaptureReady bool

+ OutputReady bool

+ Status string

+ WakeReady bool

+ type Pairing struct

+ Method string

+ Status string

+ type Registration struct

+ Capabilities Capabilities

+ Device DeviceDescriptor

+ Health Health

+ Pairing Pairing

+ RegisteredAt time.Time

+ Version string

+ type RegistrationAck struct

+ PairingID string

+ ServerTime string

+ Status string

+ type Wakeword struct

+ Backend string

+ Enabled bool

+ Phrase string

+ Status string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL