]> cloudbase.mooo.com Git - irmp.git/blobdiff - irmp.h
Version 2.1.2:
[irmp.git] / irmp.h
diff --git a/irmp.h b/irmp.h
index f8567d95aac57e141c531b8a460fe264b92c0306..1e54f2c80fd0d1d6b80622fcbdfe9d3fd9c3d2e2 100644 (file)
--- a/irmp.h
+++ b/irmp.h
@@ -1,9 +1,9 @@
 /*---------------------------------------------------------------------------------------------------------------------------------------------------\r
  * irmp.h\r
  *\r
- * Copyright (c) 2009-2010 Frank Meyer - frank(at)fli4l.de\r
+ * Copyright (c) 2009-2011 Frank Meyer - frank(at)fli4l.de\r
  *\r
- * $Id: irmp.h,v 1.57 2011/02/25 09:23:05 fm Exp $\r
+ * $Id: irmp.h,v 1.72 2012/02/24 14:24:27 fm Exp $\r
  *\r
  * ATMEGA88 @ 8 MHz\r
  *\r
 #ifndef _WC_IRMP_H_\r
 #define _WC_IRMP_H_\r
 \r
-#ifdef __cplusplus\r
-extern "C"\r
-{\r
-#endif\r
+#if defined(__18CXX)                                                        // Microchip C18 declaration of missing typedef\r
+typedef unsigned char                           uint8_t;\r
+typedef unsigned int                            uint16_t;\r
+#endif //Microchip C18\r
 \r
 /*---------------------------------------------------------------------------------------------------------------------------------------------------\r
  * timing constants:\r
  *---------------------------------------------------------------------------------------------------------------------------------------------------\r
  */\r
-#define IRMP_TIMEOUT_TIME                       16500.0e-6                  // timeout after 16.5 ms darkness\r
-#define IRMP_TIMEOUT_TIME_MS                    16500L                      // timeout after 16.5 ms darkness\r
+// fm 22.09.2011: may not be more than 16000L, otherwise some JVC codes will not be accepted\r
+#define IRMP_TIMEOUT_TIME                       15500.0e-6                  // timeout after 15.5 ms darkness\r
+#define IRMP_TIMEOUT_TIME_MS                    15500L                      // timeout after 15.5 ms darkness\r
 \r
 #if IRMP_SUPPORT_NIKON_PROTOCOL == 1\r
 #define IRMP_TIMEOUT_NIKON_TIME                 29500.0e-6                  // 2nd timeout after 29.5 ms darkness (only for NIKON!)\r
@@ -67,14 +68,19 @@ typedef uint8_t     PAUSE_LEN;
 #define IRMP_SIEMENS_PROTOCOL                   17              // Siemens, e.g. Gigaset\r
 #define IRMP_FDC_PROTOCOL                       18              // FDC keyboard\r
 #define IRMP_RCCAR_PROTOCOL                     19              // RC Car\r
-#define IRMP_JVC_PROTOCOL                       20              // JVC\r
+#define IRMP_JVC_PROTOCOL                       20              // JVC (NEC with 16 bits)\r
 #define IRMP_RC6A_PROTOCOL                      21              // RC6A, e.g. Kathrein, XBOX\r
 #define IRMP_NIKON_PROTOCOL                     22              // Nikon\r
 #define IRMP_RUWIDO_PROTOCOL                    23              // Ruwido, e.g. T-Home Mediareceiver\r
 #define IRMP_IR60_PROTOCOL                      24              // IR60 (SAB2008)\r
 #define IRMP_KATHREIN_PROTOCOL                  25              // Kathrein\r
 #define IRMP_NETBOX_PROTOCOL                    26              // Netbox keyboard (bitserial)\r
-#define IRMP_IMON_PROTOCOL                      27              // Imon (bitserial)\r
+#define IRMP_NEC16_PROTOCOL                     27              // NEC with 16 bits (incl. sync)\r
+#define IRMP_NEC42_PROTOCOL                     28              // NEC with 42 bits\r
+#define IRMP_LEGO_PROTOCOL                      29              // LEGO Power Functions RC\r
+#define IRMP_THOMSON_PROTOCOL                   30              // Thomson\r
+\r
+#define IRMP_N_PROTOCOLS                        30              // number of supported protocols\r
 \r
 // some flags of struct IRMP_PARAMETER:\r
 #define IRMP_PARAM_FLAG_IS_MANCHESTER           0x01\r
@@ -115,12 +121,25 @@ typedef uint8_t     PAUSE_LEN;
 #define NEC_LSB                                 1                               // LSB...MSB\r
 #define NEC_FLAGS                               0                               // flags\r
 \r
