Interface CommissioningModeInstanceData

interface CommissioningModeInstanceData {
    deviceType: number;
    discriminator: number;
    name: string;
    pairingHint?: TypeFromPartialBitSchema<{
        administrator: BitFlag;
        customInstruction: BitFlag;
        deviceManual: BitFlag;
        deviceManufacturerUrl: BitFlag;
        powerCycle: BitFlag;
        pressResetButton: BitFlag;
        pressResetButtonForNumberOfSecondsWithApplicationOfPower: BitFlag;
        pressResetButtonNumberOfTimes: BitFlag;
        pressResetButtonUntilLightBlinks: BitFlag;
        pressResetButtonUntilLightBlinksWithApplicationOfPower: BitFlag;
        pressResetButtonWithApplicationOfPower: BitFlag;
        pressRestButtonForNumberOfSeconds: BitFlag;
        pressSetupButton: BitFlag;
        pressSetupButtonForNumberOfSeconds: BitFlag;
        pressSetupButtonForNumberOfSecondsWithApplicationOfPower: BitFlag;
        pressSetupButtonNumberOfTimes: BitFlag;
        pressSetupButtonUntilLightBlinks: BitFlag;
        pressSetupButtonUntilLightBlinksWithApplicationOfPower: BitFlag;
        pressSetupButtonWithApplicationOfPower: BitFlag;
        settingsMenuOnNode: BitFlag;
    }>;
    pairingInstructions?: string;
    productId: number;
    sessionActiveInterval?: number;
    sessionActiveThreshold?: number;
    sessionIdleInterval?: number;
    vendorId: VendorId;
}

Hierarchy (view full)

Properties

deviceType discriminator name pairingHint? pairingInstructions? productId sessionActiveInterval? sessionActiveThreshold? sessionIdleInterval? vendorId

Properties

ReadonlydeviceType

deviceType: number

The device type for commissioning announcements.

discriminator

discriminator: number

Device discriminator for commissionable announcements.

Readonlyname

name: string

The device name for commissioning announcements.

OptionalpairingHint

pairingHint?: TypeFromPartialBitSchema<{
    administrator: BitFlag;
    customInstruction: BitFlag;
    deviceManual: BitFlag;
    deviceManufacturerUrl: BitFlag;
    powerCycle: BitFlag;
    pressResetButton: BitFlag;
    pressResetButtonForNumberOfSecondsWithApplicationOfPower: BitFlag;
    pressResetButtonNumberOfTimes: BitFlag;
    pressResetButtonUntilLightBlinks: BitFlag;
    pressResetButtonUntilLightBlinksWithApplicationOfPower: BitFlag;
    pressResetButtonWithApplicationOfPower: BitFlag;
    pressRestButtonForNumberOfSeconds: BitFlag;
    pressSetupButton: BitFlag;
    pressSetupButtonForNumberOfSeconds: BitFlag;
    pressSetupButtonForNumberOfSecondsWithApplicationOfPower: BitFlag;
    pressSetupButtonNumberOfTimes: BitFlag;
    pressSetupButtonUntilLightBlinks: BitFlag;
    pressSetupButtonUntilLightBlinksWithApplicationOfPower: BitFlag;
    pressSetupButtonWithApplicationOfPower: BitFlag;
    settingsMenuOnNode: BitFlag;
}>

Pairing hint of the device for commissionable announcements.

