物聯網時代跟著Thingsboard學IOT架構-CoAP裝置協議

三升水發表於2019-07-26

架構協議

thingsboard官網: https://thingsboard.io/

thingsboard GitHub: https://github.com/thingsboard/thingsboard

thingsboard提供的體驗地址: http://demo.thingsboard.io/

BY Thingsboard team

以下內容是在原文基礎上演繹的譯文。除非另行註明，頁面上所有內容採用知識共享-署名（CC BY 2.5 AU）協議共享。

原文地址: ThingsBoard API參考：CoAP裝置API

CoAP

協議介紹

CoAP是一種在物聯網世界的類web協議，它的詳細規範定義在RFC 7252。COAP名字翻譯來就是“受限應用協議”，顧名思義，使用在資源受限的物聯網裝置上。物聯網裝置的ram，rom都通常非常小，執行TCP和HTTP是不可以接受的。

協議特點

CoAP協議網路傳輸層由TCP改為UDP。
它基於REST，server的資源地址和網際網路一樣也有類似url的格式，客戶端同樣有POST，GET,PUT,DELETE方法來訪問server，對HTTP做了簡化。
COAP是二進位制格式的，HTTP是文字格式的，COAP比HTTP更加緊湊。
輕量化，COAP最小長度僅僅4B，一個HTTP的頭都幾十個B了。
支援可靠傳輸，資料重傳，塊傳輸。確保資料可靠到達。
支援IP多播, 即可以同時向多個裝置傳送請求。
非長連線通訊，適用於低功耗物聯網場景。

客戶端庫設定

安裝

安裝node.js,然後執行以下命令:

 npm install coap-cli -g

用法

 Usage: coap [command] [options] url
 
 
   Commands:
 
     get      performs a GET request
     put      performs a PUT request
     post     performs a POST request
     delete   performs a DELETE request
 
   Options:
 
     -h, --help                    output usage information
     -V, --version                 output the version number
     -o, --observe                 Observe the given resource
     -n, --no-new-line             No new line at the end of the stream
     -p, --payload <payload>       The payload for POST and PUT requests
     -b, --block2 <option>         set the block2 size option
     -q, --quiet                   Do not print status codes of received packets
     -c, --non-confirmable         non-confirmable
     -t, --timeout <seconds>       The maximum send time in seconds
     -T, --show-timing             Print request time, handy for simple performance tests
     -O, --coap-option <key,value> Add COAP-Option to the request (repeatable)

PUT和POST

PUT和POST請求如下例所示

 echo -n 'hello world' | coap post coap://localhost/message

Thingsboard的CoAP傳輸協議架構

因為Thingsboard最新release，是基於微服務架構，不利用單獨理解程式碼。

Thingsboard CoAP裝置傳輸協議原始碼:https://github.com/thingsboard/thingsboard/tree/release-2.0/transport/coap

本文基於上面原始碼後，剔除相關的安全驗證和處理之後搭建簡易的講解專案:

https://github.com/sanshengshui/IOT-Technical-Guide/tree/master/IOT-Guide-Coap

CoAP框架

Thingsboard的CoAP裝置傳輸協議是基於Californium。Californium 是一款基於Java實現的Coap技術框架，該專案實現了Coap協議的各種請求響應定義，支援CON/NON不同的可靠性傳輸模式。 Californium 基於分層設計且高度可擴充套件，其內部模組設計及介面定義存在許多學習之處；

值得一提的是，在同型別的 Coap技術實現中，Californium的效能表現是比較突出的，如下圖：

更多的資料可以參考Californium-可擴充套件雲服務白皮書本文以框架的原始碼分析為主，其他內容不做展開。

專案結構

 .
 └── main
     └── java
         ├── com
         │   └── sanshengshui
         │       └── coap
         │           ├── adaptors
         │           │   └── JsonCoapAdaptor.java
         │           ├── CoapTransportResource.java
         │           ├── common
         │           │   └── FeatureType.java
         │           └── session
         │               └── SessionMsgType.java
         └── IOTCoapServer.java

程式碼講解

IOTCoapServer

 1  public class IOTCoapServer {
 2  
 3      private static final String V1 = "v1";
 4      private static final String API = "api";
 5  
 6  
 7      private static String host = "127.0.0.1";
 8      private static Integer port = 5683;
 9      private static long timeout = 10000;
10  
11      public static void main(String[] args) throws UnknownHostException {
12          CoapServer coapServer = new CoapServer();
13          CoapResource api = new CoapResource(API);
14          api.add(new CoapTransportResource(V1,timeout));
15          coapServer.add(api);
16          InetAddress addr = InetAddress.getByName(host);
17          InetSocketAddress sockAddr = new InetSocketAddress(addr, port);
18          coapServer.addEndpoint(new CoapEndpoint(sockAddr));
19          coapServer.start();
20  
21      }
22  
23  }

