EasyTransfer Arduino Library

Posted in Arduino Libraries by Bill
30 May 2011
EasyTransfer Arduino Library

The purpose of this library is to make it easy for the everyday Arduino user working on projects with multiple Arduinos communicating with each other and sharing data. I had many people ask me for the code I used in my PS2X library example that sent PS2 Controller values wirelessly to my SAGAR robot. It got to be tiresome answering the questions and I had an idea to write a library to help the inexperienced with micro controller communications. This is a easy to use and no frills way to send data between two Arduinos.

In most of my own projects I define and write my own NMEA standard communication protocols. This makes communications human readable and easy to debug, but proves wasteful with bandwidth and processing power so it’s not right for every application. Binary communications is much more efficient and versatile, but requires careful handling. This library abstracts the finer points of packetized serial communication away from the user so it easy to use and understand.

To use the library, simple define all the data types you want to share inside a data structure. This keeps all the data stored together in memory.

struct SEND_DATA_STRUCTURE{
  //put your variable definitions here for the data you want to send
  //THIS MUST BE EXACTLY THE SAME ON THE OTHER ARDUINO
  int blinks;
  int pause;
};

When requested, the library will send all the binary data in the structure to another Arduino via serial with a checksum to avoid transfer errors.

void loop(){
  //this is how you access the variables. [name of the group].[variable name]
  mydata.blinks = random(5);
  mydata.pause = random(5);
  //send the data
  ET.sendData();
  delay(10000);
}

The receiving Arduino will verify the checksum, and copy the new data onto a identical structure in it’s memory.

void loop(){
  //check and see if a data packet has come in. 
  if(ET.receiveData()){
    //this is how you access the variables. [name of the group].[variable name]
    //since we have data, we will blink it out. 
    for(int i = mydata.blinks; i>0; i--){
      digitalWrite(13, HIGH);
      delay(mydata.pause * 100);
      digitalWrite(13, LOW);
      delay(mydata.pause * 100);
    }
  }

  delay(2500);
}

It’s important to make sure the structure is the same on both Arduinos for this to work. Now sharing data between Arduinos is easy without having to define and program your own communications protocol and have to worry about syncing or transmit errors. EasyTransfer will do that for you.

Using Structures to hold the data allows for versatile communications by allowing any type and number of data points to be shared, as long as the whole structure is under 255 bytes. You could define int’s, arrays, longs, etc inside the structure and share the data. It’s also possible to create two way communications by defining two sets of structs on each end and creating two objects using the library. I will have an example of that up shortly.

You can download the library and example below. The example requires two Arduino boards to be connected to each other via their Uarts. One will create two random numbers and send the data to the other that will flash out a sequence of flashes based on those numbers. The first one will also flash out the same sequence.

Now it’s easier to pick which Serial port to use; Serial, Serial1, etc. AND support for the NewSoftSerial library for creating software serial ports on any pin. EasyTransfer is for hardware serial, SoftEasyTransfer is for software; each has there own set of examples. There’s also an example for two way communications using the library.

Source Code available on GitHub project pages.

 

Or Direct Download

 

UPDATE

Thanks to Kumy, there’s now an I2C version of EasyTransfer. There’s also an experimental VirtualWire version for use with those cheap low frequency radios. All are in the single download zip file above.

 

To install the Library, open the zip file and transfer the EasyTransfer folder into your Arduino ‘libraries’ folder. Then follow the examples to add the code to your project. If you have any problems or questions, let me know in the Support Forum.

Need Help?

Please use the Support Forum to ask for help. Don’t use the comments below.

 

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.

Share

