Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Apr 24, 2023
1 parent 93a57b5 commit 80af8e5
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 7 deletions.
2 changes: 2 additions & 0 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ EtherCAT Driver ROS2 Stack

`EtherCAT <https://www.ethercat.org/default.htm>`_ provides applications with the capacity of reliable, real-time communication between systems and is therefore a common industrial standard. In order to simplify the development/deployment of new application using EtherCAT modules, this stack allows to combine them with `ros2_control <https://github.com/ros-controls/ros2_control>`_. This driver proposes a generic ways to parametrize and assemble Hardware Interfaces based on EtherCAT modules that can be defined using parameter files.

**Project GitHub repository:** `ethercat_driver_ros2 <https://github.com/ICube-Robotics/ethercat_driver_ros2>`_

.. toctree::
:maxdepth: 1
:caption: Quickstart
Expand Down
2 changes: 0 additions & 2 deletions _sources/quickstart/configuration.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ EtherCAT Slave module plugins come in two version:
* **Generic plugins** : generic module implementation configured using a configuration file which purpose is to facilitate the use of generally available devices. For most applications, the use of these plugins is encouraged.
* **Specific plugins** : specific implementations for dedicated devices or dedicated functionalities.

.. note:: A list of implemented specific plugins for EtherCAT modules and their parameters can be found in this list of `available plugins <ethercat_plugins/available_plugins.md>`_.

Creating components with EtherCAT Slave modules
-----------------------------------------------

Expand Down
1 change: 1 addition & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@
<section id="ethercat-driver-ros2-stack">
<h1>EtherCAT Driver ROS2 Stack<a class="headerlink" href="#ethercat-driver-ros2-stack" title="Permalink to this headline"></a></h1>
<p><a class="reference external" href="https://www.ethercat.org/default.htm">EtherCAT</a> provides applications with the capacity of reliable, real-time communication between systems and is therefore a common industrial standard. In order to simplify the development/deployment of new application using EtherCAT modules, this stack allows to combine them with <a class="reference external" href="https://github.com/ros-controls/ros2_control">ros2_control</a>. This driver proposes a generic ways to parametrize and assemble Hardware Interfaces based on EtherCAT modules that can be defined using parameter files.</p>
<p><strong>Project GitHub repository:</strong> <a class="reference external" href="https://github.com/ICube-Robotics/ethercat_driver_ros2">ethercat_driver_ros2</a></p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Quickstart</span></p>
<ul>
Expand Down
4 changes: 0 additions & 4 deletions quickstart/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,6 @@ <h2>EtherCAT Slave modules as Plugins<a class="headerlink" href="#ethercat-slave
<li><p><strong>Generic plugins</strong> : generic module implementation configured using a configuration file which purpose is to facilitate the use of generally available devices. For most applications, the use of these plugins is encouraged.</p></li>
<li><p><strong>Specific plugins</strong> : specific implementations for dedicated devices or dedicated functionalities.</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A list of implemented specific plugins for EtherCAT modules and their parameters can be found in this list of <a class="reference external" href="ethercat_plugins/available_plugins.md">available plugins</a>.</p>
</div>
</section>
<section id="creating-components-with-ethercat-slave-modules">
<h2>Creating components with EtherCAT Slave modules<a class="headerlink" href="#creating-components-with-ethercat-slave-modules" title="Permalink to this headline"></a></h2>
Expand Down
Loading

0 comments on commit 80af8e5

Please sign in to comment.