CoAP: mudanças entre as edições

De Wiki Cursos IFPR Foz
Ir para navegaçãoIr para pesquisar
Linha 208: Linha 208:


;Para a análise do protocolo CoAP foram utilizadas as seguintes ferramentas:
;Para a análise do protocolo CoAP foram utilizadas as seguintes ferramentas:
*Biblioteca '''CoAP-simple-library''' para Arduíno;
*'''Arduíno''' e '''programas exemplo''' da biblioteca '''CoAP-simple-library''' (IP 192.168.0.30) ;
*'''coap-server''' e '''coap-client''': rodando em Ubuntu 18.04 (IP 192.168.0.13);
*'''coap-server''' e '''coap-client''': rodando em '''Ubuntu 18.04''' (IP 192.168.0.13);
*'''wireshark''': rodando em Ubuntu 18.04 (IP 192.168.0.13);
*'''wireshark''' para captura e análise dos pacotes.


===Cenário 1: Arduíno e coap-server===
===Cenário 1: Arduíno ''request'' e coap-server ''response''===


Cenário com '''Arduíno Leonardo'''  (IP 192.168.0.30) rodando programa exemplo '''coaptest''' da biblioteca '''CoAP-simple-library''', interagindo com servidor '''coap-server'''  (IP 192.168.0.13) rodando em '''Ubuntu 18.04'''.
Cenário com '''Arduíno Leonardo'''  (IP 192.168.0.30) rodando programa exemplo '''coaptest''' da biblioteca '''CoAP-simple-library''', interagindo através de ''request'' (GET) com servidor '''coap-server'''  (IP 192.168.0.13) rodando em '''Ubuntu 18.04'''.


O programa '''coaptest''' envia a cada 5s uma '''mensagem GET''' para o '''coap-server''' solicitando a '''hora relógio''' (''time'').
O programa '''coaptest''' no '''Arduíno''' envia a cada 5s uma '''mensagem GET''' para o '''coap-server''' solicitando a '''hora relógio''' (''time'') e imprime no monitor serial.
;Código do programa coaptest:
<syntaxhighlight lang="c">
#include <SPI.h>
#include <Dhcp.h>
#include <Dns.h>
#include <Ethernet.h>
#include <EthernetUdp.h>
#include <coap-simple.h>
 
byte mac[] = { 0x00, 0xAA, 0xBB, 0xCC, 0xDE, 0x02 };
IPAddress dev_ip(192, 168, 0, 30);
 
// CoAP client response callback
void callback_response(CoapPacket &packet, IPAddress ip, int port);
 
// UDP and CoAP class
EthernetUDP Udp;
Coap coap(Udp);
 
// CoAP client response callback
void callback_response(CoapPacket &packet, IPAddress ip, int port) {
  Serial.println("[Coap Response got]");
  char p[packet.payloadlen + 1];
  memcpy(p, packet.payload, packet.payloadlen);
  p[packet.payloadlen] = NULL;
  Serial.println(p);
}
 
void setup() {
  delay(20000);
  Serial.begin(9600);
  Ethernet.begin(mac,dev_ip);
  Serial.print("My IP address: ");
  Serial.print(Ethernet.localIP());
  Serial.println();
  // client response callback.
  // this endpoint is single callback.
  Serial.println("Setup Response Callback");
  coap.response(callback_response);
  // start coap server/client
  coap.start();
  delay(5000);
}
 
void loop() {
  // send GET or PUT coap request to CoAP server.
  // To test, use libcoap, microcoap server...etc
  // int msgid = coap.put(IPAddress(10, 0, 0, 1), 5683, "light", "1");
  Serial.println("Send Request");
  int msgid = coap.get(IPAddress(192, 168, 0, 13), 5683, "time");
  delay(5000);
  coap.loop();
}
</syntaxhighlight>


;Saída do monitor serial do Arduino:
;Saída do monitor serial do Arduino:
Linha 276: Linha 222:
  Setup Response Callback
  Setup Response Callback
  Send Request
  Send Request
  [Coap Response got]
  Coap Response got:
  May 21 13:04:14
  May 21 10:04:14
  Send Request
  Send Request
  [Coap Response got]
  Coap Response got:
  May 21 13:04:19
  May 21 10:04:19
