]> cloudbase.mooo.com Git - irmp.git/blobdiff - irmpconfig.h
Version 2.6.5: corrected PROGMEM access to irmp_protocol_names[]
[irmp.git] / irmpconfig.h
index bc9d972705fb4c03e3a1a0bed7ad28a6b7285b6e..6239e83683e982b6ea805fffbf0ca2264b33c9b7 100644 (file)
@@ -1,11 +1,12 @@
 /*---------------------------------------------------------------------------------------------------------------------------------------------------\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.5 2010/05/15 17:56:24 fm Exp $\r
+ * Copyright (c) 2009-2014 Frank Meyer - frank(at)fli4l.de\r
+ * Extensions for PIC 12F1820 W.Strobl 2014-07-20\r
  *\r
- * ATMEGA88 @ 8 MHz\r
+ * $Id: irmpconfig.h,v 1.121 2014/09/15 12:36:28 fm Exp $\r
  *\r
  * This program is free software; you can redistribute it and/or modify\r
  * it under the terms of the GNU General Public License as published by\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, F_INTERRUPTS should be in the range from 10000 to 15000\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
+ * A value above 15000 costs additional program space, absolute maximum value is 20000.\r
+ * On PIC with XC8/C18 Compiler, use 15151 as the correct value.\r
  *---------------------------------------------------------------------------------------------------------------------------------------------------\r
  */\r
-#define F_INTERRUPTS                            10000   // interrupts per second\r
+#ifndef F_INTERRUPTS\r
+#  define F_INTERRUPTS                          15000   // interrupts per second, min: 10000, max: 20000, typ: 15000\r
+#endif\r
 \r
 /*---------------------------------------------------------------------------------------------------------------------------------------------------\r
  * Change settings from 1 to 0 if you want to disable one or more decoders.\r
  * This saves program space.\r
+ *\r
  * 1 enable  decoder\r
  * 0 disable decoder\r
+ *\r
+ * The standard decoders are enabled per default.\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
-#define IRMP_SUPPORT_SIRCS_PROTOCOL             1       // flag: support SIRCS                      uses ~100 bytes\r
-#define IRMP_SUPPORT_NEC_PROTOCOL               1       // flag: support NEC + APPLE                uses ~250 bytes\r
-#define IRMP_SUPPORT_SAMSUNG_PROTOCOL           1       // flag: support Samsung + Samsung32        uses ~250 bytes\r
-#define IRMP_SUPPORT_MATSUSHITA_PROTOCOL        1       // flag: support Matsushita                 uses  ~50 bytes\r
-#define IRMP_SUPPORT_KASEIKYO_PROTOCOL          1       // flag: support Kaseikyo                   uses  ~50 bytes\r
-#define IRMP_SUPPORT_RECS80_PROTOCOL            1       // flag: support RECS80                     uses  ~50 bytes\r
-#define IRMP_SUPPORT_RC5_PROTOCOL               1       // flag: support RC5                        uses ~250 bytes\r
-#define IRMP_SUPPORT_DENON_PROTOCOL             1       // flag: support DENON                      uses ~250 bytes\r
-#define IRMP_SUPPORT_RC6_PROTOCOL               1       // flag: support RC6                        uses ~200 bytes\r
-#define IRMP_SUPPORT_RECS80EXT_PROTOCOL         1       // flag: support RECS80EXT                  uses  ~50 bytes\r
-#define IRMP_SUPPORT_NUBERT_PROTOCOL            1       // flag: support NUBERT                     uses  ~50 bytes\r
-#define IRMP_SUPPORT_BANG_OLUFSEN_PROTOCOL      1       // flag: support Bang & Olufsen             uses ~200 bytes\r
-#define IRMP_SUPPORT_GRUNDIG_PROTOCOL           1       // flag: support Grundig                    uses ~150 bytes\r
+\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 + Samsg32    >= 10000                 ~300 bytes\r
+#define IRMP_SUPPORT_KASEIKYO_PROTOCOL          1       // Kaseikyo             >= 10000                 ~250 bytes\r
+\r
+// more protocols, enable here!                 Enable  Remarks                 F_INTERRUPTS            Program Space\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                 ~300 bytes\r
+#define IRMP_SUPPORT_MATSUSHITA_PROTOCOL        0       // Matsushita           >= 10000                  ~50 bytes\r
+#define IRMP_SUPPORT_DENON_PROTOCOL             0       // DENON, Sharp         >= 10000                 ~250 bytes\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_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_SPEAKER_PROTOCOL           0       // SPEAKER (~NUBERT)    >= 10000                  ~50 bytes\r
+#define IRMP_SUPPORT_BANG_OLUFSEN_PROTOCOL      0       // Bang & Olufsen       >= 10000                 ~200 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_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_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_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
+#define IRMP_SUPPORT_RCMM_PROTOCOL              0       // RCMM 12,24, or 32    >= 20000                 ~150 bytes\r
+#define IRMP_SUPPORT_LGAIR_PROTOCOL             0       // LG Air Condition     >= 10000                 ~300 bytes\r
+#define IRMP_SUPPORT_SAMSUNG48_PROTOCOL         0       // Samsung48            >= 10000                 ~100 bytes (SAMSUNG must be enabled!)\r
+#define IRMP_SUPPORT_RADIO1_PROTOCOL            0       // RADIO, e.g. TEVION   >= 10000                 ~250 bytes (experimental)\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 or XC8 compiler\r
+ *---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ */\r
+#elif defined (PIC_C18)                                                 // use RB4 as IR input on PIC (C18 or XC8 compiler)\r
+#if defined(__12F1840)\r
+#  define IRMP_PIN                              RA5                     // on 12F1840 with XC8 compiler\r
+#endif\r
+#  define IRMP_PIN                              PORTBbits.RB4           // PIC C18\r
+\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 (CCS compiler)\r
 \r
-#else                                                   // 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 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 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
-#define input(x)                                ((x) & (1 << IRMP_BIT))\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
  * Set IRMP_LOGGING to 1 if want to log data to UART with 9600Bd\r
  *---------------------------------------------------------------------------------------------------------------------------------------------------\r
  */\r
-#define IRMP_LOGGING                            0                             // 1: log IR signal (scan), 0: do not (default)\r
+#ifndef IRMP_LOGGING\r
+#  define IRMP_LOGGING                          0       // 1: log IR signal (scan), 0: do not. default is 0\r
+#endif\r
+\r
+/*---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ * Use external logging routines\r
+ * If you enable external logging, you have also to enable IRMP_LOGGING above\r
+ *---------------------------------------------------------------------------------------------------------------------------------------------------\r
+ */\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
+/*---------------------------------------------------------------------------------------------------------------------------------------------------\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
+/*---------------------------------------------------------------------------------------------------------------------------------------------------\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