WH-GM35V2 HTTP AT指令集V1.0.0

Size: px

Start display at page:

Download "WH-GM35V2 HTTP AT指令集V1.0.0"

堂邹
4 years ago
Views:

1 稳恒 HTTP AT 指令集文档版本 :V / 11

2 目录 1 范围术语定义和缩略语缩略语概述 AT 指令语法相关 HTTP 指令命令总览初始化 HTTP 服务 AT+HTTPINIT AT+HTTPTERM 终止 HTTP 服务 AT+HTTPPARA 配置 HTTP 参数的值 AT+HTTPDATA 发送 HTTP 数据 AT+HTTPSSETCRT 设置 HTTPS 证书 AT+HTTPACTION 配置 HTTP 动作方式 AT+HTTPREAD 读取 HTTP 服务器响应 AT+HTTPSTATUS 读取 HTTP 状态 HTTP 示例说明...10 联系方式免责声明更新历史 / 11

3 1 范围本规范规定了物联网领域端内设备通信的 AT 指令集其中包括使用 GM35 连接 MQTT 服务器使用的 AT 命令 2 术语定义和缩略语 2.1 缩略语下列缩略语适用于本文件缩略语英文全称中文全称 TE Terminal Equipment 终端设备 TA Terminal Adaptor 终端适配器 HTTP Hyper Text Transfer Protocol 超文本传输协议 IoT Internet Of Things 物联网 JSON JavaScript Object Notation JavaScript 对象标记格式 MQTT Message Queuing Telemetry Transport 消息队列遥测传输协议 MCU Micro Controller Unit 微控制器 MT Mobile Terminal 移动终端 TLS Transport Layer Security Protocol 安全传输层协议 URL Uniform Resource Locator 统一资源定位符 OTA Over The Air 无线下载 3 概述终端设备 (TE,Terminal Equipment) 可通过发送本标准所述的 AT 命令控制移动终端 (MT,Mobile Terminal) 功能及相关网络业务终端适配器 (TA,Terminal Adaptor) 完成终端设备与移动设备之间的命令及消息适配功能终端设备 (TE) 终端适配器 (TA) 及移动终端 (MT) 的物理实现可以是下列情况 : TE TA 和 MT 是三个独立的实体 ; TE 是独立的实体,TA 集成在 MT 内部 ; MT 是独立的实体,TA 集成在 TE 内部 ; TE TA 和 MT 集成为一个实体在本规范中,TE 认为是物联网设备的 MCU 模块,TA 集成在 MT 内部, 认为是通信模块通信模块包括但不限于 GPRS 通信模块 Wi-Fi 通信模 LoRa 通信模块终端设备 (TE) 终端适配器 (TA) 及移动终端 (MT) 的系统结构及之间建立关联的基本流程如图 1 所示终端设备及适配器间接口可使用串口线缆红外等方式图 1 系统结构图根据图 1 所示,MCU 模块与通信模块共同集成于物联网设备,MCU 通过 AT 命令与 TA 实现通信, 从而控制 MT 实现物联网设备与云端的交互 3 / 11

4 4 AT 指令语法 AT 指令采用基于 ASCII 码的命令行, 命令格式如下 : 请求消息格式为 :AT+<CMD>[OP][para-1,para-2, para-n]<\r> 表格 1 AT 请求消息格式域说明 AT+ 命令消息前缀 CMD 指令字符串 OP 指令操作符可以是以下内容 : = : 表示参数设置? : 表示查询参数的当前值 : 表示执行指令 =? : 表示查询设置指令的参数 para-1,para-2, para-n 表示设置的参数值, 是指定要查询的参数 \r 回车结束符,ASCII 码为 0x0D 回应消息格式为 :<\r\n>[+cmd:][para-1,para-2, para-n]<\r\n> :<\r\n><status><\r\n> 上述两者都有表格 2 AT 回应消息格式域说明 \n 换行符,ASCII 码为 0x0A +CMD 相应的指令字符串 para-1,para-2, para-n 表示设置的参数值, 是指定要查询的参数 STATUS 指令执行状态可以是以下内容 : : 表示指令执行成功 ERROR : 表示指令执行失败 : 表示指令执行失败, 并返回相应的错误代码注 : <>: 表示必须包含的内容 []: 表示可选的内容 \r: 回车结束符,ASCII 码为 0x0D \n: 换行符,ASCII 码为 0x0A 例如, 查询 MQTT 的连接模式, 发送指令为 : AT+WMODE?\r 回复的消息为 : \r\n+ WMODE:1\r\n \r\n\r\n 下文中为了便于阅读, 将 \r\n 隐藏 4 / 11

