Uttam Bhat / LoRaWAN-SX1276-Application-Demo

SX1276 Shield based Applications

Dependencies:   X_NUCLEO_IKS01A1 LoRaWAN-lib SX1276Lib mbed

LoRaWAN-SX1276-Application Demo uses SX1276MB1LAS mbed component shield on a nucleo board platform to demonstrate a Class-A LoRaWAN device in the 915MHz ISM band for North American region. It uses the LoRaWAN-lib and SX1276Lib libraries.

Comissioning.h (LoRaWAN Network Configuration)

The end-device can be activated in one of the two ways:

Over the Air (OTA) activation can be enabled as shown in the figure below. /media/uploads/ubhat/ota_enable.png

The end-device must be configured with the following parameters:

  • LORAWAN_DEVICE_EUI (8 Bytes) : Fist 3 Bytes is the Organizationally Unique Identifier (OUI) followed by 5 bytes of unique ID. If not defined by user, then the firmware automatically assigns one to the end-device
  • LORAWAN_APPLICATION_EUI (8 Bytes)
  • LORAWAN_APPLICATION_KEY (or DEVKEY) (16 Bytes)

/media/uploads/ubhat/ota_eui.png

Activation by Personalization (ABP) can be enabled as shown in the figure below. /media/uploads/ubhat/abp_enable.png

The end-device must be configured with the following parameters:

  • LORAWAN_DEVICE_ADDRESS (4 Bytes) : If not defined by user, then the firmware automatically assigns one to the end-device
  • LORAWAN_NWKSKEY (16 Bytes)
  • LORAWAN_APPSKEY (16 Bytes)

/media/uploads/ubhat/abp_key.png

Config.h (LoRaWAN Communication Parameters)

  • Mode of Operation : Hybrid If the end-device needs to be configured to operate over 8-channels, then Hybrid Mode needs to be enabled /media/uploads/ubhat/hybridenable.png
  • Mode of Operation : Frequency Hop If the end-device needs to be configured to operate over 64-channels, then Hybrid Mode needs to be disabled
  • Delay between successive JOIN REQUESTs : The delay between successive Join Requests (until the end-device joins the network) can be configured using the parameter OVER_THE_AIR_ACTIVATION_DUTYCYCLE
  • Inter-Frame Delay : One can change the delay between each frame transmission using APP_TX_DUTYCYCLE It is advisable that APP_TX_DUTYCYCLE is greater than or equal to 3sec.
  • Data Rate : The data rate can be configured as per LoRaWAN specification using the paramter LORAWAN_DEFAULT_DATARATE. The range of values are DR_0, DR_1, DR_2, DR_3 and DR_4
  • Confirmed/Unconfirmed Messages : The uplink message or payload can be chosen to be confirmed or unconfirmed using the parameter LORAWAN_CONFIRMED_MSG_ON. When set to 1, the transmitted messages need to be confirmed with an ACK by the network server in the subsequent RX window. When set to 0, no ACK is requested.
  • ADR ON/OFF : The ADR can be enabled or disabled using the parameter LORAWAN_ADR_ON. When set to 1, ADR is enabled and disabled when set to 0.
  • Application Port : The application port can be set using parameter LORAWAN_APP_PORT. A few examples are associated to specific Application Port, and are defined in Config.h
  • Payload Length : The lenght of the payload (in bytes) to be transmitted can be configured using LORAWAN_APP_DATA_SIZE
  • Transmit Power : The transmit power can be configured using LORAWAN_TX_POWER (LoRaMAC verifies if the set power is compliant with the LoRaWAN spec and FCC guidelines)

/media/uploads/ubhat/loraconfig.png

The baud-rate for serial terminal display is 115200

app/vt100.h@0:42863a11464a, 2016-08-26 (annotated)

