Type Alias CommissioningControllerOptions

CommissioningControllerOptions: CommissioningControllerNodeOptions & {
    adminFabricId?: FabricId;
    adminFabricIndex?: FabricIndex;
    adminVendorId?: VendorId;
    autoConnect?: boolean;
    caseAuthenticatedTags?: CaseAuthenticatedTag[];
    environment?: ControllerEnvironmentOptions;
    listeningAddressIpv4?: string;
    listeningAddressIpv6?: string;
    localPort?: number;
}

Constructor options for the CommissioningController class

Type declaration

  • Optional ReadonlyadminFabricId?: FabricId

    Controller own Fabric ID used to initialize the Controller the first time and to generate the Root certificate. Cannot be changed afterward. Default: 1

  • Optional ReadonlyadminFabricIndex?: FabricIndex

    Fabric Index used to initialize the Controller the first time. Cannot be changed afterward. Default: 1

  • Optional ReadonlyadminVendorId?: VendorId

    Admin Vendor ID used for all commissioning operations. Cannot be changed afterward. Default: 0xFFF1

  • Optional ReadonlyautoConnect?: boolean

    If set to false, the controller will not connect to any device on startup. You need to use connectNode() or connect() to connect to the relevant nodes in this case. Else all nodes are connected on startup.

  • Optional ReadonlycaseAuthenticatedTags?: CaseAuthenticatedTag[]

    CASE Authenticated Tags used to initialize the Controller the first time. Cannot be changed afterward. Maximum 3 tags are supported.

  • Optional Readonlyenvironment?: ControllerEnvironmentOptions

    When used with the new API Environment set the environment here and the CommissioningServer will self-register on the environment when you call start().

  • Optional ReadonlylisteningAddressIpv4?: string

    Listening address for IPv4. By default, the interface will listen on all IPv4 addresses.

  • Optional ReadonlylisteningAddressIpv6?: string

    Listening address for IPv6. By default, the interface will listen on all IPv6 addresses.

  • Optional ReadonlylocalPort?: number

    Local port number to use for the UDP interface. By default, a random port number will be generated (strongly recommended!).

Settings

Member Visibility