Refs #3561 - Generate uROS_Agent module

This commit is contained in:
Javier Moreno
2018-10-19 10:45:56 +02:00
parent 45c4a698c3
commit bb1fe9561c
11 changed files with 193 additions and 0 deletions
+212
View File
@@ -0,0 +1,212 @@
# Copyright 2018 Proyectos y Sistemas de Mantenimiento SL (eProsima).
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Set CMake version
cmake_minimum_required(VERSION 3.5)
# Set proyect name
project(uros_agent)
# Find packages depencences
find_package(rosidl_cmake REQUIRED)
find_package(ament_cmake REQUIRED)
find_package(fastcdr REQUIRED CONFIG)
find_package(fastrtps REQUIRED CONFIG)
find_package(microxrcedds_agent REQUIRED CONFIG)
find_package(ament_cmake_python REQUIRED)
# Export dependencies to downstream packages
ament_export_dependencies(fastcdr)
ament_export_dependencies(fastrtps)
ament_export_dependencies(microxrcedds_agent)
# Set variables
set(_OUTPUT_PATH "${CMAKE_CURRENT_BINARY_DIR}/python")
set(_XML_INTERFACE_GEN_BIN "${_OUTPUT_PATH}/bin/Xml_interface_gen.py")
normalize_path(_XML_INTERFACE_GEN_BIN "${_XML_INTERFACE_GEN_BIN}")
set(_XML_DEFAULT_READ_BIN "${_OUTPUT_PATH}/bin/Xml_read_default_profiles.py")
normalize_path(_XML_DEFAULT_READ_BIN "${_XML_DEFAULT_READ_BIN}")
set(_PYTHON_PKG_TOOL ${PROJECT_NAME})
set(_RESOURCE_DIR "${_OUTPUT_PATH}/resource")
normalize_path(_RESOURCE_DIR "${_RESOURCE_DIR}")
set(_DEFAULT_FASTRTPS_PROFILES_PATH "${_OUTPUT_PATH}/gen/DEFAULT_FASTRTPS_PROFILES.xml")
normalize_path(_DEFAULT_FASTRTPS_PROFILES_PATH "${_DEFAULT_FASTRTPS_PROFILES_PATH}")
# Get colcon call dir
get_filename_component(_COLCON_CALL_DIR "${CMAKE_INSTALL_PREFIX}" DIRECTORY)
get_filename_component(_COLCON_CALL_DIR "${_COLCON_CALL_DIR}" DIRECTORY)
# Generate python header
set(
_PYTHON_SCRIPT_HEAD
"
import os\n
import sys\n
sys.path.append('${_OUTPUT_PATH}')\n
from ${_PYTHON_PKG_TOOL} import *\n
"
)
# Copy pyton files
file(COPY "bin" "${_PYTHON_PKG_TOOL}" "resource" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/python")
# Extract all packages and manifiest paths
execute_process(
COMMAND
"${PYTHON_EXECUTABLE}"
"-c"
"${_PYTHON_SCRIPT_HEAD}for package in GetInterfacePackages(GetPackageList('${_COLCON_CALL_DIR}')): print ('%s,%s' % (package, GetPackageName(package)))"
OUTPUT_VARIABLE _packages
RESULT_VARIABLE _result
OUTPUT_STRIP_TRAILING_WHITESPACE
)
if(NOT _result EQUAL 0)
message(FATAL_ERROR "Error finding xml packages")
endif()
# Convert output to list
string(REPLACE "\n" ";" _packages ${_packages})
# Extract all msg from each package (stored in ${package}_MSG_FILES)
set(ALL_MSG_FILES "")
foreach(package ${_packages})
# Extract info
string(REPLACE "," ";" package ${package})
list(GET package 0 package_file)
list(GET package 1 package)
# Get all msg files
execute_process(
COMMAND
"${PYTHON_EXECUTABLE}"
"-c"
"${_PYTHON_SCRIPT_HEAD}for msg in GetInterfacePackageMsgs('${package_file}'): print ('%s' % msg)"
OUTPUT_VARIABLE ${package}_MSG_FILES
RESULT_VARIABLE _result
OUTPUT_STRIP_TRAILING_WHITESPACE
)
if(NOT _result EQUAL 0)
message(FATAL_ERROR "Error finding .msg files")
endif()
# Skip if there are no msgs to create
if(${package}_MSG_FILES STREQUAL "")
continue()
endif()
# Generate list
string(REPLACE "\n" ";" ${package}_MSG_FILES ${${package}_MSG_FILES})
endforeach()
# Append defaul xml profiles
execute_process(
COMMAND "${PYTHON_EXECUTABLE}" "${_XML_DEFAULT_READ_BIN}" "--default-xml-path" "${_RESOURCE_DIR}"
OUTPUT_VARIABLE _XmlDoc
RESULT_VARIABLE _result
)
if(NOT _result EQUAL 0)
message(FATAL_ERROR "Error in typesuppor generation")
endif()
# Create one xml for each message
foreach(package ${_packages})
string(REPLACE "," ";" package ${package})
list(GET package 0 package_file)
list(GET package 1 package)
# Skip this generation if there are no msgs to process
if(${package}_MSG_FILES STREQUAL "")
continue()
endif()
# generate script argument file
set(generator_arguments_file "${_OUTPUT_PATH}/XML_ArgFiles/${package}_Args.json")
rosidl_write_generator_arguments(
"${generator_arguments_file}"
PACKAGE_NAME "${package}"
ROS_INTERFACE_FILES "${${package}_MSG_FILES}"
ROS_INTERFACE_DEPENDENCIES "NULL"
OUTPUT_DIR "NULL"
TEMPLATE_DIR "NULL"
TARGET_DEPENDENCIES "NULL"
ADDITIONAL_FILES ""
)
# execute python script
execute_process(
COMMAND "${PYTHON_EXECUTABLE}" "${_XML_INTERFACE_GEN_BIN}" --generator-arguments-file "${generator_arguments_file}"
OUTPUT_VARIABLE _XmlGen
RESULT_VARIABLE _result
)
if(NOT _result EQUAL 0)
message(FATAL_ERROR "Error in typesuppor generation")
endif()
# Strore xml
set(_XmlDoc "${_XmlDoc}${_XmlGen}")
endforeach()
# Close profile
set (_XmlDoc "<profiles>\n${_XmlDoc}</profiles>\n")
# Save
file(WRITE "${_DEFAULT_FASTRTPS_PROFILES_PATH}" "${_XmlDoc}")
# Install the package.xml file, and generate code for ``find_package`` so that other packages can get information about this package.
ament_package()
#Install
install(
FILES "${_DEFAULT_FASTRTPS_PROFILES_PATH}"
DESTINATION "../microxrcedds_agent/bin"
)
# Install package
#install(
# DIRECTORY cmake resource
# DESTINATION share/${PROJECT_NAME}
#)
+31
View File
@@ -0,0 +1,31 @@
# Micro ROS Agent
## Overview
This repository contains the Micro-ROS Agent package.
Micro-ROS Agent is a ROS 2 node that wraps the Micro XRCE-DDS Agent.
For further information about Micro XRCE-DDS Agent click [here](https://github.com/eProsima/Micro-XRCE-DDS-Agent)
This package is a part of the Micro-ROS project stack.
For more information about Micro-ROS project click [here](https://microros.github.io/micro-ROS/).
The node acts as a server between DDS Network and Micro-ROS nodes inside MCU.
It receives and send messages from Micro-ROS nodes, and keep track of the Micro-ROS nodes exposing them to the ROS 2 network.
The node interacts with DDS Global Data Space on behalf of the Micro-ROS nodes.
## Package features
### XML generation
During the build process, the package looks for all ROS 2 messages to generate an initial list of XML profiles.
These profiles can are referenced in the Agent-Client communication to avoid sending the full XML content.
This reference mechanism can be switched on and off from the Micro XRCE-DDS middleware layer.
### Agent-Client communication mechanism
Communication between the Micro-ROS Agent and the Micro-ROS nodes supports two types of transport:
- UDP.
- SerialPort.
All available configurations are supported directly by the Micro XRCE-DDS agent.
For further information on how to configure the agent click [here](TODO).
+30
View File
@@ -0,0 +1,30 @@
#!/usr/bin/env python3
import argparse
import os
import sys
sys.path.append(os.path.join(os.path.dirname(os.path.realpath(__file__)),'..'))
from rosidl_cmake import read_generator_arguments
from rosidl_parser import UnknownMessageType
from uros_agent import generate_XML
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description='Generate the C interfaces for Micro RTPS.',
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument(
'--generator-arguments-file',
required=True,
help='The location of the file containing the generator arguments')
args = parser.parse_args(argv)
generator_args = read_generator_arguments(args.generator_arguments_file)
rc = generate_XML(generator_args)
return rc
if __name__ == '__main__':
sys.exit(main())
@@ -0,0 +1,26 @@
#!/usr/bin/env python3
import os
import sys
import argparse
import xml.etree.ElementTree
sys.path.append(os.path.join(os.path.dirname(os.path.realpath(__file__)),'..'))
from uros_agent import *
def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description='Import default xml files',
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument(
'--default-xml-path',
required=True,
help='The location of the default profiles')
args = parser.parse_args(argv)
ReadDefaultXMLs(args.default_xml_path)
return 0
if __name__ == '__main__':
sys.exit(main())
+32
View File
@@ -0,0 +1,32 @@
<?xml version="1.0"?>
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>uros_agent</name>
<version>0.0.2</version>
<description>DDS-XCRE agent implementation </description>
<maintainer email="javiermoreno@eprosima.com">Javier Moreno</maintainer>
<license>Apache License 2.0</license>
<buildtool_depend>ament_cmake</buildtool_depend>
<buildtool_export_depend>ament_cmake</buildtool_export_depend>
<exec_depend>rosidl_parser</exec_depend>
<depend>fastcdr</depend>
<depend>fastrtps</depend>
<depend>microxrcedds_agent</depend>
<depend>rosidl_cmake</depend>
<test_depend>ament_lint_auto</test_depend>
<test_depend>ament_lint_common</test_depend>
<group_depend>rosidl_interface_packages</group_depend>
<export>
<build_type>ament_cmake</build_type>
</export>
</package>
+39
View File
@@ -0,0 +1,39 @@
<participant profile_name="participant_profile">
<rtps>
<builtin>
<leaseDuration>
<durationbyname>INFINITE</durationbyname>
</leaseDuration>
<domainId>0</domainId>
</builtin>
<name>DataReader_participant_subscriber</name>
</rtps>
</participant>
<publisher profile_name="publisher_profile">
<topic>
<kind>WITH_KEY</kind>
<name>Square</name>
<dataType>ShapeType</dataType>
<historyQos>
<kind>KEEP_LAST</kind>
<depth>5</depth>
</historyQos>
<durability>
<kind>TRANSIENT_LOCAL</kind>
</durability>
</topic>
</publisher>
<subscriber profile_name="subscriber_profile">
<topic>
<kind>WITH_KEY</kind>
<name>Square</name>
<dataType>ShapeType</dataType>
<historyQos>
<kind>KEEP_LAST</kind>
<depth>5</depth>
</historyQos>
<durability>
<kind>TRANSIENT_LOCAL</kind>
</durability>
</topic>
</subscriber>
+225
View File
@@ -0,0 +1,225 @@
# Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import os
import sys
import xml.etree.ElementTree
from rosidl_cmake import convert_camel_case_to_lower_case_underscore
from rosidl_cmake import expand_template
from rosidl_cmake import extract_message_types
from rosidl_cmake import get_newest_modification_time
from rosidl_parser import parse_message_file
from rosidl_parser import parse_service_file
from rosidl_parser import validate_field_types
def GetPackage(Dir):
# ignore?
for f in os.listdir(Dir):
full_path = os.path.join(Dir, f)
if os.path.isfile(full_path):
if f == "COLCON_IGNORE":
return "COLCON_IGNORE"
# found package
found_package_path = ""
for f in os.listdir(Dir):
if f == "package.xml":
found_package_path = os.path.join(Dir, f)
found_package_path = os.path.abspath(found_package_path)
break
return found_package_path
def GetPackageList(Dir):
package_list = []
package_path = GetPackage(Dir)
if package_path == "":
for f in os.listdir(Dir):
full_path = os.path.join(Dir, f)
if os.path.isdir(full_path):
for l in GetPackageList(full_path):
package_list.append(l)
elif package_path != "COLCON_IGNORE":
package_list.append(package_path)
return package_list
def GetInterfacePackages(packages_list):
package_interface_list = []
for package in packages_list:
xml_root = xml.etree.ElementTree.parse(package).getroot()
for element in xml_root.findall('member_of_group'):
if element.text == "rosidl_interface_packages":
package_interface_list.append(package)
return package_interface_list
def GetPackageName(package_path):
xml_root = xml.etree.ElementTree.parse(package_path).getroot()
xml_name_elements = xml_root.findall('name')
if len(xml_name_elements) != 1:
return ""
else:
return xml_name_elements[0].text
def GetInterfacePackageMsgs(package_path):
msg_list = []
package_dir = os.path.dirname(package_path)
for root, dirs, files in os.walk(package_dir):
for file in files:
if file.endswith(".msg"):
full_path = os.path.join(root, file)
msg_list.append(full_path)
return msg_list
def GetInterfacePackageSrvs(package_path):
msg_list = []
package_dir = os.path.dirname(package_path)
for root, dirs, files in os.walk(package_dir):
for file in files:
if file.endswith(".srv"):
full_path = os.path.join(root, file)
msg_list.append(full_path)
return msg_list
def ReadDefaultXMLs(Path):
for f in os.listdir(Path):
full_path = os.path.join(Path, f)
if os.path.isfile(full_path) and f.endswith(".xml"):
#xml_root = xml.etree.ElementTree.parse(full_path).getroot()
#if xml_root.iselement():
fd = open(full_path)
print ("%s" % fd.read())
fd.close()
def generate_XML(args):
pkg_name = args['package_name']
#known_msg_types = extract_message_types(
# pkg_name, args['ros_interface_files'], args.get('ros_interface_dependencies', []))
functions = {
'get_header_filename_from_msg_name': convert_camel_case_to_lower_case_underscore,
}
# Set file format
ros2_prefix = "rt/"
# Check destination dir
dest_dir = args['output_dir']
if not os.path.exists(dest_dir):
os.makedirs(dest_dir)
# Check source dir
srcs_dir = os.path.join(dest_dir, "srcs")
if not os.path.exists(srcs_dir):
os.makedirs(srcs_dir)
# Iterate throw all msgs/srvs
for idl_file in args['ros_interface_files']:
extension = os.path.splitext(idl_file)[1]
if extension == '.msg':
spec = parse_message_file(pkg_name, idl_file)
#validate_field_types(spec, known_msg_types)
subfolder = os.path.basename(os.path.dirname(idl_file))
data = {
'spec': spec,
'pkg': spec.base_type.pkg_name,
'msg': spec.msg_name,
'type': spec.base_type.type,
'subfolder': subfolder,
}
data.update(functions)
# Generate source file path
src_file = os.path.join(srcs_dir, "%s_%s_%s.xml" % (spec.base_type.pkg_name, subfolder, spec.msg_name))
# Publisher
file_content = " <publisher profile_name=\"%s_%s_%s_p\">\n" % (spec.base_type.pkg_name, subfolder, spec.msg_name)
file_content += " <topic profile_name=\"%s_%s_%s_t\">\n" % (spec.base_type.pkg_name, subfolder, spec.msg_name)
file_content += " <kind>NO_KEY</kind>\n"
file_content += " <name>%s%s_%s_%s</name>\n" % (ros2_prefix, spec.base_type.pkg_name, subfolder, spec.msg_name)
file_content += " <dataType>%s::%s::dds_::%s_</dataType>\n" % (spec.base_type.pkg_name, subfolder, spec.msg_name)
file_content += " <historyQos>\n"
file_content += " <kind>KEEP_LAST</kind>\n"
file_content += " <depth>5</depth>\n"
file_content += " </historyQos>\n"
file_content += " <durability>\n"
file_content += " <kind>TRANSIENT_LOCAL</kind>\n"
file_content += " </durability>\n"
file_content += " </topic>\n"
file_content += " </publisher>\n"
# Subscriber
file_content += " <subscriber profile_name=\"%s_%s_%s_s\">\n" % (spec.base_type.pkg_name, subfolder, spec.msg_name)
file_content += " <topic profile_name=\"%s_%s_%s_t\">\n" % (spec.base_type.pkg_name, subfolder, spec.msg_name)
file_content += " <kind>NO_KEY</kind>\n"
file_content += " <name>%s%s_%s_%s</name>\n" % (ros2_prefix, spec.base_type.pkg_name, subfolder, spec.msg_name)
file_content += " <dataType>%s::%s::dds_::%s_</dataType>\n" % (spec.base_type.pkg_name, subfolder, spec.msg_name)
file_content += " <historyQos>\n"
file_content += " <kind>KEEP_LAST</kind>\n"
file_content += " <depth>5</depth>\n"
file_content += " </historyQos>\n"
file_content += " <durability>\n"
file_content += " <kind>TRANSIENT_LOCAL</kind>\n"
file_content += " </durability>\n"
file_content += " </topic>\n"
file_content += " </subscriber>\n"
# Topic
file_content += " <topic profile_name=\"%s_%s_%s_t\">\n" % (spec.base_type.pkg_name, subfolder, spec.msg_name)
file_content += " <name>%s%s_%s_%s</name>\n" % (ros2_prefix, spec.base_type.pkg_name, subfolder, spec.msg_name)
file_content += " <dataType>%s::%s::dds_::%s_</dataType>\n" % (spec.base_type.pkg_name, subfolder, spec.msg_name)
file_content += " </topic>\n"
# Write file content
print ("%s" % file_content)
#elif extension == '.srv':
#data = {'spec': spec}
#data.update(functions)
#if not os.path.exists(args['output_dir']):
# os.makedirs(args['output_dir'])
#f = open(os.path.join(args['output_dir'], 'demofile.txt'), 'w+')
#f.write("%s\n" % spec)
#f.close()
return 0