CY Lim / Mbed OS mbed-os-example-lorawan

WPG

Fork of mbed-os-example-mbed5-lorawan by mbed-os-examples

main.cpp@12:5015dfead3f2, 2018-04-18 (annotated)

Committer:
mbed_official
Date:
Wed Apr 18 06:30:24 2018 +0100
Revision:
12:5015dfead3f2
Parent:
3:8c7198d1a2a1
Child:
18:1720bc3831ea
Reduce example application memory usage



Our currently supported targets DISCO_L072CZ_LRWAN1 and MTB_MURATA_ABZ

only have 20kB of RAM which requires some memory usage optimizations

to LoRa example application especially when compiled with GCC compiler.



This commit reduces application tx and rx buffers to 30 bytes (instead of

255) as application only sends short messages.



Also main thread stack size is reduced to 1024 bytes for these two targets.

NOTE! Due to small stack size, mbed traces cannot be enabled for these targets!



.

Commit copied from https://github.com/ARMmbed/mbed-os-example-lorawan

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:7037ed05f54f 1 /**
mbed_official 0:7037ed05f54f 2 * Copyright (c) 2017, Arm Limited and affiliates.
mbed_official 0:7037ed05f54f 3 * SPDX-License-Identifier: Apache-2.0
mbed_official 0:7037ed05f54f 4 *
mbed_official 0:7037ed05f54f 5 * Licensed under the Apache License, Version 2.0 (the "License");
mbed_official 0:7037ed05f54f 6 * you may not use this file except in compliance with the License.
mbed_official 0:7037ed05f54f 7 * You may obtain a copy of the License at
mbed_official 0:7037ed05f54f 8 *
mbed_official 0:7037ed05f54f 9 * http://www.apache.org/licenses/LICENSE-2.0
mbed_official 0:7037ed05f54f 10 *
mbed_official 0:7037ed05f54f 11 * Unless required by applicable law or agreed to in writing, software
mbed_official 0:7037ed05f54f 12 * distributed under the License is distributed on an "AS IS" BASIS,
mbed_official 0:7037ed05f54f 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mbed_official 0:7037ed05f54f 14 * See the License for the specific language governing permissions and
mbed_official 0:7037ed05f54f 15 * limitations under the License.
mbed_official 0:7037ed05f54f 16 */
mbed_official 0:7037ed05f54f 17 #include <stdio.h>
mbed_official 3:8c7198d1a2a1 18
mbed_official 3:8c7198d1a2a1 19 #if MBED_CONF_APP_LORAWAN_ENABLED
mbed_official 3:8c7198d1a2a1 20
mbed_official 3:8c7198d1a2a1 21 #ifdef DEVICE_SPI
mbed_official 3:8c7198d1a2a1 22
mbed_official 0:7037ed05f54f 23 #include "lorawan/LoRaWANInterface.h"
mbed_official 0:7037ed05f54f 24 #include "lorawan/system/lorawan_data_structures.h"
mbed_official 0:7037ed05f54f 25 #include "events/EventQueue.h"
mbed_official 0:7037ed05f54f 26
mbed_official 0:7037ed05f54f 27 // Application helpers
mbed_official 0:7037ed05f54f 28 #include "DummySensor.h"
mbed_official 0:7037ed05f54f 29 #include "trace_helper.h"
mbed_official 0:7037ed05f54f 30 #include "lora_radio_helper.h"
mbed_official 0:7037ed05f54f 31
mbed_official 0:7037ed05f54f 32 using namespace events;
mbed_official 0:7037ed05f54f 33
mbed_official 12:5015dfead3f2 34 // Max payload size can be LORAMAC_PHY_MAXPAYLOAD.
mbed_official 12:5015dfead3f2 35 // This example only communicates with much shorter messages (<30 bytes).
mbed_official 12:5015dfead3f2 36 // If longer messages are used, these buffers must be changed accordingly.
mbed_official 12:5015dfead3f2 37 uint8_t tx_buffer[30];
mbed_official 12:5015dfead3f2 38 uint8_t rx_buffer[30];
mbed_official 0:7037ed05f54f 39
mbed_official 0:7037ed05f54f 40 /*
mbed_official 0:7037ed05f54f 41 * Sets up an application dependent transmission timer in ms. Used only when Duty Cycling is off for testing
mbed_official 0:7037ed05f54f 42 */
mbed_official 0:7037ed05f54f 43 #define TX_TIMER 10000
mbed_official 0:7037ed05f54f 44
mbed_official 0:7037ed05f54f 45 /**
mbed_official 0:7037ed05f54f 46 * Maximum number of events for the event queue.
mbed_official 12:5015dfead3f2 47 * 10 is the safe number for the stack events, however, if application
mbed_official 0:7037ed05f54f 48 * also uses the queue for whatever purposes, this number should be increased.
mbed_official 0:7037ed05f54f 49 */
mbed_official 12:5015dfead3f2 50 #define MAX_NUMBER_OF_EVENTS 10
mbed_official 0:7037ed05f54f 51
mbed_official 0:7037ed05f54f 52 /**
mbed_official 0:7037ed05f54f 53 * Maximum number of retries for CONFIRMED messages before giving up
mbed_official 0:7037ed05f54f 54 */
mbed_official 0:7037ed05f54f 55 #define CONFIRMED_MSG_RETRY_COUNTER 3
mbed_official 0:7037ed05f54f 56
mbed_official 0:7037ed05f54f 57 /**
mbed_official 0:7037ed05f54f 58 * Dummy pin for dummy sensor
mbed_official 0:7037ed05f54f 59 */
mbed_official 0:7037ed05f54f 60 #define PC_9 0
mbed_official 0:7037ed05f54f 61
mbed_official 0:7037ed05f54f 62 /**
mbed_official 0:7037ed05f54f 63 * Dummy sensor class object
mbed_official 0:7037ed05f54f 64 */
mbed_official 0:7037ed05f54f 65 DS1820 ds1820(PC_9);
mbed_official 0:7037ed05f54f 66
mbed_official 0:7037ed05f54f 67 /**
mbed_official 0:7037ed05f54f 68 * This event queue is the global event queue for both the
mbed_official 0:7037ed05f54f 69 * application and stack. To conserve memory, the stack is designed to run
mbed_official 0:7037ed05f54f 70 * in the same thread as the application and the application is responsible for
mbed_official 0:7037ed05f54f 71 * providing an event queue to the stack that will be used for ISR deferment as
mbed_official 0:7037ed05f54f 72 * well as application information event queuing.
mbed_official 0:7037ed05f54f 73 */
mbed_official 0:7037ed05f54f 74 static EventQueue ev_queue(MAX_NUMBER_OF_EVENTS * EVENTS_EVENT_SIZE);
mbed_official 0:7037ed05f54f 75
mbed_official 0:7037ed05f54f 76 /**
mbed_official 0:7037ed05f54f 77 * Event handler.
mbed_official 0:7037ed05f54f 78 *
mbed_official 0:7037ed05f54f 79 * This will be passed to the LoRaWAN stack to queue events for the
mbed_official 0:7037ed05f54f 80 * application which in turn drive the application.
mbed_official 0:7037ed05f54f 81 */
mbed_official 0:7037ed05f54f 82 static void lora_event_handler(lorawan_event_t event);
mbed_official 0:7037ed05f54f 83
mbed_official 0:7037ed05f54f 84 /**
mbed_official 2:dc95ac6d6d4e 85 * Constructing Mbed LoRaWANInterface and passing it down the radio object.
mbed_official 0:7037ed05f54f 86 */
mbed_official 2:dc95ac6d6d4e 87 static LoRaWANInterface lorawan(radio);
mbed_official 0:7037ed05f54f 88
mbed_official 0:7037ed05f54f 89 /**
mbed_official 0:7037ed05f54f 90 * Application specific callbacks
mbed_official 0:7037ed05f54f 91 */
mbed_official 0:7037ed05f54f 92 static lorawan_app_callbacks_t callbacks;
mbed_official 0:7037ed05f54f 93
mbed_official 0:7037ed05f54f 94 /**
mbed_official 0:7037ed05f54f 95 * Entry point for application
mbed_official 0:7037ed05f54f 96 */
mbed_official 0:7037ed05f54f 97 int main (void)
mbed_official 0:7037ed05f54f 98 {
mbed_official 0:7037ed05f54f 99 // setup tracing
mbed_official 0:7037ed05f54f 100 setup_trace();
mbed_official 0:7037ed05f54f 101
mbed_official 0:7037ed05f54f 102 // stores the status of a call to LoRaWAN protocol
mbed_official 0:7037ed05f54f 103 lorawan_status_t retcode;
mbed_official 0:7037ed05f54f 104
mbed_official 0:7037ed05f54f 105 // Initialize LoRaWAN stack
mbed_official 2:dc95ac6d6d4e 106 if (lorawan.initialize(&ev_queue) != LORAWAN_STATUS_OK) {
mbed_official 0:7037ed05f54f 107 printf("\r\n LoRa initialization failed! \r\n");
mbed_official 0:7037ed05f54f 108 return -1;
mbed_official 0:7037ed05f54f 109 }
mbed_official 0:7037ed05f54f 110
mbed_official 0:7037ed05f54f 111 printf("\r\n Mbed LoRaWANStack initialized \r\n");
mbed_official 0:7037ed05f54f 112
mbed_official 0:7037ed05f54f 113 // prepare application callbacks
mbed_official 0:7037ed05f54f 114 callbacks.events = mbed::callback(lora_event_handler);
mbed_official 2:dc95ac6d6d4e 115 lorawan.add_app_callbacks(&callbacks);
mbed_official 0:7037ed05f54f 116
mbed_official 0:7037ed05f54f 117 // Set number of retries in case of CONFIRMED messages
mbed_official 2:dc95ac6d6d4e 118 if (lorawan.set_confirmed_msg_retries(CONFIRMED_MSG_RETRY_COUNTER)
mbed_official 0:7037ed05f54f 119 != LORAWAN_STATUS_OK) {
mbed_official 0:7037ed05f54f 120 printf("\r\n set_confirmed_msg_retries failed! \r\n\r\n");
mbed_official 0:7037ed05f54f 121 return -1;
mbed_official 0:7037ed05f54f 122 }
mbed_official 0:7037ed05f54f 123
mbed_official 0:7037ed05f54f 124 printf("\r\n CONFIRMED message retries : %d \r\n",
mbed_official 0:7037ed05f54f 125 CONFIRMED_MSG_RETRY_COUNTER);
mbed_official 0:7037ed05f54f 126
mbed_official 0:7037ed05f54f 127 // Enable adaptive data rate
mbed_official 2:dc95ac6d6d4e 128 if (lorawan.enable_adaptive_datarate() != LORAWAN_STATUS_OK) {
mbed_official 0:7037ed05f54f 129 printf("\r\n enable_adaptive_datarate failed! \r\n");
mbed_official 0:7037ed05f54f 130 return -1;
mbed_official 0:7037ed05f54f 131 }
mbed_official 0:7037ed05f54f 132
mbed_official 0:7037ed05f54f 133 printf("\r\n Adaptive data rate (ADR) - Enabled \r\n");
mbed_official 0:7037ed05f54f 134
mbed_official 2:dc95ac6d6d4e 135 retcode = lorawan.connect();
mbed_official 0:7037ed05f54f 136
mbed_official 0:7037ed05f54f 137 if (retcode == LORAWAN_STATUS_OK ||
mbed_official 0:7037ed05f54f 138 retcode == LORAWAN_STATUS_CONNECT_IN_PROGRESS) {
mbed_official 0:7037ed05f54f 139 } else {
mbed_official 0:7037ed05f54f 140 printf("\r\n Connection error, code = %d \r\n", retcode);
mbed_official 0:7037ed05f54f 141 return -1;
mbed_official 0:7037ed05f54f 142 }
mbed_official 0:7037ed05f54f 143
mbed_official 0:7037ed05f54f 144 printf("\r\n Connection - In Progress ...\r\n");
mbed_official 0:7037ed05f54f 145
mbed_official 0:7037ed05f54f 146 // make your event queue dispatching events forever
mbed_official 0:7037ed05f54f 147 ev_queue.dispatch_forever();
mbed_official 3:8c7198d1a2a1 148
mbed_official 3:8c7198d1a2a1 149 return 0;
mbed_official 0:7037ed05f54f 150 }
mbed_official 0:7037ed05f54f 151
mbed_official 3:8c7198d1a2a1 152
mbed_official 0:7037ed05f54f 153 /**
mbed_official 0:7037ed05f54f 154 * Sends a message to the Network Server
mbed_official 0:7037ed05f54f 155 */
mbed_official 0:7037ed05f54f 156 static void send_message()
mbed_official 0:7037ed05f54f 157 {
mbed_official 0:7037ed05f54f 158 uint16_t packet_len;
mbed_official 0:7037ed05f54f 159 int16_t retcode;
mbed_official 0:7037ed05f54f 160 float sensor_value;
mbed_official 0:7037ed05f54f 161
mbed_official 0:7037ed05f54f 162 if (ds1820.begin()) {
mbed_official 0:7037ed05f54f 163 ds1820.startConversion();
mbed_official 0:7037ed05f54f 164 sensor_value = ds1820.read();
mbed_official 0:7037ed05f54f 165 printf("\r\n Dummy Sensor Value = %3.1f \r\n", sensor_value);
mbed_official 0:7037ed05f54f 166 ds1820.startConversion();
mbed_official 0:7037ed05f54f 167 } else {
mbed_official 0:7037ed05f54f 168 printf("\r\n No sensor found \r\n");
mbed_official 0:7037ed05f54f 169 return;
mbed_official 0:7037ed05f54f 170 }
mbed_official 0:7037ed05f54f 171
mbed_official 0:7037ed05f54f 172 packet_len = sprintf((char*) tx_buffer, "Dummy Sensor Value is %3.1f",
mbed_official 0:7037ed05f54f 173 sensor_value);
mbed_official 0:7037ed05f54f 174
mbed_official 2:dc95ac6d6d4e 175 retcode = lorawan.send(MBED_CONF_LORA_APP_PORT, tx_buffer, packet_len,
mbed_official 0:7037ed05f54f 176 MSG_CONFIRMED_FLAG);
mbed_official 0:7037ed05f54f 177
mbed_official 0:7037ed05f54f 178 if (retcode < 0) {
mbed_official 0:7037ed05f54f 179 retcode == LORAWAN_STATUS_WOULD_BLOCK ? printf("send - WOULD BLOCK\r\n")
mbed_official 0:7037ed05f54f 180 : printf("\r\n send() - Error code %d \r\n", retcode);
mbed_official 0:7037ed05f54f 181 return;
mbed_official 0:7037ed05f54f 182 }
mbed_official 0:7037ed05f54f 183
mbed_official 0:7037ed05f54f 184 printf("\r\n %d bytes scheduled for transmission \r\n", retcode);
mbed_official 12:5015dfead3f2 185 memset(tx_buffer, 0, sizeof(tx_buffer));
mbed_official 0:7037ed05f54f 186 }
mbed_official 0:7037ed05f54f 187
mbed_official 0:7037ed05f54f 188 /**
mbed_official 0:7037ed05f54f 189 * Receive a message from the Network Server
mbed_official 0:7037ed05f54f 190 */
mbed_official 0:7037ed05f54f 191 static void receive_message()
mbed_official 0:7037ed05f54f 192 {
mbed_official 0:7037ed05f54f 193 int16_t retcode;
mbed_official 2:dc95ac6d6d4e 194 retcode = lorawan.receive(MBED_CONF_LORA_APP_PORT, rx_buffer,
mbed_official 12:5015dfead3f2 195 sizeof(rx_buffer),
mbed_official 0:7037ed05f54f 196 MSG_CONFIRMED_FLAG|MSG_UNCONFIRMED_FLAG);
mbed_official 0:7037ed05f54f 197
mbed_official 0:7037ed05f54f 198 if (retcode < 0) {
mbed_official 0:7037ed05f54f 199 printf("\r\n receive() - Error code %d \r\n", retcode);
mbed_official 0:7037ed05f54f 200 return;
mbed_official 0:7037ed05f54f 201 }
mbed_official 0:7037ed05f54f 202
mbed_official 0:7037ed05f54f 203 printf(" Data:");
mbed_official 0:7037ed05f54f 204
mbed_official 0:7037ed05f54f 205 for (uint8_t i = 0; i < retcode; i++) {
mbed_official 0:7037ed05f54f 206 printf("%x", rx_buffer[i]);
mbed_official 0:7037ed05f54f 207 }
mbed_official 0:7037ed05f54f 208
mbed_official 0:7037ed05f54f 209 printf("\r\n Data Length: %d\r\n", retcode);
mbed_official 0:7037ed05f54f 210
mbed_official 12:5015dfead3f2 211 memset(rx_buffer, 0, sizeof(rx_buffer));
mbed_official 0:7037ed05f54f 212 }
mbed_official 0:7037ed05f54f 213
mbed_official 0:7037ed05f54f 214 /**
mbed_official 0:7037ed05f54f 215 * Event handler
mbed_official 0:7037ed05f54f 216 */
mbed_official 0:7037ed05f54f 217 static void lora_event_handler(lorawan_event_t event)
mbed_official 0:7037ed05f54f 218 {
mbed_official 0:7037ed05f54f 219 switch (event) {
mbed_official 0:7037ed05f54f 220 case CONNECTED:
mbed_official 0:7037ed05f54f 221 printf("\r\n Connection - Successful \r\n");
mbed_official 0:7037ed05f54f 222 if (MBED_CONF_LORA_DUTY_CYCLE_ON) {
mbed_official 0:7037ed05f54f 223 send_message();
mbed_official 0:7037ed05f54f 224 } else {
mbed_official 0:7037ed05f54f 225 ev_queue.call_every(TX_TIMER, send_message);
mbed_official 0:7037ed05f54f 226 }
mbed_official 0:7037ed05f54f 227
mbed_official 0:7037ed05f54f 228 break;
mbed_official 0:7037ed05f54f 229 case DISCONNECTED:
mbed_official 0:7037ed05f54f 230 ev_queue.break_dispatch();
mbed_official 0:7037ed05f54f 231 printf("\r\n Disconnected Successfully \r\n");
mbed_official 0:7037ed05f54f 232 break;
mbed_official 0:7037ed05f54f 233 case TX_DONE:
mbed_official 0:7037ed05f54f 234 printf("\r\n Message Sent to Network Server \r\n");
mbed_official 0:7037ed05f54f 235 if (MBED_CONF_LORA_DUTY_CYCLE_ON) {
mbed_official 0:7037ed05f54f 236 send_message();
mbed_official 0:7037ed05f54f 237 }
mbed_official 0:7037ed05f54f 238 break;
mbed_official 0:7037ed05f54f 239 case TX_TIMEOUT:
mbed_official 0:7037ed05f54f 240 case TX_ERROR:
mbed_official 0:7037ed05f54f 241 case TX_CRYPTO_ERROR:
mbed_official 0:7037ed05f54f 242 case TX_SCHEDULING_ERROR:
mbed_official 0:7037ed05f54f 243 printf("\r\n Transmission Error - EventCode = %d \r\n", event);
mbed_official 0:7037ed05f54f 244 // try again
mbed_official 0:7037ed05f54f 245 if (MBED_CONF_LORA_DUTY_CYCLE_ON) {
mbed_official 0:7037ed05f54f 246 send_message();
mbed_official 0:7037ed05f54f 247 }
mbed_official 0:7037ed05f54f 248 break;
mbed_official 0:7037ed05f54f 249 case RX_DONE:
mbed_official 0:7037ed05f54f 250 printf("\r\n Received message from Network Server \r\n");
mbed_official 0:7037ed05f54f 251 receive_message();
mbed_official 0:7037ed05f54f 252 break;
mbed_official 0:7037ed05f54f 253 case RX_TIMEOUT:
mbed_official 0:7037ed05f54f 254 case RX_ERROR:
mbed_official 0:7037ed05f54f 255 printf("\r\n Error in reception - Code = %d \r\n", event);
mbed_official 0:7037ed05f54f 256 break;
mbed_official 0:7037ed05f54f 257 case JOIN_FAILURE:
mbed_official 0:7037ed05f54f 258 printf("\r\n OTAA Failed - Check Keys \r\n");
mbed_official 0:7037ed05f54f 259 break;
mbed_official 0:7037ed05f54f 260 default:
mbed_official 0:7037ed05f54f 261 MBED_ASSERT("Unknown Event");
mbed_official 0:7037ed05f54f 262 }
mbed_official 0:7037ed05f54f 263 }
mbed_official 0:7037ed05f54f 264
mbed_official 3:8c7198d1a2a1 265 #endif //DEVICE_SPI
mbed_official 3:8c7198d1a2a1 266
mbed_official 3:8c7198d1a2a1 267 #else
mbed_official 3:8c7198d1a2a1 268 int main (void)
mbed_official 3:8c7198d1a2a1 269 {
mbed_official 3:8c7198d1a2a1 270 return 0;
mbed_official 3:8c7198d1a2a1 271 }
mbed_official 3:8c7198d1a2a1 272 #endif //MBED_CONF_APP_LORAWAN_ENABLED
mbed_official 0:7037ed05f54f 273 // EOF