WiFi_Tutorial_Using JSON and Schema

Using JSON?

ENGAGE uses JSON to send information to and from devices.

Detailed JSON Information

Generic JSON information can be found here: http://www.json.org/

A JSON Schema is provided below to verify that JSON sent to and from the lock meet the interface requirements for device communication.

Using Schema?

ENGAGE uses schema to define the interface for how the device communicates.

How to Get an Allegion Schema

Download the Allegion Schema zip folder. The zip folder contains the Schema definitions to create a specific schema file that is focused for 1 particular lock and data structure. To create the schema file, you will need to run these files in python code. Allegion uses PyCharm as their IDE for this tool. Please note that there are steps for setting up the schema tool. Please look through the readme file given in the zip folder.

(zip folder placeholder: put link here)

Enter settings to create Schema

device = 'NDE'              # Enter Device Model Type as a string (NDE, LE, SC, RMRU, CTE)
json_structure = 'DB'       # Enter Data Structure as a string (DB, CONFIG, AUDITS, ALERTS)
direction = 'INCOMING'      # Enter Message Direction as a string (INCOMING, OUTGOING)

For more detailed information on schema, refer to the ENGAGE - SAM API Integration document.