]> cloudbase.mooo.com Git - irmp.git/blobdiff - irmpconfig.h
Version 2.3.10: added ROOMBA protocol in IRSND
[irmp.git] / irmpconfig.h
index 4507669fb22892de54566b16a61048eb3bf36f5a..a930c7f72dbce838fc41d5791d00f12ec2069eac 100644 (file)
@@ -1,9 +1,11 @@
 /*---------------------------------------------------------------------------------------------------------------------------------------------------\r
  * irmpconfig.h\r
  *\r
- * Copyright (c) 2010 Frank Meyer - frank(at)fli4l.de\r
+ * DO NOT INCLUDE THIS FILE, WILL BE INCLUDED BY IRMP.H!\r
  *\r
- * $Id: irmpconfig.h,v 1.63 2011/03/10 12:29:14 fm Exp $\r
+ * Copyright (c) 2009-2013 Frank Meyer - frank(at)fli4l.de\r
+ *\r
+ * $Id: irmpconfig.h,v 1.101 2013/04/09 12:02:51 fm Exp $\r
  *\r
  * ATMEGA88 @ 8 MHz\r
  *\r
 #ifndef _IRMPCONFIG_H_\r
 #define _IRMPCONFIG_H_\r
 \r
+#ifndef _IRMP_H_\r
+#  error please include only irmp.h, not irmpconfig.h\r
+#endif\r
+\r
 /*---------------------------------------------------------------------------------------------------------------------------------------------------\r
  * Change F_INTERRUPTS if you change the number of interrupts per second,\r
  * Normally, F_INTERRUPTS should be in the range from 10000 to 15000, typical is 15000\r
@@ -24,7 +30,7 @@
  *---------------------------------------------------------------------------------------------------------------------------------------------------\r
  */\r
 #ifndef F_INTERRUPTS\r
-#define F_INTERRUPTS                            15000   // interrupts per second, min: 10000, max: 20000, typ: 15000\r
+#  define F_INTERRUPTS                          15000   // interrupts per second, min: 10000, max: 20000, typ: 15000\r
 #endif\r
 \r
 /*---------------------------------------------------------------------------------------------------------------------------------------------------\r
  * 0 disable decoder\r
  *\r
  * The standard decoders are enabled per default.\r
- * Some less common protocols are disabled here, you need to enable them manually.\r
+ * Less common protocols are disabled here, you need to enable them manually.\r
  *\r
  * If you want to use FDC or RCCAR simultaneous with RC5 protocol, additional program space is required.\r
  * If you don't need RC5 when using FDC/RCCAR, you should disable RC5.\r
+ * You cannot enable both DENON and RUWIDO, only enable one of them.\r
  *---------------------------------------------------------------------------------------------------------------------------------------------------\r
  */\r
 \r
-// Typical Protocols, disable here!             Enable  Remarks                 F_INTERRUPTS            Program Space\r
+// typical protocols, disable here!             Enable  Remarks                 F_INTERRUPTS            Program Space\r
 #define IRMP_SUPPORT_SIRCS_PROTOCOL             1       // Sony SIRCS           >= 10000                 ~150 bytes\r
 #define IRMP_SUPPORT_NEC_PROTOCOL               1       // NEC + APPLE          >= 10000                 ~300 bytes\r
 #define IRMP_SUPPORT_SAMSUNG_PROTOCOL           1       // Samsung + Samsung32  >= 10000                 ~300 bytes\r
 #define IRMP_SUPPORT_MATSUSHITA_PROTOCOL        1       // Matsushita           >= 10000                  ~50 bytes\r
 #define IRMP_SUPPORT_KASEIKYO_PROTOCOL          1       // Kaseikyo             >= 10000                 ~250 bytes\r
 #define IRMP_SUPPORT_DENON_PROTOCOL             1       // DENON, Sharp         >= 10000                 ~250 bytes\r
-#define IRMP_SUPPORT_RC5_PROTOCOL               1       // RC5                  >= 10000                 ~250 bytes\r
 \r