第12行程式碼: CoapServer用作建立服務端。
第12-15行: CoapResource是resource的基本實現，擴充套件這個類來編寫您自己的資源。通過向資源新增“v1”、"api"和超時時間的設定，則coap的基礎url為:coap://localhost:port/api/v1/。
第16-18行: Endpoint負責與網路進行通訊, 如果沒有一個Endpoint與CoapServer進行繫結，那就建立一個預設的Endpoint，預設就是ucp實現傳輸層。
第19行，啟動CoAP服務。

以下圖片展示服務端的基礎架構:

CoapTransportResource

此類負責處理請求

GET

 @Override
     public void handleGET(CoapExchange exchange) {
         Optional<FeatureType> featureType = getFeatureType(exchange.advanced().getRequest());
         if (!featureType.isPresent()) {
         } else if (featureType.get() == FeatureType.TELEMETRY) {
             exchange.respond(CoAP.ResponseCode.BAD_REQUEST);
         }  else if (featureType.get() == FeatureType.ATTRIBUTES) {
             processRequest(exchange, SessionMsgType.GET_ATTRIBUTES_REQUEST);
         } else {
             exchange.respond(CoAP.ResponseCode.BAD_REQUEST);
         }
     }

如果我們客戶端發起的是GET請求，那麼將會進入到handleGET(CoapExchange exchange)方法。
getFeatureType(Request request)判斷coap協議長度是否大於3。當大於等於3，獲取/api/v1/${param}的param元素。

 public static final int FEATURE_TYPE_POSITION = 3;
 
 private Optional<FeatureType> getFeatureType(Request request) {
         List<String> uriPath = request.getOptions().getUriPath();
         try {
             if (uriPath.size() >= FEATURE_TYPE_POSITION) {
                 return Optional.of(FeatureType.valueOf(uriPath.get(FEATURE_TYPE_POSITION - 1).toUpperCase()));
             }
         } catch (RuntimeException e) {
         }
         return Optional.empty();
     }

通過判斷param是否是temperature還是attributes進行相關的邏輯操作。
當不是上述型別，回覆狀態為BAD_REQUEST的狀態碼。

POST

@Override
     public void handlePOST(CoapExchange exchange) {
         Optional<FeatureType> featureType = getFeatureType(exchange.advanced().getRequest());
         if (!featureType.isPresent()) {
             exchange.respond(CoAP.ResponseCode.BAD_REQUEST);
         } else {
             switch (featureType.get()) {
                 case ATTRIBUTES:
                     processRequest(exchange, SessionMsgType.POST_ATTRIBUTES_REQUEST);
                     break;
                 case TELEMETRY:
                     processRequest(exchange, SessionMsgType.POST_TELEMETRY_REQUEST);
                     break;
             }
         }
     }

如果我們客戶端發起的是POST請求，那麼將會進入到handlePOST(CoapExchange exchange)方法。
對獲取的uri的型別是temperature還是attributes來做相關的邏輯操作。

邏輯處理

private void processRequest(CoapExchange exchange, SessionMsgType type) {
         exchange.accept();
         Exchange advanced = exchange.advanced();
         Request request = advanced.getRequest();
 
         try {
             switch (type) {
                 case GET_ATTRIBUTES_REQUEST:
                 case POST_TELEMETRY_REQUEST:
                 case POST_ATTRIBUTES_REQUEST:
                     //這個類在之前的物模型博文中有所講解，大家可以翻看！
                     JsonCoapAdaptor.convertToMsg(type,request);
                     break;
                 default:
                     throw new IllegalArgumentException("Unsupported msg type: " + type);
             }
             exchange.respond("Data has been received");
         } catch (AdaptorException e){
             exchange.respond(CoAP.ResponseCode.BAD_REQUEST, e.getMessage());
         } catch (IllegalArgumentException  e) {
             exchange.respond(CoAP.ResponseCode.INTERNAL_SERVER_ERROR, e.getMessage());
         }
     }

專案演示

遙測上傳API

要將遙測資料釋出到伺服器節點，請將POST請求傳送到以下URL：

coap://host/api/v1/telemetry

最簡單的支援資料格式是：

{"key1":"value1", "key2":"value2"}

要麼

[{"key1":"value1"}, {"key2":"value2"}]

請注意，在這種情況下，伺服器端時間戳將分配給上傳的資料！

如果您的裝置能夠獲取客戶端時間戳，您可以使用以下格式：

 {"ts":1451649600512, "values":{"key1":"value1", "key2":"value2"}}

在上面的示例中，我們假設“1451649600512”是具有毫秒精度的unix時間戳。例如，值'1451649600512'對應於'Fri，2016年1月1日12：00：00.512 GMT'

例子：

 echo -n '{"size":21,"type":"device"}' | coap post coap://demo.thingsboard.io/api/v1/telemetry

結果:

 key= 1564105084015
 屬性名=size 屬性值=21
 屬性名=type 屬性值=device

屬性API

屬性API允許裝置

將客戶端裝置屬性上載到伺服器。
從伺服器請求客戶端和共享裝置屬性。

將屬性更新發布到伺服器

