Testing State Memory Enabled Message Handler Custom Function
With state memory enabled, you can store values that can be used in successive messages to handle the incoming messages. We will go through a sample code to understand how state memory works while creating a custom function.
- headerMap = header.toMap();
- deviceid = headerMap.get("deviceid");
- receivedtime = headerMap.get("occurred_timestamp")
- topic = headerMap.get("topic");
- communication_status_flag = headerMap.get("data_internal");
- state_memory = headerMap.get("state_memory");
- if(state_memory == null)
{
state_memoryMap = Map();
}
else
{
state_memoryMap = state_memory.toMap();
}
if(communication_status_flag == false && topic == "telemetry") { payload = message.toMap(); if(payload.containKey("data")) { deviceMessage = payload.get("data"); } else { deviceMessage = payload; } } else if(communication_status_flag == true) { deviceMessage = Map(); } - //Logic
current_energy = deviceMessage.get('energy_consumed');
last_month_energy = state_memoryMap.get('previous_energy');
if(state_memoryMap.containKey('previous_energy'))
{
total_energy = current_energy + last_month_energy; deviceMessage.put("energy_consumed", total_energy); state_memoryMap.put('previous_energy', total_energy); } else { state_memoryMap.put('previous_energy', current_energy); } - //Prepare output output = Map(); output.put("device_message",deviceMessage); state_memory_string = state_memoryMap.toString(); output.put("state_memory",state_memory_string); return output;
This sample code is designed to manage energy data from an energy meter. It operates by storing monthly energy consumption data in state memory. Whenever a new data message is received, the code adds this new consumption value to the existing data stored in state memory. Subsequently, it publishes the updated total and then saves this new total back to the state memory for future use.
We will test functionality of this code under two conditions: with and without a pre-existing value in the state memory.
For these tests, the payload has the key "energy_consumed", and the state memory stores the cumulative energy data under the key "previous_energy".
First, we will test without any value stored in the state memory to assess how the code handles the absence of pre-existing data. This will verify the code’s initialization process and its ability to start accumulating data from scratch.
- Click Save and Execute in the top right.
- Select Device Message in the Message Type field.
- Provide the input {'energy_consumed':100} in the Message field.
- Click Save.
On executing without a value for state memory, the output will display "energy_consumed: 100" and "previous_energy: 100." This outcome occurs because, assuming this is the first message, no previous data exists in the state memory. Therefore, the received value is treated as the initial total consumed energy. This value is then updated and stored as "previous_energy" in the state memory, ready to be utilized for calculations with the next incoming message.
Next, we will test the code with a predefined value in the state memory to see how the code performs. This will help us confirm that the state memory value is correctly utilized when the code is executed
- Click Save and Execute in the top right.
- Select Device Message in the Message Type field.
- Provide the input {'energy_consumed':114} in the Message field.
- Provide the input {'previous_energy': 233} in the State Memory filed.
- Click Save.
On executing the code with an existing state memory value, you will observe that the output displays the total energy consumed as 347. This same value is then updated in the state memory. This output results from the current energy consumed being added to the "previous_energy" value stored in state memory. This test confirms the functionality of the code in accumulating energy usage over time by continuously updating the state memory with the new totals.
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 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
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 ...Creating a Message Handler
A message handler can be created in a Zoho IoT application by selecting "Message Handler" in the Category field while creating a custom function. Configuring the fields while creating a message handler Language: Deluge is the supported language for ...Specifications of message handler (deluge script)
A message handler custom function can be used to enrich the data sent by the connected device. The custom function is written using the deluge scripting language. In this document, we provide a sample code to demonstrate how a message handler ...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 ...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 ...
New to Zoho LandingPage?
Zoho LandingPage Resources