korymath / aNAOmate

aNAOmate

A web-based interface for controlling SoftBank's Aldebaran Nao (V5/V6) robots.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

aNAOmate is an web-based interface for controlling SoftBank's Aldebaran Nao (V5/V6) robots.

Slidedeck

Built With

• NAOqi API
• Bootstrap

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https:://github.com/QuinnyB/aNAOmate.git

Usage

For examples, please refer to the Documentation

Editing TMI (Touch Move Interface for the Nao Robot)

1. Make changes in the TMI directory
2. Test the changes by following the quick testing instructions.
3. Once satisfied, ensure that all necessary files are linked in TMI/TMI.pml.
4. Once links are complete, open the TMI/TMI.pml in Choregraphe
5. File -> Build Application Package and save to the package directory.
6. Once the package is saved, install on the robot. (Note: NAOqi must be properly installed on your system for the installation script to work)

/usr/bin/python package/install_pkg.py $ROBOT_IP $PACKAGE_FILE_NAME

7. Once the package is installed, you will see: Installation complete. (This installs the application to /home/nao/.local/share/PackageManager/apps/TMI and runs the application if autorun="true" in the TMI/manifest
8. The application interface is now running, and starts automatically by default.
9. Navigate to http://$ROBOT_IP/apps/TMI to see developed the interface.
10. This interface should match the tested changes in Step 2.

Using the aNAOmate interface

TODO

Behaviours

TODO

Configure Development Environment

TODO

Roadmap

See the open issues for a list of proposed features (and known issues).

Authors

• Quinn Boser - Website
• Riley Dawson - Website
• Josh Whitney - Website
• Kory Mathewson - Website

See the list of contributors who participated in this project.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Josh Whitney - @JoshJRWhitney - [e-mail]

Project Link: https://github.com/QuinnyB/aNAOmate

Acknowledgements

The authors of this project would like to graciously acknowledge to continued support of the community.