Cleaned Up Comments

nepi-engine · Feb 3, 2024 · 8918b0f · 8918b0f
1 parent 0344d1c
commit 8918b0f
Show file tree

Hide file tree

Showing 29 changed files with 1,127 additions and 430 deletions.
diff --git a/_drone_detect_and_follow_startup_script.py b/_drone_detect_and_follow_startup_script.py
@@ -24,11 +24,10 @@
 #
 #
 
-# Sample Solution Config Script. 
-# 1. launches scripts from list NEPI ROS service
+# Sample Solution Startup Script. 
+# 1. Launches scripts from list that are not running
 # 2. Waits for shutdown
-# 3. Stops scripts from list
-# 4. Relaunchs any scripts that were running at Start
+# 3. Stops scripts that were launched by this script
 
 import rospy
 import os
@@ -40,9 +39,9 @@
 from std_srvs.srv import Empty, EmptyRequest, Trigger
 from nepi_ros_interfaces.srv import GetScriptsQuery,GetRunningScriptsQuery ,LaunchScript, StopScript
 
-#####################################################################################
-# SETUP - Edit as Necessary ##################################
-##########################################
+#########################################
+# USER SETTINGS - Edit as Necessary 
+#########################################
 
 SCRIPT_LIST = ["ardupilot_rbx_driver_script.py",
                 "zed2_idx_driver_script.py",
@@ -52,6 +51,10 @@
                 "ai_3d_targeting_process_script.py",
                	"drone_follow_object_mission_script.py"] #  Script filenames to start/stop
 
+#########################################
+# ROS NAMESPACE SETUP
+#########################################
+
 # ROS namespace setup
 NEPI_BASE_NAMESPACE = "/nepi/s2x/"
 
@@ -61,18 +64,20 @@
 AUTO_LAUNCH_SCRIPT_SERVICE_NAME = NEPI_BASE_NAMESPACE + "launch_script"
 AUTO_STOP_SCRIPT_SERVICE_NAME = NEPI_BASE_NAMESPACE + "stop_script"
 
-#####################################################################################
+#########################################
 # Globals
-#####################################################################################
+#########################################
+
 get_installed_scripts_service = rospy.ServiceProxy(AUTO_GET_INSTALLED_SCRIPTS_SERVICE_NAME, GetScriptsQuery )
 get_running_scripts_service = rospy.ServiceProxy(AUTO_GET_RUNNING_SCRIPTS_SERVICE_NAME, GetRunningScriptsQuery )
 launch_script_service = rospy.ServiceProxy(AUTO_LAUNCH_SCRIPT_SERVICE_NAME, LaunchScript)
 stop_script_service = rospy.ServiceProxy(AUTO_STOP_SCRIPT_SERVICE_NAME, StopScript)
 scripts_installed_at_start = None
 scripts_running_at_start = None
-#####################################################################################
+
+#########################################
 # Methods
-#####################################################################################
+#########################################
 
 ### System Initialization processes
 def initialize_actions():
@@ -248,9 +253,9 @@ def startNode():
   # Spin forever
   rospy.spin()
 
-#####################################################################################
+#########################################
 # Main
-#####################################################################################
+#########################################
 
 if __name__ == '__main__':
   startNode()

diff --git a/_drone_detect_loiter_snapshot_startup_script.py b/_drone_detect_loiter_snapshot_startup_script.py
@@ -24,11 +24,10 @@
 #
 #
 
-# Sample Solution Config Script. 
-# 1. launches scripts from list NEPI ROS service
+# Sample Solution Startup Script. 
+# 1. Launches scripts from list that are not running
 # 2. Waits for shutdown
-# 3. Stops scripts from list
-# 4. Relaunchs any scripts that were running at Start
+# 3. Stops scripts that were launched by this script
 
 import rospy
 import os
@@ -40,9 +39,11 @@
 from std_srvs.srv import Empty, EmptyRequest, Trigger
 from nepi_ros_interfaces.srv import GetScriptsQuery,GetRunningScriptsQuery ,LaunchScript, StopScript
 
-#####################################################################################
-# SETUP - Edit as Necessary ##################################
-##########################################
+
+#########################################
+# USER SETTINGS - Edit as Necessary 
+#########################################
+
 SCRIPT_LIST = ["ardupilot_rbx_driver_script.py",
                "ardupilot_rbx_navpose_config_script.py",
                "ardupilot_rbx_fake_gps_config_script.py",
@@ -52,6 +53,10 @@
                "drone_detect_loiter_snapshot_mission_script.py"] #  Script filenames to start/stop
 
 
+#########################################
+# ROS NAMESPACE SETUP
+#########################################
+
 # ROS namespace setup
 NEPI_BASE_NAMESPACE = "/nepi/s2x/"
 
@@ -61,18 +66,20 @@
 AUTO_LAUNCH_SCRIPT_SERVICE_NAME = NEPI_BASE_NAMESPACE + "launch_script"
 AUTO_STOP_SCRIPT_SERVICE_NAME = NEPI_BASE_NAMESPACE + "stop_script"
 
