Skip to content

Commit

Permalink
updated documentation by github action
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 14, 2025
1 parent e626bdd commit 6360777
Show file tree
Hide file tree
Showing 79 changed files with 468 additions and 98 deletions.
Binary file added _images/PiPER.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 92 additions & 0 deletions _sources/robot_user_guide/agilex/piper.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
*****
PiPER
*****

Revision History
================

+----------+-------------------+----------+------------------------------------------------------+
| Revision | Date (DD/MM/YYYY) | Author | Changes |
+==========+===================+==========+======================================================+
| 1 | 14/1/2025 | Kang Wei | Initial release |
+----------+-------------------+----------+------------------------------------------------------+

1. Overview
===========

.. image:: figures/PiPER.png
:width: 400 px
:align: center

PiPER by AgileX Robotics is a powerful lightweight robotic arm that excels in precision, speed, and adaptability. Compact and user-friendly, it seamlessly fits into any environment, empowering users to innovate and achieve more with ease.

2. Specifications
=================

.. list-table:: Common Technical Specifications
:widths: 25 25

* - Degree of Freedom
- 6
* - Payload
- 1.5 kg
* - Weight
- 4.2kg
* - Repeatability
- ±0.1mm
* - Reach
- 626mm
* - Input Voltage
- DC 24V
* - Materials
- Aluminum alloy boby, polymer shell
* - Controller
- Integrated
* - Communication
- CAN
* - Programming
- Drag teaching / Offline trajectory / API / PC
* - External Interface
- Power x 1, CAN x 1
* - Base Installation Dimensions
- 70mm x 70mm (M5 x 4)

3. Resources
============

Videos
------
* Unboxing (CN): `Video Link <https://www.bilibili.com/video/BV1KcmKYWE6L/?spm_id_from=333.999.0.0>`_
* Return to Home Position (CN): `Video Link <https://www.bilibili.com/video/BV1wDSDY1EJf/?spm_id_from=333.999.0.0>`_
* Gripper Installation (CN): `Video Link <https://www.bilibili.com/video/BV1Ab1PYzEvr/?spm_id_from=333.999.0.0>`_

Manuals
-------
* User Manual (EN): `PDF <https://tangrobot.sharepoint.com/:b:/s/Public-Outgoing/EfqPP2v-mhFKv-VARWnYcyUB-xQBw-88Vx5Pro3mZsgmGg?e=KTfP6b>`_
* Quick Start Guide (EN): `PDF <https://tangrobot.sharepoint.com/:b:/s/Public-Outgoing/EZQW2Y1CL_pHm8SymXTjTsMBVfHFpi-THuqaTYGQ3FMW1g?e=rQMw0H>`_
* User Manual (CN): `PDF <https://tangrobot.sharepoint.com/:b:/s/Public-Outgoing/EasMrjngL_pNmaawLe8mlCgBTgPMNG1hp6PRw32CDxccow?e=7q5abC>`_
* Quick Start Guide (CN): `PDF <https://tangrobot.sharepoint.com/:b:/s/Public-Outgoing/EQBRJZsY1gdDg_do070o2goBCWjyDwGL9dohA4xCFqkNog?e=38opB8>`_

Software
--------
* Windows Application: `APP <https://tangrobot.sharepoint.com/:u:/s/Public-Outgoing/EUN0qfdCSLVCqZPctXXr_SwB6CCPON8HHcWR5ybNwy1aOQ?e=zekJyS>`_
* CAN Communication Protocol (CN): `CAN Protocol <https://tangrobot.sharepoint.com/:x:/s/Public-Outgoing/EXt0lngMwfpEuhgttEqFuYIBtMUkrF6Ou1ovQOHQbsWm8A?e=2FoZtv>`_

