Skip to content

Commit

Permalink
Add Trunk img
Browse files Browse the repository at this point in the history
  • Loading branch information
hbuurmei committed Sep 23, 2024
1 parent 419a78d commit beb1bc0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 12 deletions.
Binary file added docs/assets/trunk-closeup.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 4 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,11 @@
# Welcome to the ASL Trunk robot documentation
This documentation provides a detailed guide to the setup, configuration, and use of the Trunk Robot. It is intended for internal use by the team involved in the development, deployment, and maintenance of the robot.

![Trunk robot](assets/trunk-closeup.jpg)

## Contents
- Design: Documentation for full-system software, electrical, and mechanical design. Inlcudes BOM, CAD assets, circuit diagram, and design considerations.
- Robot Setup: Instructions for setting up trunk hardware and software
- Usage: Instructions for using a set up trunk robot
- Motion Capture: Instructions for setting up and using the motion capture system with the Trunk Robot.
- Motor Control: Instructions for enabling motor control of the Trunk Robot.
- Collecting Data: Instructions for collecting data using the Trunk Robot, including data collection scripts and procedures.
- Video Streaming: Instructions for using the video streaming capabilities of the Trunk Robot.
- Telemetry Viewer: Description on how to view and visualize telemetry data.
- Teleoperation: Instructions for teleoperating the robot with an Apple Vision Pro to collect data.
- Visuomotor Rollout: Instructions for rolling out a visuomotor policy on the Trunk Robot hardware.
- Robot Setup: Instructions for setting up trunk hardware and software. This shall be referenced for repairs, upgrades, and new installations.
- Usage: Description on how to use the trunk robot.
- Contributing: Guidelines for contributing to the development of the Trunk Robot project.

This documentation is intended as a practical resource to support your work with the Trunk Robot, ensuring that all ASL members have access to the necessary information to effectively manage the system.

<!-- WIP! Some details on the design/features of the robot. BOM? CAD? Pictures? May need to be re-taken. -->

0 comments on commit beb1bc0

Please sign in to comment.