MGAS_GR_Peach - This is the final version of Mini Gateway for Aut…

Users » vipinranka » Code » MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies: GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

RF24/RF24.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:: vipinranka
Date:: Wed Jan 11 11:41:30 2017 +0000
Revision:: 12:9a20164dcc47

This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

User	Revision	Line number	New contents of line
vipinranka	12:9a20164dcc47	1	/*
vipinranka	12:9a20164dcc47	2	Copyright (C) 2011 J. Coliz <maniacbug@ymail.com>
vipinranka	12:9a20164dcc47	3
vipinranka	12:9a20164dcc47	4	This program is free software; you can redistribute it and/or
vipinranka	12:9a20164dcc47	5	modify it under the terms of the GNU General Public License
vipinranka	12:9a20164dcc47	6	version 2 as published by the Free Software Foundation.
vipinranka	12:9a20164dcc47	7	*/
vipinranka	12:9a20164dcc47	8
vipinranka	12:9a20164dcc47	9	/**
vipinranka	12:9a20164dcc47	10	* @file RF24.h
vipinranka	12:9a20164dcc47	11	*
vipinranka	12:9a20164dcc47	12	* Class declaration for RF24 and helper enums
vipinranka	12:9a20164dcc47	13	*/
vipinranka	12:9a20164dcc47	14
vipinranka	12:9a20164dcc47	15	/*
vipinranka	12:9a20164dcc47	16	* Mbed support added by Akash Vibhute <akash.roboticist@gmail.com>
vipinranka	12:9a20164dcc47	17	* Porting completed on Nov/05/2015
vipinranka	12:9a20164dcc47	18	*
vipinranka	12:9a20164dcc47	19	* Updated 1: Synced with TMRh20's RF24 library on Nov/04/2015 from https://github.com/TMRh20
vipinranka	12:9a20164dcc47	20	* Updated 2: Synced with TMRh20's RF24 library on Apr/18/2015 from https://github.com/TMRh20
vipinranka	12:9a20164dcc47	21	*
vipinranka	12:9a20164dcc47	22	*/
vipinranka	12:9a20164dcc47	23
vipinranka	12:9a20164dcc47	24	#ifndef __RF24_H__
vipinranka	12:9a20164dcc47	25	#define __RF24_H__
vipinranka	12:9a20164dcc47	26
vipinranka	12:9a20164dcc47	27	#include "RF24_config.h"
vipinranka	12:9a20164dcc47	28	#include <mbed.h>
vipinranka	12:9a20164dcc47	29
vipinranka	12:9a20164dcc47	30
vipinranka	12:9a20164dcc47	31
vipinranka	12:9a20164dcc47	32
vipinranka	12:9a20164dcc47	33
vipinranka	12:9a20164dcc47	34
vipinranka	12:9a20164dcc47	35	/**
vipinranka	12:9a20164dcc47	36	* Power Amplifier level.
vipinranka	12:9a20164dcc47	37	*
vipinranka	12:9a20164dcc47	38	* For use with setPALevel()
vipinranka	12:9a20164dcc47	39	*/
vipinranka	12:9a20164dcc47	40	typedef enum { RF24_PA_MIN = 0,RF24_PA_LOW, RF24_PA_HIGH, RF24_PA_MAX, RF24_PA_ERROR } rf24_pa_dbm_e ;
vipinranka	12:9a20164dcc47	41
vipinranka	12:9a20164dcc47	42	/**
vipinranka	12:9a20164dcc47	43	* Data rate. How fast data moves through the air.
vipinranka	12:9a20164dcc47	44	*
vipinranka	12:9a20164dcc47	45	* For use with setDataRate()
vipinranka	12:9a20164dcc47	46	*/
vipinranka	12:9a20164dcc47	47	typedef enum { RF24_1MBPS = 0, RF24_2MBPS, RF24_250KBPS } rf24_datarate_e;
vipinranka	12:9a20164dcc47	48
vipinranka	12:9a20164dcc47	49	/**
vipinranka	12:9a20164dcc47	50	* CRC Length. How big (if any) of a CRC is included.
vipinranka	12:9a20164dcc47	51	*
vipinranka	12:9a20164dcc47	52	* For use with setCRCLength()
vipinranka	12:9a20164dcc47	53	*/
vipinranka	12:9a20164dcc47	54	typedef enum { RF24_CRC_DISABLED = 0, RF24_CRC_8, RF24_CRC_16 } rf24_crclength_e;
vipinranka	12:9a20164dcc47	55
vipinranka	12:9a20164dcc47	56	/**
vipinranka	12:9a20164dcc47	57	* Driver for nRF24L01(+) 2.4GHz Wireless Transceiver
vipinranka	12:9a20164dcc47	58	*/
vipinranka	12:9a20164dcc47	59
vipinranka	12:9a20164dcc47	60	class RF24
vipinranka	12:9a20164dcc47	61	{
vipinranka	12:9a20164dcc47	62	private:
vipinranka	12:9a20164dcc47	63
vipinranka	12:9a20164dcc47	64
vipinranka	12:9a20164dcc47	65
vipinranka	12:9a20164dcc47	66
vipinranka	12:9a20164dcc47	67
vipinranka	12:9a20164dcc47	68
vipinranka	12:9a20164dcc47	69
vipinranka	12:9a20164dcc47	70
vipinranka	12:9a20164dcc47	71
vipinranka	12:9a20164dcc47	72
vipinranka	12:9a20164dcc47	73
vipinranka	12:9a20164dcc47	74
vipinranka	12:9a20164dcc47	75
vipinranka	12:9a20164dcc47	76	DigitalOut ce_pin; /*< "Chip Enable" pin, activates the RX or TX role /
vipinranka	12:9a20164dcc47	77	DigitalOut csn_pin; /*< SPI Chip select /
vipinranka	12:9a20164dcc47	78	uint16_t spi_speed; /*< SPI Bus Speed /
vipinranka	12:9a20164dcc47	79
vipinranka	12:9a20164dcc47	80	SPI spi;
vipinranka	12:9a20164dcc47	81	Timer mainTimer;
vipinranka	12:9a20164dcc47	82
vipinranka	12:9a20164dcc47	83	bool p_variant; /* False for RF24L01 and true for RF24L01P */
vipinranka	12:9a20164dcc47	84	uint8_t payload_size; /*< Fixed size of payloads /
vipinranka	12:9a20164dcc47	85	bool dynamic_payloads_enabled; /*< Whether dynamic payloads are enabled. /
vipinranka	12:9a20164dcc47	86	uint8_t pipe0_reading_address[5]; /*< Last address set on pipe 0 for reading. /
vipinranka	12:9a20164dcc47	87	uint8_t addr_width; /*< The address width to use - 3,4 or 5 bytes. /
vipinranka	12:9a20164dcc47	88	uint32_t txRxDelay; /*< Var for adjusting delays depending on datarate /
vipinranka	12:9a20164dcc47	89
vipinranka	12:9a20164dcc47	90
vipinranka	12:9a20164dcc47	91	protected:
vipinranka	12:9a20164dcc47	92	/**
vipinranka	12:9a20164dcc47	93	* SPI transactions
vipinranka	12:9a20164dcc47	94	*
vipinranka	12:9a20164dcc47	95	* Common code for SPI transactions including CSN toggle
vipinranka	12:9a20164dcc47	96	*
vipinranka	12:9a20164dcc47	97	*/
vipinranka	12:9a20164dcc47	98	inline void beginTransaction();
vipinranka	12:9a20164dcc47	99
vipinranka	12:9a20164dcc47	100	inline void endTransaction();
vipinranka	12:9a20164dcc47	101
vipinranka	12:9a20164dcc47	102	public:
vipinranka	12:9a20164dcc47	103
vipinranka	12:9a20164dcc47	104	/**
vipinranka	12:9a20164dcc47	105	* @name Primary public interface
vipinranka	12:9a20164dcc47	106	*
vipinranka	12:9a20164dcc47	107	* These are the main methods you need to operate the chip
vipinranka	12:9a20164dcc47	108	*/
vipinranka	12:9a20164dcc47	109	/*@{/
vipinranka	12:9a20164dcc47	110
vipinranka	12:9a20164dcc47	111	/**
vipinranka	12:9a20164dcc47	112	* Arduino Constructor
vipinranka	12:9a20164dcc47	113	*
vipinranka	12:9a20164dcc47	114	* Creates a new instance of this driver. Before using, you create an instance
vipinranka	12:9a20164dcc47	115	* and send in the unique pins that this chip is connected to.
vipinranka	12:9a20164dcc47	116	*
vipinranka	12:9a20164dcc47	117	* @param _cepin The pin attached to Chip Enable on the RF module
vipinranka	12:9a20164dcc47	118	* @param _cspin The pin attached to Chip Select
vipinranka	12:9a20164dcc47	119	*/
vipinranka	12:9a20164dcc47	120	RF24(PinName mosi, PinName miso, PinName sck, PinName _cepin, PinName _csnpin);
vipinranka	12:9a20164dcc47	121
vipinranka	12:9a20164dcc47	122
vipinranka	12:9a20164dcc47	123
vipinranka	12:9a20164dcc47	124
vipinranka	12:9a20164dcc47	125
vipinranka	12:9a20164dcc47	126
vipinranka	12:9a20164dcc47	127
vipinranka	12:9a20164dcc47	128
vipinranka	12:9a20164dcc47	129
vipinranka	12:9a20164dcc47	130
vipinranka	12:9a20164dcc47	131
vipinranka	12:9a20164dcc47	132
vipinranka	12:9a20164dcc47	133
vipinranka	12:9a20164dcc47	134
vipinranka	12:9a20164dcc47	135
vipinranka	12:9a20164dcc47	136
vipinranka	12:9a20164dcc47	137
vipinranka	12:9a20164dcc47	138
vipinranka	12:9a20164dcc47	139
vipinranka	12:9a20164dcc47	140
vipinranka	12:9a20164dcc47	141	/**
vipinranka	12:9a20164dcc47	142	* Begin operation of the chip
vipinranka	12:9a20164dcc47	143	*
vipinranka	12:9a20164dcc47	144	* Call this in setup(), before calling any other methods.
vipinranka	12:9a20164dcc47	145	* @code radio.begin() @endcode
vipinranka	12:9a20164dcc47	146	*/
vipinranka	12:9a20164dcc47	147	bool begin(void);
vipinranka	12:9a20164dcc47	148
vipinranka	12:9a20164dcc47	149	/**
vipinranka	12:9a20164dcc47	150	* Start listening on the pipes opened for reading.
vipinranka	12:9a20164dcc47	151	*
vipinranka	12:9a20164dcc47	152	* 1. Be sure to call openReadingPipe() first.
vipinranka	12:9a20164dcc47	153	* 2. Do not call write() while in this mode, without first calling stopListening().
vipinranka	12:9a20164dcc47	154	* 3. Call available() to check for incoming traffic, and read() to get it.
vipinranka	12:9a20164dcc47	155	*
vipinranka	12:9a20164dcc47	156	* @code
vipinranka	12:9a20164dcc47	157	* Open reading pipe 1 using address CCCECCCECC
vipinranka	12:9a20164dcc47	158	*
vipinranka	12:9a20164dcc47	159	* byte address[] = { 0xCC,0xCE,0xCC,0xCE,0xCC };
vipinranka	12:9a20164dcc47	160	* radio.openReadingPipe(1,address);
vipinranka	12:9a20164dcc47	161	* radio.startListening();
vipinranka	12:9a20164dcc47	162	* @endcode
vipinranka	12:9a20164dcc47	163	*/
vipinranka	12:9a20164dcc47	164	void startListening(void);
vipinranka	12:9a20164dcc47	165
vipinranka	12:9a20164dcc47	166	/**
vipinranka	12:9a20164dcc47	167	* Stop listening for incoming messages, and switch to transmit mode.
vipinranka	12:9a20164dcc47	168	*
vipinranka	12:9a20164dcc47	169	* Do this before calling write().
vipinranka	12:9a20164dcc47	170	* @code
vipinranka	12:9a20164dcc47	171	* radio.stopListening();
vipinranka	12:9a20164dcc47	172	* radio.write(&data,sizeof(data));
vipinranka	12:9a20164dcc47	173	* @endcode
vipinranka	12:9a20164dcc47	174	*/
vipinranka	12:9a20164dcc47	175	void stopListening(void);
vipinranka	12:9a20164dcc47	176
vipinranka	12:9a20164dcc47	177	/**
vipinranka	12:9a20164dcc47	178	* Check whether there are bytes available to be read
vipinranka	12:9a20164dcc47	179	* @code
vipinranka	12:9a20164dcc47	180	* if(radio.available()){
vipinranka	12:9a20164dcc47	181	* radio.read(&data,sizeof(data));
vipinranka	12:9a20164dcc47	182	* }
vipinranka	12:9a20164dcc47	183	* @endcode
vipinranka	12:9a20164dcc47	184	* @return True if there is a payload available, false if none is
vipinranka	12:9a20164dcc47	185	*/
vipinranka	12:9a20164dcc47	186	bool available(void);
vipinranka	12:9a20164dcc47	187
vipinranka	12:9a20164dcc47	188	/**
vipinranka	12:9a20164dcc47	189	* Read the available payload
vipinranka	12:9a20164dcc47	190	*
vipinranka	12:9a20164dcc47	191	* The size of data read is the fixed payload size, see getPayloadSize()
vipinranka	12:9a20164dcc47	192	*
vipinranka	12:9a20164dcc47	193	* @note I specifically chose 'void*' as a data type to make it easier
vipinranka	12:9a20164dcc47	194	* for beginners to use. No casting needed.
vipinranka	12:9a20164dcc47	195	*
vipinranka	12:9a20164dcc47	196	* @note No longer boolean. Use available to determine if packets are
vipinranka	12:9a20164dcc47	197	* available. Interrupt flags are now cleared during reads instead of
vipinranka	12:9a20164dcc47	198	* when calling available().
vipinranka	12:9a20164dcc47	199	*
vipinranka	12:9a20164dcc47	200	* @param buf Pointer to a buffer where the data should be written
vipinranka	12:9a20164dcc47	201	* @param len Maximum number of bytes to read into the buffer
vipinranka	12:9a20164dcc47	202	*
vipinranka	12:9a20164dcc47	203	* @code
vipinranka	12:9a20164dcc47	204	* if(radio.available()){
vipinranka	12:9a20164dcc47	205	* radio.read(&data,sizeof(data));
vipinranka	12:9a20164dcc47	206	* }
vipinranka	12:9a20164dcc47	207	* @endcode
vipinranka	12:9a20164dcc47	208	* @return No return value. Use available().
vipinranka	12:9a20164dcc47	209	*/
vipinranka	12:9a20164dcc47	210	void read( void* buf, uint8_t len );
vipinranka	12:9a20164dcc47	211
vipinranka	12:9a20164dcc47	212	/**
vipinranka	12:9a20164dcc47	213	* Be sure to call openWritingPipe() first to set the destination
vipinranka	12:9a20164dcc47	214	* of where to write to.
vipinranka	12:9a20164dcc47	215	*
vipinranka	12:9a20164dcc47	216	* This blocks until the message is successfully acknowledged by
vipinranka	12:9a20164dcc47	217	* the receiver or the timeout/retransmit maxima are reached. In
vipinranka	12:9a20164dcc47	218	* the current configuration, the max delay here is 60-70ms.
vipinranka	12:9a20164dcc47	219	*
vipinranka	12:9a20164dcc47	220	* The maximum size of data written is the fixed payload size, see
vipinranka	12:9a20164dcc47	221	* getPayloadSize(). However, you can write less, and the remainder
vipinranka	12:9a20164dcc47	222	* will just be filled with zeroes.
vipinranka	12:9a20164dcc47	223	*
vipinranka	12:9a20164dcc47	224	* TX/RX/RT interrupt flags will be cleared every time write is called
vipinranka	12:9a20164dcc47	225	*
vipinranka	12:9a20164dcc47	226	* @param buf Pointer to the data to be sent
vipinranka	12:9a20164dcc47	227	* @param len Number of bytes to be sent
vipinranka	12:9a20164dcc47	228	*
vipinranka	12:9a20164dcc47	229	* @code
vipinranka	12:9a20164dcc47	230	* radio.stopListening();
vipinranka	12:9a20164dcc47	231	* radio.write(&data,sizeof(data));
vipinranka	12:9a20164dcc47	232	* @endcode
vipinranka	12:9a20164dcc47	233	* @return True if the payload was delivered successfully false if not
vipinranka	12:9a20164dcc47	234	*/
vipinranka	12:9a20164dcc47	235	bool write( const void* buf, uint8_t len );
vipinranka	12:9a20164dcc47	236
vipinranka	12:9a20164dcc47	237	/**
vipinranka	12:9a20164dcc47	238	* New: Open a pipe for writing via byte array. Old addressing format retained
vipinranka	12:9a20164dcc47	239	* for compatibility.
vipinranka	12:9a20164dcc47	240	*
vipinranka	12:9a20164dcc47	241	* Only one writing pipe can be open at once, but you can change the address
vipinranka	12:9a20164dcc47	242	* you'll write to. Call stopListening() first.
vipinranka	12:9a20164dcc47	243	*
vipinranka	12:9a20164dcc47	244	* Addresses are assigned via a byte array, default is 5 byte address length
vipinranka	12:9a20164dcc47	245	s *
vipinranka	12:9a20164dcc47	246	* @code
vipinranka	12:9a20164dcc47	247	* uint8_t addresses[][6] = {"1Node","2Node"};
vipinranka	12:9a20164dcc47	248	* radio.openWritingPipe(addresses[0]);
vipinranka	12:9a20164dcc47	249	* @endcode
vipinranka	12:9a20164dcc47	250	* @code
vipinranka	12:9a20164dcc47	251	* uint8_t address[] = { 0xCC,0xCE,0xCC,0xCE,0xCC };
vipinranka	12:9a20164dcc47	252	* radio.openWritingPipe(address);
vipinranka	12:9a20164dcc47	253	* address[0] = 0x33;
vipinranka	12:9a20164dcc47	254	* radio.openReadingPipe(1,address);
vipinranka	12:9a20164dcc47	255	* @endcode
vipinranka	12:9a20164dcc47	256	* @see setAddressWidth
vipinranka	12:9a20164dcc47	257	*
vipinranka	12:9a20164dcc47	258	* @param address The address of the pipe to open. Coordinate these pipe
vipinranka	12:9a20164dcc47	259	* addresses amongst nodes on the network.
vipinranka	12:9a20164dcc47	260	*/
vipinranka	12:9a20164dcc47	261
vipinranka	12:9a20164dcc47	262	void openWritingPipe(const uint8_t *address);
vipinranka	12:9a20164dcc47	263
vipinranka	12:9a20164dcc47	264	/**
vipinranka	12:9a20164dcc47	265	* Open a pipe for reading
vipinranka	12:9a20164dcc47	266	*
vipinranka	12:9a20164dcc47	267	* Up to 6 pipes can be open for reading at once. Open all the required
vipinranka	12:9a20164dcc47	268	* reading pipes, and then call startListening().
vipinranka	12:9a20164dcc47	269	*
vipinranka	12:9a20164dcc47	270	* @see openWritingPipe
vipinranka	12:9a20164dcc47	271	* @see setAddressWidth
vipinranka	12:9a20164dcc47	272	*
vipinranka	12:9a20164dcc47	273	* @note Pipes 0 and 1 will store a full 5-byte address. Pipes 2-5 will technically
vipinranka	12:9a20164dcc47	274	* only store a single byte, borrowing up to 4 additional bytes from pipe #1 per the
vipinranka	12:9a20164dcc47	275	* assigned address width.
vipinranka	12:9a20164dcc47	276	* @warning Pipes 1-5 should share the same address, except the first byte.
vipinranka	12:9a20164dcc47	277	* Only the first byte in the array should be unique, e.g.
vipinranka	12:9a20164dcc47	278	* @code
vipinranka	12:9a20164dcc47	279	* uint8_t addresses[][6] = {"1Node","2Node"};
vipinranka	12:9a20164dcc47	280	* openReadingPipe(1,addresses[0]);
vipinranka	12:9a20164dcc47	281	* openReadingPipe(2,addresses[1]);
vipinranka	12:9a20164dcc47	282	* @endcode
vipinranka	12:9a20164dcc47	283	*
vipinranka	12:9a20164dcc47	284	* @warning Pipe 0 is also used by the writing pipe. So if you open
vipinranka	12:9a20164dcc47	285	* pipe 0 for reading, and then startListening(), it will overwrite the
vipinranka	12:9a20164dcc47	286	* writing pipe. Ergo, do an openWritingPipe() again before write().
vipinranka	12:9a20164dcc47	287	*
vipinranka	12:9a20164dcc47	288	* @param number Which pipe# to open, 0-5.
vipinranka	12:9a20164dcc47	289	* @param address The 24, 32 or 40 bit address of the pipe to open.
vipinranka	12:9a20164dcc47	290	*/
vipinranka	12:9a20164dcc47	291
vipinranka	12:9a20164dcc47	292	void openReadingPipe(uint8_t number, const uint8_t *address);
vipinranka	12:9a20164dcc47	293
vipinranka	12:9a20164dcc47	294	/*@}/
vipinranka	12:9a20164dcc47	295	/**
vipinranka	12:9a20164dcc47	296	* @name Advanced Operation
vipinranka	12:9a20164dcc47	297	*
vipinranka	12:9a20164dcc47	298	* Methods you can use to drive the chip in more advanced ways
vipinranka	12:9a20164dcc47	299	*/
vipinranka	12:9a20164dcc47	300	/*@{/
vipinranka	12:9a20164dcc47	301
vipinranka	12:9a20164dcc47	302	/**
vipinranka	12:9a20164dcc47	303	* Print a giant block of debugging information to stdout
vipinranka	12:9a20164dcc47	304	*
vipinranka	12:9a20164dcc47	305	* @warning Does nothing if stdout is not defined. See fdevopen in stdio.h
vipinranka	12:9a20164dcc47	306	* The printf.h file is included with the library for Arduino.
vipinranka	12:9a20164dcc47	307	* @code
vipinranka	12:9a20164dcc47	308	* #include <printf.h>
vipinranka	12:9a20164dcc47	309	* setup(){
vipinranka	12:9a20164dcc47	310	* Serial.begin(115200);
vipinranka	12:9a20164dcc47	311	* printf_begin();
vipinranka	12:9a20164dcc47	312	* ...
vipinranka	12:9a20164dcc47	313	* }
vipinranka	12:9a20164dcc47	314	* @endcode
vipinranka	12:9a20164dcc47	315	*/
vipinranka	12:9a20164dcc47	316	void printDetails(void);
vipinranka	12:9a20164dcc47	317
vipinranka	12:9a20164dcc47	318	/**
vipinranka	12:9a20164dcc47	319	* Test whether there are bytes available to be read in the
vipinranka	12:9a20164dcc47	320	* FIFO buffers.
vipinranka	12:9a20164dcc47	321	*
vipinranka	12:9a20164dcc47	322	* @param[out] pipe_num Which pipe has the payload available
vipinranka	12:9a20164dcc47	323	*
vipinranka	12:9a20164dcc47	324	* @code
vipinranka	12:9a20164dcc47	325	* uint8_t pipeNum;
vipinranka	12:9a20164dcc47	326	* if(radio.available(&pipeNum)){
vipinranka	12:9a20164dcc47	327	* radio.read(&data,sizeof(data));
vipinranka	12:9a20164dcc47	328	* Serial.print("Got data on pipe");
vipinranka	12:9a20164dcc47	329	* Serial.println(pipeNum);
vipinranka	12:9a20164dcc47	330	* }
vipinranka	12:9a20164dcc47	331	* @endcode
vipinranka	12:9a20164dcc47	332	* @return True if there is a payload available, false if none is
vipinranka	12:9a20164dcc47	333	*/
vipinranka	12:9a20164dcc47	334	bool available(uint8_t* pipe_num);
vipinranka	12:9a20164dcc47	335
vipinranka	12:9a20164dcc47	336	/**
vipinranka	12:9a20164dcc47	337	* Check if the radio needs to be read. Can be used to prevent data loss
vipinranka	12:9a20164dcc47	338	* @return True if all three 32-byte radio buffers are full
vipinranka	12:9a20164dcc47	339	*/
vipinranka	12:9a20164dcc47	340	bool rxFifoFull();
vipinranka	12:9a20164dcc47	341
vipinranka	12:9a20164dcc47	342	/**
vipinranka	12:9a20164dcc47	343	* Enter low-power mode
vipinranka	12:9a20164dcc47	344	*
vipinranka	12:9a20164dcc47	345	* To return to normal power mode, call powerUp().
vipinranka	12:9a20164dcc47	346	*
vipinranka	12:9a20164dcc47	347	* @note After calling startListening(), a basic radio will consume about 13.5mA
vipinranka	12:9a20164dcc47	348	* at max PA level.
vipinranka	12:9a20164dcc47	349	* During active transmission, the radio will consume about 11.5mA, but this will
vipinranka	12:9a20164dcc47	350	* be reduced to 26uA (.026mA) between sending.
vipinranka	12:9a20164dcc47	351	* In full powerDown mode, the radio will consume approximately 900nA (.0009mA)
vipinranka	12:9a20164dcc47	352	*
vipinranka	12:9a20164dcc47	353	* @code
vipinranka	12:9a20164dcc47	354	* radio.powerDown();
vipinranka	12:9a20164dcc47	355	* avr_enter_sleep_mode(); // Custom function to sleep the device
vipinranka	12:9a20164dcc47	356	* radio.powerUp();
vipinranka	12:9a20164dcc47	357	* @endcode
vipinranka	12:9a20164dcc47	358	*/
vipinranka	12:9a20164dcc47	359	void powerDown(void);
vipinranka	12:9a20164dcc47	360
vipinranka	12:9a20164dcc47	361	/**
vipinranka	12:9a20164dcc47	362	* Leave low-power mode - required for normal radio operation after calling powerDown()
vipinranka	12:9a20164dcc47	363	*
vipinranka	12:9a20164dcc47	364	* To return to low power mode, call powerDown().
vipinranka	12:9a20164dcc47	365	* @note This will take up to 5ms for maximum compatibility
vipinranka	12:9a20164dcc47	366	*/
vipinranka	12:9a20164dcc47	367	void powerUp(void) ;
vipinranka	12:9a20164dcc47	368
vipinranka	12:9a20164dcc47	369	/**
vipinranka	12:9a20164dcc47	370	* Write for single NOACK writes. Optionally disables acknowledgements/autoretries for a single write.
vipinranka	12:9a20164dcc47	371	*
vipinranka	12:9a20164dcc47	372	* @note enableDynamicAck() must be called to enable this feature
vipinranka	12:9a20164dcc47	373	*
vipinranka	12:9a20164dcc47	374	* Can be used with enableAckPayload() to request a response
vipinranka	12:9a20164dcc47	375	* @see enableDynamicAck()
vipinranka	12:9a20164dcc47	376	* @see setAutoAck()
vipinranka	12:9a20164dcc47	377	* @see write()
vipinranka	12:9a20164dcc47	378	*
vipinranka	12:9a20164dcc47	379	* @param buf Pointer to the data to be sent
vipinranka	12:9a20164dcc47	380	* @param len Number of bytes to be sent
vipinranka	12:9a20164dcc47	381	* @param multicast Request ACK (0), NOACK (1)
vipinranka	12:9a20164dcc47	382	*/
vipinranka	12:9a20164dcc47	383	bool write( const void* buf, uint8_t len, const bool multicast );
vipinranka	12:9a20164dcc47	384
vipinranka	12:9a20164dcc47	385	/**
vipinranka	12:9a20164dcc47	386	* This will not block until the 3 FIFO buffers are filled with data.
vipinranka	12:9a20164dcc47	387	* Once the FIFOs are full, writeFast will simply wait for success or
vipinranka	12:9a20164dcc47	388	* timeout, and return 1 or 0 respectively. From a user perspective, just
vipinranka	12:9a20164dcc47	389	* keep trying to send the same data. The library will keep auto retrying
vipinranka	12:9a20164dcc47	390	* the current payload using the built in functionality.
vipinranka	12:9a20164dcc47	391	* @warning It is important to never keep the nRF24L01 in TX mode and FIFO full for more than 4ms at a time. If the auto
vipinranka	12:9a20164dcc47	392	* retransmit is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO
vipinranka	12:9a20164dcc47	393	* to clear by issuing txStandBy() or ensure appropriate time between transmissions.
vipinranka	12:9a20164dcc47	394	*
vipinranka	12:9a20164dcc47	395	* @code
vipinranka	12:9a20164dcc47	396	* Example (Partial blocking):
vipinranka	12:9a20164dcc47	397	*
vipinranka	12:9a20164dcc47	398	* radio.writeFast(&buf,32); // Writes 1 payload to the buffers
vipinranka	12:9a20164dcc47	399	* txStandBy(); // Returns 0 if failed. 1 if success. Blocks only until MAX_RT timeout or success. Data flushed on fail.
vipinranka	12:9a20164dcc47	400	*
vipinranka	12:9a20164dcc47	401	* radio.writeFast(&buf,32); // Writes 1 payload to the buffers
vipinranka	12:9a20164dcc47	402	* txStandBy(1000); // Using extended timeouts, returns 1 if success. Retries failed payloads for 1 seconds before returning 0.
vipinranka	12:9a20164dcc47	403	* @endcode
vipinranka	12:9a20164dcc47	404	*
vipinranka	12:9a20164dcc47	405	* @see txStandBy()
vipinranka	12:9a20164dcc47	406	* @see write()
vipinranka	12:9a20164dcc47	407	* @see writeBlocking()
vipinranka	12:9a20164dcc47	408	*
vipinranka	12:9a20164dcc47	409	* @param buf Pointer to the data to be sent
vipinranka	12:9a20164dcc47	410	* @param len Number of bytes to be sent
vipinranka	12:9a20164dcc47	411	* @return True if the payload was delivered successfully false if not
vipinranka	12:9a20164dcc47	412	*/
vipinranka	12:9a20164dcc47	413	bool writeFast( const void* buf, uint8_t len );
vipinranka	12:9a20164dcc47	414
vipinranka	12:9a20164dcc47	415	/**
vipinranka	12:9a20164dcc47	416	* WriteFast for single NOACK writes. Disables acknowledgements/autoretries for a single write.
vipinranka	12:9a20164dcc47	417	*
vipinranka	12:9a20164dcc47	418	* @note enableDynamicAck() must be called to enable this feature
vipinranka	12:9a20164dcc47	419	* @see enableDynamicAck()
vipinranka	12:9a20164dcc47	420	* @see setAutoAck()
vipinranka	12:9a20164dcc47	421	*
vipinranka	12:9a20164dcc47	422	* @param buf Pointer to the data to be sent
vipinranka	12:9a20164dcc47	423	* @param len Number of bytes to be sent
vipinranka	12:9a20164dcc47	424	* @param multicast Request ACK (0) or NOACK (1)
vipinranka	12:9a20164dcc47	425	*/
vipinranka	12:9a20164dcc47	426	bool writeFast( const void* buf, uint8_t len, const bool multicast );
vipinranka	12:9a20164dcc47	427
vipinranka	12:9a20164dcc47	428	/**
vipinranka	12:9a20164dcc47	429	* This function extends the auto-retry mechanism to any specified duration.
vipinranka	12:9a20164dcc47	430	* It will not block until the 3 FIFO buffers are filled with data.
vipinranka	12:9a20164dcc47	431	* If so the library will auto retry until a new payload is written
vipinranka	12:9a20164dcc47	432	* or the user specified timeout period is reached.
vipinranka	12:9a20164dcc47	433	* @warning It is important to never keep the nRF24L01 in TX mode and FIFO full for more than 4ms at a time. If the auto
vipinranka	12:9a20164dcc47	434	* retransmit is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO
vipinranka	12:9a20164dcc47	435	* to clear by issuing txStandBy() or ensure appropriate time between transmissions.
vipinranka	12:9a20164dcc47	436	*
vipinranka	12:9a20164dcc47	437	* @code
vipinranka	12:9a20164dcc47	438	* Example (Full blocking):
vipinranka	12:9a20164dcc47	439	*
vipinranka	12:9a20164dcc47	440	* radio.writeBlocking(&buf,32,1000); //Wait up to 1 second to write 1 payload to the buffers
vipinranka	12:9a20164dcc47	441	* txStandBy(1000); //Wait up to 1 second for the payload to send. Return 1 if ok, 0 if failed.
vipinranka	12:9a20164dcc47	442	* //Blocks only until user timeout or success. Data flushed on fail.
vipinranka	12:9a20164dcc47	443	* @endcode
vipinranka	12:9a20164dcc47	444	* @note If used from within an interrupt, the interrupt should be disabled until completion, and sei(); called to enable millis().
vipinranka	12:9a20164dcc47	445	* @see txStandBy()
vipinranka	12:9a20164dcc47	446	* @see write()
vipinranka	12:9a20164dcc47	447	* @see writeFast()
vipinranka	12:9a20164dcc47	448	*
vipinranka	12:9a20164dcc47	449	* @param buf Pointer to the data to be sent
vipinranka	12:9a20164dcc47	450	* @param len Number of bytes to be sent
vipinranka	12:9a20164dcc47	451	* @param timeout User defined timeout in milliseconds.
vipinranka	12:9a20164dcc47	452	* @return True if the payload was loaded into the buffer successfully false if not
vipinranka	12:9a20164dcc47	453	*/
vipinranka	12:9a20164dcc47	454	bool writeBlocking( const void* buf, uint8_t len, uint32_t timeout );
vipinranka	12:9a20164dcc47	455
vipinranka	12:9a20164dcc47	456	/**
vipinranka	12:9a20164dcc47	457	* This function should be called as soon as transmission is finished to
vipinranka	12:9a20164dcc47	458	* drop the radio back to STANDBY-I mode. If not issued, the radio will
vipinranka	12:9a20164dcc47	459	* remain in STANDBY-II mode which, per the data sheet, is not a recommended
vipinranka	12:9a20164dcc47	460	* operating mode.
vipinranka	12:9a20164dcc47	461	*
vipinranka	12:9a20164dcc47	462	* @note When transmitting data in rapid succession, it is still recommended by
vipinranka	12:9a20164dcc47	463	* the manufacturer to drop the radio out of TX or STANDBY-II mode if there is
vipinranka	12:9a20164dcc47	464	* time enough between sends for the FIFOs to empty. This is not required if auto-ack
vipinranka	12:9a20164dcc47	465	* is enabled.
vipinranka	12:9a20164dcc47	466	*
vipinranka	12:9a20164dcc47	467	* Relies on built-in auto retry functionality.
vipinranka	12:9a20164dcc47	468	*
vipinranka	12:9a20164dcc47	469	* @code
vipinranka	12:9a20164dcc47	470	* Example (Partial blocking):
vipinranka	12:9a20164dcc47	471	*
vipinranka	12:9a20164dcc47	472	* radio.writeFast(&buf,32);
vipinranka	12:9a20164dcc47	473	* radio.writeFast(&buf,32);
vipinranka	12:9a20164dcc47	474	* radio.writeFast(&buf,32); //Fills the FIFO buffers up
vipinranka	12:9a20164dcc47	475	* bool ok = txStandBy(); //Returns 0 if failed. 1 if success.
vipinranka	12:9a20164dcc47	476	* //Blocks only until MAX_RT timeout or success. Data flushed on fail.
vipinranka	12:9a20164dcc47	477	* @endcode
vipinranka	12:9a20164dcc47	478	* @see txStandBy(unsigned long timeout)
vipinranka	12:9a20164dcc47	479	* @return True if transmission is successful
vipinranka	12:9a20164dcc47	480	*
vipinranka	12:9a20164dcc47	481	*/
vipinranka	12:9a20164dcc47	482	bool txStandBy();
vipinranka	12:9a20164dcc47	483
vipinranka	12:9a20164dcc47	484	/**
vipinranka	12:9a20164dcc47	485	* This function allows extended blocking and auto-retries per a user defined timeout
vipinranka	12:9a20164dcc47	486	* @code
vipinranka	12:9a20164dcc47	487	* Fully Blocking Example:
vipinranka	12:9a20164dcc47	488	*
vipinranka	12:9a20164dcc47	489	* radio.writeFast(&buf,32);
vipinranka	12:9a20164dcc47	490	* radio.writeFast(&buf,32);
vipinranka	12:9a20164dcc47	491	* radio.writeFast(&buf,32); //Fills the FIFO buffers up
vipinranka	12:9a20164dcc47	492	* bool ok = txStandBy(1000); //Returns 0 if failed after 1 second of retries. 1 if success.
vipinranka	12:9a20164dcc47	493	* //Blocks only until user defined timeout or success. Data flushed on fail.
vipinranka	12:9a20164dcc47	494	* @endcode
vipinranka	12:9a20164dcc47	495	* @note If used from within an interrupt, the interrupt should be disabled until completion, and sei(); called to enable millis().
vipinranka	12:9a20164dcc47	496	* @param timeout Number of milliseconds to retry failed payloads
vipinranka	12:9a20164dcc47	497	* @return True if transmission is successful
vipinranka	12:9a20164dcc47	498	*
vipinranka	12:9a20164dcc47	499	*/
vipinranka	12:9a20164dcc47	500	bool txStandBy(uint32_t timeout, bool startTx = 0);
vipinranka	12:9a20164dcc47	501
vipinranka	12:9a20164dcc47	502	/**
vipinranka	12:9a20164dcc47	503	* Write an ack payload for the specified pipe
vipinranka	12:9a20164dcc47	504	*
vipinranka	12:9a20164dcc47	505	* The next time a message is received on @p pipe, the data in @p buf will
vipinranka	12:9a20164dcc47	506	* be sent back in the acknowledgement.
vipinranka	12:9a20164dcc47	507	* @see enableAckPayload()
vipinranka	12:9a20164dcc47	508	* @see enableDynamicPayloads()
vipinranka	12:9a20164dcc47	509	* @warning Only three of these can be pending at any time as there are only 3 FIFO buffers.<br> Dynamic payloads must be enabled.
vipinranka	12:9a20164dcc47	510	* @note Ack payloads are handled automatically by the radio chip when a payload is received. Users should generally
vipinranka	12:9a20164dcc47	511	* write an ack payload as soon as startListening() is called, so one is available when a regular payload is received.
vipinranka	12:9a20164dcc47	512	* @note Ack payloads are dynamic payloads. This only works on pipes 0&1 by default. Call
vipinranka	12:9a20164dcc47	513	* enableDynamicPayloads() to enable on all pipes.
vipinranka	12:9a20164dcc47	514	*
vipinranka	12:9a20164dcc47	515	* @param pipe Which pipe# (typically 1-5) will get this response.
vipinranka	12:9a20164dcc47	516	* @param buf Pointer to data that is sent
vipinranka	12:9a20164dcc47	517	* @param len Length of the data to send, up to 32 bytes max. Not affected
vipinranka	12:9a20164dcc47	518	* by the static payload set by setPayloadSize().
vipinranka	12:9a20164dcc47	519	*/
vipinranka	12:9a20164dcc47	520	void writeAckPayload(uint8_t pipe, const void* buf, uint8_t len);
vipinranka	12:9a20164dcc47	521
vipinranka	12:9a20164dcc47	522	/**
vipinranka	12:9a20164dcc47	523	* Determine if an ack payload was received in the most recent call to
vipinranka	12:9a20164dcc47	524	* write(). The regular available() can also be used.
vipinranka	12:9a20164dcc47	525	*
vipinranka	12:9a20164dcc47	526	* Call read() to retrieve the ack payload.
vipinranka	12:9a20164dcc47	527	*
vipinranka	12:9a20164dcc47	528	* @return True if an ack payload is available.
vipinranka	12:9a20164dcc47	529	*/
vipinranka	12:9a20164dcc47	530	bool isAckPayloadAvailable(void);
vipinranka	12:9a20164dcc47	531
vipinranka	12:9a20164dcc47	532	/**
vipinranka	12:9a20164dcc47	533	* Call this when you get an interrupt to find out why
vipinranka	12:9a20164dcc47	534	*
vipinranka	12:9a20164dcc47	535	* Tells you what caused the interrupt, and clears the state of
vipinranka	12:9a20164dcc47	536	* interrupts.
vipinranka	12:9a20164dcc47	537	*
vipinranka	12:9a20164dcc47	538	* @param[out] tx_ok The send was successful (TX_DS)
vipinranka	12:9a20164dcc47	539	* @param[out] tx_fail The send failed, too many retries (MAX_RT)
vipinranka	12:9a20164dcc47	540	* @param[out] rx_ready There is a message waiting to be read (RX_DS)
vipinranka	12:9a20164dcc47	541	*/
vipinranka	12:9a20164dcc47	542	void whatHappened(bool& tx_ok,bool& tx_fail,bool& rx_ready);
vipinranka	12:9a20164dcc47	543
vipinranka	12:9a20164dcc47	544	/**
vipinranka	12:9a20164dcc47	545	* Non-blocking write to the open writing pipe used for buffered writes
vipinranka	12:9a20164dcc47	546	*
vipinranka	12:9a20164dcc47	547	* @note Optimization: This function now leaves the CE pin high, so the radio
vipinranka	12:9a20164dcc47	548	* will remain in TX or STANDBY-II Mode until a txStandBy() command is issued. Can be used as an alternative to startWrite()
vipinranka	12:9a20164dcc47	549	* if writing multiple payloads at once.
vipinranka	12:9a20164dcc47	550	* @warning It is important to never keep the nRF24L01 in TX mode with FIFO full for more than 4ms at a time. If the auto
vipinranka	12:9a20164dcc47	551	* retransmit/autoAck is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO
vipinranka	12:9a20164dcc47	552	* to clear by issuing txStandBy() or ensure appropriate time between transmissions.
vipinranka	12:9a20164dcc47	553	*
vipinranka	12:9a20164dcc47	554	* @see write()
vipinranka	12:9a20164dcc47	555	* @see writeFast()
vipinranka	12:9a20164dcc47	556	* @see startWrite()
vipinranka	12:9a20164dcc47	557	* @see writeBlocking()
vipinranka	12:9a20164dcc47	558	*
vipinranka	12:9a20164dcc47	559	* For single noAck writes see:
vipinranka	12:9a20164dcc47	560	* @see enableDynamicAck()
vipinranka	12:9a20164dcc47	561	* @see setAutoAck()
vipinranka	12:9a20164dcc47	562	*
vipinranka	12:9a20164dcc47	563	* @param buf Pointer to the data to be sent
vipinranka	12:9a20164dcc47	564	* @param len Number of bytes to be sent
vipinranka	12:9a20164dcc47	565	* @param multicast Request ACK (0) or NOACK (1)
vipinranka	12:9a20164dcc47	566	* @return True if the payload was delivered successfully false if not
vipinranka	12:9a20164dcc47	567	*/
vipinranka	12:9a20164dcc47	568	void startFastWrite( const void* buf, uint8_t len, const bool multicast, bool startTx = 1 );
vipinranka	12:9a20164dcc47	569
vipinranka	12:9a20164dcc47	570	/**
vipinranka	12:9a20164dcc47	571	* Non-blocking write to the open writing pipe
vipinranka	12:9a20164dcc47	572	*
vipinranka	12:9a20164dcc47	573	* Just like write(), but it returns immediately. To find out what happened
vipinranka	12:9a20164dcc47	574	* to the send, catch the IRQ and then call whatHappened().
vipinranka	12:9a20164dcc47	575	*
vipinranka	12:9a20164dcc47	576	* @see write()
vipinranka	12:9a20164dcc47	577	* @see writeFast()
vipinranka	12:9a20164dcc47	578	* @see startFastWrite()
vipinranka	12:9a20164dcc47	579	* @see whatHappened()
vipinranka	12:9a20164dcc47	580	*
vipinranka	12:9a20164dcc47	581	* For single noAck writes see:
vipinranka	12:9a20164dcc47	582	* @see enableDynamicAck()
vipinranka	12:9a20164dcc47	583	* @see setAutoAck()
vipinranka	12:9a20164dcc47	584	*
vipinranka	12:9a20164dcc47	585	* @param buf Pointer to the data to be sent
vipinranka	12:9a20164dcc47	586	* @param len Number of bytes to be sent
vipinranka	12:9a20164dcc47	587	* @param multicast Request ACK (0) or NOACK (1)
vipinranka	12:9a20164dcc47	588	*
vipinranka	12:9a20164dcc47	589	*/
vipinranka	12:9a20164dcc47	590	void startWrite( const void* buf, uint8_t len, const bool multicast );
vipinranka	12:9a20164dcc47	591
vipinranka	12:9a20164dcc47	592	/**
vipinranka	12:9a20164dcc47	593	* This function is mainly used internally to take advantage of the auto payload
vipinranka	12:9a20164dcc47	594	* re-use functionality of the chip, but can be beneficial to users as well.
vipinranka	12:9a20164dcc47	595	*
vipinranka	12:9a20164dcc47	596	* The function will instruct the radio to re-use the data in the FIFO buffers,
vipinranka	12:9a20164dcc47	597	* and instructs the radio to re-send once the timeout limit has been reached.
vipinranka	12:9a20164dcc47	598	* Used by writeFast and writeBlocking to initiate retries when a TX failure
vipinranka	12:9a20164dcc47	599	* occurs. Retries are automatically initiated except with the standard write().
vipinranka	12:9a20164dcc47	600	* This way, data is not flushed from the buffer until switching between modes.
vipinranka	12:9a20164dcc47	601	*
vipinranka	12:9a20164dcc47	602	* @note This is to be used AFTER auto-retry fails if wanting to resend
vipinranka	12:9a20164dcc47	603	* using the built-in payload reuse features.
vipinranka	12:9a20164dcc47	604	* After issuing reUseTX(), it will keep reending the same payload forever or until
vipinranka	12:9a20164dcc47	605	* a payload is written to the FIFO, or a flush_tx command is given.
vipinranka	12:9a20164dcc47	606	*/
vipinranka	12:9a20164dcc47	607	void reUseTX();
vipinranka	12:9a20164dcc47	608
vipinranka	12:9a20164dcc47	609	/**
vipinranka	12:9a20164dcc47	610	* Empty the transmit buffer. This is generally not required in standard operation.
vipinranka	12:9a20164dcc47	611	* May be required in specific cases after stopListening() , if operating at 250KBPS data rate.
vipinranka	12:9a20164dcc47	612	*
vipinranka	12:9a20164dcc47	613	* @return Current value of status register
vipinranka	12:9a20164dcc47	614	*/
vipinranka	12:9a20164dcc47	615	uint8_t flush_tx(void);
vipinranka	12:9a20164dcc47	616
vipinranka	12:9a20164dcc47	617	/**
vipinranka	12:9a20164dcc47	618	* Test whether there was a carrier on the line for the
vipinranka	12:9a20164dcc47	619	* previous listening period.
vipinranka	12:9a20164dcc47	620	*
vipinranka	12:9a20164dcc47	621	* Useful to check for interference on the current channel.
vipinranka	12:9a20164dcc47	622	*
vipinranka	12:9a20164dcc47	623	* @return true if was carrier, false if not
vipinranka	12:9a20164dcc47	624	*/
vipinranka	12:9a20164dcc47	625	bool testCarrier(void);
vipinranka	12:9a20164dcc47	626
vipinranka	12:9a20164dcc47	627	/**
vipinranka	12:9a20164dcc47	628	* Test whether a signal (carrier or otherwise) greater than
vipinranka	12:9a20164dcc47	629	* or equal to -64dBm is present on the channel. Valid only
vipinranka	12:9a20164dcc47	630	* on nRF24L01P (+) hardware. On nRF24L01, use testCarrier().
vipinranka	12:9a20164dcc47	631	*
vipinranka	12:9a20164dcc47	632	* Useful to check for interference on the current channel and
vipinranka	12:9a20164dcc47	633	* channel hopping strategies.
vipinranka	12:9a20164dcc47	634	*
vipinranka	12:9a20164dcc47	635	* @code
vipinranka	12:9a20164dcc47	636	* bool goodSignal = radio.testRPD();
vipinranka	12:9a20164dcc47	637	* if(radio.available()){
vipinranka	12:9a20164dcc47	638	* Serial.println(goodSignal ? "Strong signal > 64dBm" : "Weak signal < 64dBm" );
vipinranka	12:9a20164dcc47	639	* radio.read(0,0);
vipinranka	12:9a20164dcc47	640	* }
vipinranka	12:9a20164dcc47	641	* @endcode
vipinranka	12:9a20164dcc47	642	* @return true if signal => -64dBm, false if not
vipinranka	12:9a20164dcc47	643	*/
vipinranka	12:9a20164dcc47	644	bool testRPD(void) ;
vipinranka	12:9a20164dcc47	645
vipinranka	12:9a20164dcc47	646	/**
vipinranka	12:9a20164dcc47	647	* Test whether this is a real radio, or a mock shim for
vipinranka	12:9a20164dcc47	648	* debugging. Setting either pin to 0xff is the way to
vipinranka	12:9a20164dcc47	649	* indicate that this is not a real radio.
vipinranka	12:9a20164dcc47	650	*
vipinranka	12:9a20164dcc47	651	* @return true if this is a legitimate radio
vipinranka	12:9a20164dcc47	652	*/
vipinranka	12:9a20164dcc47	653	bool isValid() { return ce_pin != 0xff && csn_pin != 0xff; }
vipinranka	12:9a20164dcc47	654
vipinranka	12:9a20164dcc47	655	/**
vipinranka	12:9a20164dcc47	656	* Close a pipe after it has been previously opened.
vipinranka	12:9a20164dcc47	657	* Can be safely called without having previously opened a pipe.
vipinranka	12:9a20164dcc47	658	* @param pipe Which pipe # to close, 0-5.
vipinranka	12:9a20164dcc47	659	*/
vipinranka	12:9a20164dcc47	660	void closeReadingPipe( uint8_t pipe ) ;
vipinranka	12:9a20164dcc47	661
vipinranka	12:9a20164dcc47	662	/**
vipinranka	12:9a20164dcc47	663	* Enable error detection by un-commenting #define FAILURE_HANDLING in RF24_config.h
vipinranka	12:9a20164dcc47	664	* If a failure has been detected, it usually indicates a hardware issue. By default the library
vipinranka	12:9a20164dcc47	665	* will cease operation when a failure is detected.
vipinranka	12:9a20164dcc47	666	* This should allow advanced users to detect and resolve intermittent hardware issues.
vipinranka	12:9a20164dcc47	667	*
vipinranka	12:9a20164dcc47	668	* In most cases, the radio must be re-enabled via radio.begin(); and the appropriate settings
vipinranka	12:9a20164dcc47	669	* applied after a failure occurs, if wanting to re-enable the device immediately.
vipinranka	12:9a20164dcc47	670	*
vipinranka	12:9a20164dcc47	671	* Usage: (Failure handling must be enabled per above)
vipinranka	12:9a20164dcc47	672	* @code
vipinranka	12:9a20164dcc47	673	* if(radio.failureDetected){
vipinranka	12:9a20164dcc47	674	* radio.begin(); // Attempt to re-configure the radio with defaults
vipinranka	12:9a20164dcc47	675	* radio.failureDetected = 0; // Reset the detection value
vipinranka	12:9a20164dcc47	676	* radio.openWritingPipe(addresses[1]); // Re-configure pipe addresses
vipinranka	12:9a20164dcc47	677	* radio.openReadingPipe(1,addresses[0]);
vipinranka	12:9a20164dcc47	678	* report_failure(); // Blink leds, send a message, etc. to indicate failure
vipinranka	12:9a20164dcc47	679	* }
vipinranka	12:9a20164dcc47	680	* @endcode
vipinranka	12:9a20164dcc47	681	*/
vipinranka	12:9a20164dcc47	682	//#if defined (FAILURE_HANDLING)
vipinranka	12:9a20164dcc47	683	bool failureDetected;
vipinranka	12:9a20164dcc47	684	//#endif
vipinranka	12:9a20164dcc47	685
vipinranka	12:9a20164dcc47	686	/*@}/
vipinranka	12:9a20164dcc47	687
vipinranka	12:9a20164dcc47	688	/*@}/
vipinranka	12:9a20164dcc47	689	/**
vipinranka	12:9a20164dcc47	690	* @name Optional Configurators
vipinranka	12:9a20164dcc47	691	*
vipinranka	12:9a20164dcc47	692	* Methods you can use to get or set the configuration of the chip.
vipinranka	12:9a20164dcc47	693	* None are required. Calling begin() sets up a reasonable set of
vipinranka	12:9a20164dcc47	694	* defaults.
vipinranka	12:9a20164dcc47	695	*/
vipinranka	12:9a20164dcc47	696	/*@{/
vipinranka	12:9a20164dcc47	697
vipinranka	12:9a20164dcc47	698	/**
vipinranka	12:9a20164dcc47	699	* Set the address width from 3 to 5 bytes (24, 32 or 40 bit)
vipinranka	12:9a20164dcc47	700	*
vipinranka	12:9a20164dcc47	701	* @param a_width The address width to use: 3,4 or 5
vipinranka	12:9a20164dcc47	702	*/
vipinranka	12:9a20164dcc47	703
vipinranka	12:9a20164dcc47	704	void setAddressWidth(uint8_t a_width);
vipinranka	12:9a20164dcc47	705
vipinranka	12:9a20164dcc47	706	/**
vipinranka	12:9a20164dcc47	707	* Set the number and delay of retries upon failed submit
vipinranka	12:9a20164dcc47	708	*
vipinranka	12:9a20164dcc47	709	* @param delay How long to wait between each retry, in multiples of 250us,
vipinranka	12:9a20164dcc47	710	* max is 15. 0 means 250us, 15 means 4000us.
vipinranka	12:9a20164dcc47	711	* @param count How many retries before giving up, max 15
vipinranka	12:9a20164dcc47	712	*/
vipinranka	12:9a20164dcc47	713	void setRetries(uint8_t delay, uint8_t count);
vipinranka	12:9a20164dcc47	714
vipinranka	12:9a20164dcc47	715	/**
vipinranka	12:9a20164dcc47	716	* Set RF communication channel
vipinranka	12:9a20164dcc47	717	*
vipinranka	12:9a20164dcc47	718	* @param channel Which RF channel to communicate on, 0-125
vipinranka	12:9a20164dcc47	719	*/
vipinranka	12:9a20164dcc47	720	void setChannel(uint8_t channel);
vipinranka	12:9a20164dcc47	721
vipinranka	12:9a20164dcc47	722	/**
vipinranka	12:9a20164dcc47	723	* Get RF communication channel
vipinranka	12:9a20164dcc47	724	*
vipinranka	12:9a20164dcc47	725	* @return The currently configured RF Channel
vipinranka	12:9a20164dcc47	726	*/
vipinranka	12:9a20164dcc47	727	uint8_t getChannel(void);
vipinranka	12:9a20164dcc47	728
vipinranka	12:9a20164dcc47	729	/**
vipinranka	12:9a20164dcc47	730	* Set Static Payload Size
vipinranka	12:9a20164dcc47	731	*
vipinranka	12:9a20164dcc47	732	* This implementation uses a pre-stablished fixed payload size for all
vipinranka	12:9a20164dcc47	733	* transmissions. If this method is never called, the driver will always
vipinranka	12:9a20164dcc47	734	* transmit the maximum payload size (32 bytes), no matter how much
vipinranka	12:9a20164dcc47	735	* was sent to write().
vipinranka	12:9a20164dcc47	736	*
vipinranka	12:9a20164dcc47	737	* @todo Implement variable-sized payloads feature
vipinranka	12:9a20164dcc47	738	*
vipinranka	12:9a20164dcc47	739	* @param size The number of bytes in the payload
vipinranka	12:9a20164dcc47	740	*/
vipinranka	12:9a20164dcc47	741	void setPayloadSize(uint8_t size);
vipinranka	12:9a20164dcc47	742
vipinranka	12:9a20164dcc47	743	/**
vipinranka	12:9a20164dcc47	744	* Get Static Payload Size
vipinranka	12:9a20164dcc47	745	*
vipinranka	12:9a20164dcc47	746	* @see setPayloadSize()
vipinranka	12:9a20164dcc47	747	*
vipinranka	12:9a20164dcc47	748	* @return The number of bytes in the payload
vipinranka	12:9a20164dcc47	749	*/
vipinranka	12:9a20164dcc47	750	uint8_t getPayloadSize(void);
vipinranka	12:9a20164dcc47	751
vipinranka	12:9a20164dcc47	752	/**
vipinranka	12:9a20164dcc47	753	* Get Dynamic Payload Size
vipinranka	12:9a20164dcc47	754	*
vipinranka	12:9a20164dcc47	755	* For dynamic payloads, this pulls the size of the payload off
vipinranka	12:9a20164dcc47	756	* the chip
vipinranka	12:9a20164dcc47	757	*
vipinranka	12:9a20164dcc47	758	* @note Corrupt packets are now detected and flushed per the
vipinranka	12:9a20164dcc47	759	* manufacturer.
vipinranka	12:9a20164dcc47	760	* @code
vipinranka	12:9a20164dcc47	761	* if(radio.available()){
vipinranka	12:9a20164dcc47	762	* if(radio.getDynamicPayloadSize() < 1){
vipinranka	12:9a20164dcc47	763	* // Corrupt payload has been flushed
vipinranka	12:9a20164dcc47	764	* return;
vipinranka	12:9a20164dcc47	765	* }
vipinranka	12:9a20164dcc47	766	* radio.read(&data,sizeof(data));
vipinranka	12:9a20164dcc47	767	* }
vipinranka	12:9a20164dcc47	768	* @endcode
vipinranka	12:9a20164dcc47	769	*
vipinranka	12:9a20164dcc47	770	* @return Payload length of last-received dynamic payload
vipinranka	12:9a20164dcc47	771	*/
vipinranka	12:9a20164dcc47	772	uint8_t getDynamicPayloadSize(void);
vipinranka	12:9a20164dcc47	773
vipinranka	12:9a20164dcc47	774	/**
vipinranka	12:9a20164dcc47	775	* Enable custom payloads on the acknowledge packets
vipinranka	12:9a20164dcc47	776	*
vipinranka	12:9a20164dcc47	777	* Ack payloads are a handy way to return data back to senders without
vipinranka	12:9a20164dcc47	778	* manually changing the radio modes on both units.
vipinranka	12:9a20164dcc47	779	*
vipinranka	12:9a20164dcc47	780	* @note Ack payloads are dynamic payloads. This only works on pipes 0&1 by default. Call
vipinranka	12:9a20164dcc47	781	* enableDynamicPayloads() to enable on all pipes.
vipinranka	12:9a20164dcc47	782	*/
vipinranka	12:9a20164dcc47	783	void enableAckPayload(void);
vipinranka	12:9a20164dcc47	784
vipinranka	12:9a20164dcc47	785	/**
vipinranka	12:9a20164dcc47	786	* Enable dynamically-sized payloads
vipinranka	12:9a20164dcc47	787	*
vipinranka	12:9a20164dcc47	788	* This way you don't always have to send large packets just to send them
vipinranka	12:9a20164dcc47	789	* once in a while. This enables dynamic payloads on ALL pipes.
vipinranka	12:9a20164dcc47	790	*
vipinranka	12:9a20164dcc47	791	*/
vipinranka	12:9a20164dcc47	792	void enableDynamicPayloads(void);
vipinranka	12:9a20164dcc47	793
vipinranka	12:9a20164dcc47	794	/**
vipinranka	12:9a20164dcc47	795	* Enable dynamic ACKs (single write multicast or unicast) for chosen messages
vipinranka	12:9a20164dcc47	796	*
vipinranka	12:9a20164dcc47	797	* @note To enable full multicast or per-pipe multicast, use setAutoAck()
vipinranka	12:9a20164dcc47	798	*
vipinranka	12:9a20164dcc47	799	* @warning This MUST be called prior to attempting single write NOACK calls
vipinranka	12:9a20164dcc47	800	* @code
vipinranka	12:9a20164dcc47	801	* radio.enableDynamicAck();
vipinranka	12:9a20164dcc47	802	* radio.write(&data,32,1); // Sends a payload with no acknowledgement requested
vipinranka	12:9a20164dcc47	803	* radio.write(&data,32,0); // Sends a payload using auto-retry/autoACK
vipinranka	12:9a20164dcc47	804	* @endcode
vipinranka	12:9a20164dcc47	805	*/
vipinranka	12:9a20164dcc47	806	void enableDynamicAck();
vipinranka	12:9a20164dcc47	807
vipinranka	12:9a20164dcc47	808	/**
vipinranka	12:9a20164dcc47	809	* Determine whether the hardware is an nRF24L01+ or not.
vipinranka	12:9a20164dcc47	810	*
vipinranka	12:9a20164dcc47	811	* @return true if the hardware is nRF24L01+ (or compatible) and false
vipinranka	12:9a20164dcc47	812	* if its not.
vipinranka	12:9a20164dcc47	813	*/
vipinranka	12:9a20164dcc47	814	bool isPVariant(void) ;
vipinranka	12:9a20164dcc47	815
vipinranka	12:9a20164dcc47	816	/**
vipinranka	12:9a20164dcc47	817	* Enable or disable auto-acknowlede packets
vipinranka	12:9a20164dcc47	818	*
vipinranka	12:9a20164dcc47	819	* This is enabled by default, so it's only needed if you want to turn
vipinranka	12:9a20164dcc47	820	* it off for some reason.
vipinranka	12:9a20164dcc47	821	*
vipinranka	12:9a20164dcc47	822	* @param enable Whether to enable (true) or disable (false) auto-acks
vipinranka	12:9a20164dcc47	823	*/
vipinranka	12:9a20164dcc47	824	void setAutoAck(bool enable);
vipinranka	12:9a20164dcc47	825
vipinranka	12:9a20164dcc47	826	/**
vipinranka	12:9a20164dcc47	827	* Enable or disable auto-acknowlede packets on a per pipeline basis.
vipinranka	12:9a20164dcc47	828	*
vipinranka	12:9a20164dcc47	829	* AA is enabled by default, so it's only needed if you want to turn
vipinranka	12:9a20164dcc47	830	* it off/on for some reason on a per pipeline basis.
vipinranka	12:9a20164dcc47	831	*
vipinranka	12:9a20164dcc47	832	* @param pipe Which pipeline to modify
vipinranka	12:9a20164dcc47	833	* @param enable Whether to enable (true) or disable (false) auto-acks
vipinranka	12:9a20164dcc47	834	*/
vipinranka	12:9a20164dcc47	835	void setAutoAck( uint8_t pipe, bool enable ) ;
vipinranka	12:9a20164dcc47	836
vipinranka	12:9a20164dcc47	837	/**
vipinranka	12:9a20164dcc47	838	* Set Power Amplifier (PA) level to one of four levels:
vipinranka	12:9a20164dcc47	839	* RF24_PA_MIN, RF24_PA_LOW, RF24_PA_HIGH and RF24_PA_MAX
vipinranka	12:9a20164dcc47	840	*
vipinranka	12:9a20164dcc47	841	* The power levels correspond to the following output levels respectively:
vipinranka	12:9a20164dcc47	842	* NRF24L01: -18dBm, -12dBm,-6dBM, and 0dBm
vipinranka	12:9a20164dcc47	843	*
vipinranka	12:9a20164dcc47	844	* SI24R1: -6dBm, 0dBm, 3dBM, and 7dBm.
vipinranka	12:9a20164dcc47	845	*
vipinranka	12:9a20164dcc47	846	* @param level Desired PA level.
vipinranka	12:9a20164dcc47	847	*/
vipinranka	12:9a20164dcc47	848	void setPALevel ( uint8_t level );
vipinranka	12:9a20164dcc47	849
vipinranka	12:9a20164dcc47	850	/**
vipinranka	12:9a20164dcc47	851	* Fetches the current PA level.
vipinranka	12:9a20164dcc47	852	*
vipinranka	12:9a20164dcc47	853	* NRF24L01: -18dBm, -12dBm, -6dBm and 0dBm
vipinranka	12:9a20164dcc47	854	* SI24R1: -6dBm, 0dBm, 3dBm, 7dBm
vipinranka	12:9a20164dcc47	855	*
vipinranka	12:9a20164dcc47	856	* @return Returns values 0 to 3 representing the PA Level.
vipinranka	12:9a20164dcc47	857	*/
vipinranka	12:9a20164dcc47	858	uint8_t getPALevel( void );
vipinranka	12:9a20164dcc47	859
vipinranka	12:9a20164dcc47	860	/**
vipinranka	12:9a20164dcc47	861	* Set the transmission data rate
vipinranka	12:9a20164dcc47	862	*
vipinranka	12:9a20164dcc47	863	* @warning setting RF24_250KBPS will fail for non-plus units
vipinranka	12:9a20164dcc47	864	*
vipinranka	12:9a20164dcc47	865	* @param speed RF24_250KBPS for 250kbs, RF24_1MBPS for 1Mbps, or RF24_2MBPS for 2Mbps
vipinranka	12:9a20164dcc47	866	* @return true if the change was successful
vipinranka	12:9a20164dcc47	867	*/
vipinranka	12:9a20164dcc47	868	bool setDataRate(rf24_datarate_e speed);
vipinranka	12:9a20164dcc47	869
vipinranka	12:9a20164dcc47	870	/**
vipinranka	12:9a20164dcc47	871	* Fetches the transmission data rate
vipinranka	12:9a20164dcc47	872	*
vipinranka	12:9a20164dcc47	873	* @return Returns the hardware's currently configured datarate. The value
vipinranka	12:9a20164dcc47	874	* is one of 250kbs, RF24_1MBPS for 1Mbps, or RF24_2MBPS, as defined in the
vipinranka	12:9a20164dcc47	875	* rf24_datarate_e enum.
vipinranka	12:9a20164dcc47	876	*/
vipinranka	12:9a20164dcc47	877	rf24_datarate_e getDataRate( void ) ;
vipinranka	12:9a20164dcc47	878
vipinranka	12:9a20164dcc47	879	/**
vipinranka	12:9a20164dcc47	880	* Set the CRC length
vipinranka	12:9a20164dcc47	881	* <br>CRC checking cannot be disabled if auto-ack is enabled
vipinranka	12:9a20164dcc47	882	* @param length RF24_CRC_8 for 8-bit or RF24_CRC_16 for 16-bit
vipinranka	12:9a20164dcc47	883	*/
vipinranka	12:9a20164dcc47	884	void setCRCLength(rf24_crclength_e length);
vipinranka	12:9a20164dcc47	885
vipinranka	12:9a20164dcc47	886	/**
vipinranka	12:9a20164dcc47	887	* Get the CRC length
vipinranka	12:9a20164dcc47	888	* <br>CRC checking cannot be disabled if auto-ack is enabled
vipinranka	12:9a20164dcc47	889	* @return RF24_DISABLED if disabled or RF24_CRC_8 for 8-bit or RF24_CRC_16 for 16-bit
vipinranka	12:9a20164dcc47	890	*/
vipinranka	12:9a20164dcc47	891	rf24_crclength_e getCRCLength(void);
vipinranka	12:9a20164dcc47	892
vipinranka	12:9a20164dcc47	893	/**
vipinranka	12:9a20164dcc47	894	* Disable CRC validation
vipinranka	12:9a20164dcc47	895	*
vipinranka	12:9a20164dcc47	896	* @warning CRC cannot be disabled if auto-ack/ESB is enabled.
vipinranka	12:9a20164dcc47	897	*/
vipinranka	12:9a20164dcc47	898	void disableCRC( void ) ;
vipinranka	12:9a20164dcc47	899
vipinranka	12:9a20164dcc47	900	/**
vipinranka	12:9a20164dcc47	901	* The radio will generate interrupt signals when a transmission is complete,
vipinranka	12:9a20164dcc47	902	* a transmission fails, or a payload is received. This allows users to mask
vipinranka	12:9a20164dcc47	903	* those interrupts to prevent them from generating a signal on the interrupt
vipinranka	12:9a20164dcc47	904	* pin. Interrupts are enabled on the radio chip by default.
vipinranka	12:9a20164dcc47	905	*
vipinranka	12:9a20164dcc47	906	* @code
vipinranka	12:9a20164dcc47	907	* Mask all interrupts except the receive interrupt:
vipinranka	12:9a20164dcc47	908	*
vipinranka	12:9a20164dcc47	909	* radio.maskIRQ(1,1,0);
vipinranka	12:9a20164dcc47	910	* @endcode
vipinranka	12:9a20164dcc47	911	*
vipinranka	12:9a20164dcc47	912	* @param tx_ok Mask transmission complete interrupts
vipinranka	12:9a20164dcc47	913	* @param tx_fail Mask transmit failure interrupts
vipinranka	12:9a20164dcc47	914	* @param rx_ready Mask payload received interrupts
vipinranka	12:9a20164dcc47	915	*/
vipinranka	12:9a20164dcc47	916	void maskIRQ(bool tx_ok,bool tx_fail,bool rx_ready);
vipinranka	12:9a20164dcc47	917
vipinranka	12:9a20164dcc47	918	/*@}/
vipinranka	12:9a20164dcc47	919	/**
vipinranka	12:9a20164dcc47	920	* @name Deprecated
vipinranka	12:9a20164dcc47	921	*
vipinranka	12:9a20164dcc47	922	* Methods provided for backwards compabibility.
vipinranka	12:9a20164dcc47	923	*/
vipinranka	12:9a20164dcc47	924	/*@{/
vipinranka	12:9a20164dcc47	925
vipinranka	12:9a20164dcc47	926
vipinranka	12:9a20164dcc47	927	/**
vipinranka	12:9a20164dcc47	928	* Open a pipe for reading
vipinranka	12:9a20164dcc47	929	* @note For compatibility with old code only, see new function
vipinranka	12:9a20164dcc47	930	*
vipinranka	12:9a20164dcc47	931	* @warning Pipes 1-5 should share the first 32 bits.
vipinranka	12:9a20164dcc47	932	* Only the least significant byte should be unique, e.g.
vipinranka	12:9a20164dcc47	933	* @code
vipinranka	12:9a20164dcc47	934	* openReadingPipe(1,0xF0F0F0F0AA);
vipinranka	12:9a20164dcc47	935	* openReadingPipe(2,0xF0F0F0F066);
vipinranka	12:9a20164dcc47	936	* @endcode
vipinranka	12:9a20164dcc47	937	*
vipinranka	12:9a20164dcc47	938	* @warning Pipe 0 is also used by the writing pipe. So if you open
vipinranka	12:9a20164dcc47	939	* pipe 0 for reading, and then startListening(), it will overwrite the
vipinranka	12:9a20164dcc47	940	* writing pipe. Ergo, do an openWritingPipe() again before write().
vipinranka	12:9a20164dcc47	941	*
vipinranka	12:9a20164dcc47	942	* @param number Which pipe# to open, 0-5.
vipinranka	12:9a20164dcc47	943	* @param address The 40-bit address of the pipe to open.
vipinranka	12:9a20164dcc47	944	*/
vipinranka	12:9a20164dcc47	945	void openReadingPipe(uint8_t number, uint64_t address);
vipinranka	12:9a20164dcc47	946
vipinranka	12:9a20164dcc47	947	/**
vipinranka	12:9a20164dcc47	948	* Open a pipe for writing
vipinranka	12:9a20164dcc47	949	* @note For compatibility with old code only, see new function
vipinranka	12:9a20164dcc47	950	*
vipinranka	12:9a20164dcc47	951	* Addresses are 40-bit hex values, e.g.:
vipinranka	12:9a20164dcc47	952	*
vipinranka	12:9a20164dcc47	953	* @code
vipinranka	12:9a20164dcc47	954	* openWritingPipe(0xF0F0F0F0F0);
vipinranka	12:9a20164dcc47	955	* @endcode
vipinranka	12:9a20164dcc47	956	*
vipinranka	12:9a20164dcc47	957	* @param address The 40-bit address of the pipe to open.
vipinranka	12:9a20164dcc47	958	*/
vipinranka	12:9a20164dcc47	959	void openWritingPipe(uint64_t address);
vipinranka	12:9a20164dcc47	960
vipinranka	12:9a20164dcc47	961	private:
vipinranka	12:9a20164dcc47	962
vipinranka	12:9a20164dcc47	963	/**
vipinranka	12:9a20164dcc47	964	* @name Low-level internal interface.
vipinranka	12:9a20164dcc47	965	*
vipinranka	12:9a20164dcc47	966	* Protected methods that address the chip directly. Regular users cannot
vipinranka	12:9a20164dcc47	967	* ever call these. They are documented for completeness and for developers who
vipinranka	12:9a20164dcc47	968	* may want to extend this class.
vipinranka	12:9a20164dcc47	969	*/
vipinranka	12:9a20164dcc47	970	/*@{/
vipinranka	12:9a20164dcc47	971
vipinranka	12:9a20164dcc47	972	/**
vipinranka	12:9a20164dcc47	973	* Set chip select pin
vipinranka	12:9a20164dcc47	974	*
vipinranka	12:9a20164dcc47	975	* Running SPI bus at PI_CLOCK_DIV2 so we don't waste time transferring data
vipinranka	12:9a20164dcc47	976	* and best of all, we make use of the radio's FIFO buffers. A lower speed
vipinranka	12:9a20164dcc47	977	* means we're less likely to effectively leverage our FIFOs and pay a higher
vipinranka	12:9a20164dcc47	978	* AVR runtime cost as toll.
vipinranka	12:9a20164dcc47	979	*
vipinranka	12:9a20164dcc47	980	* @param mode HIGH to take this unit off the SPI bus, LOW to put it on
vipinranka	12:9a20164dcc47	981	*/
vipinranka	12:9a20164dcc47	982	void csn(bool mode);
vipinranka	12:9a20164dcc47	983
vipinranka	12:9a20164dcc47	984	/**
vipinranka	12:9a20164dcc47	985	* Set chip enable
vipinranka	12:9a20164dcc47	986	*
vipinranka	12:9a20164dcc47	987	* @param level HIGH to actively begin transmission or LOW to put in standby. Please see data sheet
vipinranka	12:9a20164dcc47	988	* for a much more detailed description of this pin.
vipinranka	12:9a20164dcc47	989	*/
vipinranka	12:9a20164dcc47	990	void ce(bool level);
vipinranka	12:9a20164dcc47	991
vipinranka	12:9a20164dcc47	992	/**
vipinranka	12:9a20164dcc47	993	* Read a chunk of data in from a register
vipinranka	12:9a20164dcc47	994	*
vipinranka	12:9a20164dcc47	995	* @param reg Which register. Use constants from nRF24L01.h
vipinranka	12:9a20164dcc47	996	* @param buf Where to put the data
vipinranka	12:9a20164dcc47	997	* @param len How many bytes of data to transfer
vipinranka	12:9a20164dcc47	998	* @return Current value of status register
vipinranka	12:9a20164dcc47	999	*/
vipinranka	12:9a20164dcc47	1000	uint8_t read_register(uint8_t reg, uint8_t* buf, uint8_t len);
vipinranka	12:9a20164dcc47	1001
vipinranka	12:9a20164dcc47	1002	/**
vipinranka	12:9a20164dcc47	1003	* Read single byte from a register
vipinranka	12:9a20164dcc47	1004	*
vipinranka	12:9a20164dcc47	1005	* @param reg Which register. Use constants from nRF24L01.h
vipinranka	12:9a20164dcc47	1006	* @return Current value of register @p reg
vipinranka	12:9a20164dcc47	1007	*/
vipinranka	12:9a20164dcc47	1008	uint8_t read_register(uint8_t reg);
vipinranka	12:9a20164dcc47	1009
vipinranka	12:9a20164dcc47	1010	/**
vipinranka	12:9a20164dcc47	1011	* Write a chunk of data to a register
vipinranka	12:9a20164dcc47	1012	*
vipinranka	12:9a20164dcc47	1013	* @param reg Which register. Use constants from nRF24L01.h
vipinranka	12:9a20164dcc47	1014	* @param buf Where to get the data
vipinranka	12:9a20164dcc47	1015	* @param len How many bytes of data to transfer
vipinranka	12:9a20164dcc47	1016	* @return Current value of status register
vipinranka	12:9a20164dcc47	1017	*/
vipinranka	12:9a20164dcc47	1018	uint8_t write_register(uint8_t reg, const uint8_t* buf, uint8_t len);
vipinranka	12:9a20164dcc47	1019
vipinranka	12:9a20164dcc47	1020	/**
vipinranka	12:9a20164dcc47	1021	* Write a single byte to a register
vipinranka	12:9a20164dcc47	1022	*
vipinranka	12:9a20164dcc47	1023	* @param reg Which register. Use constants from nRF24L01.h
vipinranka	12:9a20164dcc47	1024	* @param value The new value to write
vipinranka	12:9a20164dcc47	1025	* @return Current value of status register
vipinranka	12:9a20164dcc47	1026	*/
vipinranka	12:9a20164dcc47	1027	uint8_t write_register(uint8_t reg, uint8_t value);
vipinranka	12:9a20164dcc47	1028
vipinranka	12:9a20164dcc47	1029	/**
vipinranka	12:9a20164dcc47	1030	* Write the transmit payload
vipinranka	12:9a20164dcc47	1031	*
vipinranka	12:9a20164dcc47	1032	* The size of data written is the fixed payload size, see getPayloadSize()
vipinranka	12:9a20164dcc47	1033	*
vipinranka	12:9a20164dcc47	1034	* @param buf Where to get the data
vipinranka	12:9a20164dcc47	1035	* @param len Number of bytes to be sent
vipinranka	12:9a20164dcc47	1036	* @return Current value of status register
vipinranka	12:9a20164dcc47	1037	*/
vipinranka	12:9a20164dcc47	1038	uint8_t write_payload(const void* buf, uint8_t len, const uint8_t writeType);
vipinranka	12:9a20164dcc47	1039
vipinranka	12:9a20164dcc47	1040	/**
vipinranka	12:9a20164dcc47	1041	* Read the receive payload
vipinranka	12:9a20164dcc47	1042	*
vipinranka	12:9a20164dcc47	1043	* The size of data read is the fixed payload size, see getPayloadSize()
vipinranka	12:9a20164dcc47	1044	*
vipinranka	12:9a20164dcc47	1045	* @param buf Where to put the data
vipinranka	12:9a20164dcc47	1046	* @param len Maximum number of bytes to read
vipinranka	12:9a20164dcc47	1047	* @return Current value of status register
vipinranka	12:9a20164dcc47	1048	*/
vipinranka	12:9a20164dcc47	1049	uint8_t read_payload(void* buf, uint8_t len);
vipinranka	12:9a20164dcc47	1050
vipinranka	12:9a20164dcc47	1051	/**
vipinranka	12:9a20164dcc47	1052	* Empty the receive buffer
vipinranka	12:9a20164dcc47	1053	*
vipinranka	12:9a20164dcc47	1054	* @return Current value of status register
vipinranka	12:9a20164dcc47	1055	*/
vipinranka	12:9a20164dcc47	1056	uint8_t flush_rx(void);
vipinranka	12:9a20164dcc47	1057
vipinranka	12:9a20164dcc47	1058	/**
vipinranka	12:9a20164dcc47	1059	* Retrieve the current status of the chip
vipinranka	12:9a20164dcc47	1060	*
vipinranka	12:9a20164dcc47	1061	* @return Current value of status register
vipinranka	12:9a20164dcc47	1062	*/
vipinranka	12:9a20164dcc47	1063	uint8_t get_status(void);
vipinranka	12:9a20164dcc47	1064
vipinranka	12:9a20164dcc47	1065	#if !defined (MINIMAL)
vipinranka	12:9a20164dcc47	1066	/**
vipinranka	12:9a20164dcc47	1067	* Decode and print the given status to stdout
vipinranka	12:9a20164dcc47	1068	*
vipinranka	12:9a20164dcc47	1069	* @param status Status value to print
vipinranka	12:9a20164dcc47	1070	*
vipinranka	12:9a20164dcc47	1071	* @warning Does nothing if stdout is not defined. See fdevopen in stdio.h
vipinranka	12:9a20164dcc47	1072	*/
vipinranka	12:9a20164dcc47	1073	void print_status(uint8_t status);
vipinranka	12:9a20164dcc47	1074
vipinranka	12:9a20164dcc47	1075	/**
vipinranka	12:9a20164dcc47	1076	* Decode and print the given 'observe_tx' value to stdout
vipinranka	12:9a20164dcc47	1077	*
vipinranka	12:9a20164dcc47	1078	* @param value The observe_tx value to print
vipinranka	12:9a20164dcc47	1079	*
vipinranka	12:9a20164dcc47	1080	* @warning Does nothing if stdout is not defined. See fdevopen in stdio.h
vipinranka	12:9a20164dcc47	1081	*/
vipinranka	12:9a20164dcc47	1082	void print_observe_tx(uint8_t value);
vipinranka	12:9a20164dcc47	1083
vipinranka	12:9a20164dcc47	1084	/**
vipinranka	12:9a20164dcc47	1085	* Print the name and value of an 8-bit register to stdout
vipinranka	12:9a20164dcc47	1086	*
vipinranka	12:9a20164dcc47	1087	* Optionally it can print some quantity of successive
vipinranka	12:9a20164dcc47	1088	* registers on the same line. This is useful for printing a group
vipinranka	12:9a20164dcc47	1089	* of related registers on one line.
vipinranka	12:9a20164dcc47	1090	*
vipinranka	12:9a20164dcc47	1091	* @param name Name of the register
vipinranka	12:9a20164dcc47	1092	* @param reg Which register. Use constants from nRF24L01.h
vipinranka	12:9a20164dcc47	1093	* @param qty How many successive registers to print
vipinranka	12:9a20164dcc47	1094	*/
vipinranka	12:9a20164dcc47	1095	void print_byte_register(const char* name, uint8_t reg, uint8_t qty = 1);
vipinranka	12:9a20164dcc47	1096
vipinranka	12:9a20164dcc47	1097	/**
vipinranka	12:9a20164dcc47	1098	* Print the name and value of a 40-bit address register to stdout
vipinranka	12:9a20164dcc47	1099	*
vipinranka	12:9a20164dcc47	1100	* Optionally it can print some quantity of successive
vipinranka	12:9a20164dcc47	1101	* registers on the same line. This is useful for printing a group
vipinranka	12:9a20164dcc47	1102	* of related registers on one line.
vipinranka	12:9a20164dcc47	1103	*
vipinranka	12:9a20164dcc47	1104	* @param name Name of the register
vipinranka	12:9a20164dcc47	1105	* @param reg Which register. Use constants from nRF24L01.h
vipinranka	12:9a20164dcc47	1106	* @param qty How many successive registers to print
vipinranka	12:9a20164dcc47	1107	*/
vipinranka	12:9a20164dcc47	1108	void print_address_register(const char* name, uint8_t reg, uint8_t qty = 1);
vipinranka	12:9a20164dcc47	1109	#endif
vipinranka	12:9a20164dcc47	1110	/**
vipinranka	12:9a20164dcc47	1111	* Turn on or off the special features of the chip
vipinranka	12:9a20164dcc47	1112	*
vipinranka	12:9a20164dcc47	1113	* The chip has certain 'features' which are only available when the 'features'
vipinranka	12:9a20164dcc47	1114	* are enabled. See the datasheet for details.
vipinranka	12:9a20164dcc47	1115	*/
vipinranka	12:9a20164dcc47	1116	void toggle_features(void);
vipinranka	12:9a20164dcc47	1117
vipinranka	12:9a20164dcc47	1118	/**
vipinranka	12:9a20164dcc47	1119	* Built in spi transfer function to simplify repeating code repeating code
vipinranka	12:9a20164dcc47	1120	*/
vipinranka	12:9a20164dcc47	1121
vipinranka	12:9a20164dcc47	1122	uint8_t spiTrans(uint8_t cmd);
vipinranka	12:9a20164dcc47	1123
vipinranka	12:9a20164dcc47	1124	#if defined (FAILURE_HANDLING) \|\| defined (RF24_LINUX)
vipinranka	12:9a20164dcc47	1125	void errNotify(void);
vipinranka	12:9a20164dcc47	1126	#endif
vipinranka	12:9a20164dcc47	1127
vipinranka	12:9a20164dcc47	1128	/*@}/
vipinranka	12:9a20164dcc47	1129
vipinranka	12:9a20164dcc47	1130	};
vipinranka	12:9a20164dcc47	1131
vipinranka	12:9a20164dcc47	1132
vipinranka	12:9a20164dcc47	1133	/**
vipinranka	12:9a20164dcc47	1134	* @example GettingStarted.ino
vipinranka	12:9a20164dcc47	1135	* <b>For Arduino</b><br>
vipinranka	12:9a20164dcc47	1136	* <b>Updated: TMRh20 2014 </b><br>
vipinranka	12:9a20164dcc47	1137	*
vipinranka	12:9a20164dcc47	1138	* This is an example of how to use the RF24 class to communicate on a basic level. Configure and write this sketch to two
vipinranka	12:9a20164dcc47	1139	* different nodes. Put one of the nodes into 'transmit' mode by connecting with the serial monitor and <br>
vipinranka	12:9a20164dcc47	1140	* sending a 'T'. The ping node sends the current time to the pong node, which responds by sending the value
vipinranka	12:9a20164dcc47	1141	* back. The ping node can then see how long the whole cycle took. <br>
vipinranka	12:9a20164dcc47	1142	* @note For a more efficient call-response scenario see the GettingStarted_CallResponse.ino example.
vipinranka	12:9a20164dcc47	1143	* @note When switching between sketches, the radio may need to be powered down to clear settings that are not "un-set" otherwise
vipinranka	12:9a20164dcc47	1144	*/
vipinranka	12:9a20164dcc47	1145
vipinranka	12:9a20164dcc47	1146	/**
vipinranka	12:9a20164dcc47	1147	* @example GettingStarted.cpp
vipinranka	12:9a20164dcc47	1148	* <b>For Raspberry Pi</b><br>
vipinranka	12:9a20164dcc47	1149	* <b>Updated: TMRh20 2014 </b><br>
vipinranka	12:9a20164dcc47	1150	*
vipinranka	12:9a20164dcc47	1151	* This is an example of how to use the RF24 class to communicate on a basic level. Configure and write this sketch to two
vipinranka	12:9a20164dcc47	1152	* different nodes. Put one of the nodes into 'transmit' mode by connecting with the serial monitor and <br>
vipinranka	12:9a20164dcc47	1153	* sending a 'T'. The ping node sends the current time to the pong node, which responds by sending the value
vipinranka	12:9a20164dcc47	1154	* back. The ping node can then see how long the whole cycle took. <br>
vipinranka	12:9a20164dcc47	1155	* @note For a more efficient call-response scenario see the GettingStarted_CallResponse.ino example.
vipinranka	12:9a20164dcc47	1156	*/
vipinranka	12:9a20164dcc47	1157
vipinranka	12:9a20164dcc47	1158	/**
vipinranka	12:9a20164dcc47	1159	* @example GettingStarted_CallResponse.ino
vipinranka	12:9a20164dcc47	1160	* <b>For Arduino</b><br>
vipinranka	12:9a20164dcc47	1161	* <b>New: TMRh20 2014</b><br>
vipinranka	12:9a20164dcc47	1162	*
vipinranka	12:9a20164dcc47	1163	* This example continues to make use of all the normal functionality of the radios including
vipinranka	12:9a20164dcc47	1164	* the auto-ack and auto-retry features, but allows ack-payloads to be written optionlly as well. <br>
vipinranka	12:9a20164dcc47	1165	* This allows very fast call-response communication, with the responding radio never having to
vipinranka	12:9a20164dcc47	1166	* switch out of Primary Receiver mode to send back a payload, but having the option to switch to <br>
vipinranka	12:9a20164dcc47	1167	* primary transmitter if wanting to initiate communication instead of respond to a commmunication.
vipinranka	12:9a20164dcc47	1168	*/
vipinranka	12:9a20164dcc47	1169
vipinranka	12:9a20164dcc47	1170	/**
vipinranka	12:9a20164dcc47	1171	* @example GettingStarted_Call_Response.cpp
vipinranka	12:9a20164dcc47	1172	* <b>For Raspberry Pi</b><br>
vipinranka	12:9a20164dcc47	1173	* <b>New: TMRh20 2014</b><br>
vipinranka	12:9a20164dcc47	1174	*
vipinranka	12:9a20164dcc47	1175	* This example continues to make use of all the normal functionality of the radios including
vipinranka	12:9a20164dcc47	1176	* the auto-ack and auto-retry features, but allows ack-payloads to be written optionlly as well. <br>
vipinranka	12:9a20164dcc47	1177	* This allows very fast call-response communication, with the responding radio never having to
vipinranka	12:9a20164dcc47	1178	* switch out of Primary Receiver mode to send back a payload, but having the option to switch to <br>
vipinranka	12:9a20164dcc47	1179	* primary transmitter if wanting to initiate communication instead of respond to a commmunication.
vipinranka	12:9a20164dcc47	1180	*/
vipinranka	12:9a20164dcc47	1181
vipinranka	12:9a20164dcc47	1182	/**
vipinranka	12:9a20164dcc47	1183	* @example GettingStarted_HandlingData.ino
vipinranka	12:9a20164dcc47	1184	* <b>Dec 2014 - TMRh20</b><br>
vipinranka	12:9a20164dcc47	1185	*
vipinranka	12:9a20164dcc47	1186	* This example demonstrates how to send multiple variables in a single payload and work with data. As usual, it is
vipinranka	12:9a20164dcc47	1187	* generally important to include an incrementing value like millis() in the payloads to prevent errors.
vipinranka	12:9a20164dcc47	1188	*/
vipinranka	12:9a20164dcc47	1189
vipinranka	12:9a20164dcc47	1190	/**
vipinranka	12:9a20164dcc47	1191	* @example Transfer.ino
vipinranka	12:9a20164dcc47	1192	* <b>For Arduino</b><br>
vipinranka	12:9a20164dcc47	1193	* This example demonstrates half-rate transfer using the FIFO buffers<br>
vipinranka	12:9a20164dcc47	1194	*
vipinranka	12:9a20164dcc47	1195	* It is an example of how to use the RF24 class. Write this sketch to two
vipinranka	12:9a20164dcc47	1196	* different nodes. Put one of the nodes into 'transmit' mode by connecting <br>
vipinranka	12:9a20164dcc47	1197	* with the serial monitor and sending a 'T'. The data transfer will begin,
vipinranka	12:9a20164dcc47	1198	* with the receiver displaying the payload count. (32Byte Payloads) <br>
vipinranka	12:9a20164dcc47	1199	*/
vipinranka	12:9a20164dcc47	1200
vipinranka	12:9a20164dcc47	1201	/**
vipinranka	12:9a20164dcc47	1202	* @example Transfer.cpp
vipinranka	12:9a20164dcc47	1203	* <b>For Raspberry Pi</b><br>
vipinranka	12:9a20164dcc47	1204	* This example demonstrates half-rate transfer using the FIFO buffers<br>
vipinranka	12:9a20164dcc47	1205	*
vipinranka	12:9a20164dcc47	1206	* It is an example of how to use the RF24 class. Write this sketch to two
vipinranka	12:9a20164dcc47	1207	* different nodes. Put one of the nodes into 'transmit' mode by connecting <br>
vipinranka	12:9a20164dcc47	1208	* with the serial monitor and sending a 'T'. The data transfer will begin,
vipinranka	12:9a20164dcc47	1209	* with the receiver displaying the payload count. (32Byte Payloads) <br>
vipinranka	12:9a20164dcc47	1210	*/
vipinranka	12:9a20164dcc47	1211
vipinranka	12:9a20164dcc47	1212	/**
vipinranka	12:9a20164dcc47	1213	* @example TransferTimeouts.ino
vipinranka	12:9a20164dcc47	1214	* <b>New: TMRh20 </b><br>
vipinranka	12:9a20164dcc47	1215	* This example demonstrates the use of and extended timeout period and
vipinranka	12:9a20164dcc47	1216	* auto-retries/auto-reUse to increase reliability in noisy or low signal scenarios. <br>
vipinranka	12:9a20164dcc47	1217	*
vipinranka	12:9a20164dcc47	1218	* Write this sketch to two different nodes. Put one of the nodes into 'transmit'
vipinranka	12:9a20164dcc47	1219	* mode by connecting with the serial monitor and sending a 'T'. The data <br>
vipinranka	12:9a20164dcc47	1220	* transfer will begin, with the receiver displaying the payload count and the
vipinranka	12:9a20164dcc47	1221	* data transfer rate.
vipinranka	12:9a20164dcc47	1222	*/
vipinranka	12:9a20164dcc47	1223
vipinranka	12:9a20164dcc47	1224	/**
vipinranka	12:9a20164dcc47	1225	* @example starping.pde
vipinranka	12:9a20164dcc47	1226	*
vipinranka	12:9a20164dcc47	1227	* This sketch is a more complex example of using the RF24 library for Arduino.
vipinranka	12:9a20164dcc47	1228	* Deploy this on up to six nodes. Set one as the 'pong receiver' by tying the
vipinranka	12:9a20164dcc47	1229	* role_pin low, and the others will be 'ping transmit' units. The ping units
vipinranka	12:9a20164dcc47	1230	* unit will send out the value of millis() once a second. The pong unit will
vipinranka	12:9a20164dcc47	1231	* respond back with a copy of the value. Each ping unit can get that response
vipinranka	12:9a20164dcc47	1232	* back, and determine how long the whole cycle took.
vipinranka	12:9a20164dcc47	1233	*
vipinranka	12:9a20164dcc47	1234	* This example requires a bit more complexity to determine which unit is which.
vipinranka	12:9a20164dcc47	1235	* The pong receiver is identified by having its role_pin tied to ground.
vipinranka	12:9a20164dcc47	1236	* The ping senders are further differentiated by a byte in eeprom.
vipinranka	12:9a20164dcc47	1237	*/
vipinranka	12:9a20164dcc47	1238
vipinranka	12:9a20164dcc47	1239	/**
vipinranka	12:9a20164dcc47	1240	* @example pingpair_ack.ino
vipinranka	12:9a20164dcc47	1241	* <b>Update: TMRh20</b><br>
vipinranka	12:9a20164dcc47	1242	* This example continues to make use of all the normal functionality of the radios including
vipinranka	12:9a20164dcc47	1243	* the auto-ack and auto-retry features, but allows ack-payloads to be written optionlly as well.<br>
vipinranka	12:9a20164dcc47	1244	* This allows very fast call-response communication, with the responding radio never having to
vipinranka	12:9a20164dcc47	1245	* switch out of Primary Receiver mode to send back a payload, but having the option to if wanting<br>
vipinranka	12:9a20164dcc47	1246	* to initiate communication instead of respond to a commmunication.
vipinranka	12:9a20164dcc47	1247	*/
vipinranka	12:9a20164dcc47	1248
vipinranka	12:9a20164dcc47	1249	/**
vipinranka	12:9a20164dcc47	1250	* @example pingpair_irq.ino
vipinranka	12:9a20164dcc47	1251	* <b>Update: TMRh20</b><br>
vipinranka	12:9a20164dcc47	1252	* This is an example of how to user interrupts to interact with the radio, and a demonstration
vipinranka	12:9a20164dcc47	1253	* of how to use them to sleep when receiving, and not miss any payloads.<br>
vipinranka	12:9a20164dcc47	1254	* The pingpair_sleepy example expands on sleep functionality with a timed sleep option for the transmitter.
vipinranka	12:9a20164dcc47	1255	* Sleep functionality is built directly into my fork of the RF24Network library<br>
vipinranka	12:9a20164dcc47	1256	*/
vipinranka	12:9a20164dcc47	1257
vipinranka	12:9a20164dcc47	1258	/**
vipinranka	12:9a20164dcc47	1259	* @example pingpair_irq_simple.ino
vipinranka	12:9a20164dcc47	1260	* <b>Dec 2014 - TMRh20</b><br>
vipinranka	12:9a20164dcc47	1261	* This is an example of how to user interrupts to interact with the radio, with bidirectional communication.
vipinranka	12:9a20164dcc47	1262	*/
vipinranka	12:9a20164dcc47	1263
vipinranka	12:9a20164dcc47	1264	/**
vipinranka	12:9a20164dcc47	1265	* @example pingpair_sleepy.ino
vipinranka	12:9a20164dcc47	1266	* <b>Update: TMRh20</b><br>
vipinranka	12:9a20164dcc47	1267	* This is an example of how to use the RF24 class to create a battery-
vipinranka	12:9a20164dcc47	1268	* efficient system. It is just like the GettingStarted_CallResponse example, but the<br>
vipinranka	12:9a20164dcc47	1269	* ping node powers down the radio and sleeps the MCU after every
vipinranka	12:9a20164dcc47	1270	* ping/pong cycle, and the receiver sleeps between payloads. <br>
vipinranka	12:9a20164dcc47	1271	*/
vipinranka	12:9a20164dcc47	1272
vipinranka	12:9a20164dcc47	1273	/**
vipinranka	12:9a20164dcc47	1274	* @example rf24ping85.ino
vipinranka	12:9a20164dcc47	1275	* <b>New: Contributed by https://github.com/tong67</b><br>
vipinranka	12:9a20164dcc47	1276	* This is an example of how to use the RF24 class to communicate with ATtiny85 and other node. <br>
vipinranka	12:9a20164dcc47	1277	*/
vipinranka	12:9a20164dcc47	1278
vipinranka	12:9a20164dcc47	1279	/**
vipinranka	12:9a20164dcc47	1280	* @example timingSearch3pin.ino
vipinranka	12:9a20164dcc47	1281	* <b>New: Contributed by https://github.com/tong67</b><br>
vipinranka	12:9a20164dcc47	1282	* This is an example of how to determine the correct timing for ATtiny when using only 3-pins
vipinranka	12:9a20164dcc47	1283	*/
vipinranka	12:9a20164dcc47	1284
vipinranka	12:9a20164dcc47	1285	/**
vipinranka	12:9a20164dcc47	1286	* @example pingpair_dyn.ino
vipinranka	12:9a20164dcc47	1287	*
vipinranka	12:9a20164dcc47	1288	* This is an example of how to use payloads of a varying (dynamic) size on Arduino.
vipinranka	12:9a20164dcc47	1289	*/
vipinranka	12:9a20164dcc47	1290
vipinranka	12:9a20164dcc47	1291	/**
vipinranka	12:9a20164dcc47	1292	* @example pingpair_dyn.cpp
vipinranka	12:9a20164dcc47	1293	*
vipinranka	12:9a20164dcc47	1294	* This is an example of how to use payloads of a varying (dynamic) size on Raspberry Pi.
vipinranka	12:9a20164dcc47	1295	*/
vipinranka	12:9a20164dcc47	1296
vipinranka	12:9a20164dcc47	1297	/**
vipinranka	12:9a20164dcc47	1298	* @example pingpair_dyn.py
vipinranka	12:9a20164dcc47	1299	*
vipinranka	12:9a20164dcc47	1300	* This is a python example for RPi of how to use payloads of a varying (dynamic) size.
vipinranka	12:9a20164dcc47	1301	*/
vipinranka	12:9a20164dcc47	1302
vipinranka	12:9a20164dcc47	1303	/**
vipinranka	12:9a20164dcc47	1304	* @example pingpair_dyn.ino
vipinranka	12:9a20164dcc47	1305	*
vipinranka	12:9a20164dcc47	1306	* This is an example of how to use payloads of a varying (dynamic) size.
vipinranka	12:9a20164dcc47	1307	*/
vipinranka	12:9a20164dcc47	1308
vipinranka	12:9a20164dcc47	1309	/**
vipinranka	12:9a20164dcc47	1310	* @example pingpair_dyn.ino
vipinranka	12:9a20164dcc47	1311	*
vipinranka	12:9a20164dcc47	1312	* This is an example of how to use payloads of a varying (dynamic) size.
vipinranka	12:9a20164dcc47	1313	*/
vipinranka	12:9a20164dcc47	1314
vipinranka	12:9a20164dcc47	1315	/**
vipinranka	12:9a20164dcc47	1316	* @example scanner.ino
vipinranka	12:9a20164dcc47	1317	*
vipinranka	12:9a20164dcc47	1318	* Example to detect interference on the various channels available.
vipinranka	12:9a20164dcc47	1319	* This is a good diagnostic tool to check whether you're picking a
vipinranka	12:9a20164dcc47	1320	* good channel for your application.
vipinranka	12:9a20164dcc47	1321	*
vipinranka	12:9a20164dcc47	1322	* Inspired by cpixip.
vipinranka	12:9a20164dcc47	1323	* See http://arduino.cc/forum/index.php/topic,54795.0.html
vipinranka	12:9a20164dcc47	1324	*/
vipinranka	12:9a20164dcc47	1325
vipinranka	12:9a20164dcc47	1326	/**
vipinranka	12:9a20164dcc47	1327	* @mainpage Optimized High Speed Driver for nRF24L01(+) 2.4GHz Wireless Transceiver
vipinranka	12:9a20164dcc47	1328	*
vipinranka	12:9a20164dcc47	1329	* @section Goals Design Goals
vipinranka	12:9a20164dcc47	1330	*
vipinranka	12:9a20164dcc47	1331	* This library fork is designed to be...
vipinranka	12:9a20164dcc47	1332	* @li More compliant with the manufacturer specified operation of the chip, while allowing advanced users
vipinranka	12:9a20164dcc47	1333	* to work outside the recommended operation.
vipinranka	12:9a20164dcc47	1334	* @li Utilize the capabilities of the radio to their full potential via Arduino
vipinranka	12:9a20164dcc47	1335	* @li More reliable, responsive, bug-free and feature rich
vipinranka	12:9a20164dcc47	1336	* @li Easy for beginners to use, with well documented examples and features
vipinranka	12:9a20164dcc47	1337	* @li Consumed with a public interface that's similar to other Arduino standard libraries
vipinranka	12:9a20164dcc47	1338	*
vipinranka	12:9a20164dcc47	1339	* @section News News
vipinranka	12:9a20164dcc47	1340	*
vipinranka	12:9a20164dcc47	1341	* Dec 2015<br>
vipinranka	12:9a20164dcc47	1342	* - ESP8266 support via Arduino IDE
vipinranka	12:9a20164dcc47	1343	* - <a href="https://github.com/stewarthou/Particle-RF24">Particle Photon/Core</a> fork available
vipinranka	12:9a20164dcc47	1344	* - ATTiny2313/4313 support added
vipinranka	12:9a20164dcc47	1345	* - Python 3 support added
vipinranka	12:9a20164dcc47	1346	* - RF24 added to Arduino library manager
vipinranka	12:9a20164dcc47	1347	* - RF24 added to PlatformIO library manager
vipinranka	12:9a20164dcc47	1348	*
vipinranka	12:9a20164dcc47	1349	* March 2015<br>
vipinranka	12:9a20164dcc47	1350	* - Uses SPI transactions on Arduino
vipinranka	12:9a20164dcc47	1351	* - New layout for <a href="Portability.html">easier portability:</a> Break out defines & includes for individual platforms to RF24/utility
vipinranka	12:9a20164dcc47	1352	* - <a href="MRAA.html">MRAA</a> support added ( Galileo, Edison, etc)
vipinranka	12:9a20164dcc47	1353	* - <a href="BBB.html">BBB/Generic Linux </a> support via spidev & MRAA
vipinranka	12:9a20164dcc47	1354	* - Support for RPi 2 added
vipinranka	12:9a20164dcc47	1355	* - Major Documentation cleanup & update (Move all docs to github.io)
vipinranka	12:9a20164dcc47	1356	*
vipinranka	12:9a20164dcc47	1357	*
vipinranka	12:9a20164dcc47	1358	* If issues are discovered with the documentation, please report them <a href="https://github.com/TMRh20/tmrh20.github.io/issues"> here</a>
vipinranka	12:9a20164dcc47	1359	*
vipinranka	12:9a20164dcc47	1360	* <br>
vipinranka	12:9a20164dcc47	1361	* @section Useful Useful References
vipinranka	12:9a20164dcc47	1362	*
vipinranka	12:9a20164dcc47	1363	*
vipinranka	12:9a20164dcc47	1364	* @li <a href="http://tmrh20.github.io/RF24/classRF24.html"><b>RF24</b> Class Documentation</a>
vipinranka	12:9a20164dcc47	1365	* @li <a href="https://github.com/TMRh20/RF24/archive/master.zip"><b>Download</b></a>
vipinranka	12:9a20164dcc47	1366	* @li <a href="https://github.com/tmrh20/RF24/"><b>Source Code</b></a>
vipinranka	12:9a20164dcc47	1367	* @li <a href="http://tmrh20.blogspot.com/2014/03/high-speed-data-transfers-and-wireless.html"><b>My Blog:</b> RF24 Optimization Overview</a>
vipinranka	12:9a20164dcc47	1368	* @li <a href="http://www.nordicsemi.com/files/Product/data_sheet/nRF24L01_Product_Specification_v2_0.pdf">Chip Datasheet</a>
vipinranka	12:9a20164dcc47	1369	*
vipinranka	12:9a20164dcc47	1370	* Additional Information and Add-ons
vipinranka	12:9a20164dcc47	1371	*
vipinranka	12:9a20164dcc47	1372	* @li <a href="http://tmrh20.github.io/RF24Network"> <b>RF24Network:</b> OSI Network Layer for multi-device communication. Create a home sensor network.</a>
vipinranka	12:9a20164dcc47	1373	* @li <a href="http://tmrh20.github.io/RF24Mesh"> <b>RF24Mesh:</b> Dynamic Mesh Layer for RF24Network</a>
vipinranka	12:9a20164dcc47	1374	* @li <a href="http://tmrh20.github.io/RF24Ethernet"> <b>RF24Ethernet:</b> TCP/IP Radio Mesh Networking (shares Arduino Ethernet API)</a>
vipinranka	12:9a20164dcc47	1375	* @li <a href="http://tmrh20.github.io/RF24Audio"> <b>RF24Audio:</b> Realtime Wireless Audio streaming</a>
vipinranka	12:9a20164dcc47	1376	* @li <a href="http://tmrh20.github.io/">All TMRh20 Documentation Main Page</a>
vipinranka	12:9a20164dcc47	1377	*
vipinranka	12:9a20164dcc47	1378	* More Information and RF24 Based Projects
vipinranka	12:9a20164dcc47	1379	*
vipinranka	12:9a20164dcc47	1380	* @li <a href="http://TMRh20.blogspot.com"> Project Blog: TMRh20.blogspot.com </a>
vipinranka	12:9a20164dcc47	1381	* @li <a href="http://maniacalbits.blogspot.ca/"> Maniacal Bits Blog</a>
vipinranka	12:9a20164dcc47	1382	* @li <a href="http://www.mysensors.org/">MySensors.org (User friendly sensor networks/IoT)</a>
vipinranka	12:9a20164dcc47	1383	* @li <a href="https://github.com/mannkind/RF24Node_MsgProto"> RF24Node_MsgProto (MQTT)</a>
vipinranka	12:9a20164dcc47	1384	* @li <a href="https://bitbucket.org/pjhardy/rf24sensornet/"> RF24SensorNet </a>
vipinranka	12:9a20164dcc47	1385	* @li <a href="http://www.homeautomationforgeeks.com/rf24software.shtml">Home Automation for Geeks</a>
vipinranka	12:9a20164dcc47	1386	* @li <a href="https://maniacbug.wordpress.com/2012/03/30/rf24network/"> Original Maniacbug RF24Network Blog Post</a>
vipinranka	12:9a20164dcc47	1387	* @li <a href="https://github.com/maniacbug/RF24"> ManiacBug on GitHub (Original Library Author)</a>
vipinranka	12:9a20164dcc47	1388	*
vipinranka	12:9a20164dcc47	1389	*
vipinranka	12:9a20164dcc47	1390	* <br>
vipinranka	12:9a20164dcc47	1391	*
vipinranka	12:9a20164dcc47	1392	* @section Platform_Support Platform Support Pages
vipinranka	12:9a20164dcc47	1393	*
vipinranka	12:9a20164dcc47	1394	* @li <a href="Arduino.html"><b>Arduino</b></a> (Uno, Nano, Mega, Due, Galileo, etc)
vipinranka	12:9a20164dcc47	1395	* @li <a href="ATTiny.html"><b>ATTiny</b></a>
vipinranka	12:9a20164dcc47	1396	* @li Linux ( <a href="RPi.html"><b>RPi</b></a> , <a href="BBB.html"><b>BBB</b></a>, <a href="MRAA.html"><b>MRAA</b></a> supported boards ( Galileo, Edison, etc))
vipinranka	12:9a20164dcc47	1397	* @li <a href="Python.html"><b>Python</b></a> wrapper available for RPi
vipinranka	12:9a20164dcc47	1398	*
vipinranka	12:9a20164dcc47	1399	* <br>
vipinranka	12:9a20164dcc47	1400	* General µC Pin layout (See the individual board support pages for more info)
vipinranka	12:9a20164dcc47	1401	*
vipinranka	12:9a20164dcc47	1402	* The table below shows how to connect the the pins of the NRF24L01(+) to different boards.
vipinranka	12:9a20164dcc47	1403	* CE and CSN are configurable.
vipinranka	12:9a20164dcc47	1404	*
vipinranka	12:9a20164dcc47	1405	* \| PIN \| NRF24L01 \| Arduino UNO \| ATtiny25/45/85 [0] \| ATtiny44/84 [1] \| LittleWire [2] \| RPI \| RPi -P1 Connector \|
vipinranka	12:9a20164dcc47	1406	* \|-----\|----------\|-------------\|--------------------\|-----------------\|-------------------------\|------------\|-------------------\|
vipinranka	12:9a20164dcc47	1407	* \| 1 \| GND \| GND \| pin 4 \| pin 14 \| GND \| rpi-gnd \| (25) \|
vipinranka	12:9a20164dcc47	1408	* \| 2 \| VCC \| 3.3V \| pin 8 \| pin 1 \| regulator 3.3V required \| rpi-3v3 \| (17) \|
vipinranka	12:9a20164dcc47	1409	* \| 3 \| CE \| digIO 7 \| pin 2 \| pin 12 \| pin to 3.3V \| rpi-gpio22 \| (15) \|
vipinranka	12:9a20164dcc47	1410	* \| 4 \| CSN \| digIO 8 \| pin 3 \| pin 11 \| RESET \| rpi-gpio8 \| (24) \|
vipinranka	12:9a20164dcc47	1411	* \| 5 \| SCK \| digIO 13 \| pin 7 \| pin 9 \| SCK \| rpi-sckl \| (23) \|
vipinranka	12:9a20164dcc47	1412	* \| 6 \| MOSI \| digIO 11 \| pin 6 \| pin 7 \| MOSI \| rpi-mosi \| (19) \|
vipinranka	12:9a20164dcc47	1413	* \| 7 \| MISO \| digIO 12 \| pin 5 \| pin 8 \| MISO \| rpi-miso \| (21) \|
vipinranka	12:9a20164dcc47	1414	* \| 8 \| IRQ \| - \| - \| - \| - \| - \| - \|
vipinranka	12:9a20164dcc47	1415	*
vipinranka	12:9a20164dcc47	1416	* @li [0] https://learn.sparkfun.com/tutorials/tiny-avr-programmer-hookup-guide/attiny85-use-hints
vipinranka	12:9a20164dcc47	1417	* @li [1] http://highlowtech.org/?p=1695
vipinranka	12:9a20164dcc47	1418	* @li [2] http://littlewire.cc/
vipinranka	12:9a20164dcc47	1419	* <br><br><br>
vipinranka	12:9a20164dcc47	1420	*
vipinranka	12:9a20164dcc47	1421	*
vipinranka	12:9a20164dcc47	1422	*
vipinranka	12:9a20164dcc47	1423	*
vipinranka	12:9a20164dcc47	1424	* @page Arduino Arduino
vipinranka	12:9a20164dcc47	1425	*
vipinranka	12:9a20164dcc47	1426	* RF24 is fully compatible with Arduino boards <br>
vipinranka	12:9a20164dcc47	1427	* See <b> http://www.arduino.cc/en/Reference/Board </b> and <b> http://arduino.cc/en/Reference/SPI </b> for more information
vipinranka	12:9a20164dcc47	1428	*
vipinranka	12:9a20164dcc47	1429	* RF24 makes use of the standard hardware SPI pins (MISO,MOSI,SCK) and requires two additional pins, to control
vipinranka	12:9a20164dcc47	1430	* the chip-select and chip-enable functions.<br>
vipinranka	12:9a20164dcc47	1431	* These pins must be chosen and designated by the user, in RF24 radio(ce_pin,cs_pin); and can use any
vipinranka	12:9a20164dcc47	1432	* available pins.
vipinranka	12:9a20164dcc47	1433	*
vipinranka	12:9a20164dcc47	1434	* <br>
vipinranka	12:9a20164dcc47	1435	* @section ARD_DUE Arduino Due
vipinranka	12:9a20164dcc47	1436	*
vipinranka	12:9a20164dcc47	1437	* RF24 makes use of the extended SPI functionality available on the Arduino Due, and requires one of the
vipinranka	12:9a20164dcc47	1438	* defined hardware SS/CS pins to be designated in RF24 radio(ce_pin,cs_pin);<br>
vipinranka	12:9a20164dcc47	1439	* See http://arduino.cc/en/Reference/DueExtendedSPI for more information
vipinranka	12:9a20164dcc47	1440	*
vipinranka	12:9a20164dcc47	1441	* Initial Due support taken from https://github.com/mcrosson/RF24/tree/due
vipinranka	12:9a20164dcc47	1442	*
vipinranka	12:9a20164dcc47	1443	* <br>
vipinranka	12:9a20164dcc47	1444	* @section Alternate_SPI Alternate SPI Support
vipinranka	12:9a20164dcc47	1445	*
vipinranka	12:9a20164dcc47	1446	* RF24 supports alternate SPI methods, in case the standard hardware SPI pins are otherwise unavailable.
vipinranka	12:9a20164dcc47	1447	*
vipinranka	12:9a20164dcc47	1448	* <br>
vipinranka	12:9a20164dcc47	1449	* Software Driven SPI
vipinranka	12:9a20164dcc47	1450	*
vipinranka	12:9a20164dcc47	1451	* Software driven SPI is provided by the <a href=https://github.com/greiman/DigitalIO>DigitalIO</a> library
vipinranka	12:9a20164dcc47	1452	*
vipinranka	12:9a20164dcc47	1453	* Setup:<br>
vipinranka	12:9a20164dcc47	1454	* 1. Install the digitalIO library<br>
vipinranka	12:9a20164dcc47	1455	* 2. Open RF24_config.h in a text editor. Uncomment the line #define SOFTSPI<br>
vipinranka	12:9a20164dcc47	1456	* 3. In your sketch, add #include DigitalIO.h
vipinranka	12:9a20164dcc47	1457	*
vipinranka	12:9a20164dcc47	1458	* @note Note: Pins are listed as follows and can be modified by editing the RF24_config.h file<br>
vipinranka	12:9a20164dcc47	1459	*
vipinranka	12:9a20164dcc47	1460	* const uint8_t SOFT_SPI_MISO_PIN = 16;
vipinranka	12:9a20164dcc47	1461	* const uint8_t SOFT_SPI_MOSI_PIN = 15;
vipinranka	12:9a20164dcc47	1462	* const uint8_t SOFT_SPI_SCK_PIN = 14;
vipinranka	12:9a20164dcc47	1463	*
vipinranka	12:9a20164dcc47	1464	* <br>
vipinranka	12:9a20164dcc47	1465	* Alternate Hardware (UART) Driven SPI
vipinranka	12:9a20164dcc47	1466	*
vipinranka	12:9a20164dcc47	1467	* The Serial Port (UART) on Arduino can also function in SPI mode, and can double-buffer data, while the
vipinranka	12:9a20164dcc47	1468	* default SPI hardware cannot.
vipinranka	12:9a20164dcc47	1469	*
vipinranka	12:9a20164dcc47	1470	* The SPI_UART library is available at https://github.com/TMRh20/Sketches/tree/master/SPI_UART
vipinranka	12:9a20164dcc47	1471	*
vipinranka	12:9a20164dcc47	1472	* Enabling:
vipinranka	12:9a20164dcc47	1473	* 1. Install the SPI_UART library
vipinranka	12:9a20164dcc47	1474	* 2. Edit RF24_config.h and uncomment #define SPI_UART
vipinranka	12:9a20164dcc47	1475	* 3. In your sketch, add @code #include <SPI_UART.h> @endcode
vipinranka	12:9a20164dcc47	1476	*
vipinranka	12:9a20164dcc47	1477	* SPI_UART SPI Pin Connections:
vipinranka	12:9a20164dcc47	1478	* \| NRF \|Arduino Uno Pin\|
vipinranka	12:9a20164dcc47	1479	* \|-----\|---------------\|
vipinranka	12:9a20164dcc47	1480	* \| MOSI\| TX(0) \|
vipinranka	12:9a20164dcc47	1481	* \| MISO\| RX(1) \|
vipinranka	12:9a20164dcc47	1482	* \| SCK \| XCK(4) \|
vipinranka	12:9a20164dcc47	1483	* \| CE \| User Specified\|
vipinranka	12:9a20164dcc47	1484	* \| CSN \| User Specified\|
vipinranka	12:9a20164dcc47	1485	*
vipinranka	12:9a20164dcc47	1486	*
vipinranka	12:9a20164dcc47	1487	* @note SPI_UART on Mega boards requires soldering to an unused pin on the chip. <br>See
vipinranka	12:9a20164dcc47	1488	* https://github.com/TMRh20/RF24/issues/24 for more information on SPI_UART.
vipinranka	12:9a20164dcc47	1489	*
vipinranka	12:9a20164dcc47	1490	* @page ATTiny ATTiny
vipinranka	12:9a20164dcc47	1491	*
vipinranka	12:9a20164dcc47	1492	* ATTiny support is built into the library, so users are not required to include SPI.h in their sketches<br>
vipinranka	12:9a20164dcc47	1493	* See the included rf24ping85 example for pin info and usage
vipinranka	12:9a20164dcc47	1494	*
vipinranka	12:9a20164dcc47	1495	* Some versions of Arduino IDE may require a patch to allow use of the full program space on ATTiny<br>
vipinranka	12:9a20164dcc47	1496	* See https://github.com/TCWORLD/ATTinyCore/tree/master/PCREL%20Patch%20for%20GCC for ATTiny patch
vipinranka	12:9a20164dcc47	1497	*
vipinranka	12:9a20164dcc47	1498	* ATTiny board support initially added from https://github.com/jscrane/RF24
vipinranka	12:9a20164dcc47	1499	*
vipinranka	12:9a20164dcc47	1500	* @section Hardware Hardware Configuration
vipinranka	12:9a20164dcc47	1501	* By tong67 ( https://github.com/tong67 )
vipinranka	12:9a20164dcc47	1502	*
vipinranka	12:9a20164dcc47	1503	* ATtiny25/45/85 Pin map with CE_PIN 3 and CSN_PIN 4
vipinranka	12:9a20164dcc47	1504	* @code
vipinranka	12:9a20164dcc47	1505	* +-\/-+
vipinranka	12:9a20164dcc47	1506	* NC PB5 1\|o \|8 Vcc --- nRF24L01 VCC, pin2 --- LED --- 5V
vipinranka	12:9a20164dcc47	1507	* nRF24L01 CE, pin3 --- PB3 2\| \|7 PB2 --- nRF24L01 SCK, pin5
vipinranka	12:9a20164dcc47	1508	* nRF24L01 CSN, pin4 --- PB4 3\| \|6 PB1 --- nRF24L01 MOSI, pin6
vipinranka	12:9a20164dcc47	1509	* nRF24L01 GND, pin1 --- GND 4\| \|5 PB0 --- nRF24L01 MISO, pin7
vipinranka	12:9a20164dcc47	1510	* +----+
vipinranka	12:9a20164dcc47	1511	* @endcode
vipinranka	12:9a20164dcc47	1512	*
vipinranka	12:9a20164dcc47	1513	* <br>
vipinranka	12:9a20164dcc47	1514	* ATtiny25/45/85 Pin map with CE_PIN 3 and CSN_PIN 3 => PB3 and PB4 are free to use for application <br>
vipinranka	12:9a20164dcc47	1515	* Circuit idea from http://nerdralph.blogspot.ca/2014/01/nrf24l01-control-with-3-attiny85-pins.html <br>
vipinranka	12:9a20164dcc47	1516	* Original RC combination was 1K/100nF. 22K/10nF combination worked better. <br>
vipinranka	12:9a20164dcc47	1517	* For best settletime delay value in RF24::csn() the timingSearch3pin.ino sketch can be used. <br>
vipinranka	12:9a20164dcc47	1518	* This configuration is enabled when CE_PIN and CSN_PIN are equal, e.g. both 3 <br>
vipinranka	12:9a20164dcc47	1519	* Because CE is always high the power consumption is higher than for 5 pins solution <br>
vipinranka	12:9a20164dcc47	1520	* @code
vipinranka	12:9a20164dcc47	1521	* ^^
vipinranka	12:9a20164dcc47	1522	* +-\/-+ nRF24L01 CE, pin3 ------\| //
vipinranka	12:9a20164dcc47	1523	* PB5 1\|o \|8 Vcc --- nRF24L01 VCC, pin2 ------x----------x--\|<\|-- 5V
vipinranka	12:9a20164dcc47	1524	* NC PB3 2\| \|7 PB2 --- nRF24L01 SCK, pin5 --\|<\|---x-[22k]--\| LED
vipinranka	12:9a20164dcc47	1525	* NC PB4 3\| \|6 PB1 --- nRF24L01 MOSI, pin6 1n4148 \|
vipinranka	12:9a20164dcc47	1526	* nRF24L01 GND, pin1 -x- GND 4\| \|5 PB0 --- nRF24L01 MISO, pin7 \|
vipinranka	12:9a20164dcc47	1527	* \| +----+ \|
vipinranka	12:9a20164dcc47	1528	* \|-----------------------------------------------\|\|----x-- nRF24L01 CSN, pin4
vipinranka	12:9a20164dcc47	1529	* 10nF
vipinranka	12:9a20164dcc47	1530	* @endcode
vipinranka	12:9a20164dcc47	1531	*
vipinranka	12:9a20164dcc47	1532	* <br>
vipinranka	12:9a20164dcc47	1533	* ATtiny24/44/84 Pin map with CE_PIN 8 and CSN_PIN 7 <br>
vipinranka	12:9a20164dcc47	1534	* Schematic provided and successfully tested by Carmine Pastore (https://github.com/Carminepz) <br>
vipinranka	12:9a20164dcc47	1535	* @code
vipinranka	12:9a20164dcc47	1536	* +-\/-+
vipinranka	12:9a20164dcc47	1537	* nRF24L01 VCC, pin2 --- VCC 1\|o \|14 GND --- nRF24L01 GND, pin1
vipinranka	12:9a20164dcc47	1538	* PB0 2\| \|13 AREF
vipinranka	12:9a20164dcc47	1539	* PB1 3\| \|12 PA1
vipinranka	12:9a20164dcc47	1540	* PB3 4\| \|11 PA2 --- nRF24L01 CE, pin3
vipinranka	12:9a20164dcc47	1541	* PB2 5\| \|10 PA3 --- nRF24L01 CSN, pin4
vipinranka	12:9a20164dcc47	1542	* PA7 6\| \|9 PA4 --- nRF24L01 SCK, pin5
vipinranka	12:9a20164dcc47	1543	* nRF24L01 MISO, pin7 --- PA6 7\| \|8 PA5 --- nRF24L01 MOSI, pin6
vipinranka	12:9a20164dcc47	1544	* +----+
vipinranka	12:9a20164dcc47	1545	* @endcode
vipinranka	12:9a20164dcc47	1546	*
vipinranka	12:9a20164dcc47	1547	* <br>
vipinranka	12:9a20164dcc47	1548	* ATtiny2313/4313 Pin map with CE_PIN 12 and CSN_PIN 13 <br>
vipinranka	12:9a20164dcc47	1549	* @code
vipinranka	12:9a20164dcc47	1550	* +-\/-+
vipinranka	12:9a20164dcc47	1551	* PA2 1\|o \|20 VCC --- nRF24L01 VCC, pin2
vipinranka	12:9a20164dcc47	1552	* PD0 2\| \|19 PB7 --- nRF24L01 SCK, pin5
vipinranka	12:9a20164dcc47	1553	* PD1 3\| \|18 PB6 --- nRF24L01 MOSI, pin6
vipinranka	12:9a20164dcc47	1554	* PA1 4\| \|17 PB5 --- nRF24L01 MISO, pin7
vipinranka	12:9a20164dcc47	1555	* PA0 5\| \|16 PB4 --- nRF24L01 CSN, pin4
vipinranka	12:9a20164dcc47	1556	* PD2 6\| \|15 PB3 --- nRF24L01 CE, pin3
vipinranka	12:9a20164dcc47	1557	* PD3 7\| \|14 PB2
vipinranka	12:9a20164dcc47	1558	* PD4 8\| \|13 PB1
vipinranka	12:9a20164dcc47	1559	* PD5 9\| \|12 PB0
vipinranka	12:9a20164dcc47	1560	* nRF24L01 GND, pin1 --- GND 10\| \|11 PD6
vipinranka	12:9a20164dcc47	1561	* +----+
vipinranka	12:9a20164dcc47	1562	* @endcode
vipinranka	12:9a20164dcc47	1563	*
vipinranka	12:9a20164dcc47	1564	* <br><br><br>
vipinranka	12:9a20164dcc47	1565	*
vipinranka	12:9a20164dcc47	1566	*
vipinranka	12:9a20164dcc47	1567	*
vipinranka	12:9a20164dcc47	1568	*
vipinranka	12:9a20164dcc47	1569	*
vipinranka	12:9a20164dcc47	1570	*
vipinranka	12:9a20164dcc47	1571	* @page BBB BeagleBone Black
vipinranka	12:9a20164dcc47	1572	*
vipinranka	12:9a20164dcc47	1573	* BeagleBone Black is supported via MRAA or SPIDEV.
vipinranka	12:9a20164dcc47	1574	*
vipinranka	12:9a20164dcc47	1575	* @note The SPIDEV option should work with most Linux systems supporting SPIDEV. <br>
vipinranka	12:9a20164dcc47	1576	* Users may need to edit the RF24/utility/BBB/spi.cpp file to configure the spi device. (Defaults: "/dev/spidev1.0"; or "/dev/spidev1.1"; )
vipinranka	12:9a20164dcc47	1577	*
vipinranka	12:9a20164dcc47	1578	* <br>
vipinranka	12:9a20164dcc47	1579	* @section AutoInstall Automated Install
vipinranka	12:9a20164dcc47	1580	(Designed & Tested on RPi* - Defaults to SPIDEV on BBB)
vipinranka	12:9a20164dcc47	1581	*
vipinranka	12:9a20164dcc47	1582	*
vipinranka	12:9a20164dcc47	1583	* 1. Download the install.sh file from http://tmrh20.github.io/RF24Installer/RPi/install.sh
vipinranka	12:9a20164dcc47	1584	* @code wget http://tmrh20.github.io/RF24Installer/RPi/install.sh @endcode
vipinranka	12:9a20164dcc47	1585	* 2. Make it executable:
vipinranka	12:9a20164dcc47	1586	* @code chmod +x install.sh @endcode
vipinranka	12:9a20164dcc47	1587	* 3. Run it and choose your options
vipinranka	12:9a20164dcc47	1588	* @code ./install.sh @endcode
vipinranka	12:9a20164dcc47	1589	* 4. Run an example from one of the libraries
vipinranka	12:9a20164dcc47	1590	* @code
vipinranka	12:9a20164dcc47	1591	* cd rf24libs/RF24/examples_RPi
vipinranka	12:9a20164dcc47	1592	* @endcode
vipinranka	12:9a20164dcc47	1593	* Edit the gettingstarted example, to set your pin configuration
vipinranka	12:9a20164dcc47	1594	* @code nano gettingstarted.cpp
vipinranka	12:9a20164dcc47	1595	* make
vipinranka	12:9a20164dcc47	1596	* sudo ./gettingstarted
vipinranka	12:9a20164dcc47	1597	* @endcode
vipinranka	12:9a20164dcc47	1598	*
vipinranka	12:9a20164dcc47	1599	* <br>
vipinranka	12:9a20164dcc47	1600	* @section ManInstall Manual Install
vipinranka	12:9a20164dcc47	1601	* 1. Make a directory to contain the RF24 and possibly RF24Network lib and enter it:
vipinranka	12:9a20164dcc47	1602	* @code
vipinranka	12:9a20164dcc47	1603	* mkdir ~/rf24libs
vipinranka	12:9a20164dcc47	1604	* cd ~/rf24libs
vipinranka	12:9a20164dcc47	1605	* @endcode
vipinranka	12:9a20164dcc47	1606	* 2. Clone the RF24 repo:
vipinranka	12:9a20164dcc47	1607	* @code git clone https://github.com/tmrh20/RF24.git RF24 @endcode
vipinranka	12:9a20164dcc47	1608	* 3. Change to the new RF24 directory
vipinranka	12:9a20164dcc47	1609	* @code cd RF24 @endcode
vipinranka	12:9a20164dcc47	1610	* 4. Build the library, and run an example file:
vipinranka	12:9a20164dcc47	1611	* Note: See the <a href="http://iotdk.intel.com/docs/master/mraa/index.html">MRAA </a> documentation for more info on installing MRAA
vipinranka	12:9a20164dcc47	1612	* @code sudo make install OR sudo make install RF24_MRAA=1 @endcode
vipinranka	12:9a20164dcc47	1613	* @code
vipinranka	12:9a20164dcc47	1614	* cd examples_RPi
vipinranka	12:9a20164dcc47	1615	* @endcode
vipinranka	12:9a20164dcc47	1616	* Edit the gettingstarted example, to set your pin configuration
vipinranka	12:9a20164dcc47	1617	* @code nano gettingstarted.cpp
vipinranka	12:9a20164dcc47	1618	* make
vipinranka	12:9a20164dcc47	1619	* sudo ./gettingstarted
vipinranka	12:9a20164dcc47	1620	* @endcode
vipinranka	12:9a20164dcc47	1621	*
vipinranka	12:9a20164dcc47	1622	* <br><br>
vipinranka	12:9a20164dcc47	1623	*
vipinranka	12:9a20164dcc47	1624	* @page MRAA MRAA
vipinranka	12:9a20164dcc47	1625	*
vipinranka	12:9a20164dcc47	1626	* MRAA is a Low Level Skeleton Library for Communication on GNU/Linux platforms <br>
vipinranka	12:9a20164dcc47	1627	* See http://iotdk.intel.com/docs/master/mraa/index.html for more information
vipinranka	12:9a20164dcc47	1628	*
vipinranka	12:9a20164dcc47	1629	* RF24 supports all MRAA supported platforms, but might not be tested on each individual platform due to the wide range of hardware support:<br>
vipinranka	12:9a20164dcc47	1630	* <a href="https://github.com/TMRh20/RF24/issues">Report an RF24 bug or issue </a>
vipinranka	12:9a20164dcc47	1631	*
vipinranka	12:9a20164dcc47	1632	* @section Setup Setup
vipinranka	12:9a20164dcc47	1633	* 1. Install the MRAA lib
vipinranka	12:9a20164dcc47	1634	* 2. As per your device, SPI may need to be enabled
vipinranka	12:9a20164dcc47	1635	*
vipinranka	12:9a20164dcc47	1636	* @section MRAA_Install Install
vipinranka	12:9a20164dcc47	1637	*
vipinranka	12:9a20164dcc47	1638	* 1. Make a directory to contain the RF24 and possibly RF24Network lib and enter it:
vipinranka	12:9a20164dcc47	1639	* @code
vipinranka	12:9a20164dcc47	1640	* mkdir ~/rf24libs
vipinranka	12:9a20164dcc47	1641	* cd ~/rf24libs
vipinranka	12:9a20164dcc47	1642	* @endcode
vipinranka	12:9a20164dcc47	1643	* 2. Clone the RF24 repo:
vipinranka	12:9a20164dcc47	1644	* @code git clone https://github.com/tmrh20/RF24.git RF24 @endcode
vipinranka	12:9a20164dcc47	1645	* 3. Change to the new RF24 directory
vipinranka	12:9a20164dcc47	1646	* @code cd RF24 @endcode
vipinranka	12:9a20164dcc47	1647	* 4. Build the library:
vipinranka	12:9a20164dcc47	1648	* @code sudo make install -B RF24_MRAA=1 @endcode
vipinranka	12:9a20164dcc47	1649	* 5. Configure the correct pins in gettingstarted.cpp (See http://iotdk.intel.com/docs/master/mraa/index.html )
vipinranka	12:9a20164dcc47	1650	* @code
vipinranka	12:9a20164dcc47	1651	* cd examples_RPi
vipinranka	12:9a20164dcc47	1652	* nano gettingstarted.cpp
vipinranka	12:9a20164dcc47	1653	* @endcode
vipinranka	12:9a20164dcc47	1654	* 6. Build an example
vipinranka	12:9a20164dcc47	1655	* @code
vipinranka	12:9a20164dcc47	1656	* make
vipinranka	12:9a20164dcc47	1657	* sudo ./gettingstarted
vipinranka	12:9a20164dcc47	1658	* @endcode
vipinranka	12:9a20164dcc47	1659	*
vipinranka	12:9a20164dcc47	1660	* <br><br><br>
vipinranka	12:9a20164dcc47	1661	*
vipinranka	12:9a20164dcc47	1662	*
vipinranka	12:9a20164dcc47	1663	*
vipinranka	12:9a20164dcc47	1664	*
vipinranka	12:9a20164dcc47	1665	* @page RPi Raspberry Pi
vipinranka	12:9a20164dcc47	1666	*
vipinranka	12:9a20164dcc47	1667	* RF24 supports a variety of Linux based devices via various drivers. Some boards like RPi can utilize multiple methods
vipinranka	12:9a20164dcc47	1668	* to drive the GPIO and SPI functionality.
vipinranka	12:9a20164dcc47	1669	*
vipinranka	12:9a20164dcc47	1670	* <br>
vipinranka	12:9a20164dcc47	1671	* @section PreConfig Potential PreConfiguration
vipinranka	12:9a20164dcc47	1672	*
vipinranka	12:9a20164dcc47	1673	* If SPI is not already enabled, load it on boot:
vipinranka	12:9a20164dcc47	1674	* @code sudo raspi-config @endcode
vipinranka	12:9a20164dcc47	1675	* A. Update the tool via the menu as required<br>
vipinranka	12:9a20164dcc47	1676	* B. Select Advanced and enable the SPI kernel module <br>
vipinranka	12:9a20164dcc47	1677	* C. Update other software and libraries:
vipinranka	12:9a20164dcc47	1678	* @code sudo apt-get update @endcode
vipinranka	12:9a20164dcc47	1679	* @code sudo apt-get upgrade @endcode
vipinranka	12:9a20164dcc47	1680	* <br>
vipinranka	12:9a20164dcc47	1681	* @section AutoInstall Automated Install
vipinranka	12:9a20164dcc47	1682	*
vipinranka	12:9a20164dcc47	1683	* 1. Download the install.sh file from http://tmrh20.github.io/RF24Installer/RPi/install.sh
vipinranka	12:9a20164dcc47	1684	* @code wget http://tmrh20.github.io/RF24Installer/RPi/install.sh @endcode
vipinranka	12:9a20164dcc47	1685	* 2. Make it executable:
vipinranka	12:9a20164dcc47	1686	* @code chmod +x install.sh @endcode
vipinranka	12:9a20164dcc47	1687	* 3. Run it and choose your options
vipinranka	12:9a20164dcc47	1688	* @code ./install.sh @endcode
vipinranka	12:9a20164dcc47	1689	* 4. Run an example from one of the libraries
vipinranka	12:9a20164dcc47	1690	* @code
vipinranka	12:9a20164dcc47	1691	* cd rf24libs/RF24/examples_RPi
vipinranka	12:9a20164dcc47	1692	* make
vipinranka	12:9a20164dcc47	1693	* sudo ./gettingstarted
vipinranka	12:9a20164dcc47	1694	* @endcode
vipinranka	12:9a20164dcc47	1695	* <br><br>
vipinranka	12:9a20164dcc47	1696	* @section ManInstall Manual Install
vipinranka	12:9a20164dcc47	1697	* 1. Make a directory to contain the RF24 and possibly RF24Network lib and enter it:
vipinranka	12:9a20164dcc47	1698	* @code
vipinranka	12:9a20164dcc47	1699	* mkdir ~/rf24libs
vipinranka	12:9a20164dcc47	1700	* cd ~/rf24libs
vipinranka	12:9a20164dcc47	1701	* @endcode
vipinranka	12:9a20164dcc47	1702	* 2. Clone the RF24 repo:
vipinranka	12:9a20164dcc47	1703	* @code git clone https://github.com/tmrh20/RF24.git RF24 @endcode
vipinranka	12:9a20164dcc47	1704	* 3. Change to the new RF24 directory
vipinranka	12:9a20164dcc47	1705	* @code cd RF24 @endcode
vipinranka	12:9a20164dcc47	1706	* 4. Build the library, and run an example file:
vipinranka	12:9a20164dcc47	1707	* @code sudo make install
vipinranka	12:9a20164dcc47	1708	* cd examples_RPi
vipinranka	12:9a20164dcc47	1709	* make
vipinranka	12:9a20164dcc47	1710	* sudo ./gettingstarted
vipinranka	12:9a20164dcc47	1711	* @endcode
vipinranka	12:9a20164dcc47	1712	*
vipinranka	12:9a20164dcc47	1713	* <br><br>
vipinranka	12:9a20164dcc47	1714	* @section Build Build Options
vipinranka	12:9a20164dcc47	1715	* The default build on Raspberry Pi utilizes the included BCM2835 driver from http://www.airspayce.com/mikem/bcm2835
vipinranka	12:9a20164dcc47	1716	* 1. @code sudo make install -B @endcode
vipinranka	12:9a20164dcc47	1717	*
vipinranka	12:9a20164dcc47	1718	* Build using the MRAA library from http://iotdk.intel.com/docs/master/mraa/index.html <br>
vipinranka	12:9a20164dcc47	1719	* MRAA is not included. See the <a href="MRAA.html">MRAA</a> platform page for more information.
vipinranka	12:9a20164dcc47	1720	*
vipinranka	12:9a20164dcc47	1721	* 1. Install, and build MRAA:
vipinranka	12:9a20164dcc47	1722	* @code
vipinranka	12:9a20164dcc47	1723	* git clone https://github.com/intel-iot-devkit/mraa.git
vipinranka	12:9a20164dcc47	1724	* cd mraa
vipinranka	12:9a20164dcc47	1725	* mkdir build
vipinranka	12:9a20164dcc47	1726	* cd build
vipinranka	12:9a20164dcc47	1727	* cmake .. -DBUILDSWIGNODE=OFF
vipinranka	12:9a20164dcc47	1728	* sudo make install
vipinranka	12:9a20164dcc47	1729	* @endcode
vipinranka	12:9a20164dcc47	1730	*
vipinranka	12:9a20164dcc47	1731	* 2. Complete the install <br>
vipinranka	12:9a20164dcc47	1732	* @code nano /etc/ld.so.conf @endcode
vipinranka	12:9a20164dcc47	1733	* Add the line @code /usr/local/lib/arm-linux-gnueabihf @endcode
vipinranka	12:9a20164dcc47	1734	* Run @code sudo ldconfig @endcode
vipinranka	12:9a20164dcc47	1735	*
vipinranka	12:9a20164dcc47	1736	* 3. Install RF24, using MRAA
vipinranka	12:9a20164dcc47	1737	* @code sudo make install -B RF24_MRAA=1 @endcode
vipinranka	12:9a20164dcc47	1738	* See the gettingstarted example for an example of pin configuration
vipinranka	12:9a20164dcc47	1739	*
vipinranka	12:9a20164dcc47	1740	* Build using spidev:
vipinranka	12:9a20164dcc47	1741	*
vipinranka	12:9a20164dcc47	1742	* 1. Edit the RF24/utility/BBB/spi.cpp file
vipinranka	12:9a20164dcc47	1743	* 2. Change the default device definition to @code this->device = "/dev/spidev0.0";; @endcode
vipinranka	12:9a20164dcc47	1744	* 3. Run @code sudo make install -B RF24_SPIDEV=1 @endcode
vipinranka	12:9a20164dcc47	1745	* 4. See the gettingstarted example for an example of pin configuration
vipinranka	12:9a20164dcc47	1746	*
vipinranka	12:9a20164dcc47	1747	* <br>
vipinranka	12:9a20164dcc47	1748	* @section Pins Connections and Pin Configuration
vipinranka	12:9a20164dcc47	1749	*
vipinranka	12:9a20164dcc47	1750	*
vipinranka	12:9a20164dcc47	1751	* Using pin 15/GPIO 22 for CE, pin 24/GPIO8 (CE0) for CSN
vipinranka	12:9a20164dcc47	1752	*
vipinranka	12:9a20164dcc47	1753	* Can use either RPi CE0 or CE1 pins for radio CSN.<br>
vipinranka	12:9a20164dcc47	1754	* Choose any RPi output pin for radio CE pin.
vipinranka	12:9a20164dcc47	1755	*
vipinranka	12:9a20164dcc47	1756	* BCM2835 Constructor:
vipinranka	12:9a20164dcc47	1757	* @code
vipinranka	12:9a20164dcc47	1758	* RF24 radio(RPI_V2_GPIO_P1_15,BCM2835_SPI_CS0, BCM2835_SPI_SPEED_8MHZ);
vipinranka	12:9a20164dcc47	1759	* or
vipinranka	12:9a20164dcc47	1760	* RF24 radio(RPI_V2_GPIO_P1_15,BCM2835_SPI_CS1, BCM2835_SPI_SPEED_8MHZ);
vipinranka	12:9a20164dcc47	1761	*
vipinranka	12:9a20164dcc47	1762	* RPi B+:
vipinranka	12:9a20164dcc47	1763	* RF24 radio(RPI_BPLUS_GPIO_J8_15,RPI_BPLUS_GPIO_J8_24, BCM2835_SPI_SPEED_8MHZ);
vipinranka	12:9a20164dcc47	1764	* or
vipinranka	12:9a20164dcc47	1765	* RF24 radio(RPI_BPLUS_GPIO_J8_15,RPI_BPLUS_GPIO_J8_26, BCM2835_SPI_SPEED_8MHZ);
vipinranka	12:9a20164dcc47	1766	*
vipinranka	12:9a20164dcc47	1767	* General:
vipinranka	12:9a20164dcc47	1768	* RF24 radio(22,0);
vipinranka	12:9a20164dcc47	1769	* or
vipinranka	12:9a20164dcc47	1770	* RF24 radio(22,1);
vipinranka	12:9a20164dcc47	1771	*
vipinranka	12:9a20164dcc47	1772	* @endcode
vipinranka	12:9a20164dcc47	1773	* See the gettingstarted example for an example of pin configuration
vipinranka	12:9a20164dcc47	1774	*
vipinranka	12:9a20164dcc47	1775	* See http://www.airspayce.com/mikem/bcm2835/index.html for BCM2835 class documentation.
vipinranka	12:9a20164dcc47	1776	* <br><br>
vipinranka	12:9a20164dcc47	1777	* MRAA Constructor:
vipinranka	12:9a20164dcc47	1778	*
vipinranka	12:9a20164dcc47	1779	* @code RF24 radio(15,0); @endcode
vipinranka	12:9a20164dcc47	1780	*
vipinranka	12:9a20164dcc47	1781	* See http://iotdk.intel.com/docs/master/mraa/rasppi.html
vipinranka	12:9a20164dcc47	1782	* <br><br>
vipinranka	12:9a20164dcc47	1783	* SPI_DEV Constructor
vipinranka	12:9a20164dcc47	1784	*
vipinranka	12:9a20164dcc47	1785	* @code RF24 radio(22,0); @endcode
vipinranka	12:9a20164dcc47	1786	*
vipinranka	12:9a20164dcc47	1787	* See http://pi.gadgetoid.com/pinout
vipinranka	12:9a20164dcc47	1788	*
vipinranka	12:9a20164dcc47	1789	* Pins:
vipinranka	12:9a20164dcc47	1790	*
vipinranka	12:9a20164dcc47	1791	* \| PIN \| NRF24L01 \| RPI \| RPi -P1 Connector \|
vipinranka	12:9a20164dcc47	1792	* \|-----\|----------\|------------\|-------------------\|
vipinranka	12:9a20164dcc47	1793	* \| 1 \| GND \| rpi-gnd \| (25) \|
vipinranka	12:9a20164dcc47	1794	* \| 2 \| VCC \| rpi-3v3 \| (17) \|
vipinranka	12:9a20164dcc47	1795	* \| 3 \| CE \| rpi-gpio22 \| (15) \|
vipinranka	12:9a20164dcc47	1796	* \| 4 \| CSN \| rpi-gpio8 \| (24) \|
vipinranka	12:9a20164dcc47	1797	* \| 5 \| SCK \| rpi-sckl \| (23) \|
vipinranka	12:9a20164dcc47	1798	* \| 6 \| MOSI \| rpi-mosi \| (19) \|
vipinranka	12:9a20164dcc47	1799	* \| 7 \| MISO \| rpi-miso \| (21) \|
vipinranka	12:9a20164dcc47	1800	* \| 8 \| IRQ \| - \| - \|
vipinranka	12:9a20164dcc47	1801	*
vipinranka	12:9a20164dcc47	1802	*
vipinranka	12:9a20164dcc47	1803	*
vipinranka	12:9a20164dcc47	1804	*
vipinranka	12:9a20164dcc47	1805	* <br><br>
vipinranka	12:9a20164dcc47	1806	****************
vipinranka	12:9a20164dcc47	1807	*
vipinranka	12:9a20164dcc47	1808	* Based on the arduino lib from J. Coliz <maniacbug@ymail.com> <br>
vipinranka	12:9a20164dcc47	1809	* the library was berryfied by Purinda Gunasekara <purinda@gmail.com> <br>
vipinranka	12:9a20164dcc47	1810	* then forked from github stanleyseow/RF24 to https://github.com/jscrane/RF24-rpi <br>
vipinranka	12:9a20164dcc47	1811	* Network lib also based on https://github.com/farconada/RF24Network
vipinranka	12:9a20164dcc47	1812	*
vipinranka	12:9a20164dcc47	1813	*
vipinranka	12:9a20164dcc47	1814	*
vipinranka	12:9a20164dcc47	1815	*
vipinranka	12:9a20164dcc47	1816	* <br><br><br>
vipinranka	12:9a20164dcc47	1817	*
vipinranka	12:9a20164dcc47	1818	*
vipinranka	12:9a20164dcc47	1819	*
vipinranka	12:9a20164dcc47	1820	* @page Python Python Wrapper (by https://github.com/mz-fuzzy)
vipinranka	12:9a20164dcc47	1821	*
vipinranka	12:9a20164dcc47	1822	* @section Install Installation:
vipinranka	12:9a20164dcc47	1823	*
vipinranka	12:9a20164dcc47	1824	* Install the boost libraries: (Note: Only the python libraries should be needed, this is just for simplicity)
vipinranka	12:9a20164dcc47	1825	*
vipinranka	12:9a20164dcc47	1826	* @code sudo apt-get install libboost1.50-all @endcode
vipinranka	12:9a20164dcc47	1827	*
vipinranka	12:9a20164dcc47	1828	* Build the library:
vipinranka	12:9a20164dcc47	1829	*
vipinranka	12:9a20164dcc47	1830	* @code ./setup.py build @endcode
vipinranka	12:9a20164dcc47	1831	*
vipinranka	12:9a20164dcc47	1832	* Install the library
vipinranka	12:9a20164dcc47	1833	*
vipinranka	12:9a20164dcc47	1834	* @code sudo ./setup.py install @endcode
vipinranka	12:9a20164dcc47	1835	*
vipinranka	12:9a20164dcc47	1836	*
vipinranka	12:9a20164dcc47	1837	* See the additional <a href="pages.html">Platform Support</a> pages for information on connecting your hardware <br>
vipinranka	12:9a20164dcc47	1838	* See the included <a href="pingpair_dyn_8py-example.html">example </a> for usage information.
vipinranka	12:9a20164dcc47	1839	*
vipinranka	12:9a20164dcc47	1840	* Running the Example:
vipinranka	12:9a20164dcc47	1841	*
vipinranka	12:9a20164dcc47	1842	* Edit the pingpair_dyn.py example to configure the appropriate pins per the above documentation:
vipinranka	12:9a20164dcc47	1843	*
vipinranka	12:9a20164dcc47	1844	* @code nano pingpair_dyn.py @endcode
vipinranka	12:9a20164dcc47	1845	*
vipinranka	12:9a20164dcc47	1846	* Configure another device, Arduino or RPi with the <a href="pingpair_dyn_8py-example.html">pingpair_dyn</a> example
vipinranka	12:9a20164dcc47	1847	*
vipinranka	12:9a20164dcc47	1848	* Run the example
vipinranka	12:9a20164dcc47	1849	*
vipinranka	12:9a20164dcc47	1850	* @code sudo ./pingpair_dyn.py @endcode
vipinranka	12:9a20164dcc47	1851	*
vipinranka	12:9a20164dcc47	1852	* <br><br><br>
vipinranka	12:9a20164dcc47	1853	*
vipinranka	12:9a20164dcc47	1854	*
vipinranka	12:9a20164dcc47	1855	* @page Portability RF24 Portability
vipinranka	12:9a20164dcc47	1856	*
vipinranka	12:9a20164dcc47	1857	* The RF24 radio driver mainly utilizes the <a href="http://arduino.cc/en/reference/homePage">Arduino API</a> for GPIO, SPI, and timing functions, which are easily replicated
vipinranka	12:9a20164dcc47	1858	* on various platforms. <br>Support files for these platforms are stored under RF24/utility, and can be modified to provide
vipinranka	12:9a20164dcc47	1859	* the required functionality.
vipinranka	12:9a20164dcc47	1860	*
vipinranka	12:9a20164dcc47	1861	* <br>
vipinranka	12:9a20164dcc47	1862	* @section Hardware_Templates Basic Hardware Template
vipinranka	12:9a20164dcc47	1863	*
vipinranka	12:9a20164dcc47	1864	* RF24/utility
vipinranka	12:9a20164dcc47	1865	*
vipinranka	12:9a20164dcc47	1866	* The RF24 library now includes a basic hardware template to assist in porting to various platforms. <br> The following files can be included
vipinranka	12:9a20164dcc47	1867	* to replicate standard Arduino functions as needed, allowing devices from ATTiny to Raspberry Pi to utilize the same core RF24 driver.
vipinranka	12:9a20164dcc47	1868	*
vipinranka	12:9a20164dcc47	1869	* \| File \| Purpose \|
vipinranka	12:9a20164dcc47	1870	* \|--------------------\|------------------------------------------------------------------------------\|
vipinranka	12:9a20164dcc47	1871	* \| RF24_arch_config.h \| Basic Arduino/AVR compatibility, includes for remaining support files, etc \|
vipinranka	12:9a20164dcc47	1872	* \| includes.h \| Linux only. Defines specific platform, include correct RF24_arch_config file \|
vipinranka	12:9a20164dcc47	1873	* \| spi.h \| Provides standardized SPI ( transfer() ) methods \|
vipinranka	12:9a20164dcc47	1874	* \| gpio.h \| Provides standardized GPIO ( digitalWrite() ) methods \|
vipinranka	12:9a20164dcc47	1875	* \| compatibility.h \| Provides standardized timing (millis(), delay()) methods \|
vipinranka	12:9a20164dcc47	1876	* \| your_custom_file.h \| Provides access to custom drivers for spi,gpio, etc \|
vipinranka	12:9a20164dcc47	1877	*
vipinranka	12:9a20164dcc47	1878	* <br>
vipinranka	12:9a20164dcc47	1879	* Examples are provided via the included hardware support templates in RF24/utility <br>
vipinranka	12:9a20164dcc47	1880	* See the <a href="modules.html">modules</a> page for examples of class declarations
vipinranka	12:9a20164dcc47	1881	*
vipinranka	12:9a20164dcc47	1882	*<br>
vipinranka	12:9a20164dcc47	1883	* @section Device_Detection Device Detection
vipinranka	12:9a20164dcc47	1884	*
vipinranka	12:9a20164dcc47	1885	* 1. The main detection for Linux devices is done in the Makefile, with the includes.h from the proper hardware directory copied to RF24/utility/includes.h <br>
vipinranka	12:9a20164dcc47	1886	* 2. Secondary detection is completed in RF24_config.h, causing the include.h file to be included for all supported Linux devices <br>
vipinranka	12:9a20164dcc47	1887	* 3. RF24.h contains the declaration for SPI and GPIO objects 'spi' and 'gpio' to be used for porting-in related functions.
vipinranka	12:9a20164dcc47	1888	*
vipinranka	12:9a20164dcc47	1889	* <br>
vipinranka	12:9a20164dcc47	1890	* @section Ported_Code Code
vipinranka	12:9a20164dcc47	1891	* To have your ported code included in this library, or for assistance in porting, create a pull request or open an issue at https://github.com/TMRh20/RF24
vipinranka	12:9a20164dcc47	1892	*
vipinranka	12:9a20164dcc47	1893	*
vipinranka	12:9a20164dcc47	1894	*<br><br><br>
vipinranka	12:9a20164dcc47	1895	*/
vipinranka	12:9a20164dcc47	1896
vipinranka	12:9a20164dcc47	1897	#endif // __RF24_H__
vipinranka	12:9a20164dcc47	1898

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Created:	11 Jan 2017
Imports:	0
Forks:	0
Commits:	13
Dependents:	0
Dependencies:	11
Followers:	1

RF24/RF24.h@12:9a20164dcc47, 2017-01-11 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning