OpenSMI-ROS2 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (346) hide show
  1. opensmi_ros2-0.1.0/.gitattributes +14 -0
  2. opensmi_ros2-0.1.0/.github/workflows/api-docs.yml +43 -0
  3. opensmi_ros2-0.1.0/.github/workflows/checks.yml +132 -0
  4. opensmi_ros2-0.1.0/.github/workflows/examples.yml +109 -0
  5. opensmi_ros2-0.1.0/.github/workflows/opensmi-main.yml +39 -0
  6. opensmi_ros2-0.1.0/.github/workflows/python-publish.yml +58 -0
  7. opensmi_ros2-0.1.0/.gitignore +40 -0
  8. opensmi_ros2-0.1.0/.pre-commit-config.yaml +17 -0
  9. opensmi_ros2-0.1.0/CONTRIBUTING.md +86 -0
  10. opensmi_ros2-0.1.0/LICENSE +18 -0
  11. opensmi_ros2-0.1.0/LICENSES/Apache-2.0.txt +73 -0
  12. opensmi_ros2-0.1.0/LICENSES/BSD-3-Clause.txt +11 -0
  13. opensmi_ros2-0.1.0/LICENSES/MIT.txt +18 -0
  14. opensmi_ros2-0.1.0/PKG-INFO +183 -0
  15. opensmi_ros2-0.1.0/README.md +154 -0
  16. opensmi_ros2-0.1.0/REUSE.toml +54 -0
  17. opensmi_ros2-0.1.0/SECURITY.md +18 -0
  18. opensmi_ros2-0.1.0/catalog/README.md +66 -0
  19. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/msg/DebugLevel.msg +11 -0
  20. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/msg/DeviceInfo.msg +11 -0
  21. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/msg/RobotMode.msg +10 -0
  22. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/msg/RobotStatus.msg +35 -0
  23. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/msg/ServiceReturnCode.msg +8 -0
  24. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/msg/TriState.msg +23 -0
  25. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/srv/CmdJointTrajectory.srv +9 -0
  26. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/srv/GetRobotInfo.srv +7 -0
  27. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/srv/SetDrivePower.srv +7 -0
  28. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/srv/SetRemoteLoggerLevel.srv +8 -0
  29. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/srv/StartMotion.srv +3 -0
  30. opensmi_ros2-0.1.0/catalog/packages/industrial_msgs/srv/StopMotion.srv +5 -0
  31. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/msg/AlarmCauseRemedy.msg +10 -0
  32. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/msg/AlarmInfo.msg +36 -0
  33. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/msg/ErrorInfo.msg +27 -0
  34. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/msg/InformJobCrudResultCodes.msg +22 -0
  35. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/msg/InitTrajEnum.msg +65 -0
  36. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/msg/IoResultCodes.msg +30 -0
  37. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/msg/MotionReadyEnum.msg +73 -0
  38. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/msg/QueueResultEnum.msg +26 -0
  39. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/msg/SelectionResultCodes.msg +28 -0
  40. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/GetActiveAlarmInfo.srv +30 -0
  41. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/ListInformJobs.srv +28 -0
  42. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/QueueTrajPoint.srv +22 -0
  43. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/ReadGroupIO.srv +27 -0
  44. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/ReadMRegister.srv +31 -0
  45. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/ReadSingleIO.srv +23 -0
  46. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/ResetError.srv +21 -0
  47. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/SelectMotionTool.srv +126 -0
  48. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/StartPointQueueMode.srv +25 -0
  49. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/StartTrajMode.srv +25 -0
  50. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/WriteGroupIO.srv +29 -0
  51. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/WriteMRegister.srv +31 -0
  52. opensmi_ros2-0.1.0/catalog/packages/motoros2_interfaces/srv/WriteSingleIO.srv +27 -0
  53. opensmi_ros2-0.1.0/catalog/packages/neo_msgs2/msg/EmergencyStopState.msg +15 -0
  54. opensmi_ros2-0.1.0/catalog/packages/neo_msgs2/msg/IOBoard.msg +10 -0
  55. opensmi_ros2-0.1.0/catalog/packages/neo_msgs2/msg/Keypad.msg +4 -0
  56. opensmi_ros2-0.1.0/catalog/packages/neo_msgs2/msg/KinematicsState.msg +6 -0
  57. opensmi_ros2-0.1.0/catalog/packages/neo_msgs2/msg/LCDOutput.msg +5 -0
  58. opensmi_ros2-0.1.0/catalog/packages/neo_msgs2/msg/RelayBoardV2.msg +68 -0
  59. opensmi_ros2-0.1.0/catalog/packages/neo_msgs2/msg/RelayBoardV3.msg +22 -0
  60. opensmi_ros2-0.1.0/catalog/packages/neo_msgs2/msg/SafetyMode.msg +11 -0
  61. opensmi_ros2-0.1.0/catalog/packages/neo_msgs2/msg/SafetyState.msg +6 -0
  62. opensmi_ros2-0.1.0/catalog/packages/neo_msgs2/msg/USBoard.msg +6 -0
  63. opensmi_ros2-0.1.0/catalog/packages/neo_msgs2/msg/USBoardV2.msg +9 -0
  64. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/IOBoardSetDigOut.srv +4 -0
  65. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/InitializeContourMatching.srv +3 -0
  66. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/LockPlatform.srv +2 -0
  67. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/Optimizer.srv +8 -0
  68. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/RelayBoardSetEMStop.srv +2 -0
  69. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/RelayBoardSetLCDMsg.srv +3 -0
  70. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/RelayBoardSetLED.srv +3 -0
  71. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/RelayBoardSetRelay.srv +4 -0
  72. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/RelayBoardSetSafetyMode.srv +4 -0
  73. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/RelayBoardUnSetEMStop.srv +2 -0
  74. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/ResetOmniWheels.srv +3 -0
  75. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/SetSafetyField.srv +3 -0
  76. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/USBoardToggleSensor.srv +3 -0
  77. opensmi_ros2-0.1.0/catalog/packages/neo_srvs2/srv/UnlockPlatform.srv +2 -0
  78. opensmi_ros2-0.1.0/catalog/sources.toml +164 -0
  79. opensmi_ros2-0.1.0/cliff.toml +52 -0
  80. opensmi_ros2-0.1.0/constraints.txt +9 -0
  81. opensmi_ros2-0.1.0/docs/README.md +27 -0
  82. opensmi_ros2-0.1.0/docs/architecture.md +47 -0
  83. opensmi_ros2-0.1.0/docs/assets/architecture.png +0 -0
  84. opensmi_ros2-0.1.0/docs/assets/overview.svg +57 -0
  85. opensmi_ros2-0.1.0/docs/bindings.md +899 -0
  86. opensmi_ros2-0.1.0/docs/browse-paths.md +44 -0
  87. opensmi_ros2-0.1.0/docs/client-quickstart.md +179 -0
  88. opensmi_ros2-0.1.0/docs/configuration.md +64 -0
  89. opensmi_ros2-0.1.0/docs/deployment.md +37 -0
  90. opensmi_ros2-0.1.0/docs/getting-started.md +116 -0
  91. opensmi_ros2-0.1.0/docs/migration.md +7 -0
  92. opensmi_ros2-0.1.0/docs/publishing-bindings.md +49 -0
  93. opensmi_ros2-0.1.0/docs/python-api.md +61 -0
  94. opensmi_ros2-0.1.0/docs/testing.md +24 -0
  95. opensmi_ros2-0.1.0/examples/README.md +43 -0
  96. opensmi_ros2-0.1.0/examples/__init__.py +13 -0
  97. opensmi_ros2-0.1.0/examples/client/machine.toml +60 -0
  98. opensmi_ros2-0.1.0/examples/client/quickstart.py +373 -0
  99. opensmi_ros2-0.1.0/examples/component.py +131 -0
  100. opensmi_ros2-0.1.0/examples/machine.py +34 -0
  101. opensmi_ros2-0.1.0/examples/machine.toml +103 -0
  102. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/.gitignore +6 -0
  103. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/Dockerfile +43 -0
  104. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/Dockerfile.dockerignore +15 -0
  105. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/README.md +204 -0
  106. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ci.sh +55 -0
  107. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/compose.yaml +100 -0
  108. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/docker/entrypoint.sh +12 -0
  109. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/docker/install.sh +99 -0
  110. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/docker/port_hc10.py +121 -0
  111. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/machine.toml +127 -0
  112. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/media/hc10-pick-and-place.mp4 +0 -0
  113. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/media/hc10-pick-and-place.mp4.license +3 -0
  114. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/media/hc10-pick-and-place.png +0 -0
  115. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/media/hc10-pick-and-place.png.license +3 -0
  116. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/record/Dockerfile +17 -0
  117. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/record/caption.py +146 -0
  118. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/record/capture.sh +25 -0
  119. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/record/gui.config +45 -0
  120. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/record.sh +48 -0
  121. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_description/CMakeLists.txt +9 -0
  122. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_description/config/ros2_controllers.yaml +56 -0
  123. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_description/launch/sim.launch.py +82 -0
  124. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_description/package.xml +31 -0
  125. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_description/urdf/hc10_robotiq.urdf.xacro +113 -0
  126. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_description/worlds/pick_place.sdf +99 -0
  127. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_moveit_config/CMakeLists.txt +9 -0
  128. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_moveit_config/config/hc10_robotiq.srdf +111 -0
  129. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_moveit_config/config/joint_limits.yaml +47 -0
  130. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_moveit_config/config/kinematics.yaml +8 -0
  131. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_moveit_config/config/moveit_controllers.yaml +28 -0
  132. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_moveit_config/config/pilz_cartesian_limits.yaml +11 -0
  133. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_moveit_config/launch/bringup.launch.py +47 -0
  134. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/ros2_ws/src/hc10_robotiq_moveit_config/package.xml +26 -0
  135. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/run.sh +29 -0
  136. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/scenario.py +831 -0
  137. opensmi_ros2-0.1.0/examples/moveit-hc10-robotiq/server.toml +9 -0
  138. opensmi_ros2-0.1.0/examples/nav2-rox-argo/.gitignore +11 -0
  139. opensmi_ros2-0.1.0/examples/nav2-rox-argo/Dockerfile +50 -0
  140. opensmi_ros2-0.1.0/examples/nav2-rox-argo/Dockerfile.dockerignore +15 -0
  141. opensmi_ros2-0.1.0/examples/nav2-rox-argo/README.md +174 -0
  142. opensmi_ros2-0.1.0/examples/nav2-rox-argo/ci.sh +83 -0
  143. opensmi_ros2-0.1.0/examples/nav2-rox-argo/compose.yaml +111 -0
  144. opensmi_ros2-0.1.0/examples/nav2-rox-argo/entrypoint.sh +15 -0
  145. opensmi_ros2-0.1.0/examples/nav2-rox-argo/install.sh +109 -0
  146. opensmi_ros2-0.1.0/examples/nav2-rox-argo/machine.toml +104 -0
  147. opensmi_ros2-0.1.0/examples/nav2-rox-argo/make_map.py +81 -0
  148. opensmi_ros2-0.1.0/examples/nav2-rox-argo/media/rox-argo-poster.png +0 -0
  149. opensmi_ros2-0.1.0/examples/nav2-rox-argo/media/rox-argo-poster.png.license +3 -0
  150. opensmi_ros2-0.1.0/examples/nav2-rox-argo/media/rox-argo.mp4 +0 -0
  151. opensmi_ros2-0.1.0/examples/nav2-rox-argo/media/rox-argo.mp4.license +3 -0
  152. opensmi_ros2-0.1.0/examples/nav2-rox-argo/record.sh +73 -0
  153. opensmi_ros2-0.1.0/examples/nav2-rox-argo/recording/gui.config +48 -0
  154. opensmi_ros2-0.1.0/examples/nav2-rox-argo/recording/make_video.py +179 -0
  155. opensmi_ros2-0.1.0/examples/nav2-rox-argo/recording/recorder.sh +26 -0
  156. opensmi_ros2-0.1.0/examples/nav2-rox-argo/run.sh +55 -0
  157. opensmi_ros2-0.1.0/examples/nav2-rox-argo/scenario.py +724 -0
  158. opensmi_ros2-0.1.0/examples/nav2-rox-argo/server.toml +11 -0
  159. opensmi_ros2-0.1.0/examples/nav2-rox-argo/sim_diagnostics.py +127 -0
  160. opensmi_ros2-0.1.0/examples/nav2-rox-argo/simulation_launch.py +58 -0
  161. opensmi_ros2-0.1.0/examples/nav2-rox-argo/world.sdf +129 -0
  162. opensmi_ros2-0.1.0/examples/ros2.toml +9 -0
  163. opensmi_ros2-0.1.0/examples/run_server.py +52 -0
  164. opensmi_ros2-0.1.0/pyproject.toml +169 -0
  165. opensmi_ros2-0.1.0/setup.cfg +4 -0
  166. opensmi_ros2-0.1.0/src/OpenSMI_ROS2.egg-info/PKG-INFO +183 -0
  167. opensmi_ros2-0.1.0/src/OpenSMI_ROS2.egg-info/SOURCES.txt +344 -0
  168. opensmi_ros2-0.1.0/src/OpenSMI_ROS2.egg-info/dependency_links.txt +1 -0
  169. opensmi_ros2-0.1.0/src/OpenSMI_ROS2.egg-info/entry_points.txt +2 -0
  170. opensmi_ros2-0.1.0/src/OpenSMI_ROS2.egg-info/requires.txt +5 -0
  171. opensmi_ros2-0.1.0/src/OpenSMI_ROS2.egg-info/scm_file_list.json +340 -0
  172. opensmi_ros2-0.1.0/src/OpenSMI_ROS2.egg-info/scm_version.json +8 -0
  173. opensmi_ros2-0.1.0/src/OpenSMI_ROS2.egg-info/top_level.txt +1 -0
  174. opensmi_ros2-0.1.0/src/opensmi/ros2/__init__.py +89 -0
  175. opensmi_ros2-0.1.0/src/opensmi/ros2/__main__.py +11 -0
  176. opensmi_ros2-0.1.0/src/opensmi/ros2/cli.py +143 -0
  177. opensmi_ros2-0.1.0/src/opensmi/ros2/py.typed +0 -0
  178. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/__init__.py +67 -0
  179. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/_decode.py +101 -0
  180. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/_encode.py +102 -0
  181. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/_parser.py +147 -0
  182. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/errors.py +141 -0
  183. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/goal.py +232 -0
  184. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/graph.py +288 -0
  185. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/guard.py +213 -0
  186. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/interface.py +140 -0
  187. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/messages/__init__.py +503 -0
  188. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/messages/industrial_msgs.py +62 -0
  189. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/messages/industrial_msgs.pyi +159 -0
  190. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/messages/motoros2_interfaces.py +79 -0
  191. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/messages/motoros2_interfaces.pyi +307 -0
  192. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/messages/neo_msgs2.py +55 -0
  193. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/messages/neo_msgs2.pyi +138 -0
  194. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/messages/neo_srvs2.py +72 -0
  195. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/messages/neo_srvs2.pyi +224 -0
  196. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/outcomes.py +103 -0
  197. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/parameters.py +723 -0
  198. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/publisher.py +125 -0
  199. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/qos.py +394 -0
  200. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/runtime.py +1171 -0
  201. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/selection.py +150 -0
  202. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/stamp.py +100 -0
  203. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/subscription.py +354 -0
  204. opensmi_ros2-0.1.0/src/opensmi/ros2/runtime/tf.py +714 -0
  205. opensmi_ros2-0.1.0/src/opensmi/ros2/server/__init__.py +148 -0
  206. opensmi_ros2-0.1.0/src/opensmi/ros2/server/access.py +109 -0
  207. opensmi_ros2-0.1.0/src/opensmi/ros2/server/bindings/__init__.py +92 -0
  208. opensmi_ros2-0.1.0/src/opensmi/ros2/server/bindings/_base.py +154 -0
  209. opensmi_ros2-0.1.0/src/opensmi/ros2/server/bindings/action.py +133 -0
  210. opensmi_ros2-0.1.0/src/opensmi/ros2/server/bindings/keyed.py +127 -0
  211. opensmi_ros2-0.1.0/src/opensmi/ros2/server/bindings/lifecycle.py +131 -0
  212. opensmi_ros2-0.1.0/src/opensmi/ros2/server/bindings/method.py +130 -0
  213. opensmi_ros2-0.1.0/src/opensmi/ros2/server/bindings/monitoring.py +109 -0
  214. opensmi_ros2-0.1.0/src/opensmi/ros2/server/bindings/parameter.py +133 -0
  215. opensmi_ros2-0.1.0/src/opensmi/ros2/server/bindings/publisher.py +192 -0
  216. opensmi_ros2-0.1.0/src/opensmi/ros2/server/bindings/registry.py +95 -0
  217. opensmi_ros2-0.1.0/src/opensmi/ros2/server/bindings/tf.py +256 -0
  218. opensmi_ros2-0.1.0/src/opensmi/ros2/server/browse_names.py +94 -0
  219. opensmi_ros2-0.1.0/src/opensmi/ros2/server/component.py +334 -0
  220. opensmi_ros2-0.1.0/src/opensmi/ros2/server/config.py +493 -0
  221. opensmi_ros2-0.1.0/src/opensmi/ros2/server/containers.py +191 -0
  222. opensmi_ros2-0.1.0/src/opensmi/ros2/server/drivers.py +421 -0
  223. opensmi_ros2-0.1.0/src/opensmi/ros2/server/errors.py +159 -0
  224. opensmi_ros2-0.1.0/src/opensmi/ros2/server/events.py +406 -0
  225. opensmi_ros2-0.1.0/src/opensmi/ros2/server/introspection.py +850 -0
  226. opensmi_ros2-0.1.0/src/opensmi/ros2/server/keyed.py +749 -0
  227. opensmi_ros2-0.1.0/src/opensmi/ros2/server/lifecycle.py +238 -0
  228. opensmi_ros2-0.1.0/src/opensmi/ros2/server/limits.py +66 -0
  229. opensmi_ros2-0.1.0/src/opensmi/ros2/server/loader.py +977 -0
  230. opensmi_ros2-0.1.0/src/opensmi/ros2/server/machine.py +225 -0
  231. opensmi_ros2-0.1.0/src/opensmi/ros2/server/method.py +307 -0
  232. opensmi_ros2-0.1.0/src/opensmi/ros2/server/mirror.py +582 -0
  233. opensmi_ros2-0.1.0/src/opensmi/ros2/server/mutation.py +992 -0
  234. opensmi_ros2-0.1.0/src/opensmi/ros2/server/nodesets/Opc.Ua.SmartFactory.ROS2.NodeSet2.xml +85 -0
  235. opensmi_ros2-0.1.0/src/opensmi/ros2/server/nodesets/__init__.py +18 -0
  236. opensmi_ros2-0.1.0/src/opensmi/ros2/server/nodesets/smart_factory_ros2.py +26 -0
  237. opensmi_ros2-0.1.0/src/opensmi/ros2/server/parameters.py +704 -0
  238. opensmi_ros2-0.1.0/src/opensmi/ros2/server/projection.py +1176 -0
  239. opensmi_ros2-0.1.0/src/opensmi/ros2/server/projections/__init__.py +41 -0
  240. opensmi_ros2-0.1.0/src/opensmi/ros2/server/projections/scope.py +222 -0
  241. opensmi_ros2-0.1.0/src/opensmi/ros2/server/provenance.py +121 -0
  242. opensmi_ros2-0.1.0/src/opensmi/ros2/server/publisher.py +781 -0
  243. opensmi_ros2-0.1.0/src/opensmi/ros2/server/recipes.py +514 -0
  244. opensmi_ros2-0.1.0/src/opensmi/ros2/server/required.py +633 -0
  245. opensmi_ros2-0.1.0/src/opensmi/ros2/server/skill.py +363 -0
  246. opensmi_ros2-0.1.0/src/opensmi/ros2/server/spatial.py +283 -0
  247. opensmi_ros2-0.1.0/src/opensmi/ros2/server/startup.py +626 -0
  248. opensmi_ros2-0.1.0/src/opensmi/ros2/server/status.py +107 -0
  249. opensmi_ros2-0.1.0/src/opensmi/ros2/server/structures.py +135 -0
  250. opensmi_ros2-0.1.0/src/opensmi/ros2/server/transforms/__init__.py +39 -0
  251. opensmi_ros2-0.1.0/src/opensmi/ros2/server/transforms/conversions.py +58 -0
  252. opensmi_ros2-0.1.0/src/opensmi/ros2/server/transforms/filing.py +340 -0
  253. opensmi_ros2-0.1.0/src/opensmi/ros2/server/transforms/mirror.py +462 -0
  254. opensmi_ros2-0.1.0/src/opensmi/ros2/server/transforms/outward.py +180 -0
  255. opensmi_ros2-0.1.0/src/opensmi/ros2/server/transforms/records.py +195 -0
  256. opensmi_ros2-0.1.0/src/opensmi/ros2/server/transforms/spatial.py +154 -0
  257. opensmi_ros2-0.1.0/tests/fake_runtime.py +781 -0
  258. opensmi_ros2-0.1.0/tests/fixture_broken.py +10 -0
  259. opensmi_ros2-0.1.0/tests/fixture_custom.py +82 -0
  260. opensmi_ros2-0.1.0/tests/fixture_example.py +105 -0
  261. opensmi_ros2-0.1.0/tests/fixture_lifecycle.py +207 -0
  262. opensmi_ros2-0.1.0/tests/fixture_messages.py +473 -0
  263. opensmi_ros2-0.1.0/tests/fixture_motion.py +237 -0
  264. opensmi_ros2-0.1.0/tests/fixture_structures.py +62 -0
  265. opensmi_ros2-0.1.0/tests/fixture_unimported.py +15 -0
  266. opensmi_ros2-0.1.0/tests/served.py +222 -0
  267. opensmi_ros2-0.1.0/tests/test_action_binding_server.py +1191 -0
  268. opensmi_ros2-0.1.0/tests/test_binding_events_server.py +340 -0
  269. opensmi_ros2-0.1.0/tests/test_binding_modules.py +97 -0
  270. opensmi_ros2-0.1.0/tests/test_binding_status.py +112 -0
  271. opensmi_ros2-0.1.0/tests/test_bindings.py +992 -0
  272. opensmi_ros2-0.1.0/tests/test_browse_names.py +71 -0
  273. opensmi_ros2-0.1.0/tests/test_cli.py +365 -0
  274. opensmi_ros2-0.1.0/tests/test_client_quickstart.py +317 -0
  275. opensmi_ros2-0.1.0/tests/test_config.py +249 -0
  276. opensmi_ros2-0.1.0/tests/test_datatype_valuerank_spike.py +272 -0
  277. opensmi_ros2-0.1.0/tests/test_docs_binding_examples.py +191 -0
  278. opensmi_ros2-0.1.0/tests/test_example_hc10_machine.py +21 -0
  279. opensmi_ros2-0.1.0/tests/test_examples.py +345 -0
  280. opensmi_ros2-0.1.0/tests/test_fake_runtime.py +111 -0
  281. opensmi_ros2-0.1.0/tests/test_field_selection.py +114 -0
  282. opensmi_ros2-0.1.0/tests/test_goals.py +219 -0
  283. opensmi_ros2-0.1.0/tests/test_graph.py +237 -0
  284. opensmi_ros2-0.1.0/tests/test_guard.py +137 -0
  285. opensmi_ros2-0.1.0/tests/test_import_boundary.py +210 -0
  286. opensmi_ros2-0.1.0/tests/test_introspection.py +265 -0
  287. opensmi_ros2-0.1.0/tests/test_introspection_server.py +862 -0
  288. opensmi_ros2-0.1.0/tests/test_jazzy_environment.py +22 -0
  289. opensmi_ros2-0.1.0/tests/test_keyed.py +134 -0
  290. opensmi_ros2-0.1.0/tests/test_keyed_binding_server.py +970 -0
  291. opensmi_ros2-0.1.0/tests/test_level_datatypes.py +228 -0
  292. opensmi_ros2-0.1.0/tests/test_lifecycle.py +142 -0
  293. opensmi_ros2-0.1.0/tests/test_lifecycle_binding_server.py +688 -0
  294. opensmi_ros2-0.1.0/tests/test_lifecycle_drivers.py +390 -0
  295. opensmi_ros2-0.1.0/tests/test_loader.py +466 -0
  296. opensmi_ros2-0.1.0/tests/test_loader_classes.py +384 -0
  297. opensmi_ros2-0.1.0/tests/test_loader_projections.py +487 -0
  298. opensmi_ros2-0.1.0/tests/test_message_dataclasses.py +192 -0
  299. opensmi_ros2-0.1.0/tests/test_message_types.py +88 -0
  300. opensmi_ros2-0.1.0/tests/test_method_binding_server.py +824 -0
  301. opensmi_ros2-0.1.0/tests/test_monitoring_binding_server.py +742 -0
  302. opensmi_ros2-0.1.0/tests/test_mutation_server.py +620 -0
  303. opensmi_ros2-0.1.0/tests/test_nested_rendering_server.py +208 -0
  304. opensmi_ros2-0.1.0/tests/test_nested_variable_cost.py +346 -0
  305. opensmi_ros2-0.1.0/tests/test_node_paths.py +149 -0
  306. opensmi_ros2-0.1.0/tests/test_parameter_binding_server.py +1001 -0
  307. opensmi_ros2-0.1.0/tests/test_parameters.py +784 -0
  308. opensmi_ros2-0.1.0/tests/test_plan_variable_server.py +107 -0
  309. opensmi_ros2-0.1.0/tests/test_projection.py +464 -0
  310. opensmi_ros2-0.1.0/tests/test_projection_scope.py +134 -0
  311. opensmi_ros2-0.1.0/tests/test_projection_server.py +353 -0
  312. opensmi_ros2-0.1.0/tests/test_public_driver_types.py +151 -0
  313. opensmi_ros2-0.1.0/tests/test_public_surface.py +215 -0
  314. opensmi_ros2-0.1.0/tests/test_publisher.py +153 -0
  315. opensmi_ros2-0.1.0/tests/test_publisher_binding_server.py +1493 -0
  316. opensmi_ros2-0.1.0/tests/test_qos.py +363 -0
  317. opensmi_ros2-0.1.0/tests/test_qos_binding_server.py +444 -0
  318. opensmi_ros2-0.1.0/tests/test_recipes.py +457 -0
  319. opensmi_ros2-0.1.0/tests/test_required.py +207 -0
  320. opensmi_ros2-0.1.0/tests/test_required_binding_server.py +730 -0
  321. opensmi_ros2-0.1.0/tests/test_rox_argo_example.py +78 -0
  322. opensmi_ros2-0.1.0/tests/test_runtime_jazzy.py +1508 -0
  323. opensmi_ros2-0.1.0/tests/test_runtime_seam.py +162 -0
  324. opensmi_ros2-0.1.0/tests/test_spatial.py +281 -0
  325. opensmi_ros2-0.1.0/tests/test_stamp.py +87 -0
  326. opensmi_ros2-0.1.0/tests/test_structure_projection_server.py +290 -0
  327. opensmi_ros2-0.1.0/tests/test_structure_variables_server.py +310 -0
  328. opensmi_ros2-0.1.0/tests/test_structured_skills_methods.py +771 -0
  329. opensmi_ros2-0.1.0/tests/test_structured_skills_methods_jazzy.py +226 -0
  330. opensmi_ros2-0.1.0/tests/test_structures.py +125 -0
  331. opensmi_ros2-0.1.0/tests/test_structures_server.py +200 -0
  332. opensmi_ros2-0.1.0/tests/test_subscription.py +193 -0
  333. opensmi_ros2-0.1.0/tests/test_tf.py +472 -0
  334. opensmi_ros2-0.1.0/tests/test_tf_binding_server.py +1509 -0
  335. opensmi_ros2-0.1.0/tests/wire_client.py +101 -0
  336. opensmi_ros2-0.1.0/tools/catalog/__init__.py +28 -0
  337. opensmi_ros2-0.1.0/tools/catalog/_vendor/__init__.py +18 -0
  338. opensmi_ros2-0.1.0/tools/catalog/_vendor/rosidl_adapter_parser.py +912 -0
  339. opensmi_ros2-0.1.0/tools/catalog/definitions.py +267 -0
  340. opensmi_ros2-0.1.0/tools/catalog/extraction.py +158 -0
  341. opensmi_ros2-0.1.0/tools/catalog/hashes.py +233 -0
  342. opensmi_ros2-0.1.0/tools/catalog/membership.py +97 -0
  343. opensmi_ros2-0.1.0/tools/catalog/sources.py +204 -0
  344. opensmi_ros2-0.1.0/tools/catalog/stubs.py +271 -0
  345. opensmi_ros2-0.1.0/tools/catalog_check.py +100 -0
  346. opensmi_ros2-0.1.0/tools/catalog_sync.py +89 -0