+#define NEC42_ADDRESS_OFFSET                    0                               // skip 0 bits\r
+#define NEC42_ADDRESS_LEN                      13                               // read 13 address bits\r
+#define NEC42_COMMAND_OFFSET                   26                               // skip 26 bits (2 x 13 address bits)\r
+#define NEC42_COMMAND_LEN                       8                               // read 8 command bits\r
+#define NEC42_COMPLETE_DATA_LEN                42                               // complete length (2 x 13 + 2 x 8)\r
+\r
+#define NEC16_ADDRESS_OFFSET                    0                               // skip 0 bits\r
+#define NEC16_ADDRESS_LEN                       8                               // read 8 address bits\r
+#define NEC16_COMMAND_OFFSET                    8                               // skip 8 bits (8 address)\r
+#define NEC16_COMMAND_LEN                       8                               // read 8 bits (8 command)\r
+#define NEC16_COMPLETE_DATA_LEN                 16                              // complete length\r
+\r
 #define SAMSUNG_START_BIT_PULSE_TIME            4500.0e-6                       // 4500 usec pulse\r
 #define SAMSUNG_START_BIT_PAUSE_TIME            4500.0e-6                       // 4500 usec pause\r
 #define SAMSUNG_PULSE_TIME                       550.0e-6                       //  550 usec pulse\r
-#define SAMSUNG_1_PAUSE_TIME                    1450.0e-6                       // 1450 usec pause\r
-#define SAMSUNG_0_PAUSE_TIME                     450.0e-6                       //  450 usec pause\r
-#define SAMSUNG_FRAME_REPEAT_PAUSE_TIME           45.0e-3                       // frame repeat after 45ms\r
+#define SAMSUNG_1_PAUSE_TIME                    1650.0e-6                       // 1650 usec pause\r
+#define SAMSUNG_0_PAUSE_TIME                     550.0e-6                       //  550 usec pause\r
+\r
+#define SAMSUNG_FRAME_REPEAT_PAUSE_TIME           25.0e-3                       // frame repeat after 25ms\r
 #define SAMSUNG_ADDRESS_OFFSET                   0                              // skip 0 bits\r
 #define SAMSUNG_ADDRESS_LEN                     16                              // read 16 address bits\r
 #define SAMSUNG_ID_OFFSET                       17                              // skip 16 + 1 sync bit\r
@@ -135,9 +154,9 @@ typedef uint8_t     PAUSE_LEN;
 #define SAMSUNG32_COMMAND_OFFSET                16                              // skip 16 bits\r
 #define SAMSUNG32_COMMAND_LEN                   16                              // read 16 command bits\r
 #define SAMSUNG32_COMPLETE_DATA_LEN             32                              // complete length\r
-#define SAMSUNG32_FRAMES                        2                               // SAMSUNG32 sends each frame 2 times\r
+#define SAMSUNG32_FRAMES                        1                               // SAMSUNG32 sends each frame 1 times\r
 #define SAMSUNG32_AUTO_REPETITION_PAUSE_TIME    47.0e-3                         // repetition after 47 ms\r
-#define SAMSUNG32_FRAME_REPEAT_PAUSE_TIME       47.0e-3                         // frame repeat after 40ms\r
+#define SAMSUNG32_FRAME_REPEAT_PAUSE_TIME       47.0e-3                         // frame repeat after 47ms\r
 \r
 #define MATSUSHITA_START_BIT_PULSE_TIME         3488.0e-6                       // 3488 usec pulse\r
 #define MATSUSHITA_START_BIT_PAUSE_TIME         3488.0e-6                       // 3488 usec pause\r
@@ -189,8 +208,8 @@ typedef uint8_t     PAUSE_LEN;
 #define RC5_BIT_TIME                             889.0e-6                       // 889 usec pulse/pause\r
 #define RC5_FRAME_REPEAT_PAUSE_TIME               45.0e-3                       // frame repeat after 45ms\r
 \r
-#define RC5_ADDRESS_OFFSET                      2                               // skip 2 bits (2nd start + 1 toggle)\r
-#define RC5_ADDRESS_LEN                         5                               // read 5 address bits\r
+#define RC5_ADDRESS_OFFSET                      1                               // skip 1 bit (2nd start)\r
+#define RC5_ADDRESS_LEN                         6                               // read 1 toggle bit (for key repetition detection) + 5 address bits\r
 #define RC5_COMMAND_OFFSET                      7                               // skip 5 bits (2nd start + 1 toggle + 5 address)\r
 #define RC5_COMMAND_LEN                         6                               // read 6 command bits\r
 #define RC5_COMPLETE_DATA_LEN                   13                              // complete length\r
@@ -292,7 +311,7 @@ typedef uint8_t     PAUSE_LEN;
 #define GRUNDIG_NOKIA_IR60_FLAGS                (IRMP_PARAM_FLAG_IS_MANCHESTER | IRMP_PARAM_FLAG_1ST_PULSE_IS_1)  // flags\r
 \r
 #define GRUNDIG_FRAMES                          2                               // GRUNDIG sends each frame 1+1 times\r
