Diff: settings.h

Revision:

11:312663037b8c

Parent:

6:b340a527add9

Child:

12:878c6e9d9e60

--- a/settings.h	Sun Oct 16 16:00:20 2016 +0000
+++ b/settings.h	Sun Oct 16 21:06:15 2016 +0000
@@ -20,6 +20,18 @@
  *
  */ 
 
+/*! \file settings.h
+    \brief Header file containing PsiSwarm define headings
+    \brief USE_MOTOR_CALIBRATION Enable motor calibration using stored values. 
+    If enabled, the actual motor speeds will be adjusted from the requested values using the motor calibration values stored in EPROM.
+    \brief OFFSET_MOTORS Enable PWM offset to prevent stalling at low speeds. The motors typically stall when the PWM output is below around 0.2. 
+    Enabling the offset shifts the actual PWM range so that the motor speed 0.0 -> 1.0 actually sets a PWM output of 0.2 -> 1.0
+    
+*/
+
+#ifndef SETTINGS_H
+#define SETTINGS_H
+
 /* USE_MOTOR_CALIBRATION [1=on, recommended      0=off]
  * If enabled, the actual motor speeds will be adjusted from the requested values using the motor calibration values stored in
  * firmware (and set using the motor calibration code in the demo mode)
@@ -50,6 +62,7 @@
  */
 
 /* ENABLE_BLUETOOTH [1=on, 0=off]:  Enable if the BlueSmirf module is being used */
+/** @brief Enable if the BlueSmirf module is being used. 0=off 1=on*/
 #define ENABLE_BLUETOOTH 1
 
 /* ENABLE_PC_SERIAL [1=on, 0=off]:  Enable if the PC USB serial module is being used */
@@ -82,3 +95,6 @@
 
 /* DEBUG_OUTPUT_STREAM [1=PC\USB 2=BlueSmirf 4=Display]:  Specify which output stream(s) should be used by default for debug messages, if enabled*/
 #define DEBUG_OUTPUT_STREAM 1
+
+#endif
+