Tami Farber / microbit-dal

Revised to disable BLE for radio communication as needed.

Dependencies:   BLE_API nRF51822 mbed-dev-bin

Dependents:   microbit

source/types/PacketBuffer.cpp@74:26717338739d, 2019-11-26 (annotated)

Committer:
tsfarber
Date:
Tue Nov 26 04:12:46 2019 +0000
Revision:
74:26717338739d
Parent:
1:8aa5cdb4ab67 
This program combines samples programs radio TX and radio RX so that both units can send or receive depending on which unit's buttons are pressed. Tested successfully. MicroBitConfig.h has been edited to disable BLE.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jonathan Austin 1:8aa5cdb4ab67 1 /*
Jonathan Austin 1:8aa5cdb4ab67 2 The MIT License (MIT)
Jonathan Austin 1:8aa5cdb4ab67 3
Jonathan Austin 1:8aa5cdb4ab67 4 Copyright (c) 2016 British Broadcasting Corporation.
Jonathan Austin 1:8aa5cdb4ab67 5 This software is provided by Lancaster University by arrangement with the BBC.
Jonathan Austin 1:8aa5cdb4ab67 6
Jonathan Austin 1:8aa5cdb4ab67 7 Permission is hereby granted, free of charge, to any person obtaining a
Jonathan Austin 1:8aa5cdb4ab67 8 copy of this software and associated documentation files (the "Software"),
Jonathan Austin 1:8aa5cdb4ab67 9 to deal in the Software without restriction, including without limitation
Jonathan Austin 1:8aa5cdb4ab67 10 the rights to use, copy, modify, merge, publish, distribute, sublicense,
Jonathan Austin 1:8aa5cdb4ab67 11 and/or sell copies of the Software, and to permit persons to whom the
Jonathan Austin 1:8aa5cdb4ab67 12 Software is furnished to do so, subject to the following conditions:
Jonathan Austin 1:8aa5cdb4ab67 13
Jonathan Austin 1:8aa5cdb4ab67 14 The above copyright notice and this permission notice shall be included in
Jonathan Austin 1:8aa5cdb4ab67 15 all copies or substantial portions of the Software.
Jonathan Austin 1:8aa5cdb4ab67 16
Jonathan Austin 1:8aa5cdb4ab67 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Jonathan Austin 1:8aa5cdb4ab67 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Jonathan Austin 1:8aa5cdb4ab67 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
Jonathan Austin 1:8aa5cdb4ab67 20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Jonathan Austin 1:8aa5cdb4ab67 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
Jonathan Austin 1:8aa5cdb4ab67 22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
Jonathan Austin 1:8aa5cdb4ab67 23 DEALINGS IN THE SOFTWARE.
Jonathan Austin 1:8aa5cdb4ab67 24 */
Jonathan Austin 1:8aa5cdb4ab67 25
Jonathan Austin 1:8aa5cdb4ab67 26 #include "MicroBitConfig.h"
Jonathan Austin 1:8aa5cdb4ab67 27 #include "PacketBuffer.h"
Jonathan Austin 1:8aa5cdb4ab67 28 #include "ErrorNo.h"
Jonathan Austin 1:8aa5cdb4ab67 29
Jonathan Austin 1:8aa5cdb4ab67 30 // Create the EmptyPacket reference.
Jonathan Austin 1:8aa5cdb4ab67 31 PacketBuffer PacketBuffer::EmptyPacket = PacketBuffer(1);
Jonathan Austin 1:8aa5cdb4ab67 32
Jonathan Austin 1:8aa5cdb4ab67 33 /**
Jonathan Austin 1:8aa5cdb4ab67 34 * Default Constructor.
Jonathan Austin 1:8aa5cdb4ab67 35 * Creates an empty Packet Buffer.
Jonathan Austin 1:8aa5cdb4ab67 36 *
Jonathan Austin 1:8aa5cdb4ab67 37 * @code
Jonathan Austin 1:8aa5cdb4ab67 38 * PacketBuffer p();
Jonathan Austin 1:8aa5cdb4ab67 39 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 40 */
Jonathan Austin 1:8aa5cdb4ab67 41 PacketBuffer::PacketBuffer()
Jonathan Austin 1:8aa5cdb4ab67 42 {
Jonathan Austin 1:8aa5cdb4ab67 43 this->init(NULL, 0, 0);
Jonathan Austin 1:8aa5cdb4ab67 44 }
Jonathan Austin 1:8aa5cdb4ab67 45
Jonathan Austin 1:8aa5cdb4ab67 46 /**
Jonathan Austin 1:8aa5cdb4ab67 47 * Constructor.
Jonathan Austin 1:8aa5cdb4ab67 48 * Creates a new PacketBuffer of the given size.
Jonathan Austin 1:8aa5cdb4ab67 49 *
Jonathan Austin 1:8aa5cdb4ab67 50 * @param length The length of the buffer to create.
Jonathan Austin 1:8aa5cdb4ab67 51 *
Jonathan Austin 1:8aa5cdb4ab67 52 * @code
Jonathan Austin 1:8aa5cdb4ab67 53 * PacketBuffer p(16); // Creates a PacketBuffer 16 bytes long.
Jonathan Austin 1:8aa5cdb4ab67 54 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 55 */
Jonathan Austin 1:8aa5cdb4ab67 56 PacketBuffer::PacketBuffer(int length)
Jonathan Austin 1:8aa5cdb4ab67 57 {
Jonathan Austin 1:8aa5cdb4ab67 58 this->init(NULL, length, 0);
Jonathan Austin 1:8aa5cdb4ab67 59 }
Jonathan Austin 1:8aa5cdb4ab67 60
Jonathan Austin 1:8aa5cdb4ab67 61 /**
Jonathan Austin 1:8aa5cdb4ab67 62 * Constructor.
Jonathan Austin 1:8aa5cdb4ab67 63 * Creates an empty Packet Buffer of the given size,
Jonathan Austin 1:8aa5cdb4ab67 64 * and fills it with the data provided.
Jonathan Austin 1:8aa5cdb4ab67 65 *
Jonathan Austin 1:8aa5cdb4ab67 66 * @param data The data with which to fill the buffer.
Jonathan Austin 1:8aa5cdb4ab67 67 *
Jonathan Austin 1:8aa5cdb4ab67 68 * @param length The length of the buffer to create.
Jonathan Austin 1:8aa5cdb4ab67 69 *
Jonathan Austin 1:8aa5cdb4ab67 70 * @param rssi The radio signal strength at the time this packet was recieved. Defaults to 0.
Jonathan Austin 1:8aa5cdb4ab67 71 *
Jonathan Austin 1:8aa5cdb4ab67 72 * @code
Jonathan Austin 1:8aa5cdb4ab67 73 * uint8_t buf = {13,5,2};
Jonathan Austin 1:8aa5cdb4ab67 74 * PacketBuffer p(buf, 3); // Creates a PacketBuffer 3 bytes long.
Jonathan Austin 1:8aa5cdb4ab67 75 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 76 */
Jonathan Austin 1:8aa5cdb4ab67 77 PacketBuffer::PacketBuffer(uint8_t *data, int length, int rssi)
Jonathan Austin 1:8aa5cdb4ab67 78 {
Jonathan Austin 1:8aa5cdb4ab67 79 this->init(data, length, rssi);
Jonathan Austin 1:8aa5cdb4ab67 80 }
Jonathan Austin 1:8aa5cdb4ab67 81
Jonathan Austin 1:8aa5cdb4ab67 82 /**
Jonathan Austin 1:8aa5cdb4ab67 83 * Copy Constructor.
Jonathan Austin 1:8aa5cdb4ab67 84 * Add ourselves as a reference to an existing PacketBuffer.
Jonathan Austin 1:8aa5cdb4ab67 85 *
Jonathan Austin 1:8aa5cdb4ab67 86 * @param buffer The PacketBuffer to reference.
Jonathan Austin 1:8aa5cdb4ab67 87 *
Jonathan Austin 1:8aa5cdb4ab67 88 * @code
Jonathan Austin 1:8aa5cdb4ab67 89 * PacketBuffer p();
Jonathan Austin 1:8aa5cdb4ab67 90 * PacketBuffer p2(p); // Refers to the same packet as p.
Jonathan Austin 1:8aa5cdb4ab67 91 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 92 */
Jonathan Austin 1:8aa5cdb4ab67 93 PacketBuffer::PacketBuffer(const PacketBuffer &buffer)
Jonathan Austin 1:8aa5cdb4ab67 94 {
Jonathan Austin 1:8aa5cdb4ab67 95 ptr = buffer.ptr;
Jonathan Austin 1:8aa5cdb4ab67 96 ptr->incr();
Jonathan Austin 1:8aa5cdb4ab67 97 }
Jonathan Austin 1:8aa5cdb4ab67 98
Jonathan Austin 1:8aa5cdb4ab67 99 /**
Jonathan Austin 1:8aa5cdb4ab67 100 * Internal constructor-initialiser.
Jonathan Austin 1:8aa5cdb4ab67 101 *
Jonathan Austin 1:8aa5cdb4ab67 102 * @param data The data with which to fill the buffer.
Jonathan Austin 1:8aa5cdb4ab67 103 *
Jonathan Austin 1:8aa5cdb4ab67 104 * @param length The length of the buffer to create.
Jonathan Austin 1:8aa5cdb4ab67 105 *
Jonathan Austin 1:8aa5cdb4ab67 106 * @param rssi The radio signal strength at the time this packet was recieved.
Jonathan Austin 1:8aa5cdb4ab67 107 */
Jonathan Austin 1:8aa5cdb4ab67 108 void PacketBuffer::init(uint8_t *data, int length, int rssi)
Jonathan Austin 1:8aa5cdb4ab67 109 {
Jonathan Austin 1:8aa5cdb4ab67 110 if (length < 0)
Jonathan Austin 1:8aa5cdb4ab67 111 length = 0;
Jonathan Austin 1:8aa5cdb4ab67 112
Jonathan Austin 1:8aa5cdb4ab67 113 ptr = (PacketData *) malloc(sizeof(PacketData) + length);
Jonathan Austin 1:8aa5cdb4ab67 114 ptr->init();
Jonathan Austin 1:8aa5cdb4ab67 115
Jonathan Austin 1:8aa5cdb4ab67 116 ptr->length = length;
Jonathan Austin 1:8aa5cdb4ab67 117 ptr->rssi = rssi;
Jonathan Austin 1:8aa5cdb4ab67 118
Jonathan Austin 1:8aa5cdb4ab67 119 // Copy in the data buffer, if provided.
Jonathan Austin 1:8aa5cdb4ab67 120 if (data)
Jonathan Austin 1:8aa5cdb4ab67 121 memcpy(ptr->payload, data, length);
Jonathan Austin 1:8aa5cdb4ab67 122 }
Jonathan Austin 1:8aa5cdb4ab67 123
Jonathan Austin 1:8aa5cdb4ab67 124 /**
Jonathan Austin 1:8aa5cdb4ab67 125 * Destructor.
Jonathan Austin 1:8aa5cdb4ab67 126 *
Jonathan Austin 1:8aa5cdb4ab67 127 * Removes buffer resources held by the instance.
Jonathan Austin 1:8aa5cdb4ab67 128 */
Jonathan Austin 1:8aa5cdb4ab67 129 PacketBuffer::~PacketBuffer()
Jonathan Austin 1:8aa5cdb4ab67 130 {
Jonathan Austin 1:8aa5cdb4ab67 131 ptr->decr();
Jonathan Austin 1:8aa5cdb4ab67 132 }
Jonathan Austin 1:8aa5cdb4ab67 133
Jonathan Austin 1:8aa5cdb4ab67 134 /**
Jonathan Austin 1:8aa5cdb4ab67 135 * Copy assign operation.
Jonathan Austin 1:8aa5cdb4ab67 136 *
Jonathan Austin 1:8aa5cdb4ab67 137 * Called when one PacketBuffer is assigned the value of another using the '=' operator.
Jonathan Austin 1:8aa5cdb4ab67 138 *
Jonathan Austin 1:8aa5cdb4ab67 139 * Decrements our reference count and free up the buffer as necessary.
Jonathan Austin 1:8aa5cdb4ab67 140 *
Jonathan Austin 1:8aa5cdb4ab67 141 * Then, update our buffer to refer to that of the supplied PacketBuffer,
Jonathan Austin 1:8aa5cdb4ab67 142 * and increase its reference count.
Jonathan Austin 1:8aa5cdb4ab67 143 *
Jonathan Austin 1:8aa5cdb4ab67 144 * @param p The PacketBuffer to reference.
Jonathan Austin 1:8aa5cdb4ab67 145 *
Jonathan Austin 1:8aa5cdb4ab67 146 * @code
Jonathan Austin 1:8aa5cdb4ab67 147 * uint8_t buf = {13,5,2};
Jonathan Austin 1:8aa5cdb4ab67 148 * PacketBuffer p1(16);
Jonathan Austin 1:8aa5cdb4ab67 149 * PacketBuffer p2(buf, 3);
Jonathan Austin 1:8aa5cdb4ab67 150 *
Jonathan Austin 1:8aa5cdb4ab67 151 * p1 = p2;
Jonathan Austin 1:8aa5cdb4ab67 152 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 153 */
Jonathan Austin 1:8aa5cdb4ab67 154 PacketBuffer& PacketBuffer::operator = (const PacketBuffer &p)
Jonathan Austin 1:8aa5cdb4ab67 155 {
Jonathan Austin 1:8aa5cdb4ab67 156 if(ptr == p.ptr)
Jonathan Austin 1:8aa5cdb4ab67 157 return *this;
Jonathan Austin 1:8aa5cdb4ab67 158
Jonathan Austin 1:8aa5cdb4ab67 159 ptr->decr();
Jonathan Austin 1:8aa5cdb4ab67 160 ptr = p.ptr;
Jonathan Austin 1:8aa5cdb4ab67 161 ptr->incr();
Jonathan Austin 1:8aa5cdb4ab67 162
Jonathan Austin 1:8aa5cdb4ab67 163 return *this;
Jonathan Austin 1:8aa5cdb4ab67 164 }
Jonathan Austin 1:8aa5cdb4ab67 165
Jonathan Austin 1:8aa5cdb4ab67 166 /**
Jonathan Austin 1:8aa5cdb4ab67 167 * Array access operation (read).
Jonathan Austin 1:8aa5cdb4ab67 168 *
Jonathan Austin 1:8aa5cdb4ab67 169 * Called when a PacketBuffer is dereferenced with a [] operation.
Jonathan Austin 1:8aa5cdb4ab67 170 *
Jonathan Austin 1:8aa5cdb4ab67 171 * Transparently map this through to the underlying payload for elegance of programming.
Jonathan Austin 1:8aa5cdb4ab67 172 *
Jonathan Austin 1:8aa5cdb4ab67 173 * @code
Jonathan Austin 1:8aa5cdb4ab67 174 * PacketBuffer p1(16);
Jonathan Austin 1:8aa5cdb4ab67 175 * uint8_t data = p1[0];
Jonathan Austin 1:8aa5cdb4ab67 176 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 177 */
Jonathan Austin 1:8aa5cdb4ab67 178 uint8_t PacketBuffer::operator [] (int i) const
Jonathan Austin 1:8aa5cdb4ab67 179 {
Jonathan Austin 1:8aa5cdb4ab67 180 return ptr->payload[i];
Jonathan Austin 1:8aa5cdb4ab67 181 }
Jonathan Austin 1:8aa5cdb4ab67 182
Jonathan Austin 1:8aa5cdb4ab67 183 /**
Jonathan Austin 1:8aa5cdb4ab67 184 * Array access operation (modify).
Jonathan Austin 1:8aa5cdb4ab67 185 *
Jonathan Austin 1:8aa5cdb4ab67 186 * Called when a PacketBuffer is dereferenced with a [] operation.
Jonathan Austin 1:8aa5cdb4ab67 187 *
Jonathan Austin 1:8aa5cdb4ab67 188 * Transparently map this through to the underlying payload for elegance of programming.
Jonathan Austin 1:8aa5cdb4ab67 189 *
Jonathan Austin 1:8aa5cdb4ab67 190 * @code
Jonathan Austin 1:8aa5cdb4ab67 191 * PacketBuffer p1(16);
Jonathan Austin 1:8aa5cdb4ab67 192 * p1[0] = 42;
Jonathan Austin 1:8aa5cdb4ab67 193 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 194 */
Jonathan Austin 1:8aa5cdb4ab67 195 uint8_t& PacketBuffer::operator [] (int i)
Jonathan Austin 1:8aa5cdb4ab67 196 {
Jonathan Austin 1:8aa5cdb4ab67 197 return ptr->payload[i];
Jonathan Austin 1:8aa5cdb4ab67 198 }
Jonathan Austin 1:8aa5cdb4ab67 199
Jonathan Austin 1:8aa5cdb4ab67 200 /**
Jonathan Austin 1:8aa5cdb4ab67 201 * Equality operation.
Jonathan Austin 1:8aa5cdb4ab67 202 *
Jonathan Austin 1:8aa5cdb4ab67 203 * Called when one PacketBuffer is tested to be equal to another using the '==' operator.
Jonathan Austin 1:8aa5cdb4ab67 204 *
Jonathan Austin 1:8aa5cdb4ab67 205 * @param p The PacketBuffer to test ourselves against.
Jonathan Austin 1:8aa5cdb4ab67 206 *
Jonathan Austin 1:8aa5cdb4ab67 207 * @return true if this PacketBuffer is identical to the one supplied, false otherwise.
Jonathan Austin 1:8aa5cdb4ab67 208 *
Jonathan Austin 1:8aa5cdb4ab67 209 * @code
Jonathan Austin 1:8aa5cdb4ab67 210 * MicroBitDisplay display;
Jonathan Austin 1:8aa5cdb4ab67 211 * uint8_t buf = {13,5,2};
Jonathan Austin 1:8aa5cdb4ab67 212 * PacketBuffer p1();
Jonathan Austin 1:8aa5cdb4ab67 213 * PacketBuffer p2();
Jonathan Austin 1:8aa5cdb4ab67 214 *
Jonathan Austin 1:8aa5cdb4ab67 215 * if(p1 == p2) // will be true
Jonathan Austin 1:8aa5cdb4ab67 216 * display.scroll("same!");
Jonathan Austin 1:8aa5cdb4ab67 217 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 218 */
Jonathan Austin 1:8aa5cdb4ab67 219 bool PacketBuffer::operator== (const PacketBuffer& p)
Jonathan Austin 1:8aa5cdb4ab67 220 {
Jonathan Austin 1:8aa5cdb4ab67 221 if (ptr == p.ptr)
Jonathan Austin 1:8aa5cdb4ab67 222 return true;
Jonathan Austin 1:8aa5cdb4ab67 223 else
Jonathan Austin 1:8aa5cdb4ab67 224 return (ptr->length == p.ptr->length && (memcmp(ptr->payload, p.ptr->payload, ptr->length)==0));
Jonathan Austin 1:8aa5cdb4ab67 225 }
Jonathan Austin 1:8aa5cdb4ab67 226
Jonathan Austin 1:8aa5cdb4ab67 227 /**
Jonathan Austin 1:8aa5cdb4ab67 228 * Sets the byte at the given index to value provided.
Jonathan Austin 1:8aa5cdb4ab67 229 *
Jonathan Austin 1:8aa5cdb4ab67 230 * @param position The index of the byte to change.
Jonathan Austin 1:8aa5cdb4ab67 231 *
Jonathan Austin 1:8aa5cdb4ab67 232 * @param value The new value of the byte (0-255).
Jonathan Austin 1:8aa5cdb4ab67 233 *
Jonathan Austin 1:8aa5cdb4ab67 234 * @return MICROBIT_OK, or MICROBIT_INVALID_PARAMETER.
Jonathan Austin 1:8aa5cdb4ab67 235 *
Jonathan Austin 1:8aa5cdb4ab67 236 * @code
Jonathan Austin 1:8aa5cdb4ab67 237 * PacketBuffer p1(16);
Jonathan Austin 1:8aa5cdb4ab67 238 * p1.setByte(0,255); // Sets the first byte in the buffer to the value 255.
Jonathan Austin 1:8aa5cdb4ab67 239 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 240 */
Jonathan Austin 1:8aa5cdb4ab67 241 int PacketBuffer::setByte(int position, uint8_t value)
Jonathan Austin 1:8aa5cdb4ab67 242 {
Jonathan Austin 1:8aa5cdb4ab67 243 if (position < ptr->length)
Jonathan Austin 1:8aa5cdb4ab67 244 {
Jonathan Austin 1:8aa5cdb4ab67 245 ptr->payload[position] = value;
Jonathan Austin 1:8aa5cdb4ab67 246 return MICROBIT_OK;
Jonathan Austin 1:8aa5cdb4ab67 247 }
Jonathan Austin 1:8aa5cdb4ab67 248 else
Jonathan Austin 1:8aa5cdb4ab67 249 {
Jonathan Austin 1:8aa5cdb4ab67 250 return MICROBIT_INVALID_PARAMETER;
Jonathan Austin 1:8aa5cdb4ab67 251 }
Jonathan Austin 1:8aa5cdb4ab67 252 }
Jonathan Austin 1:8aa5cdb4ab67 253
Jonathan Austin 1:8aa5cdb4ab67 254 /**
Jonathan Austin 1:8aa5cdb4ab67 255 * Determines the value of the given byte in the packet.
Jonathan Austin 1:8aa5cdb4ab67 256 *
Jonathan Austin 1:8aa5cdb4ab67 257 * @param position The index of the byte to read.
Jonathan Austin 1:8aa5cdb4ab67 258 *
Jonathan Austin 1:8aa5cdb4ab67 259 * @return The value of the byte at the given position, or MICROBIT_INVALID_PARAMETER.
Jonathan Austin 1:8aa5cdb4ab67 260 *
Jonathan Austin 1:8aa5cdb4ab67 261 * @code
Jonathan Austin 1:8aa5cdb4ab67 262 * PacketBuffer p1(16);
Jonathan Austin 1:8aa5cdb4ab67 263 * p1.setByte(0,255); // Sets the first byte in the buffer to the value 255.
Jonathan Austin 1:8aa5cdb4ab67 264 * p1.getByte(0); // Returns 255.
Jonathan Austin 1:8aa5cdb4ab67 265 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 266 */
Jonathan Austin 1:8aa5cdb4ab67 267 int PacketBuffer::getByte(int position)
Jonathan Austin 1:8aa5cdb4ab67 268 {
Jonathan Austin 1:8aa5cdb4ab67 269 if (position < ptr->length)
Jonathan Austin 1:8aa5cdb4ab67 270 return ptr->payload[position];
Jonathan Austin 1:8aa5cdb4ab67 271 else
Jonathan Austin 1:8aa5cdb4ab67 272 return MICROBIT_INVALID_PARAMETER;
Jonathan Austin 1:8aa5cdb4ab67 273 }
Jonathan Austin 1:8aa5cdb4ab67 274
Jonathan Austin 1:8aa5cdb4ab67 275 /**
Jonathan Austin 1:8aa5cdb4ab67 276 * Provide a pointer to a memory location containing the packet data.
Jonathan Austin 1:8aa5cdb4ab67 277 *
Jonathan Austin 1:8aa5cdb4ab67 278 * @return The contents of this packet, as an array of bytes.
Jonathan Austin 1:8aa5cdb4ab67 279 */
Jonathan Austin 1:8aa5cdb4ab67 280 uint8_t*PacketBuffer::getBytes()
Jonathan Austin 1:8aa5cdb4ab67 281 {
Jonathan Austin 1:8aa5cdb4ab67 282 return ptr->payload;
Jonathan Austin 1:8aa5cdb4ab67 283 }
Jonathan Austin 1:8aa5cdb4ab67 284
Jonathan Austin 1:8aa5cdb4ab67 285 /**
Jonathan Austin 1:8aa5cdb4ab67 286 * Gets number of bytes in this buffer
Jonathan Austin 1:8aa5cdb4ab67 287 *
Jonathan Austin 1:8aa5cdb4ab67 288 * @return The size of the buffer in bytes.
Jonathan Austin 1:8aa5cdb4ab67 289 *
Jonathan Austin 1:8aa5cdb4ab67 290 * @code
Jonathan Austin 1:8aa5cdb4ab67 291 * PacketBuffer p1(16);
Jonathan Austin 1:8aa5cdb4ab67 292 * p1.length(); // Returns 16.
Jonathan Austin 1:8aa5cdb4ab67 293 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 294 */
Jonathan Austin 1:8aa5cdb4ab67 295 int PacketBuffer::length()
Jonathan Austin 1:8aa5cdb4ab67 296 {
Jonathan Austin 1:8aa5cdb4ab67 297 return ptr->length;
Jonathan Austin 1:8aa5cdb4ab67 298 }
Jonathan Austin 1:8aa5cdb4ab67 299
Jonathan Austin 1:8aa5cdb4ab67 300 /**
Jonathan Austin 1:8aa5cdb4ab67 301 * Retrieves the received signal strength of this packet.
Jonathan Austin 1:8aa5cdb4ab67 302 *
Jonathan Austin 1:8aa5cdb4ab67 303 * @return The signal strength of the radio when this packet was received, in -dbM.
Jonathan Austin 1:8aa5cdb4ab67 304 *
Jonathan Austin 1:8aa5cdb4ab67 305 * @code
Jonathan Austin 1:8aa5cdb4ab67 306 * PacketBuffer p1(16);
Jonathan Austin 1:8aa5cdb4ab67 307 * p1.getRSSI(); // Returns the received signal strength.
Jonathan Austin 1:8aa5cdb4ab67 308 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 309 */
Jonathan Austin 1:8aa5cdb4ab67 310 int PacketBuffer::getRSSI()
Jonathan Austin 1:8aa5cdb4ab67 311 {
Jonathan Austin 1:8aa5cdb4ab67 312 return ptr->rssi;
Jonathan Austin 1:8aa5cdb4ab67 313 }
Jonathan Austin 1:8aa5cdb4ab67 314
Jonathan Austin 1:8aa5cdb4ab67 315 /**
Jonathan Austin 1:8aa5cdb4ab67 316 * Sets the received signal strength of this packet.
Jonathan Austin 1:8aa5cdb4ab67 317 *
Jonathan Austin 1:8aa5cdb4ab67 318 * @code
Jonathan Austin 1:8aa5cdb4ab67 319 * PacketBuffer p1(16);
Jonathan Austin 1:8aa5cdb4ab67 320 * p1.setRSSI(37);
Jonathan Austin 1:8aa5cdb4ab67 321 * @endcode
Jonathan Austin 1:8aa5cdb4ab67 322 */
Jonathan Austin 1:8aa5cdb4ab67 323 void PacketBuffer::setRSSI(uint8_t rssi)
Jonathan Austin 1:8aa5cdb4ab67 324 {
Jonathan Austin 1:8aa5cdb4ab67 325 ptr->rssi = rssi;
Jonathan Austin 1:8aa5cdb4ab67 326 }