-#define GRUNDIG_AUTO_REPETITION_PAUSE_TIME        20.0e-3                       // repetition after 20ms\r
+#define GRUNDIG_AUTO_REPETITION_PAUSE_TIME      20.0e-3                         // repetition after 20ms\r
 #define GRUNDIG_ADDRESS_OFFSET                  0                               // no address\r
 #define GRUNDIG_ADDRESS_LEN                     0                               // no address\r
 #define GRUNDIG_COMMAND_OFFSET                  1                               // skip 1 start bit\r
@@ -300,13 +319,15 @@ typedef uint8_t     PAUSE_LEN;
 #define GRUNDIG_COMPLETE_DATA_LEN               10                              // complete length: 1 start bit + 9 data bits\r
 \r
 #define NOKIA_FRAMES                            3                               // NOKIA sends each frame 1 + 1 + 1 times\r
-#define NOKIA_AUTO_REPETITION_PAUSE_TIME          20.0e-3                       // repetition after 20ms\r
+#define NOKIA_AUTO_REPETITION_PAUSE_TIME        20.0e-3                         // repetition after 20ms\r
 #define NOKIA_ADDRESS_OFFSET                    9                               // skip 9 bits (1 start bit + 8 data bits)\r
 #define NOKIA_ADDRESS_LEN                       8                               // 7 address bits\r
 #define NOKIA_COMMAND_OFFSET                    1                               // skip 1 bit (1 start bit)\r
 #define NOKIA_COMMAND_LEN                       8                               // read 8 command bits\r
 #define NOKIA_COMPLETE_DATA_LEN                 17                              // complete length: 1 start bit + 8 address bits + 8 command bits\r
 \r
+#define IR60_FRAMES                             2                               // IR60 sends each frame 1+1 times\r
+#define IR60_AUTO_REPETITION_PAUSE_TIME         22.2e-3                         // repetition after 22.2ms\r
 #define IR60_TIMEOUT_TIME                       5000.0e-6                       // timeout grundig frame, switch to IR60\r
 #define IR60_ADDRESS_OFFSET                     0                               // skip 1 bits\r
 #define IR60_ADDRESS_LEN                        0                               // read 0 address bits\r
@@ -384,7 +405,7 @@ typedef uint8_t     PAUSE_LEN;
 \r
 #define NIKON_START_BIT_PULSE_TIME              2200.0e-6                       //  2200 usec pulse\r
 #define NIKON_START_BIT_PAUSE_TIME             27100.0e-6                       // 27100 usec pause\r
-#define NIKON_PULSE_TIME                         500.0e-6                       //   520 usec pulse\r
+#define NIKON_PULSE_TIME                         500.0e-6                       //   500 usec pulse\r
 #define NIKON_1_PAUSE_TIME                      3500.0e-6                       //  3500 usec pause\r
 #define NIKON_0_PAUSE_TIME                      1500.0e-6                       //  1500 usec pause\r
 #define NIKON_FRAME_REPEAT_PAUSE_TIME             60.0e-3                       // frame repeat after 60ms\r
@@ -432,21 +453,35 @@ typedef uint8_t     PAUSE_LEN;
 #define NETBOX_LSB                              1                               // LSB\r
 #define NETBOX_FLAGS                            IRMP_PARAM_FLAG_IS_SERIAL       // flags\r
 \r
