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.h@1:cf9b0c21907a, 2016-11-19 (annotated)

Committer:
azazeal88
Date:
Sat Nov 19 23:30:34 2016 +0000
Revision:
1:cf9b0c21907a
Parent:
0:a8609e6f88f3
Child:
2:336a025b82b5
Improved comments; added additional command functionality.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
azazeal88 0:a8609e6f88f3 1 /*
azazeal88 0:a8609e6f88f3 2 * Copyright (c) 2016 Dan Knox. All rights reserved.
azazeal88 0:a8609e6f88f3 3 *
azazeal88 0:a8609e6f88f3 4 * This file is part of RN2483.
azazeal88 0:a8609e6f88f3 5 *
azazeal88 0:a8609e6f88f3 6 * RN2483 is free software: you can redistribute it and/or modify
azazeal88 0:a8609e6f88f3 7 * it under the terms of the GNU Lesser General Public License as
azazeal88 0:a8609e6f88f3 8 * published by the Free Software Foundation, either version 3 of
azazeal88 0:a8609e6f88f3 9 * the License, or(at your option) any later version.
azazeal88 0:a8609e6f88f3 10 *
azazeal88 0:a8609e6f88f3 11 * RN2483 is distributed in the hope that it will be useful,
azazeal88 0:a8609e6f88f3 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
azazeal88 0:a8609e6f88f3 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
azazeal88 0:a8609e6f88f3 14 * GNU Lesser General Public License for more details.
azazeal88 0:a8609e6f88f3 15 *
azazeal88 0:a8609e6f88f3 16 * You should have received a copy of the GNU Lesser General Public
azazeal88 0:a8609e6f88f3 17 * License along with RN2483. If not, see
azazeal88 0:a8609e6f88f3 18 * <http://www.gnu.org/licenses/>.
azazeal88 0:a8609e6f88f3 19 */
azazeal88 0:a8609e6f88f3 20
azazeal88 0:a8609e6f88f3 21 #ifndef _RN2483_h
azazeal88 0:a8609e6f88f3 22 #define _RN2483_h
azazeal88 0:a8609e6f88f3 23
azazeal88 0:a8609e6f88f3 24 #include "mbed.h"
azazeal88 0:a8609e6f88f3 25 #include <stdint.h>
azazeal88 0:a8609e6f88f3 26
azazeal88 1:cf9b0c21907a 27 //#define USE_DYNAMIC_BUFFER
azazeal88 0:a8609e6f88f3 28
azazeal88 0:a8609e6f88f3 29 #define DEFAULT_INPUT_BUFFER_SIZE 64
azazeal88 0:a8609e6f88f3 30 #define DEFAULT_RECEIVED_PAYLOAD_BUFFER_SIZE 32
azazeal88 0:a8609e6f88f3 31 #define DEFAULT_TIMEOUT 120
azazeal88 0:a8609e6f88f3 32 #define RECEIVE_TIMEOUT 60000
azazeal88 0:a8609e6f88f3 33 #define DEFAULT_FSB 2
azazeal88 0:a8609e6f88f3 34 #define DEFAULT_PWR_IDX_868 1
azazeal88 0:a8609e6f88f3 35 #define DEFAULT_PWR_IDX_915 5
azazeal88 0:a8609e6f88f3 36 #define DEFAULT_SF_868 7
azazeal88 0:a8609e6f88f3 37 #define DEFAULT_SF_915 7
azazeal88 0:a8609e6f88f3 38
azazeal88 0:a8609e6f88f3 39 #define ENABLE_SLEEP
azazeal88 0:a8609e6f88f3 40
azazeal88 0:a8609e6f88f3 41 // Available error codes.
azazeal88 1:cf9b0c21907a 42 enum MacTransmitErrorCodes {
azazeal88 0:a8609e6f88f3 43 NoError = 0,
azazeal88 0:a8609e6f88f3 44 NoResponse = 1,
azazeal88 0:a8609e6f88f3 45 Timedout = 2,
azazeal88 0:a8609e6f88f3 46 PayloadSizeError = 3,
azazeal88 0:a8609e6f88f3 47 InternalError = 4,
azazeal88 0:a8609e6f88f3 48 Busy = 5,
azazeal88 0:a8609e6f88f3 49 NetworkFatalError = 6,
azazeal88 0:a8609e6f88f3 50 NotConnected = 7,
azazeal88 0:a8609e6f88f3 51 NoAcknowledgment = 8,
azazeal88 0:a8609e6f88f3 52 };
azazeal88 0:a8609e6f88f3 53
azazeal88 0:a8609e6f88f3 54 // Provides a simple, abstracted interface to Microchip's RN2483 LoRaWAN module.
azazeal88 0:a8609e6f88f3 55
azazeal88 0:a8609e6f88f3 56 class RN2483
azazeal88 0:a8609e6f88f3 57 {
azazeal88 0:a8609e6f88f3 58 public:
azazeal88 1:cf9b0c21907a 59
azazeal88 1:cf9b0c21907a 60 /**
azazeal88 1:cf9b0c21907a 61 * @brief Create a new instance of the RN2483.
azazeal88 1:cf9b0c21907a 62 * @param Serial TX pin name.
azazeal88 1:cf9b0c21907a 63 * @param Serial RX pin name.
azazeal88 1:cf9b0c21907a 64 */
azazeal88 0:a8609e6f88f3 65 RN2483(PinName tx, PinName rx);
azazeal88 1:cf9b0c21907a 66
azazeal88 1:cf9b0c21907a 67 /**
azazeal88 1:cf9b0c21907a 68 * @return Returns the default device baud rate.
azazeal88 1:cf9b0c21907a 69 */
azazeal88 1:cf9b0c21907a 70 uint32_t getDefaultBaudRate() {
azazeal88 1:cf9b0c21907a 71 return 57600;
azazeal88 1:cf9b0c21907a 72 };
azazeal88 1:cf9b0c21907a 73
azazeal88 1:cf9b0c21907a 74 /**
azazeal88 1:cf9b0c21907a 75 * @brief Connect to network using Over The Air activation.
azazeal88 1:cf9b0c21907a 76 * @param devEUI provided by LoRaWAN Network server registration.
azazeal88 1:cf9b0c21907a 77 * @param appEUI provided by LoRaWAN Network server registration.
azazeal88 1:cf9b0c21907a 78 * @param appKey provided by LoRaWAN Network server registration.
azazeal88 1:cf9b0c21907a 79 * @return Network confirmation if sucessfully connected.
azazeal88 1:cf9b0c21907a 80 */
azazeal88 0:a8609e6f88f3 81 bool initOTA(const uint8_t devEUI[8], const uint8_t appEUI[8], const uint8_t appKey[16], bool adr = true);
azazeal88 0:a8609e6f88f3 82
azazeal88 1:cf9b0c21907a 83 /**
azazeal88 1:cf9b0c21907a 84 * @brief Initializes the device and connects to the network using Activation By Personalization.
azazeal88 1:cf9b0c21907a 85 * @param devADDR provided by LoRaWAN Network server registration.
azazeal88 1:cf9b0c21907a 86 * @param appSKey provided by LoRaWAN Network server registration.
azazeal88 1:cf9b0c21907a 87 * @param nwkSKey provided by LoRaWAN Network server registration.
azazeal88 1:cf9b0c21907a 88 * @return Returns true if the parameters was valid.
azazeal88 1:cf9b0c21907a 89 */
azazeal88 0:a8609e6f88f3 90 bool initABP(const uint8_t devAddr[4], const uint8_t appSKey[16], const uint8_t nwkSKey[16], bool adr = true);
azazeal88 0:a8609e6f88f3 91
azazeal88 1:cf9b0c21907a 92 /**
azazeal88 1:cf9b0c21907a 93 * @brief Sends the given payload without acknowledgement.
azazeal88 1:cf9b0c21907a 94 * @param Port to use for transmission.
azazeal88 1:cf9b0c21907a 95 * @param Payload buffer
azazeal88 1:cf9b0c21907a 96 * @param Payload buffer size
azazeal88 1:cf9b0c21907a 97 * @return Returns 0 (NoError) when data was sucessfully fowarded to radio, otherwise returns MacTransmitErrorCode.
azazeal88 1:cf9b0c21907a 98 */
azazeal88 0:a8609e6f88f3 99 uint8_t send(uint8_t port, const uint8_t* payload, uint8_t size);
azazeal88 0:a8609e6f88f3 100
azazeal88 1:cf9b0c21907a 101 /**
azazeal88 1:cf9b0c21907a 102 * @brief Sends the given payload with acknowledgement.
azazeal88 1:cf9b0c21907a 103 * @param Port to use for transmission.
azazeal88 1:cf9b0c21907a 104 * @param Payload buffer
azazeal88 1:cf9b0c21907a 105 * @param Payload buffer size
azazeal88 1:cf9b0c21907a 106 * @param Number of transmission retries in event of network transmission failure.
azazeal88 1:cf9b0c21907a 107 * @return Returns 0 (NoError) when network acks transmission, otherwise returns MacTransmitErrorCode.
azazeal88 1:cf9b0c21907a 108 */
azazeal88 0:a8609e6f88f3 109 uint8_t sendReqAck(uint8_t port, const uint8_t* payload, uint8_t size, uint8_t maxRetries);
azazeal88 0:a8609e6f88f3 110
azazeal88 1:cf9b0c21907a 111 /**
azazeal88 1:cf9b0c21907a 112 * @brief Copies the latest received packet (optionally starting from the "payloadStartPosition" of the payload).
azazeal88 1:cf9b0c21907a 113 * @param Buffer to read into.
azazeal88 1:cf9b0c21907a 114 * @param Buffer size.
azazeal88 1:cf9b0c21907a 115 * @return Returns the number of bytes written or 0 if no packet is received since last transmission.
azazeal88 1:cf9b0c21907a 116 */
azazeal88 0:a8609e6f88f3 117 uint16_t receive(uint8_t* buffer, uint16_t size, uint16_t payloadStartPosition = 0);
azazeal88 0:a8609e6f88f3 118
azazeal88 1:cf9b0c21907a 119 /**
azazeal88 1:cf9b0c21907a 120 * @brief Gets the preprogrammed EUI node address from the module.
azazeal88 1:cf9b0c21907a 121 * @param Buffer to read into.
azazeal88 1:cf9b0c21907a 122 * @param Buffer size.
azazeal88 1:cf9b0c21907a 123 * @return Returns the number of bytes written or 0 in case of error..
azazeal88 1:cf9b0c21907a 124 */
azazeal88 0:a8609e6f88f3 125 uint8_t getHWEUI(uint8_t* buffer, uint8_t size);
azazeal88 0:a8609e6f88f3 126
azazeal88 1:cf9b0c21907a 127 /**
azazeal88 1:cf9b0c21907a 128 * @brief Enables all the channels that belong to the given Frequency Sub-Band (FSB)
azazeal88 1:cf9b0c21907a 129 * disables the rest.
azazeal88 1:cf9b0c21907a 130 * @param FSB is [1, 8] or 0 to enable all channels.
azazeal88 1:cf9b0c21907a 131 * @return Returns true if all channels were set successfully.
azazeal88 1:cf9b0c21907a 132 */
azazeal88 0:a8609e6f88f3 133 bool setFsbChannels(uint8_t fsb);
azazeal88 0:a8609e6f88f3 134
azazeal88 1:cf9b0c21907a 135 /**
azazeal88 1:cf9b0c21907a 136 * @brief Sets the spreading factor.
azazeal88 1:cf9b0c21907a 137 * @param Spreading factor parameter.
azazeal88 1:cf9b0c21907a 138 * @return Returns true if was set successfully.
azazeal88 1:cf9b0c21907a 139 */
azazeal88 0:a8609e6f88f3 140 bool setSpreadingFactor(uint8_t spreadingFactor);
azazeal88 0:a8609e6f88f3 141
azazeal88 1:cf9b0c21907a 142 /**
azazeal88 1:cf9b0c21907a 143 * @brief Sets the power index
azazeal88 1:cf9b0c21907a 144 * @param 868MHz: 1 to 5 / 915MHz: 5, 7, 8, 9 or 10.
azazeal88 1:cf9b0c21907a 145 * @return Returns true if succesful.
azazeal88 1:cf9b0c21907a 146 */
azazeal88 0:a8609e6f88f3 147 bool setPowerIndex(uint8_t powerIndex);
azazeal88 0:a8609e6f88f3 148
azazeal88 1:cf9b0c21907a 149 /**
azazeal88 1:cf9b0c21907a 150 * @brief Sets the time interval for the link check process. When the time expires, the next application
azazeal88 1:cf9b0c21907a 151 * packet will include a link check command to the server.
azazeal88 1:cf9b0c21907a 152 * @param Decimal number that sets the time interval in seconds, from 0 to 65535. 0 disables link check process.
azazeal88 1:cf9b0c21907a 153 * @return Returns true if parameter is valid or false if time interval is not valid.
azazeal88 1:cf9b0c21907a 154 */
azazeal88 1:cf9b0c21907a 155 bool setLinkCheckInterval(uint8_t linkCheckInterval);
azazeal88 1:cf9b0c21907a 156
azazeal88 1:cf9b0c21907a 157 /**
azazeal88 1:cf9b0c21907a 158 * @brief Sets the battery level required for the Device Status Answer frame in LoRaWAN Class A Protocol.
azazeal88 1:cf9b0c21907a 159 * @param temperature Decimal number between 0-255 representing battery level. 0 means external power, 1 means
azazeal88 1:cf9b0c21907a 160 * low level, 254 means high level, 255 means the device was unable to measure battery level.
azazeal88 1:cf9b0c21907a 161 * @return Returns true if battery level is valid or false if value not valid.
azazeal88 1:cf9b0c21907a 162 */
azazeal88 1:cf9b0c21907a 163 bool setBattery(uint8_t batLvl);
azazeal88 1:cf9b0c21907a 164
azazeal88 1:cf9b0c21907a 165 /**
azazeal88 1:cf9b0c21907a 166 * @brief Sets the module operation frequency on a given channel ID.
azazeal88 1:cf9b0c21907a 167 * @param Channel ID from 3 - 15.
azazeal88 1:cf9b0c21907a 168 * @param Decimal number representing the frequency.
azazeal88 1:cf9b0c21907a 169 * 863000000 to 870000000 or 433050000 to 434790000 in Hz
azazeal88 1:cf9b0c21907a 170 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 171 */
azazeal88 1:cf9b0c21907a 172 bool setChannelFreq(uint8_t channelID, uint32_t frequency);
azazeal88 1:cf9b0c21907a 173
azazeal88 1:cf9b0c21907a 174 /**
azazeal88 1:cf9b0c21907a 175 * @brief Sets the duty cycle allowed on the given channel ID.
azazeal88 1:cf9b0c21907a 176 * @param Channel ID to set duty cycle (0-15),
azazeal88 1:cf9b0c21907a 177 * @param Duty cycle is 0 - 100% as a float.
azazeal88 1:cf9b0c21907a 178 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 179 */
azazeal88 1:cf9b0c21907a 180 bool setDutyCycle(uint8_t channelID, float dutyCycle);
azazeal88 1:cf9b0c21907a 181
azazeal88 1:cf9b0c21907a 182 /**
azazeal88 1:cf9b0c21907a 183 * @brief Sets the data rate for a given channel ID.
azazeal88 1:cf9b0c21907a 184 * Please refer to the LoRaWAN spec for the actual values.
azazeal88 1:cf9b0c21907a 185 * @param Channel ID from 0 - 15.
azazeal88 1:cf9b0c21907a 186 * @param Number representing the minimum data rate range from 0 to 7.
azazeal88 1:cf9b0c21907a 187 * @param Number representing the maximum data rate range from 0 to 7
azazeal88 1:cf9b0c21907a 188 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 189 */
azazeal88 1:cf9b0c21907a 190 bool setDrRange(uint8_t channelID, uint8_t minRange, uint8_t maxRange);
azazeal88 1:cf9b0c21907a 191
azazeal88 1:cf9b0c21907a 192 /**
azazeal88 1:cf9b0c21907a 193 * @brief Sets a given channel ID to be enabled or disabled.
azazeal88 1:cf9b0c21907a 194 * @param Channel ID from 0 - 15.
azazeal88 1:cf9b0c21907a 195 * @param Flag representing if channel is enabled or disabled.
azazeal88 1:cf9b0c21907a 196 * Warning: duty cycle, frequency and data range must be set for a channel
azazeal88 1:cf9b0c21907a 197 * before enabling!
azazeal88 1:cf9b0c21907a 198 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 199 */
azazeal88 1:cf9b0c21907a 200 bool setStatus(uint8_t channelID, bool status);
azazeal88 1:cf9b0c21907a 201
azazeal88 1:cf9b0c21907a 202 /**
azazeal88 1:cf9b0c21907a 203 * @brief The network can issue a command to silence the RN2483. This restores the module.
azazeal88 1:cf9b0c21907a 204 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 205 */
azazeal88 1:cf9b0c21907a 206 bool forceEnable();
azazeal88 1:cf9b0c21907a 207
azazeal88 1:cf9b0c21907a 208 /**
azazeal88 1:cf9b0c21907a 209 * @brief Saves configurable parameters to eeprom.
azazeal88 1:cf9b0c21907a 210 * @return Returns true if parameters are valid or false if not.
azazeal88 1:cf9b0c21907a 211 */
azazeal88 1:cf9b0c21907a 212 bool saveConfiguration();
azazeal88 1:cf9b0c21907a 213
azazeal88 1:cf9b0c21907a 214 /**
azazeal88 1:cf9b0c21907a 215 * @brief Sends the command together with the given, paramValue (optional)
azazeal88 1:cf9b0c21907a 216 * @param Command should include a trailing space if paramValue is set. Refer to RN2483 command ref
azazeal88 1:cf9b0c21907a 217 * @param Command Parameter to send
azazeal88 1:cf9b0c21907a 218 * @param Size of param buffer
azazeal88 1:cf9b0c21907a 219 * @return Returns true on success or false if invalid.
azazeal88 1:cf9b0c21907a 220 */
azazeal88 0:a8609e6f88f3 221 bool sendCommand(const char* command, const uint8_t* paramValue, uint16_t size);
azazeal88 0:a8609e6f88f3 222 bool sendCommand(const char* command, uint8_t paramValue);
azazeal88 0:a8609e6f88f3 223 bool sendCommand(const char* command, const char* paramValue = NULL);
azazeal88 0:a8609e6f88f3 224
azazeal88 1:cf9b0c21907a 225 /**
azazeal88 1:cf9b0c21907a 226 * @brief Sends the command together with the given paramValue (optional)
azazeal88 1:cf9b0c21907a 227 * @param MAC param should include a trailing space if paramValue is set. Refer to RN2483 command ref.
azazeal88 1:cf9b0c21907a 228 * @param Param value to send
azazeal88 1:cf9b0c21907a 229 * @param Size of Param buffer
azazeal88 1:cf9b0c21907a 230 * @return Returns true on success or false if invalid.
azazeal88 1:cf9b0c21907a 231 */
azazeal88 0:a8609e6f88f3 232 bool setMacParam(const char* paramName, const uint8_t* paramValue, uint16_t size);
azazeal88 0:a8609e6f88f3 233 bool setMacParam(const char* paramName, uint8_t paramValue);
azazeal88 0:a8609e6f88f3 234 bool setMacParam(const char* paramName, const char* paramValue);
azazeal88 0:a8609e6f88f3 235
azazeal88 0:a8609e6f88f3 236 #ifdef ENABLE_SLEEP
azazeal88 1:cf9b0c21907a 237 /**
azazeal88 1:cf9b0c21907a 238 * @brief Sends a serial line break to wake up the RN2483
azazeal88 1:cf9b0c21907a 239 */
azazeal88 0:a8609e6f88f3 240 void wakeUp();
azazeal88 0:a8609e6f88f3 241
azazeal88 1:cf9b0c21907a 242 /**
azazeal88 1:cf9b0c21907a 243 * @brief Sends the RN2483 to sleep for a finite length of time.
azazeal88 1:cf9b0c21907a 244 * @param Milliseconds to sleep for, range is 100 to 4294967295
azazeal88 1:cf9b0c21907a 245 */
azazeal88 1:cf9b0c21907a 246 void sleep(uint32_t);
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 sleep();
azazeal88 1:cf9b0c21907a 253
azazeal88 0:a8609e6f88f3 254 #endif
azazeal88 0:a8609e6f88f3 255
azazeal88 0:a8609e6f88f3 256 #ifdef USE_DYNAMIC_BUFFER
azazeal88 0:a8609e6f88f3 257 // Sets the size of the input buffer.
azazeal88 0:a8609e6f88f3 258 // Needs to be called before initOTA()/initABP().
azazeal88 1:cf9b0c21907a 259 void setInputBufferSize(uint16_t value) {
azazeal88 1:cf9b0c21907a 260 this->inputBufferSize = value;
azazeal88 1:cf9b0c21907a 261 };
azazeal88 0:a8609e6f88f3 262
azazeal88 0:a8609e6f88f3 263 // Sets the size of the "Received Payload" buffer.
azazeal88 0:a8609e6f88f3 264 // Needs to be called before initOTA()/initABP().
azazeal88 1:cf9b0c21907a 265 void setReceivedPayloadBufferSize(uint16_t value) {
azazeal88 1:cf9b0c21907a 266 this->receivedPayloadBufferSize = value;
azazeal88 1:cf9b0c21907a 267 };
azazeal88 0:a8609e6f88f3 268 #endif
azazeal88 0:a8609e6f88f3 269
azazeal88 0:a8609e6f88f3 270 private:
azazeal88 0:a8609e6f88f3 271
azazeal88 0:a8609e6f88f3 272 Serial _RN2483;
azazeal88 1:cf9b0c21907a 273
azazeal88 0:a8609e6f88f3 274 // The size of the input buffer. Equals DEFAULT_INPUT_BUFFER_SIZE
azazeal88 0:a8609e6f88f3 275 // by default or (optionally) a user-defined value when using USE_DYNAMIC_BUFFER.
azazeal88 0:a8609e6f88f3 276 uint16_t inputBufferSize;
azazeal88 0:a8609e6f88f3 277
azazeal88 0:a8609e6f88f3 278 // The size of the received payload buffer. Equals DEFAULT_RECEIVED_PAYLOAD_BUFFER_SIZE
azazeal88 0:a8609e6f88f3 279 // by default or (optionally) a user-defined value when using USE_DYNAMIC_BUFFER.
azazeal88 0:a8609e6f88f3 280 uint16_t receivedPayloadBufferSize;
azazeal88 0:a8609e6f88f3 281
azazeal88 0:a8609e6f88f3 282 // Flag used to make sure the received payload buffer is
azazeal88 0:a8609e6f88f3 283 // current with the latest transmission.
azazeal88 0:a8609e6f88f3 284 bool packetReceived;
azazeal88 0:a8609e6f88f3 285
azazeal88 1:cf9b0c21907a 286 // Used to distinguise between RN2483 and RN2903.
azazeal88 0:a8609e6f88f3 287 // Currently only being set during reset().
azazeal88 0:a8609e6f88f3 288 bool isRN2903;
azazeal88 0:a8609e6f88f3 289
azazeal88 0:a8609e6f88f3 290 #ifdef USE_DYNAMIC_BUFFER
azazeal88 0:a8609e6f88f3 291 // Flag to make sure the buffers are not allocated more than once.
azazeal88 0:a8609e6f88f3 292 bool isBufferInitialized;
azazeal88 0:a8609e6f88f3 293
azazeal88 0:a8609e6f88f3 294 char* inputBuffer;
azazeal88 0:a8609e6f88f3 295 char* receivedPayloadBuffer;
azazeal88 0:a8609e6f88f3 296 #else
azazeal88 0:a8609e6f88f3 297 char inputBuffer[DEFAULT_INPUT_BUFFER_SIZE];
azazeal88 0:a8609e6f88f3 298 char receivedPayloadBuffer[DEFAULT_RECEIVED_PAYLOAD_BUFFER_SIZE];
azazeal88 0:a8609e6f88f3 299 #endif
azazeal88 0:a8609e6f88f3 300
azazeal88 1:cf9b0c21907a 301 /**
azazeal88 1:cf9b0c21907a 302 * @brief Takes care of the init tasks common to both initOTA() and initABP.
azazeal88 1:cf9b0c21907a 303 */
azazeal88 0:a8609e6f88f3 304 inline void init();
azazeal88 0:a8609e6f88f3 305
azazeal88 1:cf9b0c21907a 306 /**
azazeal88 1:cf9b0c21907a 307 * @brief Reads a line from the device serial stream.
azazeal88 1:cf9b0c21907a 308 * @param Buffer to read into.
azazeal88 1:cf9b0c21907a 309 * @param Size of buffer.
azazeal88 1:cf9b0c21907a 310 * @param Position to start from.
azazeal88 1:cf9b0c21907a 311 * @return Number of bytes read.
azazeal88 1:cf9b0c21907a 312 */
azazeal88 0:a8609e6f88f3 313 uint16_t readLn(char* buffer, uint16_t size, uint16_t start = 0);
azazeal88 0:a8609e6f88f3 314
azazeal88 1:cf9b0c21907a 315 /**
azazeal88 1:cf9b0c21907a 316 * @brief Reads a line from the input buffer
azazeal88 1:cf9b0c21907a 317 * @return Number of bytes read.
azazeal88 1:cf9b0c21907a 318 */
azazeal88 1:cf9b0c21907a 319 uint16_t readLn() {
azazeal88 1:cf9b0c21907a 320 return readLn(this->inputBuffer, this->inputBufferSize);
azazeal88 1:cf9b0c21907a 321 };
azazeal88 0:a8609e6f88f3 322
azazeal88 1:cf9b0c21907a 323 /**
azazeal88 1:cf9b0c21907a 324 * @brief Waits for the given string.
azazeal88 1:cf9b0c21907a 325 * @param String to look for.
azazeal88 1:cf9b0c21907a 326 * @param Timeout Period
azazeal88 1:cf9b0c21907a 327 * @param Position to start from.
azazeal88 1:cf9b0c21907a 328 * @return Returns true if the string is received before a timeout.
azazeal88 1:cf9b0c21907a 329 * Returns false if a timeout occurs or if another string is received.
azazeal88 1:cf9b0c21907a 330 */
azazeal88 0:a8609e6f88f3 331 bool expectString(const char* str, uint16_t timeout = DEFAULT_TIMEOUT);
azazeal88 1:cf9b0c21907a 332
azazeal88 1:cf9b0c21907a 333 /**
azazeal88 1:cf9b0c21907a 334 * @brief Looks for an 'OK' response from the RN2483
azazeal88 1:cf9b0c21907a 335 * @return Returns true if the string is received before a timeout.
azazeal88 1:cf9b0c21907a 336 * Returns false if a timeout occurs or if another string is received.
azazeal88 1:cf9b0c21907a 337 */
azazeal88 0:a8609e6f88f3 338 bool expectOK();
azazeal88 0:a8609e6f88f3 339
azazeal88 1:cf9b0c21907a 340 /**
azazeal88 1:cf9b0c21907a 341 * @brief Sends a reset command to the module
azazeal88 1:cf9b0c21907a 342 * Also sets-up some initial parameters like power index, SF and FSB channels.
azazeal88 1:cf9b0c21907a 343 * @return Waits for sucess reponse or timeout.
azazeal88 1:cf9b0c21907a 344 */
azazeal88 0:a8609e6f88f3 345 bool resetDevice();
azazeal88 0:a8609e6f88f3 346
azazeal88 1:cf9b0c21907a 347 /**
azazeal88 1:cf9b0c21907a 348 * @brief Sends a join command to the network
azazeal88 1:cf9b0c21907a 349 * @param Type of join, OTAA or ABP
azazeal88 1:cf9b0c21907a 350 * @return Returns true on success or false if fail.
azazeal88 1:cf9b0c21907a 351 */
azazeal88 0:a8609e6f88f3 352 bool joinNetwork(const char* type);
azazeal88 0:a8609e6f88f3 353
azazeal88 1:cf9b0c21907a 354 /**
azazeal88 1:cf9b0c21907a 355 * @brief Returns the enum that is mapped to the given "error" message
azazeal88 1:cf9b0c21907a 356 * @param Error to lookup.
azazeal88 1:cf9b0c21907a 357 * @return Returns the enum
azazeal88 1:cf9b0c21907a 358 */
azazeal88 0:a8609e6f88f3 359 uint8_t lookupMacTransmitError(const char* error);
azazeal88 0:a8609e6f88f3 360
azazeal88 1:cf9b0c21907a 361 /**
azazeal88 1:cf9b0c21907a 362 * @brief Sends a a payload and blocks until there is a response back,
azazeal88 1:cf9b0c21907a 363 * or the receive windows have closed or the hard timeout has passed.
azazeal88 1:cf9b0c21907a 364 * @param Transmit type
azazeal88 1:cf9b0c21907a 365 * @param Port to use for transmit
azazeal88 1:cf9b0c21907a 366 * @param Payload buffer
azazeal88 1:cf9b0c21907a 367 * @param Size of payload buffer
azazeal88 1:cf9b0c21907a 368 * @return Returns if sucessfull or if a MAC transmit error.
azazeal88 1:cf9b0c21907a 369 */
azazeal88 0:a8609e6f88f3 370 uint8_t macTransmit(const char* type, uint8_t port, const uint8_t* payload, uint8_t size);
azazeal88 0:a8609e6f88f3 371
azazeal88 1:cf9b0c21907a 372 /**
azazeal88 1:cf9b0c21907a 373 * @brief Parses the input buffer and copies the received payload into
azazeal88 1:cf9b0c21907a 374 * the "received payload" buffer when a "mac rx" message has been received.
azazeal88 1:cf9b0c21907a 375 * @return Returns 0 (NoError) or otherwise one of the MacTransmitErrorCodes.
azazeal88 1:cf9b0c21907a 376 */
azazeal88 0:a8609e6f88f3 377 uint8_t onMacRX();
azazeal88 1:cf9b0c21907a 378
azazeal88 1:cf9b0c21907a 379 /**
azazeal88 1:cf9b0c21907a 380 * @brief Private method to read serial port with timeout
azazeal88 1:cf9b0c21907a 381 * @param The time to wait for in milliseconds.
azazeal88 1:cf9b0c21907a 382 * @return Returns character or -1 on timeout
azazeal88 1:cf9b0c21907a 383 */
azazeal88 1:cf9b0c21907a 384 int timedRead(int _timeout);
azazeal88 1:cf9b0c21907a 385
azazeal88 1:cf9b0c21907a 386 /**
azazeal88 1:cf9b0c21907a 387 * @brief Read characters into buffer.
azazeal88 1:cf9b0c21907a 388 * Terminates if length characters have been read, timeout, or
azazeal88 1:cf9b0c21907a 389 * if the terminator character has been detected
azazeal88 1:cf9b0c21907a 390 * @param The terminator character to look for
azazeal88 1:cf9b0c21907a 391 * @param The buffer to read into.
azazeal88 1:cf9b0c21907a 392 * @param The size of the buffer.
azazeal88 1:cf9b0c21907a 393 * @return The number of bytes read. 0 means no valid data found.
azazeal88 1:cf9b0c21907a 394 */
azazeal88 0:a8609e6f88f3 395 size_t readBytesUntil(char terminator, char *buffer, size_t length);
azazeal88 0:a8609e6f88f3 396 };
azazeal88 0:a8609e6f88f3 397
azazeal88 0:a8609e6f88f3 398 #endif // RN2483