Skip to content

Commit

Permalink
Merge #18156
Browse files Browse the repository at this point in the history 
18156: pkg/opendsme: add initial support for IEEE 802.15.4 DSME time-slotted MAC r=chrysn a=jia200x



Co-authored-by: Jose Alamos <jose@alamos.cc>
  • Loading branch information
@bors @jia200x
bors[bot] and jia200x authored May 31, 2023
2 parents d742513 + 972304c commit 597b68c
Show file tree
Hide file tree
Showing 31 changed files with 3,314 additions and 95 deletions.
16 changes: 2 additions & 14 deletions examples/gcoap/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,21 +56,9 @@ Start the libcoap example server with the command below.

./coap-server

\
Below are some example queries to enter into the RIOT CLI. Ports can be omitted.
The port defaults to 5683 for the `gcoap` and to 5684 for the `gcoap_dtls` example.
Enter the query below in the RIOT CLI.

- For IPv6 setup (network interface can be omitted)

> coap get [fe80::d8b8:65ff:feee:121b%6]:5683 /.well-known/core
- For IPv4 setup

> coap get 192.168.2.135:5683 /.well-known/core
- When including the module `sock_dns` for domain resolution

> coap get example.com:5683 /.well-known/core
> coap get fe80::d8b8:65ff:feee:121b%6 5683 /.well-known/core

CLI output:

Expand Down
186 changes: 112 additions & 74 deletions examples/gcoap/client.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
*
* @author Ken Bannister <kb2ma@runbox.com>
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Hendrik van Essen <hendrik.ve@fu-berlin.de>
*
* @}
*/
Expand All @@ -25,11 +24,8 @@
#include <stdlib.h>
#include <string.h>

#include <arpa/inet.h>

#include "fmt.h"
#include "net/gcoap.h"
#include "net/sock/util.h"
#include "net/utils.h"
#include "od.h"

Expand Down Expand Up @@ -145,7 +141,59 @@ static void _resp_handler(const gcoap_request_memo_t *memo, coap_pkt_t* pdu,
}
}

static size_t _send(uint8_t *buf, size_t len, char *addr_str)
static bool _parse_endpoint(sock_udp_ep_t *remote, const char *addr_str, const char *port_str)
{
bool is_ipv4 = false;
bool is_ipv6 = false;

if (IS_ACTIVE(SOCK_HAS_IPV6)) {
netif_t *netif;
/* IPv6 might contain '.', but IPv4 cannot contain ':' */
if (strstr(addr_str, ":") != NULL) {

/* parse hostname */
if (netutils_get_ipv6((ipv6_addr_t *)&remote->addr, &netif, addr_str) < 0) {
puts("gcoap_cli: unable to parse destination ipv6 address");
return false;
}

is_ipv6 = true;
remote->netif = netif ? netif_get_id(netif) : SOCK_ADDR_ANY_NETIF;
remote->family = AF_INET6;
}
}

if (IS_ACTIVE(SOCK_HAS_IPV4)) {
if (!is_ipv6 && strstr(addr_str, ".") != NULL) { /* IPv4 */

/* parse hostname */
if (netutils_get_ipv4((ipv4_addr_t *)&remote->addr, addr_str) < 0) {
puts("gcoap_cli: unable to parse destination ipv4 address");
return false;
}

is_ipv4 = true;
remote->netif = SOCK_ADDR_ANY_NETIF;
remote->family = AF_INET;
}
}

if (!is_ipv4 && !is_ipv6) {
puts("gcoap_cli: unable to parse destination address");
return false;
}

/* parse port */
remote->port = atoi(port_str);
if (remote->port == 0) {
puts("gcoap_cli: unable to parse destination port");
return false;
}

return true;
}

