Skip to content

Commit

Permalink
added doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mcbed committed Apr 24, 2023
1 parent 195e1a3 commit 534193b
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
1 change: 1 addition & 0 deletions ethercat_driver_ros2/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ EtherCAT Driver ROS2 Stack

user_guide/config_generic_slave
user_guide/config_cia402_drive
user_guide/sdo_async_com

.. toctree::
:maxdepth: 1
Expand Down
29 changes: 29 additions & 0 deletions ethercat_driver_ros2/sphinx/user_guide/sdo_async_com.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
SDO acyclic exchange using ROS2 services
========================================

Service Data Objects (SDO) contain object dictionary entries that can be exchanged acyclically. SDO works as a mailbox sending and buffering received data. This communication is acyclic and is dependent on available bandwidth in the communication cycle. This communication is not deterministic and is best suited for transmitting configuration data.

The EtherCAT Driver ROS2 stack comes with a service server that allows the exchange of data with an EtherCAT slave using ROS2 services through SDO.
The following services are available:

.. list-table::
:header-rows: 1

* - Service
- Interface
- Description
* - :code:`ethercat_manager/get_sdo`
- :code:`ethercat_msgs::srv::GetSdo`
- Read data from slave SDO register
* - :code:`ethercat_manager/set_sdo`
- :code:`ethercat_msgs::srv::SetSdo`
- Write data to slave SDO register

Usage
-----

Build and source the :code:`ethercat_manager` package and run:

.. code-block:: shell
$ ros2 run ethercat_manager ethercat_sdo_srv_server

0 comments on commit 534193b

Please sign in to comment.