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