Group 3_ESE519 / Mbed 2 deprecated lab5-remote

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.

Dependencies:   mbed

MRF24J40/MRF24J40.h@6:1fe84e29b486, 2015-11-11 (annotated)

Committer:
mfrede
Date:
Wed Nov 11 00:46:15 2015 +0000
Revision:
6:1fe84e29b486
Parent:
1:019a3be50b96 
added headers back in...not sure if we need them

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mfrede 1:019a3be50b96 1 /* mbed MRF24J40 (IEEE 802.15.4 tranceiver) Library
mfrede 1:019a3be50b96 2 * Copyright (c) 2011 Jeroen Hilgers
mfrede 1:019a3be50b96 3 *
mfrede 1:019a3be50b96 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mfrede 1:019a3be50b96 5 * of this software and associated documentation files (the "Software"), to deal
mfrede 1:019a3be50b96 6 * in the Software without restriction, including without limitation the rights
mfrede 1:019a3be50b96 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mfrede 1:019a3be50b96 8 * copies of the Software, and to permit persons to whom the Software is
mfrede 1:019a3be50b96 9 * furnished to do so, subject to the following conditions:
mfrede 1:019a3be50b96 10 *
mfrede 1:019a3be50b96 11 * The above copyright notice and this permission notice shall be included in
mfrede 1:019a3be50b96 12 * all copies or substantial portions of the Software.
mfrede 1:019a3be50b96 13 *
mfrede 1:019a3be50b96 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mfrede 1:019a3be50b96 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mfrede 1:019a3be50b96 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mfrede 1:019a3be50b96 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mfrede 1:019a3be50b96 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mfrede 1:019a3be50b96 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
mfrede 1:019a3be50b96 20 * THE SOFTWARE.
mfrede 1:019a3be50b96 21 */
mfrede 1:019a3be50b96 22
mfrede 1:019a3be50b96 23 #ifndef MRF24J40_H
mfrede 1:019a3be50b96 24 #define MRF25J40_H
mfrede 1:019a3be50b96 25
mfrede 1:019a3be50b96 26 #include "mbed.h"
mfrede 1:019a3be50b96 27
mfrede 1:019a3be50b96 28 /** MRF24J40 class. Provides a simple send/receive API for a microchip
mfrede 1:019a3be50b96 29 ** MFR24J40 IEEE 802.15.4 tranceiver. The tranceiver is available on a
mfrede 1:019a3be50b96 30 ** module that can easilly be soldered to some header pins to use it with
mfrede 1:019a3be50b96 31 ** an mbed on a breadboard. The module is called 'MRF24J40MA' and can be
mfrede 1:019a3be50b96 32 ** ordered for example by www.farnell.com.
mfrede 1:019a3be50b96 33 *
mfrede 1:019a3be50b96 34 * Example:
mfrede 1:019a3be50b96 35 * @code
mfrede 1:019a3be50b96 36 * #include "mbed.h"
mfrede 1:019a3be50b96 37 * #include "MRF24J40.h"
mfrede 1:019a3be50b96 38 *
mfrede 1:019a3be50b96 39 * // RF tranceiver to link with handheld.
mfrede 1:019a3be50b96 40 * MRF24J40 mrf(p11, p12, p13, p14, p21);
mfrede 1:019a3be50b96 41 *
mfrede 1:019a3be50b96 42 * // LEDs
mfrede 1:019a3be50b96 43 * DigitalOut led1(LED1);
mfrede 1:019a3be50b96 44 * DigitalOut led2(LED2);
mfrede 1:019a3be50b96 45 * DigitalOut led3(LED3);
mfrede 1:019a3be50b96 46 * DigitalOut led4(LED4);
mfrede 1:019a3be50b96 47 *
mfrede 1:019a3be50b96 48 * // Timer.
mfrede 1:019a3be50b96 49 * Timer timer;
mfrede 1:019a3be50b96 50 *
mfrede 1:019a3be50b96 51 * // Serial port for showing RX data.
mfrede 1:019a3be50b96 52 * Serial pc(USBTX, USBRX);
mfrede 1:019a3be50b96 53 *
mfrede 1:019a3be50b96 54 * // Send / receive buffers.
mfrede 1:019a3be50b96 55 * // IMPORTANT: The MRF24J40 is intended as zigbee tranceiver; it tends
mfrede 1:019a3be50b96 56 * // to reject data that doesn't have the right header. So the first
mfrede 1:019a3be50b96 57 * // 8 bytes in txBuffer look like a valid header. The remaining 120
mfrede 1:019a3be50b96 58 * // bytes can be used for anything you like.
mfrede 1:019a3be50b96 59 * uint8_t txBuffer[128]= {1, 8, 0, 0xA1, 0xB2, 0xC3, 0xD4, 0x00};
mfrede 1:019a3be50b96 60 *
mfrede 1:019a3be50b96 61 * uint8_t rxBuffer[128];
mfrede 1:019a3be50b96 62 * uint8_t rxLen;
mfrede 1:019a3be50b96 63 *
mfrede 1:019a3be50b96 64 * int main (void)
mfrede 1:019a3be50b96 65 * {
mfrede 1:019a3be50b96 66 * uint8_t count = 0;
mfrede 1:019a3be50b96 67 * pc.baud(115200);
mfrede 1:019a3be50b96 68 * timer.start();
mfrede 1:019a3be50b96 69 * while(1)
mfrede 1:019a3be50b96 70 * {
mfrede 1:019a3be50b96 71 * // Check if any data was received.
mfrede 1:019a3be50b96 72 * rxLen = mrf.Receive(rxBuffer, 128);
mfrede 1:019a3be50b96 73 * if(rxLen)
mfrede 1:019a3be50b96 74 * {
mfrede 1:019a3be50b96 75 * // Toggle LED 1 upon each reception of data.
mfrede 1:019a3be50b96 76 * led1 = led1^1;
mfrede 1:019a3be50b96 77 * // Send to serial.
mfrede 1:019a3be50b96 78 * // IMPORTANT: The last two bytes of the received data
mfrede 1:019a3be50b96 79 * // are the checksum used in the transmission.
mfrede 1:019a3be50b96 80 * for(uint8_t i=0; i<rxLen; i++)
mfrede 1:019a3be50b96 81 * {
mfrede 1:019a3be50b96 82 * pc.printf("0x%02X ", rxBuffer[i]);
mfrede 1:019a3be50b96 83 * }
mfrede 1:019a3be50b96 84 * pc.printf("\r\n");
mfrede 1:019a3be50b96 85 * }
mfrede 1:019a3be50b96 86 *
mfrede 1:019a3be50b96 87 * // Each second, send some data.
mfrede 1:019a3be50b96 88 * if(timer.read_ms() >= 1000)
mfrede 1:019a3be50b96 89 * {
mfrede 1:019a3be50b96 90 * timer.reset();
mfrede 1:019a3be50b96 91 * // Toggle LED 2.
mfrede 1:019a3be50b96 92 * led2 = led2^1;
mfrede 1:019a3be50b96 93 *
mfrede 1:019a3be50b96 94 * // UART.
mfrede 1:019a3be50b96 95 * pc.printf("TXD\r\n");
mfrede 1:019a3be50b96 96 *
mfrede 1:019a3be50b96 97 * // Send counter value.
mfrede 1:019a3be50b96 98 * count++;
mfrede 1:019a3be50b96 99 * txBuffer[8] = count;
mfrede 1:019a3be50b96 100 * mrf.Send(txBuffer, 9);
mfrede 1:019a3be50b96 101 * }
mfrede 1:019a3be50b96 102 * }
mfrede 1:019a3be50b96 103 * }
mfrede 1:019a3be50b96 104 * @endcode
mfrede 1:019a3be50b96 105 */
mfrede 1:019a3be50b96 106
mfrede 1:019a3be50b96 107
mfrede 1:019a3be50b96 108 class MRF24J40
mfrede 1:019a3be50b96 109 {
mfrede 1:019a3be50b96 110 public:
mfrede 1:019a3be50b96 111 /** Create a MRF24J40 object and initizalize it.
mfrede 1:019a3be50b96 112 *
mfrede 1:019a3be50b96 113 * @param pin mosi Spi MOSI pin connected to MRF's SDI.
mfrede 1:019a3be50b96 114 * @param pin miso Spi MISO pin connected to MRF's SDO.
mfrede 1:019a3be50b96 115 * @param pin sck Spi SCK pin connected to MRF's SCK.
mfrede 1:019a3be50b96 116 * @param pin cs Pin connected to MRF's #CS.
mfrede 1:019a3be50b96 117 * @param pin reset Pin connected to MRF's #Reset.
mfrede 1:019a3be50b96 118 */
mfrede 1:019a3be50b96 119 MRF24J40(PinName mosi, PinName miso, PinName sck, PinName cs, PinName reset);//, PinName irq, PinName wake);
mfrede 1:019a3be50b96 120
mfrede 1:019a3be50b96 121 /** Reset the MRF24J40 and initialize it.
mfrede 1:019a3be50b96 122 */
mfrede 1:019a3be50b96 123 void Reset(void); // Reset chip and configure it.
mfrede 1:019a3be50b96 124
mfrede 1:019a3be50b96 125 /** Send data.
mfrede 1:019a3be50b96 126 *
mfrede 1:019a3be50b96 127 * Note that the MRF24J40 only handles data with a valid IEEE 802.15.4
mfrede 1:019a3be50b96 128 * header. See the example how to get around this.
mfrede 1:019a3be50b96 129 *
mfrede 1:019a3be50b96 130 * @param data Pointer to data to be send.
mfrede 1:019a3be50b96 131 * @param length Length of the data to be send in bytes.
mfrede 1:019a3be50b96 132 */
mfrede 1:019a3be50b96 133 void Send(uint8_t *data, uint8_t length); // Send data.
mfrede 1:019a3be50b96 134
mfrede 1:019a3be50b96 135 /** Check if any data was received.
mfrede 1:019a3be50b96 136 *
mfrede 1:019a3be50b96 137 * Note that the MRF24J40 appends two bytes of CRC for each packet.
mfrede 1:019a3be50b96 138 * So you will receive two bytes more than were send with the 'Send' function.
mfrede 1:019a3be50b96 139 *
mfrede 1:019a3be50b96 140 * @param data Pointer to buffer where received data can be placed.
mfrede 1:019a3be50b96 141 * @param maxLength Maximum amount of data to be placed in the buffer.
mfrede 1:019a3be50b96 142 * @param returns The number of bytes written into the buffer.
mfrede 1:019a3be50b96 143 */
mfrede 1:019a3be50b96 144 uint8_t Receive(uint8_t *data, uint8_t maxLength); // Receive data if ready.
mfrede 1:019a3be50b96 145
mfrede 1:019a3be50b96 146 /** Sets the channel of the MRF24J40
mfrede 1:019a3be50b96 147 *
mfrede 1:019a3be50b96 148 * @param channel A number between 0-15 (0=2405MHz 15=2480MHz)
mfrede 1:019a3be50b96 149 */
mfrede 1:019a3be50b96 150 void SetChannel(uint8_t channel);
mfrede 1:019a3be50b96 151
mfrede 1:019a3be50b96 152 // void DebugDump(Serial &ser);
mfrede 1:019a3be50b96 153
mfrede 1:019a3be50b96 154 private:
mfrede 1:019a3be50b96 155 SPI mSpi;
mfrede 1:019a3be50b96 156 DigitalOut mCs;
mfrede 1:019a3be50b96 157 DigitalOut mReset;
mfrede 1:019a3be50b96 158 // DigitalIn mIrq;
mfrede 1:019a3be50b96 159 // DigitalIn mWake;
mfrede 1:019a3be50b96 160
mfrede 1:019a3be50b96 161 uint8_t ReadShort (uint8_t address);
mfrede 1:019a3be50b96 162 void WriteShort (uint8_t address, uint8_t data);
mfrede 1:019a3be50b96 163 uint8_t ReadLong (uint16_t address);
mfrede 1:019a3be50b96 164 void WriteLong (uint16_t address, uint8_t data);
mfrede 1:019a3be50b96 165 };
mfrede 1:019a3be50b96 166
mfrede 1:019a3be50b96 167 #endif