-#define IMON_START_BIT_PULSE_TIME               1333.0e-6                       // 1333 usec pulse\r
-#define IMON_START_BIT_PAUSE_TIME               1172.0e-6                       // 1333 usec pause\r
-#define IMON_PULSE_TIME                          500.0e-6                       //  500 usec pulse\r
-#define IMON_PAUSE_TIME                          500.0e-6                       //  500 usec pause\r
-#define IMON_FRAMES                             1                               // Imon sends 1 frame\r
-#define IMON_AUTO_REPETITION_PAUSE_TIME         35.0e-3                         // auto repetition after 35ms\r
-#define IMON_FRAME_REPEAT_PAUSE_TIME            35.0e-3                         // frame repeat after 35ms\r
-#define IMON_ADDRESS_OFFSET                     0                               // skip 0 bits\r
-#define IMON_ADDRESS_LEN                        0                               // read 0 address bits\r
-#define IMON_COMMAND_OFFSET                     26                              // skip 26 bits\r
-#define IMON_COMMAND_LEN                        16                              // read last 16 bits, ignore rest\r
-#define IMON_COMPLETE_DATA_LEN                  42                              // complete length, last is stop bit\r
-#define IMON_STOP_BIT                           1                               // has stop bit\r
-#define IMON_LSB                                1                               // LSB\r
-#define IMON_FLAGS                              IRMP_PARAM_FLAG_IS_SERIAL       // flags\r
+#define LEGO_START_BIT_PULSE_TIME                158.0e-6                       //  158 usec pulse ( 6 x 1/38kHz)\r
+#define LEGO_START_BIT_PAUSE_TIME               1026.0e-6                       // 1026 usec pause (39 x 1/38kHz)\r
+#define LEGO_PULSE_TIME                          158.0e-6                       //  158 usec pulse ( 6 x 1/38kHz)\r
+#define LEGO_1_PAUSE_TIME                        553.0e-6                       //  553 usec pause (21 x 1/38kHz)\r
+#define LEGO_0_PAUSE_TIME                        263.0e-6                       //  263 usec pause (10 x 1/38kHz)\r
+#define LEGO_FRAME_REPEAT_PAUSE_TIME              40.0e-3                       // frame repeat after 40ms\r
+#define LEGO_ADDRESS_OFFSET                     0                               // skip 0 bits\r
+#define LEGO_ADDRESS_LEN                        0                               // read 0 address bits\r
+#define LEGO_COMMAND_OFFSET                     0                               // skip 0 bits\r
+#define LEGO_COMMAND_LEN                        16                              // read 16 bits (12 command + 4 CRC)\r
+#define LEGO_COMPLETE_DATA_LEN                  16                              // complete length\r
+#define LEGO_STOP_BIT                           1                               // has stop bit\r
+#define LEGO_LSB                                0                               // MSB...LSB\r
+#define LEGO_FLAGS                              0                               // flags\r
+\r
+#define THOMSON_PULSE_TIME                       550.0e-6                       //  550 usec pulse\r
+#define THOMSON_1_PAUSE_TIME                    4500.0e-6                       // 4500 usec pause\r
+#define THOMSON_0_PAUSE_TIME                    2000.0e-6                       // 2000 usec pause\r
+#define THOMSON_FRAMES                          1                               // THOMSON sends 1 frame\r
+#define THOMSON_AUTO_REPETITION_PAUSE_TIME        65.0e-3                       // repetition after 65ms\r
+#define THOMSON_FRAME_REPEAT_PAUSE_TIME           65.0e-3                       // frame repeat after 65ms\r
+#define THOMSON_ADDRESS_OFFSET                  0                               // skip 0 bits\r
+#define THOMSON_ADDRESS_LEN                     4                               // read 4 address bits\r
+#define THOMSON_COMMAND_OFFSET                  5                               // skip 4 address bits + 1 toggle bit\r
+#define THOMSON_COMMAND_LEN                     7                               // read 7 command bits\r
+#define THOMSON_COMPLETE_DATA_LEN               12                              // complete length\r
+#define THOMSON_STOP_BIT                        1                               // has stop bit\r
+#define THOMSON_LSB                             0                               // MSB...LSB\r
+#define THOMSON_FLAGS                           0                               // flags\r
 \r
 #define AUTO_FRAME_REPETITION_TIME              80.0e-3                         // SIRCS/SAMSUNG32/NUBERT: automatic repetition after 25-50ms\r
                                                                                 // KASEIKYO: automatic repetition after 75ms\r
@@ -464,29 +499,17 @@ typedef struct
   uint8_t               flags;                                                  // flags, e.g. repetition\r
 } IRMP_DATA;\r
 \r
+extern void                             irmp_init (void);\r
+extern uint8_t                          irmp_get_data (IRMP_DATA *);\r
+extern uint8_t                          irmp_is_busy (void);\r
+extern uint8_t                          irmp_ISR (void);\r
 \r
-/**\r
- *  Initialize IRMP decoder\r
- *  @details  Configures IRMP input pin\r
- */\r
-extern void                           irmp_init (void);\r
-\r
-/**\r
- *  Get IRMP data\r
- *  @details  gets decoded IRMP data\r
- *  @param    pointer in order to store IRMP data\r
- *  @return    TRUE: successful, FALSE: failed\r
- */\r
-extern uint8_t                        irmp_get_data (IRMP_DATA *);\r
-\r
-/**\r
- *  ISR routine\r
- *  @details  ISR routine, called 10000 times per second\r
- */\r
-extern uint8_t                        irmp_ISR (void);\r
-\r
-#ifdef __cplusplus\r
-}\r
+#if IRMP_PROTOCOL_NAMES == 1\r
+extern char *                           irmp_protocol_names[IRMP_N_PROTOCOLS + 1];\r
 #endif\r
 \r
+#if IRMP_USE_CALLBACK == 1\r
+extern void                             irmp_set_callback_ptr (void (*cb)(uint8_t));\r
+#endif // IRSND_USE_CALLBACK == 1\r
+\r
 #endif /* _WC_IRMP_H_ */\r