Send Request
:Mostra a sequência de '''mensagens enviadas''' (Send Request) e as '''respostas recebidas''' do servidor (Coap Response got:) seguida da '''hora relógio'''.
:Mostra a sequência de '''mensagens enviadas''' (Send Request) e as '''respostas recebidas''' do servidor [Coap Response got] seguida da '''hora relógio'''.
 
<!--Saída (verbose) do '''coap-server''':
Saída (verbose) do '''coap-server''':
  $ coap-server -A 192.168.0.13 -v 9
  $ coap-server -A 192.168.0.13 -v 9
  May 21 10:03:52 DEBG created endpoint 192.168.0.13:5683
  May 21 10:03:52 DEBG created endpoint 192.168.0.13:5683
Linha 292: Linha 238:
  v:1 t:CON c:GET i:3af1 {} [ Uri-Host:192.168.0.13, Uri-Path:time ]
  v:1 t:CON c:GET i:3af1 {} [ Uri-Host:192.168.0.13, Uri-Path:time ]
  May 21 10:04:19 DEBG call custom handler for resource 0x2f0df10e
  May 21 10:04:19 DEBG call custom handler for resource 0x2f0df10e
May 21 10:04:24 DEBG received 22 bytes on fd 3
v:1 t:CON c:GET i:2cd9 {} [ Uri-Host:192.168.0.13, Uri-Path:time ]
May 21 10:04:24 DEBG call custom handler for resource 0x2f0df10e-->


;Captura de pacotes com Wireshark:
;Captura de pacotes com Wireshark:
[[Arquivo:coaptest-coap-server.png|6--px]]
[[Arquivo:coaptest-coap-server.png|6--px]]


:Mostra três trocas de mensagens, cada uma incluindo um '''pedido CON''' ('''GET''' com confirmação exigida) e a '''resposta ACK''' (incluindo o '''time''' solicitado).
:Mostra duas trocas de mensagens, cada uma incluindo um '''pedido CON''' ('''GET''' com confirmação exigida) e a '''resposta ACK''' (incluindo o '''time''' solicitado).


[[Arquivo:coaptest-coap-server-pacotes.png|6--px]]
[[Arquivo:coaptest-coap-server-pacotes.png|6--px]]


