AT Commands For HTTP(S) Application
No | Command | Description |
C0901 | AT+SHSSL | Select SSL Configure |
C0902 | AT+SHCONF | Set HTTP(S) Parameter |
C0903 | AT+SHCONN | HTTP(S) Connection |
C0904 | AT+SHBOD | Set Body |
C0905 | AT+SHBODEXT | Set Extension Body |
C0906 | AT+SHAHEAD | Add Head |
C0907 | AT+SHPARA | Set HTTP(S) Para |
C0908 | AT+SHCPARA | Clear HTTP(S) Para |
C0909 | AT+SHCHEAD | Clear Head |
C0910 | AT+SHSTATE | Query HTTP(S) Connection Status |
C0911 | AT+SHREQ | Set Request Type |
C0912 | AT+SHREAD | Read Response Value |
C0913 | AT+SHDISC | Disconnect HTTP(S) |
C0914 | AT+HTTPTOFS | Download file to ap file system |
C0915 | AT+HTTPTOFSRL | State of download file to ap file system |
C0901 AT+SHSSL Select SSL Configure
T) AT+SHSSL=? |
+SHSSL: (0-5), “ca list”,”cert name”
OK |
R) AT+SHSSL? |
+SHSSL: <index>,<ca list>,<cert name>
OK |
W) AT+SHSSL=<index>,<ca list>,<certname> |
OK or ERROR |
Parameters <index> CSSLCFG set Configure index <ca list> Ca Certificate name <cert name> Cert Certificate name |
|
Parameter Saving Mode | AUTO_SAVE |
C0902 AT+SHCONF Set HTTP(S) Parameter
T) AT+SHCONF=? |
+SHCONF: “HTTPParamTag”,”HTTPParamValue”
OK |
R) AT+SHCONF? |
+SHCONF: <HTTPParamTag>,<HTTPParamValue>
OK |
W) AT+SHCONF=<HTTPParamTag>,<HTTPParamVa lue> |
OK or ERROR |
Parameters <HTTPParaTag> <HTTPParamValue> “URL” Server URL address(max is 64 bytes) “server domain[: tcpPort]” “TIMEOUT” Hold once request time. Unit is second.Default 60s. range: 30-1800 “BODYLEN” Set body max length(max is 1024 bytes) “HEADERLEN” Set head max length(max is 350 bytes) “IPVER” Set IP version 0 IPv4 1 IPv6 |
|
Parameter Saving Mode | AUTO_SAVE |
Reference |
Note: Must set URL,BODYLEN,HEADERLEN value, TIMEOUT default is 60 s, URL format must “http://xxx.xx.xx” or “https://xxx.xx.xx” |
C0903 AT+SHCONN HTTP(S) Connection
E) AT+SHCONN |
OK or ERROR |
C0904 AT+SHBOD Set Body
T) AT+SHBOD=? |
+SHBOD: “body”,<bodylen>
OK |
R) AT+SHBOD? |
+SHBOD: <body>,<bodylen>
OK |
W) AT+SHBOD=<body>,<bodylen> |
OK or ERROR |
Parameters <body> Set body value (max length is SHCONF Set value) <bodylen> Set body length (max length is SHCONF Set value) |
|
Parameter Saving Mode | AUTO_SAVE |
Reference |
Note: Must be executed after the connection |
C0905 AT+SHBODEXT Set Extension Body
T) AT+SHBODEXT=? |
+SHBODEXT: (range of supported <bodylen>s),(range of supported <timeout>s)
OK |
R) AT+SHBODEXT? |
+SHBODEXT: <body>,<len_body>
OK |
W) AT+SHBODEXT=<len_body>,<timeout> <CR>text is entered <ctrl-Z/ESC> ESC quits without sending |
OK or ERROR |
Parameters <body> Set body value (max length is SHCONF Set value) <len_body> Length of <body>. Max value is <bodylen>. <bodylen> Max length set by “AT+SHCONF=”BODYLEN”,<bodylen>” <timeout> Timeout for automatically sending edited data (100-10000 ms) |
|
Parameter Saving Mode | AUTO_SAVE |
Reference |
Note: Must be executed after the connection |
C0906 AT+SHAHEAD Add Head
T) AT+SHAHEAD=? |
+SHAHEAD: “type”,”value”
OK |
R) AT+SHAHEAD? |
+SHAHEAD: <type>,<value>
OK |
W) AT+SHAHEAD=<type>,<value> |
OK OR ERROR |
Parameters <type> Head type (max length is SHCONF Set value) <value> Head value (max length is SHCONF Set value) Note: The sum of type and value max length is 350 |
|
Parameter Saving Mode | AUTO_SAVE |
Reference |
Note: Must be executed after the connection |
C0907 AT+SHCHEAD Clear Head
E) AT+SHCHEAD |
OK or ERROR |
Reference |
Note: Must be executed after the connection |
C0908 AT+SHPARA Set HTTP(S) Para
T) AT+SHPARA=? |
+SHPARA: “key”,”value”
OK |
R) AT+SHPARA? |
+SHPARA: <key>,<value>
OK |
W) AT+SHPARA=<key>,<value> |
OK or ERROR |
Parameters <key> Set key (max is 64 bytes) <value> Set value (max is 64 bytes) |
|
Parameter Saving Mode | AUTO_SAVE |
Reference |
Note: Must be executed after the connection. |
C0909 AT+SHCPARA Clear HTTP(S) Para
T) AT+SHCPARA=? | OK |
E) AT+SHCPARA |
OK or ERROR |
Reference |
Note: Must be executed after the connection. |
C0910 AT+SHSTATE Query HTTP(S) Connection Status
R) AT+SHSTATE? |
+SHSTATE: <status>
OK |
Parameters <status> 0 Expression HTTP(S) disconnect state; 1 Expression HTTP(S) connect state; |
C0911 AT+SHREQ Set Request Type
T) AT+SHREQ=? |
+SHREQ: url,(1-5)
OK |
R) AT+SHREQ? |
+SHREQ: <url>,<type>
OK |
W) AT+SHREQ=<url>,<type> |
OK or ERROR Unsolicited Result Code +SHREQ: <type string>,<StatusCode>,<DataLen> |
Parameters <url> Request server domain (max is 512 bytes) <type> 1 GET 2 PUT 3 POST 4 PATCH 5 HEAD <type string> String of type are GET ,PUT,POST,PATCH,HEAD. <timeout> Waiting for Response time(default is 60 sec) <StatusCode> HTTP(S) Status Code responded by remote server, it identifier refer to HTTP1.1(RFC2616) 100 Continue 101 Switching Protocols 200 OK 201 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(S) Version not supported <DataLen> The length of data got |
|
Reference |
Note: Must be executed after the connection |
C0912 AT+SHREAD Read Response Value
T) AT+SHREAD=? |
+SHREAD: (0-306176),(1-306176)
OK |
W) AT+SHREAD=<startaddr ess>,<datalen> |
OK +SHREAD: <data_len> <data>
+SHREAD: <data_len> <data> ….. or ERROR
If<datalen> is bigger than the data size received, it’s error If <datalen> is bigger than 2048, will got multi URC +SHREAD |
Parameters <startaddress> Start address of data <datalen> Set read values length <data_len> Return data length max is 2048 bytes once, if more than 2048 bytes, will return many timer until all data are read out <data> Response data |
|
Reference |
Note: Read data after request |
C0913 AT+SHDISC Disconnect HTTP(S)
E) AT+SHDISC |
OK or ERROR |
C0914 AT+HTTPTOFS Download File To AP File System
T) AT+HTTPTOFS=? |
+HTTPTOFS: (1-255),(1-127)
OK |
R) AT+HTTPTOFS? |
+HTTPTOFS: <status>,<url>,<file_path>
OK If error is related to ME functionality: +CME ERROR: <err> |
Parameters See Write Command |
|
W) AT+HTTPTOFS=<url>, <file_path>[,<timeout> [,<retrycnt>]] |
OK
+HTTPTOFS: <StatusCode>,<DataLen> |
Parameters <status> 0 Idle 1 Busy <url> The url <file_path> File path and name on AP side, For example: “/customer/test.bin”,”/custapp/ test.bin “,”/fota/test.bin” <timeout> Timeout of HTTP request. Unit is second. Range is 10-1000, default value is 50. <retrycnt> Retry times of HTTP request. Range is 5-100, default value is 5. <StatusCode> HTTP Status Code responded by remote server, it identifier refer to HTTP1.1(RFC2616) 100 Continue 200 OK 206 Partial Content 400 Bad Request 404 Not Found 408 Request Time-out 500 Internal Server Error 600 Not HTTP PDU 601 Network Error 602 No memory 603 DNS Error 604 Stack Busy 620 SSL continue 65535 Other Errors <DataLen> The length of data download |
|
Parameter Saving Mode | NO_SAVE |
C0915 AT+HTTPTOFSRL State Of Download File To AP File System
T) AT+HTTPTOFSRL=? | OK |
R) AT+HTTPTOFSRL? |
+HTTPTOFSRL: <status>,<curlen >,<totallen>
OK If error is related to ME functionality: +CME ERROR: <err> |
Parameters <status> Downloading state 0 Idle 1 During downloading <curlen> The length of data have been download successfully <totallen> The length of data download. If total length does not been got, <totallen> will be 0. |
|
Parameter Saving Mode | NO_SAVE |