RF24Audio.h

/**
 * @file RF24Audio.h
 *
 * Class declaration for RF24Audio Library
 *
 * RFAudio Library: by TMRh20 2011-2014
 */

#ifndef __RF24Audio_H__
#define __RF24Audio_H__

class RF24;

/**
 * @brief Arduino Realtime Audio Streaming library
 *
 * This class implements an Audio Streaming library using nRF24L01(+) radios driven
 * by the [Optimized RF24 library](https://github.com/TMRh20/RF24).
 */

class RF24Audio
{

public:
    /**
     * Setup the radio and radio identifier
     * @note Changing radioNum is only required if utilizing private node-to-node communication as
     * opposed to broadcasting to the entire radio group
     *
     * @code
     *	RF24 radio(48, 49);          // Initialize the radio driver
     *	RF24Audio rfAudio(radio, 0); // Initialize the audio driver
     * @endcode
     *
     * @param _radio   The underlying radio driver instance
     * @param radioNum The radio identifier
     */
	RF24Audio(RF24& _radio, byte radioNum);

    /**
     * Initialize the radio and audio library
     *
     * Generally called in setup to initialize the radio
     * @code
     *	rfAudio.begin();
     * @endcode
     */
	void begin();

    /**
     * Volume Control
     * @code
     * rfAudio.volume(1); // Raise the volume
     * @endcode
     * @param upDn Set 0 to lower volume, 1 to raise volume
     *
     */
	void volume(bool upDn);

    /**
     * Volume Control
     * @code
     * rfAudio.setVolume(4); // Set the volume to mid-level
     * @endcode
     * @param vol Set at 0 to 7 for range of volume control
     *
     */
	void setVolume(char vol);

    /**
     * Control transmission through code
     * @code
     * rfAudio.transmit(); // Begin realtime audio streaming
     * @endcode
     * Call this function to begin transmission
     *
     */
	void transmit();

    /**
     * Stop transmission through code
     * @code
     *	rfAudio.receive(); // Stop audio streaming
     * @endcode
     * Call this function to stop transmission
     *
     */
	void receive();

    /**
     * Control of Private or Public Communication
     *
     * Call this function to establish private communication between nodes
     * in a radio group, or to switch back to public transmission.
     * @note Using a radioID of 255 will disable private communication and broadcast to all nodes
     *
     * @code
     * rfAudio.broadcast(1); 	// Only transmit audio to radio number 1
     * rfAudio.broadcast(255);  // Transmit audio to all radios in the group
     * @endcode
     * @param radioID  Set the radioID of the radio to communicate privately with.
     */
	void broadcast(byte radioID);

    /**
     * Get any of the preset radio addresses
     *
     * Useful for listening nodes who wish to create private or additional radio groups
     * The library has 14 predefined radio addreses. All radios listen/write on the first
     * two addresses (0, 1), and engage a private channel based on the radio number.
     * Radio 0 listens on address 2, Radio 1 on address 3, etc.
     *
     * @code
     * uint64_t newAddress = rfAudio.getAddress(3);	// Gets the 3rd defined radio address
     *  OR
     * radio.openReadingPipe(0, rfAudio.getAddress(7)); // Listens on the 7th defined radio address
     * @endcode
     * @param addressNo  Numbers 0 through 14 to access any part of the defined address array
     * @return RadioAddress:  Returns the requested predefined radio address
     */
    uint64_t getAddress(byte addressNo);

    /**
    * Handle button inputs. Must be called regularly for button functionality
    */
    void handleButtons();
     
private:
	RF24& radio;
	void timerStart();
};

/**
 * Global helper function to RF24Audio::transmit(). Do not use this directly.
 * Use RF24Audio::transmit() instead of this function as RF24Audio needs to be
 * properly setup first.
 */
void TX();

/**
 * Global helper function to RF24Audio::receive(). Do not use this directly.
 * Use RF24Audio::receive() instead of this function as RF24Audio needs to be
 * properly setup first.
 */
void RX();

#endif // __RF24Audio_H__


/**
 * @example GettingStarted.ino
 * This sketch is intended to demonstrate the basic functionality of the audio library.
 */

/**
 * @example Minimal.ino
 * This sketch is intended to demonstrate the most basic functionality of the audio library.
 */

/**
 * @example PrivateChannels.ino
 * This sketch is demonstrates the use of private channels (node-to-node) in a multi-radio group.
 */

/**
 * @example PrivateGroups.ino
 * This sketch is demonstrates the use of private groups (node-to-custom_groups) in a multi-radio group.
 */

/**
 * @example USB_Audio.ino
 * This sketch is demonstrates how to interact with the audio library directly using the core
 * RF24 radio library: http://nRF24.github.io/RF24/
 */

/**
 * @page Setup Boards & Wiring
 * @section Board Wiring
 * This page displays different options for wiring/board configuration.
 *
 * @image html "images/NRF1.jpg" height=25% width=25%
 * 
 * Wiring diagram for DIY module connector. May not be needed depending on module:
 * @image html "images/RF24AudioBasic_LargeAntenna.jpg" height=45% width=45%
 * @image html "images/NRF2.jpg" height=20% width=20%
 * @image html "images/RF24AudioBasic_SmallAntenna.jpg" height=45% width=45%
 * Wiring diagram for SD streaming/multicast using TMRpcm library:
 * @image html "images/RF24Audio_FullSD.jpg" height=65% width=65%
 */