From 53b947df484159f5934898ba6c0aa69a9c869007 Mon Sep 17 00:00:00 2001 From: Ido Hadanny Date: Thu, 22 Sep 2011 21:30:13 +0300 Subject: added stuff --- roombacomm-client/docs/Asus Router HowTo.html | 50 +++ roombacomm-client/docs/CHANGELOG.txt | 62 +++ roombacomm-client/docs/DirectoryStructure.html | 145 +++++++ roombacomm-client/docs/FileDescriptions.html | 512 +++++++++++++++++++++++++ roombacomm-client/docs/Index.html | 26 ++ roombacomm-client/docs/README | 73 ++++ roombacomm-client/docs/README-0.95 | 70 ++++ roombacomm-client/docs/README.eclipse.txt | 22 ++ roombacomm-client/docs/README.windows.txt | 103 +++++ roombacomm-client/docs/SVN_Info.html | 176 +++++++++ roombacomm-client/docs/ToDo.html | 121 ++++++ 11 files changed, 1360 insertions(+) create mode 100644 roombacomm-client/docs/Asus Router HowTo.html create mode 100755 roombacomm-client/docs/CHANGELOG.txt create mode 100644 roombacomm-client/docs/DirectoryStructure.html create mode 100644 roombacomm-client/docs/FileDescriptions.html create mode 100644 roombacomm-client/docs/Index.html create mode 100644 roombacomm-client/docs/README create mode 100644 roombacomm-client/docs/README-0.95 create mode 100644 roombacomm-client/docs/README.eclipse.txt create mode 100644 roombacomm-client/docs/README.windows.txt create mode 100644 roombacomm-client/docs/SVN_Info.html create mode 100644 roombacomm-client/docs/ToDo.html (limited to 'roombacomm-client/docs') diff --git a/roombacomm-client/docs/Asus Router HowTo.html b/roombacomm-client/docs/Asus Router HowTo.html new file mode 100644 index 0000000..6fa458e --- /dev/null +++ b/roombacomm-client/docs/Asus Router HowTo.html @@ -0,0 +1,50 @@ + + + + + Asus Router HowTo + + +

ASUS Router HowTo

+

Updating the package list and stty utilities

+The purpose of this step is to get updated stty utilities onto the ASUS +router so that the baud rate of the console port can be set.
+
+
opkg update
+
opkg install coreutils-stty
+

+
+
+

To start ser2net

+To use console port, comment out the serial port in /etc/inittab & +reboot. File with commented out serial port should be
+::ttyS0::askfirst:/bin/ash --login
+
+The following command sets the port to 115200
+# stty -F /dev/ttyS0 115200
+
+Now start ser2net
+# cd /roomba
+# ./ser2netconf.sh
+
+
+
+

Reference

