Lobaro CoAP

Tämä sivu on johdanto meidän ilmainen CoAP-ohjelmistopino nimeltä "Lobaro-CoAP", jonka avulla voit luoda CoAP-sovelluksia C:llä ja muilla ohjelmointikielillä.

Kohderyhmänä ovat kokeneet ohjelmoijat, joilla on hyvät tiedot C-ohjelmointikielestä.

Projektin sivu Githubissa
Esimerkki ESP8266-projekti

Tarjoamme myös integrointia muille kielille, jotka perustuvat samaan C-koodiin:

Lobaro CoAP Go Githubissa

Pikatietoja

helppokäyttöinen "C" CoAP-pino
täydellinen pyyntö/vastauslogiikka
täydellinen uusintalogiikka
piggybacked & erilliset vastaukset
valmis nukkuvalle palvelimelle
Demot ESP8266:lle (IPv4), ZWIR4512:lle (IPv6)

Keskeiset termit

Avoin lähdekoodi (MIT-lisenssi)
Asiakas + palvelin
RFC7252 (CoAP, ydin)
RFC7641 (Tarkkaile)
RFC7641 edistynyt siirto
Siirrot myötäpäivään

Yksinkertainen "CoAP GET" esimerkki

Tämä resurssi palauttaa nykyisen ip-konfiguraation hyötykuormana, ja sitä käytetään komennolla "GET coap://.../wifi/ipconfig".
[code lang="c"]
#include "../lobaro-coap/coap.h"

CoAP_Res_t* pWifi_ip_Res = NULL;

static CoAP_HandlerResult_t ICACHE_FLASH_ATTR RequestHandler(CoAP_Message_t* pReq, CoAP_Message_t* pResp) {
struct ip_info ipconfig;
char payloadTemp[100];

if(wifi_get_ip_info(STATION_IF, &ipconfig)) {
coap_sprintf(payloadTemp, "Asema: %d.%d.%d.%drn",IP2STR(&ipconfig.ip));
CoAP_SetPayload(pReq, pResp, (uint8_t*)payloadTemp, coap_strlen(payloadTemp), true);
} else {
pResp->Code=RESP_INTERNAL_SERVER_ERROR_5_00;
}

return HANDLER_OK;
}

CoAP_Res_t* Create_Wifi_IPs_Resource() {
CoAP_ResOpts_t Options = {.Cf = COAP_CF_TEXT_PLAIN, .Flags = RES_OPT_GET };
return (pWifi_ip_Res=CoAP_CreateResource("wifi/ipconfig", "ESP8266 IP configuration",Options, RequestHandler, NULL));
}
[/koodi]

Havainnoitava resurssi esimerkki

Tämä havainnoitava resurssi palauttaa järjestelmän nykyisen ajan, ja sitä käytetään komennolla "GET coap://.../rtc".
[code lang="c"]
#include "../lobaro-coap/coap.h"
#include "rtc_res.h"

CoAP_Res_t* pRTC_Res = NULL;

static CoAP_HandlerResult_t RequestHandler(CoAP_Message_t* pReq, CoAP_Message_t* pResp) {
char myString[20];
coap_sprintf(myString, "%d [s]", hal_rtc_1Hz_Cnt());
CoAP_SetPayload(pReq, pResp, myString, coap_strlen(myString), true);

return HANDLER_OK;
}

static CoAP_HandlerResult_t NotifyHandler(CoAP_Observer_t* pObserver, CoAP_Message_t* pResp) {
char myString[20];
coap_sprintf(myString, "%d [s]", hal_rtc_1Hz_Cnt());
CoAP_SetPayload(NULL, pResp, myString, coap_strlen(myString), true);

return HANDLER_OK;
}

//Päivitä tarkkailijat joka sekunti
#define DELAY_LOOP 1000 // millisekuntia
LOCAL os_timer_t Notify_timer;

LOCAL void notify_cb(void *arg) {
CoAP_NotifyResourceObservers(pRTC_Res);
}

