MangoMangoDevelopment / neptune

BSD 3-Clause "New" or "Revised" License
7 stars 4 forks source link

Project Neptune

Introduction

Project Neptune is the code name for an online robot configurator project developed by Mango Mango for Clearpath Robotics. The primary deliverable for the project is a web application that allows Clearpath's customers to drag and drop sensors on a robot base. After customizing the robot, the web app will output the configuration in Unified Robot Description Format (URDF) that Clearpath will use as the basis for building the robot.

Subprojects

The Neptune project includes three notable features:

Neptune Client

The Neptune Client is a WebGL application built in Unity that provides the UI for configuring a robot with customized sensors. The Neptune Client provides a drag and drop UI, extensive support for sensor position manipulation, and can also provide updated power usage, labour time and cost ratings for the configuration.

Feature overviews:

DB Maintenance

In addition to the Neptune Client, the DB Maintainance subproject is a utility tool for maintaining the centralized database of robot components that is read by the client app.

Feature overviews:

URDF/Unity Converter

The URDF/Unity Converter subproject is a class library developed in C# that provides an API for converting between URDF files and Unity game objects.

Feature overviews:

Developer References:

Development Environment

API Documentation

Coming soon!

Contribute

Currently, contribution for Project Neptune is closed to members of Mango Mango. Upon delivery of their capstone project, the team intends to open the project to external contributors.

Resources for Contributors

Deployment

Currently, deployment is handled internally by Mango Mango.

The latest deployment for development purposes is available here.