Overview

Introduction

FunctionGraph can be utilized to convert binary data into JSON data or vice versa. This feature is used when the device has limited capabilities and can only report basic binary data. FunctionGraph supports Node.js, Python, Java, Go, C#, PHP, Cangjie, and custom runtimes, meeting multiple development requirements. You can check run logs and graphical monitoring data in real time, greatly improving development and debugging efficiency.

• FunctionGraph hosts and computes event-driven functions in a serverless context while ensuring high reliability, high scalability, and zero maintenance. All you need to do is write your code and set conditions.
• For details about FunctionGraph billing, see FunctionGraph Billing Overview. You pay only for what you use and you are not charged when your code is not running.

Process

Communications with FunctionGraph Through APIs

IoTDA Product Model Data Format

Data Decoding Format

{
     "status": 200,
     "message": "${Decoded JSON data}"
 }

${Decoded JSON data} is in the JSON format required by the platform.

• Device reporting properties

  1 2 3 4 5 6 7 8 9 10

  { "msg_type": "properties_report", "services": [{ "service_id": "Battery", "properties": { "batteryLevel": 57 }, "event_time": "20151212T121212Z" }] }

  Table 6 Data format of device reporting properties

  Parameter	Mandatory	Type	Description
  Message Type	Yes	String	Message type. The value is fixed to properties_report.
  services	Yes	List<ServiceProperty>	List of device services. For details, see the ServiceProperty structure table.

  Table 7 ServiceProperty structure

  Parameter	Mandatory	Type	Description
  service_id	Yes	String	Service ID of the device.
  properties	Yes	Object	Service properties, which are defined in the product model associated with the device.
  event_time	No	String	UTC time when the device collects data. The format is yyyyMMddTHHmmssZ, for example, 20161219T114920Z. If this parameter is not carried in the reported data or is in incorrect format, the time when the platform receives the data is used.

• Responding to the Platform for Property Setting

  1 2 3 4 5 6

  { "msg_type": "properties_set_response", "request_id": "42aa08ea-84c1-4025-a7b2-c1f6efe547c2", "result_code": 0, "result_desc": "success" }

  Table 8 Data format of device returning a response to the platform for property setting

  Parameter	Mandatory	Type	Description
  Message Type	Yes	String	Message type. Fixed value: properties_set_response
  request_id	No	String	Unique identifier of the request. If this parameter is carried in a message received by a device, the parameter value must be carried in the response sent to the platform. If the decoded message does not contain this field, the value of request_id in the topic is used.
  result_code	No	Integer	Execution result. 0 indicates success, and other values indicate failure. If this parameter is not carried, the execution is considered successful.
  result_desc	No	String	Description of the property setting response.

• Responding to the Platform for Property Query

  1 2 3 4 5 6 7 8 9 10 11 12 13 14

  { "msg_type": "properties_get_response", "request_id": "42aa08ea-84c1-4025-a7b2-c1f6efe547c2", "services": [ { "service_id": "analog", "properties": { "PhV_phsA": "1", "PhV_phsB": "2" }, "event_time": "20190606T121212Z" } ] }

  Table 9 Data format of device returning a response to the platform for property query

  Parameter	Mandatory	Type	Description
  Message Type	Yes	String	The value is fixed at properties_get_response.
  request_id	No	String	Unique identifier of the request. If this parameter is carried in a message received by a device, the parameter value must be carried in the response sent to the platform. If the decoded message does not contain this field, the value of request_id in the topic is used.
  services	Yes	List<ServiceProperty>	List of device services. For details, see the ServiceProperty structure table.

  Table 10 ServiceProperty structure

  Parameter	Mandatory	Type	Description
  service_id	Yes	String	Service ID of the device.
  properties	Yes	Object	Service properties, which are defined in the product model associated with the device.
  event_time	No	String	UTC time when the device collects data. The format is yyyyMMddTHHmmssZ, for example, 20161219T114920Z. If this parameter is not carried in the reported data or is in incorrect format, the time when the platform receives the data is used.

