Daniel Knox / RN2483

A mbed library for the RN2483. Heavily based on the Sodaq_RN2483 library for Arduino (https://github.com/SodaqMoja/Sodaq_RN2483). This is currently under-going initial testing, but seems to work! Tested on a NRF51 and FRDM K64F.

Dependents:   rn2483-TestProgram

RN2483.cpp@2:336a025b82b5, 2016-11-20 (annotated)

Committer:
azazeal88
Date:
Sun Nov 20 14:37:54 2016 +0000
Revision:
2:336a025b82b5
Parent:
1:cf9b0c21907a
Child:
3:ee222a99783c
Implemented functions like getVDD, a few public methods for joining networks without editing settings again, editing settings now saves configuration.

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