Understanding message formatter and message handler
In the Zoho IoT application, data sent from the gateway/smart device can be enhanced further. This includes decoding raw payload into a usable JSON format and performing additional computations and enrich by calling external API's. This is achieved using the Message Formatter and Message Handler.
Message Formatter
Payloads sent by the device can be of any format. These formats need to be converted to readable values in the form of JSON to be further processed in the application. Zoho IoT applications provide the option to include a decoder as an uplink message formatter for a device product.
Note: Message formatting is supported for LoRa node devices connected using LoRa datastreams.Message formatters are predefined for some sensors showcased in the device product gallery, and there is no limit for its usage. For other sensors, users can implement their own formatter using custom functions. Please note, the number of executions for decoding with custom function is limited. To enable unrestricted decoding executions directly within the Zoho IoT application, please contact our support team at support@zohoiot.com.
Note: Custom functions for uplink handler i.e the decoder supports JavaScript Lite.For example, consider the Milesight AM103 device that sends payloads in Hexadecimal format. The uplink message formatter linked to the AM103 device product will decode the hex message as given below:
Here, the device sends the payload in the hexadecimal format:
017564 03671801 04686D 077DC501
The Output of the formatter will be:
{
"battery": 100,
"co2": 453,
"temperature": 28,
"humidity": 54.5
}
"battery": 100,
"co2": 453,
"temperature": 28,
"humidity": 54.5
}
Here is a sample code used as a decoder.
This JSON object is then used by the Zoho IoT application to process further like parse the values for the configured datapoints, etc.
The maximum processing time for functions is 2 seconds. For further details, please contact support@zohoiot.com.
Message Handler
After a message is received and formatted(optional), complex computations can be performed, and external APIs can be called if needed and enrich the received data using message handler. Zoho IoT applications provide the option to include a message handler for a device model/device instance.
Note: The message handler can use a custom function written in the Deluge language, and the payload received by the message handler must be a JSON payload.For example, based on the temperature data received from the AM103 device, you can call a weather API to get the external temperature. Next, calculate the delta value between the internal room temperature and the external temperature, and add the new value to the JSON payload.
Input Payload for message handler:
{
temp_c : 27
}
Output Payload by message handler:
{
temp_c : 27,
temp_out : 40
temp_del : 13
}
The maximum processing time for functions is 2 seconds. For further details, please contact support@zohoiot.com.
Message Handler Model and Instance Customization
A message handler can be defined for a device model, and all devices created from this model will utilize the specified message handler. If a particular device instance needs a different handler, users have the option to override the default model message handler.
Learn more about working with message handlers.
Fair Usage Policy
The fair usage policy outlines the limitations on Message Handler and Message Formatter functions across all editions of the application. This is to ensure balanced system performance. These limits apply individually to each registered device rather than to the application as a whole.
Feature | Function Processing Time | Time Window | Max Request allowed |
Message Handler | 500ms | 2 hours | 75 |
Message Formatter | 50ms | 2 hours | 35 |
For more details, contact support@zohoiot.com.
See Also
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:
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Writer?
Create. Review. Publish.
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?
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
Adding a Message Handler through a Device Instance
A message handler custom function can be added through a device instance in the end application. To add a message handler through a device, Access the End Application. Select Devices > Devices in the left pane. Click on the name of the device for ...Understanding Devices
In Zoho IoT applications, a device represents a real world entity that can be a gateway, a smart device, a sensor, or even a virtual service/system application that needs to be managed and monitored. Devices in the application are the essential ...Message Handler Custom Function
When data is received from endpoints such as gateways or smart devices in the Zoho IoT application, you can use a message handler to perform additional processing. This includes running complex computations, calling external APIs, and enriching the ...Testing a Message Handler Custom Function
While creating a message handler custom function, you can test the function to see if the desired output is received. For testing, you can provide the expected value and see if the expected output value is obtained. For the message handler custom ...Understanding Custom Functions
Custom functions in Zoho IoT allow you to extend the platform's capabilities. These functions are written using various programming languages and are easy to construct. With custom functions, users can move beyond the default offerings of the ...
New to Zoho LandingPage?
Zoho LandingPage Resources