Difference between revisions of "Advantech Robotic Suite/Advantech ROS2 Data Format"

From ESS-WIKI
Jump to: navigation, search
 
(11 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
= Introduction =
 
= Introduction =
  
−
The message definition of Advantech ROS node are located in include/adv_msgs folder, message file (.msg) is defined for node data publish/subscribe and action file (.action) is defined for setting sensor data.
+
The message definition of ROS2 node are located in include/adv_msgs folder, message file (.msg) is defined for node data publish/subscribe and action file (.action) is defined for setting sensor data.
  
 
 
 
 
  
−
== Message definition ==
+
= Message definition =
  
 
'''AdvSensor.msg'''
 
'''AdvSensor.msg'''
Line 25: Line 25:
 
 
 
 
  
−
== Action definition ==
+
= Action definition =
  
 
'''AdvSensorSet.action'''
 
'''AdvSensorSet.action'''
Line 33: Line 33:
 
 
 
 
  
−
{| width="887" height="62" cellspacing="1" cellpadding="1" border="1"
+
{| border="1" cellpadding="1" cellspacing="1" width="887"
 
|-
 
|-
−
| style="width: 47px; text-align: center" | '''<span style="font-size:larger">Action Type</span>'''
+
| style="width: 47px; text-align: center" | '''<span style="font-size:larger">Action Type</span>'''
−
| style="width: 63px; text-align: center" | '''<span style="font-size:larger">Action name</span>'''
+
| style="width: 63px; text-align: center" | '''<span style="font-size:larger">Action name</span>'''
−
| style="width: 85px; text-align: center" | '''<span style="font-size:larger">Action File</span>'''
+
| style="width: 85px; text-align: center" | '''<span style="font-size:larger">Action File</span>'''
 
|-
 
|-
−
| style="width: 47px; text-align: center" | <span style="font-size:larger">adv_msgs/action/AdvSensorSet</span>
+
| style="width: 47px; text-align: center" | <span style="font-size:larger">adv_msgs/action/AdvSensorSet</span>
−
| style="width: 63px; text-align: center" | <span style="font-size:larger">adv_sensor_set</span>
+
| style="width: 63px; text-align: center" | <span style="font-size:larger">adv_sensor_set</span>
−
| style="width: 85px; text-align: center" | <span style="font-size:larger">AdvSensorSet.action</span>
+
| style="width: 85px; text-align: center" | <span style="font-size:larger">AdvSensorSet.action</span>
 
|}
 
|}
  
 
&nbsp;
 
&nbsp;
−
 
+
<pre># This is a request/response/feedback that holds a detail hardware sensor data that Advantech device/board provided.
−
<pre>
 
−
# This is a request/response/feedback that holds a detail hardware sensor data that Advantech device/board provided.
 
 
#
 
#
 
string    cmd      # Request command of set sensor value
 
string    cmd      # Request command of set sensor value
Line 66: Line 64:
 
&nbsp;
 
&nbsp;
  
−
== Setup message ==
+
= Setup Message =
  
 
This section will introduct you how to setup node in your environmant.
 
This section will introduct you how to setup node in your environmant.
−
<br/>
 
  
−
1. Sourcing ROS2 foxy environmant setup file:
+
1. Setup ROS2 environmant variables:
−
<pre>
+
<pre>$ source /opt/ros/${ROS_DISTRO}/setup.bash
−
$ source /opt/ros/foxy/setup.bash
 
 
</pre>
 
</pre>
−
<br/>
 
  
−
2. Sourcing node setup file:
+
&nbsp;
−
<pre>
+
 
−
$ source /usr/local/Advantech/ros/foxy/include/edge-converter-ros2/adv_msgs/install/local_setup.bash
+
2. Setup ROS2 message definition:
 +
<pre>$ source /usr/local/Advantech/ros/${ROS_DISTRO}/include/edge-converter-ros2/adv_msgs/install/local_setup.bash
 
</pre>
 
</pre>
−
<br/>
 
  
−
[[Category:Editor]]
+
&nbsp;

Latest revision as of 04:24, 5 March 2024

Introduction

The message definition of ROS2 node are located in include/adv_msgs folder, message file (.msg) is defined for node data publish/subscribe and action file (.action) is defined for setting sensor data.

 

Message definition

AdvSensor.msg

The file AdvSensor.msg is a message definition that holds a detail hardware sensor data that Advantech device/board provided.

  

# This is a message that holds a detail hardware sensor data that Advantech device/board provided.
#
string    sensor    # Sensor name
string    type      # Sensor type: "v", "bv" or "sv"
bool      bv        # Boolean type of sensor value 
float64   v         # Number type of sensor value 
string    sv        # String type of sensor value 
uint64    ts        # Timestamp od sensor value

 

Action definition

AdvSensorSet.action

The file AdvSensorSet.action' is a request/response/feedback that holds a detail hardware sensor data that Advantech device/board provided.

 

Action Type Action name Action File
adv_msgs/action/AdvSensorSet adv_sensor_set AdvSensorSet.action

  

# This is a request/response/feedback that holds a detail hardware sensor data that Advantech device/board provided.
#
string    cmd       # Request command of set sensor value
string    sensor    # Sensor name of set request
string    type      # Sensor type: "v", "bv" or "sv"
bool      bv        # Boolean type of sensor value
float64   v         # Number type of sensor value
string    sv        # String type of sensor value
---
int16     code      # Result code, request accept: 100, unaccept: code > 100
---
int16     status    # Status feedback of set sensor request
string    sensor    # Sensor name feedback of set request
string    info      # Information feedback of set request
uint64    ts        # Timestamp of sensor value

 

Setup Message

This section will introduct you how to setup node in your environmant.

1. Setup ROS2 environmant variables: 

$ source /opt/ros/${ROS_DISTRO}/setup.bash

 

2. Setup ROS2 message definition: 

$ source /usr/local/Advantech/ros/${ROS_DISTRO}/include/edge-converter-ros2/adv_msgs/install/local_setup.bash

 

Retrieved from "https://ess-wiki.advantech.com.tw/wiki/index.php?title=Advantech_Robotic_Suite/Advantech_ROS2_Data_Format&oldid=34150"