-// More Protocols, enable here!                 Enable  Remarks                 F_INTERRUPTS            Program Space\r
+// more protocols, enable here!                 Enable  Remarks                 F_INTERRUPTS            Program Space\r
+#define IRMP_SUPPORT_RC5_PROTOCOL               0       // RC5                  >= 10000                 ~250 bytes\r
+#define IRMP_SUPPORT_RC6_PROTOCOL               0       // RC6 & RC6A           >= 10000                 ~250 bytes\r
 #define IRMP_SUPPORT_JVC_PROTOCOL               0       // JVC                  >= 10000                 ~150 bytes\r
 #define IRMP_SUPPORT_NEC16_PROTOCOL             0       // NEC16                >= 10000                 ~100 bytes\r
-#define IRMP_SUPPORT_NEC42_PROTOCOL             0       // NEC42                >= 10000                 ~100 bytes\r
-#define IRMP_SUPPORT_RC6_PROTOCOL               0       // RC6 & RC6A           >= 10000                 ~250 bytes\r
-#define IRMP_SUPPORT_IR60_PROTOCOL              0       // IR60 (SAB2008)       >= 10000                 ~300 bytes\r
+#define IRMP_SUPPORT_NEC42_PROTOCOL             0       // NEC42                >= 10000                 ~300 bytes\r
+#define IRMP_SUPPORT_IR60_PROTOCOL              0       // IR60 (SDA2008)       >= 10000                 ~300 bytes\r
 #define IRMP_SUPPORT_GRUNDIG_PROTOCOL           0       // Grundig              >= 10000                 ~300 bytes\r
+#define IRMP_SUPPORT_SIEMENS_PROTOCOL           0       // Siemens Gigaset      >= 15000                 ~550 bytes\r
 #define IRMP_SUPPORT_NOKIA_PROTOCOL             0       // Nokia                >= 10000                 ~300 bytes\r
+\r
+// exotic protocols, enable here!               Enable  Remarks                 F_INTERRUPTS            Program Space\r
+#define IRMP_SUPPORT_BOSE_PROTOCOL              0       // BOSE                 >= 10000                 ~150 bytes\r
 #define IRMP_SUPPORT_KATHREIN_PROTOCOL          0       // Kathrein             >= 10000                 ~200 bytes\r
 #define IRMP_SUPPORT_NUBERT_PROTOCOL            0       // NUBERT               >= 10000                  ~50 bytes\r
 #define IRMP_SUPPORT_BANG_OLUFSEN_PROTOCOL      0       // Bang & Olufsen       >= 10000                 ~200 bytes\r
-#define IRMP_SUPPORT_NIKON_PROTOCOL             0       // NIKON                >= 10000                 ~250 bytes\r
+#define IRMP_SUPPORT_RECS80_PROTOCOL            0       // RECS80 (SAA3004)     >= 15000                  ~50 bytes\r
+#define IRMP_SUPPORT_RECS80EXT_PROTOCOL         0       // RECS80EXT (SAA3008)  >= 15000                  ~50 bytes\r
+#define IRMP_SUPPORT_THOMSON_PROTOCOL           0       // Thomson              >= 10000                 ~250 bytes\r
+#define IRMP_SUPPORT_NIKON_PROTOCOL             0       // NIKON camera         >= 10000                 ~250 bytes\r
 #define IRMP_SUPPORT_NETBOX_PROTOCOL            0       // Netbox keyboard      >= 10000                 ~400 bytes (PROTOTYPE!)\r
-#define IRMP_SUPPORT_IMON_PROTOCOL              0       // IMON keyboard        >= 10000                 ~400 bytes (PROTOTYPE!)\r
+#define IRMP_SUPPORT_ORTEK_PROTOCOL             0       // ORTEK (Hama)         >= 10000                 ~150 bytes\r
+#define IRMP_SUPPORT_TELEFUNKEN_PROTOCOL        0       // Telefunken 1560      >= 10000                 ~150 bytes\r
 #define IRMP_SUPPORT_FDC_PROTOCOL               0       // FDC3402 keyboard     >= 10000 (better 15000)  ~150 bytes (~400 in combination with RC5)\r
 #define IRMP_SUPPORT_RCCAR_PROTOCOL             0       // RC Car               >= 10000 (better 15000)  ~150 bytes (~500 in combination with RC5)\r
