Understanding Command Key and Command Payloads
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 command key is based on the name defined during the programming of the edge device. Altering the key values can result in device malfunction or unintended behaviour.Command payload structure:
For example, consider this sample JSON payload sent to the edge device to turn on the light.
Command payload example :
Configuring Command Key
When creating a command, the command key is specified in the Command Key field. You can configure the command key in two ways: as a Direct Parsing String or as an Edge Key.
Direct Parsing String
The Direct Parsing Key refers to the key used in the JSON message's key-value pair.
For example, if "power" is entered in the Command Key field, the following JSON message will be generated when the command is executed.
Edge Key Parsing
Edge Parsing is similar to Direct String Parsing, but with an added information: the edge key specified in the edge name field of an instance (device, asset, location) is prefixed to the generated JSON message.
For instance, if "power" is used as the command key and "ac_1" as the edge name, the resulting JSON file will include the edge name to the key, forming "ac_1.power", and this payload will be sent to the edge device.
Learn More about Edge Keys.Values
Values in the JSON message are determined by the command executed. The generated value can be Boolean, Decimal, Integer, or Percentage, depending on the user's configuration of the command.
For example, consider a payload for controlling the speed of a smart fan. In this, a command uses a command key: set_speed and slider input type with the following configurations: Slider Datatype is set to percentage, the minimum value is 10%, the maximum value is 100%, and the increments are in steps of 10%. When the command is executed with the slider set at 50%, the following payload is generated:
Acknowledgement Payload
When the device receives a command from the Zoho IoT application, it must send an acknowledgement message within 10 seconds to confirm successful receipt. This acknowledgement must adhere to the following JSON structure:
A sample implementation is provided below.
The status codes corresponding to various events are listed below:
1000 : Acknowledged (Message delivered to device)
1001 : Execution Success (Command executed successfully on device)
4000 : Execution Failure (Command execution on device failed)
4001 : Method Not Found (Device does not recognize the command type)
4002 : Executing Previous Command (Device is busy processing a previous command)
4003 : Insufficient Inputs (Issues understanding the command body contents)
4004 : Device Connectivity Issues (Problem communicating with the device)
4005 : Partial Execution (Some actuators succeeded, others encountered issues)
4006 : Already in Target State (Device or actuator is already in the desired state)
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:
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
Understanding Command Widgets
Command type widgets are used to perform actions such as On/Off, control brightness or volume, etc., on managed entities. You can choose from a list of commands created in the application and associate it with the corresponding widget. These widgets ...Understanding Certificates
In any network where data communication occurs, authentication is crucial for establishing a secure and trustworthy communication channel. In Zoho IoT, Transport Layer Security (TLS) ensures that the data transmitted between the device and the server ...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 Model and Instance
A model is like a container that can be configured with different templates (datapoints, commands, alarm rules, and fields). Using this model, you can create multiple instances (devices, assets, and locations) with the same setup. Each managed entity ...Understanding Device Models
A device model serves as a blueprint and can be configured with the following : Datapoint templates Command templates Overview dashboards templates Custom fields Alarm rule templates Message Handler and Formatters Model Settings Every device created ...
New to Zoho LandingPage?
Zoho LandingPage Resources