Interface CommissioningOptions

General commissioning options.

interface CommissioningOptions {
    adminVendorId?: VendorId;
    fabric: Fabric;
    finalizeCommissioning?: ((peerAddress: PeerAddress, discoveryData?: DiscoveryData) => Promise<void>);
    nodeId?: NodeId;
    passcode: number;
    regulatoryCountryCode?: string;
    regulatoryLocation?: GeneralCommissioning.RegulatoryLocationType;
    threadNetwork?: {
        networkName: string;
        operationalDataset: string;
    };
    wifiNetwork?: {
        wifiCredentials: string;
        wifiSsid: string;
    };
}

Hierarchy (view full)

Properties

adminVendorId? fabric finalizeCommissioning? nodeId? passcode regulatoryCountryCode? regulatoryLocation? threadNetwork? wifiNetwork?

Properties

OptionaladminVendorId

adminVendorId?: VendorId

The vendor ID we present as a commissioner.

fabric

fabric: Fabric

The fabric into which to commission.

OptionalfinalizeCommissioning

finalizeCommissioning?: ((peerAddress: PeerAddress, discoveryData?: DiscoveryData) => Promise<void>)

Commissioning completion callback

This optional callback allows the caller to complete commissioning once PASE commissioning completes. If it does not throw, the commissioner considers commissioning complete.

OptionalnodeId

nodeId?: NodeId

The node ID to assign (the commissioner assigns a random node ID if omitted)

passcode

passcode: number

Passcode to use for commissioning.

OptionalregulatoryCountryCode

regulatoryCountryCode?: string

The country where the device is used.

OptionalregulatoryLocation

regulatoryLocation?: GeneralCommissioning.RegulatoryLocationType

The regulatory location (indoor or outdoor) where the device is used.

OptionalthreadNetwork

threadNetwork?: {
    networkName: string;
    operationalDataset: string;
}

If the device should connect to a thread network.

OptionalwifiNetwork

wifiNetwork?: {
    wifiCredentials: string;
    wifiSsid: string;
}

Required credentials if the device is to connect to a wifi network provide the credentials here.

Settings

Member Visibility

On This Page

Properties