-#define IRMP_SUPPORT_SIEMENS_PROTOCOL           0       // Siemens Gigaset      >= 15000                 ~550 bytes\r
+#define IRMP_SUPPORT_ROOMBA_PROTOCOL            0       // iRobot Roomba        >= 10000                 ~150 bytes\r
 #define IRMP_SUPPORT_RUWIDO_PROTOCOL            0       // RUWIDO, T-Home       >= 15000                 ~550 bytes\r
-#define IRMP_SUPPORT_RECS80_PROTOCOL            0       // RECS80 (SAA3004)     >= 15000                  ~50 bytes\r
-#define IRMP_SUPPORT_RECS80EXT_PROTOCOL         0       // RECS80EXT (SAA3008)  >= 15000                  ~50 bytes\r
+#define IRMP_SUPPORT_A1TVBOX_PROTOCOL           0       // A1 TV BOX            >= 15000 (better 20000)  ~300 bytes\r
+#define IRMP_SUPPORT_LEGO_PROTOCOL              0       // LEGO Power RC        >= 20000                 ~150 bytes\r
+\r
 \r
 /*---------------------------------------------------------------------------------------------------------------------------------------------------\r
- * Change hardware pin here:\r
+ * Change hardware pin here for ATMEL AVR\r
  *---------------------------------------------------------------------------------------------------------------------------------------------------\r
  */\r
-#ifdef PIC_CCS_COMPILER                                 // PIC CCS Compiler:\r
+#if defined (ATMEL_AVR)                                                 // use PB6 as IR input on AVR\r
+#  define IRMP_PORT_LETTER                      B\r
+#  define IRMP_BIT_NUMBER                       6\r
 \r
-#define IRMP_PIN                                PIN_B4  // use PB4 as IR input on PIC\r
+/*---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ * Change hardware pin here for PIC C18 compiler\r
+ *---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ */\r
+#elif defined (PIC_C18)                                                 // use RB4 as IR input on PIC\r
+#  define IRMP_PIN                              PORTBbits.RB4\r
 \r
-#else                                                   // AVR:\r
+/*---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ * Change hardware pin here for PIC CCS compiler\r
+ *---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ */\r
+#elif defined (PIC_CCS)\r
+#  define IRMP_PIN                              PIN_B4                  // use PB4 as IR input on PIC\r
 \r
-#define IRMP_PORT                               PORTB\r
-#define IRMP_DDR                                DDRB\r
-#define IRMP_PIN                                PINB\r
-#define IRMP_BIT                                6       // use PB6 as IR input on AVR\r
+/*---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ * Change hardware pin here for ARM STM32\r
+ *---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ */\r
+#elif defined (ARM_STM32)                                               // use C13 as IR input on STM32\r
+#  define IRMP_PORT_LETTER                      C\r
+#  define IRMP_BIT_NUMBER                       13\r
 \r
-#define input(x)                                ((x) & (1 << IRMP_BIT))\r
+/*---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ * Change hardware pin here for Stellaris ARM Cortex M4\r
+ *---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ */\r
+#elif defined (STELLARIS_ARM_CORTEX_M4)                                 // use B4 as IR input on Stellaris LM4F\r
+#  define IRMP_PORT_LETTER                      B\r
+#  define IRMP_BIT_NUMBER                       4\r
+\r
+/*---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ * Handling of unknown target system: DON'T CHANGE\r
+ *---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ */\r
+#elif !defined (UNIX_OR_WINDOWS)\r
+#  error target system not defined.\r
 #endif\r
 \r
 /*---------------------------------------------------------------------------------------------------------------------------------------------------\r
  *---------------------------------------------------------------------------------------------------------------------------------------------------\r
  */\r
 #ifndef IRMP_LOGGING\r
-#define IRMP_LOGGING                            0       // 1: log IR signal (scan), 0: do not (default)\r
+#  define IRMP_LOGGING                          0       // 1: log IR signal (scan), 0: do not. default is 0\r
 #endif\r
 \r
 /*---------------------------------------------------------------------------------------------------------------------------------------------------\r
- * DO NOT CHANGE THE FOLLOWING LINES !\r
+ * Use external logging routines\r
+ * If you enable external logging, you have also to enable IRMP_LOGGING above\r
  *---------------------------------------------------------------------------------------------------------------------------------------------------\r
  */\r