Committer:
ubhat
Date:
Fri Aug 26 19:36:35 2016 +0000
Revision:
0:42863a11464a
SX1276 Shield based Applications

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ubhat 0:42863a11464a 1 /*
ubhat 0:42863a11464a 2 / _____) _ | |
ubhat 0:42863a11464a 3 ( (____ _____ ____ _| |_ _____ ____| |__
ubhat 0:42863a11464a 4 \____ \| ___ | (_ _) ___ |/ ___) _ \
ubhat 0:42863a11464a 5 _____) ) ____| | | || |_| ____( (___| | | |
ubhat 0:42863a11464a 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
ubhat 0:42863a11464a 7 (C)2015 Semtech
ubhat 0:42863a11464a 8
ubhat 0:42863a11464a 9 Description: VT100 terminal support class
ubhat 0:42863a11464a 10
ubhat 0:42863a11464a 11 License: Revised BSD License, see LICENSE.TXT file include in the project
ubhat 0:42863a11464a 12
ubhat 0:42863a11464a 13 Maintainer: Miguel Luis and Gregory Cristian
ubhat 0:42863a11464a 14 */
ubhat 0:42863a11464a 15 #ifndef __VT100_H__
ubhat 0:42863a11464a 16 #define __VT100_H__
ubhat 0:42863a11464a 17
ubhat 0:42863a11464a 18 #ifndef STRING_STACK_LIMIT
ubhat 0:42863a11464a 19 #define STRING_STACK_LIMIT 120
ubhat 0:42863a11464a 20 #endif
ubhat 0:42863a11464a 21
ubhat 0:42863a11464a 22 /**
ubhat 0:42863a11464a 23 * Implements VT100 terminal commands support.
ubhat 0:42863a11464a 24 * Implments also the same behaviour has RawSerial class. The only difference
ubhat 0:42863a11464a 25 * is located in putc fucntion where writeable check is made befor sending the character.
ubhat 0:42863a11464a 26 */
ubhat 0:42863a11464a 27 class VT100 : public SerialBase
ubhat 0:42863a11464a 28 {
ubhat 0:42863a11464a 29 public:
ubhat 0:42863a11464a 30 enum TextAttributes
ubhat 0:42863a11464a 31 {
ubhat 0:42863a11464a 32 ATTR_OFF = 0,
ubhat 0:42863a11464a 33 BOLD = 1,
ubhat 0:42863a11464a 34 USCORE = 4,
ubhat 0:42863a11464a 35 BLINK = 5,
ubhat 0:42863a11464a 36 REVERSE = 7,
ubhat 0:42863a11464a 37 BOLD_OFF = 21,
ubhat 0:42863a11464a 38 USCORE_OFF = 24,
ubhat 0:42863a11464a 39 BLINK_OFF = 25,
ubhat 0:42863a11464a 40 REVERSE_OFF = 27,
ubhat 0:42863a11464a 41 };
ubhat 0:42863a11464a 42
ubhat 0:42863a11464a 43 enum Colors
ubhat 0:42863a11464a 44 {
ubhat 0:42863a11464a 45 BLACK = 0,
ubhat 0:42863a11464a 46 RED = 1,
ubhat 0:42863a11464a 47 GREEN = 2,
ubhat 0:42863a11464a 48 BROWN = 3,
ubhat 0:42863a11464a 49 BLUE = 4,
ubhat 0:42863a11464a 50 MAGENTA = 5,
ubhat 0:42863a11464a 51 CYAN = 6,
ubhat 0:42863a11464a 52 WHITE = 7,
ubhat 0:42863a11464a 53 };
ubhat 0:42863a11464a 54
ubhat 0:42863a11464a 55 VT100( PinName tx, PinName rx ): SerialBase( tx, rx )
ubhat 0:42863a11464a 56 {
ubhat 0:42863a11464a 57 this->baud( 115200 );
ubhat 0:42863a11464a 58 // initializes terminal to "power-on" settings
ubhat 0:42863a11464a 59 // ESC c
ubhat 0:42863a11464a 60 this->printf( "\x1B\x63" );
ubhat 0:42863a11464a 61 }
ubhat 0:42863a11464a 62
ubhat 0:42863a11464a 63 void ClearScreen( uint8_t param )
ubhat 0:42863a11464a 64 {
ubhat 0:42863a11464a 65 // ESC [ Ps J
ubhat 0:42863a11464a 66 // 0 Clear screen from cursor down
ubhat 0:42863a11464a 67 // 1 Clear screen from cursor up
ubhat 0:42863a11464a 68 // 2 Clear entire screen
ubhat 0:42863a11464a 69 this->printf( "\x1B[%dJ", param );
ubhat 0:42863a11464a 70 }
ubhat 0:42863a11464a 71
ubhat 0:42863a11464a 72 void ClearLine( uint8_t param )
ubhat 0:42863a11464a 73 {
ubhat 0:42863a11464a 74 // ESC [ Ps K
ubhat 0:42863a11464a 75 // 0 Erase from the active position to the end of the line, inclusive (default)
ubhat 0:42863a11464a 76 // 1 Erase from the start of the screen to the active position, inclusive
ubhat 0:42863a11464a 77 // 2 Erase all of the line, inclusive
ubhat 0:42863a11464a 78 this->printf( "\x1B[%dK", param );
ubhat 0:42863a11464a 79 }
ubhat 0:42863a11464a 80
ubhat 0:42863a11464a 81 void SetAttribute( uint8_t attr )
ubhat 0:42863a11464a 82 {
ubhat 0:42863a11464a 83 // ESC [ Ps;...;Ps m
ubhat 0:42863a11464a 84 this->printf( "\x1B[%dm", attr );
ubhat 0:42863a11464a 85 }
ubhat 0:42863a11464a 86
ubhat 0:42863a11464a 87 void SetAttribute( uint8_t attr, uint8_t fgcolor, uint8_t bgcolor )
ubhat 0:42863a11464a 88 {
ubhat 0:42863a11464a 89 // ESC [ Ps;...;Ps m
ubhat 0:42863a11464a 90 this->printf( "\x1B[%d;%d;%dm", attr, fgcolor + 30, bgcolor + 40 );
ubhat 0:42863a11464a 91 }
ubhat 0:42863a11464a 92
ubhat 0:42863a11464a 93 void SetCursorMode( uint8_t visible )
ubhat 0:42863a11464a 94 {
ubhat 0:42863a11464a 95 if( visible == true )
ubhat 0:42863a11464a 96 {
ubhat 0:42863a11464a 97 // ESC [ ? 25 h
ubhat 0:42863a11464a 98 this->printf( "\x1B[?25h" );
ubhat 0:42863a11464a 99 }
ubhat 0:42863a11464a 100 else
ubhat 0:42863a11464a 101 {
ubhat 0:42863a11464a 102 // ESC [ ? 25 l
ubhat 0:42863a11464a 103 this->printf( "\x1B[?25l" );
ubhat 0:42863a11464a 104 }
ubhat 0:42863a11464a 105 }
ubhat 0:42863a11464a 106
ubhat 0:42863a11464a 107 void SetCursorPos( uint8_t line, uint8_t col )
ubhat 0:42863a11464a 108 {
ubhat 0:42863a11464a 109 // ESC [ Pl ; Pc H
ubhat 0:42863a11464a 110 this->printf( "\x1B[%d;%dH", line, col );
ubhat 0:42863a11464a 111 }
ubhat 0:42863a11464a 112
ubhat 0:42863a11464a 113 void PutStringAt( uint8_t line, uint8_t col, const char *s )
ubhat 0:42863a11464a 114 {
ubhat 0:42863a11464a 115 this->SetCursorPos( line, col );
ubhat 0:42863a11464a 116 this->printf( "%s", s );
ubhat 0:42863a11464a 117 }
ubhat 0:42863a11464a 118
ubhat 0:42863a11464a 119 void PutCharAt( uint8_t line, uint8_t col, uint8_t c )
ubhat 0:42863a11464a 120 {
ubhat 0:42863a11464a 121 this->SetCursorPos( line, col );
ubhat 0:42863a11464a 122 this->printf( "%c", c );
ubhat 0:42863a11464a 123 }
ubhat 0:42863a11464a 124
ubhat 0:42863a11464a 125 void PutHexAt( uint8_t line, uint8_t col, uint16_t n )
ubhat 0:42863a11464a 126 {
ubhat 0:42863a11464a 127 this->SetCursorPos( line, col );
ubhat 0:42863a11464a 128 this->printf( "%X", n );
ubhat 0:42863a11464a 129 }
ubhat 0:42863a11464a 130
ubhat 0:42863a11464a 131 void PutBoxDrawingChar( uint8_t c )
ubhat 0:42863a11464a 132 {
ubhat 0:42863a11464a 133 this->printf( "\x1B(0%c\x1b(B", c );
ubhat 0:42863a11464a 134 }
ubhat 0:42863a11464a 135
ubhat 0:42863a11464a 136 bool Readable( void )
ubhat 0:42863a11464a 137 {
ubhat 0:42863a11464a 138 return this->readable( );
ubhat 0:42863a11464a 139 }
ubhat 0:42863a11464a 140
ubhat 0:42863a11464a 141 uint8_t GetChar( void )
ubhat 0:42863a11464a 142 {
ubhat 0:42863a11464a 143 return this->getc( );
ubhat 0:42863a11464a 144 }
ubhat 0:42863a11464a 145
ubhat 0:42863a11464a 146 /*
ubhat 0:42863a11464a 147 * RawSerial class implmentation copy.
ubhat 0:42863a11464a 148 */
ubhat 0:42863a11464a 149 /** Read a char from the serial port
ubhat 0:42863a11464a 150 *
ubhat 0:42863a11464a 151 * @returns The char read from the serial port
ubhat 0:42863a11464a 152 */
ubhat 0:42863a11464a 153 int getc( )
ubhat 0:42863a11464a 154 {
ubhat 0:42863a11464a 155 return _base_getc();
ubhat 0:42863a11464a 156 }
ubhat 0:42863a11464a 157
ubhat 0:42863a11464a 158 /** Write a char to the serial port
ubhat 0:42863a11464a 159 *
ubhat 0:42863a11464a 160 * @param c The char to write
ubhat 0:42863a11464a 161 *
ubhat 0:42863a11464a 162 * @returns The written char or -1 if an error occured
ubhat 0:42863a11464a 163 */
ubhat 0:42863a11464a 164 int putc( int c )
ubhat 0:42863a11464a 165 {
ubhat 0:42863a11464a 166 while( this->writeable( ) != 1 );
ubhat 0:42863a11464a 167 return _base_putc( c );
ubhat 0:42863a11464a 168 }
ubhat 0:42863a11464a 169
ubhat 0:42863a11464a 170 /** Write a string to the serial port
ubhat 0:42863a11464a 171 *
ubhat 0:42863a11464a 172 * @param str The string to write
ubhat 0:42863a11464a 173 *
ubhat 0:42863a11464a 174 * @returns 0 if the write succeeds, EOF for error
ubhat 0:42863a11464a 175 */
ubhat 0:42863a11464a 176 int puts( const char *str )
ubhat 0:42863a11464a 177 {
ubhat 0:42863a11464a 178 while( *str )
ubhat 0:42863a11464a 179 putc( *str++ );
ubhat 0:42863a11464a 180 return 0;
ubhat 0:42863a11464a 181 }
ubhat 0:42863a11464a 182
ubhat 0:42863a11464a 183 // Experimental support for printf in RawSerial. No Stream inheritance
ubhat 0:42863a11464a 184 // means we can't call printf() directly, so we use sprintf() instead.
ubhat 0:42863a11464a 185 // We only call malloc() for the sprintf() buffer if the buffer
ubhat 0:42863a11464a 186 // length is above a certain threshold, otherwise we use just the stack.
ubhat 0:42863a11464a 187 int printf( const char *format, ... )
ubhat 0:42863a11464a 188 {
ubhat 0:42863a11464a 189 std::va_list arg;
ubhat 0:42863a11464a 190 va_start( arg, format );
ubhat 0:42863a11464a 191 int len = vsnprintf( NULL, 0, format, arg );
ubhat 0:42863a11464a 192 if( len < STRING_STACK_LIMIT )
ubhat 0:42863a11464a 193 {
ubhat 0:42863a11464a 194 char temp[STRING_STACK_LIMIT];
ubhat 0:42863a11464a 195 vsprintf( temp, format, arg );
ubhat 0:42863a11464a 196 puts( temp );
ubhat 0:42863a11464a 197 }
ubhat 0:42863a11464a 198 else
ubhat 0:42863a11464a 199 {
ubhat 0:42863a11464a 200 char *temp = new char[len + 1];
ubhat 0:42863a11464a 201 vsprintf( temp, format, arg );
ubhat 0:42863a11464a 202 puts( temp );
ubhat 0:42863a11464a 203 delete[] temp;
ubhat 0:42863a11464a 204 }
ubhat 0:42863a11464a 205 va_end( arg );
ubhat 0:42863a11464a 206 return len;
ubhat 0:42863a11464a 207 }
ubhat 0:42863a11464a 208
ubhat 0:42863a11464a 209 private:
ubhat 0:42863a11464a 210
ubhat 0:42863a11464a 211 };
ubhat 0:42863a11464a 212
ubhat 0:42863a11464a 213 #endif // __VT100_H__