Read Me

-- Open Automaton Project: http://oap.sourceforge.net -- 

-------------------------------------------------------------------------------
Welcome to the Open Automaton Project. 

The list below briefly describes the contents of each of the project's 
subdirectories. Please consult the README documents within each of the 
subdirectories for more detailed information.

-------------------------------------------------------------------------------
config_api - Library used by the host programs for reading and writing
             configuration settings. Originally developed by Flavio de Ayra 
             Mendes.
-------------------------------------------------------------------------------
dia - Block diagrams created using the Dia drawing tool.
-------------------------------------------------------------------------------
docking_station - Ground-based charging station.
-------------------------------------------------------------------------------
etc - Configuration files used by the programs that run on the host system.
-------------------------------------------------------------------------------
head_control_module - Device for driving the Pan and Tilt head and interfacing
                      with the human body heat sensor. Interfaces with the host
                      via a synchronous serial bus (I2C).
-------------------------------------------------------------------------------
input_module - A device that allows humans to enter instructions via an
               on-board keypad, universal IR TV remote, or a custom RF remote.
               Plugs directly into the host's PS/2 keyboard socket and
               emulates a standard keyboard.
-------------------------------------------------------------------------------
motor_control_module - A device that generates high frequency PWM drive signals
                       for the two main DC drive motors, and captures odometry 
                       data from wheel encoders. Interfaces with the host
                       via the I2C synchronous serial bus.
-------------------------------------------------------------------------------
power_management_module - A device that monitors the main battery voltage, and
                          control battery charging. I2C host interface.
-------------------------------------------------------------------------------
rf_remote - A standalone battery operated handheld radio frequency remote 
            control unit that's compatible with the input module.
-------------------------------------------------------------------------------
sonar_array_module - A device for interfacing an array of sonar ranging
                     sensors. Interfaces with the host via a synchronous
                     serial bus (I2C).
-------------------------------------------------------------------------------
i2c_para_module - A parallel port device that provides an I2C master interface
                  to connect to the other I2C modules. Only required if the 
                  host mainboard doesn't have its own I2C header.
-------------------------------------------------------------------------------
utils - Command line utility programs that run on the host system, for testing,
        configuring and experimenting with the hardware devices on the I2C bus.
        These utilities use the /dev I2C kernel interface, so the i2c-dev 
        driver module must be loaded, as well as the I2C driver module for 
        the particular hardware implementation (for example, i2c-philips-par 
        for the parallel port interface). 
-------------------------------------------------------------------------------