-#if IRMP_SUPPORT_SIEMENS_PROTOCOL == 1 && F_INTERRUPTS < 15000\r
-#warning F_INTERRUPTS too low, SIEMENS protocol disabled (should be at least 15000)\r
-#undef IRMP_SUPPORT_SIEMENS_PROTOCOL\r
-#define IRMP_SUPPORT_SIEMENS_PROTOCOL           0\r
-#endif\r
-\r
-#if IRMP_SUPPORT_RUWIDO_PROTOCOL == 1 && F_INTERRUPTS < 15000\r
-#warning F_INTERRUPTS too low, RUWIDO protocol disabled (should be at least 15000)\r
-#undef IRMP_SUPPORT_RUWIDO_PROTOCOL\r
-#define IRMP_SUPPORT_RUWIDO_PROTOCOL            0\r
-#endif\r
-\r
-#if IRMP_SUPPORT_RECS80_PROTOCOL == 1 && F_INTERRUPTS < 15000\r
-#warning F_INTERRUPTS too low, RECS80 protocol disabled (should be at least 15000)\r
-#undef IRMP_SUPPORT_RECS80_PROTOCOL\r
-#define IRMP_SUPPORT_RECS80_PROTOCOL            0\r
-#endif\r
-\r
-#if IRMP_SUPPORT_RECS80EXT_PROTOCOL == 1 && F_INTERRUPTS < 15000\r
-#warning F_INTERRUPTS too low, RECS80EXT protocol disabled (should be at least 15000)\r
-#undef IRMP_SUPPORT_RECS80EXT_PROTOCOL\r
-#define IRMP_SUPPORT_RECS80EXT_PROTOCOL         0\r
-#endif\r
-\r
-#if IRMP_SUPPORT_JVC_PROTOCOL == 1 && IRMP_SUPPORT_NEC_PROTOCOL == 0\r
-#warning JVC protocol needs also NEC protocol, NEC protocol enabled\r
-#undef IRMP_SUPPORT_NEC_PROTOCOL\r
-#define IRMP_SUPPORT_NEC_PROTOCOL               1\r
+#ifndef IRMP_EXT_LOGGING\r
+#  define IRMP_EXT_LOGGING                      0       // 1: use external logging, 0: do not. default is 0\r
 #endif\r
 \r
-#if IRMP_SUPPORT_NEC16_PROTOCOL == 1 && IRMP_SUPPORT_NEC_PROTOCOL == 0\r
-#warning NEC16 protocol needs also NEC protocol, NEC protocol enabled\r
-#undef IRMP_SUPPORT_NEC_PROTOCOL\r
-#define IRMP_SUPPORT_NEC_PROTOCOL               1\r
-#endif\r
-\r
-#if IRMP_SUPPORT_NEC42_PROTOCOL == 1 && IRMP_SUPPORT_NEC_PROTOCOL == 0\r
-#warning NEC42 protocol needs also NEC protocol, NEC protocol enabled\r
-#undef IRMP_SUPPORT_NEC_PROTOCOL\r
-#define IRMP_SUPPORT_NEC_PROTOCOL               1\r
+/*---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ * Set IRMP_PROTOCOL_NAMES to 1 if want to access protocol names (for logging etc), costs ~300 bytes RAM!\r
+ *---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ */\r
+#ifndef IRMP_PROTOCOL_NAMES\r
+#  define IRMP_PROTOCOL_NAMES                   0       // 1: access protocol names, 0: do not. default is 0\r
 #endif\r
 \r
-#if F_INTERRUPTS > 20000\r
-#error F_INTERRUPTS too high (should be not greater than 20000)\r
+/*---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ * Use Callbacks to indicate input signal\r
+ *---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ */\r
+#ifndef IRMP_USE_CALLBACK\r
+#  define IRMP_USE_CALLBACK                     0       // 1: use callbacks. 0: do not. default is 0\r
 #endif\r
 \r
 #endif /* _WC_IRMPCONFIG_H_ */\r