5 5 相关 HTTP 指令 5.1 命令总览注意 : 1) 在执行第 2~9 章中的 AT 命令之前, 应该先执行 AT+HTTPINIT 模组 HTTP 使用的 AT 指令如下 : 表格 3 连接 HTTP 平台的 AT 指令集命令描述实现方式 AT+HTTPINIT 初始化 HTTP 服务强制 AT+HTTPTERM 终止 HTTP 服务强制 AT+HTTPPARA 配置 HTTP 参数的值可选 AT+HTTPSSETCRT 设置 HTTPS 证书可选 AT+UNSUBSCRIBE 取消订阅主题可选 AT+HTTPDATA 发送 HTTP 消息可选 AT+HTTPACTION 配置 HTTP 动作方式可选 AT+HTTPREAD 读取 HTTP 服务器响应可选 5.2 初始化 HTTP 服务 AT+HTTPINIT 表格 4 初始化 HTTP 服务查询命令 AT+HTTPINIT=? +HTTPINIT 执行命令 AT+HTTPINIT 参数说明返回值说明返回代表初始化成功 <err>:error 代码, 详见 WH-GM 系列标准 AT 指令集示例 AT+HTTPINIT AT+HTTPINIT=? +HTTPINIT 注意事项 1. 此命令在激活 HTTP 服务之才能后执行 2. 此命令之前要注网之后才能执行 5.3 AT+HTTPTERM 终止 HTTP 服务表格 5 终止 HTTP 服务查询命令 AT+HTTPTERM=? +HTTPTERM 5 / 11

6 执行命令 AT+HTTPTERM 参数说明返回代表终止服务成功返回值说明 <err>:error 代码, 详见 WH-GM 系列标准 AT 指令集示例 AT+HTTPTERM AT+HTTPTERM=? +HTTPTERM 注意事项此命令在结束 HTTP 服务的时候使用 5.4 AT+HTTPPARA 配置 HTTP 参数的值表格 6 配置 HTTP 参数的值查询命令 AT+HTTPPARA=? +HTTPPARA=<HTTPParamTag>,<HTTPParamValu e> 执行命令 AT+HTTPPARA=<HTTPParamTag>, <HTTPParamValue> 参数说明 <HTTPParamTag>:HTTP 参数名称 : 返回值说明参数列表 : CID:( 必填参数 ) 承载概要标识符 URL:( 必填参数 )HTTP 客户端 URL tcpport : 默认值为 80 IETF-RFC2616 UA: 用户代理字符串, 由应用程序设置以标识移动设备通常设置这个参数作为操作系统和软件版本信息默认值是 RDA8955 PROIP: 代理服务器 IP 地址 PROPORT: 代理服务器端口号 REDIR: 当 RDA8955 充当 HTTP 客户机时, 此标志控制其重定向机制 ( 数字 ) 如果服务器发送重定向代码 ( 范围 30x), 当标志设置为 1 时客户端将自动发送一个新的 HTTP 请求 BREAK: 参数用于 HTTP 方法 GET, 用于恢复损坏的传输 BREAKEND: 参数用于 HTTP 方法 GET, 用于恢复损坏的传输与 BREAK 一起使用, 如果 BREAKEND 的值大于 BREAK, 则传输范围为从 BREAK 到 BREAKEND 如果 BREAKEND 的值小于 BREAK 传输范围是从 BREAK 到文件末尾 TIMEOUT: 会话超时值, 作用域 : 秒, 默认值 120 秒如果 BREAKEND 和 BREAK 都为 0, 恢复损坏传输的函数将不能使用 HTTP 参数值类型和支持的内容取决于相关的 <HTTPParamTag> CONTENT: 用于设置 HTTP 报头中的内容类型字段 USERDATA: 用户数据 6 / 11