static size_t _send(uint8_t *buf, size_t len, char *addr_str, char *port_str)
{
size_t bytes_sent;
sock_udp_ep_t *remote;
Expand All @@ -155,19 +203,9 @@ static size_t _send(uint8_t *buf, size_t len, char *addr_str)
remote = &_proxy_remote;
}
else {
if (sock_udp_name2ep(&new_remote, addr_str) != 0) {
if (!_parse_endpoint(&new_remote, addr_str, port_str)) {
return 0;
}

if (new_remote.port == 0) {
if (IS_USED(MODULE_GCOAP_DTLS)) {
new_remote.port = CONFIG_GCOAPS_PORT;
}
else {
new_remote.port = CONFIG_GCOAP_PORT;
}
}

remote = &new_remote;
}

Expand Down Expand Up @@ -219,13 +257,28 @@ int gcoap_cli_cmd(int argc, char **argv)
#else
char addrstr[IPV4_ADDR_MAX_STR_LEN];
#endif
inet_ntop(_proxy_remote.family, &_proxy_remote.addr, addrstr, sizeof(addrstr));

if (_proxy_remote.family == AF_INET6) {
printf("[%s]:%u\n", addrstr, _proxy_remote.port);
}
else {
printf("%s:%u\n", addrstr, _proxy_remote.port);
switch (_proxy_remote.family) {
#ifdef SOCK_HAS_IPV4
case AF_INET:
printf("%s:%u\n",
ipv4_addr_to_str(addrstr,
(ipv4_addr_t *) &_proxy_remote.addr.ipv4,
sizeof(addrstr)),
_proxy_remote.port);
break;
#endif
#ifdef SOCK_HAS_IPV6
case AF_INET6:
printf("[%s]:%u\n",
ipv6_addr_to_str(addrstr,
(ipv6_addr_t *) &_proxy_remote.addr.ipv6,
sizeof(addrstr)),
_proxy_remote.port);
break;
#endif
default:
assert(0);
}
}
else {
Expand All @@ -234,21 +287,11 @@ int gcoap_cli_cmd(int argc, char **argv)
return 0;
}
else if (strcmp(argv[1], "proxy") == 0) {
if ((argc == 4) && (strcmp(argv[2], "set") == 0)) {
if (sock_udp_name2ep(&_proxy_remote, argv[3]) != 0) {
if ((argc == 5) && (strcmp(argv[2], "set") == 0)) {
if (!_parse_endpoint(&_proxy_remote, argv[3], argv[4])) {
puts("Could not set proxy");
return 1;
}

if (_proxy_remote.port == 0) {
if (IS_USED(MODULE_GCOAP_DTLS)) {
_proxy_remote.port = CONFIG_GCOAPS_PORT;
}
else {
_proxy_remote.port = CONFIG_GCOAP_PORT;
}
}

_proxied = true;
return 0;
}
Expand All @@ -257,7 +300,15 @@ int gcoap_cli_cmd(int argc, char **argv)
_proxied = false;
return 0;
}
printf("usage: %s proxy set <host>[:port]\n", argv[0]);

if (IS_ACTIVE(SOCK_HAS_IPV4)) {
printf("usage: %s proxy set <IPv4 addr> <port>\n", argv[0]);
}

if (IS_ACTIVE(SOCK_HAS_IPV6)) {
printf("usage: %s proxy set <IPv6 addr>[%%iface] <port>\n", argv[0]);
}

printf(" %s proxy unset\n", argv[0]);
return 1;
}
Expand All @@ -282,16 +333,16 @@ int gcoap_cli_cmd(int argc, char **argv)
apos++;
}

if (((argc == apos + 1) && (code_pos == 0)) || /* ping */
((argc == apos + 2) && (code_pos == 1)) || /* get */
((argc == apos + 2 ||
argc == apos + 3) && (code_pos > 1))) { /* post or put */
if (((argc == apos + 2) && (code_pos == 0)) || /* ping */
((argc == apos + 3) && (code_pos == 1)) || /* get */
((argc == apos + 3 ||
argc == apos + 4) && (code_pos > 1))) { /* post or put */

char *uri = NULL;
int uri_len = 0;
if (code_pos) {
uri = argv[apos+1];
uri_len = strlen(argv[apos+1]);
uri = argv[apos+2];
uri_len = strlen(argv[apos+2]);
}

if (uri && ((uri_len <= 0) || (uri[0] != '/'))) {
Expand All @@ -300,36 +351,14 @@ int gcoap_cli_cmd(int argc, char **argv)
}

if (_proxied) {
sock_udp_ep_t tmp_remote;
if (sock_udp_name2ep(&tmp_remote, argv[apos]) != 0) {
return _print_usage(argv);
}

if (tmp_remote.port == 0) {
if (IS_USED(MODULE_GCOAP_DTLS)) {
tmp_remote.port = CONFIG_GCOAPS_PORT;
}
else {
tmp_remote.port = CONFIG_GCOAP_PORT;
}
}

#ifdef SOCK_HAS_IPV6
char addrstr[IPV6_ADDR_MAX_STR_LEN];
#else
char addrstr[IPV4_ADDR_MAX_STR_LEN];
#endif
inet_ntop(tmp_remote.family, &tmp_remote.addr, addrstr, sizeof(addrstr));

if (tmp_remote.family == AF_INET6) {
uri_len = snprintf(proxy_uri, sizeof(proxy_uri), "coap://[%s]:%d%s",
addrstr, tmp_remote.port, uri);
/* IPv6 might contain '.', but IPv4 cannot contain ':' */
if (strstr(argv[apos], ":") != NULL) {
uri_len = snprintf(proxy_uri, 64, "coap://[%s]:%s%s",
argv[apos], argv[apos+1], uri);
}
else {
uri_len = snprintf(proxy_uri, sizeof(proxy_uri), "coap://%s:%d%s",
addrstr, tmp_remote.port, uri);
uri_len = snprintf(proxy_uri, 64, "coap://%s:%s%s", argv[apos], argv[apos+1], uri);
}

uri = proxy_uri;

gcoap_req_init(&pdu, &buf[0], CONFIG_GCOAP_PDU_BUF_SIZE, code_pos, NULL);
Expand All @@ -344,7 +373,7 @@ int gcoap_cli_cmd(int argc, char **argv)
memcpy(_last_req_path, uri, uri_len);
}

size_t paylen = (argc == apos + 3) ? strlen(argv[apos+2]) : 0;
size_t paylen = (argc == apos + 4) ? strlen(argv[apos+3]) : 0;
if (paylen) {
coap_opt_add_format(&pdu, COAP_FORMAT_TEXT);
}
Expand All @@ -356,7 +385,7 @@ int gcoap_cli_cmd(int argc, char **argv)
if (paylen) {
len = coap_opt_finish(&pdu, COAP_OPT_FINISH_PAYLOAD);
if (pdu.payload_len >= paylen) {
memcpy(pdu.payload, argv[apos+2], paylen);
memcpy(pdu.payload, argv[apos+3], paylen);
len += paylen;
}
else {
Expand All @@ -370,7 +399,7 @@ int gcoap_cli_cmd(int argc, char **argv)

printf("gcoap_cli: sending msg ID %u, %u bytes\n", coap_get_id(&pdu),
(unsigned) len);
if (!_send(&buf[0], len, argv[apos])) {
if (!_send(&buf[0], len, argv[apos], argv[apos+1])) {
puts("gcoap_cli: msg send failed");
}
else {
Expand All @@ -380,9 +409,18 @@ int gcoap_cli_cmd(int argc, char **argv)
return 0;
}
else {
printf("usage: %s <get|post|put> [-c] <host>[:port] <path> [data]\n",
argv[0]);
printf(" %s ping <host>[:port]\n", argv[0]);
if (IS_ACTIVE(SOCK_HAS_IPV4)) {
printf("usage: %s <get|post|put> [-c] <IPv4 addr> <port> <path> [data]\n",
argv[0]);
printf(" %s ping <IPv4 addr> <port>\n", argv[0]);
}

if (IS_ACTIVE(SOCK_HAS_IPV6)) {
printf("usage: %s <get|post|put> [-c] <IPv6 addr>[%%iface] <port> <path> [data]\n",
argv[0]);
printf(" %s ping <IPv6 addr>[%%iface] <port>\n", argv[0]);
}

printf("Options\n");
printf(" -c Send confirmably (defaults to non-confirmable)\n");
return 1;
Expand Down
51 changes: 51 additions & 0 deletions examples/opendsme/Makefile
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# name of your application
APPLICATION = opendsme_example

# If no BOARD is found in the environment, use this default:
BOARD ?= nrf52840dk

# DSME uses beacon transmission, which are usually filtered out in current drivers.
# So far, nrf802154 is the only driver that supports beacons, which means openDSME
# will run only in nrf802154-based CPUs.
FEATURES_REQUIRED += cpu_nrf52

# This has to be the absolute path to the RIOT base directory:
RIOTBASE ?= $(CURDIR)/../..

# Uncomment these lines if you want to use platform support from external
# repositories:
#RIOTCPU ?= $(CURDIR)/../../../thirdparty_cpu
#EXTERNAL_BOARD_DIRS ?= $(CURDIR)/../../../thirdparty_boards

# Uncomment this to enable scheduler statistics for ps:
#CFLAGS += -DSCHEDSTATISTICS

# If you want to use native with valgrind, you should recompile native
# with the target all-valgrind instead of all:
# make -B clean all-valgrind

# Comment this out to disable code in RIOT that does safety checking
# which is not needed in a production environment but helps in the
# development process:
DEVELHELP ?= 1

# Change this to 0 show compiler invocation lines by default:
QUIET ?= 1

USEMODULE += ps
USEMODULE += shell
USEMODULE += shell_cmds_default

USEPKG += opendsme
USEMODULE += auto_init_gnrc_netif
USEMODULE += l2util
USEMODULE += gnrc_pktdump
USEMODULE += gnrc_txtsnd

USEMODULE += netdev_default

# Some boards (e.g nrf52840dongle) require a higher CCA threshold to avoid
# false positives.
CFLAGS += -DCONFIG_IEEE802154_CCA_THRESH_DEFAULT=-30

include $(RIOTBASE)/Makefile.include
5 changes: 5 additions & 0 deletions examples/opendsme/Makefile.ci
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
BOARD_INSUFFICIENT_MEMORY := \
nrf52dk \
nrf52840dk \
nrf52840dongle \
#
Loading

0 comments on commit 597b68c

Please # to comment.