Trackbacks / Pingbacks

  1. Library makes Arduino to Arduino serial communications dead simple - Hack a Day
  2. Arduino Blog » Blog Archive » Easytransfer Library Makes Arduino2Arduino Communication Easy
  3. EasyTransfer Arduino Library « The Mind of Bill Porter | SpikenzieLabs Blog
  4. Easytransfer Library Makes Arduino2Arduino Communication Easy | dev.SquareCows.com
  5. Arduino a sériová komunikace | μArt.cz
  6. Comunicaciones entre Arduino y Skymega | /home/darkomen
  7. Bill Porter ported his EasyTransfer library to VirtualWire for me: Cheap wireless telemetry at last…. » itux.co.za - the Experiments
  8. TIMO TOOTS | Elektron
  9. Adding a lot of twinkle to this rebar sculpture - Hack a Day
  10. Sector67 ::: Madison - Wisconsin ::: Blog
  11. Guide to Arduino and AVR Communications
  12. [Arduino] Arduino to Arduino Serial Communication | Billwaa's Blog
  13. [Arduino] Arduino to Arduino Serial Communication | Billwaa's Blog
  14. Using i2c and an ExtraCore to increase your I/O capacity | AuthenticInvention
  15. vulussu» Blog Archive » EasyTransfer Arduino Library « The Mind of Bill Porter
  16. The Living Map of Manchester powered by Arduino | greater than 140.
  17. Arduino Controlled RGB LED Dot Matrix Board -Use Arduino for Projects
  18. Xbee notes | Grimtech
  19. Arduino Controlled RGB LED Dot Matrix Board -Arduino for Projects
  20. First, Working, Autopilot Prototype | Denial Media
  1. 423 Comments.

    • […] is used to make this process painless. Here is the link to the instruction website we used: http://www.billporter.info/2011/05/30/easytransfer-arduino-library/. Just make sure you download the libabrary files and SAVE them to the “C:Program Files […]

    • DaveNo Gravatar says:

      Bill — this library is fanTASTIC. So easy and intuitive to use. For me, this library is a classic example of “standing on the shoulders of giants”.
      Thanks again for your work.

    • Danny BNo Gravatar says:

      Hi,

      Thank-you for doing and releasing this library. I’m using it as part of a wireless control system for my model railroad, and I just have one question. Is it possible to have two ‘sets’ of easytransfer objects (i.e. two pairs of easytransfers, 1 send/receive each) sending and receiving over the same serial link with different structs?

      For example, I’m automating part of my model railroad, and the Arduino running the sensors, etc. for this will need to communicate with the control system base station, but it will need to transfer a different set of data to the handheld controller.

      Cheers and thanks,
      Danny

    • […] more responsive, the first chip decodes the NMEA data from the GPS, then sends the location via Bill Porter’s EasyTransfer Library to the other […]

    • Anurag JainNo Gravatar says:

      Sir I am finding it difficult to pass an char array. Can you give me one example where i can pass an character array

      Thanks in advance

    • MachmanNo Gravatar says:

      Hello, I am wondering if this can be used on the Uno r3 and Mega 2560 r3, and if it would create an issue when i go to reprogram the Uno (if i am using the hardware serial port

    • maxidNo Gravatar says:

      Hi, can you read a forum?
      i need undestand how calculate Checksum to transmit from pc to arduino

    • PhilNo Gravatar says:

      This is a great article, and thanks for the code.

      But I have one question…
      In the I2C version of EasyTransfer, is there a way for the slave to send data back to the master?

      • andrewinbrizNo Gravatar says:

        I would like to see the response to this question also!! It may be simple, but I haven’t got it either. I think the issue is that the master is assumed, not defined.

    • antoineNo Gravatar says:

      Hello ! Your lib. seams to be exactly what I am looking for and 2 way example is perfect !

      Just one question :
      In 2 way mode, what happen if some bytes are lost during transfer between the 2 Arduino ?
      In other words : what happen if checksum is wrong ?
      – message is lost ?
      – receiver ask message to b resend by sender until fully ok ?

      for more details, working flow between my arduinos is as follow :
      Arduino1 -(cmd)-> Arduino2 -(answer)-> Arduino1
      (arduino 1 send command to Arduino 2, and Arduino 2 answer to Arduino 1 once job is done.)

      My question is just to know if I need to manage some timer on Arduino 1 between “cmd” and “answer”, in case no answer after certain time, mean problem in communication => resend cmd.

      Thanks

      • ConstantinNo Gravatar says:

        You have to come up with a protocol if you want to guard against that. Ie once a message has been received, acknowledge the receipt. Or retransmit at a set interval for x times before timing out and giving up.

        You don’t want infinite retries or you may end up with a packet storm. Some systems use a somewhat randomized delay before responding. That limits the number of units stomping on each other by accident.

        In my implementations I assign a single master that coordinates all communications. That makes stomping much less likely as clients on the bus will only transmit when called upon.

        For a more comprehensive system check out radio head at airspayce. They have a library for radio and serial communications that takes care of the details you’re concerned with.

    • nasrulNo Gravatar says:

      hi,please help me,i cant even load the library into my arduino software,dont know where i made mistake,before this,i had uploaded many libraries,but this time,im having difficulties.Thanks

    • nasrulNo Gravatar says:

      hi,do you able to load the library?

Leave a Reply

Your email address will not be published. Required fields are marked *

*

Notify me of followup comments via e-mail. You can also subscribe without commenting.