Back to Homebridge

Interface MatterBridgeMetadata

docs/interfaces/MatterBridgeMetadata.html

2.0.22.5 KB
Original Source
  • MatterBridgeMetadata

Interface MatterBridgeMetadata

Metadata for a Matter bridge instance

interface MatterBridgeMetadata {
commissioned?: boolean;
deviceCount: number;
identifier: string;
manuallyStopped?: boolean;
manualPairingCode?: string;
name: string;
pid?: number;
plugin: string;
port?: number;
qrCode?: string;
serialNumber?: string;
status: MatterBridgeStatus;
type: "matter";
username?: string;
}

Index

Properties

commissioned?deviceCountidentifiermanuallyStopped?manualPairingCode?namepid?pluginport?qrCode?serialNumber?statustypeusername?

Properties

Optionalcommissioned

commissioned?: boolean

Whether the bridge has been commissioned

deviceCount

deviceCount: number

Number of devices exposed by this bridge

identifier

identifier: string

Unique identifier for this bridge instance

OptionalmanuallyStopped

manuallyStopped?: boolean

Whether the bridge was manually stopped

OptionalmanualPairingCode

manualPairingCode?: string

Manual pairing code for commissioning

name

name: string

Display name of the bridge

Optionalpid

pid?: number

Process ID of the bridge if running as child process

plugin

plugin: string

Plugin identifier that owns this bridge

Optionalport

port?: number

Bridge port number

OptionalqrCode

qrCode?: string

QR code payload for commissioning

OptionalserialNumber

serialNumber?: string

Device serial number

status

status: MatterBridgeStatus

Current operational status

type

type: "matter"

Bridge type identifier (always 'matter')

Optionalusername

username?: string

Bridge username/identifier

Settings

Member Visibility

  • Inherited

ThemeOSLightDark

On This Page

Properties commissioneddeviceCountidentifiermanuallyStoppedmanualPairingCodenamepidpluginportqrCodeserialNumberstatustypeusername