Development
-----------
* SDK: `piper_sdk <https://github.com/agilexrobotics/piper_sdk>`_
* SDK_DEMO: `piper_sdk_demo <https://github.com/agilexrobotics/piper_sdk_demo>`_
* ROS1: `Piper_ros1_noetic <https://github.com/agilexrobotics/Piper_ros/tree/ros-noetic-no-aloha>`_
* ROS2:
* `Piper_ros2_humble <https://github.com/agilexrobotics/Piper_ros/tree/ros-humble-no-aloha>`_
* `Piper_ros2_foxy <https://github.com/agilexrobotics/Piper_ros/tree/ros-foxy-no-aloha>`_
* Gazebo: `Gazebo <https://github.com/agilexrobotics/agilex_open_class/tree/master/piper>`_
* Issac SIM: `piper_issac_sim <https://github.com/agilexrobotics/piper_isaac_sim>`_
* URDF: `urdf <https://github.com/agilexrobotics/Piper_ros/tree/ros-noetic-no-aloha/src/piper_description/urdf>`_
* Moveit2: `Moveit2 <https://github.com/agilexrobotics/agilex_open_class/tree/master/piper>`_

CAD Models
----------
* PiPER Arm: `PIPER <https://tangrobot.sharepoint.com/:u:/s/Public-Outgoing/Edhy2bZ_K1VEtaVOmVpe7AEBsh_b-1CXjWN9vhLG7VqNMw?e=qyKYmB>`_
* Gripper: `Gripper <https://tangrobot.sharepoint.com/:u:/s/Public-Outgoing/EYwTc-zvbopOqe_LtjsbhscBrMTgOvUHuVOVgNnWEDmt5w?e=WzT6bk>`_
* Drag Teaching Tool: `Drag Tool <https://tangrobot.sharepoint.com/:u:/s/Public-Outgoing/EfaGx4MK2hxHonUwllRgDGgBz9ciPUZrmXTq3Hu4o4WAyQ?e=ZVX6uK>`_
3 changes: 2 additions & 1 deletion _sources/robot_user_guide/manipulators.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ Robot Manipulators
/robot_user_guide/westonrobot/wr65
/robot_user_guide/westonrobot/wrl63
/robot_user_guide/ufactory/xarm
/robot_user_guide/unitree/z1
/robot_user_guide/unitree/z1
/robot_user_guide/agilex/piper
10 changes: 7 additions & 3 deletions _static/js/versions.js
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
const themeFlyoutDisplay = "hidden";
const themeVersionSelector = "True";
const themeLanguageSelector = "True";
const themeVersionSelector = true;
const themeLanguageSelector = true;

