Change modulation type defines to enum

merbanan · Feb 13, 2019 · cab7ca9 · cab7ca9
1 parent baace97
commit cab7ca9
Showing 1 changed file with 15 additions and 13 deletions.
diff --git a/include/decoder.h b/include/decoder.h
@@ -12,19 +12,21 @@
 #include "util.h"
 #include "decoder_util.h"
 
-/* Supported modulation types */
-#define OOK_PULSE_MANCHESTER_ZEROBIT    3  // Manchester encoding. Hardcoded zerobit. Rising Edge = 0, Falling edge = 1
-#define OOK_PULSE_PCM_RZ                4  // Pulse Code Modulation with Return-to-Zero encoding, Pulse = 0, No pulse = 1
-#define OOK_PULSE_PPM                   5  // Pulse Position Modulation. Short gap = 0, Long = 1
-#define OOK_PULSE_PWM                   6  // Pulse Width Modulation with precise timing parameters
-#define OOK_PULSE_PIWM_RAW              8  // Level shift for each bit. Short interval = 1, Long = 0
-#define OOK_PULSE_PIWM_DC               11 // Level shift for each bit. Short interval = 1, Long = 0
-#define OOK_PULSE_DMC                   9  // Level shift within the clock cycle.
-#define OOK_PULSE_PWM_OSV1              10 // Pulse Width Modulation. Oregon Scientific v1
+/** Supported modulation types. */
+enum modulation_types {
+    OOK_PULSE_MANCHESTER_ZEROBIT =  3,  ///< Manchester encoding. Hardcoded zerobit. Rising Edge = 0, Falling edge = 1.
+    OOK_PULSE_PCM_RZ =              4,  ///< Pulse Code Modulation with Return-to-Zero encoding, Pulse = 0, No pulse = 1.
+    OOK_PULSE_PPM =                 5,  ///< Pulse Position Modulation. Short gap = 0, Long = 1.
+    OOK_PULSE_PWM =                 6,  ///< Pulse Width Modulation with precise timing parameters.
+    OOK_PULSE_PIWM_RAW =            8,  ///< Level shift for each bit. Short interval = 1, Long = 0.
+    OOK_PULSE_PIWM_DC =             11, ///< Level shift for each bit. Short interval = 1, Long = 0.
+    OOK_PULSE_DMC =                 9,  ///< Level shift within the clock cycle.
+    OOK_PULSE_PWM_OSV1 =            10, ///< Pulse Width Modulation. Oregon Scientific v1.
 
-#define FSK_DEMOD_MIN_VAL               16 // Dummy. FSK demodulation must start at this value
-#define FSK_PULSE_PCM                   16 // FSK, Pulse Code Modulation
-#define FSK_PULSE_PWM                   17 // FSK, Pulse Width Modulation. Short pulses = 1, Long = 0
-#define FSK_PULSE_MANCHESTER_ZEROBIT    18 // FSK, Manchester encoding
+    FSK_DEMOD_MIN_VAL =             16, ///< Dummy. FSK demodulation must start at this value.
+    FSK_PULSE_PCM =                 16, ///< FSK, Pulse Code Modulation.
+    FSK_PULSE_PWM =                 17, ///< FSK, Pulse Width Modulation. Short pulses = 1, Long = 0.
+    FSK_PULSE_MANCHESTER_ZEROBIT =  18, ///< FSK, Manchester encoding.
+};
 
 #endif /* INCLUDE_DECODER_H_ */