From f7f3bfe5288ca5e0b4572b33ec6317e95f975456 Mon Sep 17 00:00:00 2001
From: Burak Ozter <burak.ozter@spirirobotics.com>
Date: Tue, 29 Oct 2024 10:31:59 -0300
Subject: [PATCH] add comments

---
 .env | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/.env b/.env
index 08e2b48..a7cb3dd 100644
--- a/.env
+++ b/.env
@@ -1,12 +1,15 @@
-DRONE_SYS_ID=1
-#this is used for multi-vehicle sim. first vehicle would have these
+#Manual edit not needed unless desired set of DRONE_SYS_ID's are different.
+DRONE_SYS_ID=1 #sim_drone.py increments this env variable.
+#this is used for multi-vehicle sim. first/single vehicle would have these.
 TRACKER_INSTANCE=0
 SERIAL0_PORT=5760
 SITL_PORT=5501
 MAVLINK_PORT=14560
-#This is the vehicle ardupilot will use.
+#This is the vehicle ardupilot will use. Default value is for SITL + Gazebo
+#E.g. "-v copter" , "-v rover"
 ARDUPILOT_VEHICLE="-v ArduCopter -f gazebo-iris --model=JSON"
-#gazebo-sdk related
+
+#these below are used in spawn_drones.sh to create the world with the correct entities.
 #Number of drones to be spawned in the gazebo world.
 SIM_DRONE_COUNT=2
 #This is not needed to be modified.
@@ -14,6 +17,7 @@ FDM_PORT_IN=9002
 #The world file you want to use.
 WORLD_FILE_NAME="citadel_hill_world.sdf"
 #World name in your world file. Not the same as world file name necessarily.
+#Important for spawning entities in the correct world.
 WORLD_NAME="citadel_hill"
 #Vehicle model folder name where model.config and model.xacro.sdf are present.
 DRONE_MODEL="spiri_mu"
\ No newline at end of file