homebridge
    Preparing search index...

    Interface MatterConfig

    Matter Configuration (for bridge or child bridge)

    interface MatterConfig {
        disableIpv4?: boolean;
        enabled?: boolean;
        externalsOnly?: boolean;
        name?: string;
        port?: number;
        [key: string]: unknown;
    }

    Hierarchy

    • Record<string, unknown>
      • MatterConfig

    Indexable

    • [key: string]: unknown
    Index
    disableIpv4? enabled? externalsOnly? name? port?
    disableIpv4?: boolean

    When true, matter.js mDNS runs IPv6-only — no IPv4 sockets are opened on port 5353. The Matter spec requires IPv6; IPv4 discovery is optional.

    Useful when Matter's own mDNS responder competes with avahi-daemon for IPv4 port 5353 on the same host (symptom: <hostname>.local stops resolving over IPv4 while direct IP access still works). Missing or false keeps matter.js's default dual-stack behaviour.

    enabled?: boolean

    When false, Matter is configured but not advertised — the config block and the on-disk commissioning storage are preserved, so it can be re-enabled without re-commissioning. Missing/true means enabled. This mirrors how bridge.hap.enabled: false disables HAP without losing pairing data.

    externalsOnly?: boolean

    When true, the Matter bridge node itself is NOT advertised, but plugins MAY still publish external Matter accessories (each gets its own pairing via api.matter.publishExternalAccessories). The Matter API surface (api.matter) is still made available to plugins; only the bridge aggregator is suppressed.

    Intended to be paired with enabled: false; if externalsOnly: true is set on its own, validation warns and normalises enabled to false rather than rejecting the config. Mirrors the behaviour of bridge.hap.externalsOnly.

    name?: string

    Name for the Matter bridge (optional)

    port?: number

    Port for Matter server (optional, will auto-assign if not specified)

    Settings
    Member Visibility

    On This Page
    Properties