7 示例 <HTTPParamValue>:HTTP 参数值类型和支持的内容取决于相关的 <HTTPParamTag>. <err>:error 代码, 详见 WH-GM 系列标准 AT 指令集 AT+HTTPPARA= CID, 1 1. 此命令必须在 AT+HTTPINIT 之后执行 2. 并不是所有得服务器都支持 BREAK 和 BREAKEND 参数设置 5.5 AT+HTTPDATA 发送 HTTP 数据表格 7 发送 HTTP 数据查询命令 AT+HTTPDATA=? +HTTPDATA 或执行命令 AT+HTTPDATA > 参数说明 > 表示命令执行成功, 后面接需要发送得数据, 使用 CTRL+Z 来结束返回值说明 <err>:error 代码, 详见 WH-GM 系列标准 AT 指令集示例 AT+HTTPDATA > 注意事项需要在 AT+HTTPINIT 之后执行 5.6 AT+HTTPSSETCRT 设置 HTTPS 证书表格 8 设置 HTTPS 证书查询命令 AT+HTTPSSETCRT=? +HTTPSSETCRT= <crtflag> 执行命令 AT+AUTOSUB=<mode>,<topic>,<qos> <response_data> 参数说明返回值说明 <crtflag>: 0 设置 CA 证书 1 设置客户端证书 2 设置客户端私有秘匙 <err> :error 代码, 详见 WH-GM 系列标准 AT 指令集示例 AT+ HTTPSSETCRT= 0 注意事项执行此命令后, 需要处理 AT+HTTPDATA 来完成 CRT 设置 5.7 AT+HTTPACTION 配置 HTTP 动作方式表格 9 配置 HTTP 动作方式查询命令 AT+HTTPACTION=? 7 / 11

8 HTTPACTION=<method_code> 执行命令 AT+HTTPACTION=<method_code> method_code>,<status_code>, <content_length> 参数说明 <method_code> : 返回值说明 HTTP 方式 : 0 GET 1 POST 2 HEAD 3 DELETE 4 DELETE(for onenet) 5 PUT(for onenet) <status_code> : 远程服务器响应的 HTTP 状态代码 101 Switching Protocols Created 202 Accepted 203 Non-Authoritative Information 204 No Content 205 Reset Content 206 Partial Content 300 Multiple Choices 301 Moved Permanently 302 Found 303 See Other 304 Not Modified 305 Use Proxy 307 Temporary Redirect 400 Bad Request 401 Unauthorized 402 Payment Required 403 Forbidden 404 Not Found 405 Method Not Allowed 406 Not Acceptable 407 Proxy Authentication Required 408 Request Time-out 409 Conflict 410 Gone 411 Length Required 412 Precondition Failed 413 Request Entity Too Large 414 Request-URI Too Large 415 Unsupported Media Type 416 Requested range not satisfiable 417 Expectation Failed 500 Internal Server Error 501 Not Implemented 502 Bad Gateway 503 Service Unavailable 504 Gateway Time-out 505 HTTP Version not supported 600 Not HTTP PDU 601 Network Error 602 No memory 603 DNS Error 604 Stack Busy <content_length> : 远程服务器响应 HTTP content_length <err> :error 代码, 详见 WH-GM 系列标准 AT 指令集示例 AT+HTTPACTION=0 0,200,10 注意事项 1. 在这个命令执行前, 必须要执行 AT+HTTPPARA 2. 除了方式 GET 之外, 其他方式的 <content_length> 都为 0 8 / 11

