rn2903: Initial implementation; C; C++ wraps C; examples

This requires a new MRAA with UART sendbreak support.

Signed-off-by: Jon Trulson <jtrulson@ics.com>
This commit is contained in:
Jon Trulson
2017-04-28 18:33:34 -06:00
parent c78da687d4
commit 21a1860ec2
26 changed files with 4918 additions and 0 deletions

137
examples/c/rn2903-p2p-rx.c Normal file
View File

@ -0,0 +1,137 @@
/*
* Author: Jon Trulson <jtrulson@ics.com>
* Copyright (c) 2017 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include <unistd.h>
#include <stdio.h>
#include <string.h>
#include <signal.h>
#include "rn2903.h"
#include "upm_utilities.h"
#include "upm_platform.h"
int shouldRun = true;
void sig_handler(int signo)
{
if (signo == SIGINT)
shouldRun = false;
}
#if defined(UPM_PLATFORM_ZEPHYR) && !defined(CONFIG_STDOUT_CONSOLE)
# define printf printk
#endif
int main(int argc, char **argv)
{
//! [Interesting]
char *defaultDev = "/dev/ttyUSB0";
if (argc > 1)
defaultDev = argv[1];
printf("Using device: %s\n", defaultDev);
// Instantiate a RN2903 sensor on defaultDev at 57600 baud.
#if defined(UPM_PLATFORM_ZEPHYR)
rn2903_context sensor = rn2903_init(0, RN2903_DEFAULT_BAUDRATE);
#else
rn2903_context sensor = rn2903_init_tty(defaultDev,
RN2903_DEFAULT_BAUDRATE);
#endif
// To use an internal UART understood by MRAA, use the following
// to inititialize rather than the above, which by default uses a
// tty path.
//
// rn2903_context sensor = rn2903_init(0, RN2903_DEFAULT_BAUDRATE);
if (!sensor)
{
printf("rn2903_init_tty() failed.\n");
return 1;
}
// enable debugging
// rn2903_set_debug(sensor, true);
// get version
if (rn2903_command(sensor, "sys get ver"))
{
printf("Failed to retrieve device version string\n");
rn2903_close(sensor);
return 1;
}
printf("Firmware version: %s\n", rn2903_get_response(sensor));
printf("Hardware EUI: %s\n", rn2903_get_hardware_eui(sensor));
// For this example, we will just try to receive a packet
// transmitted by the p2p-tx rn2903 example. We reset the
// device to defaults, and we do not make any adjustments to the
// radio configuration. You will probably want to do so for a
// real life application.
// The first thing to do is to suspend the LoRaWAN stack on the device.
if (rn2903_mac_pause(sensor))
{
printf("Failed to pause the LoRaWAN stack\n");
rn2903_close(sensor);
return 1;
}
// We will use continuous mode (window_size 0), though the default
// radio watch dog timer will expire every 15 seconds. We will
// just loop here.
while (shouldRun)
{
printf("Waiting for packet...\n");
RN2903_RESPONSE_T rv;
rv = rn2903_radio_rx(sensor, 0);
if (rv)
{
printf("rn2903_radio_rx() failed with code (%d)\n", rv);
}
else
{
const char *resp = rn2903_get_response(sensor);
const char *payload = rn2903_get_radio_rx_payload(sensor);
if (!payload)
printf("Got response: '%s'\n", resp);
else
printf("Got payload: '%s'\n",
rn2903_from_hex(sensor, payload));
}
printf("\n");
}
printf("Exiting\n");
rn2903_close(sensor);
//! [Interesting]
return 0;
}

139
examples/c/rn2903-p2p-tx.c Normal file
View File

@ -0,0 +1,139 @@
/*
* Author: Jon Trulson <jtrulson@ics.com>
* Copyright (c) 2017 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include <unistd.h>
#include <stdio.h>
#include <string.h>
#include <signal.h>
#include "rn2903.h"
#include "upm_utilities.h"
#include "upm_platform.h"
bool shouldRun = true;
void sig_handler(int signo)
{
if (signo == SIGINT)
shouldRun = false;
}
#if defined(UPM_PLATFORM_ZEPHYR) && !defined(CONFIG_STDOUT_CONSOLE)
# define printf printk
#endif
int main(int argc, char **argv)
{
//! [Interesting]
char *defaultDev = "/dev/ttyUSB0";
if (argc > 1)
defaultDev = argv[1];
printf("Using device: %s\n", defaultDev);
// Instantiate a RN2903 sensor on defaultDev at 57600 baud.
#if defined(UPM_PLATFORM_ZEPHYR)
rn2903_context sensor = rn2903_init(0, RN2903_DEFAULT_BAUDRATE);
#else
rn2903_context sensor = rn2903_init_tty(defaultDev,
RN2903_DEFAULT_BAUDRATE);
#endif
// To use an internal UART understood by MRAA, use the following
// to inititialize rather than the above, which by default uses a
// tty path.
//
// rn2903_context sensor = rn2903_init(0, RN2903_DEFAULT_BAUDRATE);
if (!sensor)
{
printf("rn2903_init_tty() failed.\n");
return 1;
}
// enable debugging
// rn2903_set_debug(sensor, true);
// get version
if (rn2903_command(sensor, "sys get ver"))
{
printf("Failed to retrieve device version string\n");
rn2903_close(sensor);
return 1;
}
printf("Firmware version: %s\n", rn2903_get_response(sensor));
printf("Hardware EUI: %s\n", rn2903_get_hardware_eui(sensor));
// For this example, we will just try transmitting a packet over
// LoRa. We reset the device to defaults, and we do not make any
// adjustments to the radio configuration. You will probably want
// to do so for a real life application.
// The first thing to do is to suspend the LoRaWAN stack on the device.
if (rn2903_mac_pause(sensor))
{
printf("Failed to pause the LoRaWAN stack\n");
rn2903_close(sensor);
return 1;
}
// the default radio watchdog timer is set for 15 seconds, so we
// will send a packet every 10 seconds. In reality, local
// restrictions limit the amount of time on the air, so in a real
// implementation, you would not want to send packets that
// frequently.
int count = 0;
while (shouldRun)
{
char pingbuf[32] = {};
snprintf(pingbuf, 32, "Ping %d", count++);
// All payloads must be hex encoded
const char *payload = rn2903_to_hex(sensor, pingbuf, strlen(pingbuf));
printf("Transmitting a packet, data: '%s' -> hex: '%s'\n",
pingbuf, payload);
RN2903_RESPONSE_T rv;
rv = rn2903_radio_tx(sensor, payload);
if (rv == RN2903_RESPONSE_OK)
printf("Transmit successful.\n");
else
printf("Transmit failed with code %d.\n", rv);
printf("\n");
upm_delay(10);
}
printf("Exiting\n");
rn2903_close(sensor);
//! [Interesting]
return 0;
}

153
examples/c/rn2903.c Normal file
View File

@ -0,0 +1,153 @@
/*
* Author: Jon Trulson <jtrulson@ics.com>
* Copyright (c) 2017 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include <unistd.h>
#include <stdio.h>
#include <string.h>
#include "rn2903.h"
#include "upm_utilities.h"
#include "upm_platform.h"
#if defined(UPM_PLATFORM_ZEPHYR) && !defined(CONFIG_STDOUT_CONSOLE)
# define printf printk
#endif
int main(int argc, char **argv)
{
//! [Interesting]
char *defaultDev = "/dev/ttyUSB0";
if (argc > 1)
defaultDev = argv[1];
printf("Using device: %s\n", defaultDev);
// Instantiate a RN2903 sensor on defaultDev at 57600 baud.
#if defined(UPM_PLATFORM_ZEPHYR)
rn2903_context sensor = rn2903_init(0, RN2903_DEFAULT_BAUDRATE);
#else
rn2903_context sensor = rn2903_init_tty(defaultDev,
RN2903_DEFAULT_BAUDRATE);
#endif
// To use an internal UART understood by MRAA, use the following
// to inititialize rather than the above, which by default uses a
// tty path.
//
// rn2903_context sensor = rn2903_init(0, RN2903_DEFAULT_BAUDRATE);
if (!sensor)
{
printf("rn2903_init_tty() failed.\n");
return 1;
}
// enable debugging
// rn2903_set_debug(sensor, true);
// get version
if (rn2903_command(sensor, "sys get ver"))
{
printf("Failed to retrieve device version string\n");
rn2903_close(sensor);
return 1;
}
printf("Firmware version: %s\n", rn2903_get_response(sensor));
printf("Hardware EUI: %s\n", rn2903_get_hardware_eui(sensor));
// we can support two types of join, OTAA and ABP. Each requires
// that certain parameters be set first. We will only attempt ABP
// joining with this example since it's the only one that can
// succeed without actual configuration. In both cases, if you
// are actually attempting to join a real LoRaWAN network, you
// must change the parameters below to match the network you are
// attempting to join.
// For OTAA, you need to supply valid Device EUI, Application EUI,
// and Application key:
//
// rn2903_set_device_eui(sensor, "0011223344556677");
// rn2903_set_application_eui(sensor, "0011223344556677");
// rn2903_set_application_key(sensor, "01234567012345670123456701234567");
//
// RN2903_JOIN_STATUS_T rv = rn2903_join(sensor, RN2903_JOIN_TYPE_OTAA);
// A successful join will return RN2903_JOIN_STATUS_ACCEPTED (0).
// printf("JOIN: got rv %d\n", rv);
// Try an ABP join. Note, these parameters are made up. For a
// real network, you will want to use the correct values
// obviously. For an ABP join, you need to supply the Device
// Address, Network Session Key, and the Application Session Key.
rn2903_set_device_addr(sensor, "00112233");
rn2903_set_network_session_key(sensor, "00112233001122330011223300112233");
rn2903_set_application_session_key(sensor,
"00112233001122330011223300112233");
RN2903_JOIN_STATUS_T rv = rn2903_join(sensor, RN2903_JOIN_TYPE_ABP);
if (rv == RN2903_JOIN_STATUS_ACCEPTED)
{
printf("Join successful.\n");
// All transmit payloads must be hex encoded strings, so
// pretend we have a temperature sensor that gave us a value
// of 25.6 C, and we want to transmit it.
const char *faketemp = "25.6";
printf("Transmitting a packet....\n");
RN2903_MAC_TX_STATUS_T trv;
trv = rn2903_mac_tx(sensor, RN2903_MAC_MSG_TYPE_UNCONFIRMED,
1, // port number
rn2903_to_hex(sensor, faketemp, strlen(faketemp)));
if (trv == RN2903_MAC_TX_STATUS_TX_OK)
printf("Transmit successful.\n");
else
{
// check to see if we got a downlink packet
if (trv == RN2903_MAC_TX_STATUS_RX_RECEIVED)
{
printf("Transmit successful, downlink packet received: %s\n",
rn2903_get_response(sensor));
}
else
{
printf("Transmit failed with code %d.\n", trv);
}
}
}
else
{
printf("Join failed with code %d.\n", rv);
}
printf("Exiting\n");
rn2903_close(sensor);
//! [Interesting]
return 0;
}