-#####################################################################################
+#########################################
 # Globals
-#####################################################################################
+#########################################
+
 get_installed_scripts_service = rospy.ServiceProxy(AUTO_GET_INSTALLED_SCRIPTS_SERVICE_NAME, GetScriptsQuery )
 get_running_scripts_service = rospy.ServiceProxy(AUTO_GET_RUNNING_SCRIPTS_SERVICE_NAME, GetRunningScriptsQuery )
 launch_script_service = rospy.ServiceProxy(AUTO_LAUNCH_SCRIPT_SERVICE_NAME, LaunchScript)
 stop_script_service = rospy.ServiceProxy(AUTO_STOP_SCRIPT_SERVICE_NAME, StopScript)
 scripts_installed_at_start = None
 scripts_running_at_start = None
-#####################################################################################
+
+#########################################
 # Methods
-#####################################################################################
+#########################################
 
 ### System Initialization processes
 def initialize_actions():
@@ -248,9 +255,9 @@ def startNode():
   # Spin forever
   rospy.spin()
 
-#####################################################################################
+#########################################
 # Main
-#####################################################################################
+#########################################
 
 if __name__ == '__main__':
   startNode()

diff --git a/_drone_waypoint_inspection_startup_script.py b/_drone_waypoint_inspection_startup_script.py
@@ -24,11 +24,10 @@
 #
 #
 
-# Sample Solution Config Script. 
-# 1. launches scripts from list NEPI ROS service
+# Sample Solution Startup Script. 
+# 1. Launches scripts from list that are not running
 # 2. Waits for shutdown
-# 3. Stops scripts from list
-# 4. Relaunchs any scripts that were running at Start
+# 3. Stops scripts that were launched by this script
 
 import rospy
 import os
@@ -40,15 +39,21 @@
 from std_srvs.srv import Empty, EmptyRequest, Trigger
 from nepi_ros_interfaces.srv import GetScriptsQuery,GetRunningScriptsQuery ,LaunchScript, StopScript
 
-#####################################################################################
-# SETUP - Edit as Necessary ##################################
-##########################################
+
+#########################################
+# USER SETTINGS - Edit as Necessary 
+#########################################
+
 SCRIPT_LIST = ["ardupilot_rbx_driver_script.py",
                 "ardupilot_rbx_navpose_config_script.py",
                 "ardupilot_rbx_fake_gps_config_script.py",
                 "snapshot_event_save_to_disk_action_script.py",
                	"drone_waypoint_inspection_mission_script.py"] #  Script filenames to start/stop
 
+#########################################
+# ROS NAMESPACE SETUP
+#########################################
+
 # ROS namespace setup
 NEPI_BASE_NAMESPACE = "/nepi/s2x/"
 
@@ -58,18 +63,20 @@
 AUTO_LAUNCH_SCRIPT_SERVICE_NAME = NEPI_BASE_NAMESPACE + "launch_script"
 AUTO_STOP_SCRIPT_SERVICE_NAME = NEPI_BASE_NAMESPACE + "stop_script"
 
-#####################################################################################
+#########################################
 # Globals
-#####################################################################################
+#########################################
+
 get_installed_scripts_service = rospy.ServiceProxy(AUTO_GET_INSTALLED_SCRIPTS_SERVICE_NAME, GetScriptsQuery )
 get_running_scripts_service = rospy.ServiceProxy(AUTO_GET_RUNNING_SCRIPTS_SERVICE_NAME, GetRunningScriptsQuery )
 launch_script_service = rospy.ServiceProxy(AUTO_LAUNCH_SCRIPT_SERVICE_NAME, LaunchScript)
 stop_script_service = rospy.ServiceProxy(AUTO_STOP_SCRIPT_SERVICE_NAME, StopScript)
 scripts_installed_at_start = None
 scripts_running_at_start = None
-#####################################################################################
+
+#########################################
 # Methods
-#####################################################################################
+#########################################
 
 ### System Initialization processes
 def initialize_actions():
@@ -245,9 +252,9 @@ def startNode():
   # Spin forever
   rospy.spin()
 
-#####################################################################################
+#########################################
 # Main
-#####################################################################################
+#########################################
 
 if __name__ == '__main__':
   startNode()

diff --git a/_object_detect_and_3d_targeting_startup_script.py b/_object_detect_and_3d_targeting_startup_script.py
@@ -24,11 +24,10 @@
 #
 #
 
-# Sample Solution Config Script. 
-# 1. launches scripts from list NEPI ROS service
+# Sample Solution Startup Script. 
+# 1. Launches scripts from list that are not running
 # 2. Waits for shutdown
-# 3. Stops scripts from list
-# 4. Relaunchs any scripts that were running at Start
+# 3. Stops scripts that were launched by this script
 
 import rospy
 import os
@@ -40,9 +39,10 @@
 from std_srvs.srv import Empty, EmptyRequest, Trigger
 from nepi_ros_interfaces.srv import GetScriptsQuery,GetRunningScriptsQuery ,LaunchScript, StopScript
 
