interfisch
/
rf24-pio
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

astyle -A1

This commit is contained in:
maniacbug 2011-06-04 16:01:43 -07:00
parent bec84a7907
commit 26c45e85a9
1 changed files with 394 additions and 394 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

788
RF24.h
View File

@ -1,6 +1,6 @@
/* /*
Copyright (C) 2011 James Coliz, Jr. <maniacbug@ymail.com> Copyright (C) 2011 James Coliz, Jr. <maniacbug@ymail.com>
This program is free software; you can redistribute it and/or This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License modify it under the terms of the GNU General Public License
version 2 as published by the Free Software Foundation. version 2 as published by the Free Software Foundation.
@ -17,427 +17,427 @@ typedef enum { RF24_CRC_8 = 0, RF24_CRC_16 } rf24_crclength_e;
/** /**
* Driver for nRF24L01(+) 2.4GHz Wireless Transceiver * Driver for nRF24L01(+) 2.4GHz Wireless Transceiver
*/ */
class RF24 class RF24
{ {
private: private:
uint8_t ce_pin; /**< "Chip Enable" pin, activates the RX or TX role */ uint8_t ce_pin; /**< "Chip Enable" pin, activates the RX or TX role */
uint8_t csn_pin; /**< SPI Chip select */ uint8_t csn_pin; /**< SPI Chip select */
uint8_t payload_size; /**< Fixed size of payloads */ uint8_t payload_size; /**< Fixed size of payloads */
boolean ack_payload_available; /**< Whether there is an ack payload waiting */ boolean ack_payload_available; /**< Whether there is an ack payload waiting */
uint8_t ack_payload_length; /**< Dynamic size of pending ack payload. Note: not used. */ uint8_t ack_payload_length; /**< Dynamic size of pending ack payload. Note: not used. */
uint64_t pipe0_reading_address; /**< Last address set on pipe 0 for reading. */ uint64_t pipe0_reading_address; /**< Last address set on pipe 0 for reading. */
protected: protected:
/** /**
* @name Low-level internal interface. * @name Low-level internal interface.
* *
* Protected methods that address the chip directly. Regular users cannot * Protected methods that address the chip directly. Regular users cannot
* ever call these. They are documented for completeness and for developers who * ever call these. They are documented for completeness and for developers who
* may want to extend this class. * may want to extend this class.
*/ */
/**@{*/ /**@{*/
/** /**
* Set chip select pin * Set chip select pin
* *
* @param mode HIGH to take this unit off the SPI bus, LOW to put it on * @param mode HIGH to take this unit off the SPI bus, LOW to put it on
*/ */
void csn(int mode) ; void csn(int mode) ;
/** /**
* Set chip enable * Set chip enable
* *
* @param mode HIGH to actively begin transmission or LOW to put in standby. Please see data sheet * @param mode HIGH to actively begin transmission or LOW to put in standby. Please see data sheet
* for a much more detailed description of this pin. * for a much more detailed description of this pin.
*/ */
void ce(int mode); void ce(int mode);
/** /**
* Read a chunk of data in from a register * Read a chunk of data in from a register
* *
* @param reg Which register. Use constants from nRF24L01.h * @param reg Which register. Use constants from nRF24L01.h
* @param buf Where to put the data * @param buf Where to put the data
* @param len How many bytes of data to transfer * @param len How many bytes of data to transfer
* @return Current value of status register * @return Current value of status register
*/ */
uint8_t read_register(uint8_t reg, uint8_t* buf, uint8_t len) ; uint8_t read_register(uint8_t reg, uint8_t* buf, uint8_t len) ;
/**
* Read single byte from a register
*
* @param reg Which register. Use constants from nRF24L01.h
* @return Current value of register @p reg
*/
uint8_t read_register(uint8_t reg);
/** /**
* Write a chunk of data to a register * Read single byte from a register
* *
* @param reg Which register. Use constants from nRF24L01.h * @param reg Which register. Use constants from nRF24L01.h
* @param buf Where to get the data * @return Current value of register @p reg
* @param len How many bytes of data to transfer */
* @return Current value of status register uint8_t read_register(uint8_t reg);
*/
uint8_t write_register(uint8_t reg, const uint8_t* buf, uint8_t len);
/** /**
* Write a single byte to a register * Write a chunk of data to a register
* *
* @param reg Which register. Use constants from nRF24L01.h * @param reg Which register. Use constants from nRF24L01.h
* @param value The new value to write * @param buf Where to get the data
* @return Current value of status register * @param len How many bytes of data to transfer
*/ * @return Current value of status register
uint8_t write_register(uint8_t reg, uint8_t value); */
uint8_t write_register(uint8_t reg, const uint8_t* buf, uint8_t len);
/** /**
* Write the transmit payload * Write a single byte to a register
* *
* The size of data written is the fixed payload size, see getPayloadSize() * @param reg Which register. Use constants from nRF24L01.h
* * @param value The new value to write
* @param buf Where to get the data * @return Current value of status register
* @param len Number of bytes to be sent */
* @return Current value of status register uint8_t write_register(uint8_t reg, uint8_t value);
*/
uint8_t write_payload(const void* buf, uint8_t len);
/** /**
* Read the receive payload * Write the transmit payload
* *
* The size of data read is the fixed payload size, see getPayloadSize() * The size of data written is the fixed payload size, see getPayloadSize()
* *
* @param buf Where to put the data * @param buf Where to get the data
* @param len Maximum number of bytes to read * @param len Number of bytes to be sent
* @return Current value of status register * @return Current value of status register
*/ */
uint8_t read_payload(void* buf, uint8_t len) ; uint8_t write_payload(const void* buf, uint8_t len);
/** /**
* Read the payload length * Read the receive payload
* *
* For dynamic payloads, this pulls the size of the payload off * The size of data read is the fixed payload size, see getPayloadSize()
* the chip *
* * @param buf Where to put the data
* @return Payload length of last-received dynamic payload * @param len Maximum number of bytes to read
*/ * @return Current value of status register
uint8_t read_payload_length(void); */
uint8_t read_payload(void* buf, uint8_t len) ;
/**
* Empty the receive buffer
*
* @return Current value of status register
*/
uint8_t flush_rx(void);
/**
* Empty the transmit buffer
*
* @return Current value of status register
*/
uint8_t flush_tx(void);
/** /**
* Retrieve the current status of the chip * Read the payload length
* *
* @return Current value of status register * For dynamic payloads, this pulls the size of the payload off
*/ * the chip
uint8_t get_status(void) ; *
* @return Payload length of last-received dynamic payload
*/
uint8_t read_payload_length(void);
/** /**
* Decode and print the given status to stdout * Empty the receive buffer
* *
* @param status Status value to print * @return Current value of status register
* */
* @warning Does nothing if stdout is not defined. See fdevopen in stdio.h uint8_t flush_rx(void);
*/
void print_status(uint8_t status) ;
/** /**
* Decode and print the given 'observe_tx' value to stdout * Empty the transmit buffer
* *
* @param value The observe_tx value to print * @return Current value of status register
* */
* @warning Does nothing if stdout is not defined. See fdevopen in stdio.h uint8_t flush_tx(void);
*/
void print_observe_tx(uint8_t value) ;
/** /**
* Turn on or off the special features of the chip * Retrieve the current status of the chip
* *
* The chip has certain 'features' which are only available when the 'features' * @return Current value of status register
* are enabled. See the datasheet for details. */
*/ uint8_t get_status(void) ;
void toggle_features(void);
/**@}*/ /**
* Decode and print the given status to stdout
*
* @param status Status value to print
*
* @warning Does nothing if stdout is not defined. See fdevopen in stdio.h
*/
void print_status(uint8_t status) ;
/**
* Decode and print the given 'observe_tx' value to stdout
*
* @param value The observe_tx value to print
*
* @warning Does nothing if stdout is not defined. See fdevopen in stdio.h
*/
void print_observe_tx(uint8_t value) ;
/**
* Turn on or off the special features of the chip
*
* The chip has certain 'features' which are only available when the 'features'
* are enabled. See the datasheet for details.
*/
void toggle_features(void);
/**@}*/
public: public:
/** /**
* @name Primary public interface * @name Primary public interface
* *
* These are the main methods you need to operate the chip * These are the main methods you need to operate the chip
*/ */
/**@{*/ /**@{*/
/** /**
* Constructor * Constructor
* *
* Creates a new instance of this driver. Before using, you create an instance * Creates a new instance of this driver. Before using, you create an instance
* and send in the unique pins that this chip is connected to. * and send in the unique pins that this chip is connected to.
* *
* @param _cepin The pin attached to Chip Enable on the RF module * @param _cepin The pin attached to Chip Enable on the RF module
* @param _cspin The pin attached to Chip Select * @param _cspin The pin attached to Chip Select
*/ */
RF24(uint8_t _cepin, uint8_t _cspin); RF24(uint8_t _cepin, uint8_t _cspin);
/** /**
* Begin operation of the chip * Begin operation of the chip
* *
* Call this in setup(), before calling any other methods. * Call this in setup(), before calling any other methods.
*/ */
void begin(void); void begin(void);
/** /**
* Start listening on the pipes opened for reading. * Start listening on the pipes opened for reading.
* *
* Be sure to call openReadingPipe() first. Do not call write() while * Be sure to call openReadingPipe() first. Do not call write() while
* in this mode, without first calling stopListening(). Call * in this mode, without first calling stopListening(). Call
* isAvailable() to check for incoming traffic, and read() to get it. * isAvailable() to check for incoming traffic, and read() to get it.
*/ */
void startListening(void); void startListening(void);
/** /**
* Stop listening for incoming messages * Stop listening for incoming messages
* *
* Do this before calling write(). * Do this before calling write().
*/ */
void stopListening(void); void stopListening(void);
/** /**
* Write to the open writing pipe * Write to the open writing pipe
* *
* Be sure to call openWritingPipe() first to set the destination * Be sure to call openWritingPipe() first to set the destination
* of where to write to. * of where to write to.
* *
* This blocks until the message is successfully acknowledged by * This blocks until the message is successfully acknowledged by
* the receiver or the timeout/retransmit maxima are reached. In * the receiver or the timeout/retransmit maxima are reached. In
* the current configuration, the max delay here is 60ms. * the current configuration, the max delay here is 60ms.
* *
* The maximum size of data written is the fixed payload size, see * The maximum size of data written is the fixed payload size, see
* getPayloadSize(). However, you can write less, and the remainder * getPayloadSize(). However, you can write less, and the remainder
* will just be filled with zeroes. * will just be filled with zeroes.
* *
* @param buf Pointer to the data to be sent * @param buf Pointer to the data to be sent
* @param len Number of bytes to be sent * @param len Number of bytes to be sent
* @return True if the payload was delivered successfully false if not * @return True if the payload was delivered successfully false if not
*/ */
boolean write( const void* buf, uint8_t len ); boolean write( const void* buf, uint8_t len );
/** /**
* Test whether there are bytes available to be read * Test whether there are bytes available to be read
* *
* @return True if there is a payload available, false if none is * @return True if there is a payload available, false if none is
*/ */
boolean available(void) ; boolean available(void) ;
/** /**
* Read the payload * Read the payload
* *
* Return the last payload received * Return the last payload received
* *
* The size of data read is the fixed payload size, see getPayloadSize() * The size of data read is the fixed payload size, see getPayloadSize()
* *
* @note I specifically chose 'void*' as a data type to make it easier * @note I specifically chose 'void*' as a data type to make it easier
* for beginners to use. No casting needed. * for beginners to use. No casting needed.
* *
* @param buf Pointer to a buffer where the data should be written * @param buf Pointer to a buffer where the data should be written
* @param len Maximum number of bytes to read into the buffer * @param len Maximum number of bytes to read into the buffer
* @return True if the payload was delivered successfully false if not * @return True if the payload was delivered successfully false if not
*/ */
boolean read( void* buf, uint8_t len ) ; boolean read( void* buf, uint8_t len ) ;
/** /**
* Open a pipe for writing * Open a pipe for writing
* *
* Only one pipe can be open at once, but you can change the pipe * Only one pipe can be open at once, but you can change the pipe
* you'll listen to. Do not call this while actively listening. * you'll listen to. Do not call this while actively listening.
* Remember to stopListening() first. * Remember to stopListening() first.
* *
* Addresses are 40-bit hex values, e.g.: * Addresses are 40-bit hex values, e.g.:
* *
* @code * @code
* openWritingPipe(0xF0F0F0F0F0); * openWritingPipe(0xF0F0F0F0F0);
* @endcode * @endcode
* *
* @param address The 40-bit address of the pipe to open. This can be * @param address The 40-bit address of the pipe to open. This can be
* any value whatsoever, as long as you are the only one writing to it * any value whatsoever, as long as you are the only one writing to it
* and only one other radio is listening to it. Coordinate these pipe * and only one other radio is listening to it. Coordinate these pipe
* addresses amongst nodes on the network. * addresses amongst nodes on the network.
*/ */
void openWritingPipe(uint64_t address); void openWritingPipe(uint64_t address);
/** /**
* Open a pipe for reading * Open a pipe for reading
* *
* Up to 5 pipes can be open for reading at once. Open all the * Up to 5 pipes can be open for reading at once. Open all the
* reading pipes, and then call startListening(). * reading pipes, and then call startListening().
* *
* @see openWritingPipe * @see openWritingPipe
* *
* @warning Pipes 1-5 should share the first 32 bits. * @warning Pipes 1-5 should share the first 32 bits.
* Only the least significant byte should be unique, e.g. * Only the least significant byte should be unique, e.g.
* *
* @code * @code
* openReadingPipe(1,0xF0F0F0F0AA); * openReadingPipe(1,0xF0F0F0F0AA);
* openReadingPipe(2,0xF0F0F0F066); * openReadingPipe(2,0xF0F0F0F066);
* @endcode * @endcode
* *
* @todo Enforce the restriction that pipes 1-5 must share the top 32 bits * @todo Enforce the restriction that pipes 1-5 must share the top 32 bits
* *
* @param number Which pipe# to open, 0-5. * @param number Which pipe# to open, 0-5.
* @param address The 40-bit address of the pipe to open. * @param address The 40-bit address of the pipe to open.
*/ */
void openReadingPipe(uint8_t number, uint64_t address); void openReadingPipe(uint8_t number, uint64_t address);
/**@}*/ /**@}*/
/** /**
* @name Optional public interface * @name Optional public interface
* *
* Methods you may want to use but are not needed for regular operation * Methods you may want to use but are not needed for regular operation
*/ */
/**@{*/ /**@{*/
/** /**
* Set RF communication channel * Set RF communication channel
* *
* @param channel Which RF channel to communicate on, 0-127 * @param channel Which RF channel to communicate on, 0-127
*/ */
void setChannel(uint8_t channel); void setChannel(uint8_t channel);
/** /**
* Set Payload Size * Set Payload Size
* *
* This implementation uses a pre-stablished fixed payload size for all * This implementation uses a pre-stablished fixed payload size for all
* transmissions. If this method is never called, the driver will always * transmissions. If this method is never called, the driver will always
* transmit the maximum payload size (32 bytes), no matter how much * transmit the maximum payload size (32 bytes), no matter how much
* was sent to write(). * was sent to write().
* *
* @todo Implement variable-sized payloads feature * @todo Implement variable-sized payloads feature
* *
* @param size The number of bytes in the payload * @param size The number of bytes in the payload
*/ */
void setPayloadSize(uint8_t size); void setPayloadSize(uint8_t size);
/** /**
* Get Payload Size * Get Payload Size
* *
* @see setPayloadSize() * @see setPayloadSize()
* *
* @return The number of bytes in the payload * @return The number of bytes in the payload
*/ */
uint8_t getPayloadSize(void) ; uint8_t getPayloadSize(void) ;
/** /**
* Print a giant block of debugging information to stdout * Print a giant block of debugging information to stdout
* *
* @warning Does nothing if stdout is not defined. See fdevopen in stdio.h * @warning Does nothing if stdout is not defined. See fdevopen in stdio.h
*/ */
void printDetails(void) ; void printDetails(void) ;
/**
* Enter low-power mode
*
* To return to normal power mode, either write() some data or
* startListening().
*/
void powerDown(void);
/** /**
* Test whether there are bytes available to be read * Enter low-power mode
* *
* Use this version to discover on which pipe the message * To return to normal power mode, either write() some data or
* arrived. * startListening().
* */
* @param[out] pipe_num Which pipe has the payload available void powerDown(void);
* @return True if there is a payload available, false if none is
*/
boolean available(uint8_t* pipe_num);
/** /**
* Enable custom payloads on the acknowledge packets * Test whether there are bytes available to be read
* *
* Ack payloads are a handy way to return data back to senders without * Use this version to discover on which pipe the message
* manually changing the radio modes on both units. * arrived.
* *
* @see examples/pingpair_pl/pingpair_pl.pde * @param[out] pipe_num Which pipe has the payload available
*/ * @return True if there is a payload available, false if none is
void enableAckPayload(void); */
boolean available(uint8_t* pipe_num);
/** /**
* Write an ack payload for the specified pipe * Enable custom payloads on the acknowledge packets
* *
* The next time a message is received on @p pipe, the data in @p buf will * Ack payloads are a handy way to return data back to senders without
* be sent back in the acknowledgement. * manually changing the radio modes on both units.
* *
* @warning According to the data sheet, only three of these can be pending * @see examples/pingpair_pl/pingpair_pl.pde
* at any time. I have not tested this. */
* void enableAckPayload(void);
* @param pipe Which pipe# (typically 1-5) will get this response.
* @param buf Pointer to data that is sent
* @param len Length of the data to send, up to 32 bytes max. Not affected
* by the static payload set by setPayloadSize().
*/
void writeAckPayload(uint8_t pipe, const void* buf, uint8_t len);
/** /**
* Determine if an ack payload was received in the most recent call to * Write an ack payload for the specified pipe
* write(). *
* * The next time a message is received on @p pipe, the data in @p buf will
* Call read() to retrieve the ack payload. * be sent back in the acknowledgement.
* *
* @warning Calling this function clears the internal flag which indicates * @warning According to the data sheet, only three of these can be pending
* a payload is available. If it returns true, you must read the packet * at any time. I have not tested this.
* out as the very next interaction with the radio, or the results are *
* undefined. * @param pipe Which pipe# (typically 1-5) will get this response.
* * @param buf Pointer to data that is sent
* @return True if an ack payload is available. * @param len Length of the data to send, up to 32 bytes max. Not affected
*/ * by the static payload set by setPayloadSize().
boolean isAckPayloadAvailable(void); */
void writeAckPayload(uint8_t pipe, const void* buf, uint8_t len);
/** /**
* Enable or disable auto-acknowlede packets * Determine if an ack payload was received in the most recent call to
* * write().
* This is enabled by default, so it's only needed if you want to turn *
* it off for some reason. * Call read() to retrieve the ack payload.
* *
* @param enable Whether to enable (true) or disable (false) auto-acks * @warning Calling this function clears the internal flag which indicates
*/ * a payload is available. If it returns true, you must read the packet
void setAutoAck(bool enable); * out as the very next interaction with the radio, or the results are
* undefined.
*
* @return True if an ack payload is available.
*/
boolean isAckPayloadAvailable(void);
/** /**
* Test whether there was a carrier on the line for the * Enable or disable auto-acknowlede packets
* previous listening period. *
* * This is enabled by default, so it's only needed if you want to turn
* Useful to check for interference on the current channel. * it off for some reason.
* *
* @return true if was carrier, false if not * @param enable Whether to enable (true) or disable (false) auto-acks
*/ */
boolean testCarrier(void); void setAutoAck(bool enable);
/** /**
* Set the transmission data rate * Test whether there was a carrier on the line for the
* * previous listening period.
* @param speed RF24_1MBPS for 1Mbps or RF24_2MBPS for 2Mbps *
*/ * Useful to check for interference on the current channel.
void setDataRate(rf24_datarate_e speed); *
* @return true if was carrier, false if not
/** */
* Set the CRC length boolean testCarrier(void);
*
* @param length RF24_CRC_8 for 8-bit or RF24_CRC_16 for 16-bit /**
*/ * Set the transmission data rate
void setCRCLength(rf24_crclength_e length); *
* @param speed RF24_1MBPS for 1Mbps or RF24_2MBPS for 2Mbps
/**@}*/ */
void setDataRate(rf24_datarate_e speed);
/**
* Set the CRC length
*
* @param length RF24_CRC_8 for 8-bit or RF24_CRC_16 for 16-bit
*/
void setCRCLength(rf24_crclength_e length);
/**@}*/
}; };
/** /**
@ -452,8 +452,8 @@ public:
/** /**
* @example pingpair.pde * @example pingpair.pde
* *
* This is an example of how to use the RF24 class. Write this sketch to two * This is an example of how to use the RF24 class. Write this sketch to two
* different nodes, connect the role_pin to ground on one. The ping node sends * different nodes, connect the role_pin to ground on one. The ping node sends
* the current time to the pong node, which responds by sending the value back. * the current time to the pong node, which responds by sending the value back.
* The ping node can then see how long the whole cycle took. * The ping node can then see how long the whole cycle took.
@ -462,10 +462,10 @@ public:
/** /**
* @example starping.pde * @example starping.pde
* *
* This sketch is a more complex example of using the RF24 library for Arduino. * This sketch is a more complex example of using the RF24 library for Arduino.
* Deploy this on up to six nodes. Set one as the 'pong receiver' by tying the * Deploy this on up to six nodes. Set one as the 'pong receiver' by tying the
* role_pin low, and the others will be 'ping transmit' units. The ping units * role_pin low, and the others will be 'ping transmit' units. The ping units
* unit will send out the value of millis() once a second. The pong unit will * unit will send out the value of millis() once a second. The pong unit will
* respond back with a copy of the value. Each ping unit can get that response * respond back with a copy of the value. Each ping unit can get that response
* back, and determine how long the whole cycle took. * back, and determine how long the whole cycle took.
* *
@ -475,16 +475,16 @@ public:
*/ */
/** /**
* @example pingpair_pl.pde * @example pingpair_pl.pde
* *
* This is an example of how to do two-way communication without changing * This is an example of how to do two-way communication without changing
* transmit/receive modes. Here, a payload is set to the transmitter within * transmit/receive modes. Here, a payload is set to the transmitter within
* the Ack packet of each transmission. Note that the payload is set BEFORE * the Ack packet of each transmission. Note that the payload is set BEFORE
* the sender's message arrives. * the sender's message arrives.
*/ */
/** /**
* @example pingpair_sleepy.pde * @example pingpair_sleepy.pde
* *
* This is an example of how to use the RF24 class to create a battery- * This is an example of how to use the RF24 class to create a battery-
* efficient system. It is just like the pingpair.pde example, but the * efficient system. It is just like the pingpair.pde example, but the
@ -495,7 +495,7 @@ public:
/** /**
* @example starping_relay.pde * @example starping_relay.pde
* *
* This sketch is a very complex example of using the RF24 library for Arduino. * This sketch is a very complex example of using the RF24 library for Arduino.
* Deploy this on any number of nodes to create a basic mesh network. I have * Deploy this on any number of nodes to create a basic mesh network. I have
* tested this on 6 nodes, but it should work on many more. 'Leaf' nodes attempt * tested this on 6 nodes, but it should work on many more. 'Leaf' nodes attempt
* to send a ping every 2 seconds to the 'Base' node. Optional 'Relay' nodes * to send a ping every 2 seconds to the 'Base' node. Optional 'Relay' nodes
@ -503,7 +503,7 @@ public:
*/ */
/** /**
* @example scanner.pde * @example scanner.pde
* *
* Example to detect interference on the various channels available. * Example to detect interference on the various channels available.
* This is a good diagnostic tool to check whether you're picking a * This is a good diagnostic tool to check whether you're picking a