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

    Type Alias DeviceOptions

    Options for constructing a Device.

    type DeviceOptions = {
        broker?: BrokerOptions;
        capabilities: [CapabilityDeclaration, ...CapabilityDeclaration[]];
        claimCode?: string;
        keepaliveSeconds?: number;
        name?: string;
        provisioningUrl: string;
        reconnectPeriodMs?: number;
        store?: CredentialStore;
    }
    Index

    Properties

    broker? capabilities claimCode? keepaliveSeconds? name? provisioningUrl reconnectPeriodMs? store?

    Properties

    broker?: BrokerOptions

    MQTT gateway connection settings. The host defaults to the broker returned at enrollment.

    capabilities: [CapabilityDeclaration, ...CapabilityDeclaration[]]

    Capabilities the device declares to the platform, published as a manifest on every connect. Required, with at least one entry: a device that declares nothing sends data no dashboard or automation can use. A missing, empty or invalid list throws a CapabilityError from the constructor.

    claimCode?: string

    One-time claim code, used only on first boot when no credential is stored.

    keepaliveSeconds?: number

    Keep-alive interval in seconds. Defaults to 60.

    name?: string

    Optional human-friendly device name set at claim time.

    provisioningUrl: string

    Provisioning API base URL for the device's environment, e.g. https://api.qualithm.com.

    reconnectPeriodMs?: number

    Reconnect backoff base in milliseconds. Defaults to 1000. Each consecutive failure doubles the ceiling of a random wait, up to 30 s; a successful connect resets it. 0 disables reconnecting.

    store?: CredentialStore

    Where the credential is persisted. Defaults to a crash-safe file store.

    Settings

    Member Visibility

    On This Page

    Properties