+ refinement and reorganizing documents

+ documentation on how to get robot running
UW-Advanced-Robotics-Lab · Oct 4, 2023 · bd9dc6e · bd9dc6e
1 parent e784bbc
commit bd9dc6e
Show file tree

Hide file tree

Showing 28 changed files with 782 additions and 669 deletions.
diff --git a/docs/Home.md b/docs/Home.md
@@ -13,31 +13,41 @@ Outline and overview of works contributed by all members and alumnis from the **
   * [:diamond_shape_with_a_dot_inside: *Home*](./Home)
 
   * :label: **[   Lab   ]:** <--- Lab related information
-    * [:diamond_shape_with_a_dot_inside: *Code of Conduct*](./Lab%3ACode-of-Conduct)
-    * [:diamond_shape_with_a_dot_inside: *Getting Started*](./Lab%3AGetting-Started)
-    * [:diamond_shape_with_a_dot_inside: *List of Projects and Papers*](./Lab%3AList-of-Projects-and-Papers)
-    * [:diamond_shape_with_a_dot_inside: *On going Projects*](./Lab%3AOn-going-Projects)
-    * [:diamond_shape_with_a_dot_inside: *User Guide*](./Lab%3AUser-Guide)
-
-  * :label: **[   Logbook   ]:** <--- Log book for some of the trouble that was encountered (log and maybe messy)
-    * [:diamond_shape_with_a_dot_inside: *Jetson Setup*](./Logbook%3AJetson-Setup)
-    * [:diamond_shape_with_a_dot_inside: *Ubuntu Setup*](./Logbook%3AUbuntu-Setup)
-    * [:diamond_shape_with_a_dot_inside: *WAM PC Setup*](./Logbook%3AWAM-PC-Setup)
-    * [:diamond_shape_with_a_dot_inside: *Waterloo Steel V2 Upgrade*](./Logbook%3AWaterloo-Steel-V2-Upgrade)
-    * [:diamond_shape_with_a_dot_inside: *ZED Camera Setup*](./Logbook%3AZED-Camera-Setup)
-
+    | Topics                                                       | Note                                                         |
+    | ------------------------------------------------------------ | ------------------------------------------------------------ |
+    | [:diamond_shape_with_a_dot_inside: *Code of Conduct*](./Lab%3ACode-of-Conduct) | Code of Conduct, with UW Academic Code of Conduct            |
+    | [:diamond_shape_with_a_dot_inside: *Getting Started*](./Lab%3AGetting-Started) | :construction: ideally a manual for new comers to get started, :) |
+    | [:diamond_shape_with_a_dot_inside: *List of Projects and Papers*](./Lab%3AList-of-Projects-and-Papers) | 🚧 List of Research Projcets (Incomplete List) that are public |
+    | [:diamond_shape_with_a_dot_inside: *User Guide*](./Lab%3AUser-Guide) | 🚧 User Guide on GitHub                                       |
+
+  * :label: **[   Logbook   ]:** <--- Log book for some of the trouble that was encountered (log and maybe **messy** :warning: , use only if encountering issues)
+
+    | Logs                                                         | Note                                                         |
+    | ------------------------------------------------------------ | ------------------------------------------------------------ |
+    | [:diamond_shape_with_a_dot_inside: *Jetson Setup*](./Logbook%3AJetson-Setup) | Manual setup logs for Jetson Orin, includes cross-compiling Kernels (now, mostly automated) |
+    | [:diamond_shape_with_a_dot_inside: *Ubuntu Setup*](./Logbook%3AUbuntu-Setup) | Ubuntu Setup (now, mostly automated)                         |
+    | [:diamond_shape_with_a_dot_inside: *WAM PC Setup*](./Logbook%3AWAM-PC-Setup) | Internal / External WAM PC Manual Setup , (now, mostly automated) |
+    | [:diamond_shape_with_a_dot_inside: *Waterloo Steel V2 Upgrade*](./Logbook%3AWaterloo-Steel-V2-Upgrade) | Logs on manual upgrades from V1-->V2-->V3 , V3 is managed completely by [uwarl-robot_configs](https://github.com/UW-Advanced-Robotics-Lab/uwarl-robot_configs) |
+    | [:diamond_shape_with_a_dot_inside: *ZED Camera Setup*](./Logbook%3AZED-Camera-Setup) | Zed related issues, including hardware repair                |
+
   * :label: **[   Tips   ]:** <--- A guide/tip that helps YOU to guide you when you are lost
-    * [:diamond_shape_with_a_dot_inside: *Better Research*](./Tips%3ABetter-Research)
-    * [:diamond_shape_with_a_dot_inside: *Coding Guidelines*](./Tips%3ACoding-Guidelines)
-    * [:diamond_shape_with_a_dot_inside: *Dev Tools*](./Tips%3ADev-Tools)
+    | Tips                                                         | Note                                                         |
+    | ------------------------------------------------------------ | ------------------------------------------------------------ |
+    | [:diamond_shape_with_a_dot_inside: *Better Research*](./Tips%3ABetter-Research) | Tips and setups related to efficient research                |
+    | [:diamond_shape_with_a_dot_inside: *Coding Guidelines*](./Tips%3ACoding-Guidelines) | General Guides: Github, Git, Documentation, Python           |
+    | [:diamond_shape_with_a_dot_inside: *Dev Tools*](./Tips%3ADev-Tools) | Development Tools: Git, Linux, VM, ... (incomplete), besides our semi-automated [uwarl-robot_configs](https://github.com/UW-Advanced-Robotics-Lab/uwarl-robot_configs) packages |
 
   * :label: **[   Waterloo Steel   ]:** <--- :star2: The VIP (Very Important Pages) related to our hardware and development platform (Concised and actively maintained)
-    * [:diamond_shape_with_a_dot_inside: *Platform Development*](./Waterloo-Steel%3APlatform-Development) <--- Platform Development Guide: includes workspace, ROS and toolchains
-    * [:diamond_shape_with_a_dot_inside: *Platform Hardware Setup*](./Waterloo-Steel%3APlatform-Hardware-Setup) <--- Platform on Robot Hardware Guide: MXE 211, Jetson Orin, Steam Deck, Common in Linux
-    * [:diamond_shape_with_a_dot_inside: *Platform Launch Instruction*](./Waterloo-Steel%3APlatform-Launch-Instruction) <--- How to run the demo, and troubleshoot to launch the robot
-    * [:diamond_shape_with_a_dot_inside: *Platform Workstation Setup*](./Waterloo-Steel%3APlatform-Workstation-Setup) <--- HOW TO SETUP YOUR LAPTOP Linux / Linux VM (Ubuntu 18/20 , melodic / noetic)
-    * [:diamond_shape_with_a_dot_inside: *Spec Hardware*](./Waterloo-Steel%3ASpec-Hardware) <--- hardware specifications 
-    * [:diamond_shape_with_a_dot_inside: *Spec Links*](./Waterloo-Steel%3ASpec-Links) <--- other commonly used links related to hardware specs
+    | Directory                                                    | Note                                                         |
+    | ------------------------------------------------------------ | ------------------------------------------------------------ |
+    | [:diamond_shape_with_a_dot_inside: *Platform Instruction*](./Waterloo-Steel%3APlatform-Instruction) | :cheese: Platform Instructions: Powering, Launching, Networking, ROS, Development, Troubleshoots |
+    | [:diamond_shape_with_a_dot_inside: *Platform Launch Demos*](./Waterloo-Steel%3APlatform-Launch-Demos) | :rocket: Platform Launch Demos: Demos launching instructions |
+    | [:diamond_shape_with_a_dot_inside: *Platform Setup Hardware*](./Waterloo-Steel%3APlatform-Setup-Hardware) | :robot: Platform Setup for Robot Hardware: MXE 211, Jetson Orin, Steam Deck, Common in Linux with  [uwarl-robot_configs](https://github.com/UW-Advanced-Robotics-Lab/uwarl-robot_configs) |
+    | [:diamond_shape_with_a_dot_inside: *Platform Setup Workstation*](./Waterloo-Steel%3APlatform-Setup-Workstation) | :computer: HOW TO SETUP YOUR LAPTOP Linux / Linux VM (Ubuntu 18/20 , melodic / noetic) with  [uwarl-robot_configs](https://github.com/UW-Advanced-Robotics-Lab/uwarl-robot_configs) |
+    | [:diamond_shape_with_a_dot_inside: *Spec Hardware*](./Waterloo-Steel%3ASpec-Hardware) | :gear: Hardware specifications                               |
+    | [:diamond_shape_with_a_dot_inside: *Spec Links*](./Waterloo-Steel%3ASpec-Links) | :link: Other commonly used links related to hardware specs   |
+
+
 
 ## Hardware System Architecture
 

diff --git a/docs/Lab:Code-of-Conduct.md b/docs/Lab:Code-of-Conduct.md
@@ -1,7 +1,7 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:36 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:19 EDT*]
 - [**Academic Research Code of Conduct**](#Academic-Research-Code-of-Conduct)
   - [Attribution](#Attribution)
 - [**Contributor Covenant Code of Conduct**](#Contributor-Covenant-Code-of-Conduct)
@@ -107,6 +107,12 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
 
 
 
+
+
+
+
+
+
 <eof>
 
 ---

diff --git a/docs/Lab:Getting-Started.md b/docs/Lab:Getting-Started.md
@@ -1,15 +1,34 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:36 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:19 EDT*]
+- [**1. Preparation**](#1-Preparation)
+- [**2. Play around Robots**](#2-Play-around-Robots)
 
 ---
 </toc>
 
+# 1. Preparation
 
+| Tips                                                         | Note                                                         |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| [:diamond_shape_with_a_dot_inside: *Better Research*](./Tips%3ABetter-Research) | Tips and setups related to efficient research                |
+| [:diamond_shape_with_a_dot_inside: *Coding Guidelines*](./Tips%3ACoding-Guidelines) | General Guides: Github, Git, Documentation, Python           |
+| [:diamond_shape_with_a_dot_inside: *Dev Tools*](./Tips%3ADev-Tools) | Development Tools: Git, Linux, VM, ... (incomplete), besides our semi-automated [uwarl-robot_configs](https://github.com/UW-Advanced-Robotics-Lab/uwarl-robot_configs) packages |
 
 
 
+# 2. Play around Robots
+
+| Directory                                                    | Note                                                         |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| [:diamond_shape_with_a_dot_inside: *Platform Instruction*](./Waterloo-Steel%3APlatform-Instruction) | :cheese: Platform Instructions: Powering, Launching, Networking, ROS, Development, Troubleshoots |
+| [:diamond_shape_with_a_dot_inside: *Platform Launch Demos*](./Waterloo-Steel%3APlatform-Launch-Demos) | :rocket: Platform Launch Demos: Demos launching instructions |
+| [:diamond_shape_with_a_dot_inside: *Platform Setup Hardware*](./Waterloo-Steel%3APlatform-Setup-Hardware) | :robot: Platform Setup for Robot Hardware: MXE 211, Jetson Orin, Steam Deck, Common in Linux with  [uwarl-robot_configs](https://github.com/UW-Advanced-Robotics-Lab/uwarl-robot_configs) |
+| [:diamond_shape_with_a_dot_inside: *Platform Setup Workstation*](./Waterloo-Steel%3APlatform-Setup-Workstation) | :computer: HOW TO SETUP YOUR LAPTOP Linux / Linux VM (Ubuntu 18/20 , melodic / noetic) with  [uwarl-robot_configs](https://github.com/UW-Advanced-Robotics-Lab/uwarl-robot_configs) |
+| [:diamond_shape_with_a_dot_inside: *Spec Hardware*](./Waterloo-Steel%3ASpec-Hardware) | :gear: Hardware specifications                               |
+| [:diamond_shape_with_a_dot_inside: *Spec Links*](./Waterloo-Steel%3ASpec-Links) | :link: Other commonly used links related to hardware specs   |
+
 
 
 

diff --git a/docs/Lab:List-of-Projects-and-Papers.md b/docs/Lab:List-of-Projects-and-Papers.md
@@ -1,7 +1,7 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:36 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:19 EDT*]
 - [**Projects:**](#Projects)
   - [[2021-April. 2022] Demo (@akeaveny @fwthree3 @JXproject) - demostration of using elevators and traversing E7 @UW](#2021-April-2022-Demo-akeaveny-fwthree3-JXproject-demostration-of-using-elevators-and-traversing-E7-UW)
   - [[Dec. 2021] Affordance Grasping (@akeaveny)](#Dec-2021-Affordance-Grasping-akeaveny)
@@ -41,6 +41,12 @@
 
 
 
+
+
+
+
+
+
 <eof>
 
 ---

diff --git a/docs/Lab:On-going-Projects.md b/docs/Lab:On-going-Projects.md
diff --git a/docs/Lab:User-Guide.md b/docs/Lab:User-Guide.md
@@ -1,7 +1,7 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:36 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:19 EDT*]
 - [**1. Lab GitHub Usage**](#1-Lab-GitHub-Usage)
   - [1.1. Make your profile visible to public:](#11-Make-your-profile-visible-to-public)
 - [**2. Lab Maintainance**](#2-Lab-Maintainance)
@@ -53,7 +53,7 @@
 
 ### 2.1.3 How to grant Owner Settings
 
-![add_owner](resources/add_owner.png)
+![add_owner](resources/github/add_owner.png)
 
 - change role to **Owner**
   - able to manage the Lab GitHub and add people to the team
@@ -62,6 +62,12 @@
 
 
 
+
+
+
+
+
+
 <eof>
 
 ---

diff --git a/docs/Logbook:Jetson-Setup.md b/docs/Logbook:Jetson-Setup.md
@@ -1,7 +1,7 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:36 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:19 EDT*]
 - [**Jetson AGX Orin - RT Kernel Final Guide:**](#Jetson-AGX-Orin-RT-Kernel-Final-Guide)
 - [**Common**](#Common)
   - [Recommended Tool-sets:](#Recommended-Tool-sets)
@@ -297,6 +297,12 @@ export ROS_IP=192.168.0.150
 
 
 
+
+
+
+
+
+
 <eof>
 
 ---

diff --git a/docs/Logbook:Ubuntu-Setup.md b/docs/Logbook:Ubuntu-Setup.md
@@ -1,7 +1,7 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:36 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:19 EDT*]
 - [**Ubuntu Setup**](#Ubuntu-Setup)
   - [General Linux Ubuntu Setup](#General-Linux-Ubuntu-Setup)
   - [ROS Kinetic Setup (for Ubuntu 16.04)](#ROS-Kinetic-Setup-for-Ubuntu-1604)
@@ -161,6 +161,12 @@ $ sudo apt install protobuf-c-compiler
 
 
 
+
+
+
+
+
+
 <eof>
 
 ---

diff --git a/docs/Logbook:WAM-PC-Setup.md b/docs/Logbook:WAM-PC-Setup.md
@@ -1,7 +1,7 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:36 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:19 EDT*]
 - [**Install Libbarrett hardware (external PC) direct support through PEAK USB CAN (PCAN)**](#Install-Libbarrett-hardware-external-PC-direct-support-through-PEAK-USB-CAN-PCAN)
 - [**CF WAM Internal PC Setup:**](#CF-WAM-Internal-PC-Setup)
   - [Re-Install CF:](#Re-Install-CF)
@@ -91,6 +91,12 @@ Only in barrett/calibration_data/wam7w: zerocal.conf.5
 
 
 
+
+
+
+
+
+
 <eof>
 
 ---

diff --git a/docs/Logbook:Waterloo-Steel-V2-Upgrade.md b/docs/Logbook:Waterloo-Steel-V2-Upgrade.md
@@ -1,7 +1,7 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:36 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:19 EDT*]
 - [**Spec Comparison**](#Spec-Comparison)
 - [**ADLINK - MXE211**](#ADLINK-MXE211)
     - [Catkin_ws/src](#Catkin_wssrc)
@@ -904,6 +904,12 @@ Version: ROS Melodic + Ubuntu 18.04 rt
 
 
 
+
+
+
+
+
+
 <eof>
 
 ---

diff --git a/docs/Logbook:ZED-Camera-Setup.md b/docs/Logbook:ZED-Camera-Setup.md
@@ -1,7 +1,7 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:37 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:19 EDT*]
 - [**ZED Camera Documentation**](#ZED-Camera-Documentation)
   - [How to fix ZED Camera USB 3.0 not recognized](#How-to-fix-ZED-Camera-USB-30-not-recognized)
     - [Replace the cable:](#Replace-the-cable)
@@ -60,6 +60,12 @@ $ ./ZED_SDK_Tegra_L4T35.1_v3.8.2.zstd.run
 
 
 
+
+
+
+
+
+
 <eof>
 
 ---

diff --git a/docs/Tips:Better-Research.md b/docs/Tips:Better-Research.md
@@ -1,7 +1,7 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:37 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:19 EDT*]
 - [**Writing a Paper:**](#Writing-a-Paper)
   - [Book:](#Book)
   - [Data Visualization:](#Data-Visualization)
@@ -90,6 +90,12 @@
 
 
 
+
+
+
+
+
+
 <eof>
 
 ---

diff --git a/docs/Tips:Coding-Guidelines.md b/docs/Tips:Coding-Guidelines.md
@@ -1,7 +1,7 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:37 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:20 EDT*]
 - [**0. GitHub**](#0-GitHub)
 - [**1. Git**](#1-Git)
   - [1.1 Intro. to Git](#11-Intro-to-Git)
@@ -211,6 +211,12 @@ class PyClass:
 
 
 
+
+
+
+
+
+
 <eof>
 
 ---

diff --git a/docs/Tips:Dev-Tools.md b/docs/Tips:Dev-Tools.md
@@ -1,7 +1,7 @@
 <toc>
 
 # Table of Contents
-[*Last generated: Wed  4 Oct 2023 14:07:37 EDT*]
+[*Last generated: Wed  4 Oct 2023 15:34:20 EDT*]
 - [**Git:**](#Git)
   - [A better Git Graph:](#A-better-Git-Graph)
 - [**Linux:**](#Linux)
@@ -70,6 +70,12 @@ https://rocky-chen.medium.com/setup-ssh-connection-to-your-ubuntu-vm-of-virtualb
 
 
 
+
+
+
+
+
+
 <eof>
 
 ---