Real-Time Robotics Framework

User Tools

Site Tools

You are here: EEROS Wiki » EEROS Architecture » Hardware Abstraction Layer » Configuration File for ROS
eeros_architecture:hal:config_ros

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
eeros_architecture:hal:config_ros [2017/11/30 19:55] – grafeeros_architecture:hal:config_ros [2023/02/27 14:44] (current) – [Configuration File for ROS] ursgraf
Line 1: Line 1:
 ====== Configuration File for ROS ====== ====== Configuration File for ROS ======
  
-^ Keyword ^ Type ^ Remarks ^ +As described in [[getting_started:ros#Using ROS through EEROS HAL|]] you can directly map EEROS signal onto ROS messages through the EEROS HAL. The wrapper library [[eeros_architecture:hal:hardware_libraries#ros|EEROS-ROS]] is used to connect the EEROS HAL with ROS topics. \\ 
-| deviceX | object | device, X is the device number |+The EEROS HAL digital and analog inputs and outputs can be defined as usual in a JSON file. In this file you specify into which message type these signals get packed. There are hundreds of different message types in ROS and it is possible to create custom types. For this reason, we currently support only a few by default. If one wishes to use other message types, the wrapper library can easily be extended.
  
-As described in [[getting_started:ros#Using ROS through EEROS HAL|]]The wrapper library ''\textit{ros-eeros}'' is used to connect the EEROS HAL with ROS topics.+WARNING  
 +The naming of messages changes from ROS1 to ROS2, e.g. 
 +  * ROS1: std_msgs::Float64 
 +  * ROS2: std_msgs::msg::Float64 
 +The information below is for ROS1. Change accordingly for ROS2.
  
-The EEROS HAL digital and analogue inputs and outputs can be defined with an *.json file. +The keywords for the EEROS-ROS wrapper library must be set as follows: 
- +^ Keyword ^ Type ^ Remarks ^ 
-If you want to test your application with a \textit{Gazebo} simulation, you can define your inputs and outputs as ROS topics to connect your application with the simulation completely without any real hardware. +| library | string | libroseeros.so (include version e.g. *.so.0.1.2) | 
- +| devHandle | string | e.g. testNodeHAL, this is the name of the node created by the HAL | 
-To use your application with hardware, you can, for example, use the wrapper library \textit{comedi-eeros} or \textit{flink-eeros}. +| type | string | e.g. AnalogIn / AnalogOut / DigIn / DigOut | 
- +| additionalArguments | string | see table below |
-If you adapt the *.json file correctly, your application should now run on hardware with real encoders and motors without any problems. +
- +
- +
- +
-It is also possible to use ROS-topics alongside real hardware. +
- +
-You can use \textit{comedi-eeros} to read an encoder and set a control value for a motor. +
- +
-At the same time, you can publish the same values to ROS topics to visualize the state of the robot with \textit{rviz} (if you have a model of your robot) or you can monitor the values with a ROS tool like ''\textit{rqt}'' and display them in a graph with \textit{Multiplot} or as numbers with \textit{TopicMonitor}. +
- +
-With \textit{Multiplot} you can also store the values in a text file. +
- +
- +
- +
-There are hundreds of different message types in ROS and it is possible to create custom types. +
- +
-Because every message type has to be handled differently, only a few are supported by default. +
- +
-But the wrapper library can easily be extended to support additional message types. +
- +
-Chapter \ref{sectionImplementMsgType} describes how you can add a new ROS msg type to the library. +
- +
- +
- +
- +
- +
-\subsection{The *.json file} +
- +
-Table \ref{tableKeyValueEeros} shows the most important key-value pairs for using the HAL with ROS. +
- +
- +
- +
-\begin{table}[] +
- +
-\centering +
- +
-\caption{Most important key-value pairs for ros-eeros} +
- +
-\label{tableKeyValueEeros} +
- +
-\begin{tabular}{@{}lll@{}} +
- +
-\toprule +
- +
-Key                 & Typical value                         & Description              \\ \midrule +
- +
-library             & libroseeros.so                        & Wrapper library  for ROS \\ +
- +
-devHandle           & testNodeHAL                           & ROS node created by HAL  \\ +
- +
-type                & AnalogIn / AnalogOut / DigIn / DigOut & Type of input / output   \\  +
- +
-additionalArguments & 'see next table'                      & 'see next table'         \\ \bottomrule +
- +
-\end{tabular} +
- +
-\end{table} +
- +
- +
- +
-The \textit{additionalArguments} are special arguments which are parsed in the wrapper library \textit{ros-eeros}. +
- +
-These arguments contain additional information which are necessary to communicate with a ROS network. +
- +
-All arguments are separated with a semicolon. +
- +
-The available arguments are listed in table \ref{tableAdditionalArgumentsEeros}.+
  
 +===== Additional Arguments =====
 +The ''additionalArguments'' are special arguments containing additional information about the communication with a ROS network. The next table shows all currently available arguments. ''topic'' and ''msgType'' are mandatory.
  
 +^ Keyword ^ Type ^ Remarks ^
 +| topic | string | topic to listen or subscribe |
 +| msgType | string | message type |
 +| dataField | string | data member of message |
 +| callOne | boolean | newest availabe message is fetched (false), oldest not yet read message is fetched (true) |
 +| queueSize | int | size of buffer, default = 1000 |
 +| useEerosSystemTime | boolean | use system time or timestamp of message |
  
 An example for an additional argument could be: An example for an additional argument could be:
 +<code>
 +  "additionalArguments": "topic=/testNode/TestTopic3; msgType=sensor_msgs::LaserScan; dataField=scan_time; callOne=false; queueSize=100"
 +</code>
  
 +===== Implemented Message Types =====
 +The table below shows all currently implemented message types and associated data fields. If your desired message type is not implemented yet, you can easily implement it yourself, see below.
  
 +^ type ^ msgType ^ dataField ^
 +| AnalogIn | std_msgs::Float64 | - |
 +| ::: | sensor_msgs::LaserScan | angle_min |
 +| ::: | ::: | angle_max |
 +| ::: | ::: | angle_increment |
 +| ::: | ::: | time_increment |
 +| ::: | ::: | scan_time |
 +| ::: | ::: | range_min |
 +| ::: | ::: | range_max |
 +| AnalogOut | std_msgs::Float64 | - |
 +| ::: | sensor_msgs::LaserScan | angle_min |
 +| ::: | ::: | angle_max |
 +| ::: | ::: | angle_increment |
 +| ::: | ::: | time_increment |
 +| ::: | ::: | scan_time |
 +| ::: | ::: | range_min |
 +| ::: | ::: | range_max |
 +| DigIn | std_msgs::BatteryState | present |
 +| DigOut | std_msgs::BatteryState | present |
  
-\begin{snugshade*} +You can find a complete example, including a *.json file, in the [[getting_started:tutorials:start|]].
- +
-\textit{\char"22additionalArguments\char"22: \char"22topic=/testNode/TestTopic3; msgType=sensor\_msgs::LaserScan; \\ +
- +
-dataField=scan\_time; callOne=false; queueSize=100\char"22,} +
- +
-\end{snugshade*} +
- +
- +
- +
- +
- +
-Table \ref{tableAdditionalArgumentsEeros} shows all currently available \textit{additionalArguments}. +
- +
-\textbf{Topic} and \textbf{msgType} are mandatory arguments. +
- +
- +
- +
-\begin{table} +
- +
-\centering +
- +
-\caption{Additional arguments specific for ros-eeros} +
- +
-\label{tableAdditionalArgumentsEeros} +
- +
-\begin{tabular}{@{}lll@{}} +
- +
-\toprule +
- +
-Key        & Typical value           & Description                                \\ \midrule +
- +
-\textbf{topic}      & /testNode/TestTopic1    & Topic to listen / subscribe                \\ +
- +
-\textbf{msgType }   & sensor\_msgs::LaserScan & ROS message type of topic                  \\  +
- +
-dataField & scan\_time              & Desired data member of message             \\ +
- +
-callOne    & true                    & Oldest, not yet fetched message is fetched \\ +
- +
-callOne    & false                   & Newest available message is fetched        \\ +
- +
-queueSize  & 1000                    & Size of buffer; queueSize=1000 if omitted  \\  +
- +
-useEerosSystemTime  & fals           & Use system time or timestamp of received msg  \\ \bottomrule +
- +
-\end{tabular} +
- +
-\end{table} +
- +
- +
- +
-In table \ref{tableImplementedMsgTypes} are all currently implemented message types and associated data fields. +
- +
-If your desired message type is not implemented yet, you can easily implement it yourself. +
- +
-See chapter \ref{sectionImplementMsgType} for a guide to implement additional message types and data fields in \textit{ros-eeros}. +
- +
- +
- +
-\begin{table}[] +
- +
-\centering +
- +
-\caption{Currently implemented message types in ros-eeros} +
- +
-\label{tableImplementedMsgTypes} +
- +
-\begin{tabular}{lll} +
- +
-\cline{2-3} +
- +
-HAL type  & msgType                    & dataField        \\ \cline{2-3}  +
- +
-AnalogIn  & std\_msgs::Float64         & -                \\ +
- +
-          & sensor\_msgs::LaserScan    & angle\_min       \\ +
- +
-          &                            & angle\_max       \\ +
- +
-          &                            & angle\_increment \\ +
- +
-          &                            & time\_increment  \\ +
- +
-          &                            & scan\_time       \\ +
- +
-          &                            & range\_min       \\ +
- +
-          &                            & range\_max       \\ +
- +
-AnalogOut & std\_msgs::Float64         & -                \\ +
- +
-          & sensor\_msgs::LaserScan    & angle\_min       \\ +
- +
-          &                            & angle\_max       \\ +
- +
-          &                            & angle\_increment \\ +
- +
-          &                            & time\_increment  \\ +
- +
-          &                            & scan\_time       \\ +
- +
-          &                            & range\_min       \\ +
- +
-          &                            & range\_max       \\ +
- +
-DigIn     & sensor\_msgs::BatteryState & present          \\ +
- +
-DigOut    & sensor\_msgs::BatteryState & present          \\ \cline{2-3}  +
- +
-\end{tabular} +
- +
-\end{table} +
- +
- +
- +
-You can find a complete example, including a *.json file, in the eeros framework (/examples/hal/Ros*). +
- +
- +
- +
- +
- +
-\subsection{How to use} +
- +
-Refere to the documentation of the EEROS HAL\footnote{http://wiki.eeros.org/eeros\_architecture/hal/start?s[]=hal} and check the example in the eeros framework (/examples/ros). +
- +
- +
- +
-First initialize the HAL in your main function: +
- +
-\lstset{language=c} +
- +
-\begin{lstlisting} +
- +
-... +
- +
-int main(int argc, char **argv) { +
- +
- ... +
- +
- // HAL +
- +
- // //////////////////////////////////////////////////////////////////////// +
- +
- HAL& hal = HAL::instance(); +
- +
- hal.readConfigFromFile(&argc, argv); +
- +
- ... +
- +
-\end{lstlisting} +
- +
- +
- +
-Add the header file to your control system: +
- +
-\lstset{language=c} +
- +
-\begin{lstlisting} +
- +
-#include <eeros/hal/HAL.hpp> +
- +
-\end{lstlisting} +
- +
- +
- +
-You can now declare \textit{PeripheralInputs} and \textit{PeripheralOutputs}: +
- +
-\lstset{language=c} +
- +
-\begin{lstlisting} +
- +
- PeripheralInput<double> analogIn0; +
- +
- PeripheralInput<bool> digitalIn0; +
- +
- PeripheralOutput<double> analogOut0; +
- +
- PeripheralOutput<bool> digitalOut0; +
- +
-\end{lstlisting} +
- +
- +
- +
-Call the constructor of the peripheral IOs with the \textit{signalID} used in the *.json file +
- +
-\begin{lstlisting} +
- +
-class MyControlSystem { +
- +
-public: +
- +
- MyControlSystem(double ts, ros::NodeHandle& rosNodeHandler): +
- +
- dt(ts), +
- +
- ... +
- +
- analogIn0("scanTimeIn0"), // argument has to match signalId of json +
- +
- digitalIn0("batteryPresent0"), +
- +
- analogOut0("scanTimeEchoOut0"), +
- +
- digitalOut0("batteryPresentEchoOut0"),+
  
- ... 
  
-} 
eeros_architecture/hal/config_ros.1512068144.txt.gz · Last modified: 2017/11/30 19:55 by graf