CoAP_Res_t* Create_RTC_Resource() {
CoAP_ResOpts_t Options = {.Cf = COAP_CF_TEXT_PLAIN, .Flags = RES_OPT_GET};

// Käynnistä päivitysajastin
os_timer_disarm(&Notify_timer);
os_timer_setfn(&Notify_timer, (os_timer_func_t *)notify_cb, (void *)0);
os_timer_arm(&Notify_timer, DELAY_LOOP, 1);

return (pRTC_Res=CoAP_CreateResource("/rtc", "esp8266 RTC", Options, RequestHandler, NotifyHandler));
}
[/koodi]

resurssien hallinta uri-query-kyselyn avulla

Tämä resurssi voi muuttaa ledin tilaa "POST coap://.../esp8266/led_gpio12" -palvelun kautta.
[code lang="c" highlight="12-17″]
static void SetLedstatePayload(CoAP_Message_t* pReq, CoAP_Message_t* pResp){
if(LedState) CoAP_SetPayload(pReq, pResp, "Led on päällä!", coap_strlen("Led on päällä!"), true);
else CoAP_SetPayload(pReq, pResp, "Led on pois päältä!", coap_strlen("Led on pois päältä!"), true);
}

static CoAP_HandlerResult_t Res_ReqHandler(CoAP_Message_t* pReq, CoAP_Message_t* pResp) {
if(pReq->Code == REQ_POST) {
CoAP_option_t* pOpt;
bool Found = false;

for(pOpt =pReq->pOptionsList ; pOpt != NULL; pOpt = pOpt->next) {
switch(CoAP_FindUriQueryVal(pOpt,"",3, "on", "off", "tgl")) { // etuliitettä ei käytetä
case 0: break; //ei löydy
case 1: led(true); Found=true; break; //found "on".
case 2: led(false); Found=true; break; //löytyi "off".
case 3: led(!LedState); Found=true; break; //löytyi "tgl".
}
if(Found) {
SetLedstatePayload(pReq, pResp);
tauko;
}
}

if(!Found){
char info[] = {"usage: coap://.../led_gpio12?on (tai "off", "tgl")"};
CoAP_SetPayload(pReq, pResp, info, coap_strlen(info), true);
pResp->Code=RESP_ERROR_BAD_REQUEST_4_00;
}

}else if(pReq->Code == REQ_GET){
SetLedstatePayload(pReq, pResp);
}

return HANDLER_OK;
}

static CoAP_HandlerResult_t Res_NotifyHandler(CoAP_Observer_t* pObserver, CoAP_Message_t* pResp) {
SetLedstatePayload(NULL, pResp);
return HANDLER_OK;
}

CoAP_Res_t* Create_Led_Resource() {
CoAP_ResOpts_t Options = {.Cf = COAP_CF_TEXT_PLAIN, .Flags = RES_OPT_POST | RES_OPT_GET};
return (pLed_Res=CoAP_CreateResource("esp8266/led_gpio12", "LED at GPIO12",Options, Res_ReqHandler, Res_NotifyHandler));
}
[/koodi]

iso blockwise resurssi

Tämä resurssi lähetetään useiden GET-pyyntöjen kautta käyttäen blockwise-protokollaa (draft-ietf-core-block-18).
[code lang="c"]
static const char CoapInfoStringInFlash[] = {"
CoAP (Constrained Application Protocol) on erikoistunut verkkoprotokolla.
siirtoprotokolla, jota käytetään rajoitettujen solmujen ja rajoitettujen verkkojen kanssa.
(esim. pienitehoiset, häviölliset) verkot. Solmuilla on usein 8-bittiset
mikrokontrollerit, joissa on pieni määrä ROM- ja RAM-muistia, kun taas rajoitetut
verkot, kuten IPv6 pienitehoisten langattomien henkilökohtaisten alueverkkojen välityksellä
(6LoWPAN) on usein korkea pakettivirheiden määrä ja tyypillinen
10 kbit/s:n läpäisykyky. Protokolla on suunniteltu kone- ja
M2M-sovellukset, kuten älykkäät energia- ja rakennussovellukset.
automaatio.rnrn

CoAP tarjoaa pyyntö-vastaus-vuorovaikutusmallin seuraavien välillä
sovellusten päätepisteet, tukee sisäänrakennettua palvelujen löytämistä ja
resursseja, ja se sisältää Webin keskeiset käsitteet, kuten URI:t ja
Internet-mediatyypit. CoAP on suunniteltu helposti liitettäväksi HTTP:hen
integrointiin Webin kanssa ja samalla erityisvaatimusten täyttämiseen.
kuten multicast-tuki, erittäin pieni yleiskustannus ja yksinkertaisuus, kun on kyse
rajoitetuissa ympäristöissä.
“};

CoAP_Res_t* pAbout_Res = NULL;

static CoAP_HandlerResult_t RequestHandler(CoAP_Message_t* pReq, CoAP_Message_t* pResp) {
static uint16_t payloadSize = sizeof(CoapInfoStringInFlash)-1;

CoAP_SetPayload(pReq, pResp, (uint8_t*)&(CoapInfoStringInFlash[0]), payloadSize, false);

return HANDLER_OK;
}

CoAP_Res_t* Create_About_Resource() {
CoAP_ResOpts_t Options = {.Cf = COAP_CF_TEXT_PLAIN, .Flags = RES_OPT_GET};
return (pAbout_Res=CoAP_CreateResource("about/coap", "CoAP Description",Options, RequestHandler, NULL));
}
[/koodi]

RTC-kellon asettaminen URI-kyselyllä

Tämä resurssi asettaa DS3231 RTC:n CoAP-pyynnön kautta päivämääräksi 21.2.2016 14:00h.

coap://[IP]:5683/ds3231?y=2016&mn=2&d=21&h=14&m=0&s=0

[code lang="c"]
static CoAP_HandlerResult_t Handler(CoAP_Message_t* pReq, CoAP_Message_t* pResp)
{
static char myString[100];
static datetime_t datetime;

uint8_t valLen = 0;
uint8_t* pVal = NULL;

drv_DS3231_GetDateTime(&datetime);
if(pReq->Code == REQ_PUT) {
if((pVal=CoAP_GetUriQueryValFromMsg(pReq, "d=", &valLen)) && valLen) datetime.w_day = (uint8_t) CoAP_atoi(pVal, valLen);
if((pVal=CoAP_GetUriQueryValFromMsg(pReq, "h=", &valLen)) && valLen) datetime.hour = (uint8_t) CoAP_atoi(pVal, valLen);
if((pVal=CoAP_GetUriQueryValFromMsg(pReq, "m=", &valLen)) && valLen) datetime.min = (uint8_t) CoAP_atoi(pVal, valLen);
if((pVal=CoAP_GetUriQueryValFromMsg(pReq, "s=", &valLen)) && valLen) datetime.sec = (uint8_t) CoAP_atoi(pVal, valLen);
if((pVal=CoAP_GetUriQueryValFromMsg(pReq, "mm=", &valLen)) && valLen) datetime.w_month = (uint8_t) CoAP_atoi(pVal, valLen);
if((pVal=CoAP_GetUriQueryValFromMsg(pReq, "y=", &valLen)) && valLen) datetime.w_year = (uint8_t) CoAP_atoi(pVal, valLen);
drv_DS3231_SetDateTime(&datetime);
}

sprintf(myString,”%02d.%02d.20%02d %02d:%02d:%02drn”, datetime.w_day, datetime.w_month, datetime.w_year, datetime.hour, datetime.min, datetime.sec);
CoAP_SetPayload(pReq, pResp, myString, strlen(myString), false);

return HANDLER_OK;
}
[/koodi]

Lobaro CoAP

Lobaro CoAP

Pikatietoja

Keskeiset termit

Yksinkertainen "CoAP GET" esimerkki

Havainnoitava resurssi esimerkki

resurssien hallinta uri-query-kyselyn avulla

iso blockwise resurssi

RTC-kellon asettaminen URI-kyselyllä

Esimerkkiprojekti: lobaro.com/lobaro-coap-on-esp8266

Lähde: github.com/Lobaro/lobaro-coap