Lobaro CoAP

Denne siden er en introduksjon til vår gratis CoAP-programvarestakken "Lobaro-CoAP", som gjør det mulig å lage CoAP-applikasjoner i C og andre programmeringsspråk.

Målgruppen er erfarne programmerere med god kjennskap til programmeringsspråket "C".

Prosjektside på Github
Eksempel på ESP8266-prosjekt

Vi tilbyr også integrasjon i andre språk som er basert på samme C-kode:

Lobaro CoAP Go på Github

Kjappe fakta

brukervennlig "C" CoAP-stabel
fullstendig logikk for forespørsel/svar
fullstendig retry-logikk
piggybacked og separate svar
forberedt for sovende server
Demoer for ESP8266 (IPv4), ZWIR4512 (IPv6)

Nøkkelbegreper

OpenSource (MIT-lisens)
Klient + server
RFC7252 (CoAP, kjerne)
RFC7641 (Observe)
RFC7641 avansert overføring
Blokkvise overføringer

Enkelt "CoAP GET"-eksempel

Denne ressursen returnerer gjeldende ip-konfigurasjon som nyttelast og nås via "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,"Stasjon: %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* Opprett_Wifi_IPs_Ressource() {
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));
}
[/code] [/code

Eksempel på observerbar ressurs

Denne observerbare ressursen returnerer gjeldende systemtid og er tilgjengelig via "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;
}

//Oppdater observatører hvert sekund
#define DELAY_LOOP 1000 // millisekunder
LOCAL os_timer_t Notify_timer;

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

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

//Start tidtaker for oppdatering
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));
}
[/code] [/code

ressurskontroll via uri-forespørsel

Denne ressursen kan endre tilstanden til en led via "POST coap://.../esp8266/led_gpio12″.
[code lang="c" highlight="12-17″] [code lang="c" highlight="12-17″]
static void SetLedstatePayload(CoAP_Message_t* pReq, CoAP_Message_t* pResp){
if(LedState) CoAP_SetPayload(pReq, pResp, "Led er på!", coap_strlen("Led er på!"), true);
else CoAP_SetPayload(pReq, pResp, "Led er av!", coap_strlen("Led er av!"), 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 Funnet = false;

for(pOpt =pReq->pOptionsList ; pOpt != NULL; pOpt = pOpt->next) {
switch(CoAP_FindUriQueryVal(pOpt,"",3,"on","off","tgl"))) { // ingen prefiks brukt
case 0: break; //ikke funnet
case 1: led(true); Found=true; break; //found "on"
case 2: led(false); Found=true; break; //found "off"
case 3: led(!LedState); Found=true; break; //found "tgl"
}
if(Funnet) {
SetLedstatePayload(pReq, pResp);
pause;
}
}

if(!Found){
char info[] = {"usage: coap://.../led_gpio12?on (or "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* Opprett_Led_Ressurs() {
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 på GPIO12",Options, Res_ReqHandler, Res_NotifyHandler));
}
[/code] [/code

stor blokkvis ressurs

Denne ressursen overføres over flere GET-forespørsler ved hjelp av den blokkvise protokollen (draft-ietf-core-block-18).
[code lang="c"]
static const char CoapInfoStringInFlash[] = {"
Den begrensede applikasjonsprotokollen (CoAP) er en spesialisert web
overføringsprotokoll for bruk med begrensede noder og begrensede
(f.eks. nettverk med lavt strømforbruk og tap). Nodene har ofte 8-bits
mikrokontrollere med små mengder ROM og RAM, mens de er begrensede
nettverk som IPv6 over trådløse nettverk med lav effekt (Low-Power Wireless Personal Area Networks)
(6LoWPANs) har ofte høye pakkefeilrater og en typisk
gjennomstrømning på 10s kbit/s. Protokollen er utformet for maskin- og
til-maskin (M2M)-applikasjoner som smart energi og bygninger, og
automatisering.rnrn

CoAP gir en interaksjonsmodell for forespørsel/svar mellom
applikasjonsendepunkter, støtter innebygget oppdagelse av tjenester og
ressurser, og inkluderer nøkkelkonsepter på nettet som URI-er og
Internett-medietyper. CoAP er designet for å enkelt grensesnitt med HTTP
for integrasjon med nettet samtidig som de oppfyller spesialiserte krav
for eksempel støtte for multikast, svært lav overhead og enkelhet for
begrensede miljøer.
“};

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* Opprett_om_Ressurs() {
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));
}
[/code] [/code

Angi RTC-klokke etter URI-spørring

Denne ressursen setter en DS3231 RTC via CoAP-forespørsel til dato 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->Kode == 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;
}
[/code] [/code

Lobaro CoAP

Lobaro CoAP

Kjappe fakta

Nøkkelbegreper

Enkelt "CoAP GET"-eksempel

Eksempel på observerbar ressurs

ressurskontroll via uri-forespørsel

stor blokkvis ressurs

Angi RTC-klokke etter URI-spørring

Eksempel på prosjekt: lobaro.com/lobaro-coap-on-esp8266

Kilde: github.com/Lobaro/lobaro-coap