9 5.8 AT+HTTPREAD 读取 HTTP 服务器响应表格 10 读取 HTTP 服务器响应查询命令 AT+HTTPREAD=? AT+HTTPREAD=<data_len>,<byte_size > 执行命令 AT+HTTPREAD=<start_address>,<byte_size> +HTTPREAD:<data_len>,<data> 参数说明 <start_address>: 数据输出的起点字节返回值说明 <byte_size>: 数据输出的长度字节 <data_len>: 数据输出的实际长度 <data>: 来自 HTTP 服务器的数据示例 AT+HTTPREAD=2,8 +HTTPREAD: 注意事项 1. 在 +HTTPACTION=0 或在 +HTTPDATA 执行时读取数据如果大于接收到的数据大小, 模块将只返回实际数据大小 2. 强烈建议设置足够的时间使得所有 <byte_size> 能被输入 5.9 AT+HTTPSTATUS 读取 HTTP 状态表格 11 读取 HTTP 状态查询命令 AT+HTTPSTATUS=? +HTTPSTATUS: <mode>,<status>, <finish>,<remain> 执行命令 AT+HTTPSTATUS +HTTPSTATUS: <mode>,<status>, <finish>,<remain> +CME ERROR: <err> 返回值说明 <mode>:get POST HEAD <status>:0 idle 1 receiving 2 sending <finish> : 已完成传输的数据量 <remain>: 需要发送或接收的剩余数据量示例 AT+HTTPSTATUS GET,1,210,0 注意事项此命令执行前必须执行 AT+HTTPACTION 9 / 11

10 5.10 HTTP 示例说明 1) 初始化 HTTP( 之前需要注网成功 ) AT+HTTPINIT 2) 设置参数 AT+HTTPPARA = CID, 1 AT+HTTPPARA = URL, AT+HTTPPARA= CONTENT, application/json AT+HTTPPARA= API_KEY, qnx1rqyulfofiimxmwe243huzeo= AT+HTTPDATA >,;temperature, t22:31:12,22.5;102;pm2.5,89;10( 以 Ctrl+Z 结束 ) 3) 执行 HTTP 动作 AT+HTTPACTION = ) 读取返回数据 AT+HTTPREAD = 0, 26 +HTTPREAD: 26 { errno :0, error : succ } 5) 结束 HTTP AT+HTTPTERM 10 / 11

11 联系方式公司 : 地址 : 上海市闵行区秀文路 898 号西子国际五号楼 611 室网址 : 邮箱 : sales@mokuai.cn 电话 : 使命 : 做芯片到产品的桥梁愿景 : 全球有影响力的模块公司价值观 : 信任专注创新产品观 : 稳定的基础上追求高性价比免责声明免责声明本文档未授予任何知识产权的许可, 并未以明示或暗示, 或以禁止发言或其它方式授予任何知识产权许可除在其产品的销售条款和条件声明的责任之外, 我公司概不承担任何其它责任并且, 我公司对本产品的销售和 / 或使用不作任何明示或暗示的担保, 包括对产品的特定用途适用性, 适销性或对任何专利权, 版权或其它知识产权的侵权责任等均不作担保本公司可能随时对产品规格及产品描述做出修改, 恕不另行通知更新历史版本 v1.0.0 创立 11 / 11

目录（目录名） 1 SIP... 1 1.1 SIP... 1 1.2 SIP... 1 1.3 SIP... 2 2 SIP... 3 2.1... 3 2.2... 4 3 SIP... 6 3.1 SIP... 6 3.2 SIP... 6 3.3... 6 3.3.1... 6 3.3.2... 8 4 SIP... 11 4.1... 11 4.2 1xx... 11 4.3 2xx... 12 4.4