-#####################################################################################
-# SETUP - Edit as Necessary ##################################
-##########################################
+
+#########################################
+# USER SETTINGS - Edit as Necessary 
+#########################################
 
 SCRIPT_LIST = ["zed2_idx_driver_script.py",
                "navpose_set_fixed_config_script.py",
@@ -51,6 +51,9 @@
                "ai_3d_targeting_process_script.py"] #  Script filenames to start/stop
 
 
+#########################################
+# ROS NAMESPACE SETUP
+#########################################
 
 # ROS namespace setup
 NEPI_BASE_NAMESPACE = "/nepi/s2x/"
@@ -61,18 +64,20 @@
 AUTO_LAUNCH_SCRIPT_SERVICE_NAME = NEPI_BASE_NAMESPACE + "launch_script"
 AUTO_STOP_SCRIPT_SERVICE_NAME = NEPI_BASE_NAMESPACE + "stop_script"
 
-#####################################################################################
+#########################################
 # Globals
-#####################################################################################
+#########################################
+
 get_installed_scripts_service = rospy.ServiceProxy(AUTO_GET_INSTALLED_SCRIPTS_SERVICE_NAME, GetScriptsQuery )
 get_running_scripts_service = rospy.ServiceProxy(AUTO_GET_RUNNING_SCRIPTS_SERVICE_NAME, GetRunningScriptsQuery )
 launch_script_service = rospy.ServiceProxy(AUTO_LAUNCH_SCRIPT_SERVICE_NAME, LaunchScript)
 stop_script_service = rospy.ServiceProxy(AUTO_STOP_SCRIPT_SERVICE_NAME, StopScript)
 scripts_installed_at_start = None
 scripts_running_at_start = None
-#####################################################################################
+
+#########################################
 # Methods
-#####################################################################################
+#########################################
 
 ### System Initialization processes
 def initialize_actions():
@@ -283,9 +288,9 @@ def startNode():
   # Spin forever
   rospy.spin()
 
-#####################################################################################
+#########################################
 # Main
-#####################################################################################
+#########################################
 
 if __name__ == '__main__':
   startNode()

diff --git a/_object_detect_and_snapshot_startup_script.py b/_object_detect_and_snapshot_startup_script.py
@@ -24,11 +24,10 @@
 #
 #
 
-# Sample Solution Config Script. 
-# 1. launches scripts from list NEPI ROS service
+# Sample Solution Startup Script. 
+# 1. Launches scripts from list that are not running
 # 2. Waits for shutdown
-# 3. Stops scripts from list
-# 4. Relaunchs any scripts that were running at Start
+# 3. Stops scripts that were launched by this script
 
 import rospy
 import os
@@ -40,15 +39,20 @@
 from std_srvs.srv import Empty, EmptyRequest, Trigger
 from nepi_ros_interfaces.srv import GetScriptsQuery,GetRunningScriptsQuery ,LaunchScript, StopScript
 
-#####################################################################################
-# SETUP - Edit as Necessary ##################################
-##########################################
+
+#########################################
+# USER SETTINGS - Edit as Necessary 
+#########################################
+
 SCRIPT_LIST = ["ai_detector_config_script.py",
                "navpose_set_fixed_config_script.py",
                "ai_detect_and_snapshot_process_script.py",
                "snapshot_event_save_to_disk_action_script.py",
                "snapshot_event_send_to_cloud_action_script.py"] #  Script filenames to start/stop
 
+#########################################
+# ROS NAMESPACE SETUP
+#########################################
 
 # ROS namespace setup
 NEPI_BASE_NAMESPACE = "/nepi/s2x/"
@@ -59,18 +63,20 @@
 AUTO_LAUNCH_SCRIPT_SERVICE_NAME = NEPI_BASE_NAMESPACE + "launch_script"
 AUTO_STOP_SCRIPT_SERVICE_NAME = NEPI_BASE_NAMESPACE + "stop_script"
 
-#####################################################################################
+#########################################
 # Globals
-#####################################################################################
+#########################################
+
 get_installed_scripts_service = rospy.ServiceProxy(AUTO_GET_INSTALLED_SCRIPTS_SERVICE_NAME, GetScriptsQuery )
 get_running_scripts_service = rospy.ServiceProxy(AUTO_GET_RUNNING_SCRIPTS_SERVICE_NAME, GetRunningScriptsQuery )
 launch_script_service = rospy.ServiceProxy(AUTO_LAUNCH_SCRIPT_SERVICE_NAME, LaunchScript)
 stop_script_service = rospy.ServiceProxy(AUTO_STOP_SCRIPT_SERVICE_NAME, StopScript)
 scripts_installed_at_start = None
 scripts_running_at_start = None
-#####################################################################################
+
+#########################################
 # Methods
-#####################################################################################
+#########################################
 
 ### System Initialization processes
 def initialize_actions():
@@ -246,9 +252,9 @@ def startNode():
   # Spin forever
   rospy.spin()
 
-#####################################################################################
+#########################################
 # Main
-#####################################################################################
+#########################################
 
 if __name__ == '__main__':
   startNode()