Type Alias CommissioningOptions

CommissioningOptions: {
    adminVendorId?: VendorId;
    regulatoryCountryCode: string;
    regulatoryLocation: GeneralCommissioning.RegulatoryLocationType;
    threadNetwork?: {
        networkName: string;
        operationalDataset: string;
    };
    wifiNetwork?: {
        wifiCredentials: string;
        wifiSsid: string;
    };
}

User specific options for the Commissioning process

Type declaration

  • OptionaladminVendorId?: VendorId

    The vendor ID we present as a commissioner.

  • regulatoryCountryCode: string

    The country where the device is used.

  • regulatoryLocation: GeneralCommissioning.RegulatoryLocationType

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

  • OptionalthreadNetwork?: {
        networkName: string;
        operationalDataset: string;
    }

    If the device should connect to a thread network.

    • networkName: string
    • operationalDataset: string
  • OptionalwifiNetwork?: {
        wifiCredentials: string;
        wifiSsid: string;
    }

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

    • wifiCredentials: string
    • wifiSsid: string

Settings

Member Visibility