要將客戶端裝置屬性發布到ThingsBoard伺服器節點，請將POST請求傳送到以下URL：

 coap://host/api/v1/attributes

例子：

 echo -n '{"size":21,"type":"device","status":true}' | coap post coap://localhost:5683/api/v1/attributes

結果：

key= 1564105158573
 屬性名=size 屬性值=21
 屬性名=type 屬性值=device
 屬性名=status 屬性值=true

從伺服器請求屬性值

要向ThingsBoard伺服器節點請求客戶端或共享裝置屬性，請將GET請求傳送到以下URL：

coap://host/api/v1/attributes?clientKeys=attribute1,attribute2&sharedKeys=shared1,shared2

例子：

 coap get coap://localhost:5683/api/v1/attributes?clientKeys=attribute1,attribute2&sharedKeys=shared1,shared2

結果:

 (2.05)  Data has been received

到此,物聯網時代，相信大家對IOT架構下的CoAP協議有所瞭解了，感謝大家的閱讀！

物聯網時代-跟著Thingsboard學IOT架構-MQTT裝置協議
2019-07-24
架構MQQT協議
將 CoAP 協議裝置接入 EMQX Cloud
2022-05-09
協議MQCloud
【物聯網】IoT與智慧時代
2018-04-30
騰訊IOT之樹莓派物聯網裝置
2021-01-11
樹莓派
NB-IoT物聯網流量監測裝置
2017-02-06
MQTT協議與阿里雲IoT物聯網平臺
2018-12-18
MQQT協議阿里
11種你需要了解的物聯網（IoT）協議
2017-07-04
協議
物聯網 IOT 裝置如何脫離資訊孤島？
2022-12-28
Android與物聯網裝置通訊-UDP&TCP協議
2019-03-02
AndroidUDPTCP協議
如何解決物聯網(IoT)裝置充電難題
2017-07-03
NB-IOT物聯網系統的安全架構
2021-09-28
架構
Nodejs裝置接入阿里雲IoT物聯網平臺
2018-12-17
NodeJS阿里
一文解決 CoAP 協議裝置與外部網路溝通難題
2022-03-22
協議
【物聯網】通過mqtt協議使用wifi遠端控制你的智慧裝置
2018-09-02
MQQT協議WiFi
基於Azure IoT開發.NET物聯網應用系列-全新的Azure IoT架構
2020-06-08
架構
抓住CoAP協議的“心”
2020-05-08
協議
使用4G通訊模組和MQTT協議，完成物聯網裝置開發。
2023-05-14
MQQT協議
物信鏈釋出PDash資料共享協議，物聯網迎來資料互聯時代
2018-06-27
協議
物聯網通訊協議介紹
2016-12-04
協議
基於nb-iot的物聯網構建
2020-12-21
如何保護物聯網裝置
2022-03-30
當 JS 遇上物聯網（IoT）
2017-09-09
JS
常用物聯網應用層協議（1）——先說HTTP協議
2020-10-27
協議HTTP
物聯網實驗2 協議棧剖析
2020-11-18
協議
物聯網常見通訊協議梳理
2017-07-26
協議
UIUC聯合IBM、Inspirit IoT推出最新DNN/FPGA協同設計方案，助力物聯網終端裝置AI應用
2019-05-25
UIIBMDNNFPGAAI
跟著《架構探險》學輕量級微服務架構 (一)
2019-02-20
架構微服務
跟著《架構探險》學輕量級微服務架構 (二)
2017-09-22
架構微服務
物聯網架構成長之路
2018-04-27
架構
全球數億物聯網裝置受影響！騰訊報告首個LoRaWAN協議棧通用漏洞
2020-06-19
協議
電信運營商基於 MQTT 協議構建千萬級 IoT 裝置管理平臺
2021-08-11
MQQT協議
主流物聯網協議選擇：MQTT、CoAP 還是 LwM2M？
2022-03-15
協議MQQT
艾拉物聯：標準協議不同，碎片化將是IoT長期挑戰
2016-07-17
協議
IoT Analytics釋出：全球蜂窩物聯網模組跟蹤報告
2021-05-28
物聯網時代來臨，百億裝置大爆發，世界該如何守護？
2017-07-05
阿里雲新推出 HiTSDB + IoT套件物聯網裝置上雲步入快車道
2018-01-12
阿里套件
LoRa VS NB-IoT，一場物聯網時代C位爭奪戰
2020-08-18
認識物聯網平臺架構
2018-12-05
架構

物聯網時代 跟著Thingsboard學IOT架構-CoAP裝置協議

CoAP

協議介紹

協議特點

客戶端庫設定

安裝

用法

Thingsboard的CoAP傳輸協議架構

CoAP框架

專案結構

程式碼講解

IOTCoapServer

CoapTransportResource

GET

POST

邏輯處理

專案演示

遙測上傳API

屬性API

將屬性更新發布到伺服器

從伺服器請求屬性值

相關文章

物聯網時代跟著Thingsboard學IOT架構-CoAP裝置協議