RF12B/RF12B.h@1:0370ea94b64a, 2012-04-26 (annotated)
- Committer:
- narshu
- Date:
- Thu Apr 26 17:50:00 2012 +0000
- Revision:
- 1:0370ea94b64a
- Parent:
- 0:7583de124698
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
narshu | 0:7583de124698 | 1 | #ifndef _RF12B_H |
narshu | 0:7583de124698 | 2 | #define _RF12B_H |
narshu | 0:7583de124698 | 3 | |
narshu | 0:7583de124698 | 4 | #include "mbed.h" |
narshu | 1:0370ea94b64a | 5 | //#include <queue> |
narshu | 0:7583de124698 | 6 | |
narshu | 0:7583de124698 | 7 | enum rfmode_t{RX, TX}; |
narshu | 0:7583de124698 | 8 | |
narshu | 1:0370ea94b64a | 9 | class DummyCT; |
narshu | 1:0370ea94b64a | 10 | |
narshu | 0:7583de124698 | 11 | class RF12B { |
narshu | 0:7583de124698 | 12 | public: |
narshu | 0:7583de124698 | 13 | /* Constructor */ |
narshu | 0:7583de124698 | 14 | RF12B(PinName SDI, |
narshu | 0:7583de124698 | 15 | PinName SDO, |
narshu | 0:7583de124698 | 16 | PinName SCK, |
narshu | 0:7583de124698 | 17 | PinName NCS, |
narshu | 0:7583de124698 | 18 | PinName NIRQ); |
narshu | 1:0370ea94b64a | 19 | |
narshu | 0:7583de124698 | 20 | |
narshu | 0:7583de124698 | 21 | |
narshu | 0:7583de124698 | 22 | /* Reads a packet of data. Returns false if read failed. Use available() to check how much space to allocate for buffer */ |
narshu | 0:7583de124698 | 23 | bool read(unsigned char* data, unsigned int size); |
narshu | 0:7583de124698 | 24 | |
narshu | 0:7583de124698 | 25 | /* Reads a byte of data from the receive buffer |
narshu | 0:7583de124698 | 26 | Returns 0xFF if there is no data */ |
narshu | 0:7583de124698 | 27 | unsigned char read(); |
narshu | 0:7583de124698 | 28 | |
narshu | 0:7583de124698 | 29 | /* Transmits a packet of data */ |
narshu | 0:7583de124698 | 30 | void write(unsigned char* data, unsigned char length); |
narshu | 0:7583de124698 | 31 | void write(unsigned char data); /* 1-byte packet */ |
narshu | 1:0370ea94b64a | 32 | // void write(std::queue<char> &data, int length = -1); /* sends a whole queue */ |
narshu | 0:7583de124698 | 33 | |
narshu | 0:7583de124698 | 34 | /* Returns the packet length if data is available in the receive buffer, 0 otherwise*/ |
narshu | 0:7583de124698 | 35 | unsigned int available(); |
narshu | 1:0370ea94b64a | 36 | |
narshu | 1:0370ea94b64a | 37 | /** A assigns a callback function when a new reading is available **/ |
narshu | 1:0370ea94b64a | 38 | void (*callbackfunc)(unsigned char rx_code); |
narshu | 1:0370ea94b64a | 39 | DummyCT* callbackobj; |
narshu | 1:0370ea94b64a | 40 | void (DummyCT::*mcallbackfunc)(unsigned char rx_code); |
narshu | 0:7583de124698 | 41 | |
narshu | 0:7583de124698 | 42 | protected: |
narshu | 0:7583de124698 | 43 | /* Receive FIFO buffer */ |
narshu | 1:0370ea94b64a | 44 | // std::queue<unsigned char> fifo; |
narshu | 1:0370ea94b64a | 45 | // std::queue<unsigned char> temp; //for storing stuff mid-packet |
narshu | 0:7583de124698 | 46 | |
narshu | 0:7583de124698 | 47 | /* SPI module */ |
narshu | 0:7583de124698 | 48 | SPI spi; |
narshu | 0:7583de124698 | 49 | |
narshu | 0:7583de124698 | 50 | /* Other digital pins */ |
narshu | 0:7583de124698 | 51 | DigitalOut NCS; |
narshu | 0:7583de124698 | 52 | InterruptIn NIRQ; |
narshu | 0:7583de124698 | 53 | DigitalIn NIRQ_in; |
narshu | 0:7583de124698 | 54 | //DigitalOut rfled; |
narshu | 0:7583de124698 | 55 | |
narshu | 0:7583de124698 | 56 | rfmode_t mode; |
narshu | 0:7583de124698 | 57 | |
narshu | 0:7583de124698 | 58 | /* Initialises the RF12B module */ |
narshu | 0:7583de124698 | 59 | void init(); |
narshu | 0:7583de124698 | 60 | |
narshu | 0:7583de124698 | 61 | /* Write a command to the RF Module */ |
narshu | 0:7583de124698 | 62 | unsigned int writeCmd(unsigned int cmd); |
narshu | 0:7583de124698 | 63 | |
narshu | 0:7583de124698 | 64 | /* Sends a byte of data across RF */ |
narshu | 0:7583de124698 | 65 | void send(unsigned char data); |
narshu | 0:7583de124698 | 66 | |
narshu | 0:7583de124698 | 67 | /* Switch module between receive and transmit modes */ |
narshu | 0:7583de124698 | 68 | void changeMode(rfmode_t mode); |
narshu | 0:7583de124698 | 69 | |
narshu | 0:7583de124698 | 70 | /* Interrupt routine for data reception */ |
narshu | 0:7583de124698 | 71 | void rxISR(); |
narshu | 0:7583de124698 | 72 | |
narshu | 0:7583de124698 | 73 | /* Tell the RF Module this packet is received and wait for the next */ |
narshu | 0:7583de124698 | 74 | void resetRX(); |
narshu | 0:7583de124698 | 75 | |
narshu | 0:7583de124698 | 76 | /* Return the RF Module Status word */ |
narshu | 0:7583de124698 | 77 | unsigned int status(); |
narshu | 0:7583de124698 | 78 | |
narshu | 0:7583de124698 | 79 | /* Calculate CRC8 */ |
narshu | 0:7583de124698 | 80 | unsigned char crc8(unsigned char crc, unsigned char data); |
narshu | 0:7583de124698 | 81 | }; |
narshu | 0:7583de124698 | 82 | |
narshu | 0:7583de124698 | 83 | #endif /* _RF12B_H */ |