Understanding Parsing Keys and Payload Formats
Parsing keys act as identifiers in datapoint configuration.
Consider the Shelly H&T smart sensor, which monitors a room's temperature and humidity. The sensor sends data in JSON format as below:
In the Zoho IOT application, you'll use the parsing key `temp_C` to configure a datapoint called Temperature. Similarly, to create a datapoint for humidity, you'll use the parsing key `humid`.
In this scenario, given a JSON payload of `"temp_C": 37` and `"humid": 21`, the sensor reports a room temperature of 37°C and a humidity level of 21%. These values are then stored under their respective datapoints in the Zoho IOT application.
Configuring a Parsing Key
While configuring a parsing key, users have three options: Direct Parsing, Find Value (), and Edge Key Parsing. The selection of the parsing method depends on the nature/structure of the message from the device.
Direct Parsing Key
This option is used for straightforward JSON messages consisting of a simple key-value pair.
Example: For the JSON message from a room temperature monitoring device, Direct Parsing is used.
The key room_temperature is specified to create a datapoint named Temperature to capture the value from the message.
Edge Key
An Edge Key is used when a single gateway device relays information about multiple resources as objects in the JSON message.
Note: Edge Key parsing is available only in Assets and Locations.Example: For the JSON message with data on multiple diesel generators in a building, the Edge Key method is used.
To acquire the engine temperature value for the Temperature datapoint, the Edge Key option is selected and the engine_temperature key is provided.
DieselGen1, DieselGen2, and DieselGen3 are the Edge keys of the respective diesel generators; the same must be provided in the Edge Key field of each asset/location.
Learn more about how edge keys are used.findValue()
This option is suitable for more intricate JSON messages where data is nested and includes objects with detailed information.
Example: For a comprehensive JSON message from a CNC milling machine, findValue() is used.
To acquire the speed value for the Spindle Speed datapoint of CNC Machine 1 the following values are provided.
Object Name: CNC_Machine_1
Unique identification Key name
Unique Identification Value: spindle_speed
Required Value's Key: value
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Understanding Edge Keys
Edge Keys in Zoho IOT Applications ensure uniqueness to resources and their corresponding data. They help to distinguish between resources that might have similar or duplicate names in the application. This feature is important in environments where ...Understanding Command Key and Command Payload
Commands executed in Zoho IOT applications send a payload as a JSON message containing essential information. A command key within the payload enables the edge device to identify the specific command and trigger the appropriate actions. Note: This ...Understanding Expression Builder for Datapoints
Expression builders are used to create expression for computing values based on a set of available datapoints, fields, or constants and storing them as realtime or scheduled KPI datapoints. Note: Expression builder is available by default for ...Understanding Actions
In an IoT setup, you may have to trigger various actions, such as sending notification emails to relevant personnel, connecting to a third-party URL via. webhook, or executing custom business logic on certain conditions. These actions are generally ...Understanding Commands
Zoho IOT applications enable users to execute actions on connected devices, and assets/locations using commands. These commands send instructions to the devices. For example, take an air conditioning (AC) unit in a smart home system. By using a ...
New to Zoho LandingPage?
Zoho LandingPage Resources