irmp.h

   1 /*---------------------------------------------------------------------------------------------------------------------------------------------------
   2  * irmp.h
   3  *
   4  * Copyright (c) 2009-2010 Frank Meyer - frank(at)fli4l.de
   5  *
   6  * $Id: irmp.h,v 1.11 2010/03/29 09:33:29 fm Exp $
   7  *
   8  * ATMEGA88 @ 8 MHz
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *---------------------------------------------------------------------------------------------------------------------------------------------------
  15  */
  16
  17 #ifndef _WC_IRMP_H_
  18 #define _WC_IRMP_H_
  19
  20 #ifdef __cplusplus
  21 extern "C"
  22 {
  23 #endif
  24
  25 /*---------------------------------------------------------------------------------------------------------------------------------------------------
  26  * IR protocols
  27  *---------------------------------------------------------------------------------------------------------------------------------------------------
  28  */
  29 #define IRMP_SIRCS_PROTOCOL                      1                            // Sony
  30 #define IRMP_NEC_PROTOCOL                        2                            // NEC, Pioneer, JVC, Toshiba, NoName etc.
  31 #define IRMP_SAMSUNG_PROTOCOL                    3                            // Samsung
  32 #define IRMP_MATSUSHITA_PROTOCOL                 4                            // Matsushita
  33 #define IRMP_KASEIKYO_PROTOCOL                   5                            // Kaseikyo (Panasonic etc)
  34 #define IRMP_RECS80_PROTOCOL                     6                            // Philips, Thomson, Nordmende, Telefunken, Saba
  35 #define IRMP_RC5_PROTOCOL                        7                            // Philips etc
  36 #define IRMP_DENON_PROTOCOL                      8                            // Denon
  37 #define IRMP_RC6_PROTOCOL                        9                            // Philips etc
  38 #define IRMP_SAMSUNG32_PROTOCOL                 10                            // Samsung32: no sync pulse at bit 16, length 32 instead of 37
  39 #define IRMP_APPLE_PROTOCOL                     11                            // Apple, very similar to NEC
  40 #define IRMP_RECS80EXT_PROTOCOL                 12                            // Philips, Technisat, Thomson, Nordmende, Telefunken, Saba
  41 #define IRMP_NUBERT_PROTOCOL                    13                            // Nubert
  42
  43 #define SIRCS_START_BIT_PULSE_TIME              2400.0e-6                     // 2400 usec pulse
  44 #define SIRCS_START_BIT_PAUSE_TIME               600.0e-6                     //  600 usec pause
  45 #define SIRCS_1_PULSE_TIME                      1200.0e-6                     // 1200 usec pulse
  46 #define SIRCS_0_PULSE_TIME                       600.0e-6                     //  600 usec pulse
  47 #define SIRCS_PAUSE_TIME                         600.0e-6                     //  600 usec pause
  48 #define SIRCS_REPETITION_TIME                     45.0e-3                     // repetition after 45ms
  49 #define SIRCS_REPETITION_CNT                    3                             // SIRCS repeats each frame 3 times
  50 #define SIRCS_ADDRESS_OFFSET                    15                            // skip 15 bits
  51 #define SIRCS_ADDRESS_LEN                       5                             // read up to 5 address bits
  52 #define SIRCS_COMMAND_OFFSET                    0                             // skip 0 bits
  53 #define SIRCS_COMMAND_LEN                       15                            // read 12-15 command bits
  54 #define SIRCS_MINIMUM_DATA_LEN                  12                            // minimum data length
  55 #define SIRCS_COMPLETE_DATA_LEN                 20                            // complete length - may be up to 20
  56 #define SIRCS_STOP_BIT                          0                             // has no stop bit
  57 #define SIRCS_LSB                               1                             // LSB...MSB
  58
  59 #define NEC_START_BIT_PULSE_TIME                9000.0e-6                     // 9000 usec pulse
  60 #define NEC_START_BIT_PAUSE_TIME                4500.0e-6                     // 4500 usec pause
  61 #define NEC_REPEAT_START_BIT_PAUSE_TIME         2250.0e-6                     // 2250 usec pause
  62 #define NEC_PULSE_TIME                           560.0e-6                     //  560 usec pulse
  63 #define NEC_1_PAUSE_TIME                        1690.0e-6                     // 1690 usec pause
  64 #define NEC_0_PAUSE_TIME                         560.0e-6                     //  560 usec pause
  65 #define NEC_ADDRESS_OFFSET                       0                            // skip 0 bits
  66 #define NEC_ADDRESS_LEN                         16                            // read 16 address bits
  67 #define NEC_COMMAND_OFFSET                      16                            // skip 16 bits (8 address + 8 /address)
  68 #define NEC_COMMAND_LEN                         16                            // read 16 bits (8 command + 8 /command)
  69 #define NEC_COMPLETE_DATA_LEN                   32                            // complete length
  70 #define NEC_STOP_BIT                            1                             // has stop bit
  71 #define NEC_LSB                                 1                             // LSB...MSB
  72
  73 #define SAMSUNG_START_BIT_PULSE_TIME            4500.0e-6                     // 4500 usec pulse
  74 #define SAMSUNG_START_BIT_PAUSE_TIME            4500.0e-6                     // 4500 usec pause
  75 #define SAMSUNG_PULSE_TIME                       550.0e-6                     //  550 usec pulse
  76 #define SAMSUNG_1_PAUSE_TIME                    1450.0e-6                     // 1450 usec pause
  77 #define SAMSUNG_0_PAUSE_TIME                     450.0e-6                     //  450 usec pause
  78 #define SAMSUNG_ADDRESS_OFFSET                   0                            // skip 0 bits
  79 #define SAMSUNG_ADDRESS_LEN                     16                            // read 16 address bits
  80 #define SAMSUNG_ID_OFFSET                       17                            // skip 16 + 1 sync bit
  81 #define SAMSUNG_ID_LEN                          4                             // read 4 id bits
  82 #define SAMSUNG_COMMAND_OFFSET                  21                            // skip 16 + 1 sync + 4 data bits
  83 #define SAMSUNG_COMMAND_LEN                     16                            // read 16 command bits
  84 #define SAMSUNG_COMPLETE_DATA_LEN               37                            // complete length
  85 #define SAMSUNG_STOP_BIT                        1                             // has stop bit
  86 #define SAMSUNG_LSB                             1                             // LSB...MSB?
  87
  88 #define SAMSUNG32_COMMAND_OFFSET                16                            // skip 16 bits
  89 #define SAMSUNG32_COMMAND_LEN                   16                            // read 16 command bits
  90 #define SAMSUNG32_COMPLETE_DATA_LEN             32                            // complete length
  91
  92 #define MATSUSHITA_START_BIT_PULSE_TIME         3488.0e-6                     // 3488 usec pulse
  93 #define MATSUSHITA_START_BIT_PAUSE_TIME         3488.0e-6                     // 3488 usec pause
  94 #define MATSUSHITA_PULSE_TIME                    872.0e-6                     //  872 usec pulse
  95 #define MATSUSHITA_1_PAUSE_TIME                 2616.0e-6                     // 2616 usec pause
  96 #define MATSUSHITA_0_PAUSE_TIME                  872.0e-6                     //  872 usec pause
  97 #define MATSUSHITA_ADDRESS_OFFSET               12                            // skip 12 bits
  98 #define MATSUSHITA_ADDRESS_LEN                  12                            // read 12 address bits
  99 #define MATSUSHITA_COMMAND_OFFSET               0                             // skip 0 bits
 100 #define MATSUSHITA_COMMAND_LEN                  12                            // read 12 bits (6 custom + 6 command)
 101 #define MATSUSHITA_COMPLETE_DATA_LEN            24                            // complete length
 102 #define MATSUSHITA_STOP_BIT                     1                             // has stop bit
 103 #define MATSUSHITA_LSB                          1                             // LSB...MSB?
 104
 105 #define KASEIKYO_START_BIT_PULSE_TIME           3380.0e-6                     // 3380 usec pulse
 106 #define KASEIKYO_START_BIT_PAUSE_TIME           1690.0e-6                     // 1690 usec pause
 107 #define KASEIKYO_PULSE_TIME                      423.0e-6                     //  525 usec pulse
 108 #define KASEIKYO_1_PAUSE_TIME                   1269.0e-6                     //  525 usec pause
 109 #define KASEIKYO_0_PAUSE_TIME                    423.0e-6                     // 1690 usec pause
 110 #define KASEIKYO_ADDRESS_OFFSET                  0                            // skip 0 bits
 111 #define KASEIKYO_ADDRESS_LEN                    16                            // read 16 address bits
 112 #define KASEIKYO_COMMAND_OFFSET                 28                            // skip 28 bits (16 manufacturer & 4 parity & 8 genre)
 113 #define KASEIKYO_COMMAND_LEN                    12                            // read 12 command bits (10 real command & 2 id)
 114 #define KASEIKYO_COMPLETE_DATA_LEN              48                            // complete length
 115 #define KASEIKYO_STOP_BIT                       1                             // has stop bit
 116 #define KASEIKYO_LSB                            1                             // LSB...MSB?
 117
 118 #define RECS80_START_BIT_PULSE_TIME              158.0e-6                     //  158 usec pulse
 119 #define RECS80_START_BIT_PAUSE_TIME             7432.0e-6                     // 7432 usec pause
 120 #define RECS80_PULSE_TIME                        158.0e-6                     //  158 usec pulse
 121 #define RECS80_1_PAUSE_TIME                     7432.0e-6                     // 7432 usec pause
 122 #define RECS80_0_PAUSE_TIME                     4902.0e-6                     // 4902 usec pause
 123 #define RECS80_ADDRESS_OFFSET                   2                             // skip 2 bits (2nd start + 1 toggle)
 124 #define RECS80_ADDRESS_LEN                      3                             // read 3 address bits
 125 #define RECS80_COMMAND_OFFSET                   5                             // skip 5 bits (2nd start + 1 toggle + 3 address)
 126 #define RECS80_COMMAND_LEN                      6                             // read 6 command bits
 127 #define RECS80_COMPLETE_DATA_LEN                11                            // complete length
 128 #define RECS80_STOP_BIT                         1                             // has stop bit
 129 #define RECS80_LSB                              0                             // MSB...LSB
 130
 131 #define RC5_BIT_TIME                            889.0e-6                      // 889 usec pulse/pause
 132 #define RC5_ADDRESS_OFFSET                      2                             // skip 2 bits (2nd start + 1 toggle)
 133 #define RC5_ADDRESS_LEN                         5                             // read 5 address bits
 134 #define RC5_COMMAND_OFFSET                      7                             // skip 5 bits (2nd start + 1 toggle + 5 address)
 135 #define RC5_COMMAND_LEN                         6                             // read 6 command bits
 136 #define RC5_COMPLETE_DATA_LEN                   13                            // complete length
 137 #define RC5_STOP_BIT                            0                             // has no stop bit
 138 #define RC5_LSB                                 0                             // MSB...LSB
 139
 140 #define DENON_PULSE_TIME                        275.0e-6                      //  275 usec pulse
 141 #define DENON_1_PAUSE_TIME                      1900.0e-6                     // 1900 usec pause
 142 #define DENON_0_PAUSE_TIME                      1050.0e-6                     // 1050 usec pause
 143 #define DENON_REPETITION_TIME                     65.0e-3                     // inverted repetition after 65ms
 144 #define DENON_ADDRESS_OFFSET                    0                             // skip 0 bits
 145 #define DENON_ADDRESS_LEN                       5                             // read 5 address bits
 146 #define DENON_COMMAND_OFFSET                    5                             // skip 5
 147 #define DENON_COMMAND_LEN                       10                            // read 10 command bits
 148 #define DENON_COMPLETE_DATA_LEN                 15                            // complete length
 149 #define DENON_STOP_BIT                          1                             // has stop bit
 150 #define DENON_LSB                               0                             // MSB...LSB
 151
 152 #define RC6_START_BIT_PULSE_TIME                2666.0e-6                     // 2.666 msec pulse
 153 #define RC6_START_BIT_PAUSE_TIME                889.0e-6                      // 889 usec pause
 154 #define RC6_TOGGLE_BIT_TIME                     889.0e-6                      // 889 msec pulse/pause
 155 #define RC6_BIT_TIME                            444.0e-6                      // 889 usec pulse/pause
 156 #define RC6_ADDRESS_OFFSET                      5                             // skip "1" + 3 mode bits + 1 toggle bit
 157 #define RC6_ADDRESS_LEN                         8                             // read 8 address bits
 158 #define RC6_COMMAND_OFFSET                      13                            // skip 12 bits ("1" + 3 mode + 1 toggle + 8 address)
 159 #define RC6_COMMAND_LEN                         8                             // read 8 command bits
 160 #define RC6_COMPLETE_DATA_LEN_SHORT             21                            // complete length
 161 #define RC6_COMPLETE_DATA_LEN_LONG              36                            // complete length
 162 #define RC6_STOP_BIT                            0                             // has no stop bit
 163 #define RC6_LSB                                 0                             // MSB...LSB
 164
 165 #define RECS80EXT_START_BIT_PULSE_TIME           158.0e-6                     //  158 usec pulse
 166 #define RECS80EXT_START_BIT_PAUSE_TIME          3637.0e-6                     // 3637 usec pause
 167 #define RECS80EXT_PULSE_TIME                     158.0e-6                     //  158 usec pulse
 168 #define RECS80EXT_1_PAUSE_TIME                  7432.0e-6                     // 7432 usec pause
 169 #define RECS80EXT_0_PAUSE_TIME                  4902.0e-6                     // 4902 usec pause
 170 #define RECS80EXT_ADDRESS_OFFSET                2                             // skip 2 bits (2nd start + 1 toggle)
 171 #define RECS80EXT_ADDRESS_LEN                   4                             // read 3 address bits
 172 #define RECS80EXT_COMMAND_OFFSET                6                             // skip 6 bits (2nd start + 1 toggle + 4 address)
 173 #define RECS80EXT_COMMAND_LEN                   6                             // read 6 command bits
 174 #define RECS80EXT_COMPLETE_DATA_LEN             12                            // complete length
 175 #define RECS80EXT_STOP_BIT                      1                             // has stop bit
 176 #define RECS80EXT_LSB                           0                             // MSB...LSB
 177
 178 #define NUBERT_START_BIT_PULSE_TIME             1340.0e-6                     // 1340 usec pulse
 179 #define NUBERT_START_BIT_PAUSE_TIME              340.0e-6                     //  340 usec pause
 180 #define NUBERT_1_PULSE_TIME                     1340.0e-6                     // 1340 usec pulse
 181 #define NUBERT_1_PAUSE_TIME                      340.0e-6                     //  340 usec pause
 182 #define NUBERT_0_PULSE_TIME                      500.0e-6                     //  500 usec pulse
 183 #define NUBERT_0_PAUSE_TIME                     1300.0e-6                     // 1300 usec pause
 184 #define NUBERT_REPETITION_TIME                  35.0e-3                       // repetition after 35ms
 185 #define NUBERT_ADDRESS_OFFSET                   0                             // skip 0 bits
 186 #define NUBERT_ADDRESS_LEN                      0                             // read 0 address bits
 187 #define NUBERT_COMMAND_OFFSET                   0                             // skip 0 bits
 188 #define NUBERT_COMMAND_LEN                      10                            // read 10 bits
 189 #define NUBERT_COMPLETE_DATA_LEN                10                            // complete length
 190 #define NUBERT_STOP_BIT                         1                             // has stop bit
 191 #define NUBERT_LSB                              0                             // MSB?
 192
 193 #define AUTO_REPETITION_TIME                    50.0e-3                       // SIRCS or SAMSUNG32: automatic repetition after 45-50ms
 194
 195 #define TRUE                                    1
 196 #define FALSE                                   0
 197
 198 #define IRMP_FLAG_REPETITION                    0x01
 199
 200 typedef struct
 201 {
 202   uint8_t               protocol;                                             // protocol, i.e. NEC_PROTOCOL
 203   uint16_t              address;                                              // address
 204   uint16_t              command;                                              // command
 205   uint8_t               flags;                                                // flags, e.g. repetition
 206 } IRMP_DATA;
 207
 208
 209 /**
 210  *  Initialize IRMP decoder
 211  *  @details  Configures IRMP input pin
 212  */
 213 extern void                           irmp_init (void);
 214
 215 /**
 216  *  Get IRMP data
 217  *  @details  gets decoded IRMP data
 218  *  @param    pointer in order to store IRMP data
 219  *  @return    TRUE: successful, FALSE: failed
 220  */
 221 extern uint8_t                        irmp_get_data (IRMP_DATA *);
 222
 223 /**
 224  *  ISR routine
 225  *  @details  ISR routine, called 10000 times per second
 226  */
 227 extern void                           irmp_ISR (void);
 228
 229 #ifdef __cplusplus
 230 }
 231 #endif
 232
 233 #endif /* _WC_IRMP_H_ */