Type declaration

  • administrator: BitFlag

    The Device has been commissioned. Any Administrator that commissioned the device provides a user interface that may be used to put the device into Commissioning Mode.

  • customInstruction: BitFlag

    The PI key/value pair describes a custom way to put the Device into Commissioning Mode. This Custom Instruction option is NOT recommended for use by a Device that does not have knowledge of the user’s language preference.

  • deviceManual: BitFlag

    The Device Manual provides special instructions to put the Device into Commissioning Mode (see Section 11.22.5.8, “UserManualUrl”). This is a catch-all option to capture user interactions that are not codified by other options in this table.

  • deviceManufacturerUrl: BitFlag

    This SHALL be set to 1 for devices requiring Custom Commissioning Flow before they can be available for Commissioning by any Commissioner. For such a flow, the user SHOULD be sent to the URL specified in the CommissioningCustomFlowUrl of the DeviceModel schema entry indexed by the Vendor ID and Product ID (e.g., as found in the announcement) in the Distributed Compliance Ledger.

  • powerCycle: BitFlag

    The Device will automatically enter Commissioning Mode upon power cycle (unplug/re- plug, remove/re-insert batteries). This bit SHALL be set to 1 for devices using Standard Commissioning Flow, and set to 0 otherwise.

  • pressResetButton: BitFlag

    The Device will enter Commissioning Mode when reset button is pressed.

  • pressResetButtonForNumberOfSecondsWithApplicationOfPower: BitFlag

    The Device will enter Commissioning Mode when reset button is pressed for N seconds when applying power to it. The exact value of N SHALL be made available via PI key.

  • pressResetButtonNumberOfTimes: BitFlag

    The Device will enter Commissioning Mode when reset button is pressed N times with maximum 1 second between each press. The exact value of N SHALL be made available via PI key.

  • pressResetButtonUntilLightBlinks: BitFlag

    The Device will enter Commissioning Mode when reset button is pressed until associated light blinks. Information on color of light MAY be made available via PI key (see Note 1).

  • pressResetButtonUntilLightBlinksWithApplicationOfPower: BitFlag

    The Device will enter Commissioning Mode when reset button is pressed until associated light blinks when applying power to the Device. Information on color of light MAY be made available via PI key (see Note 1).

  • pressResetButtonWithApplicationOfPower: BitFlag

    The Device will enter Commissioning Mode when reset button is pressed when applying power to it.

  • pressRestButtonForNumberOfSeconds: BitFlag

    The Device will enter Commissioning Mode when reset button is pressed for N seconds. The exact value of N SHALL be made available via PI key.

  • pressSetupButton: BitFlag

    The Device will enter Commissioning Mode when setup button is pressed.

  • pressSetupButtonForNumberOfSeconds: BitFlag

    The Device will enter Commissioning Mode when setup button is pressed for N seconds. The exact value of N SHALL be made available via PI key.

  • pressSetupButtonForNumberOfSecondsWithApplicationOfPower: BitFlag

    The Device will enter Commissioning Mode when setup button is pressed for N seconds when applying power to it. The exact value of N SHALL be made available via PI key.

  • pressSetupButtonNumberOfTimes: BitFlag

    The Device will enter Commissioning Mode when setup button is pressed N times with maximum 1 second between each press. The exact value of N SHALL be made available via PI key.

  • pressSetupButtonUntilLightBlinks: BitFlag

    The Device will enter Commissioning Mode when setup button is pressed until associated light blinks. Information on color of light MAY be made available via PI key (see Note 1).

  • pressSetupButtonUntilLightBlinksWithApplicationOfPower: BitFlag

    The Device will enter Commissioning Mode when setup button is pressed until associated light blinks when applying power to the Device. Information on color of light MAY be made available via PI key (see Note 1).

  • pressSetupButtonWithApplicationOfPower: BitFlag

    The Device will enter Commissioning Mode when setup button is pressed when applying power to it.

  • settingsMenuOnNode: BitFlag

    The settings menu on the Device provides instructions to put it into Commissioning Mode.

OptionalpairingInstructions

pairingInstructions?: string

Pairing instruction of the device for commissionable announcements.

ReadonlyproductId

productId: number

The product ID for commissioning announcements.

OptionalsessionActiveInterval

sessionActiveInterval?: number

Session Active Interval of the device for commissionable announcements.

OptionalsessionActiveThreshold

sessionActiveThreshold?: number

Duration of time the node should stay active after the last network activity. *

OptionalsessionIdleInterval

sessionIdleInterval?: number

Session Idle Interval of the device for commissionable announcements.

ReadonlyvendorId

vendorId: VendorId

The vendor ID for commissioning announcements.

Settings

Member Visibility

On This Page

Properties