:Detalhes:
;Detalhes da captura de pacotes:
:*Mostra as mensagens trocadas, destacando o protocolo de transporte '''UDP''', as '''portas''' CoAP padrão '''5683'''.
*Destaque para o protocolo de transporte '''UDP''' e as '''portas''' CoAP padrão '''5683''' utilizados pelas mensagens.
:*Destaque para a primeira mensagem '''CoAP''', incluindo o '''Code''' (GET) e a '''URI''' [Uri-Path: coap://192.168.0.13/time] da solicitação.
*Na primeira mensagem '''CoAP''' pode-se observar o '''Code''' (GET) e a '''URI''' [Uri-Path: coap://192.168.0.13/time] da solicitação.
:*Mostra o '''tamanho reduzido''' da mensagem CoAP, 4 bytes de cabeçalho, mais 1 byte de opções e 4 bytes de dados (time), total 9 bytes.
*O detalhe da mensagem mostra o '''tamanho reduzido''' da '''mensagem CoAP''', 4 bytes de cabeçalho, mais 1 byte de opções e 4 bytes de dados (time), total 9 bytes.
 
===Cenário 2: Arduíno ''request/response'' e coap-client ''request''===
 
Cenário com '''Arduíno Leonardo'''  (IP 192.168.0.30) rodando programa exemplo '''coapserver''' da biblioteca '''CoAP-simple-library''', interagindo através de ''request'' (GET) com servidor  '''coap-server''' (IP 192.168.0.13) e também respondendo a ''resquest'' (PUT) de  '''coap-client''' (IP 192.168.0.13).


==Referências==
==Referências==

Edição das 18h05min de 22 de maio de 2020

CoAP

Referências: [1], [2], [3]

O CoAP (Constrained Application Protocol) (RFC7252) é uma alternativa mais leve ao HTTP, com alvo nos dispositivos limitados em termos de energia e comunicação (redes LLN). O CoAP usa UDP, ao invés do TCP usado pelo HTTP, reduzindo o overhead de mensagens ocasionado pela abertura e encerramento de uma conexão TCP.

O CoAP provê interação usando um modelo pedido/resposta (request/response) entre aplicações, com comunicação assíncrona por meio de mensagens UDP. Este modelo é semelhante ao modelo cliente/servidor usado no HTTP, porém, ambas as máquinas podem atuar nas duas funções, diferente do HTTP. O CoAP apresenta baixo overhead de cabeçalho e processamento e suporta URI (Uniform Resource Identifier) e Content-type.

Pode-se visualizar o CoAP em duas camadas, uma camada de mensagens interagindo de forma assíncrona com o UDP e uma camada de interações pedido/resposta usando métodos e códigos de resposta. 

+----------------------+
|      Application     |
+----------------------+  \
|  Requests/Responses  |  |
|----------------------|  | CoAP
|       Messages       |  |
+----------------------+  /
|          UDP         |
+----------------------+

CoAP roda por padrão na porta UDP 5683.

Modelo de mensagens

O CoAP usa mensagens curtas com cabeçalho de tamanho fixo (4 bytes) que podem ser seguidas por opções e dados (payload). Cada mensagem contém um identificador (Message ID) usado para implementar o serviço de entrega garantida de mensagens.

Para a entrega garantida uma mensagem é marcada como confirmável (CON). Uma mensagem confirmável é retransmitida, usando um temporizador, até receber uma reconhecimento (ACK). Se o receptor não estiver habilitado a fornecer uma resposta adequada ele responde com a mensagem de reset (RST). 

Client              Server
   |                  |
   |   CON [0x7d34]   |
   +----------------->|
   |                  |
   |   ACK [0x7d34]   |
   |<-----------------+
   |                  |

Uma mensagem que não requer confirmação é marcada como não confirmável (NON). 

Client              Server
   |                  |
   |   NON [0x01a0]   |
   +----------------->|
   |                  |

Modelo pedido/resposta

Os pedidos e respostas são carregados por mensagens CoAP, as quais incluem o código do método e da resposta.

Os métodos utilizados pelo CoAP são GET, PUT, POST, e DELETE de modo similar ao HTTP.

Os métodos podem usar mensagens confirmáveis (CON) ou não confirmáveis (NON). A resposta, se tiver disponível, pode ser enviada imediatamente, confirmável ou não confirmável. 

Client              Server       Client              Server
   |                  |             |                  |
   |   CON [0xbc90]   |             |   CON [0xbc91]   |
   | GET /temperature |             | GET /temperature |
   |   (Token 0x71)   |             |   (Token 0x72)   |
   +----------------->|             +----------------->|
   |                  |             |                  |
   |   ACK [0xbc90]   |             |   ACK [0xbc91]   |
   |   2.05 Content   |             |  4.04 Not Found  |
   |   (Token 0x71)   |             |   (Token 0x72)   |
   |     "22.5 C"     |             |   "Not found"    |
   |<-----------------+             |<-----------------+
   |                  |             |                  |

Client              Server
   |                  |
   |   NON [0x7a11]   |
   | GET /temperature |
   |   (Token 0x73)   |
   +----------------->|
   |                  |
   |   NON [0x23bc]   |
   |   2.05 Content   |
   |   (Token 0x73)   |
   |     "22.5 C"     |
   |<-----------------+
   |                  |

Se a resposta não estiver disponível imediatamente, pode ser enviada posteriormente em mensagem separada. 

Client              Server
   |                  |
   |   CON [0x7a10]   |
   | GET /temperature |
   |   (Token 0x74)   |
   +----------------->|
   |                  |
   |   ACK [0x7a10]   |
   |<-----------------+
   |                  |
   ... Time Passes  ...
   |                  |
   |   CON [0x23bb]   |
   |   2.05 Content   |
   |   (Token 0x74)   |
   |     "22.5 C"     |
   |<-----------------+
   |                  |
   |   ACK [0x23bb]   |
   +----------------->|
   |                  |

Formato das mensagens

As mensagens CoAP são codificadas em binário, iniciando com um cabeçalho fixo de 4 bytes. 

   0                   1                   2                   3
   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |Ver| T |  TKL  |      Code     |          Message ID           |
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |   Token (if any, TKL bytes) ...
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |   Options (if any) ...
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |1 1 1 1 1 1 1 1|    Payload (if any) ...
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Campos:

  • Ver: 1
  • T (Type): CON (0), NON (1), ACK (2) ou RST (3)
  • TKL: Comprimento variável do Token (0 a 8 bytes).
  • Code: Código da mensagem:
    • Class (3 bits): request (0), success response (2), client error response (4), server error response (5) ou signaling codes (7)
    • Detail (5 bits): Em caso de pedido, indica o método. Em caso de resposta indica o código da resposta.
Method:0.XX Success:2.XX Client Error:4.XX Server Error: 5.XX       Signaling Codes: 7.XX
0 EMPTY     1 Created    0 Bad Request     0 Internal Server Error  0 Unassigned
1 GET       2 Deleted    1 Unauthorized    1 Not Implemented        1 CSM
2 POST      3 Valid      2 Bad Option      2 Bad Gateway            2 Ping
3 PUT       4 Changed    3 Forbidden       3 Service Unavailable    3 Pong
4 DELETE    5 Content    4 Not Found       4 Gateway Timeout        4 Release
5 FETCH                  ...               5 Proxying Not Supported 5 Abort
6 PATCH
7 iPATCH
  • Message ID: Identificador da mensagem, usado para detectar duplicatas ou correspondências entre uma mensagem CON com a mensagem ACK/RST ou entre uma mensagem NON com uma mensagem RST (caso o nó não possa processar a mensagem).

Campos opcionais:

  • Token: Usado para correlacionar pedidos e respostas
  • Options: A especificação CoAP define um conjunto de opções, identificadas por números, para serem utilizadas nas mensagens.
  • Payload: Dados

REST (Representational State Transfer)

As mensagens CoAP seguem a arquitetura REST (Representational State Transfer) para ler, atualizar, criar ou apagar de dados de aplicação em servidores remotos.

Na arquitetura REST um servidor REST simplesmente provê acesso a recursos e um cliente REST acessa e apresenta os recursos. Cada recurso é identificado por uma URI (Uniform Resource Identifier), que é sua identidade global.

Um sistema com capacidade de aplicar os princípios de REST é chamado de RESTful.

Métodos RESTful
  1. GET - ler informação
  2. PUT - atualizar informação
  3. POST - criar uma nova informação
  4. DELETE - apagar informação

A arquitetura REST usa várias representações para representar um recurso, como texto, JSON e XML, sendo o formato JASON o mais popular em Web Services.

Formato XML:
<endereco>
  <rua>
    JK
  </rua>
  <cidade>
    Foz do Iguaçu
  </cidade>
</endereco>
Formato JASON:
{ endereco:
  {
  rua: JK,
  cidade: Foz do Iguaçu
  }
}

A arquitetura REST é fortemente influenciada pelas tecnologias Web, sendo o HTTP uma de suas instâncias mais relevantes.

Muitas aplicações de IoT que utilizam protocolos IP fazem uso publicadores MQTT (sensores) e subscritores MQTT (atuadores), mas podem também utilizar REST Web Services.

O CoAP é um protocolo de transferência RESTful para nós e redes com recursos restritos em termos de processamento, memória e consumo de energia.

URI (Uniform Resource Identifier)

Estrutura de uma URI: 

coap://   host     [:port] path [? query]

Parâmetros query : 

?key1=value1&key2=value2
lista de chave/valor separados por &.
#SomewhereInTheDocument
é um marcador para outra parte do próprio recurso.

Clientes e Servidores CoAP

Algumas referências:

  • Artigo: (Porciúncula etal, 2018) [4]
  • Video: [5]

Agente Usuário CoAP para Chrome

Agente usuário CoAP desenvolvido por Kovatsch Matthias como extensão para o o navegador Chrome [6].

Cliente e Servidor CoAP para Ubuntu

coap-client e coap-server baseado na biblioteca libcoap.

Instalação Ubuntu 18.04:
sudo apt-get update
sudo apt-get install libcoap-1-0-bin

Biblioteca CoAP para Arduíno

Biblioteca CoAP-simple-library: [7], [8]

CoAP: Análise do protocolo com Arduíno e Wireshark

Para a análise do protocolo CoAP foram utilizadas as seguintes ferramentas
  • Arduíno e programas exemplo da biblioteca CoAP-simple-library (IP 192.168.0.30) ;
  • coap-server e coap-client: rodando em Ubuntu 18.04 (IP 192.168.0.13);
  • wireshark para captura e análise dos pacotes.

Cenário 1: Arduíno request e coap-server response

Cenário com Arduíno Leonardo (IP 192.168.0.30) rodando programa exemplo coaptest da biblioteca CoAP-simple-library, interagindo através de request (GET) com servidor coap-server (IP 192.168.0.13) rodando em Ubuntu 18.04.

O programa coaptest no Arduíno envia a cada 5s uma mensagem GET para o coap-server solicitando a hora relógio (time) e imprime no monitor serial.

Saída do monitor serial do Arduino
My IP address: 192.168.0.30
Setup Response Callback
Send Request
Coap Response got:
May 21 10:04:14
Send Request
Coap Response got:
May 21 10:04:19
Mostra a sequência de mensagens enviadas (Send Request) e as respostas recebidas do servidor (Coap Response got:) seguida da hora relógio.

Saída (verbose) do coap-server: 

$ coap-server -A 192.168.0.13 -v 9
May 21 10:03:52 DEBG created endpoint 192.168.0.13:5683
May 21 10:04:14 DEBG received 22 bytes on fd 3
v:1 t:CON c:GET i:41a7 {} [ Uri-Host:192.168.0.13, Uri-Path:time ]
May 21 10:04:14 DEBG call custom handler for resource 0x2f0df10e
May 21 10:04:19 DEBG received 22 bytes on fd 3
v:1 t:CON c:GET i:3af1 {} [ Uri-Host:192.168.0.13, Uri-Path:time ]
May 21 10:04:19 DEBG call custom handler for resource 0x2f0df10e
Captura de pacotes com Wireshark

6--px

Mostra duas trocas de mensagens, cada uma incluindo um pedido CON (GET com confirmação exigida) e a resposta ACK (incluindo o time solicitado).

6--px

Detalhes da captura de pacotes
  • Destaque para o protocolo de transporte UDP e as portas CoAP padrão 5683 utilizados pelas mensagens.
  • Na primeira mensagem CoAP pode-se observar o Code (GET) e a URI [Uri-Path: coap://192.168.0.13/time] da solicitação.
  • O detalhe da mensagem mostra o tamanho reduzido da mensagem CoAP, 4 bytes de cabeçalho, mais 1 byte de opções e 4 bytes de dados (time), total 9 bytes.

Cenário 2: Arduíno request/response e coap-client request

Cenário com Arduíno Leonardo (IP 192.168.0.30) rodando programa exemplo coapserver da biblioteca CoAP-simple-library, interagindo através de request (GET) com servidor coap-server (IP 192.168.0.13) e também respondendo a resquest (PUT) de coap-client (IP 192.168.0.13).

Referências

  1. ↑ https://www.rfc-editor.org/info/rfc7252
  2. ↑ https://en.wikipedia.org/wiki/Constrained_Application_Protocol
  3. ↑ http://www.tigli.fr/lib/exe/fetch.php?media=cours:tutorial_rest_coap_mit_2016_2017.pdf
  4. ↑ Cleber B. da Porciúncula, Sílvio Beskow, Daniel Stefani Marcon e Jéferson Campos Nobre. Constrained Application Protocol (CoAP) no Arduino UNO R3: Uma Análise Prática, Anais do V Workshop Pré-IETF, 2018.
  5. ↑ https://www.youtube.com/watch?v=pfG8uEDZj5g
  6. ↑ https://github.com/mkovatsc/Copper4Cr
  7. ↑ https://www.arduinolibraries.info/libraries/co-ap-simple-library
  8. ↑ https://github.com/hirotakaster/CoAP-simple-library

Evandro.cantu (discussão) 15h22min de 14 de maio de 2020 (-03)

Disponível em “http://wiki.foz.ifpr.edu.br/wiki/index.php?title=CoAP&oldid=26320”