• Responding to the Platform for Command Delivery

  1 2 3 4 5 6 7 8 9 10

  { "msg_type": "command_response", "request_id": "42aa08ea-84c1-4025-a7b2-c1f6efe547c2", "result_code": 0, "command_name": "ON_OFF", "service_id": "WaterMeter", "paras": { "value": "1" } }

  Table 11 Data format of device returning a command response

  Parameter	Mandatory	Type	Description
  Message Type	Yes	String	The value is fixed at command_response.
  request_id	No	String	Unique identifier of the request. If this parameter is carried in a message received by a device, the parameter value must be carried in the response sent to the platform. If the decoded message does not contain this field, the value of request_id in the topic is used.
  result_code	No	Integer	Execution result. 0 indicates success, and other values indicate failure. If this parameter is not carried, the execution is considered successful.
  response_name	No	String	Response name, which is defined in the product model associated with the device.
  paras	No	Object	Response parameters, which are defined in the product model associated with the device.

• Device Reporting Messages

  1 2 3 4

  { "msg_type": "message_up", "content": "hello" }

  Table 12 Data format of device reporting messages

  Parameter	Mandatory	Type	Description
  Message Type	Yes	String	The value is fixed at message_up.
  content	No	String	Message content.

Data Encoding Format

{
    "codecType": "encode",
    "message": "${JSON data sent from the platform to FunctionGraph}"
}

${JSON data sent from the platform to FunctionGraph} is the JSON data sent by the platform to FunctionGraph before encoding.

• Platform delivering commands

  1 2 3 4 5 6 7 8 9

  { "msg_type": "commands", "request_id": "42aa08ea-84c1-4025-a7b2-c1f6efe547c2", "command_name": "ON_OFF", "service_id": "WaterMeter", "paras": { "value": 1 } }

  Table 13 Data format of platform delivering commands

  Parameter	Mandatory	Type	Description
  Message Type	Yes	String	The value is fixed at commands.
  request_id	Yes	String	Unique ID of a request. The ID is delivered to the device through a topic.
  service_id	No	String	Service ID of the device.
  command_name	No	String	Command name, which is defined in the product model associated with the device.
  paras	No	Object	Command execution parameters, which are defined in the product model associated with the device.

• Platform Setting Device Properties

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

  { "msg_type": "properties_set", "request_id": "42aa08ea-84c1-4025-a7b2-c1f6efe547c2", "services": [{ "service_id": "Temperature", "properties": { "value": 57 } }, { "service_id": "Battery", "properties": { "level": 80 } } ] }

  Table 14 Data format of platform setting device properties

  Parameter	Mandatory	Type	Description
  Message Type	Yes	String	The value is fixed at properties_set.
  request_id	Yes	String	Unique identifier of the request. If this parameter is carried in a message received by a device, the parameter value must be carried in the response sent to the platform.
  services	Yes	List<ServiceProperty>	List of device services.

  ServiceProperty Structure

  Table 15 ServiceProperty structure

  Parameter	Mandatory	Type	Description
  service_id	Yes	String	Service ID of the device.
  properties	Yes	Object	Service properties, which are defined in the product model.

• Platform Querying Device Properties

  1 2 3 4 5

  { "msg_type": "properties_get", "request_id": "42aa08ea-84c1-4025-a7b2-c1f6efe547c2", "service_id": "Temperature" }

  Table 16 Data format of platform querying device properties

  Parameter	Mandatory	Type	Description
  Message Type	Yes	String	The value is fixed at properties_get.
  request_id	Yes	String	Unique ID of a request. The ID is delivered to the device through a topic.
  service_id	No	String	Service ID of the device.

• Platform Responding to Device Property Reporting (NB-IoT Devices)

  1 2 3 4 5

  { "msg_type": "properties_report_reply", "request": "213355656", "result_code": 0 }

  Table 17 Data format of platform responding to device property reporting

  Parameter	Mandatory	Type	Description
  Message Type	Yes	String	The value is fixed at properties_report_reply.
  request	No	String	Base64-encoded string of property reporting.
  result_code	No	Integer	Execution result of property reporting.
  has_more	No	Boolean	Whether a cache command exists.

• Platform Delivering Messages

  1 2 3 4

  { "msg_type": "messages", "content": "hello" }

  Table 18 Data format of platform delivering messages

  Parameter	Mandatory	Type	Description
  Message Type	Yes	String	The value is fixed at messages.
  content	No	String	Content of command delivery.