FunctionGraph开发说明

概述

物联网平台支持使用FunctionGraph编解码的功能，根据您提交的脚本文件，实现设备二进制格式与JSON格式相互转换。常在设备能力比较弱，只能上报简单的二进制数据的设备场景下使用。FunctionGraph的函数托管计算服务支持Node.js、Python、Java、Go、C#、PHP、Cangjie和定制运行时语言，可以满足多种开发需求；具有实时查看运行日志、查看图形化监控等功能，大大的提高了开发者开发、调试效率。

• FunctionGraph是一项基于事件驱动的函数托管计算服务。使用FunctionGraph函数，只需编写业务函数代码并设置运行的条件，无需配置和管理服务器等基础设施，函数以弹性、免运维、高可靠的方式运行。
• FunctionGraph的收费标准可见：FunctionGraph函数工作流计费概述。此外，FunctionGraph按函数实际执行资源计费，不执行不产生费用。

使用流程

IoTDA+FunctionGraph通信说明（API）

IoTDA物模型数据格式

数据解码格式定义

{
     "status": 200,
     "message": "${解码后的JSON数据格式}"
 }

其中${解码后的JSON数据格式}，为平台对FunctionGraph解析后要求的JSON格式，其要求的数据格式为：

• 设备属性上报

  1 2 3 4 5 6 7 8 9 10

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

  表6 设备属性上报数据格式

  字段名	必选/可选	类型	参数描述
  msg_type	必选	String	属性上报的消息类型，固定为：properties_report。
  services	必选	List<ServiceProperty>	设备服务数据列表（具体结构参考下表ServiceProperty定义表）。

  表7 ServiceProperty结构定义

  字段名	必选/可选	类型	参数描述
  service_id	必选	String	设备的服务ID。
  properties	必选	Object	设备服务的属性列表，具体字段在设备关联的产品模型中定义。
  event_time	可选	String	设备采集数据UTC时间（格式：yyyyMMddTHHmmssZ），如：20161219T114920Z。 设备上报数据不带该参数或参数格式错误时，则数据上报时间以平台时间为准。

• 平台设置设备属性的响应消息

  1 2 3 4 5 6

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

  表8 设备属性的响应消息数据格式

  字段名	必选/可选	类型	参数描述
  msg_type	必选	String	属性上报的消息类型，固定为： properties_set_response
  request_id	可选	String	用于唯一标识这次请求，设备侧收到的消息带该参数时，响应消息需要将该参数值返回给平台。如果解码后的消息不带该字段，则以topic中带的request_id为准。
  result_code	可选	Integer	命令的执行结果，0表示成功，其他表示失败。不带默认认为成功。
  result_desc	可选	String	属性设置的响应描述。

• 平台查询设备属性的响应消息

  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" } ] }

  表9 平台查询设备属性的响应数据格式

  字段名	必选/可选	类型	参数描述
  msg_type	必选	String	固定为：properties_get_response
  request_id	可选	String	用于唯一标识这次请求，设备侧收到的消息带该参数时，响应消息需要将该参数值返回给平台。如果解码后的消息不带该字段，则以topic中带的request_id为准。
  services	必选	List<ServiceProperty>	设备服务数据列表（具体结构参考下表ServiceProperty定义表）。

  表10 ServiceProperty结构定义

  字段名	必选/可选	类型	参数描述
  service_id	必选	String	设备的服务ID。
  properties	必选	Object	设备服务的属性列表，具体字段在设备关联的产品模型中定义。
  event_time	可选	String	设备采集数据UTC时间（格式：yyyyMMddTHHmmssZ），如：20161219T114920Z。 设备上报数据不带该参数或参数格式错误时，则数据上报时间以平台时间为准。

• 平台命令下发的响应消息

  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" } }

  表11 平台命令下发数据格式

  字段名	必选/可选	类型	参数描述
  msg_type	必选	String	固定为：command_response
  request_id	可选	String	用于唯一标识这次请求，设备侧收到的消息带该参数时，响应消息需要将该参数值返回给平台。如果解码后的消息不带该字段，则以topic中带的request_id为准。
  result_code	可选	Integer	标识命令的执行结果，0表示成功，其他表示失败。不带默认认为成功。
  response_name	可选	String	命令的响应名称，在设备关联的产品模型中定义。
  paras	可选	Object	命令的响应参数，具体字段在设备关联的产品模型中定义。

• 设备消息上报

  1 2 3 4

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

  表12 设备消息上报数据格式

  字段名	必选/可选	类型	参数描述
  msg_type	必选	String	固定为：message_up
  content	可选	String	消息内容。

数据编码格式定义

{
    "codecType": "encode",
    "message": "${平台发送给FunctionGraph的JSON数据格式}"
}

其中${平台发送给FunctionGraph的JSON数据格式}，为平台发送给FunctionGraph的编码前的JSON数据，其发送的格式为：

• 平台命令下发

  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 } }

  表13 设备命令下发数据格式

  字段名	必选/可选	类型	参数描述
  msg_type	必选	String	固定为：commands
  request_id	必选	String	用于唯一标识这次请求，该标识会通过topic下发给设备。
  service_id	可选	String	设备的服务ID。
  command_name	可选	String	设备命令名称，在设备关联的产品模型中定义。
  paras	可选	Object	设备命令的执行参数，具体字段在设备关联的产品模型中定义。

• 平台设置设备属性

  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 } } ] }

  表14 平台设置设备属性数据格式

  字段名	必选/可选	类型	参数描述
  msg_type	必选	String	固定为：properties_set
  request_id	必选	String	用于唯一标识这次请求，设备侧收到的消息带该参数时，响应消息需要将该参数值返回给平台。
  services	必选	List<ServiceProperty>	设备服务数据列表。

  ServiceProperty结构定义：

  表15 ServiceProperty结构定义

  字段名	必选/可选	类型	参数描述
  service_id	必选	String	设备的服务ID。
  properties	必选	Object	设备服务的属性列表，具体字段在产品模型里定义。

• 平台查询设备属性

  1 2 3 4 5

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

  表16 平台查询设备属性数据格式

  字段名	必选/可选	类型	参数描述
  msg_type	必选	String	固定为：properties_get
  request_id	必选	String	用于唯一标识这次请求，该标识会通过topic下发给设备。
  service_id	可选	String	设备的服务ID。

• 平台响应设备属性上报（NB-IoT设备）

  1 2 3 4 5

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

  表17 平台响应设备属性上报数据格式

  字段名	必选/可选	类型	参数描述
  msg_type	必选	String	固定为：properties_report_reply
  request	可选	String	属性上报的BASE64编码字符串。
  result_code	可选	Integer	属性上报的执行结果。
  has_more	可选	Boolean	是否存在缓存命令。

• 平台消息下发

  1 2 3 4

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

  表18 设备消息下发数据格式

  字段名	必选/可选	类型	参数描述
  msg_type	必选	String	固定为：messages
  content	可选	String	消息下发的内容。