@@ -0,0 +1,14 @@
1
+ # SPDX-FileCopyrightText: 2026 Technologie-Initiative SmartFactory KL e.V.
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ # Text files are stored with LF and checked out with LF on every platform, so a Windows editor
6
+ # cannot turn a file into CRLF and bury a small change in a whole-file diff.
7
+ * text=auto eol=lf
8
+
9
+ # Vendored third-party text is stored and checked out exactly as upstream wrote it. Without this
10
+ # a Windows clone would rewrite every line ending, and `tools/catalog_check.py` -- which asserts
11
+ # that what is carried here is byte-identical to what its pinned commit produces -- would fail on
12
+ # a difference nobody introduced.
13
+ catalog/packages/** -text
14
+ tools/catalog/_vendor/*.py -text
@@ -0,0 +1,43 @@
1
+ # SPDX-FileCopyrightText: 2026 Technologie-Initiative SmartFactory KL e.V.
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ # Builds the API reference from the docstrings with pydoctor (configured in pyproject.toml) and
6
+ # publishes it to GitHub Pages. Enable Pages with the source "GitHub Actions" in the repository settings.
7
+
8
+ name: Publish API doc to Pages
9
+
10
+ on:
11
+ push:
12
+ branches: [main]
13
+ workflow_dispatch:
14
+
15
+ permissions:
16
+ contents: read
17
+ pages: write
18
+ id-token: write
19
+
20
+ # One deployment at a time; a running deployment is allowed to finish.
21
+ concurrency:
22
+ group: pages
23
+ cancel-in-progress: false
24
+
25
+ jobs:
26
+ deploy:
27
+ runs-on: ubuntu-24.04
28
+ environment:
29
+ name: github-pages
30
+ url: ${{ steps.deployment.outputs.page_url }}
31
+ steps:
32
+ - uses: actions/checkout@v4
33
+ - uses: actions/setup-python@v5
34
+ with:
35
+ python-version: "3.12"
36
+ - run: python -m pip install pydoctor
37
+ - run: pydoctor
38
+ - uses: actions/configure-pages@v5
39
+ - uses: actions/upload-pages-artifact@v3
40
+ with:
41
+ path: ./apidocs
42
+ - id: deployment
43
+ uses: actions/deploy-pages@v4
@@ -0,0 +1,132 @@
1
+ # SPDX-FileCopyrightText: 2026 Technologie-Initiative SmartFactory KL e.V.
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ # The checks of this repository, without hardware: secret scan, lint, types, the definition catalog,
6
+ # the test suite on Python 3.12 and 3.11, and the tests that need a live ROS2 Jazzy graph.
7
+ # python-publish.yml calls this workflow before it publishes, like the other OpenSMI repositories.
8
+
9
+ name: Checks
10
+
11
+ on:
12
+ push:
13
+ branches: [main]
14
+ pull_request:
15
+ workflow_dispatch:
16
+ workflow_call: # lets the publishing workflow reuse this one
17
+
18
+ concurrency:
19
+ group: checks-${{ github.workflow }}-${{ github.ref }}
20
+ cancel-in-progress: ${{ github.event_name == 'pull_request' }}
21
+
22
+ permissions:
23
+ contents: read
24
+
25
+ env:
26
+ PIP_DISABLE_PIP_VERSION_CHECK: "1"
27
+
28
+ jobs:
29
+ secrets:
30
+ name: secrets
31
+ runs-on: ubuntu-24.04
32
+ steps:
33
+ - uses: actions/checkout@v4
34
+ # The scan covers the checked-out files; the history starts clean on GitHub.
35
+ - run: docker run --rm -v "$PWD:/repo" zricethezav/gitleaks:v8.30.1 dir /repo --redact --no-banner --verbose
36
+
37
+ lint:
38
+ name: lint
39
+ runs-on: ubuntu-24.04
40
+ steps:
41
+ - uses: actions/checkout@v4
42
+ with:
43
+ fetch-depth: 0 # setuptools-scm reads the version from the tags
44
+ - uses: actions/setup-python@v5
45
+ with:
46
+ python-version: "3.12"
47
+ cache: pip
48
+ - run: python -m pip install --upgrade pip
49
+ - run: python -m pip install -c constraints.txt -e . --group dev
50
+ - run: ruff check .
51
+ - run: ruff format --check .
52
+ - run: reuse lint
53
+
54
+ types:
55
+ name: types
56
+ runs-on: ubuntu-24.04
57
+ steps:
58
+ - uses: actions/checkout@v4
59
+ with:
60
+ fetch-depth: 0
61
+ - uses: actions/setup-python@v5
62
+ with:
63
+ python-version: "3.12"
64
+ cache: pip
65
+ - run: python -m pip install --upgrade pip
66
+ - run: python -m pip install -c constraints.txt -e . --group dev
67
+ - run: basedpyright # checks src and tests, see pyproject.toml
68
+
69
+ catalog:
70
+ name: catalog
71
+ runs-on: ubuntu-24.04
72
+ steps:
73
+ - uses: actions/checkout@v4
74
+ with:
75
+ fetch-depth: 0
76
+ - uses: actions/setup-python@v5
77
+ with:
78
+ python-version: "3.12"
79
+ cache: pip
80
+ - run: python -m pip install --upgrade pip
81
+ - run: python -m pip install -c constraints.txt -e . --group dev
82
+ # Needs a network and nothing else: no ROS2, no apt, no container.
83
+ - run: python -m tools.catalog_check
84
+
85
+ test:
86
+ name: test (Python ${{ matrix.python }})
87
+ runs-on: ubuntu-24.04
88
+ strategy:
89
+ fail-fast: false
90
+ matrix:
91
+ python: ["3.12", "3.11"] # 3.11 is the declared floor
92
+ steps:
93
+ - uses: actions/checkout@v4
94
+ with:
95
+ fetch-depth: 0
96
+ - uses: actions/setup-python@v5
97
+ with:
98
+ python-version: ${{ matrix.python }}
99
+ cache: pip
100
+ - run: python -m pip install --upgrade pip
101
+ - run: python -m pip install -c constraints.txt -e . --group dev
102
+ - run: pytest -n auto
103
+
104
+ jazzy:
105
+ name: test (ROS2 Jazzy)
106
+ runs-on: ubuntu-24.04
107
+ container:
108
+ # ros:jazzy-ros-base, pinned by digest (resolved 2026-09-19): the ROS package repository keeps
109
+ # one version of each package, so a tag would drift. Re-pin deliberately.
110
+ image: ros@sha256:c3706ef0a0aa45413c07803cf433602f543b22e45b4855f6fca955c2d8ecc4e8
111
+ steps:
112
+ # git first: setuptools-scm reads the version from the repository.
113
+ # `example_interfaces` is not in ros-base and the action tests need its Fibonacci action;
114
+ # `control_msgs` and `controller_manager_msgs` carry the trajectory action and the listing
115
+ # services of the structured-field tests.
116
+ - run: >
117
+ apt-get update && apt-get install -y --no-install-recommends
118
+ git python3-pip python3-venv ros-jazzy-example-interfaces ros-jazzy-control-msgs
119
+ ros-jazzy-controller-manager-msgs
120
+ - uses: actions/checkout@v4
121
+ with:
122
+ fetch-depth: 0
123
+ - run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
124
+ # A venv rather than the image's Python: apt-installed distributions there carry no RECORD
125
+ # file, so pip cannot replace one. --system-site-packages keeps rclpy importable.
126
+ - run: |
127
+ python3 -m venv --system-site-packages /opt/venv
128
+ /opt/venv/bin/python -m pip install --upgrade pip
129
+ /opt/venv/bin/python -m pip install -c constraints.txt -e . --group dev
130
+ - run: |
131
+ . /opt/ros/jazzy/setup.sh
132
+ /opt/venv/bin/python -m pytest -m jazzy
@@ -0,0 +1,109 @@
1
+ # SPDX-FileCopyrightText: 2026 Technologie-Initiative SmartFactory KL e.V.
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ # The two simulated-robot examples. `images` builds their Docker images (a pull request only builds,
6
+ # main and tags push to the GitHub container registry). `scenario` runs a scenario end to end in a
7
+ # ROS2 container, without Docker; it is started by hand, because it needs about 10 to 15 minutes and a
8
+ # lot of CPU.
9
+
10
+ name: Examples
11
+
12
+ on:
13
+ push:
14
+ branches: [main]
15
+ tags: ["v*"]
16
+ pull_request:
17
+ paths:
18
+ - "examples/nav2-rox-argo/**"
19
+ - "examples/moveit-hc10-robotiq/**"
20
+ - "src/**"
21
+ - "pyproject.toml"
22
+ - "constraints.txt"
23
+ - ".github/workflows/examples.yml"
24
+ workflow_dispatch:
25
+ inputs:
26
+ example:
27
+ description: Which scenario to run
28
+ type: choice
29
+ options: [nav2-rox-argo, moveit-hc10-robotiq]
30
+ default: nav2-rox-argo
31
+
32
+ concurrency:
33
+ group: examples-${{ github.ref }}-${{ github.event_name }}
34
+ cancel-in-progress: true
35
+
36
+ permissions:
37
+ contents: read
38
+
39
+ jobs:
40
+ images:
41
+ name: image (${{ matrix.example }})
42
+ if: github.event_name != 'workflow_dispatch'
43
+ runs-on: ubuntu-24.04
44
+ permissions:
45
+ contents: read
46
+ packages: write
47
+ strategy:
48
+ fail-fast: false
49
+ matrix:
50
+ include:
51
+ - example: nav2-rox-argo
52
+ target: example # the recorder stage is for filming only
53
+ - example: moveit-hc10-robotiq
54
+ target: ""
55
+ env:
56
+ PUSH: ${{ github.event_name != 'pull_request' }}
57
+ steps:
58
+ - uses: actions/checkout@v4
59
+ with:
60
+ fetch-depth: 0
61
+ - uses: docker/setup-buildx-action@v3
62
+ - uses: docker/login-action@v3
63
+ if: env.PUSH == 'true'
64
+ with:
65
+ registry: ghcr.io
66
+ username: ${{ github.actor }}
67
+ password: ${{ secrets.GITHUB_TOKEN }}
68
+ - id: meta
69
+ uses: docker/metadata-action@v5
70
+ with:
71
+ images: ghcr.io/${{ github.repository }}/example-${{ matrix.example }}
72
+ tags: |
73
+ type=ref,event=branch
74
+ type=ref,event=tag
75
+ # The build context is the repository root; the Dockerfile is the one run.sh builds locally.
76
+ - uses: docker/build-push-action@v6
77
+ with:
78
+ context: .
79
+ file: examples/${{ matrix.example }}/Dockerfile
80
+ target: ${{ matrix.target }}
81
+ build-args: OPENSMI_ROS_COMMIT=${{ github.sha }}
82
+ push: ${{ env.PUSH == 'true' }}
83
+ tags: ${{ steps.meta.outputs.tags }}
84
+ labels: ${{ steps.meta.outputs.labels }}
85
+ cache-from: type=gha,scope=${{ matrix.example }}
86
+ cache-to: type=gha,mode=max,scope=${{ matrix.example }}
87
+
88
+ scenario:
89
+ name: scenario (${{ inputs.example }})
90
+ if: github.event_name == 'workflow_dispatch'
91
+ runs-on: ubuntu-24.04
92
+ timeout-minutes: 60
93
+ container:
94
+ image: ros@sha256:c3706ef0a0aa45413c07803cf433602f543b22e45b4855f6fca955c2d8ecc4e8
95
+ steps:
96
+ - run: apt-get update && apt-get install -y --no-install-recommends git
97
+ - uses: actions/checkout@v4
98
+ with:
99
+ fetch-depth: 0
100
+ - run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
101
+ # ci.sh installs what the example's image holds, starts the stack as processes, runs the scenario
102
+ # and writes reports/report.md.
103
+ - run: bash examples/${{ inputs.example }}/ci.sh
104
+ - uses: actions/upload-artifact@v4
105
+ if: always()
106
+ with:
107
+ name: report-${{ inputs.example }}
108
+ path: examples/${{ inputs.example }}/reports/
109
+ retention-days: 30
@@ -0,0 +1,39 @@
1
+ # SPDX-FileCopyrightText: 2026 Technologie-Initiative SmartFactory KL e.V.
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ # Early warning for upstream changes: the test suite against the current main branches of opensmi-server
6
+ # and opensmi-core instead of the pinned releases. It runs every Monday and by hand. Raise the pins in
7
+ # constraints.txt only together with a green run of this workflow.
8
+
9
+ name: opensmi main
10
+
11
+ on:
12
+ schedule:
13
+ - cron: "0 5 * * 1"
14
+ workflow_dispatch:
15
+
16
+ permissions:
17
+ contents: read
18
+
19
+ env:
20
+ PIP_DISABLE_PIP_VERSION_CHECK: "1"
21
+
22
+ jobs:
23
+ test:
24
+ name: test (opensmi main)
25
+ runs-on: ubuntu-24.04
26
+ steps:
27
+ - uses: actions/checkout@v4
28
+ with:
29
+ fetch-depth: 0
30
+ - uses: actions/setup-python@v5
31
+ with:
32
+ python-version: "3.12"
33
+ - run: python -m pip install --upgrade pip
34
+ - run: |
35
+ python -m pip install \
36
+ "OpenSMI-Server @ git+https://github.com/SmartFactory-KL/opensmi-server@main" \
37
+ "OpenSMI-Core @ git+https://github.com/SmartFactory-KL/opensmi-core@main" \
38
+ -e . --group dev
39
+ - run: pytest -n auto
@@ -0,0 +1,58 @@
1
+ # SPDX-FileCopyrightText: 2026 Technologie-Initiative SmartFactory KL e.V.
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ # Publishes to PyPI when a GitHub release is published, by Trusted Publishing: no token is stored.
6
+ # The release creates the tag, and setuptools-scm takes the version from it. Register this workflow
7
+ # (python-publish.yml, environment "pypi") as a trusted publisher on PyPI before the first release,
8
+ # and mark a release candidate as a pre-release.
9
+
10
+ name: Upload Python Package
11
+
12
+ on:
13
+ release:
14
+ types: [published]
15
+
16
+ permissions:
17
+ contents: read
18
+
19
+ jobs:
20
+ checks:
21
+ uses: ./.github/workflows/checks.yml
22
+
23
+ release-build:
24
+ needs: [checks]
25
+ runs-on: ubuntu-24.04
26
+ steps:
27
+ - uses: actions/checkout@v4
28
+ with:
29
+ fetch-depth: 0 # setuptools-scm reads the version from the tag
30
+ - uses: actions/setup-python@v5
31
+ with:
32
+ python-version: "3.12"
33
+ - name: Build release distributions
34
+ run: |
35
+ python -m pip install --upgrade pip build twine
36
+ python -m build
37
+ python -m twine check --strict dist/*
38
+ - uses: actions/upload-artifact@v4
39
+ with:
40
+ name: release-dists
41
+ path: dist/
42
+
43
+ pypi-publish:
44
+ needs: [release-build]
45
+ runs-on: ubuntu-24.04
46
+ permissions:
47
+ id-token: write # mandatory for trusted publishing
48
+ environment:
49
+ name: pypi
50
+ url: https://pypi.org/p/opensmi-ros2
51
+ steps:
52
+ - uses: actions/download-artifact@v4
53
+ with:
54
+ name: release-dists
55
+ path: dist/
56
+ - uses: pypa/gh-action-pypi-publish@release/v1
57
+ with:
58
+ packages-dir: dist/
@@ -0,0 +1,40 @@
1
+ # SPDX-FileCopyrightText: 2026 Technologie-Initiative SmartFactory KL e.V.
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ # Byte-compiled / cache
6
+ __pycache__/
7
+ *.py[cod]
8
+
9
+ # Packaging
10
+ *.egg-info/
11
+ build/
12
+ dist/
13
+
14
+ # Virtual environments
15
+ .venv/
16
+ venv/
17
+
18
+ # Test / lint caches
19
+ .pytest_cache/
20
+ .ruff_cache/
21
+ .pip-cache/
22
+
23
+ # Editors
24
+ .vscode/
25
+ .idea/
26
+
27
+ # OS
28
+ .DS_Store
29
+
30
+ # Local wrappers carrying values of a private environment
31
+ *.local.*
32
+
33
+ # Local agent workflow files (kept on disk, not in git)
34
+ CLAUDE.md
35
+ AGENTS.md
36
+ .claude/
37
+ docs/agents/
38
+
39
+ # Output of pydoctor
40
+ apidocs/
@@ -0,0 +1,17 @@
1
+ # SPDX-FileCopyrightText: 2026 Technologie-Initiative SmartFactory KL e.V.
2
+ #
3
+ # SPDX-License-Identifier: MIT
4
+
5
+ repos:
6
+ - repo: https://github.com/astral-sh/ruff-pre-commit
7
+ rev: v0.17.3
8
+ hooks:
9
+ - id: ruff-format
10
+ - repo: local
11
+ hooks:
12
+ - id: basedpyright
13
+ name: basedpyright
14
+ entry: basedpyright
15
+ language: system
16
+ types: [python]
17
+ pass_filenames: false # check the whole project, like CI
@@ -0,0 +1,86 @@
1
+ # Contributing
2
+
3
+ ## Setup
4
+
5
+ Work in a clone, in a virtual environment. For the tests that need ROS 2, create it with
6
+ `--system-site-packages` after sourcing ROS 2 Jazzy, as the README shows. Then install the package
7
+ with the development tools:
8
+
9
+ ```
10
+ python -m pip install --upgrade pip
11
+ python -m pip install -c constraints.txt -e . --group dev
12
+ ```
13
+
14
+ `--group` needs pip 25.1 or newer, hence the upgrade first.
15
+
16
+ pyproject.toml holds version ranges, which is what a released package needs. constraints.txt pins
17
+ the exact opensmi releases that development and CI install, all from PyPI (today opensmi-server
18
+ 0.4.1 and opensmi-core 0.8.1). Raise a pin in its own merge request, together with a green run of the
19
+ [opensmi main](.github/workflows/opensmi-main.yml) workflow, which runs the tests against the current
20
+ opensmi-server and opensmi-core main branches every Monday.
21
+
22
+ ## Checks
23
+
24
+ CI runs these checks, and so should you before pushing:
25
+
26
+ ```
27
+ ruff check .
28
+ ruff format --check .
29
+ reuse lint
30
+ basedpyright
31
+ pytest -n auto
32
+ ```
33
+
34
+ `ruff format --check` also checks Python code blocks in Markdown files. basedpyright checks `src`,
35
+ `tests`, `tools` and `examples`, so a type error in a test fails the pipeline too. The runtime half
36
+ (`opensmi.ros2.runtime`) never imports opensmi or asyncua; `tests/test_import_boundary.py` enforces
37
+ that.
38
+
39
+ Tests that need a live ROS 2 Jazzy graph are marked `jazzy` and deselected by default. Source ROS 2
40
+ Jazzy, install the interface packages `example_interfaces`, `control_msgs` and
41
+ `controller_manager_msgs`, and run `pytest -m jazzy`. On WSL, set `FASTDDS_BUILTIN_TRANSPORTS=SHM`.
42
+
43
+ ## The public surface
44
+
45
+ The public surface is what a server author touches to declare or start a server. The docstrings of
46
+ `opensmi.ros2.server` and `opensmi.ros2.runtime` list it. Every other name stays importable from its
47
+ module but may change in any release. The error classes are public through
48
+ `opensmi.ros2.server.errors` and `opensmi.ros2.runtime.errors`.
49
+
50
+ A name joins the surface when a server author needs it to write a declaration, a custom driver or a
51
+ custom Projection. A name leaves it by being removed from `__all__`, after a rename or a deprecation
52
+ if it was in a release. Make either change in one commit that edits `__all__`, the expected lists in
53
+ `tests/test_public_surface.py` and, if a user would notice, the docstring and the README. That test
54
+ also checks that every public name imports and is documented where it is defined.
55
+
56
+ ## The definition catalog
57
+
58
+ `catalog/` holds verbatim ROS 2 interface definitions for packages that cannot be installed, and
59
+ `tools/catalog/` generates the stubs in `src/opensmi/ros2/runtime/messages/` from them. CI runs
60
+ `python -m tools.catalog_check`. See [catalog/README.md](catalog/README.md).
61
+
62
+ ## Before a tag
63
+
64
+ The version comes from the git tag through setuptools-scm. Tags are `vX.Y.Z` (pre-releases such as
65
+ `v0.1.0rc1`), and a tag cannot be moved. Before tagging, run every check above, basedpyright
66
+ included, and the `jazzy` tests (`pytest -m jazzy`).
67
+
68
+ ## Commits
69
+
70
+ Use [Conventional Commits](https://www.conventionalcommits.org/). The changelog is generated from the
71
+ history with [git-cliff](https://git-cliff.org/), so the commit message is the release note.
72
+
73
+ ```
74
+ <type>(<optional scope>): <summary in the imperative, lower case, no trailing period>
75
+
76
+ <optional body: what and why>
77
+
78
+ <optional footers, e.g. BREAKING CHANGE: ...>
79
+ ```
80
+
81
+ Types: `feat`, `fix`, `perf`, `refactor`, `docs`, `test`, `build`, `ci`, `style`, `revert`, `chore`.
82
+ Mark a breaking change with `!` after the type or scope, or with a `BREAKING CHANGE:` footer. A change
83
+ that breaks a client also gets an entry in [docs/migration.md](docs/migration.md).
84
+
85
+ Preview the unreleased changelog with `git cliff --unreleased`. When releasing, regenerate it with
86
+ `git cliff --tag vX.Y.Z -o CHANGELOG.md`. The configuration is in cliff.toml.
@@ -0,0 +1,18 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Technologie-Initiative SmartFactory KL e.V.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
6
+ associated documentation files (the "Software"), to deal in the Software without restriction, including
7
+ without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
9
+ following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be included in all copies or substantial
12
+ portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
15
+ LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
16
+ EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
17
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
18
+ USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,73 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
10
+
11
+ "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
12
+
13
+ "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
14
+
15
+ "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
16
+
17
+ "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
18
+
19
+ "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
20
+
21
+ "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
22
+
23
+ "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
24
+
25
+ "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
26
+
27
+ "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
28
+
29
+ 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
30
+
31
+ 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
32
+
33
+ 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
34
+
35
+ (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
36
+
37
+ (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
38
+
39
+ (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
40
+
41
+ (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
42
+
43
+ You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
44
+
45
+ 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
46
+
47
+ 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
48
+
49
+ 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
50
+
51
+ 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
52
+
53
+ 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
54
+
55
+ END OF TERMS AND CONDITIONS
56
+
57
+ APPENDIX: How to apply the Apache License to your work.
58
+
59
+ To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
60
+
61
+ Copyright [yyyy] [name of copyright owner]
62
+
63
+ Licensed under the Apache License, Version 2.0 (the "License");
64
+ you may not use this file except in compliance with the License.
65
+ You may obtain a copy of the License at
66
+
67
+ http://www.apache.org/licenses/LICENSE-2.0
68
+
69
+ Unless required by applicable law or agreed to in writing, software
70
+ distributed under the License is distributed on an "AS IS" BASIS,
71
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
72
+ See the License for the specific language governing permissions and
73
+ limitations under the License.
@@ -0,0 +1,11 @@
1
+ Copyright (c) <year> <owner>.
2
+
3
+ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
4
+
5
+ 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
6
+
7
+ 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
8
+
9
+ 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
10
+
11
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.