Interface CommissioningOptions

Options that control commissioning.

interface CommissioningOptions {
    discoveryCapabilities?: TypeFromPartialBitSchema<{
        ble: BitFlag;
        onIpNetwork: BitFlag;
    }>;
    fabric?: Fabric;
    fabricAuthority?: FabricAuthority;
    nodeId?: NodeId;
    passcode: number;
}

Properties

discoveryCapabilities? fabric? fabricAuthority? nodeId? passcode

Properties

OptionaldiscoveryCapabilities

discoveryCapabilities?: TypeFromPartialBitSchema<{
    ble: BitFlag;
    onIpNetwork: BitFlag;
}>

Discovery capabilities to use for discovery. These are included in the QR code normally and defined if BLE is supported for initial commissioning.

Type declaration

  • ble: BitFlag

    Device supports BLE for discovery when not commissioned.

  • onIpNetwork: BitFlag

    Device is already on the IP network.

Optionalfabric

fabric?: Fabric

The fabric the joins upon commissioning. Defaults to the default fabric of the assigned FabricAuthority.

OptionalfabricAuthority

fabricAuthority?: FabricAuthority

The authority controlling the commissioning fabric. Defaults to the FabricAuthority of the local environment.

OptionalnodeId

nodeId?: NodeId

The ID to assign the node during commissioning. By default the node receives the next available ID.

passcode

passcode: number

The device's passcode.

Settings

Member Visibility

On This Page

Properties