Daniel Knox / RN2483

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   rn2483-TestProgram

RN2483.cpp@8:c4069091afa1, 2016-12-19 (annotated)

Committer:
azazeal88
Date:
Mon Dec 19 08:25:35 2016 +0000
Revision:
8:c4069091afa1
Parent:
7:100ab85cc6d7 
Have removed save functioanlity for now, due to a bug introduced. The potentially long delay between requesting to save and saving means the device is thrown out of sync with the returned 'ok' strings -- causing issues with the library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
azazeal88 0:a8609e6f88f3 1 #include "RN2483.h"
azazeal88 0:a8609e6f88f3 2 #include "StringLiterals.h"
azazeal88 0:a8609e6f88f3 3 #include "Utils.h"
azazeal88 3:ee222a99783c 4 #include "errno.h"
azazeal88 3:ee222a99783c 5 #include "limits.h"
azazeal88 0:a8609e6f88f3 6
azazeal88 0:a8609e6f88f3 7 // Structure for mapping error response strings and error codes.
azazeal88 1:cf9b0c21907a 8 typedef struct StringEnumPair {
azazeal88 0:a8609e6f88f3 9 const char* stringValue;
azazeal88 0:a8609e6f88f3 10 uint8_t enumValue;
azazeal88 0:a8609e6f88f3 11 } StringEnumPair_t;
azazeal88 0:a8609e6f88f3 12
azazeal88 1:cf9b0c21907a 13 /**
azazeal88 1:cf9b0c21907a 14 * @brief Create a new instance of the RN2483.
azazeal88 1:cf9b0c21907a 15 * @param Serial TX pin name.
azazeal88 1:cf9b0c21907a 16 * @param Serial RX pin name.
azazeal88 1:cf9b0c21907a 17 */
azazeal88 1:cf9b0c21907a 18 RN2483::RN2483(PinName tx, PinName rx) :
azazeal88 0:a8609e6f88f3 19 _RN2483(tx, rx, getDefaultBaudRate()),
azazeal88 0:a8609e6f88f3 20 inputBufferSize(DEFAULT_INPUT_BUFFER_SIZE),
azazeal88 0:a8609e6f88f3 21 receivedPayloadBufferSize(DEFAULT_RECEIVED_PAYLOAD_BUFFER_SIZE),
azazeal88 0:a8609e6f88f3 22 packetReceived(false),
azazeal88 1:cf9b0c21907a 23 isRN2903(false)
azazeal88 0:a8609e6f88f3 24 {
azazeal88 0:a8609e6f88f3 25 #ifdef USE_DYNAMIC_BUFFER
azazeal88 0:a8609e6f88f3 26 this->isBufferInitialized = false;
azazeal88 0:a8609e6f88f3 27 #endif
azazeal88 0:a8609e6f88f3 28 }
azazeal88 1:cf9b0c21907a 29
azazeal88 1:cf9b0c21907a 30 /**
azazeal88 1:cf9b0c21907a 31 * @brief Takes care of the init tasks common to both initOTA() and initABP.
azazeal88 1:cf9b0c21907a 32 */
azazeal88 0:a8609e6f88f3 33 void RN2483::init()
azazeal88 0:a8609e6f88f3 34 {
azazeal88 0:a8609e6f88f3 35 #ifdef USE_DYNAMIC_BUFFER
azazeal88 0:a8609e6f88f3 36 // make sure the buffers are only initialized once
azazeal88 0:a8609e6f88f3 37 if (!isBufferInitialized) {
azazeal88 0:a8609e6f88f3 38 this->inputBuffer = static_cast<char*>(malloc(this->inputBufferSize));
azazeal88 0:a8609e6f88f3 39 this->receivedPayloadBuffer = static_cast<char*>(malloc(this->receivedPayloadBufferSize));
azazeal88 0:a8609e6f88f3 40 isBufferInitialized = true;
azazeal88 0:a8609e6f88f3 41 }
azazeal88 0:a8609e6f88f3 42 #endif
azazeal88 0:a8609e6f88f3 43 // make sure the module's state is synced and woken up
azazeal88 1:cf9b0c21907a 44 sleep(259200000);
azazeal88 3:ee222a99783c 45 wait_ms(10);
azazeal88 0:a8609e6f88f3 46 wakeUp();
azazeal88 0:a8609e6f88f3 47 }
azazeal88 0:a8609e6f88f3 48
azazeal88 1:cf9b0c21907a 49 /**
azazeal88 2:336a025b82b5 50 * @brief Initialise settings and connect to network using Over The Air activation.
azazeal88 1:cf9b0c21907a 51 * @param devEUI provided by LoRaWAN Network server registration.
azazeal88 1:cf9b0c21907a 52 * @param appEUI provided by LoRaWAN Network server registration.
azazeal88 1:cf9b0c21907a 53 * @param appKey provided by LoRaWAN Network server registration.
azazeal88 2:336a025b82b5 54 * @return Returns true if network confirmation and able to save settings.
azazeal88 1:cf9b0c21907a 55 */
azazeal88 0:a8609e6f88f3 56 bool RN2483::initOTA(const uint8_t devEUI[8], const uint8_t appEUI[8], const uint8_t appKey[16], bool adr)
azazeal88 0:a8609e6f88f3 57 {
azazeal88 0:a8609e6f88f3 58 init();
azazeal88 2:336a025b82b5 59 if(resetDevice() && setMacParam(STR_DEV_EUI, devEUI, 8) && setMacParam(STR_APP_EUI, appEUI, 8) &&
azazeal88 2:336a025b82b5 60 setMacParam(STR_APP_KEY, appKey, 16) && setMacParam(STR_ADR, BOOL_TO_ONOFF(adr)) && joinOTTA()) {
azazeal88 2:336a025b82b5 61 if(saveConfiguration()) {
azazeal88 2:336a025b82b5 62 return true;
azazeal88 2:336a025b82b5 63 }
azazeal88 2:336a025b82b5 64 }
azazeal88 2:336a025b82b5 65 return false;
azazeal88 0:a8609e6f88f3 66 }
azazeal88 0:a8609e6f88f3 67
azazeal88 1:cf9b0c21907a 68 /**
azazeal88 1:cf9b0c21907a 69 * @brief Initializes the device and connects to the network using Activation By Personalization.
azazeal88 1:cf9b0c21907a 70 * @param devADDR provided by LoRaWAN Network server registration.
azazeal88 1:cf9b0c21907a 71 * @param appSKey provided by LoRaWAN Network server registration.
azazeal88 1:cf9b0c21907a 72 * @param nwkSKey provided by LoRaWAN Network server registration.
azazeal88 2:336a025b82b5 73 * @return Returns true if the parameters were valid and able to save settings.
azazeal88 1:cf9b0c21907a 74 */
azazeal88 0:a8609e6f88f3 75 bool RN2483::initABP(const uint8_t devAddr[4], const uint8_t appSKey[16], const uint8_t nwkSKey[16], bool adr)
azazeal88 0:a8609e6f88f3 76 {
azazeal88 0:a8609e6f88f3 77 init();
azazeal88 2:336a025b82b5 78 if(resetDevice() && setMacParam(STR_DEV_ADDR, devAddr, 4) && setMacParam(STR_APP_SESSION_KEY, appSKey, 16) &&
azazeal88 2:336a025b82b5 79 setMacParam(STR_NETWORK_SESSION_KEY, nwkSKey, 16) && setMacParam(STR_ADR, BOOL_TO_ONOFF(adr)) &&
azazeal88 2:336a025b82b5 80 joinABP()) {
azazeal88 2:336a025b82b5 81 if(saveConfiguration()) {
azazeal88 2:336a025b82b5 82 return true;
azazeal88 2:336a025b82b5 83 }
azazeal88 2:336a025b82b5 84 }
azazeal88 2:336a025b82b5 85 return false;
azazeal88 2:336a025b82b5 86 }
azazeal88 2:336a025b82b5 87
azazeal88 2:336a025b82b5 88 /**
azazeal88 2:336a025b82b5 89 * @brief Attempts to connect to the network using Over The Air Activation.
azazeal88 2:336a025b82b5 90 * @return Returns true if able to join network.
azazeal88 2:336a025b82b5 91 */
azazeal88 2:336a025b82b5 92 bool RN2483::joinOTTA()
azazeal88 2:336a025b82b5 93 {
azazeal88 2:336a025b82b5 94 return joinNetwork(STR_OTAA);
azazeal88 2:336a025b82b5 95 }
azazeal88 2:336a025b82b5 96
azazeal88 2:336a025b82b5 97 /**
azazeal88 2:336a025b82b5 98 * @brief Attempts to connect to the network using Activation By Personalization.
azazeal88 2:336a025b82b5 99 * @return Returns true if able to join network.
azazeal88 2:336a025b82b5 100 */
azazeal88 2:336a025b82b5 101 bool RN2483::joinABP()
azazeal88 2:336a025b82b5 102 {
azazeal88 2:336a025b82b5 103 return joinNetwork(STR_ABP);
azazeal88 0:a8609e6f88f3 104 }
azazeal88 1:cf9b0c21907a 105
azazeal88 1:cf9b0c21907a 106 /**
azazeal88 1:cf9b0c21907a 107 * @brief Sends the given payload without acknowledgement.
azazeal88 1:cf9b0c21907a 108 * @param Port to use for transmission.
azazeal88 1:cf9b0c21907a 109 * @param Payload buffer
azazeal88 1:cf9b0c21907a 110 * @param Payload buffer size
azazeal88 1:cf9b0c21907a 111 * @return Returns 0 (NoError) when data was sucessfully fowarded to radio, otherwise returns MacTransmitErrorCode.
azazeal88 1:cf9b0c21907a 112 */
azazeal88 0:a8609e6f88f3 113 uint8_t RN2483::send(uint8_t port, const uint8_t* payload, uint8_t size)
azazeal88 0:a8609e6f88f3 114 {
azazeal88 0:a8609e6f88f3 115 return macTransmit(STR_UNCONFIRMED, port, payload, size);
azazeal88 0:a8609e6f88f3 116 }
azazeal88 0:a8609e6f88f3 117
azazeal88 1:cf9b0c21907a 118 /**
azazeal88 1:cf9b0c21907a 119 * @brief Sends the given payload with acknowledgement.
azazeal88 1:cf9b0c21907a 120 * @param Port to use for transmission.
azazeal88 1:cf9b0c21907a 121 * @param Payload buffer
azazeal88 1:cf9b0c21907a 122 * @param Payload buffer size
azazeal88 1:cf9b0c21907a 123 * @param Number of transmission retries in event of network transmission failure.
azazeal88 1:cf9b0c21907a 124 * @return Returns 0 (NoError) when network acks transmission, otherwise returns MacTransmitErrorCode.
azazeal88 1:cf9b0c21907a 125 */
azazeal88 1:cf9b0c21907a 126 uint8_t RN2483::sendReqAck(uint8_t port, const uint8_t* payload, uint8_t size, uint8_t maxRetries)
azazeal88 0:a8609e6f88f3 127 {
azazeal88 8:c4069091afa1 128 // Need to implement retries! mac set retx
azazeal88 0:a8609e6f88f3 129 return macTransmit(STR_CONFIRMED, port, payload, size);
azazeal88 0:a8609e6f88f3 130 }
azazeal88 0:a8609e6f88f3 131
azazeal88 1:cf9b0c21907a 132 /**
azazeal88 1:cf9b0c21907a 133 * @brief Copies the latest received packet (optionally starting from the "payloadStartPosition" of the payload).
azazeal88 1:cf9b0c21907a 134 * @param Buffer to read into.
azazeal88 1:cf9b0c21907a 135 * @param Buffer size.
azazeal88 1:cf9b0c21907a 136 * @return Returns the number of bytes written or 0 if no packet is received since last transmission.
azazeal88 1:cf9b0c21907a 137 */
azazeal88 0:a8609e6f88f3 138 uint16_t RN2483::receive(uint8_t* buffer, uint16_t size,
azazeal88 1:cf9b0c21907a 139 uint16_t payloadStartPosition)
azazeal88 0:a8609e6f88f3 140 {
azazeal88 0:a8609e6f88f3 141
azazeal88 0:a8609e6f88f3 142 if (!this->packetReceived) {
azazeal88 0:a8609e6f88f3 143 return 0;
azazeal88 0:a8609e6f88f3 144 }
azazeal88 0:a8609e6f88f3 145
azazeal88 0:a8609e6f88f3 146 uint16_t inputIndex = payloadStartPosition * 2; // payloadStartPosition is in bytes, not hex char pairs
azazeal88 0:a8609e6f88f3 147 uint16_t outputIndex = 0;
azazeal88 0:a8609e6f88f3 148
azazeal88 0:a8609e6f88f3 149 // check that the asked starting position is within bounds
azazeal88 0:a8609e6f88f3 150 if (inputIndex >= this->receivedPayloadBufferSize) {
azazeal88 0:a8609e6f88f3 151 return 0;
azazeal88 0:a8609e6f88f3 152 }
azazeal88 0:a8609e6f88f3 153
azazeal88 0:a8609e6f88f3 154 // stop at the first string termination char, or if output buffer is over, or if payload buffer is over
azazeal88 0:a8609e6f88f3 155 while (outputIndex < size
azazeal88 1:cf9b0c21907a 156 && inputIndex + 1 < this->receivedPayloadBufferSize
azazeal88 1:cf9b0c21907a 157 && this->receivedPayloadBuffer[inputIndex] != 0
azazeal88 1:cf9b0c21907a 158 && this->receivedPayloadBuffer[inputIndex + 1] != 0) {
azazeal88 0:a8609e6f88f3 159 buffer[outputIndex] = HEX_PAIR_TO_BYTE(
azazeal88 1:cf9b0c21907a 160 this->receivedPayloadBuffer[inputIndex],
azazeal88 1:cf9b0c21907a 161 this->receivedPayloadBuffer[inputIndex + 1]);
azazeal88 0:a8609e6f88f3 162
azazeal88 0:a8609e6f88f3 163 inputIndex += 2;
azazeal88 0:a8609e6f88f3 164 outputIndex++;
azazeal88 0:a8609e6f88f3 165 }
azazeal88 0:a8609e6f88f3 166
azazeal88 0:a8609e6f88f3 167 // Note: if the payload has an odd length, the last char is discarded
azazeal88 0:a8609e6f88f3 168
azazeal88 0:a8609e6f88f3 169 buffer[outputIndex] = 0; // terminate the string
azazeal88 0:a8609e6f88f3 170
azazeal88 0:a8609e6f88f3 171 return outputIndex;
azazeal88 0:a8609e6f88f3 172 }
azazeal88 0:a8609e6f88f3 173
azazeal88 1:cf9b0c21907a 174 /**
azazeal88 3:ee222a99783c 175 * @brief Gets the preprogrammed EUI node address from the module in HEX.
azazeal88 1:cf9b0c21907a 176 * @param Buffer to read into.
azazeal88 1:cf9b0c21907a 177 * @param Buffer size.
azazeal88 1:cf9b0c21907a 178 * @return Returns the number of bytes written or 0 in case of error..
azazeal88 1:cf9b0c21907a 179 */
azazeal88 0:a8609e6f88f3 180 uint8_t RN2483::getHWEUI(uint8_t* buffer, uint8_t size)
azazeal88 0:a8609e6f88f3 181 {
azazeal88 0:a8609e6f88f3 182 _RN2483.printf(STR_CMD_GET_HWEUI);
azazeal88 0:a8609e6f88f3 183 _RN2483.printf(CRLF);
azazeal88 0:a8609e6f88f3 184
azazeal88 0:a8609e6f88f3 185 // TODO move to general "read hex" method
azazeal88 0:a8609e6f88f3 186 uint8_t inputIndex = 0;
azazeal88 0:a8609e6f88f3 187 uint8_t outputIndex = 0;
azazeal88 0:a8609e6f88f3 188 Timer t;
azazeal88 0:a8609e6f88f3 189 t.start();
azazeal88 0:a8609e6f88f3 190
azazeal88 1:cf9b0c21907a 191 int start = t.read_ms ();
azazeal88 0:a8609e6f88f3 192 while (t.read_ms () < start + DEFAULT_TIMEOUT) {
azazeal88 0:a8609e6f88f3 193 if (readLn() > 0) {
azazeal88 0:a8609e6f88f3 194 while (outputIndex < size
azazeal88 1:cf9b0c21907a 195 && inputIndex + 1 < this->inputBufferSize
azazeal88 1:cf9b0c21907a 196 && this->inputBuffer[inputIndex] != 0
azazeal88 1:cf9b0c21907a 197 && this->inputBuffer[inputIndex + 1] != 0) {
azazeal88 0:a8609e6f88f3 198 buffer[outputIndex] = HEX_PAIR_TO_BYTE(
azazeal88 1:cf9b0c21907a 199 this->inputBuffer[inputIndex],
azazeal88 1:cf9b0c21907a 200 this->inputBuffer[inputIndex + 1]);
azazeal88 0:a8609e6f88f3 201 inputIndex += 2;
azazeal88 0:a8609e6f88f3 202 outputIndex++;
azazeal88 0:a8609e6f88f3 203 }
azazeal88 0:a8609e6f88f3 204 t.stop();
azazeal88 0:a8609e6f88f3 205 return outputIndex;
azazeal88 0:a8609e6f88f3 206 }
azazeal88 0:a8609e6f88f3 207 }
azazeal88 1:cf9b0c21907a 208 t.stop();
azazeal88 0:a8609e6f88f3 209 return 0;
azazeal88 0:a8609e6f88f3 210 }
azazeal88 0:a8609e6f88f3 211
azazeal88 2:336a025b82b5 212 /**
azazeal88 2:336a025b82b5 213 * @brief Informs the RN2483 to do an ADC conversion on the VDD.
azazeal88 5:eb983e9336a7 214 * @param Pass pointer to long for conversion to read into.
azazeal88 5:eb983e9336a7 215 * @return Returns if a value was sucessfully read into the long.
azazeal88 2:336a025b82b5 216 */
azazeal88 4:0c066401ae12 217 bool RN2483::getVDD(long *vdd)
azazeal88 2:336a025b82b5 218 {
azazeal88 2:336a025b82b5 219 _RN2483.printf(STR_CMD_GET_VDD);
azazeal88 2:336a025b82b5 220 _RN2483.printf(CRLF);
azazeal88 4:0c066401ae12 221 Timer t;
azazeal88 4:0c066401ae12 222 t.start();
azazeal88 4:0c066401ae12 223 int timeout = t.read_ms() + RECEIVE_TIMEOUT; // hard timeouts
azazeal88 4:0c066401ae12 224 while (t.read_ms() < timeout) {
azazeal88 4:0c066401ae12 225 if (readLn() > 0) {
azazeal88 4:0c066401ae12 226 char *temp;
azazeal88 4:0c066401ae12 227 bool rc = true;
azazeal88 4:0c066401ae12 228 errno = 0;
azazeal88 4:0c066401ae12 229 *vdd = strtol(this->inputBuffer, &temp, 10);
azazeal88 4:0c066401ae12 230 if (temp == this->inputBuffer || *temp != '\0' || ((*vdd == LONG_MIN ||
azazeal88 4:0c066401ae12 231 *vdd == LONG_MAX) && errno == ERANGE)){
azazeal88 4:0c066401ae12 232 rc = false;
azazeal88 4:0c066401ae12 233 }
azazeal88 4:0c066401ae12 234 t.stop();
azazeal88 4:0c066401ae12 235 return rc;
azazeal88 4:0c066401ae12 236 }
azazeal88 2:336a025b82b5 237 }
azazeal88 4:0c066401ae12 238 t.stop();
azazeal88 3:ee222a99783c 239 return false;
azazeal88 2:336a025b82b5 240 }
azazeal88 2:336a025b82b5 241
azazeal88 0:a8609e6f88f3 242 #ifdef ENABLE_SLEEP
azazeal88 1:cf9b0c21907a 243 /**
azazeal88 1:cf9b0c21907a 244 * @brief Sends a serial line break to wake up the RN2483
azazeal88 1:cf9b0c21907a 245 */
azazeal88 0:a8609e6f88f3 246 void RN2483::wakeUp()
azazeal88 0:a8609e6f88f3 247 {
azazeal88 8:c4069091afa1 248 // "emulate" break condition
azazeal88 0:a8609e6f88f3 249 _RN2483.send_break();
azazeal88 0:a8609e6f88f3 250 // set baudrate
azazeal88 0:a8609e6f88f3 251 _RN2483.baud(getDefaultBaudRate());
azazeal88 0:a8609e6f88f3 252 _RN2483.putc((uint8_t)0x55);
azazeal88 0:a8609e6f88f3 253 }
azazeal88 0:a8609e6f88f3 254
azazeal88 1:cf9b0c21907a 255 /**
azazeal88 1:cf9b0c21907a 256 * @brief Sends the RN2483 to sleep for a finite length of time.
azazeal88 1:cf9b0c21907a 257 * @param Milliseconds to sleep for.
azazeal88 1:cf9b0c21907a 258 */
azazeal88 1:cf9b0c21907a 259 void RN2483::sleep(uint32_t sleepLength)
azazeal88 1:cf9b0c21907a 260 {
azazeal88 8:c4069091afa1 261 if(sleepLength > 100) {
azazeal88 1:cf9b0c21907a 262 _RN2483.printf("%s%u",STR_CMD_SLEEP,sleepLength);
azazeal88 1:cf9b0c21907a 263 _RN2483.printf(CRLF);
azazeal88 1:cf9b0c21907a 264 }
azazeal88 1:cf9b0c21907a 265 }
azazeal88 1:cf9b0c21907a 266
azazeal88 1:cf9b0c21907a 267 /**
azazeal88 1:cf9b0c21907a 268 * @brief Sends the RN2483 to sleep for a finite length of time.
azazeal88 1:cf9b0c21907a 269 * Roughly three days.
azazeal88 1:cf9b0c21907a 270 */
azazeal88 0:a8609e6f88f3 271 void RN2483::sleep()
azazeal88 0:a8609e6f88f3 272 {
azazeal88 1:cf9b0c21907a 273 sleep(4294967295);
azazeal88 0:a8609e6f88f3 274 }
azazeal88 0:a8609e6f88f3 275
azazeal88 0:a8609e6f88f3 276 #endif
azazeal88 0:a8609e6f88f3 277
azazeal88 1:cf9b0c21907a 278 /**
azazeal88 1:cf9b0c21907a 279 * @brief Reads a line from the device serial stream.
azazeal88 1:cf9b0c21907a 280 * @param Buffer to read into.
azazeal88 1:cf9b0c21907a 281 * @param Size of buffer.
azazeal88 1:cf9b0c21907a 282 * @param Position to start from.
azazeal88 1:cf9b0c21907a 283 * @return Number of bytes read.
azazeal88 1:cf9b0c21907a 284 */
azazeal88 0:a8609e6f88f3 285 uint16_t RN2483::readLn(char* buffer, uint16_t size, uint16_t start)
azazeal88 0:a8609e6f88f3 286 {
azazeal88 0:a8609e6f88f3 287 int len = readBytesUntil('\n', buffer + start, size);
azazeal88 0:a8609e6f88f3 288 if (len > 0) {
azazeal88 0:a8609e6f88f3 289 this->inputBuffer[start + len - 1] = 0; // bytes until \n always end with \r, so get rid of it (-1)
azazeal88 0:a8609e6f88f3 290 }
azazeal88 0:a8609e6f88f3 291
azazeal88 0:a8609e6f88f3 292 return len;
azazeal88 0:a8609e6f88f3 293 }
azazeal88 0:a8609e6f88f3 294
azazeal88 1:cf9b0c21907a 295 /**
azazeal88 1:cf9b0c21907a 296 * @brief Waits for the given string.
azazeal88 1:cf9b0c21907a 297 * @param String to look for.
azazeal88 1:cf9b0c21907a 298 * @param Timeout Period
azazeal88 1:cf9b0c21907a 299 * @param Position to start from.
azazeal88 1:cf9b0c21907a 300 * @return Returns true if the string is received before a timeout.
azazeal88 1:cf9b0c21907a 301 * Returns false if a timeout occurs or if another string is received.
azazeal88 1:cf9b0c21907a 302 */
azazeal88 0:a8609e6f88f3 303 bool RN2483::expectString(const char* str, uint16_t timeout)
azazeal88 0:a8609e6f88f3 304 {
azazeal88 0:a8609e6f88f3 305 Timer t;
azazeal88 0:a8609e6f88f3 306 t.start();
azazeal88 1:cf9b0c21907a 307 int start = t.read_ms();
azazeal88 0:a8609e6f88f3 308 while (t.read_ms() < start + timeout) {
azazeal88 0:a8609e6f88f3 309 if (readLn() > 0) {
azazeal88 0:a8609e6f88f3 310 if (strstr(this->inputBuffer, str) != NULL) {
azazeal88 0:a8609e6f88f3 311 t.stop();
azazeal88 0:a8609e6f88f3 312 return true;
azazeal88 0:a8609e6f88f3 313 }
azazeal88 1:cf9b0c21907a 314 t.stop();
azazeal88 0:a8609e6f88f3 315 return false;
azazeal88 0:a8609e6f88f3 316 }
azazeal88 0:a8609e6f88f3 317 }
azazeal88 0:a8609e6f88f3 318 t.stop();
azazeal88 0:a8609e6f88f3 319 return false;
azazeal88 0:a8609e6f88f3 320 }
azazeal88 0:a8609e6f88f3 321
azazeal88 1:cf9b0c21907a 322 /**
azazeal88 1:cf9b0c21907a 323 * @brief Looks for an 'OK' response from the RN2483
azazeal88 7:100ab85cc6d7 324 * @param Timeout Period
azazeal88 1:cf9b0c21907a 325 * @return Returns true if the string is received before a timeout.
azazeal88 1:cf9b0c21907a 326 * Returns false if a timeout occurs or if another string is received.
azazeal88 1:cf9b0c21907a 327 */
azazeal88 7:100ab85cc6d7 328 bool RN2483::expectOK(uint16_t timeout)
azazeal88 0:a8609e6f88f3 329 {
azazeal88 7:100ab85cc6d7 330 return expectString(STR_RESULT_OK, timeout);
azazeal88 0:a8609e6f88f3 331 }
azazeal88 0:a8609e6f88f3 332
azazeal88 1:cf9b0c21907a 333 /**
azazeal88 1:cf9b0c21907a 334 * @brief Sends a reset command to the module
azazeal88 1:cf9b0c21907a 335 * Also sets-up some initial parameters like power index, SF and FSB channels.
azazeal88 1:cf9b0c21907a 336 * @return Waits for sucess reponse or timeout.
azazeal88 1:cf9b0c21907a 337 */
azazeal88 0:a8609e6f88f3 338 bool RN2483::resetDevice()
azazeal88 0:a8609e6f88f3 339 {
azazeal88 0:a8609e6f88f3 340 _RN2483.printf(STR_CMD_RESET);
azazeal88 0:a8609e6f88f3 341 _RN2483.printf(CRLF);
azazeal88 0:a8609e6f88f3 342 if (expectString(STR_DEVICE_TYPE_RN)) {
azazeal88 0:a8609e6f88f3 343 if (strstr(this->inputBuffer, STR_DEVICE_TYPE_RN2483) != NULL) {
azazeal88 0:a8609e6f88f3 344 isRN2903 = false;
azazeal88 0:a8609e6f88f3 345 return setPowerIndex(DEFAULT_PWR_IDX_868) &&
azazeal88 1:cf9b0c21907a 346 setSpreadingFactor(DEFAULT_SF_868);
azazeal88 1:cf9b0c21907a 347 } else if (strstr(this->inputBuffer, STR_DEVICE_TYPE_RN2903) != NULL) {
azazeal88 0:a8609e6f88f3 348 // TODO move into init once it is decided how to handle RN2903-specific operations
azazeal88 0:a8609e6f88f3 349 isRN2903 = true;
azazeal88 0:a8609e6f88f3 350
azazeal88 0:a8609e6f88f3 351 return setFsbChannels(DEFAULT_FSB) &&
azazeal88 1:cf9b0c21907a 352 setPowerIndex(DEFAULT_PWR_IDX_915) &&
azazeal88 1:cf9b0c21907a 353 setSpreadingFactor(DEFAULT_SF_915);
azazeal88 1:cf9b0c21907a 354 } else {
azazeal88 0:a8609e6f88f3 355 return false;
azazeal88 0:a8609e6f88f3 356 }
azazeal88 0:a8609e6f88f3 357 }
azazeal88 0:a8609e6f88f3 358 return false;
azazeal88 0:a8609e6f88f3 359 }
azazeal88 0:a8609e6f88f3 360
azazeal88 1:cf9b0c21907a 361 /**
azazeal88 1:cf9b0c21907a 362 * @brief Enables all the channels that belong to the given Frequency Sub-Band (FSB)
azazeal88 1:cf9b0c21907a 363 * disables the rest.
azazeal88 1:cf9b0c21907a 364 * @param FSB is [1, 8] or 0 to enable all channels.
azazeal88 1:cf9b0c21907a 365 * @return Returns true if all channels were set successfully.
azazeal88 1:cf9b0c21907a 366 */
azazeal88 0:a8609e6f88f3 367 bool RN2483::setFsbChannels(uint8_t fsb)
azazeal88 0:a8609e6f88f3 368 {
azazeal88 0:a8609e6f88f3 369 uint8_t first125kHzChannel = fsb > 0 ? (fsb - 1) * 8 : 0;
azazeal88 0:a8609e6f88f3 370 uint8_t last125kHzChannel = fsb > 0 ? first125kHzChannel + 7 : 71;
azazeal88 0:a8609e6f88f3 371 uint8_t fsb500kHzChannel = fsb + 63;
azazeal88 0:a8609e6f88f3 372
azazeal88 0:a8609e6f88f3 373 bool allOk = true;
azazeal88 0:a8609e6f88f3 374 for (uint8_t i = 0; i < 72; i++) {
azazeal88 0:a8609e6f88f3 375 _RN2483.printf(STR_CMD_SET_CHANNEL_STATUS);
azazeal88 0:a8609e6f88f3 376 _RN2483.printf("%u",i);
azazeal88 0:a8609e6f88f3 377 _RN2483.printf(" ");
azazeal88 0:a8609e6f88f3 378 _RN2483.printf(BOOL_TO_ONOFF(((i == fsb500kHzChannel) || (i >= first125kHzChannel && i <= last125kHzChannel))));
azazeal88 0:a8609e6f88f3 379 _RN2483.printf(CRLF);
azazeal88 0:a8609e6f88f3 380
azazeal88 0:a8609e6f88f3 381 allOk &= expectOK();
azazeal88 0:a8609e6f88f3 382 }
azazeal88 0:a8609e6f88f3 383
azazeal88 0:a8609e6f88f3 384 return allOk;
azazeal88 0:a8609e6f88f3 385 }
azazeal88 0:a8609e6f88f3 386
azazeal88 1:cf9b0c21907a 387 /**
azazeal88 1:cf9b0c21907a 388 * @brief Sets the spreading factor.
azazeal88 1:cf9b0c21907a 389 * @param Spreading factor parameter.
azazeal88 1:cf9b0c21907a 390 * @return Returns true if was set successfully.
azazeal88 1:cf9b0c21907a 391 */
azazeal88 0:a8609e6f88f3 392 bool RN2483::setSpreadingFactor(uint8_t spreadingFactor)
azazeal88 0:a8609e6f88f3 393 {
azazeal88 0:a8609e6f88f3 394 int8_t datarate;
azazeal88 0:a8609e6f88f3 395 if (!isRN2903) {
azazeal88 0:a8609e6f88f3 396 // RN2483 SF(DR) = 7(5), 8(4), 9(3), 10(2), 11(1), 12(0)
azazeal88 0:a8609e6f88f3 397 datarate = 12 - spreadingFactor;
azazeal88 1:cf9b0c21907a 398 } else {
azazeal88 0:a8609e6f88f3 399 // RN2903 SF(DR) = 7(3), 8(2), 9(1), 10(0)
azazeal88 0:a8609e6f88f3 400 datarate = 10 - spreadingFactor;
azazeal88 0:a8609e6f88f3 401 }
azazeal88 0:a8609e6f88f3 402
azazeal88 0:a8609e6f88f3 403 if (datarate > -1) {
azazeal88 0:a8609e6f88f3 404 return setMacParam(STR_DATARATE, datarate);
azazeal88 0:a8609e6f88f3 405 }
azazeal88 0:a8609e6f88f3 406
azazeal88 0:a8609e6f88f3 407 return false;
azazeal88 0:a8609e6f88f3 408 }
azazeal88 0:a8609e6f88f3 409
azazeal88 1:cf9b0c21907a 410 /**
azazeal88 1:cf9b0c21907a 411 * @brief Sets the power index
azazeal88 1:cf9b0c21907a 412 * @param 868MHz: 1 to 5 / 915MHz: 5, 7, 8, 9 or 10.
azazeal88 1:cf9b0c21907a 413 * @return Returns true if succesful.
azazeal88 1:cf9b0c21907a 414 */
azazeal88 0:a8609e6f88f3 415 bool RN2483::setPowerIndex(uint8_t powerIndex)
azazeal88 0:a8609e6f88f3 416 {
azazeal88 0:a8609e6f88f3 417 return setMacParam(STR_PWR_IDX, powerIndex);
azazeal88 0:a8609e6f88f3 418 }
azazeal88 0:a8609e6f88f3 419
azazeal88 1:cf9b0c21907a 420 /**
azazeal88 1:cf9b0c21907a 421 * @brief Sets the time interval for the link check process. When the time expires, the next application
azazeal88 1:cf9b0c21907a 422 * packet will include a link check command to the server.
azazeal88 1:cf9b0c21907a 423 * @param Decimal number that sets the time interval in seconds, from 0 to 65535. 0 disables link check process.
azazeal88 1:cf9b0c21907a 424 * @return Returns true if parameter is valid or false if time interval is not valid.
azazeal88 1:cf9b0c21907a 425 */
azazeal88 1:cf9b0c21907a 426 bool RN2483::setLinkCheckInterval(uint8_t linkCheckInterval)
azazeal88 1:cf9b0c21907a 427 {
azazeal88 8:c4069091afa1 428 return setMacParam(STR_LNK_CHK, linkCheckInterval);
azazeal88 1:cf9b0c21907a 429 }
azazeal88 1:cf9b0c21907a 430
azazeal88 1:cf9b0c21907a 431 /**
azazeal88 1:cf9b0c21907a 432 * @brief Sets the battery level required for the Device Status Answer frame in LoRaWAN Class A Protocol.
azazeal88 1:cf9b0c21907a 433 * @param temperature Decimal number between 0-255 representing battery level. 0 means external power, 1 means
azazeal88 1:cf9b0c21907a 434 * low level, 254 means high level, 255 means the device was unable to measure battery level.
azazeal88 1:cf9b0c21907a 435 * @return Returns true if battery level is valid or false if value not valid.
azazeal88 1:cf9b0c21907a 436 */
azazeal88 1:cf9b0c21907a 437 bool RN2483::setBattery(uint8_t batLvl)
azazeal88 1:cf9b0c21907a 438 {
azazeal88 8:c4069091afa1 439 return setMacParam(STR_BAT, batLvl);
azazeal88 1:cf9b0c21907a 440 }
azazeal88 1:cf9b0c21907a 441
azazeal88 1:cf9b0c21907a 442 /**
azazeal88 1:cf9b0c21907a 443 * @brief Sets the module operation frequency on a given channel ID.
azazeal88 1:cf9b0c21907a 444 * @param Channel ID from 3 - 15.
azazeal88 1:cf9b0c21907a 445 * @param Decimal number representing the frequency.
azazeal88 1:cf9b0c21907a 446 * 863000000 to 870000000 or 433050000 to 434790000 in Hz
azazeal88 1:cf9b0c21907a 447 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 448 */
azazeal88 2:336a025b82b5 449 bool RN2483::setChannelFreq(uint8_t channelID, uint32_t frequency)
azazeal88 2:336a025b82b5 450 {
azazeal88 2:336a025b82b5 451 if((channelID <= 15 && channelID >= 3)) {
azazeal88 2:336a025b82b5 452 if((frequency <=870000000 && frequency >= 863000000)||(frequency <=434790000 && frequency >= 433050000)) {
azazeal88 1:cf9b0c21907a 453 char buffer [15];
azazeal88 8:c4069091afa1 454 int bytesWritten = sprintf(buffer, "%d %lu", channelID, frequency);
azazeal88 1:cf9b0c21907a 455 // Check to make sure sprintf did not return an error before sending.
azazeal88 1:cf9b0c21907a 456 if(bytesWritten > 0) {
azazeal88 2:336a025b82b5 457 return setMacParam(STR_CH_FREQ, buffer);
azazeal88 2:336a025b82b5 458 }
azazeal88 2:336a025b82b5 459 }
azazeal88 1:cf9b0c21907a 460 }
azazeal88 1:cf9b0c21907a 461 return false;
azazeal88 1:cf9b0c21907a 462 }
azazeal88 1:cf9b0c21907a 463
azazeal88 1:cf9b0c21907a 464 /**
azazeal88 1:cf9b0c21907a 465 * @brief Sets the duty cycle allowed on the given channel ID.
azazeal88 1:cf9b0c21907a 466 * @param Channel ID to set duty cycle (0-15),
azazeal88 1:cf9b0c21907a 467 * @param Duty cycle is 0 - 100% as a float.
azazeal88 1:cf9b0c21907a 468 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 469 */
azazeal88 1:cf9b0c21907a 470 bool RN2483::setDutyCycle(uint8_t channelID, float dutyCycle)
azazeal88 1:cf9b0c21907a 471 {
azazeal88 1:cf9b0c21907a 472 // Convert duty cycle into the required value using equation (100 / X) - 1
azazeal88 1:cf9b0c21907a 473 if((dutyCycle <= (float)100 && dutyCycle >=(float)0) && (channelID > 15)) {
azazeal88 1:cf9b0c21907a 474 uint8_t dutyCycleSetting = ((float)100 / dutyCycle) - 1;
azazeal88 1:cf9b0c21907a 475 // Create the string for the settings
azazeal88 1:cf9b0c21907a 476 char buffer [15];
azazeal88 1:cf9b0c21907a 477 int bytesWritten = sprintf(buffer, "%d %d", channelID, dutyCycleSetting);
azazeal88 1:cf9b0c21907a 478 // Check to make sure sprintf did not return an error before sending.
azazeal88 1:cf9b0c21907a 479 if(bytesWritten > 0) {
azazeal88 2:336a025b82b5 480 return setMacParam(STR_CH_DCYCLE, buffer);
azazeal88 1:cf9b0c21907a 481 }
azazeal88 1:cf9b0c21907a 482 }
azazeal88 1:cf9b0c21907a 483 return false;
azazeal88 1:cf9b0c21907a 484 }
azazeal88 1:cf9b0c21907a 485
azazeal88 1:cf9b0c21907a 486 /**
azazeal88 1:cf9b0c21907a 487 * @brief Sets the data rate for a given channel ID.
azazeal88 1:cf9b0c21907a 488 * Please refer to the LoRaWAN spec for the actual values.
azazeal88 1:cf9b0c21907a 489 * @param Channel ID from 0 - 15.
azazeal88 1:cf9b0c21907a 490 * @param Number representing the minimum data rate range from 0 to 7.
azazeal88 1:cf9b0c21907a 491 * @param Number representing the maximum data rate range from 0 to 7
azazeal88 1:cf9b0c21907a 492 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 493 */
azazeal88 2:336a025b82b5 494 bool RN2483::setDrRange(uint8_t channelID, uint8_t minRange, uint8_t maxRange)
azazeal88 2:336a025b82b5 495 {
azazeal88 2:336a025b82b5 496 if((channelID <= 15)&&(minRange<=7)&&(maxRange<=7)) {
azazeal88 1:cf9b0c21907a 497 char buffer [15];
azazeal88 1:cf9b0c21907a 498 int bytesWritten = sprintf(buffer, "%d %d %d", channelID, minRange, maxRange);
azazeal88 1:cf9b0c21907a 499 // Check to make sure sprintf did not return an error before sending.
azazeal88 1:cf9b0c21907a 500 if(bytesWritten > 0) {
azazeal88 1:cf9b0c21907a 501 return setMacParam(STR_CH_DRRANGE, buffer);
azazeal88 1:cf9b0c21907a 502 }
azazeal88 1:cf9b0c21907a 503 }
azazeal88 1:cf9b0c21907a 504 return false;
azazeal88 1:cf9b0c21907a 505 }
azazeal88 1:cf9b0c21907a 506
azazeal88 1:cf9b0c21907a 507 /**
azazeal88 1:cf9b0c21907a 508 * @brief Sets a given channel ID to be enabled or disabled.
azazeal88 1:cf9b0c21907a 509 * @param Channel ID from 0 - 15.
azazeal88 1:cf9b0c21907a 510 * @param Flag representing if channel is enabled or disabled.
azazeal88 1:cf9b0c21907a 511 * Warning: duty cycle, frequency and data range must be set for a channel
azazeal88 1:cf9b0c21907a 512 * before enabling!
azazeal88 1:cf9b0c21907a 513 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 514 */
azazeal88 2:336a025b82b5 515 bool RN2483::setStatus(uint8_t channelID, bool status)
azazeal88 2:336a025b82b5 516 {
azazeal88 2:336a025b82b5 517 if((channelID <= 15)) {
azazeal88 2:336a025b82b5 518 int bytesWritten = 0;
azazeal88 2:336a025b82b5 519 char buffer [15];
azazeal88 2:336a025b82b5 520 if(status)
azazeal88 2:336a025b82b5 521 bytesWritten = sprintf(buffer, "%d %s", channelID, "on");
azazeal88 2:336a025b82b5 522 else {
azazeal88 2:336a025b82b5 523 bytesWritten = sprintf(buffer, "%d %s", channelID, "off");
azazeal88 2:336a025b82b5 524 }
azazeal88 2:336a025b82b5 525 // Check to make sure sprintf did not return an error before sending.
azazeal88 2:336a025b82b5 526 if(bytesWritten > 0) {
azazeal88 2:336a025b82b5 527 return sendCommand(STR_CMD_SET_CHANNEL_STATUS, buffer);
azazeal88 2:336a025b82b5 528 }
azazeal88 1:cf9b0c21907a 529 }
azazeal88 1:cf9b0c21907a 530 return false;
azazeal88 1:cf9b0c21907a 531 }
azazeal88 1:cf9b0c21907a 532
azazeal88 1:cf9b0c21907a 533 /**
azazeal88 2:336a025b82b5 534 * @brief The network can issue a command to silence the RN2483. This restores the module.
azazeal88 1:cf9b0c21907a 535 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 536 */
azazeal88 2:336a025b82b5 537 bool RN2483::forceEnable()
azazeal88 2:336a025b82b5 538 {
azazeal88 1:cf9b0c21907a 539 return sendCommand(STR_MAC_FORCEENABLE);
azazeal88 1:cf9b0c21907a 540 }
azazeal88 1:cf9b0c21907a 541
azazeal88 1:cf9b0c21907a 542 /**
azazeal88 2:336a025b82b5 543 * @brief Saves configurable parameters to eeprom.
azazeal88 1:cf9b0c21907a 544 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 545 */
azazeal88 2:336a025b82b5 546 bool RN2483::saveConfiguration()
azazeal88 2:336a025b82b5 547 {
azazeal88 3:ee222a99783c 548 // Forced to return true currently.
azazeal88 8:c4069091afa1 549 // Currently broken due to the long length of time it takes save to return.
azazeal88 8:c4069091afa1 550 //_RN2483.printf(STR_CMD_SAVE);
azazeal88 8:c4069091afa1 551 //_RN2483.printf(CRLF);
azazeal88 3:ee222a99783c 552 return true;
azazeal88 1:cf9b0c21907a 553 }
azazeal88 1:cf9b0c21907a 554
azazeal88 1:cf9b0c21907a 555 /**
azazeal88 1:cf9b0c21907a 556 * @brief Sends the command together with the given, paramValue (optional)
azazeal88 1:cf9b0c21907a 557 * @param Command should include a trailing space if paramValue is set. Refer to RN2483 command ref
azazeal88 1:cf9b0c21907a 558 * @param Command Parameter to send
azazeal88 1:cf9b0c21907a 559 * @param Size of param buffer
azazeal88 1:cf9b0c21907a 560 * @return Returns true on success or false if invalid.
azazeal88 1:cf9b0c21907a 561 */
azazeal88 0:a8609e6f88f3 562 bool RN2483::sendCommand(const char* command, const uint8_t* paramValue, uint16_t size)
azazeal88 0:a8609e6f88f3 563 {
azazeal88 0:a8609e6f88f3 564 _RN2483.printf(command);
azazeal88 0:a8609e6f88f3 565
azazeal88 0:a8609e6f88f3 566 for (uint16_t i = 0; i < size; ++i) {
azazeal88 0:a8609e6f88f3 567 _RN2483.putc(static_cast<char>(NIBBLE_TO_HEX_CHAR(HIGH_NIBBLE(paramValue[i]))));
azazeal88 0:a8609e6f88f3 568 _RN2483.putc(static_cast<char>(NIBBLE_TO_HEX_CHAR(LOW_NIBBLE(paramValue[i]))));
azazeal88 0:a8609e6f88f3 569 }
azazeal88 0:a8609e6f88f3 570
azazeal88 0:a8609e6f88f3 571 _RN2483.printf(CRLF);
azazeal88 0:a8609e6f88f3 572
azazeal88 0:a8609e6f88f3 573 return expectOK();
azazeal88 0:a8609e6f88f3 574 }
azazeal88 0:a8609e6f88f3 575
azazeal88 1:cf9b0c21907a 576 /**
azazeal88 1:cf9b0c21907a 577 * @brief Sends the command together with the given, paramValue (optional)
azazeal88 1:cf9b0c21907a 578 * @param Command should include a trailing space if paramValue is set. Refer to RN2483 command ref
azazeal88 1:cf9b0c21907a 579 * @param Command Parameter to send
azazeal88 1:cf9b0c21907a 580 * @return Returns true on success or false if invalid.
azazeal88 1:cf9b0c21907a 581 */
azazeal88 0:a8609e6f88f3 582 bool RN2483::sendCommand(const char* command, uint8_t paramValue)
azazeal88 0:a8609e6f88f3 583 {
azazeal88 0:a8609e6f88f3 584 _RN2483.printf(command);
azazeal88 0:a8609e6f88f3 585 _RN2483.printf("%u",paramValue);
azazeal88 0:a8609e6f88f3 586 _RN2483.printf(CRLF);
azazeal88 0:a8609e6f88f3 587
azazeal88 0:a8609e6f88f3 588 return expectOK();
azazeal88 0:a8609e6f88f3 589 }
azazeal88 0:a8609e6f88f3 590
azazeal88 1:cf9b0c21907a 591 /**
azazeal88 1:cf9b0c21907a 592 * @brief Sends the command together with the given, paramValue (optional)
azazeal88 1:cf9b0c21907a 593 * @param Command should include a trailing space if paramValue is set. Refer to RN2483 command ref
azazeal88 1:cf9b0c21907a 594 * @param Command Parameter to send
azazeal88 1:cf9b0c21907a 595 * @return Returns true on success or false if invalid.
azazeal88 1:cf9b0c21907a 596 */
azazeal88 0:a8609e6f88f3 597 bool RN2483::sendCommand(const char* command, const char* paramValue)
azazeal88 0:a8609e6f88f3 598 {
azazeal88 0:a8609e6f88f3 599 _RN2483.printf(command);
azazeal88 0:a8609e6f88f3 600 if (paramValue != NULL) {
azazeal88 0:a8609e6f88f3 601 _RN2483.printf(paramValue);
azazeal88 0:a8609e6f88f3 602 }
azazeal88 0:a8609e6f88f3 603 _RN2483.printf(CRLF);
azazeal88 0:a8609e6f88f3 604 return expectOK();
azazeal88 0:a8609e6f88f3 605 }
azazeal88 0:a8609e6f88f3 606
azazeal88 1:cf9b0c21907a 607 /**
azazeal88 1:cf9b0c21907a 608 * @brief Sends a join command to the network
azazeal88 1:cf9b0c21907a 609 * @param Type of join, OTAA or ABP
azazeal88 1:cf9b0c21907a 610 * @return Returns true on success or false if fail.
azazeal88 1:cf9b0c21907a 611 */
azazeal88 0:a8609e6f88f3 612 bool RN2483::joinNetwork(const char* type)
azazeal88 0:a8609e6f88f3 613 {
azazeal88 0:a8609e6f88f3 614 _RN2483.printf(STR_CMD_JOIN);
azazeal88 0:a8609e6f88f3 615 _RN2483.printf(type);
azazeal88 0:a8609e6f88f3 616 _RN2483.printf(CRLF);
azazeal88 0:a8609e6f88f3 617
azazeal88 0:a8609e6f88f3 618 return expectOK() && expectString(STR_ACCEPTED, 30000);
azazeal88 0:a8609e6f88f3 619 }
azazeal88 0:a8609e6f88f3 620
azazeal88 1:cf9b0c21907a 621 /**
azazeal88 1:cf9b0c21907a 622 * @brief Sends the command together with the given paramValue (optional)
azazeal88 1:cf9b0c21907a 623 * @param MAC param should include a trailing space if paramValue is set. Refer to RN2483 command ref.
azazeal88 1:cf9b0c21907a 624 * @param Param value to send
azazeal88 1:cf9b0c21907a 625 * @param Size of Param buffer
azazeal88 1:cf9b0c21907a 626 * @return Returns true on success or false if invalid.
azazeal88 1:cf9b0c21907a 627 */
azazeal88 0:a8609e6f88f3 628 bool RN2483::setMacParam(const char* paramName, const uint8_t* paramValue, uint16_t size)
azazeal88 0:a8609e6f88f3 629 {
azazeal88 0:a8609e6f88f3 630 _RN2483.printf(STR_CMD_SET);
azazeal88 0:a8609e6f88f3 631 _RN2483.printf(paramName);
azazeal88 0:a8609e6f88f3 632
azazeal88 0:a8609e6f88f3 633 for (uint16_t i = 0; i < size; ++i) {
azazeal88 0:a8609e6f88f3 634 _RN2483.putc(static_cast<char>(NIBBLE_TO_HEX_CHAR(HIGH_NIBBLE(paramValue[i]))));
azazeal88 0:a8609e6f88f3 635 _RN2483.putc(static_cast<char>(NIBBLE_TO_HEX_CHAR(LOW_NIBBLE(paramValue[i]))));
azazeal88 0:a8609e6f88f3 636 }
azazeal88 0:a8609e6f88f3 637
azazeal88 0:a8609e6f88f3 638 _RN2483.printf(CRLF);
azazeal88 0:a8609e6f88f3 639
azazeal88 0:a8609e6f88f3 640 return expectOK();
azazeal88 0:a8609e6f88f3 641 }
azazeal88 0:a8609e6f88f3 642
azazeal88 1:cf9b0c21907a 643 /**
azazeal88 1:cf9b0c21907a 644 * @brief Sends the command together with the given paramValue (optional)
azazeal88 1:cf9b0c21907a 645 * @param MAC param should include a trailing space if paramValue is set. Refer to RN2483 command ref.
azazeal88 1:cf9b0c21907a 646 * @param Param value to send
azazeal88 1:cf9b0c21907a 647 * @return Returns true on success or false if invalid.
azazeal88 1:cf9b0c21907a 648 */
azazeal88 0:a8609e6f88f3 649 bool RN2483::setMacParam(const char* paramName, uint8_t paramValue)
azazeal88 0:a8609e6f88f3 650 {
azazeal88 0:a8609e6f88f3 651 _RN2483.printf(STR_CMD_SET);
azazeal88 0:a8609e6f88f3 652 _RN2483.printf(paramName);
azazeal88 0:a8609e6f88f3 653 _RN2483.printf("%u",paramValue);
azazeal88 0:a8609e6f88f3 654 _RN2483.printf(CRLF);
azazeal88 0:a8609e6f88f3 655
azazeal88 0:a8609e6f88f3 656 return expectOK();
azazeal88 0:a8609e6f88f3 657 }
azazeal88 0:a8609e6f88f3 658
azazeal88 1:cf9b0c21907a 659 /**
azazeal88 1:cf9b0c21907a 660 * @brief Sends the command together with the given paramValue (optional)
azazeal88 1:cf9b0c21907a 661 * @param MAC param should include a trailing space if paramValue is set. Refer to RN2483 command ref.
azazeal88 1:cf9b0c21907a 662 * @param Param value to send
azazeal88 1:cf9b0c21907a 663 * @return Returns true on success or false if invalid.
azazeal88 1:cf9b0c21907a 664 */
azazeal88 0:a8609e6f88f3 665 bool RN2483::setMacParam(const char* paramName, const char* paramValue)
azazeal88 0:a8609e6f88f3 666 {
azazeal88 0:a8609e6f88f3 667 _RN2483.printf(STR_CMD_SET);
azazeal88 0:a8609e6f88f3 668 _RN2483.printf(paramName);
azazeal88 0:a8609e6f88f3 669 _RN2483.printf(paramValue);
azazeal88 0:a8609e6f88f3 670 _RN2483.printf(CRLF);
azazeal88 0:a8609e6f88f3 671
azazeal88 0:a8609e6f88f3 672 return expectOK();
azazeal88 0:a8609e6f88f3 673 }
azazeal88 0:a8609e6f88f3 674
azazeal88 1:cf9b0c21907a 675 /**
azazeal88 1:cf9b0c21907a 676 * @brief Returns the enum that is mapped to the given "error" message
azazeal88 1:cf9b0c21907a 677 * @param Error to lookup.
azazeal88 1:cf9b0c21907a 678 * @return Returns the enum.
azazeal88 1:cf9b0c21907a 679 */
azazeal88 0:a8609e6f88f3 680 uint8_t RN2483::lookupMacTransmitError(const char* error)
azazeal88 0:a8609e6f88f3 681 {
azazeal88 0:a8609e6f88f3 682 if (error[0] == 0) {
azazeal88 0:a8609e6f88f3 683 return NoResponse;
azazeal88 0:a8609e6f88f3 684 }
azazeal88 0:a8609e6f88f3 685
azazeal88 1:cf9b0c21907a 686 StringEnumPair_t errorTable[] = {
azazeal88 0:a8609e6f88f3 687 { STR_RESULT_INVALID_PARAM, InternalError },
azazeal88 0:a8609e6f88f3 688 { STR_RESULT_NOT_JOINED, NotConnected },
azazeal88 0:a8609e6f88f3 689 { STR_RESULT_NO_FREE_CHANNEL, Busy },
azazeal88 2:336a025b82b5 690 { STR_RESULT_SILENT, Silent },
azazeal88 0:a8609e6f88f3 691 { STR_RESULT_FRAME_COUNTER_ERROR, NetworkFatalError },
azazeal88 0:a8609e6f88f3 692 { STR_RESULT_BUSY, Busy },
azazeal88 0:a8609e6f88f3 693 { STR_RESULT_MAC_PAUSED, InternalError },
azazeal88 0:a8609e6f88f3 694 { STR_RESULT_INVALID_DATA_LEN, PayloadSizeError },
azazeal88 0:a8609e6f88f3 695 { STR_RESULT_MAC_ERROR, NoAcknowledgment },
azazeal88 0:a8609e6f88f3 696 };
azazeal88 0:a8609e6f88f3 697
azazeal88 0:a8609e6f88f3 698 for (StringEnumPair_t * p = errorTable; p->stringValue != NULL; ++p) {
azazeal88 0:a8609e6f88f3 699 if (strcmp(p->stringValue, error) == 0) {
azazeal88 0:a8609e6f88f3 700 return p->enumValue;
azazeal88 0:a8609e6f88f3 701 }
azazeal88 0:a8609e6f88f3 702 }
azazeal88 0:a8609e6f88f3 703
azazeal88 0:a8609e6f88f3 704 return NoResponse;
azazeal88 0:a8609e6f88f3 705 }
azazeal88 0:a8609e6f88f3 706
azazeal88 1:cf9b0c21907a 707 /**
azazeal88 1:cf9b0c21907a 708 * @brief Sends a a payload and blocks until there is a response back,
azazeal88 1:cf9b0c21907a 709 * or the receive windows have closed or the hard timeout has passed.
azazeal88 1:cf9b0c21907a 710 * @param Transmit type
azazeal88 1:cf9b0c21907a 711 * @param Port to use for transmit
azazeal88 1:cf9b0c21907a 712 * @param Payload buffer
azazeal88 1:cf9b0c21907a 713 * @param Size of payload buffer
azazeal88 1:cf9b0c21907a 714 * @return Returns if sucessfull or if a MAC transmit error.
azazeal88 1:cf9b0c21907a 715 */
azazeal88 0:a8609e6f88f3 716 uint8_t RN2483::macTransmit(const char* type, uint8_t port, const uint8_t* payload, uint8_t size)
azazeal88 0:a8609e6f88f3 717 {
azazeal88 0:a8609e6f88f3 718 _RN2483.printf(STR_CMD_MAC_TX);
azazeal88 0:a8609e6f88f3 719 _RN2483.printf(type);
azazeal88 0:a8609e6f88f3 720 _RN2483.printf("%u",port);
azazeal88 0:a8609e6f88f3 721 _RN2483.printf(" ");
azazeal88 0:a8609e6f88f3 722
azazeal88 0:a8609e6f88f3 723 for (int i = 0; i < size; ++i) {
azazeal88 0:a8609e6f88f3 724 _RN2483.putc(static_cast<char>(NIBBLE_TO_HEX_CHAR(HIGH_NIBBLE(payload[i]))));
azazeal88 0:a8609e6f88f3 725 _RN2483.putc(static_cast<char>(NIBBLE_TO_HEX_CHAR(LOW_NIBBLE(payload[i]))));
azazeal88 0:a8609e6f88f3 726 }
azazeal88 0:a8609e6f88f3 727
azazeal88 0:a8609e6f88f3 728 _RN2483.printf(CRLF);
azazeal88 0:a8609e6f88f3 729
azazeal88 0:a8609e6f88f3 730 if (!expectOK()) {
azazeal88 0:a8609e6f88f3 731 return lookupMacTransmitError(this->inputBuffer); // inputBuffer still has the last line read
azazeal88 0:a8609e6f88f3 732 }
azazeal88 0:a8609e6f88f3 733
azazeal88 0:a8609e6f88f3 734 this->packetReceived = false; // prepare for receiving a new packet
azazeal88 0:a8609e6f88f3 735 Timer t;
azazeal88 0:a8609e6f88f3 736 t.start();
azazeal88 1:cf9b0c21907a 737 int timeout = t.read_ms() + RECEIVE_TIMEOUT; // hard timeouts
azazeal88 0:a8609e6f88f3 738 while (t.read_ms() < timeout) {
azazeal88 0:a8609e6f88f3 739 if (readLn() > 0) {
azazeal88 1:cf9b0c21907a 740 if (strstr(this->inputBuffer, " ") != NULL) { // to avoid double delimiter search
azazeal88 0:a8609e6f88f3 741 // there is a splittable line -only case known is mac_rx
azazeal88 0:a8609e6f88f3 742 t.stop();
azazeal88 0:a8609e6f88f3 743 return onMacRX();
azazeal88 1:cf9b0c21907a 744 } else if (strstr(this->inputBuffer, STR_RESULT_MAC_TX_OK)) {
azazeal88 0:a8609e6f88f3 745 // done
azazeal88 0:a8609e6f88f3 746 t.stop();
azazeal88 0:a8609e6f88f3 747 return NoError;
azazeal88 1:cf9b0c21907a 748 } else {
azazeal88 0:a8609e6f88f3 749 // lookup the error message
azazeal88 0:a8609e6f88f3 750 t.stop();
azazeal88 0:a8609e6f88f3 751 return lookupMacTransmitError(this->inputBuffer);
azazeal88 0:a8609e6f88f3 752 }
azazeal88 0:a8609e6f88f3 753 }
azazeal88 0:a8609e6f88f3 754 }
azazeal88 1:cf9b0c21907a 755 t.stop();
azazeal88 0:a8609e6f88f3 756 return Timedout;
azazeal88 0:a8609e6f88f3 757 }
azazeal88 0:a8609e6f88f3 758
azazeal88 1:cf9b0c21907a 759 /**
azazeal88 1:cf9b0c21907a 760 * @brief Parses the input buffer and copies the received payload into
azazeal88 1:cf9b0c21907a 761 * the "received payload" buffer when a "mac rx" message has been received.
azazeal88 1:cf9b0c21907a 762 * @return Returns 0 (NoError) or otherwise one of the MacTransmitErrorCodes.
azazeal88 1:cf9b0c21907a 763 */
azazeal88 0:a8609e6f88f3 764 uint8_t RN2483::onMacRX()
azazeal88 0:a8609e6f88f3 765 {
azazeal88 0:a8609e6f88f3 766 // parse inputbuffer, put payload into packet buffer
azazeal88 0:a8609e6f88f3 767 char* token = strtok(this->inputBuffer, " ");
azazeal88 0:a8609e6f88f3 768
azazeal88 0:a8609e6f88f3 769 // sanity check
azazeal88 0:a8609e6f88f3 770 if (strcmp(token, STR_RESULT_MAC_RX) != 0) {
azazeal88 0:a8609e6f88f3 771 return InternalError;
azazeal88 0:a8609e6f88f3 772 }
azazeal88 0:a8609e6f88f3 773
azazeal88 0:a8609e6f88f3 774 // port
azazeal88 0:a8609e6f88f3 775 token = strtok(NULL, " ");
azazeal88 0:a8609e6f88f3 776
azazeal88 0:a8609e6f88f3 777 // payload
azazeal88 0:a8609e6f88f3 778 token = strtok(NULL, " "); // until end of string
azazeal88 0:a8609e6f88f3 779
azazeal88 0:a8609e6f88f3 780 uint16_t len = strlen(token) + 1; // include termination char
azazeal88 0:a8609e6f88f3 781 memcpy(this->receivedPayloadBuffer, token, len <= this->receivedPayloadBufferSize ? len : this->receivedPayloadBufferSize);
azazeal88 0:a8609e6f88f3 782
azazeal88 0:a8609e6f88f3 783 this->packetReceived = true; // enable receive() again
azazeal88 0:a8609e6f88f3 784 return NoError;
azazeal88 0:a8609e6f88f3 785 }
azazeal88 0:a8609e6f88f3 786
azazeal88 1:cf9b0c21907a 787 /**
azazeal88 1:cf9b0c21907a 788 * @brief Private method to read serial port with timeout
azazeal88 1:cf9b0c21907a 789 * @param The time to wait for in milliseconds.
azazeal88 1:cf9b0c21907a 790 * @return Returns character or -1 on timeout
azazeal88 1:cf9b0c21907a 791 */
azazeal88 1:cf9b0c21907a 792 int RN2483::timedRead(int _timeout)
azazeal88 1:cf9b0c21907a 793 {
azazeal88 0:a8609e6f88f3 794 int c;
azazeal88 0:a8609e6f88f3 795 Timer t;
azazeal88 0:a8609e6f88f3 796 t.start();
azazeal88 8:c4069091afa1 797 long _startMillis = t.read_ms(); // get milliseconds
azazeal88 3:ee222a99783c 798 do {
azazeal88 3:ee222a99783c 799 if(_RN2483.readable()){
azazeal88 3:ee222a99783c 800 c = _RN2483.getc();
azazeal88 3:ee222a99783c 801 if (c >= 0){
azazeal88 3:ee222a99783c 802 t.stop();
azazeal88 3:ee222a99783c 803 return c;
azazeal88 3:ee222a99783c 804 }
azazeal88 3:ee222a99783c 805 }
azazeal88 3:ee222a99783c 806 } while(t.read_ms() - _startMillis <_timeout);
azazeal88 0:a8609e6f88f3 807 t.stop();
azazeal88 0:a8609e6f88f3 808 return -1; // -1 indicates timeout
azazeal88 1:cf9b0c21907a 809 }
azazeal88 0:a8609e6f88f3 810
azazeal88 1:cf9b0c21907a 811 /**
azazeal88 1:cf9b0c21907a 812 * @brief Read characters into buffer.
azazeal88 1:cf9b0c21907a 813 * Terminates if length characters have been read, timeout, or
azazeal88 1:cf9b0c21907a 814 * if the terminator character has been detected
azazeal88 1:cf9b0c21907a 815 * @param The terminator character to look for
azazeal88 1:cf9b0c21907a 816 * @param The buffer to read into.
azazeal88 4:0c066401ae12 817 * @param The number of bytes to read.
azazeal88 1:cf9b0c21907a 818 * @return The number of bytes read. 0 means no valid data found.
azazeal88 1:cf9b0c21907a 819 */
azazeal88 4:0c066401ae12 820 size_t RN2483::readBytesUntil(char terminator, char *buffer, size_t bytesToRead)
azazeal88 0:a8609e6f88f3 821 {
azazeal88 4:0c066401ae12 822 if (bytesToRead < 1) return 0;
azazeal88 0:a8609e6f88f3 823 size_t index = 0;
azazeal88 4:0c066401ae12 824 while (index < (bytesToRead - 1 )) {
azazeal88 0:a8609e6f88f3 825 int c = timedRead(1000);
azazeal88 0:a8609e6f88f3 826 if (c < 0 || c == terminator) break;
azazeal88 0:a8609e6f88f3 827 *buffer++ = (char)c;
azazeal88 0:a8609e6f88f3 828 index++;
azazeal88 0:a8609e6f88f3 829 }
azazeal88 1:cf9b0c21907a 830 return index; // return number of characters, not including null terminator
azazeal88 1:cf9b0c21907a 831 }
azazeal88 0:a8609e6f88f3 832
azazeal88 0:a8609e6f88f3 833 #ifdef DEBUG
azazeal88 0:a8609e6f88f3 834 int freeRam()
azazeal88 0:a8609e6f88f3 835 {
azazeal88 0:a8609e6f88f3 836 extern int __heap_start;
azazeal88 0:a8609e6f88f3 837 extern int *__brkval;
azazeal88 0:a8609e6f88f3 838 int v;
azazeal88 0:a8609e6f88f3 839 return (int)&v - (__brkval == 0 ? (int)&__heap_start : (int)__brkval);
azazeal88 0:a8609e6f88f3 840 }
azazeal88 0:a8609e6f88f3 841 #endif