mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
c06335b71b
Previously `shell_commands` was a "catch-all" module that included shell commands for each and every used module that has a shell companion. Instead, the new `shell_cmds` module is now used to provide shell commands as individually selectable submodules, e.g. `cmd_gnrc_icmpv6_echo` now provides the ICMPv6 echo command (a.k.a. ping). To still have a "catch all" module to pull in shell commands of modules already used, `shell_cmds_default` was introduced. `shell_commands` depends now on `shell_cmds_default` for backward compatibility, but has been deprecated. New apps should use `shell_cmds_default` instead. For a handful of shell commands individual selection was already possible. Those modules now depend on the corresponding `cmd_%` module and they have been deprecated.
516 lines
17 KiB
C
516 lines
17 KiB
C
/*
|
|
* Copyright 2018 Inria
|
|
*
|
|
* 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 command implementation for Semtech loramac stack
|
|
*
|
|
* @author Alexandre Abadie <alexandre.abadie@inria.fr>
|
|
*
|
|
* @}
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
|
|
#include "fmt.h"
|
|
#include "net/loramac.h"
|
|
#include "semtech_loramac.h"
|
|
#include "shell.h"
|
|
|
|
extern semtech_loramac_t loramac;
|
|
|
|
/* Application key is 16 bytes long (e.g. 32 hex chars), and thus the longest
|
|
possible size (with application session and network session keys) */
|
|
static char print_buf[LORAMAC_APPKEY_LEN * 2 + 1];
|
|
|
|
static void _loramac_usage(void)
|
|
{
|
|
puts("Usage: loramac <get|set|join|tx"
|
|
#ifdef MODULE_SEMTECH_LORAMAC_RX
|
|
"|link_check"
|
|
#endif
|
|
#ifdef MODULE_PERIPH_EEPROM
|
|
"|save|erase"
|
|
#endif
|
|
">");
|
|
}
|
|
|
|
static void _loramac_join_usage(void)
|
|
{
|
|
puts("Usage: loramac join <otaa|abp>");
|
|
}
|
|
|
|
static void _loramac_tx_usage(void)
|
|
{
|
|
puts("Usage: loramac tx <payload> [<cnf|uncnf>] [port]");
|
|
}
|
|
|
|
static void _loramac_set_usage(void)
|
|
{
|
|
puts("Usage: loramac set <deveui|appeui|appkey|appskey|nwkskey|devaddr|"
|
|
"class|dr|adr|public|netid|tx_power|rx2_freq|rx2_dr|ul_cnt|ch_mask> <value>");
|
|
}
|
|
|
|
static void _loramac_get_usage(void)
|
|
{
|
|
puts("Usage: loramac get <deveui|appeui|appkey|appskey|nwkskey|devaddr|"
|
|
"class|dr|adr|public|netid|tx_power|rx2_freq|rx2_dr|ul_cnt|ch_mask>");
|
|
}
|
|
|
|
static int _loramac_handler(int argc, char **argv)
|
|
{
|
|
if (argc < 2) {
|
|
_loramac_usage();
|
|
return 1;
|
|
}
|
|
|
|
if (strcmp(argv[1], "get") == 0) {
|
|
if (argc < 3) {
|
|
_loramac_get_usage();
|
|
return 1;
|
|
}
|
|
|
|
if (strcmp("deveui", argv[2]) == 0) {
|
|
uint8_t deveui[LORAMAC_DEVEUI_LEN];
|
|
semtech_loramac_get_deveui(&loramac, deveui);
|
|
fmt_bytes_hex(print_buf, deveui, LORAMAC_DEVEUI_LEN);
|
|
print_buf[LORAMAC_DEVEUI_LEN * 2] = '\0';
|
|
printf("DEVEUI: %s\n", print_buf);
|
|
}
|
|
else if (strcmp("appeui", argv[2]) == 0) {
|
|
uint8_t appeui[LORAMAC_APPEUI_LEN];
|
|
semtech_loramac_get_appeui(&loramac, appeui);
|
|
fmt_bytes_hex(print_buf, appeui, LORAMAC_APPEUI_LEN);
|
|
print_buf[LORAMAC_APPEUI_LEN * 2] = '\0';
|
|
printf("APPEUI: %s\n", print_buf);
|
|
}
|
|
else if (strcmp("appkey", argv[2]) == 0) {
|
|
uint8_t appkey[LORAMAC_APPKEY_LEN];
|
|
semtech_loramac_get_appkey(&loramac, appkey);
|
|
fmt_bytes_hex(print_buf, appkey, LORAMAC_APPKEY_LEN);
|
|
print_buf[LORAMAC_APPKEY_LEN * 2] = '\0';
|
|
printf("APPKEY: %s\n", print_buf);
|
|
}
|
|
else if (strcmp("appskey", argv[2]) == 0) {
|
|
uint8_t appskey[LORAMAC_APPSKEY_LEN];
|
|
semtech_loramac_get_appskey(&loramac, appskey);
|
|
fmt_bytes_hex(print_buf, appskey, LORAMAC_APPSKEY_LEN);
|
|
print_buf[LORAMAC_APPSKEY_LEN * 2] = '\0';
|
|
printf("APPSKEY: %s\n", print_buf);
|
|
}
|
|
else if (strcmp("nwkskey", argv[2]) == 0) {
|
|
uint8_t nwkskey[LORAMAC_NWKSKEY_LEN];
|
|
semtech_loramac_get_nwkskey(&loramac, nwkskey);
|
|
fmt_bytes_hex(print_buf, nwkskey, LORAMAC_NWKSKEY_LEN);
|
|
print_buf[LORAMAC_NWKSKEY_LEN * 2] = '\0';
|
|
printf("NWKSKEY: %s\n", print_buf);
|
|
}
|
|
else if (strcmp("devaddr", argv[2]) == 0) {
|
|
uint8_t devaddr[LORAMAC_DEVADDR_LEN];
|
|
semtech_loramac_get_devaddr(&loramac, devaddr);
|
|
fmt_bytes_hex(print_buf, devaddr, LORAMAC_DEVADDR_LEN);
|
|
print_buf[LORAMAC_DEVADDR_LEN * 2] = '\0';
|
|
printf("DEVADDR: %s\n", print_buf);
|
|
}
|
|
else if (strcmp("class", argv[2]) == 0) {
|
|
printf("Device class: ");
|
|
switch(semtech_loramac_get_class(&loramac)) {
|
|
case LORAMAC_CLASS_A:
|
|
puts("A");
|
|
break;
|
|
case LORAMAC_CLASS_B:
|
|
puts("B");
|
|
break;
|
|
case LORAMAC_CLASS_C:
|
|
puts("C");
|
|
break;
|
|
default:
|
|
puts("Invalid");
|
|
break;
|
|
}
|
|
}
|
|
else if (strcmp("dr", argv[2]) == 0) {
|
|
printf("DATARATE: %d\n",
|
|
semtech_loramac_get_dr(&loramac));
|
|
}
|
|
else if (strcmp("adr", argv[2]) == 0) {
|
|
printf("ADR: %s\n",
|
|
semtech_loramac_get_adr(&loramac) ? "on" : "off");
|
|
}
|
|
else if (strcmp("public", argv[2]) == 0) {
|
|
printf("Public network: %s\n",
|
|
semtech_loramac_get_public_network(&loramac) ? "on" : "off");
|
|
}
|
|
else if (strcmp("netid", argv[2]) == 0) {
|
|
printf("NetID: %"PRIu32"\n", semtech_loramac_get_netid(&loramac));
|
|
}
|
|
else if (strcmp("tx_power", argv[2]) == 0) {
|
|
printf("TX power index: %d\n", semtech_loramac_get_tx_power(&loramac));
|
|
}
|
|
else if (strcmp("rx2_freq", argv[2]) == 0) {
|
|
printf("RX2 freq: %"PRIu32"\n", semtech_loramac_get_rx2_freq(&loramac));
|
|
}
|
|
else if (strcmp("rx2_dr", argv[2]) == 0) {
|
|
printf("RX2 dr: %d\n", semtech_loramac_get_rx2_dr(&loramac));
|
|
}
|
|
else if (strcmp("ul_cnt", argv[2]) == 0) {
|
|
printf("Uplink Counter: %"PRIu32"\n", semtech_loramac_get_uplink_counter(&loramac));
|
|
}
|
|
else if (strcmp("ch_mask", argv[2]) == 0) {
|
|
uint16_t mask[LORAMAC_CHANNELS_MASK_LEN] = { 0 };
|
|
semtech_loramac_get_channels_mask(&loramac, mask);
|
|
printf("Channels mask: ");
|
|
for (size_t i = 0; i < LORAMAC_CHANNELS_MASK_LEN; i++) {
|
|
printf("%04x", mask[i]);
|
|
}
|
|
printf("\n");
|
|
}
|
|
else {
|
|
_loramac_get_usage();
|
|
return 1;
|
|
}
|
|
}
|
|
else if (strcmp(argv[1], "set") == 0) {
|
|
if (argc < 3) {
|
|
_loramac_set_usage();
|
|
return 1;
|
|
}
|
|
|
|
if (strcmp("deveui", argv[2]) == 0) {
|
|
if ((argc < 4) || (strlen(argv[3]) != LORAMAC_DEVEUI_LEN * 2)) {
|
|
puts("Usage: loramac set deveui <16 hex chars>");
|
|
return 1;
|
|
}
|
|
uint8_t deveui[LORAMAC_DEVEUI_LEN];
|
|
fmt_hex_bytes(deveui, argv[3]);
|
|
semtech_loramac_set_deveui(&loramac, deveui);
|
|
}
|
|
else if (strcmp("appeui", argv[2]) == 0) {
|
|
if ((argc < 4) || (strlen(argv[3]) != LORAMAC_APPEUI_LEN * 2)) {
|
|
puts("Usage: loramac set appeui <16 hex chars>");
|
|
return 1;
|
|
}
|
|
uint8_t appeui[LORAMAC_APPEUI_LEN];
|
|
fmt_hex_bytes(appeui, argv[3]);
|
|
semtech_loramac_set_appeui(&loramac, appeui);
|
|
}
|
|
else if (strcmp("appkey", argv[2]) == 0) {
|
|
if ((argc < 4) || (strlen(argv[3]) != LORAMAC_APPKEY_LEN * 2)) {
|
|
puts("Usage: loramac set appkey <32 hex chars>");
|
|
return 1;
|
|
}
|
|
uint8_t appkey[LORAMAC_APPKEY_LEN];
|
|
fmt_hex_bytes(appkey, argv[3]);
|
|
semtech_loramac_set_appkey(&loramac, appkey);
|
|
}
|
|
else if (strcmp("appskey", argv[2]) == 0) {
|
|
if ((argc < 4) || (strlen(argv[3]) != LORAMAC_APPSKEY_LEN * 2)) {
|
|
puts("Usage: loramac set appskey <32 hex chars>");
|
|
return 1;
|
|
}
|
|
uint8_t appskey[LORAMAC_APPSKEY_LEN];
|
|
fmt_hex_bytes(appskey, argv[3]);
|
|
semtech_loramac_set_appskey(&loramac, appskey);
|
|
}
|
|
else if (strcmp("nwkskey", argv[2]) == 0) {
|
|
if ((argc < 4) || (strlen(argv[3]) != LORAMAC_NWKSKEY_LEN * 2)) {
|
|
puts("Usage: loramac set nwkskey <32 hex chars>");
|
|
return 1;
|
|
}
|
|
uint8_t nwkskey[LORAMAC_NWKSKEY_LEN];
|
|
fmt_hex_bytes(nwkskey, argv[3]);
|
|
semtech_loramac_set_nwkskey(&loramac, nwkskey);
|
|
}
|
|
else if (strcmp("devaddr", argv[2]) == 0) {
|
|
if ((argc < 4) || (strlen(argv[3]) != LORAMAC_DEVADDR_LEN * 2)) {
|
|
puts("Usage: loramac set devaddr <8 hex chars>");
|
|
return 1;
|
|
}
|
|
uint8_t devaddr[LORAMAC_DEVADDR_LEN];
|
|
fmt_hex_bytes(devaddr, argv[3]);
|
|
semtech_loramac_set_devaddr(&loramac, devaddr);
|
|
}
|
|
else if (strcmp("class", argv[2]) == 0) {
|
|
if (argc < 4) {
|
|
puts("Usage: loramac set class <A,B,C>");
|
|
return 1;
|
|
}
|
|
loramac_class_t cls;
|
|
if (strcmp(argv[3], "A") == 0) {
|
|
cls = LORAMAC_CLASS_A;
|
|
}
|
|
else if (strcmp(argv[3], "B") == 0) {
|
|
cls = LORAMAC_CLASS_B;
|
|
}
|
|
else if (strcmp(argv[3], "C") == 0) {
|
|
cls = LORAMAC_CLASS_C;
|
|
}
|
|
else {
|
|
puts("Usage: loramac set class <A,B,C>");
|
|
return 1;
|
|
}
|
|
semtech_loramac_set_class(&loramac, cls);
|
|
}
|
|
else if (strcmp("dr", argv[2]) == 0) {
|
|
if (argc < 4) {
|
|
puts("Usage: loramac set dr <0..16>");
|
|
return 1;
|
|
}
|
|
uint8_t dr = atoi(argv[3]);
|
|
if (dr > LORAMAC_DR_15) {
|
|
puts("Usage: loramac set dr <0..16>");
|
|
return 1;
|
|
}
|
|
semtech_loramac_set_dr(&loramac, dr);
|
|
}
|
|
else if (strcmp("adr", argv[2]) == 0) {
|
|
if (argc < 4) {
|
|
puts("Usage: loramac set adr <on|off>");
|
|
return 1;
|
|
}
|
|
bool adr;
|
|
if (strcmp("on", argv[3]) == 0) {
|
|
adr = true;
|
|
}
|
|
else if (strcmp("off", argv[3]) == 0) {
|
|
adr = false;
|
|
}
|
|
else {
|
|
puts("Usage: loramac set adr <on|off>");
|
|
return 1;
|
|
}
|
|
semtech_loramac_set_adr(&loramac, adr);
|
|
}
|
|
else if (strcmp("public", argv[2]) == 0) {
|
|
if (argc < 4) {
|
|
puts("Usage: loramac set public <on|off>");
|
|
return 1;
|
|
}
|
|
bool public;
|
|
if (strcmp("on", argv[3]) == 0) {
|
|
public = true;
|
|
}
|
|
else if (strcmp("off", argv[3]) == 0) {
|
|
public = false;
|
|
}
|
|
else {
|
|
puts("Usage: loramac set public <on|off>");
|
|
return 1;
|
|
}
|
|
semtech_loramac_set_public_network(&loramac, public);
|
|
}
|
|
else if (strcmp("netid", argv[2]) == 0) {
|
|
if (argc < 4) {
|
|
puts("Usage: loramac set netid <integer value>");
|
|
return 1;
|
|
}
|
|
semtech_loramac_set_netid(&loramac, strtoul(argv[2], NULL, 0));
|
|
}
|
|
else if (strcmp("tx_power", argv[2]) == 0) {
|
|
if (argc < 4) {
|
|
puts("Usage: loramac set tx_power <0..16>");
|
|
return 1;
|
|
}
|
|
uint8_t power = atoi(argv[3]);
|
|
if (power > LORAMAC_TX_PWR_15) {
|
|
puts("Usage: loramac set tx_power <0..16>");
|
|
return 1;
|
|
}
|
|
semtech_loramac_set_tx_power(&loramac, power);
|
|
}
|
|
else if (strcmp("rx2_freq", argv[2]) == 0) {
|
|
if (argc < 4) {
|
|
puts("Usage: loramac set rx2_freq <frequency>");
|
|
return 1;
|
|
}
|
|
uint32_t freq = atoi(argv[3]);
|
|
semtech_loramac_set_rx2_freq(&loramac, freq);
|
|
}
|
|
else if (strcmp("rx2_dr", argv[2]) == 0) {
|
|
if (argc < 4) {
|
|
puts("Usage: loramac set rx2_dr <0..16>");
|
|
return 1;
|
|
}
|
|
uint8_t dr = atoi(argv[3]);
|
|
if (dr > LORAMAC_DR_15){
|
|
puts("Usage: loramac set rx2_dr <0..16>");
|
|
return 1;
|
|
}
|
|
semtech_loramac_set_rx2_dr(&loramac, dr);
|
|
}
|
|
else if (strcmp("ul_cnt", argv[2]) == 0) {
|
|
if (argc < 4) {
|
|
puts("Usage: loramac set ul_cnt <value>");
|
|
return 1;
|
|
}
|
|
uint32_t counter = atoi(argv[3]);
|
|
semtech_loramac_set_uplink_counter(&loramac, counter);
|
|
}
|
|
else if (strcmp("ch_mask", argv[2]) == 0) {
|
|
if (argc < 4) {
|
|
puts("Usage: loramac set ch_mask <value>");
|
|
puts("Example (sets channels 0-3): loramac set ch_mask 000F00000000000000000000");
|
|
return 1;
|
|
}
|
|
uint16_t mask[LORAMAC_CHANNELS_MASK_LEN] = { 0 };
|
|
uint8_t tmp[LORAMAC_CHANNELS_MASK_LEN*2];
|
|
fmt_hex_bytes(tmp, argv[3]);
|
|
for (size_t i = 0, j = 0; i < LORAMAC_CHANNELS_MASK_LEN; i++, j+=2) {
|
|
/* copy over to span a 16-bit -wide unsigned integer */
|
|
mask[i] |= tmp[j] << 8;
|
|
mask[i] |= tmp[j+1];
|
|
}
|
|
semtech_loramac_set_channels_mask(&loramac, mask);
|
|
}
|
|
else {
|
|
_loramac_set_usage();
|
|
return 1;
|
|
}
|
|
}
|
|
else if (strcmp(argv[1], "join") == 0) {
|
|
if (argc < 3) {
|
|
_loramac_join_usage();
|
|
return 1;
|
|
}
|
|
|
|
uint8_t join_type;
|
|
if (strcmp(argv[2], "otaa") == 0) {
|
|
join_type = LORAMAC_JOIN_OTAA;
|
|
}
|
|
else if (strcmp(argv[2], "abp") == 0) {
|
|
join_type = LORAMAC_JOIN_ABP;
|
|
}
|
|
else {
|
|
_loramac_join_usage();
|
|
return 1;
|
|
}
|
|
|
|
switch (semtech_loramac_join(&loramac, join_type)) {
|
|
case SEMTECH_LORAMAC_DUTYCYCLE_RESTRICTED:
|
|
puts("Cannot join: dutycycle restriction");
|
|
return 1;
|
|
case SEMTECH_LORAMAC_BUSY:
|
|
puts("Cannot join: mac is busy");
|
|
return 1;
|
|
case SEMTECH_LORAMAC_JOIN_FAILED:
|
|
puts("Join procedure failed!");
|
|
return 1;
|
|
case SEMTECH_LORAMAC_ALREADY_JOINED:
|
|
puts("Warning: already joined!");
|
|
return 1;
|
|
case SEMTECH_LORAMAC_JOIN_SUCCEEDED:
|
|
puts("Join procedure succeeded!");
|
|
break;
|
|
default: /* should not happen */
|
|
break;
|
|
}
|
|
return 0;
|
|
}
|
|
else if (strcmp(argv[1], "tx") == 0) {
|
|
if (argc < 3) {
|
|
_loramac_tx_usage();
|
|
return 1;
|
|
}
|
|
|
|
uint8_t cnf = CONFIG_LORAMAC_DEFAULT_TX_MODE; /* Default: confirmable */
|
|
uint8_t port = CONFIG_LORAMAC_DEFAULT_TX_PORT; /* Default: 2 */
|
|
/* handle optional parameters */
|
|
if (argc > 3) {
|
|
if (strcmp(argv[3], "cnf") == 0) {
|
|
cnf = LORAMAC_TX_CNF;
|
|
}
|
|
else if (strcmp(argv[3], "uncnf") == 0) {
|
|
cnf = LORAMAC_TX_UNCNF;
|
|
}
|
|
else {
|
|
_loramac_tx_usage();
|
|
return 1;
|
|
}
|
|
|
|
if (argc > 4) {
|
|
port = atoi(argv[4]);
|
|
if (port == 0 || port >= 224) {
|
|
printf("error: invalid port given '%d', "
|
|
"port can only be between 1 and 223\n", port);
|
|
return 1;
|
|
}
|
|
}
|
|
}
|
|
|
|
semtech_loramac_set_tx_mode(&loramac, cnf);
|
|
semtech_loramac_set_tx_port(&loramac, port);
|
|
|
|
switch (semtech_loramac_send(&loramac,
|
|
(uint8_t *)argv[2], strlen(argv[2]))) {
|
|
case SEMTECH_LORAMAC_NOT_JOINED:
|
|
puts("Cannot send: not joined");
|
|
return 1;
|
|
|
|
case SEMTECH_LORAMAC_DUTYCYCLE_RESTRICTED:
|
|
puts("Cannot send: dutycycle restriction");
|
|
return 1;
|
|
|
|
case SEMTECH_LORAMAC_BUSY:
|
|
puts("Cannot send: MAC is busy");
|
|
return 1;
|
|
|
|
case SEMTECH_LORAMAC_TX_ERROR:
|
|
puts("Cannot send: error");
|
|
return 1;
|
|
|
|
case SEMTECH_LORAMAC_TX_CNF_FAILED:
|
|
puts("Fail to send: no ACK received");
|
|
return 1;
|
|
}
|
|
|
|
puts("Message sent with success");
|
|
return 0;
|
|
}
|
|
#ifdef MODULE_SEMTECH_LORAMAC_RX
|
|
else if (strcmp(argv[1], "link_check") == 0) {
|
|
if (argc > 2) {
|
|
_loramac_usage();
|
|
return 1;
|
|
}
|
|
|
|
semtech_loramac_request_link_check(&loramac);
|
|
puts("Link check request scheduled");
|
|
}
|
|
#endif
|
|
#ifdef MODULE_PERIPH_EEPROM
|
|
else if (strcmp(argv[1], "save") == 0) {
|
|
if (argc > 2) {
|
|
_loramac_usage();
|
|
return 1;
|
|
}
|
|
|
|
semtech_loramac_save_config(&loramac);
|
|
}
|
|
else if (strcmp(argv[1], "erase") == 0) {
|
|
if (argc > 2) {
|
|
_loramac_usage();
|
|
return 1;
|
|
}
|
|
|
|
semtech_loramac_erase_config();
|
|
}
|
|
#endif
|
|
else {
|
|
_loramac_usage();
|
|
return 1;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
SHELL_COMMAND(loramac, "Control Semtech loramac stack", _loramac_handler);
|