Device Interaction Documentation

NoTourV1 Trait

Information about the device's configuration settings to read Schlage ENGAGE No Tour credentials and the actions to set them. Trait Type: Standard

Action Mutations

Note: See Overview: Device Action Lifecycle for more information on action flows.

NoTourV1SetNoTourState

Enables or disables the No Tour capability for enabled devices.

Mutation Inputs

Input Name

Description

Data Type

Nullable

deviceId	UUID of the device to which the mutation should apply	ID!	false
noTourState	The enabled/disabled state of the device's No Tour capability	enum (ENABLED or DISABLED)!	false

GQL Examples

Request Example

GraphQL

 mutation NoTourV1SetNoTourState {
    NoTourV1SetNoTourState(
      deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d", 
      traitActionArgs: { noTourState: "ENABLED" }
    ) {
      deviceId
      actionId
    }
}

Response Example

Plain text

 {
    "data": {
        "NoTourV1SetNoTourState": {
            "actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
            "deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
        }
    }
}

NoTourV1ConfigNoTour

Sets the No Tour configuration settings of the enabled device.

Action Pre-Requisites

Once the following have been met, the client may submit this action according to the linked action lifecycle flow.

Client MUST have a site set up in the Schlage ENGAGE system that supports No Tour.
Client MUST obtain the key of the Schlage ENGAGE No Tour site to which the device should be associated.
Client MUST generate a HEX string containing the SHA-256 hash of the Schlage ENGAGE siteKey value for input into the mutation.
Client MUST encrypt the Schlage ENGAGE siteKey value for input into the mutation according to the encryption requirements laid out below.
Client MUST generate a noTourDoorId and correlate it to the deviceId. The ID must be an integer from 0 to 65535 and must be unique to each device correlated to the Schlage ENGAGE siteKey (in YP or ENGAGE systems).

Site Key Encryption Requirements

Encrypt using the following public key:

Plain text

Algorithm: RSA with 4096‑bit modulus (RSA‑4096).
Padding: RSA‑OAEP with SHA‑256 and MGF1 using SHA‑256. Label = None.
Input encoding: plaintext UTF‑8 bytes of the exact value to be encrypted (no padding, case changes, or newline).
Output format: ciphertext bytes encoded as lowercase hex, no 0x prefix, no spaces/newlines. With RSA‑4096 the ciphertext is 512 bytes → 1024 hex characters.

Mutation Inputs

Input Name

Description

Data Type

Nullable

noTourDoorId	2-byte No Tour identifier associated with the device. Must be unique for all devices within a given `siteKey`.	Int (0 to 65535)!	false
noTourGroupIds	Array of integers used to assign the device to one or more groups of potentially many devices. When included in the request, the input must have an array containing 1 to 16 integers, each integer may be from 0 to 65535.	Array	true
noTourEncryptedSiteKey	Object containing the encrypted value and SHA-256 hash of the Schlage ENGAGE siteKey.	NoTourEncryptedSiteKeyObject!	false

NoTourEncryptedSiteKeyObject Fields

Field Name

Description

Data Type

Nullable

encryptedValue	The HEX string output from encrypting the Schlage ENGAGE `siteKey` (see Action Pre‑Requisites above).	HEX String (length = 1024 characters)!	false
originalDataHash	The HEX string output from encoding a SHA-256 hash of the Schlage ENGAGE `siteKey`. Used to validate that the YP decrypted value matches the original `siteKey`.	HEX String (length = 64 characters)!	false

GQL Examples

Request Example

GraphQL

 mutation NoTourV1ConfigNoTour {
    NoTourV1ConfigNoTour(
        deviceId: "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
        traitActionArgs: {
            noTourDoorId: 65535
            noTourGroupIds: [0, 65535]
            noTourEncryptedSiteKey: {
                encryptedValue: "{{encryptedSiteKey}}"
                originalDataHash: "{{SHA256Hash}}"
            }
        }
    ) {
        deviceId
        actionId
        traitName
    }
}

Response Example

Plain text

 {
    "data": {
        "NoTourV1ConfigNoTour": {
            "actionId": "7eb3629a-a1c3-49f0-89b6-2831d500ac68",
            "deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d"
        }
    }
}

Reported States

Note: See Overview: Device Reported State for more information on reported state flows.

State Definitions

noTourDoorId State

Unique 2-byte identifier associated with the device. Must be unique for all devices within a given siteKey in both the YP and Schlage ENGAGE systems.

DataType: Integer

noTourGroupIds State

Array of 1 to 16 items. Each item indicates a unique ID that assigns the device to one or more No Tour groups.

DataType: Array of Integers

noTourActiveSector State

Sector of the credential to which No Tour data is written. For Schlage ENGAGE compatibility, this is always Sector 2.

DataType: String

noTourSha256HashSiteKey State

SHA‑256 hash of the decrypted siteKey value written to the device. This can be compared to the SHA‑256 hash of the original siteKey value to confirm that the value written to the device matches the correct siteKey.

DataType: String

noTourState State

The enabled/disabled state of the device's No Tour capability.

DataType: String

noTourRemainingCredentials State

The remaining number of No Tour credentials that may be written to the device.

DataType: Integer

Device State Query GQL Examples

Request Example

Plain text

 query Device {
    device(deviceId: null) {
        traits {
            ... on NoTourV1DeviceTrait {
                name
                state {
                    noTourDoorId {
                        reported {
                            value
                        }
                    }
                    noTourGroupIds {
                        reported {
                            value
                        }
                    }
                    noTourActiveSector {
                        reported {
                            value
                        }
                    }
                    noTourSha256HashSiteKey {
                        reported {
                            value
                        }
                    }
                    noTourState {
                        reported {
                            value
                        }
                    }
                    noTourRemainingCredentials {
                        reported {
                            value
                        }
                    }
                }
            }
        }
    }
}

Response Example

Plain text

 {
    "data": {
        "device": {
            "id": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
            "traits": [
                {
                    "name": "NoTourV1",
                    "state": {
                        "noTourDoorId": {
                            "reported": {
                                "value": 65535
                            }
                        },
                        "noTourGroupIds": {
                            "reported": {
                                "value": [0, 65535]
                            }
                        },
                        "noTourActiveSector": {
                            "reported": {
                                "value": "SECTOR_2"
                            }
                        },
                        "noTourSha256HashSiteKey": {
                            "reported": {
                                "value": "{SHA256HashEncodedHexString}"
                            }
                        },
                        "noTourState": {
                            "reported": {
                                "value": "ENABLED"
                            }
                        },
                        "noTourRemainingCredentials": {
                            "reported": {
                                "value": 0
                            }
                        }
                    }
                }
            ]
        }
    }
}

Sections

NoTourV1 Trait

Action Mutations

NoTourV1SetNoTourState

Mutation Inputs

GQL Examples

Request Example

Response Example

NoTourV1ConfigNoTour

Action Pre-Requisites

Site Key Encryption Requirements

Mutation Inputs

NoTourEncryptedSiteKeyObject Fields

GQL Examples

Request Example

Response Example

Reported States

State Definitions

noTourDoorId State

noTourGroupIds State

noTourActiveSector State

noTourSha256HashSiteKey State

noTourState State

noTourRemainingCredentials State

Device State Query GQL Examples

Request Example

Response Example

On this page