1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

sys/shell: add 'ble' shell cmd for nimble_netif

This commit is contained in:
Hauke Petersen 2019-07-05 13:49:40 +02:00
parent 6bbe16601a
commit a3b8c87ab5
5 changed files with 409 additions and 0 deletions

View File

@ -443,6 +443,10 @@ ifneq (,$(filter shell_commands,$(USEMODULE)))
ifneq (,$(filter fib,$(USEMODULE)))
USEMODULE += posix_inet
endif
ifneq (,$(filter nimble_netif,$(USEMODULE)))
USEMODULE += nimble_scanner
USEMODULE += nimble_scanlist
endif
endif
ifneq (,$(filter posix_semaphore,$(USEMODULE)))

View File

@ -103,6 +103,10 @@ void nimble_riot_init(void)
#ifdef MODULE_NIMBLE_NETIF
extern void nimble_netif_init(void);
nimble_netif_init();
#ifdef MODULE_SHELL_COMMANDS
extern void sc_nimble_netif_init(void);
sc_nimble_netif_init();
#endif
#endif
/* initialize the configured, build-in services */

View File

@ -85,4 +85,8 @@ ifneq (,$(filter semtech-loramac,$(USEPKG)))
SRC += sc_loramac.c
endif
ifneq (,$(filter nimble_netif,$(USEMODULE)))
SRC += sc_nimble_netif.c
endif
include $(RIOTBASE)/Makefile.base

View File

