Difference between revisions of "RoboPaint RT"

From Evil Mad Scientist Wiki
Jump to: navigation, search
(Using RoboPaint RT)
 
(8 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
== Overview ==
 
== Overview ==
  
RoboPaint RT is the "Real Time" Painting Software that allows you to paint with the [http://watercolorbot.com WaterColorBot].  It runs under Mac, Windows, and Linux.   
+
RoboPaint RT is the "Real Time" Painting Software that allows you to paint with the [[WaterColorBot]].  It runs under Mac, Windows, and Linux.   
  
 
RoboPaint RT is straightforward and manual: Click on a color in the paint palette to change to that color, click on the water to dip the brush in the water, and drag the brush to paint on your paper.  
 
RoboPaint RT is straightforward and manual: Click on a color in the paint palette to change to that color, click on the water to dip the brush in the water, and drag the brush to paint on your paper.  
Line 13: Line 13:
 
== Getting RoboPaint RT ==
 
== Getting RoboPaint RT ==
  
=== Running Within Processing ===
+
RoboPaint RT is a Java application, and requires that you download and install Java on your computer running it.   
 
 
We currently recommend all users to download and install Processing to run RoboPaint RT; we will be streamlining this process over the next week or so, and we apologize for the rough process(There are reliability issues with the stand-alone applications, and we are providing this rougher but more robust alternative method until those are sorted out.)
 
 
 
  
 
* First, install the [http://java.com/en/ latest version of Java] on your computer.  
 
* First, install the [http://java.com/en/ latest version of Java] on your computer.  
* Download and install [https://processing.org/download/ Processing 2.1] for your operating system.
+
* Then, download RoboPaint RT for your platform, from [https://github.com/evil-mad/robopaint-rt/releases our releases page].     
* Download the Ani library from [http://www.looksgood.de/libraries/Ani/ this site], and install it in your Processing libraries folder.
 
* Finally, download and unzip the RoboPaint RT ZIP file [https://github.com/evil-mad/robopaint-rt/archive/master.zip from our github account].     
 
  
From within Processing, open up the RoboPaint RT Sketch.  You can find it at:  robopaint-rt-master>processing>RoboPaint_RT>RoboPaint_RT.pde
 
  
 +
Important note for Windows users:  The WaterColorBot requires a USB driver as well (on Windows only). The installer for this driver is included with the RoboPaint installer (available [https://github.com/evil-mad/robopaint/releases here]).
  
=== "Stand-Alone" executables ===
 
  
''Ready-to-use executable versions are in progress, expected to be posted the week of November 10, 2013.''
 
  
 
== Using RoboPaint RT ==
 
== Using RoboPaint RT ==
 
'''''Additional information coming week of November 10, 2013.'''''
 
  
 
=== Overview ===
 
=== Overview ===
Line 42: Line 33:
 
* Raise and lower the brush holder, and insert your brush at an appropriate height
 
* Raise and lower the brush holder, and insert your brush at an appropriate height
 
* Begin painting!
 
* Begin painting!
 +
 +
 +
<img src="http://evilmadscience.s3.amazonaws.com/wiki/watercolor/robopaint-rt/robopaint_rt.jpg">
 +
 +
In basic usage, click the paint pans to change color, click the water dishes to dip, and drag on the paper to paint.
  
  
Line 56: Line 52:
 
RoboPaint RT works by recording user gestures in real time while making a painting.  The literal record of gestures that it replays can be saved as a RoboPaint RT file (.rrt file format), to be opened later and continued or painted.  Use the Open File and Save File buttons in the program to open or save a file, respectively.  
 
RoboPaint RT works by recording user gestures in real time while making a painting.  The literal record of gestures that it replays can be saved as a RoboPaint RT file (.rrt file format), to be opened later and continued or painted.  Use the Open File and Save File buttons in the program to open or save a file, respectively.  
  
RoboPaint RT gesture recordings are not drawings in the traditional sense; .rrt files cannot be opened or generated by any other drawing or painting program.
+
RoboPaint RT gesture recordings are not drawings in the traditional sense; .rrt files cannot be opened or generated by any other drawing or painting program.
 
 
  
 
== Troubleshooting ==
 
== Troubleshooting ==
Line 66: Line 61:
 
Make sure that both the USB cable and the power supply are plugged in.  If the USB cable is plugged in but power is not, the WaterColorBot will be responsive to your computer, but the motors will not move.  
 
Make sure that both the USB cable and the power supply are plugged in.  If the USB cable is plugged in but power is not, the WaterColorBot will be responsive to your computer, but the motors will not move.  
  
=== Cannot connect to WaterColorBot ===
+
=== Cannot find WaterColorBot ===
  
 
If the USB cable is not connected, or if the WaterColorBot is already on use on your computer, you may get a message telling you that the program could not find the WaterColorBot: "WaterColorBot not found.  Entering Simulation Mode."
 
If the USB cable is not connected, or if the WaterColorBot is already on use on your computer, you may get a message telling you that the program could not find the WaterColorBot: "WaterColorBot not found.  Entering Simulation Mode."
 +
 +
In this case, you can play with RoboPaint RT-- even create and save files without the WaterColorBot present --but no further attempt will be made to communicate with the WaterColorBot.  Quit and relaunch the program to try connecting again, once you have checked your cables.
 +
 +
 +
For additional hints, please see [[WaterColorBot_Troubleshooting#Computer_cannot_find_WaterColorBot|our troubleshooting page]].
  
  
Line 75: Line 75:
  
 
If you are certain that Java *is* installed, you may need to manually add Java to the PATH in your system preferences.
 
If you are certain that Java *is* installed, you may need to manually add Java to the PATH in your system preferences.
 +
  
 
=== Motion is jerky/stutters ===
 
=== Motion is jerky/stutters ===
Line 84: Line 85:
  
 
== For Developers ==
 
== For Developers ==
 +
 +
=== Repository ===
 +
RoboPaint RT is maintained at [https://github.com/evil-mad/robopaint-rt/ our github repository]. 
 +
 +
=== Bugs and feature requests ===
 +
 +
Please use the [https://github.com/evil-mad/robopaint-rt/issues issues page] at our repository to report bugs and request new features for RoboPaint RT.
  
 
=== Running RoboPaint RT within Processing ===
 
=== Running RoboPaint RT within Processing ===
* Install Processing, from processing.org  
+
* Download and Install Processing, from [http://processing.org processing.org].  We recommend Processing version 2.0.3, NOT version 2.1 (which has known serial issues).  Windows users: Please install the 32-bit version, not the 64 bit version (again, known serial issues).
  
 
* Download and install ani library, from  http://www.looksgood.de/libraries/Ani/
 
* Download and install ani library, from  http://www.looksgood.de/libraries/Ani/

Latest revision as of 19:13, 23 November 2013

wcb_tn.jpg This wiki page is part of the documentation for the WaterColorBot.
Click here to return to the WaterColorBot overview.


Overview[edit]

RoboPaint RT is the "Real Time" Painting Software that allows you to paint with the WaterColorBot. It runs under Mac, Windows, and Linux.

RoboPaint RT is straightforward and manual: Click on a color in the paint palette to change to that color, click on the water to dip the brush in the water, and drag the brush to paint on your paper.

With RoboPaint RT, you can also replay your drawing to make multiple copies, and save the file to open up and print again later. This program can be a lot of fun to play with and is a great way to get acquainted with the WaterColorBot. For those with good artistic skill, it can also be a remarkably powerful program.


Getting RoboPaint RT[edit]

RoboPaint RT is a Java application, and requires that you download and install Java on your computer running it.


Important note for Windows users: The WaterColorBot requires a USB driver as well (on Windows only). The installer for this driver is included with the RoboPaint installer (available here).


Using RoboPaint RT[edit]

Overview[edit]

  • Move the carriage by hand to the upper-left (START) corner
  • Make sure that the WaterColorBot has power
  • Hook up your computer and the WaterColorBot by USB
  • Run RoboPaint RT -- make sure that it finds the WaterColorBot
  • Raise and lower the brush holder, and insert your brush at an appropriate height
  • Begin painting!


In basic usage, click the paint pans to change color, click the water dishes to dip, and drag on the paper to paint.


Hold 'h' for Help[edit]

Hold down the 'h' key on your keyboard for a help overlay, explaining the functions of the program.


Saving and loading files[edit]

RoboPaint RT works by recording user gestures in real time while making a painting. The literal record of gestures that it replays can be saved as a RoboPaint RT file (.rrt file format), to be opened later and continued or painted. Use the Open File and Save File buttons in the program to open or save a file, respectively.

RoboPaint RT gesture recordings are not drawings in the traditional sense; .rrt files cannot be opened or generated by any other drawing or painting program.

Troubleshooting[edit]

Motors do not move[edit]

Make sure that both the USB cable and the power supply are plugged in. If the USB cable is plugged in but power is not, the WaterColorBot will be responsive to your computer, but the motors will not move.

Cannot find WaterColorBot[edit]

If the USB cable is not connected, or if the WaterColorBot is already on use on your computer, you may get a message telling you that the program could not find the WaterColorBot: "WaterColorBot not found. Entering Simulation Mode."

In this case, you can play with RoboPaint RT-- even create and save files without the WaterColorBot present --but no further attempt will be made to communicate with the WaterColorBot. Quit and relaunch the program to try connecting again, once you have checked your cables.


For additional hints, please see our troubleshooting page.


Application will not start (Windows 8)[edit]

If the RoboPaint RT application will not start, it is likely because Java is not installed on your computer. We have seen the program refuse to start , giving an error that "java is not recognized as an internal or external command..."

If you are certain that Java *is* installed, you may need to manually add Java to the PATH in your system preferences.


Motion is jerky/stutters[edit]

If the motion of the carriage is basically correct except that it is "jerky" rather than smooth, the likely cause is that the program is running slowly on your computer. RoboPaint RT operates very smoothly with a reasonably fast modern computer, but we have found that a computer busy running other tasks (e.g., playing music or video, heavy downloads, printing, etc) does not have as much time to operate the program, resulting in "stuttery" motion.



For Developers[edit]

Repository[edit]

RoboPaint RT is maintained at our github repository.

Bugs and feature requests[edit]

Please use the issues page at our repository to report bugs and request new features for RoboPaint RT.

Running RoboPaint RT within Processing[edit]

  • Download and Install Processing, from processing.org. We recommend Processing version 2.0.3, NOT version 2.1 (which has known serial issues). Windows users: Please install the 32-bit version, not the 64 bit version (again, known serial issues).
  • Open robopaint-rt-master>processing>RoboPaint_RT>RoboPaint_RT.pde from within Processing
  • Click "Run" button