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