@ -0,0 +1,390 @@
/*
* Copyright (C) 2019 Freie Universität Berlin
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @ingroup sys_shell_commands
* @{
*
* @file
* @brief Shell commands to control NimBLEs netif wrapper
*
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*
* @}
*/
#include <stdio.h>
#include <stdlib.h>
#include "xtimer.h"
#include "nimble_riot.h"
#include "nimble_scanlist.h"
#include "nimble_scanner.h"
#include "nimble_netif.h"
#include "nimble_netif_conn.h"
#include "net/bluetil/ad.h"
#include "net/bluetil/addr.h"
#define DEFAULT_NODE_NAME "RIOT-GNRC"
#define DEFAULT_SCAN_DURATION (500U) /* 500ms */
#define DEFAULT_CONN_TIMEOUT (500U) /* 500ms */
static void _on_ble_evt(int handle, nimble_netif_event_t event)
{
switch (event) {
case NIMBLE_NETIF_CONNECTED_MASTER: {
printf("event: handle %i -> CONNECTED as MASTER (", handle);
bluetil_addr_print(nimble_netif_conn_get(handle)->addr);
puts(")");
break;
}
case NIMBLE_NETIF_CONNECTED_SLAVE:
printf("event: handle %i -> CONNECTED as SLAVE (", handle);
bluetil_addr_print(nimble_netif_conn_get(handle)->addr);
puts(")");
break;
case NIMBLE_NETIF_CLOSED_MASTER:
case NIMBLE_NETIF_CLOSED_SLAVE:
printf("event: handle %i -> CONNECTION CLOSED\n", handle);
break;
case NIMBLE_NETIF_CONNECT_ABORT:
printf("event: handle %i -> CONNECTION ABORT\n", handle);
break;
case NIMBLE_NETIF_CONN_UPDATED:
default:
/* do nothing */
break;
}
}
static int _conn_dump(nimble_netif_conn_t *conn, int handle, void *arg)
{
(void)arg;
char role = (conn->state & NIMBLE_NETIF_GAP_MASTER) ? 'M' : 'S';
printf("[%2i] ", handle);
bluetil_addr_print(conn->addr);
printf(" (%c) -> ", role);
bluetil_addr_ipv6_l2ll_print(conn->addr);
puts("");
return 0;
}
static int _conn_state_dump(nimble_netif_conn_t *conn, int handle, void *arg)
{
(void)arg;
printf("[%2i] state: 0x%04x -", handle, conn->state);
if (conn->state & NIMBLE_NETIF_UNUSED) {
printf(" unused");
}
if (conn->state & NIMBLE_NETIF_CONNECTING) {
printf(" connecting");
}
if (conn->state & NIMBLE_NETIF_ADV) {
printf(" advertising");
}
if (conn->state & NIMBLE_NETIF_GAP_SLAVE) {
printf(" GAP-slave");
}
if (conn->state & NIMBLE_NETIF_GAP_MASTER) {
printf(" GAP-master");
}
if (conn->state & NIMBLE_NETIF_L2CAP_SERVER) {
printf(" L2CAP-server");
}
if (conn->state & NIMBLE_NETIF_L2CAP_CLIENT) {
printf(" L2CAP-client");
}
puts("");
return 0;
}
static void _conn_list(void)
{
nimble_netif_conn_foreach(NIMBLE_NETIF_L2CAP_CONNECTED, _conn_dump, NULL);
}
static void _cmd_info(void)
{
unsigned free = nimble_netif_conn_count(NIMBLE_NETIF_UNUSED);
unsigned active = nimble_netif_conn_count(NIMBLE_NETIF_L2CAP_CONNECTED);
uint8_t own_addr[BLE_ADDR_LEN];
uint8_t tmp_addr[BLE_ADDR_LEN];
ble_hs_id_copy_addr(nimble_riot_own_addr_type, tmp_addr, NULL);
bluetil_addr_swapped_cp(tmp_addr, own_addr);
printf("Own Address: ");
bluetil_addr_print(own_addr);
printf(" -> ");
bluetil_addr_ipv6_l2ll_print(own_addr);
puts("");
printf(" Free slots: %u/%u\n", free, MYNEWT_VAL_BLE_MAX_CONNECTIONS);
printf("Advertising: ");
if (nimble_netif_conn_get_adv() != NIMBLE_NETIF_CONN_INVALID) {
puts("yes");
}
else {
puts("no");
}
if (active > 0) {
printf("Connections: %u\n", active);
_conn_list();
}
puts(" Contexts:");
nimble_netif_conn_foreach(NIMBLE_NETIF_ANY, _conn_state_dump, NULL);
puts("");
}
static void _cmd_adv(const char *name)
{
int res;
(void)res;
uint8_t buf[BLE_HS_ADV_MAX_SZ];
bluetil_ad_t ad;
const struct ble_gap_adv_params _adv_params = {
.conn_mode = BLE_GAP_CONN_MODE_UND,
.disc_mode = BLE_GAP_DISC_MODE_LTD,
.itvl_min = BLE_GAP_ADV_FAST_INTERVAL2_MIN,
.itvl_max = BLE_GAP_ADV_FAST_INTERVAL2_MAX,
};
/* make sure no advertising is in progress */
if (nimble_netif_conn_is_adv()) {
puts("err: advertising already in progress");
return;
}
/* build advertising data */
res = bluetil_ad_init_with_flags(&ad, buf, BLE_HS_ADV_MAX_SZ,
BLUETIL_AD_FLAGS_DEFAULT);
assert(res == BLUETIL_AD_OK);
uint16_t ipss = BLE_GATT_SVC_IPSS;
res = bluetil_ad_add(&ad, BLE_GAP_AD_UUID16_INCOMP, &ipss, sizeof(ipss));
assert(res == BLUETIL_AD_OK);
if (name == NULL) {
name = DEFAULT_NODE_NAME;
}
res = bluetil_ad_add(&ad, BLE_GAP_AD_NAME, name, strlen(name));
if (res != BLUETIL_AD_OK) {
puts("err: the given name is too long");
return;
}
/* start listening for incoming connections */
res = nimble_netif_accept(ad.buf, ad.pos, &_adv_params);
if (res != NIMBLE_NETIF_OK) {
printf("err: unable to start advertising (%i)\n", res);
}
else {
printf("success: advertising this node as '%s'\n", name);
}
}
static void _cmd_adv_stop(void)
{
int res = nimble_netif_accept_stop();
if (res == NIMBLE_NETIF_OK) {
puts("canceled advertising");
}
else if (res == NIMBLE_NETIF_NOTADV) {
puts("no advertising in progress");
}
}
static void _cmd_scan(unsigned duration)
{
if (duration == 0) {
return;
}
printf("scanning (for %ums) ... ", (duration / 1000));
nimble_scanlist_clear();
nimble_scanner_start();
xtimer_usleep(duration);
nimble_scanner_stop();
puts("done");
nimble_scanlist_print();
}
static void _cmd_connect_addr(ble_addr_t *addr)
{
/* simply use NimBLEs default connection parameters */
int res = nimble_netif_connect(addr, NULL, DEFAULT_CONN_TIMEOUT);
if (res < 0) {
printf("err: unable to trigger connection sequence (%i)\n", res);
return;
}
printf("initiated connection procedure with ");
uint8_t addrn[BLE_ADDR_LEN];
bluetil_addr_swapped_cp(addr->val, addrn);
bluetil_addr_print(addrn);
puts("");
}
static void _cmd_connect_addstr(const char *addr_str)
{
uint8_t tmp[BLE_ADDR_LEN];
/* RANDOM is the most common type, has no noticeable effect when connecting
anyhow... */
ble_addr_t addr = { .type = BLE_ADDR_RANDOM };
if (bluetil_addr_from_str(tmp, addr_str) == NULL) {
puts("err: unable to parse address");
return;
}
/* NimBLE expects address in little endian, so swap */
bluetil_addr_swapped_cp(tmp, addr.val);
_cmd_connect_addr(&addr);
}
static void _cmd_connect(unsigned pos)
{
nimble_scanlist_entry_t *sle = nimble_scanlist_get_by_pos(pos);
if (sle == NULL) {
puts("err: unable to find given entry in scanlist");
return;
}
_cmd_connect_addr(&sle->addr);
}
static void _cmd_close(int handle)
{
int res = nimble_netif_close(handle);
if (res != NIMBLE_NETIF_OK) {
puts("err: unable to close connection with given handle");
}
else {
puts("success: connection tear down initiated");
}
}
static void _cmd_update(int handle, int itvl, int timeout)
{
struct ble_gap_upd_params params;
params.itvl_min = (uint16_t)((itvl * 1000) / BLE_HCI_CONN_ITVL);
params.itvl_max = (uint16_t)((itvl * 1000) / BLE_HCI_CONN_ITVL);
params.latency = 0;
params.supervision_timeout = (uint16_t)(timeout / 10);
params.min_ce_len = BLE_GAP_INITIAL_CONN_MIN_CE_LEN;
params.max_ce_len = BLE_GAP_INITIAL_CONN_MAX_CE_LEN;
int res = nimble_netif_update(handle, &params);
if (res != NIMBLE_NETIF_OK) {
puts("err: unable to update connection parameters for given handle");
}
else {
puts("success: connection parameters updated");
}
}
static int _ishelp(char *argv)
{
return memcmp(argv, "help", 4) == 0;
}
void sc_nimble_netif_init(void)
{
/* setup the scanning environment */
nimble_scanlist_init();
nimble_scanner_init(NULL, nimble_scanlist_update);
/* register event callback with the netif wrapper */
nimble_netif_eventcb(_on_ble_evt);
}
int _nimble_netif_handler(int argc, char **argv)
{
if ((argc == 1) || _ishelp(argv[1])) {
printf("usage: %s [help|info|adv|scan|connect|close|update]\n", argv[0]);
return 0;
}
if (memcmp(argv[1], "info", 4) == 0) {
_cmd_info();
}
else if (memcmp(argv[1], "adv", 3) == 0) {
char *name = NULL;
if (argc > 2) {
if (_ishelp(argv[2])) {
printf("usage: %s adv [help|stop|<name>]\n", argv[0]);
return 0;
}
if (memcmp(argv[2], "stop", 4) == 0) {
_cmd_adv_stop();
return 0;
}
name = argv[2];
}
_cmd_adv(name);
}
else if (memcmp(argv[1], "scan", 4) == 0) {
uint32_t duration = DEFAULT_SCAN_DURATION;
if (argc > 2) {
if (_ishelp(argv[2])) {
printf("usage: %s scan [help|list|[duration in ms]]\n", argv[0]);
return 0;
}
if (memcmp(argv[2], "list", 4) == 0) {
nimble_scanlist_print();
return 0;
}
duration = atoi(argv[2]);
}
_cmd_scan(duration * 1000);
}
else if (memcmp(argv[1], "connect", 7) == 0) {
if ((argc < 3) || _ishelp(argv[2])) {
printf("usage: %s connect [help|list|<scanlist entry #>|<BLE addr>]\n",
argv[0]);
}
if (memcmp(argv[2], "list", 4) == 0) {
_conn_list();
return 0;
}
if (strlen(argv[2]) == (BLUETIL_ADDR_STRLEN - 1)) {
_cmd_connect_addstr(argv[2]);
return 0;
}
unsigned pos = atoi(argv[2]);
_cmd_connect(pos);
}
else if (memcmp(argv[1], "close", 5) == 0) {
if ((argc < 3) || _ishelp(argv[2])) {
printf("usage: %s close [help|list|<conn #>]\n", argv[0]);
return 0;
}
if (memcmp(argv[2], "list", 4) == 0) {
_conn_list();
return 0;
}
int handle = atoi(argv[2]);
_cmd_close(handle);
}
else if ((memcmp(argv[1], "update", 6) == 0)) {
if ((argc < 5) || _ishelp(argv[2])) {
printf("usage: %s update [help|<handle> <itvl> <timeout>]\n",
argv[0]);
return 0;
}
int handle = atoi(argv[2]);
int itvl = atoi(argv[3]);
int timeout = atoi(argv[4]);
_cmd_update(handle, itvl, timeout);
}
else {
printf("unable to parse the command. Use '%s help' for more help\n",
argv[0]);
}
return 0;
}

View File

@ -153,6 +153,10 @@ extern int _i2c_scan(int argc, char **argv);
extern int _loramac_handler(int argc, char **argv);
#endif
#ifdef MODULE_NIMBLE_NETIF
extern int _nimble_netif_handler(int argc, char **argv);
#endif
const shell_command_t _shell_command_list[] = {
{"reboot", "Reboot the node", _reboot_handler},
#ifdef MODULE_CONFIG
@ -251,6 +255,9 @@ const shell_command_t _shell_command_list[] = {
#endif
#ifdef MODULE_SEMTECH_LORAMAC
{"loramac", "Control Semtech loramac stack", _loramac_handler},
#endif
#ifdef MODULE_NIMBLE_NETIF
{ "ble", "Manage BLE connections for NimBLE", _nimble_netif_handler },
#endif
{NULL, NULL, NULL}
};