好多人找的arduinojson庫和httppacket庫文件包：
0.png (42.96 KB, 下載次數: 76)
下載附件
2018-10-3 00:40 上傳
HTTP數據封裝Ardiuno SDK說明文檔 RestfulAPI包括資源的增、刪、改、查四類操作，其中刪、查操作不帶HTTP內容，只有HTTP報頭。增、改操作有HTTP報頭，后面帶有JSON格式HTTP內容。報頭數據URL帶有可選參數，都是以“？”開始，以“&”分隔。下列操作的HTTP報文，紅色代表有URL可選參數。 HTTP報由報頭和HTTP內容組成。HTTP內容是JSON格式字符串，可以通過Ardiuno的JSON庫實現HTTP內容的封裝，本文檔主要說明HTTP包頭封裝的封裝方法和接口實現。
1．報文總結
1.1 查詢操作
//查看用戶
GET /user HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//查詢設備
GET /devices/<devices_id> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
GET /devices HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//查看數據流
GET /devices/<devices_id>/datastreams/<datastream_id> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
GET /devices/<devices_id>/datastreams?datastream_ids=temp,gps HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//查看數據點
GET /devices/<devices_id>/datapoints HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//查看觸發器
GET /triggers/<trigger_id> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//查看API權限
GET /keys HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//查看二進制數據
GET /bindata/<index> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//RestAPI日志查詢
GET /logs/<device_id> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//歷史數據查詢
GET /datapoints HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
1.2 新增操作
//新增設備
POST /devices HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
Content-Length: ***\r\n
\r\n
{"JASON"}
//新增數據流
POST /devices/<devices_id>/datastreams HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
Content-Length: ***\r\n
\r\n
{"JASON"}
//新增數據點
POST /devices/<devices_id>/datapoints HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
Content-Length: ***\r\n
\r\n
{"JASON"}
//新增觸發器
POST /triggers HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
Content-Length: ***\r\n
\r\n
{"JASON"}
//新增API權限
POST /keys HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
Content-Length: ***\r\n
\r\n
{"JASON"}
///新增二進制數據
POST /bindata HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
Content-Length: ***\r\n
\r\n
{"JASON"}
1.3 更新操作
//更新設備
PUT /devices/<devices_id> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
Content-Length: ***\r\n
\r\n
{"JASON"}
//更新數據流
PUT /devices/<devices_id>/datastreams/<datastream_id> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
Content-Length: ***\r\n
\r\n
{"JASON"}
//更新觸發器
PUT /triggers/<trigger_id> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
Content-Length: ***\r\n
\r\n
{"JASON"}
//更新API權限
PUT /keys/<key_string> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
Content-Length: ***\r\n
\r\n
{"JASON"}
//發送數據到edp設備
POST /cmds/<device_id> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
Content-Length: ***\r\n
\r\n
{"JASON"}
1.4 刪除操作
//刪除設備
DELETE /devices/<devices_id> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//刪除數據流
DELETE /devices/<devices_id>/datastreams/<datastream_id> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//刪除數據點
DELETE /devices/<devices_id>/datapoints HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//刪除觸發器
DELETE /triggers/<trigger_id> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//刪除API權限
DELETE /keys/<key_string> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
//刪除二進制數據
DELETE /bindata/<index> HTTP/1.1\r\n
api-key:<your_api_key>\r\n
Host:api.heclouds.com\r\n
\r\n
2．SDK對外接口說明
/**********************************************************************
* 功能描述: 設置http包頭主機地址字符串
* @param param1 char* hostAddr 服務器地址字符串指針
* @return void **********************************************************************/
void HttpPacketHead::setHostAddress(char* hostAddr)
/**********************************************************************
* 功能描述: 更新單個URL參數
* @param param1 char* key 參數名字字符串指針
* @param param2 char* value 參數的值字符串指針
* @return void **********************************************************************/
void HttpPacketHead::updateUrlParameterWith(char* key, char* value)
/**********************************************************************
* 功能描述: 清除所有之前設置的URL參數
* @param void
* @return void **********************************************************************/
void HttpPacketHead::clearUrlParameter(void)
/**********************************************************************
* 功能描述:刪除一個之前已經存在的URL參數，如果沒有這
* 個參數 不做任何操作
* @param char* key 參數名稱
* @return void **********************************************************************/
void HttpPacketHead::removeUrlParameter(char* key)
/**********************************************************************
* 功能描述:添加一個url 參數http包中，如果存在該參數，
* 不做任何操作.
* @param1 char* key 參數名稱
* @param2 char* value 參數值
* @return void **********************************************************************/
void HttpPacketHead::addUrlParameter(char* key, char* value)
/**********************************************************************
* 功能描述:設置http包中要要訪問的設備id
* @param1 char* Dev_Id 設備ID 字符串
* @return void **********************************************************************/
void HttpPacketHead::setDevId(char* Dev_Id)
/**********************************************************************
* 功能描述:設置http包中要要訪問的數據流ID
* @param1 char* StreamId 數據流ID 字符串
* @return void **********************************************************************/
void HttpPacketHead::setDataStreamId(char* StreamId)
/**********************************************************************
* 功能描述:設置http包中要要訪問的觸發器ID
* @param1 char* TrigId 觸發器ID 字符串
* @return void **********************************************************************/
void HttpPacketHead::setTriggerId(char* TrigId)
/**********************************************************************
* 功能描述:設置http包中要要訪問的bin文件索引
* @param1 char* Idx 文件索引
* @return void **********************************************************************/
void HttpPacketHead::setBinIdx(char* Idx)
/**********************************************************************
* 功能描述:添加一個API key，只有在API 更新操作中才會設置.
* @param1 char* key key字符串
* @return void **********************************************************************/
void HttpPacketHead::addAPIKey(char* key)
/**********************************************************************
* 功能描述:設置訪問設備所需的密鑰.
* @param1 char* key key字符串
* @return void **********************************************************************/
void HttpPacketHead::setAccessKey(char* key)
/**********************************************************************
* 功能描述:產生http 數據報頭，僅限POST、PUT操作
* @param1 OPS_TYPE operType 操作類型
* @param2 RESRC_TYPE type 資源類型
* @param3 char* jsonData http內容json結構
* @return RET_ERR 產生數據包失敗，可能因為參數傳入不當 RET_OK 產生數據包成功 **********************************************************************/
intHttpPacketHead::createCmdPacket(OPS_TYPE operType, RESRC_TYPE type, char* jsonData)
/**********************************************************************
int HttpPacketHead::createCmdPacket(OPS_TYPE operType, RESRC_TYPEtype) * 功能描述:產生http 數據報頭，僅限DELETE、GET操作
* @param1 OPS_TYPE operType 操作類型
* @param2 RESRC_TYPE type 資源類型
* @return RET_ERR 產生數據包失敗，可能因為參數傳入不當 RET_OK 產生數據包成功
**********************************************************************/
3.資源類型說明
TYPE_USER 用戶
TYPE_DEV 設備
TYPE_DATASTREAM 數據流
TYPE_DATAPOINT 數據點
TYPE_TRIGGER 觸發器
TYPE_APIKEY API-KEY
TYPE_BINDATA 二進制數據
TYPE_APILOG API日志
TYPE_HISTORYDATA 歷史數據
4. 操作類型說明
POST 新增
PUT 更新
GET 查詢
DELETE 刪除
5. 約束限制
1）一個HTTP報報頭最大不能超過300字節；
2）一個HTTP報URL可選參數個數不超過7個；
3）一個HTTP報所有URL參數字符串總長度不超過150字節。
6. 編程舉例
Ardiuno代碼段：
HttpPacketHead packet;
packet.setHostAddress("api.heclouds.com");//設置主機地址 packet.setDevId("70290");//設置設備ID packet.setAccessKey("<Your access api-key>");//設置訪問密鑰 packet.addUrlParameter("datastream_ids", "temp");//添加URL參數 packet.addUrlParameter("datastream_ids", "gps");//添加URL參數 packet.createCmdPacket(GET, TYPE_DATASTREAM);//產生查詢數據流的報頭 Serial.print(packet.content);
輸出為：
GET /devices/70290/datastreams/?datastream_ids=temp,gps HTTP/1.1
api-key:<Your access api-key>
Host:api.heclouds.com
具體使用方法請參照示例程序。
全部資料51hei下載地址：
ArdiunoHttpSDK.rar
(1.12 MB, 下載次數: 100)
2018-10-3 00:52 上傳
點擊文件名下載附件
下載積分: 黑幣 -5
| 
QQ好友和群
QQ空間
騰訊微博
騰訊朋友
收藏
淘帖
頂
踩