+# cat sercon.sh
+ser2net -c /roomba/ser2netcon.conf
+
+
+# cat ser2netcon.conf
+5001:raw:0:/dev/ttyS0:115200
+
+
+# cat /etc/inittab
+::sysinit:/etc/init.d/rcS S boot
+::shutdown:/etc/init.d/rcS K stop
+tts/0::askfirst:/bin/ash --login
+::ttyS0::askfirst:/bin/ash --login
+tty1::askfirst:/bin/ash --login
+
+ + diff --git a/roombacomm-client/docs/CHANGELOG.txt b/roombacomm-client/docs/CHANGELOG.txt new file mode 100755 index 0000000..d9660ff --- /dev/null +++ b/roombacomm-client/docs/CHANGELOG.txt @@ -0,0 +1,62 @@ +Changes in Roombacomm 0.96 +-------------------------- +- The primary goal of this release was to enable Roomba 500 models, + which use a different baud rate. This has been done while retaining + backward compatibility - programs which use the roombacomm class for + 400 and older models shouldn't have to change for the older models, and + may not have to change for the 500 models. Commands should run unchanged + on older models. +- Secondary goals were to: + - get roombacomm to remember it's serial port settings, so you don't have to + change them each time you run a GUI + - Make life easier for Windows users + - Fix bugs along the way. + +The following changes were made: +- Updated RXTX library to latest that is included in Processsing-1.01 +- Created README.windows.txt, README.eclipse.txt, CHANGELOG.txt, TODO.txt +- Created runit.bat - Windows command prompt equivalent of runit.sh for Linux, + makeit.bat (makes all on windows), makedoc.bat (makes all javadoc on windows) +- Added bluecove-2.1.0.jar to rxtxlib for windows bluetooth support +- Made SimpleTest go backwards after it went forward using send, + so it ends up where it started (and doesn't creep forward) +- Changed playNote to use song 3, because 500-series roombas only support + 4 or 5 songs (vs. 16 for 400-series & ealier). +- Changed RoombaCommTest beep-hi and beep-lo duration from 10 to 32, + and notes more toward the middle of the range to make the beeps audible. + (They were too short & high/low pitched to be readily discernable.) +- Added actions in RoombaCommPanel to make left & right forward turn buttons work +- Added a combo box in RoombaCommPanel to let the user select the protocol + (SCI - Serial Command Interface, for Roomba 400 & older, and + OI (Open Interface,for Roomba 500 series.) +- Put logic into RoombaCommSerial to store the protocol & port & + DSRwait settings in .roomba_config file, & retrieve them when when the + object is created. This lets an app "remember" the config settings that + were last used. +- Updated the command-line apps to allow the protocol to be unspecified + (uses default from config file), or to specify the protocol +- Made the -debug flag work in RoombaCommTest - eliminated the hard-coded + enable/disable statements in RoombaCommPanel +- Made RoombaCommTest check for whether Roomba is connected (runs sensors + command) immediately after connecting, & print connected message. +- Fixed disconnect button to do disconnect action +- Fixed typo where RoombaComm.start() said it was sending control +- Added Roomba 5xx new commands, and a sensors method that lets the caller + pass in the length of the expected reply. + Make RoombaCommSerial.serialEvent() indicate completion when the requested + reply length has been received. +- Added queryList method to support 5xx Query List command +- Beefed up the javadoc for the executables +- Made the Spy* programs terminate cleanly +- Fixed bug in RoombaComm.goBackward() which made it go forward +- Made the Test application stop when complete +- Created build-jar.bat and build-processing-library.bat. +- Installed 7z.exe to support zip archive creation of build-processing-library +- Fixed roombaview - framerate() should be frameRate() +- Made the control() command turn LEDs on, so we know roomba is powered on + and we don't run the batteries flat thinking it's off. + Bug: The first control command after a poweron, the LEDs flash, + but don't stay on. +- Added programs Stop (stops the robot), PowerOff (powers off the robot), + and Bsquare (runs a Borenstein square test - see the UMB benchmark paper + by Borenstein et. al.) diff --git a/roombacomm-client/docs/DirectoryStructure.html b/roombacomm-client/docs/DirectoryStructure.html new file mode 100644 index 0000000..4cdf458 --- /dev/null +++ b/roombacomm-client/docs/DirectoryStructure.html @@ -0,0 +1,145 @@ + + + + + DirectoryStructure + + +

Directory Structure

+This page defines the directory structure standard used in this +project. It is based on the recommendations in the developer.com article +here.  +
+

The Directories

+The directories described below are relative to the project source +tree, as would be checked out of SVN at +http://svn.dprg.org/repos/roomba/roombacomm/trunk
+
+Two trees are supplied by the project:
+
    +
  1. the full developer tree, described below
    2. +
  2. the user tree, which is the contents of the dist directory after +building the full developer tree
    3. +
+The intent is that the dist directory contains everything a user needs +to run the applications, but not the source. It is considered good +practice to separate the runnable application from the source, which +contains much more that users aren't typically interested in. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Directory Structure of /:
/ project root directory +(run all tools from here)
 build.xml Ant build file
 lib/ jar files required for +build
 src/ Java source code for +servlets and utilities
 doc/Project documentation, +READMEs, HowTo's, etc
 build/ files compiled/copied +into here (this directory can be +safely deleted, and is not stored in the repository)
dist/"ready to use" JAR's and other applications for +users.
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Directory Structure of /src:
com/hackingroomba/roombacomm Source directory of roombacomm library + applications
 scripts scripts to run the applications, and obsolete scripts that +used to build the applications
 processing-examples contains directories for the /roombaring, /roombatune & +/roombaview processing +apps. These apps are intended to be copied as-is into a processing +directory. (Processing is a graphic development environment - read +"Hacking Roomba" for more details.)
processing-examples/roombaviewIn addition to the processing application, contains +subdirectories which support the application. See fileDescriptions.
packaging???A directory containing RoombaCommTest.app and directories +which help a Mac build an app???
+
+ + + + + + + + + + + + + + +
Directory Structure of +/lib:
/jar files which support roombacomm apps
/rxtx Files which provide serial I/O for java
+
+ + + + + + + + + + + + + + +
Directory Structure of +/dist:
+
+ + diff --git a/roombacomm-client/docs/FileDescriptions.html b/roombacomm-client/docs/FileDescriptions.html new file mode 100644 index 0000000..0175b84 --- /dev/null +++ b/roombacomm-client/docs/FileDescriptions.html @@ -0,0 +1,512 @@ + + + + + +Below are a description of each of the files of this project.
+

/

+ +

/src/com/hackingroomba/roombacomm

+ +
+Classes designed for specific test(s)
+ +
+Older classes (Legacy?/Depreciated?) that may not be maintained by this +project going forward:
+ +

/src/scripts

+ +

/src/processing-examples

+Directories intended to be copied into the users Processing work +directory
+ +

/docs

+ +

/lib

+ +

/lib/rxtxlib

+ + + diff --git a/roombacomm-client/docs/Index.html b/roombacomm-client/docs/Index.html new file mode 100644 index 0000000..15091e3 --- /dev/null +++ b/roombacomm-client/docs/Index.html @@ -0,0 +1,26 @@ + + + + + Index + + +

Roombacomm 0.97

+README
+Eclipse HowTo
+Windows-related information
+Changelog
+Directory Structure
+File Descriptions +
+Subversion Tree structure +
+ASUS Router How To
+

To Do

+The To Do list enumerates the remaining work +for the 0.97 release, as well as work remaining beyond 0.97
+

Previous Versions

+README for 0.95 release + + diff --git a/roombacomm-client/docs/README b/roombacomm-client/docs/README new file mode 100644 index 0000000..b5909e0 --- /dev/null +++ b/roombacomm-client/docs/README @@ -0,0 +1,73 @@ +RoombaComm: Roomba Control & Communications API, release 0.96 +Copyright (c) 2006-9 Tod E. Kurt, tod-at-todbot.com & + Paul Bouchier, bouchier-at-classicnet.net + +Quick Start for Java on Linux +----------------------------- +If you have a Roomba Serial Interface built and the 'roombacomm-java.zip' +library, you can quickly try both out by unzipping this file and running +one of the examples: + +% unzip roombacomm.zip +% cd roombacomm +% ./run-it.sh roombacomm.SimpleTest /dev/cu.KeySerial1 + +Assuming you have a serial device called "/dev/cu.KeySerial1", which you +probably do if you have a Keyspan USA-19HS USB serial adapter. + + +Quick Start for Processing +-------------------------- +If you have a Roomba Serial Interface built and the 'roombacomm-processing.zip' +library, you can quickly try out both by unzipping this file and running +one of the examples: + +1. Unzip the 'roombacomm-processing.zip' file inside of Processing's + 'libraries' directory. This will create a directory called 'roombacomm'. +2. Start Processing (or Restart if already running) +3. Create a New Sketch +3. Choose "Sketch->Import Library->roombacomm" menu item +4. Copy one of the Processing examples in the 'examples' directory of the + roombacomm library (zipfile). Note that if you want to run roombaview + you must install the MyGUI package. + The MyGUI library is located in the 'libraries' directory of the 'roombaview' + sketch. You may need to run an older version of Processing for it to work. + + + +Compatibility +------------- +This library has only been tested on Mac OS X 10.4, and a little on +Windows 2000, but everything is in place (particularly the RXTX native +libraries) for it to work on any version of Mac OS X, Windows, and Linux. + + + +Platform-specific Notes +----------------------- +Mac OS X: +--------- +If you've never used RXTX before on your Mac OS X box, run the command: + +% ./rxtxlib/macosx_setup.command + +And then shutdown (not just log out) and log back in again. +And read this faq from Processing: http://processing.org/faq/bugs.html#serial + +Also, if you use Bluetooth in 10.3, you can only input numeric passkeys, +which can make using Bluetooth adapters difficult. If your Bluetooth +adapter can change its passkey (possible with the SparkFun/BlueRadios +devices), change it to a numeric passkey on a differernt computer. +Or upgrade your OS. :) + +Windows: +-------- + +The serial port implementation is a little different (at least to RXTX) +so use the '-hwhandshake' flag with the programs, if using Bluetooth on +Windows. See, 'RoomabCommSerial.waitForDSR' for details. + +(And yes, I know the build, configuration, and release of this library +is a little goofball, but I wanted to get something out so others can play) + +-eof- diff --git a/roombacomm-client/docs/README-0.95 b/roombacomm-client/docs/README-0.95 new file mode 100644 index 0000000..68c1e17 --- /dev/null +++ b/roombacomm-client/docs/README-0.95 @@ -0,0 +1,70 @@ +RoombaComm: Roomba Control & Communications API, release 0.95 +Copyright (c) 2006 Tod E. Kurt, tod@todbot.com + +Quick Start for Java +-------------------- +If you have a Roomba Serial Interface built and the 'roombacomm-java.zip' +library, you can quickly try both out by unzipping this file and running +one of the examples: + +% unzip roombacomm.zip +% cd roombacomm +% ./run-it.sh roombacomm.SimpleTest /dev/cu.KeySerial1 + +Assuming you have a serial device called "/dev/cu.KeySerial1", which you +probably do if you have a Keyspan USA-19HS USB serial adapter. + + +Quick Start for Processing +-------------------------- +If you have a Roomba Serial Interface built and the 'roombacomm-processing.zip' +library, you can quickly try out both by unzipping this file and running +one of the examples: + +1. Unzip the 'roombacomm-processing.zip' file inside of Processing's + 'libraries' directory. This will create a directory called 'roombacomm'. +2. Start Processing (or Restart if already running) +3. Create a New Sketch +3. Choose "Sketch->Import Library->roombacomm" menu item +4. Copy one of the Processing examples in the 'examples' directory of the + roombacomm library (zipfile) + + + + +Compatibility +------------- +This library has only been tested on Mac OS X 10.4, and a little on +Windows 2000, but everything is in place (particularly the RXTX native +libraries) for it to work on any version of Mac OS X, Windows, and Linux. + + + +Platform-specific Notes +----------------------- +Mac OS X: +--------- +If you've never used RXTX before on your Mac OS X box, run the command: + +% ./rxtxlib/macosx_setup.command + +And then shutdown (not just log out) and log back in again. +And read this faq from Processing: http://processing.org/faq/bugs.html#serial + +Also, if you use Bluetooth in 10.3, you can only input numeric passkeys, +which can make using Bluetooth adapters difficult. If your Bluetooth +adapter can change its passkey (possible with the SparkFun/BlueRadios +devices), change it to a numeric passkey on a differernt computer. +Or upgrade your OS. :) + +Windows: +-------- + +The serial port implementation is a little different (at least to RXTX) +so use the '-hwhandshake' flag with the programs, if using Bluetooth on +Windows. See, 'RoomabCommSerial.waitForDSR' for details. + +(And yes, I know the build, configuration, and release of this library +is a little goofball, but I wanted to get something out so others can play) + +-eof- diff --git a/roombacomm-client/docs/README.eclipse.txt b/roombacomm-client/docs/README.eclipse.txt new file mode 100644 index 0000000..08957d8 --- /dev/null +++ b/roombacomm-client/docs/README.eclipse.txt @@ -0,0 +1,22 @@ +Instructions for running eclipse on windows with Roombacomm +----------------------------------------------------------- +Disclaimer: I'm not an eclipse expert. Please improve these instructions. However, eclipse is a really great +java IDE - once you learn how to use it you won't want to go back to the command-line. + +Prerequisite: You have installed eclipse and a jdk, and pointed eclipse to a workspace. + +- Create a new project from existing source in the folder you unzipped into. (Do not create it in the directory with the +source files.) +- Give the project the same name as the directory you downloaded into +- Change project layout: choose "use project folder as root for source & class files" +- Optionally select a project-specific jre that is the same as makeit.bat uses +- Check "create project from existing source" +- click next +- click the libraries tab +- Click the button to add external jars. Navigate to rxtxlib and select RXTXcomm.jar +- Open "Run Configurations" and make a new run configuration called SimpleSerial. Search for the main class and select +SimpleSerial in the popup. In the arguments tab, type the name of the COM port you're using. +- Run the configuration you just created. You should see the same output in the console pane of eclipse as you saw +in the command prompt window if you followed the README.windows instructions. +- Make a new run configuration called RoombaCommTest, and select RoombaCommTest as the main class, as above. Run it and you +should get the GUI for driving Roomba around. \ No newline at end of file diff --git a/roombacomm-client/docs/README.windows.txt b/roombacomm-client/docs/README.windows.txt new file mode 100644 index 0000000..3978727 --- /dev/null +++ b/roombacomm-client/docs/README.windows.txt @@ -0,0 +1,103 @@ +Quick Start for Windows +----------------------- +This procedure has been tested on Windows XP and Vista. + +Prerequisites +------------- +- You must have java installed, and the path to java must be in your environment. +To test, open a command prompt window and type "java". You should get a help menu +printed. + +Roombacomm Installation +----------------------- +- unzip roombacomm somewhere + +rxtxSerial.dll Installation +--------------------------- +- You need to copy the rxtxSerial.dll file into the folder containing java.exe +- Identify your Java Runtime Environment's folder. For version 1.6.0, this usually +is c:\Program Files\Java\jre1.6.0_??\. java.exe is usually in the bin folder under the +runtime folder. +- Note that the java.exe program can live anywhere (even in \Windows\System32!), and rxtxSerial.dll +needs to be copied to the same directory as the java.exe version that will be run from the +command prompt. If you have several versions of Java installed, you need to find the right +directory containing the version of Java which will be run when you type java from the command +prompt. One way to do this is open up a command prompt window and type java -version. Then +look in suitable directories for that version. The version of java.exe which runs is determined +by the order of directories in the PATH environment variable. Test that you found the right version of java +by typing \\java -version and looking for a match to the version when you don't explicitly +type the path. For example: + > \windows\system32\java.exe -version +will print the version of java in the windows system32 folder. +- Copy rxtxSerial.dll from roombacomm\rxtxlib folder to the folder with java.exe. For +example: c:\Program Files\Java\jre1.6.0_01\bin\ +- Further help is available on the Wiki at http://www.rxtx.org +- If you don't get rxtxSerial.dll installed in the right place, RoombacommTest will hang when you +press the connect button, command-line apps will hang at startup, and the Windows bluetooth device +icon will flash to connected then back to not connected. + +Bluetooth +--------- +- It may be that bluetooth is problematic when you've been using the device from one computer, +which is still turned on, and you try to use it from another computer. You may have to turn the +other computer off, and/or delete the bluetooth device and re-add it in the Bluetooth devices +window before it will allow opening it. +- Open up the bluetooth Devices window (in the control panel). You can monitor the connected state +there, as well as identify which COM ports are assigned to the bluetooth 1SPP board. The device +should show connected once you've hit the connect button on RoombacommTest, or when any of the +sample programs are active. +- Bluetooth on Windows may not work too well if you select no passcode. Try creating the device +with a passcode of 0000, even if the bluetooth device is set up for no passcode. +- A Philips BGB203 chip in automatic server mode as a bluetooth transceiver, and +Windows XP and Vista, and RXTXlib does not seem reliable - YMMV! Please help if you can. + +Identifying which COM port Roomba is connected to +------------------------------------------------- +- Find which COM port your Roomba is connected to. +- If you've hard-wired Roomba to a PC serial port, this should be in your computer's documentation. +- If you're using a USB to serial adapter, you can find the COM port by going to device manager +(right click on My Computer, click on Manage, and click on Device Manger - expand the +"Ports (COM & LPT)" item) and looking for a COM port that comes and goes as you plug and unplug +the USB to serial adapter. +- If you're using bluetooth with the Windows bluetooth stack (default), go to control panel +and open up "bluetooth Devices" and look on the COM ports tab +- The SimpleTest program helps you by listing which COM ports it found. You can try them all. + +Testing with SimpleTest +----------------------- +- Before you jump to running SimpleTest (which actually relies on a lot of SW underneath it) +check that you can actually connect to the COM port you intend to use. Run a terminal emulator +program such as PuTTY, and open up the serial port with the name COMx (whichever port your Roomba +is connected to). Jumper the Tx port to the Rx port. If your USB to Serial adapter has data LEDs, +try hitting keys, and make sure the LEDs blink, and the key you pressed is echoed back. Similarly +for bluetooth. If you can't get a terminal emulator to talk to your interface, SimpleTest has +no hope. +- SimpleTest is a java application which connects to Roomba through a serial port you specify +and sends commands to make it do a few basic things. +- Open a command prompt window and cd to the directory where you unzipped roombacomm +- run the runit.bat file with the name of your com port, e.g. + > runit COM5. + Note that COMx is case sensitive - "COM" in Windows COM ports is capitalized +- If you get the dreaded "Couldn't connect to com4" message, you likely either mistyped +the COM port (e.g. didn't capitalize COM), or you have not installed rxtxSerial.dll in the +same directory as the java.exe that you're running. +- If it connects to the COM port, and you have lights on your USB to serial port, they should +start flashing as the program prints the commands it's sending to Roomba. If you have Roomba +connected and powered on, it will move around a little. +- If you're using bluetooth on Windows, you may have to give the -hwhandshake option on +the command line. e.g. + > runit roombacomm.DriveRealTime COM4 -hwhandshake + +Modifying & Rebuilding +---------------------- +- The "Hacking Roomba" book describes the makeit.sh script, which builds all the java code. +For windows, use the makeit.bat batch file from the command prompt to rebuild all java code +after modifications. +- For windows, the analog to the makedoc.sh script is the makedoc.bat batch file. This rebuilds +the javadoc. Please keep the javadoc up to date if you're going to submit changes back to Tod. + +Processing +---------- +- If you change any RoombaComm functions, you'll need to re-make the roombacomm jar file. Use +the build-jar.bat batch file for this, then run the build-processing-library.bat batch file. + diff --git a/roombacomm-client/docs/SVN_Info.html b/roombacomm-client/docs/SVN_Info.html new file mode 100644 index 0000000..02c270c --- /dev/null +++ b/roombacomm-client/docs/SVN_Info.html @@ -0,0 +1,176 @@ + + + + + SVN_Info + + + +

Getting started (for the Subversion unaware):

+ +

The O'Reilly Media book +(free on line, but you can buy it too)
+Good parts to read first: (What +Is Subversion?, Fundamental +Concepts )
+

+ +

A few SVN quotes:

+ +

+ref: +svnbook.red-bean.com, Chapter 4. Branching and Merging +

+ +
+For projects that have a large number of contributors, it's common for +most people to have working copies of the trunk. Whenever someone needs +to make a long-running change that is likely to disrupt the trunk, a +standard procedure is to create a private branch and commit changes +there until all the work is complete.
+
+ +

ref: +What is a branch?

+ +
This is the basic concept of a branch-namely, +a line of development that exists independently of another line, yet +still shares a common history if you look far enough back in time. A +branch always begins life as a copy of something, and moves on from +there, generating its own history (see Figure 4.1, Branches +of development).
+ +

ref: +What's the point of a branch?

+ +
You should +remember two important lessons from this section. First, Subversion has +no internal concept of a branch-it knows only how to make copies. When +you copy a directory, the resultant directory is only a "branch" +because you attach that meaning +to it. You may think of the directory differently, or treat it +differently, but to Subversion it's just an ordinary directory that +happens to carry some extra historical information.
+
+Second, because of this copy mechanism, Subversion's branches exist as normal filesystem directories in the +repository. This is different from other version control systems, where +branches are typically defined by adding extra-dimensional "labels" to collections of files. The location +of your branch directory doesn't matter to Subversion. Most teams +follow a convention of putting all branches into a /branches directory, but you're free to invent +any policy you wish.
+
+ +

A few words about this project's tree managment approach:

+ +The structure will be as follows:
+ +/roombacomm
+ +  ../trunk
+ +     This is where the bleading edge development +and believed to be fully working code for this project can be found. +The structure should be +usable as an SVN checkout  for the project source tree. In general +the idea is that /trunk will be usable at all times. More deatils about +the structure of the project in a seperate document.
+ +
+ +  ../branches
+ +     These branches are planed to be of one of two +types: experemental or releases.
+ +    Experemental branches:
+ +     This is where long running development efforts +will take place for the project. Each branch should follow the projects +naming +convention based on the type of branch. (See "SVN policies of this +project" for details) In general, these branches should be considered +"under development" or "experimental" and under the control of a +developer. When the branch reaches a stability point, where the code +implmentes the changes that are desired for the branch, has implemented +any now needed testing code, and the code still passes all tests for +the project then the branch is +ready to be merged back into the trunk.
+ +    Release branches are points of code development +where it has been tested, prepaired, and packaged as a step forward for +the project.
+ +
+ +

SVN policies of this project:

+ +
    + +
  1. all svn commits should have comments/log entries. (prefereably +identifying each file that was altered and in laymen terms what was +changed in that file)
    2. +
  2. the keyword Id should be included in a comment in every file (do +not forget to set the svn:keywords property on the file too.)
    3. +
  3. /branches/release-N.N.N will be official releases of the project
    4. +
  4. experemental branches are encouraged when any or all of the following +is true: + + + + + + + + + + + + +
    the +development effort will +take more than one commit to achieve
    the change is +likely to +break any backwards compatibility in +the current/previous release
    automated +testing failed, +or the changes are not yet covered by +automated testing
    +
    5. +
  5. code in compiled form should not be in SVN unless it is at +least one of the following: + + + + + + + + + +
    an outside +library that is +included for simplicity/compatibility (best done with a Vendor +Branch)
    it is in a +packaged release for the +project
    +
    6. +
  6. All new features developed must include automated testing code to +validate the function.The tests should be constructed in accordance with the format and approach that +the project is using for automated testing.
    +
    7. +
+ +

More general SVN references:

+ + + +


+

+ + \ No newline at end of file diff --git a/roombacomm-client/docs/ToDo.html b/roombacomm-client/docs/ToDo.html new file mode 100644 index 0000000..c1e6125 --- /dev/null +++ b/roombacomm-client/docs/ToDo.html @@ -0,0 +1,121 @@ + + + + To Do + + + +

TO +Do for 0.97 Release

+

MUST (we will hold shipment +for these)

+ +

Docs

+ +

HI-WANT (we plan to put these in, but priorities may intercede)

+ +

WANT (these are desirable and will be worked on opportunistically)

+ +

VERIFY (these are thought to be complete but need checking)

+ + + -- cgit v1.3.1