@qualithm/device - v0.12.2
    Preparing search index...

    Type Alias ProvisioningServerOptions

    Options for constructing a ProvisioningServer.

    type ProvisioningServerOptions = {
        accessPoint?: AccessPointController;
        deviceName?: string;
        exchange?: ClaimExchange;
        homeNetwork?: HomeNetworkController;
        host?: string;
        onError?: (error: Error) => void;
        onProvisioned?: (credential: DeviceCredential) => void | Promise<void>;
        port?: number;
        provisioningUrl: string;
        store: CredentialStore;
    }
    Index

    Properties

    accessPoint? deviceName? exchange? homeNetwork? host? onError? onProvisioned? port? provisioningUrl store

    Properties

    accessPoint?: AccessPointController

    Setup access point lifecycle hook, supplied by the deployment.

    deviceName?: string

    Human-friendly device name advertised by GET /provision/info.

    exchange?: ClaimExchange

    Claim exchange override. Defaults to claimDevice.

    homeNetwork?: HomeNetworkController

    Home network hook, supplied by the deployment. Without it the device claims over the setup network and refuses claims that carry Wi-Fi details.

    host?: string

    Interface to listen on. Defaults to "0.0.0.0" (the setup network).

    onError?: (error: Error) => void

    Called when the post-claim teardown or onProvisioned itself fails.

    onProvisioned?: (credential: DeviceCredential) => void | Promise<void>

    Called after a successful claim has been persisted and the server and access point have stopped. This is where the deployment proceeds to Device.connect().

    port?: number

    Port to listen on. Defaults to 80; pass 0 for an ephemeral port.

    provisioningUrl: string

    Provisioning API base URL, e.g. https://api.qualithm.com.

    store: CredentialStore

    Where the claimed credential is persisted.

    Settings

    Member Visibility

    On This Page

    Properties