[digital_cam] documentation

paparazzi · Sep 3, 2015 · c7f00ac · c7f00ac
1 parent d85a942
commit c7f00ac
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 7 deletions.
diff --git a/conf/modules/digital_cam.xml b/conf/modules/digital_cam.xml
@@ -2,7 +2,12 @@
 
 <module name="digital_cam">
   <doc>
-    <description>Digital camera control (trigger using GPIO)</description>
+    <description>
+      Digital Photo Camera Triggering (using a GPIO pin)
+
+      This module controls triggering of an attached external digital camera via one or more GPIO pins for on/off/shoot/zoom.
+      It can trigger photos based on GPS distance, time or circle radius in both fixedwings and rotorcraft.
+    </description>
     <define name="DC_SHOOT_ON_BUTTON_RELEASE" description="if defined, call dc_send_shot_postion on button release instead of on push"/>
     <define name="DC_SHUTTER_GPIO" value="GPIOC,GPIO12" description="mandatory, gpio to control shutter"/>
     <define name="DC_ZOOM_IN_GPIO" value="GPIOC,GPIO2" description="optional, gpio to activate zoom in"/>

diff --git a/conf/modules/digital_cam_i2c.xml b/conf/modules/digital_cam_i2c.xml
@@ -3,8 +3,12 @@
 <module name="atmega_i2c_cam_ctrl" dir="digital_cam">
   <doc>
     <description>
-      Trigger Digital Camera (I2C).
-      Using I2C connected remote microcontroller
+      Digital Photo Camera Triggering (using a I2C channel)
+
+      This module controls triggering of an attached device via an I2C command.
+      Typically a remote microcontroller (atmega/arduino) will then use the triggering/zoom/power commands.
+      Using the PAYLOAD_COMMAND, all functions of the camera can be controlled.
+      It can trigger photos based on GPS distance, time or circle radius in both fixedwings and rotorcraft.
     </description>
     <define name="DC_SHOOT_ON_BUTTON_RELEASE" />
     <define name="DC_SHOT_SYNC_SEND" value="TRUE|FALSE" description="send DC_SHOT message when photo was taken (default: TRUE)"/>

diff --git a/conf/modules/digital_cam_servo.xml b/conf/modules/digital_cam_servo.xml
@@ -2,7 +2,12 @@
 
 <module name="digital_cam_servo" dir="digital_cam">
   <doc>
-    <description>Digital camera control (trigger using servo)</description>
+    <description>
+      Digital Photo Camera Triggering (using a servo)
+
+      This module controls triggering of an attached external digital camera via a servo channel.
+      It can trigger photos based on GPS distance, time or circle radius in both fixedwings and rotorcraft.
+    </description>
     <define name="DC_SHOOT_ON_BUTTON_RELEASE" description="if defined, call dc_send_shot_postion on button release instead of on push"/>
     <define name="DC_SHUTTER_SERVO" value="servo" description="mandatory, Servo to control shutter"/>
     <define name="DC_ZOOM_IN_SERVO" value="servo" description="optional, Servo to activate zoom in"/>

diff --git a/conf/modules/digital_cam_uart.xml b/conf/modules/digital_cam_uart.xml
@@ -2,8 +2,23 @@
 <module name="uart_cam_ctrl" dir="digital_cam">
   <doc>
     <description>
-      Digital Camera Triggering over UART link.
-      Send attitude and other relevant data to a computer based photocamera after a shootphoto command is given. And in return get certain value back from the computerbased photocamera to be able to intercat with the flightplan.</description>
+      Digital Photo Camera Triggering (using a UART link)
+
+      This module controls triggering of an attached external digital camera via UART commands.
+      It can trigger photos based on GPS distance, time or circle radius in both fixedwings and rotorcraft.
+
+      This module fullfilss 4 functions:
+      1) send shoot commands over UART
+      2) Besides triggering the shooting of images, the module also sends attitude and other relevant data.
+      Typically an external linux camera or linux computer will receive the attitude and position data and add
+      it to the photos.
+      3) The module will also parse the replies received over the UART. This contains status but can also
+      contain computer vision results to able to interact with the flightplan.
+      4) Finally, the module will also relay over telemetry all data it receives from the attached computer
+      or camera using the PAYLOAD message. This can for instance be used to downlink thumbnails.
+
+      The linux program used to parse the UART command is given in the subdirectory.
+    </description>
     <define name="DC_AUTOSHOOT_PERIOD" value="0.5" description="time period for DC_AUTOSHOOT_PERIODIC in seconds"/>
     <define name="DC_AUTOSHOOT_DISTANCE_INTERVAL" value="50" description="grid in meters"/>
     <define name="DC_SHOT_SYNC_SEND" value="TRUE|FALSE" description="send DC_SHOT message when photo was taken (default: TRUE)"/>

diff --git a/conf/modules/digital_cam_video.xml b/conf/modules/digital_cam_video.xml
@@ -2,7 +2,10 @@
 <module name="video_cam_ctrl" dir="digital_cam">
   <doc>
     <description>
-      Digital Camera Triggering of an embedded camera on a linux based autopilot.
+      Digital Photo Camera Triggering (using embedded video)
+
+      This module controls triggering of an embedded digital camera on a linux based autopilot. This particular version triggers the video_rtp_stream.xml module to store jpeg images.
+      It can trigger photos based on GPS distance, time or circle radius in both fixedwings and rotorcraft.
     </description>
     <define name="DC_AUTOSHOOT_PERIOD" value="0.5" description="time period for DC_AUTOSHOOT_PERIODIC in seconds"/>
     <define name="DC_AUTOSHOOT_DISTANCE_INTERVAL" value="50" description="grid in meters"/>