cnc4less / arduino-easytransfer Goto Github PK

/******************************************************************
*  EasyTransfer Arduino Library v2.1
*		details and example sketch: 
*			http://www.billporter.info/easytransfer-arduino-library/
*
*		Brought to you by:
*              Bill Porter
*              www.billporter.info
*
*		Major props to Mathieu Alorent (kumy) for 
*		  I2C version and the pretty pictures.
*
*
*  Lib version history
*	1.0  Created
*	1.1  Fixed dumb Copy-paste error in header file
*		 Added a keyword file
*	1.5  Forked lib into Software and Hardware Serial branches, I don't know a better way
*		 added passing in of Serial port of different types
*	1.6  Fixed bug where it wasn't clearing out the buffers if the CheckSum failed,
*			I'm good at dumb mistakes
*	1.7  Fixed a bug where the receive function could block for too long and never process data correctly
*		    Organized the examples to be Arduino IDE compatible
*	1.8
*		Now Arduino 1.0 compatible!
*   1.81
*		Made it more cross compatible. Man, They really made us work for this one. 
*   2.0
*       Combined SoftEasyTransfer with the other two to make everything one repo
*           Added EasyTransferVirtualWire library for use with Virtual Wire and cheap radios.
*   2.0.1
*       VirtualWire version tested by garth@netram, bugs fixed. 
*   2.1
*	   Changes RX parsing buffer to dynamic allocation to conserve RAM.
*
*
*  Limits of the Library
*		You can change the Serial port,
*		but the Struct size must not pass 255 bytes
*		VirtualWire Version Struct can'e be bigger then 26 bytes
*
*   The protcol is as follows:
*		Header(0x06,0x85),SizeofPayload,Payload,Checksum
*	
*  
*This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
<http://www.gnu.org/licenses/>
*
*This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. 
*To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or
*send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
******************************************************************/


********************To Install*************************************

To install, unzip and place 'EasyTransfer' folder into your 'C:\Users\{user name}\Documents\Arduino\libraries' folder or '{Arduino IDE path}\hardware\libraries" or {Arduino IDE path}\libraries" directory. 

Restart the Arduino IDE, look for the Library under "Sketch" -> "Import Library". You can also try the examples by finding them
under "File" -> "Examples" -> "EasyTransfer".

All uses of the library are in the example sketchs. 


*******************************************************************


Library now has two versions, one for regular hardware Serial, one for use with the NewSoftSerial library
making any Arduino pin capable of transfering data back and forth easily. 

See the examples to find out how to use the library.