]> cloudbase.mooo.com Git - irmp.git/blob - irmp.h
projects / irmp.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Version 1.6.0: added FDC protocol, corrected DENON timing
[irmp.git] / 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.26 2010/06/08 23:34:14 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 #define IRMP_BANG_OLUFSEN_PROTOCOL 14 // Bang & Olufsen
43 #define IRMP_GRUNDIG_PROTOCOL 15 // Grundig
44 #define IRMP_NOKIA_PROTOCOL 16 // Nokia
45 #define IRMP_SIEMENS_PROTOCOL 17 // Siemens, e.g. Gigaset
46 #define IRMP_FDC_PROTOCOL 18 // FDC keyboard
47
48 #define SIRCS_START_BIT_PULSE_TIME 2400.0e-6 // 2400 usec pulse
49 #define SIRCS_START_BIT_PAUSE_TIME 600.0e-6 // 600 usec pause
50 #define SIRCS_1_PULSE_TIME 1200.0e-6 // 1200 usec pulse
51 #define SIRCS_0_PULSE_TIME 600.0e-6 // 600 usec pulse
52 #define SIRCS_PAUSE_TIME 600.0e-6 // 600 usec pause
53 #define SIRCS_FRAMES 3 // SIRCS sends each frame 3 times
54 #define SIRCS_AUTO_REPETITION_PAUSE_TIME 25.0e-3 // auto repetition after 25ms
55 #define SIRCS_FRAME_REPEAT_PAUSE_TIME 25.0e-3 // frame repeat after 25ms
56 #define SIRCS_ADDRESS_OFFSET 15 // skip 15 bits
57 #define SIRCS_ADDRESS_LEN 5 // read up to 5 address bits
58 #define SIRCS_COMMAND_OFFSET 0 // skip 0 bits
59 #define SIRCS_COMMAND_LEN 15 // read 12-15 command bits
60 #define SIRCS_MINIMUM_DATA_LEN 12 // minimum data length
61 #define SIRCS_COMPLETE_DATA_LEN 20 // complete length - may be up to 20
62 #define SIRCS_STOP_BIT 0 // has no stop bit
63 #define SIRCS_LSB 1 // LSB...MSB
64
65 #define NEC_START_BIT_PULSE_TIME 9000.0e-6 // 9000 usec pulse
66 #define NEC_START_BIT_PAUSE_TIME 4500.0e-6 // 4500 usec pause
67 #define NEC_REPEAT_START_BIT_PAUSE_TIME 2250.0e-6 // 2250 usec pause
68 #define NEC_PULSE_TIME 560.0e-6 // 560 usec pulse
69 #define NEC_1_PAUSE_TIME 1690.0e-6 // 1690 usec pause
70 #define NEC_0_PAUSE_TIME 560.0e-6 // 560 usec pause
71 #define NEC_FRAME_REPEAT_PAUSE_TIME 40.0e-3 // frame repeat after 40ms
72 #define NEC_ADDRESS_OFFSET 0 // skip 0 bits
73 #define NEC_ADDRESS_LEN 16 // read 16 address bits
74 #define NEC_COMMAND_OFFSET 16 // skip 16 bits (8 address + 8 /address)
75 #define NEC_COMMAND_LEN 16 // read 16 bits (8 command + 8 /command)
76 #define NEC_COMPLETE_DATA_LEN 32 // complete length
77 #define NEC_STOP_BIT 1 // has stop bit
78 #define NEC_LSB 1 // LSB...MSB
79
80 #define SAMSUNG_START_BIT_PULSE_TIME 4500.0e-6 // 4500 usec pulse
81 #define SAMSUNG_START_BIT_PAUSE_TIME 4500.0e-6 // 4500 usec pause
82 #define SAMSUNG_PULSE_TIME 550.0e-6 // 550 usec pulse
83 #define SAMSUNG_1_PAUSE_TIME 1450.0e-6 // 1450 usec pause
84 #define SAMSUNG_0_PAUSE_TIME 450.0e-6 // 450 usec pause
85 #define SAMSUNG_FRAME_REPEAT_PAUSE_TIME 45.0e-3 // frame repeat after 45ms
86 #define SAMSUNG_ADDRESS_OFFSET 0 // skip 0 bits
87 #define SAMSUNG_ADDRESS_LEN 16 // read 16 address bits
88 #define SAMSUNG_ID_OFFSET 17 // skip 16 + 1 sync bit
89 #define SAMSUNG_ID_LEN 4 // read 4 id bits
90 #define SAMSUNG_COMMAND_OFFSET 21 // skip 16 + 1 sync + 4 data bits
91 #define SAMSUNG_COMMAND_LEN 16 // read 16 command bits
92 #define SAMSUNG_COMPLETE_DATA_LEN 37 // complete length
93 #define SAMSUNG_STOP_BIT 1 // has stop bit
94 #define SAMSUNG_LSB 1 // LSB...MSB?
95
96 #define SAMSUNG32_COMMAND_OFFSET 16 // skip 16 bits
97 #define SAMSUNG32_COMMAND_LEN 16 // read 16 command bits
98 #define SAMSUNG32_COMPLETE_DATA_LEN 32 // complete length
99 #define SAMSUNG32_FRAMES 2 // SAMSUNG32 sends each frame 2 times
100 #define SAMSUNG32_AUTO_REPETITION_PAUSE_TIME 47.0e-3 // repetition after 47 ms
101 #define SAMSUNG32_FRAME_REPEAT_PAUSE_TIME 47.0e-3 // frame repeat after 40ms
102
103 #define MATSUSHITA_START_BIT_PULSE_TIME 3488.0e-6 // 3488 usec pulse
104 #define MATSUSHITA_START_BIT_PAUSE_TIME 3488.0e-6 // 3488 usec pause
105 #define MATSUSHITA_PULSE_TIME 872.0e-6 // 872 usec pulse
106 #define MATSUSHITA_1_PAUSE_TIME 2616.0e-6 // 2616 usec pause
107 #define MATSUSHITA_0_PAUSE_TIME 872.0e-6 // 872 usec pause
108 #define MATSUSHITA_FRAME_REPEAT_PAUSE_TIME 45.0e-3 // frame repeat after 45ms
109 #define MATSUSHITA_ADDRESS_OFFSET 12 // skip 12 bits
110 #define MATSUSHITA_ADDRESS_LEN 12 // read 12 address bits
111 #define MATSUSHITA_COMMAND_OFFSET 0 // skip 0 bits
112 #define MATSUSHITA_COMMAND_LEN 12 // read 12 bits (6 custom + 6 command)
113 #define MATSUSHITA_COMPLETE_DATA_LEN 24 // complete length
114 #define MATSUSHITA_STOP_BIT 1 // has stop bit
115 #define MATSUSHITA_LSB 1 // LSB...MSB?
116
117 #define KASEIKYO_START_BIT_PULSE_TIME 3380.0e-6 // 3380 usec pulse
118 #define KASEIKYO_START_BIT_PAUSE_TIME 1690.0e-6 // 1690 usec pause
119 #define KASEIKYO_PULSE_TIME 423.0e-6 // 525 usec pulse
120 #define KASEIKYO_1_PAUSE_TIME 1269.0e-6 // 525 usec pause
121 #define KASEIKYO_0_PAUSE_TIME 423.0e-6 // 1690 usec pause
122 #define KASEIKYO_FRAME_REPEAT_PAUSE_TIME 45.0e-3 // frame repeat after 45ms
123 #define KASEIKYO_ADDRESS_OFFSET 0 // skip 0 bits
124 #define KASEIKYO_ADDRESS_LEN 16 // read 16 address bits
125 #define KASEIKYO_COMMAND_OFFSET 28 // skip 28 bits (16 manufacturer & 4 parity & 8 genre)
126 #define KASEIKYO_COMMAND_LEN 12 // read 12 command bits (10 real command & 2 id)
127 #define KASEIKYO_COMPLETE_DATA_LEN 48 // complete length
128 #define KASEIKYO_STOP_BIT 1 // has stop bit
129 #define KASEIKYO_LSB 1 // LSB...MSB?
130
131 #define RECS80_START_BIT_PULSE_TIME 158.0e-6 // 158 usec pulse
132 #define RECS80_START_BIT_PAUSE_TIME 7432.0e-6 // 7432 usec pause
133 #define RECS80_PULSE_TIME 158.0e-6 // 158 usec pulse
134 #define RECS80_1_PAUSE_TIME 7432.0e-6 // 7432 usec pause
135 #define RECS80_0_PAUSE_TIME 4902.0e-6 // 4902 usec pause
136 #define RECS80_FRAME_REPEAT_PAUSE_TIME 45.0e-3 // frame repeat after 45ms
137 #define RECS80_ADDRESS_OFFSET 2 // skip 2 bits (2nd start + 1 toggle)
138 #define RECS80_ADDRESS_LEN 3 // read 3 address bits
139 #define RECS80_COMMAND_OFFSET 5 // skip 5 bits (2nd start + 1 toggle + 3 address)
140 #define RECS80_COMMAND_LEN 6 // read 6 command bits
141 #define RECS80_COMPLETE_DATA_LEN 11 // complete length
142 #define RECS80_STOP_BIT 1 // has stop bit
143 #define RECS80_LSB 0 // MSB...LSB
144
145 #define RC5_BIT_TIME 889.0e-6 // 889 usec pulse/pause
146 #define RC5_FRAME_REPEAT_PAUSE_TIME 45.0e-3 // frame repeat after 45ms
147 #define RC5_ADDRESS_OFFSET 2 // skip 2 bits (2nd start + 1 toggle)
148 #define RC5_ADDRESS_LEN 5 // read 5 address bits
149 #define RC5_COMMAND_OFFSET 7 // skip 5 bits (2nd start + 1 toggle + 5 address)
150 #define RC5_COMMAND_LEN 6 // read 6 command bits
151 #define RC5_COMPLETE_DATA_LEN 13 // complete length
152 #define RC5_STOP_BIT 0 // has no stop bit
153 #define RC5_LSB 0 // MSB...LSB
154
155 #define DENON_PULSE_TIME 275.0e-6 // 275 usec pulse
156 #define DENON_1_PAUSE_TIME 1900.0e-6 // 1900 usec pause
157 #define DENON_0_PAUSE_TIME 775.0e-6 // 775 usec pause
158 #define DENON_FRAMES 2 // DENON sends each frame 2 times
159 #define DENON_AUTO_REPETITION_PAUSE_TIME 65.0e-3 // inverted repetition after 65ms
160 #define DENON_FRAME_REPEAT_PAUSE_TIME 65.0e-3 // frame repeat after 65ms
161 #define DENON_ADDRESS_OFFSET 0 // skip 0 bits
162 #define DENON_ADDRESS_LEN 5 // read 5 address bits
163 #define DENON_COMMAND_OFFSET 5 // skip 5
164 #define DENON_COMMAND_LEN 10 // read 10 command bits
165 #define DENON_COMPLETE_DATA_LEN 15 // complete length
166 #define DENON_STOP_BIT 1 // has stop bit
167 #define DENON_LSB 0 // MSB...LSB
168
169 #define RC6_START_BIT_PULSE_TIME 2666.0e-6 // 2.666 msec pulse
170 #define RC6_START_BIT_PAUSE_TIME 889.0e-6 // 889 usec pause
171 #define RC6_TOGGLE_BIT_TIME 889.0e-6 // 889 msec pulse/pause
172 #define RC6_BIT_TIME 444.0e-6 // 889 usec pulse/pause
173 #define RC6_FRAME_REPEAT_PAUSE_TIME 45.0e-3 // frame repeat after 45ms
174 #define RC6_ADDRESS_OFFSET 5 // skip "1" + 3 mode bits + 1 toggle bit
175 #define RC6_ADDRESS_LEN 8 // read 8 address bits
176 #define RC6_COMMAND_OFFSET 13 // skip 12 bits ("1" + 3 mode + 1 toggle + 8 address)
177 #define RC6_COMMAND_LEN 8 // read 8 command bits
178 #define RC6_COMPLETE_DATA_LEN_SHORT 21 // complete length
179 #define RC6_COMPLETE_DATA_LEN_LONG 36 // complete length
180 #define RC6_STOP_BIT 0 // has no stop bit
181 #define RC6_LSB 0 // MSB...LSB
182
183 #define RECS80EXT_START_BIT_PULSE_TIME 158.0e-6 // 158 usec pulse
184 #define RECS80EXT_START_BIT_PAUSE_TIME 3637.0e-6 // 3637 usec pause
185 #define RECS80EXT_PULSE_TIME 158.0e-6 // 158 usec pulse
186 #define RECS80EXT_1_PAUSE_TIME 7432.0e-6 // 7432 usec pause
187 #define RECS80EXT_0_PAUSE_TIME 4902.0e-6 // 4902 usec pause
188 #define RECS80EXT_FRAME_REPEAT_PAUSE_TIME 45.0e-3 // frame repeat after 45ms
189 #define RECS80EXT_ADDRESS_OFFSET 2 // skip 2 bits (2nd start + 1 toggle)
190 #define RECS80EXT_ADDRESS_LEN 4 // read 3 address bits
191 #define RECS80EXT_COMMAND_OFFSET 6 // skip 6 bits (2nd start + 1 toggle + 4 address)
192 #define RECS80EXT_COMMAND_LEN 6 // read 6 command bits
193 #define RECS80EXT_COMPLETE_DATA_LEN 12 // complete length
194 #define RECS80EXT_STOP_BIT 1 // has stop bit
195 #define RECS80EXT_LSB 0 // MSB...LSB
196
197 #define NUBERT_START_BIT_PULSE_TIME 1340.0e-6 // 1340 usec pulse
198 #define NUBERT_START_BIT_PAUSE_TIME 340.0e-6 // 340 usec pause
199 #define NUBERT_1_PULSE_TIME 1340.0e-6 // 1340 usec pulse
200 #define NUBERT_1_PAUSE_TIME 340.0e-6 // 340 usec pause
201 #define NUBERT_0_PULSE_TIME 500.0e-6 // 500 usec pulse
202 #define NUBERT_0_PAUSE_TIME 1300.0e-6 // 1300 usec pause
203 #define NUBERT_FRAMES 2 // Nubert sends 2 frames
204 #define NUBERT_AUTO_REPETITION_PAUSE_TIME 35.0e-3 // auto repetition after 35ms
205 #define NUBERT_FRAME_REPEAT_PAUSE_TIME 35.0e-3 // frame repeat after 45ms
206 #define NUBERT_ADDRESS_OFFSET 0 // skip 0 bits
207 #define NUBERT_ADDRESS_LEN 0 // read 0 address bits
208 #define NUBERT_COMMAND_OFFSET 0 // skip 0 bits
209 #define NUBERT_COMMAND_LEN 10 // read 10 bits
210 #define NUBERT_COMPLETE_DATA_LEN 10 // complete length
211 #define NUBERT_STOP_BIT 1 // has stop bit
212 #define NUBERT_LSB 0 // MSB?
213
214 #define BANG_OLUFSEN_START_BIT1_PULSE_TIME 200.0e-6 // 200 usec pulse
215 #define BANG_OLUFSEN_START_BIT1_PAUSE_TIME 3125.0e-6 // 3125 usec pause
216 #define BANG_OLUFSEN_START_BIT2_PULSE_TIME 200.0e-6 // 200 usec pulse
217 #define BANG_OLUFSEN_START_BIT2_PAUSE_TIME 3125.0e-6 // 3125 usec pause
218 #define BANG_OLUFSEN_START_BIT3_PULSE_TIME 200.0e-6 // 200 usec pulse
219 #define BANG_OLUFSEN_START_BIT3_PAUSE_TIME 15625.0e-6 // 15625 usec pause
220 #define BANG_OLUFSEN_START_BIT4_PULSE_TIME 200.0e-6 // 200 usec pulse
221 #define BANG_OLUFSEN_START_BIT4_PAUSE_TIME 3125.0e-6 // 3125 usec pause
222 #define BANG_OLUFSEN_PULSE_TIME 200.0e-6 // 200 usec pulse
223 #define BANG_OLUFSEN_1_PAUSE_TIME 9375.0e-6 // 9375 usec pause
224 #define BANG_OLUFSEN_0_PAUSE_TIME 3125.0e-6 // 3125 usec pause
225 #define BANG_OLUFSEN_R_PAUSE_TIME 6250.0e-6 // 6250 usec pause (repeat last bit)
226 #define BANG_OLUFSEN_TRAILER_BIT_PAUSE_TIME 12500.0e-6 // 12500 usec pause (trailer bit)
227 #define BANG_OLUFSEN_FRAME_REPEAT_PAUSE_TIME 45.0e-3 // frame repeat after 45ms
228 #define BANG_OLUFSEN_ADDRESS_OFFSET 0 // no address bits
229 #define BANG_OLUFSEN_ADDRESS_LEN 0 // no address bits
230 #define BANG_OLUFSEN_COMMAND_OFFSET 3 // skip startbits 2, 3, 4
231 #define BANG_OLUFSEN_COMMAND_LEN 16 // read 16 command bits
232 #define BANG_OLUFSEN_COMPLETE_DATA_LEN 20 // complete length: startbits 2, 3, 4 + 16 data bits + trailer bit
233 #define BANG_OLUFSEN_STOP_BIT 1 // has stop bit
234 #define BANG_OLUFSEN_LSB 0 // MSB...LSB
235
236 #define GRUNDIG_OR_NOKIA_BIT_TIME 528.0e-6 // 528 usec pulse/pause
237 #define GRUNDIG_OR_NOKIA_PRE_PAUSE_TIME 2639.0e-6 // 2639 usec pause after pre bit
238 #define GRUNDIG_OR_NOKIA_FRAME_REPEAT_PAUSE_TIME 117.76e-3 // info frame repeat after 117.76 ms
239 #define GRUNDIG_OR_NOKIA_STOP_BIT 0 // has no stop bit
240 #define GRUNDIG_OR_NOKIA_LSB 1 // MSB...LSB
241
242 #define GRUNDIG_FRAMES 2 // GRUNDIG sends each frame 1+1 times
243 #define GRUNDIG_AUTO_REPETITION_PAUSE_TIME 20.0e-3 // repetition after 20ms
244 #define GRUNDIG_ADDRESS_OFFSET 0 // no address
245 #define GRUNDIG_ADDRESS_LEN 0 // no address
246 #define GRUNDIG_COMMAND_OFFSET 1 // skip 1 start bit
247 #define GRUNDIG_COMMAND_LEN 9 // read 9 command bits
248 #define GRUNDIG_COMPLETE_DATA_LEN 10 // complete length: 1 start bit + 9 data bits
249
250 #define NOKIA_FRAMES 3 // NOKIA sends each frame 1 + 1 + 1 times
251 #define NOKIA_AUTO_REPETITION_PAUSE_TIME 20.0e-3 // repetition after 20ms
252 #define NOKIA_ADDRESS_OFFSET 9 // skip 9 bits (1 start bit + 8 data bits)
253 #define NOKIA_ADDRESS_LEN 8 // 7 address bits
254 #define NOKIA_COMMAND_OFFSET 1 // skip 1 bit (1 start bit)
255 #define NOKIA_COMMAND_LEN 8 // read 8 command bits
256 #define NOKIA_COMPLETE_DATA_LEN 17 // complete length: 1 start bit + 8 address bits + 8 command bits
257
258 #define SIEMENS_BIT_TIME 250.0e-6 // 250 usec pulse/pause
259 #define SIEMENS_FRAME_REPEAT_PAUSE_TIME 45.0e-3 // frame repeat after 45ms
260 #define SIEMENS_ADDRESS_OFFSET 2 // skip 2 start bits
261 #define SIEMENS_ADDRESS_LEN 12 // read 12 address bits
262 #define SIEMENS_COMMAND_OFFSET 15 // skip 15 bits (2 start bits + 12 address bits + 1 inverted bit)
263 #define SIEMENS_COMMAND_LEN 7 // read 7 command bits
264 #define SIEMENS_COMPLETE_DATA_LEN 23 // complete length
265 #define SIEMENS_STOP_BIT 0 // has no stop bit
266 #define SIEMENS_LSB 0 // MSB...LSB
267
268 #define FDC_START_BIT_PULSE_TIME 1390.0e-6 // 1390 usec pulse
269 #define FDC_START_BIT_PAUSE_TIME 640.0e-6 // 640 usec pause
270 #define FDC_PULSE_TIME 200.0e-6 // 200 usec pulse
271 #define FDC_1_PAUSE_TIME 475.0e-6 // 475 usec pause
272 #define FDC_0_PAUSE_TIME 145.0e-6 // 145 usec pause
273 #define FDC_FRAME_REPEAT_PAUSE_TIME 40.0e-3 // frame repeat after 40ms
274 #define FDC_ADDRESS_OFFSET 0 // skip 0 bits
275 #define FDC_ADDRESS_LEN 16 // read 16 address bits
276 #define FDC_COMMAND_OFFSET 25 // skip 25 bits (16 address + 9 0-bits)
277 #define FDC_COMMAND_LEN 12 // read 12 bits
278 #define FDC_COMPLETE_DATA_LEN 40 // complete length
279 #define FDC_STOP_BIT 1 // has stop bit
280 #define FDC_LSB 1 // LSB...MSB
281
282 #define AUTO_FRAME_REPETITION_TIME 50.0e-3 // SIRCS/SAMSUNG32/NUBERT: automatic repetition after 25-50ms
283
284 #define TRUE 1
285 #define FALSE 0
286
287 #define IRMP_FLAG_REPETITION 0x01
288
289 typedef struct
290 {
291 uint8_t protocol; // protocol, i.e. NEC_PROTOCOL
292 uint16_t address; // address
293 uint16_t command; // command
294 uint8_t flags; // flags, e.g. repetition
295 } IRMP_DATA;
296
297
298 /**
299 * Initialize IRMP decoder
300 * @details Configures IRMP input pin
301 */
302 extern void irmp_init (void);
303
304 /**
305 * Get IRMP data
306 * @details gets decoded IRMP data
307 * @param pointer in order to store IRMP data
308 * @return TRUE: successful, FALSE: failed
309 */
310 extern uint8_t irmp_get_data (IRMP_DATA *);
311
312 /**
313 * ISR routine
314 * @details ISR routine, called 10000 times per second
315 */
316 extern void irmp_ISR (void);
317
318 #ifdef __cplusplus
319 }
320 #endif
321
322 #endif /* _WC_IRMP_H_ */
Clone of IRMP - Infrared Muliti Protocol Decoder (https://www.mikrocontroller.net/articles/IRMP)