if (themeFlyoutDisplay === "attached") {
function renderLanguages(config) {
if (!config.projects.translations.length) {
return "";
}

// Insert the current language to the options on the selector
let languages = config.projects.translations.concat(config.projects.current);
languages = languages.sort((a, b) => a.language.name.localeCompare(b.language.name));

const languagesHTML = `
<dl>
<dt>Languages</dt>
${config.projects.translations
${languages
.map(
(translation) => `
<dd ${translation.slug == config.projects.current.slug ? 'class="rtd-current-item"' : ""}>
Expand Down
36 changes: 18 additions & 18 deletions _static/pygments.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; }
.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .err { border: 1px solid #F00 } /* Error */
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .o { color: #666 } /* Operator */
.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #9C6500 } /* Comment.Preproc */
Expand All @@ -25,34 +25,34 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .gt { color: #04D } /* Generic.Traceback */
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #B00040 } /* Keyword.Type */
.highlight .m { color: #666666 } /* Literal.Number */
.highlight .m { color: #666 } /* Literal.Number */
.highlight .s { color: #BA2121 } /* Literal.String */
.highlight .na { color: #687822 } /* Name.Attribute */
.highlight .nb { color: #008000 } /* Name.Builtin */
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
.highlight .no { color: #880000 } /* Name.Constant */
.highlight .nd { color: #AA22FF } /* Name.Decorator */
.highlight .nc { color: #00F; font-weight: bold } /* Name.Class */
.highlight .no { color: #800 } /* Name.Constant */
.highlight .nd { color: #A2F } /* Name.Decorator */
.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0000FF } /* Name.Function */
.highlight .nf { color: #00F } /* Name.Function */
.highlight .nl { color: #767600 } /* Name.Label */
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
.highlight .nn { color: #00F; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #19177C } /* Name.Variable */
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #666666 } /* Literal.Number.Bin */
.highlight .mf { color: #666666 } /* Literal.Number.Float */
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
.highlight .ow { color: #A2F; font-weight: bold } /* Operator.Word */
.highlight .w { color: #BBB } /* Text.Whitespace */
.highlight .mb { color: #666 } /* Literal.Number.Bin */
.highlight .mf { color: #666 } /* Literal.Number.Float */
.highlight .mh { color: #666 } /* Literal.Number.Hex */
.highlight .mi { color: #666 } /* Literal.Number.Integer */
.highlight .mo { color: #666 } /* Literal.Number.Oct */
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
Expand All @@ -67,9 +67,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0000FF } /* Name.Function.Magic */
.highlight .fm { color: #00F } /* Name.Function.Magic */
.highlight .vc { color: #19177C } /* Name.Variable.Class */
.highlight .vg { color: #19177C } /* Name.Variable.Global */
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
.highlight .il { color: #666 } /* Literal.Number.Integer.Long */
2 changes: 1 addition & 1 deletion genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/css/hacks.css?v=a7984756" />

Expand Down
2 changes: 1 addition & 1 deletion getting_started/basics/operational_safety.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Operational Safety &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../_static/css/hacks.css?v=a7984756" />

Expand Down
2 changes: 1 addition & 1 deletion getting_started/basics/robot_base_control.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Robot Base Control &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../_static/css/hacks.css?v=a7984756" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AgileX &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/hacks.css?v=a7984756" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Firmware Upgrade Tool &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/hacks.css?v=a7984756" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Scout V2.5 Robot &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/hacks.css?v=a7984756" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Scout (&gt;V2.5) Robot &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/hacks.css?v=a7984756" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Robot Upgrade Guide &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/hacks.css?v=a7984756" />

Expand Down
2 changes: 1 addition & 1 deletion getting_started/basics/robot_maintenance.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Robot Maintenance &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../_static/css/hacks.css?v=a7984756" />

Expand Down
2 changes: 1 addition & 1 deletion getting_started/common/communication.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ROS to CAN/Serial interface &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../_static/css/hacks.css?v=a7984756" />

Expand Down
2 changes: 1 addition & 1 deletion getting_started/common/general_information.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>General Information &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../_static/css/hacks.css?v=a7984756" />

Expand Down
2 changes: 1 addition & 1 deletion getting_started/common/mobile_robot_system.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview of Robots &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../_static/css/hacks.css?v=a7984756" />

Expand Down
2 changes: 1 addition & 1 deletion getting_started/common/software_packages.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview of Software Packages &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../_static/css/hacks.css?v=a7984756" />

Expand Down
2 changes: 1 addition & 1 deletion getting_started/common/ugv_system_overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>UGV System Overview &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../_static/css/hacks.css?v=a7984756" />

Expand Down
2 changes: 1 addition & 1 deletion getting_started/getting_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Getting Started &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/css/hacks.css?v=a7984756" />

Expand Down
3 changes: 2 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to Weston Robot Documentation &mdash; Weston Robot v0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/css/hacks.css?v=a7984756" />

Expand Down Expand Up @@ -161,6 +161,7 @@ <h1>Welcome to Weston Robot Documentation<a class="headerlink" href="#welcome-to
<li class="toctree-l3"><a class="reference internal" href="robot_user_guide/westonrobot/wrl63.html">Weston Robot WRL63</a></li>
<li class="toctree-l3"><a class="reference internal" href="robot_user_guide/ufactory/xarm.html">xArm Manipulator Series</a></li>
<li class="toctree-l3"><a class="reference internal" href="robot_user_guide/unitree/z1.html">Z1 Robot Arm</a></li>
<li class="toctree-l3"><a class="reference internal" href="robot_user_guide/agilex/piper.html">PiPER</a></li>
</ul>
</li>
</ul>
Expand Down
Binary file modified objects.inv
Binary file not shown.
Loading

0 comments on commit 6360777

Please sign in to comment.