Subversion Repositories HomeAutomation

Rev

Rev 2237 | Rev 2244 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | SVN | RSS feed

  1. /**
  2.  * @defgroup infrared IR Protocols Driver Library
  3.  * @code #include <drivers/ir/protocols.h> @endcode
  4.  *
  5.  * @brief  
  6.  *
  7.  *
  8.  * @author  Andreas Fritiofson, Anders Runeson
  9.  * @date    2007
  10.  */
  11.  
  12. /**@{*/
  13.  
  14.  
  15. #ifndef IR_PROTOCOLS_H_
  16. #define IR_PROTOCOLS_H_
  17. #include <stdio.h>
  18. #include <config.h>
  19.  
  20. /* Protocol data structure */
  21. typedef struct {
  22.     uint8_t protocol;
  23.     uint64_t data;
  24.     uint16_t timeout;       //Set to 0 to indicate burst protocol (only one pulse train is sent)
  25.     uint8_t repeats;
  26.     uint16_t modfreq;
  27.     uint8_t framecnt;
  28. } Ir_Protocol_Data_t;
  29.  
  30. /* Which protocols to use. These should perhaps be configuration options
  31.  * (config.inc). Only applies to receiver right now */
  32. #ifndef IR_PROTOCOLS_USE_SIRC
  33. # define IR_PROTOCOLS_USE_SIRC      1
  34. #endif
  35. #ifndef IR_PROTOCOLS_USE_RC5
  36. # define IR_PROTOCOLS_USE_RC5       1
  37. #endif
  38. #ifndef IR_PROTOCOLS_USE_SHARP
  39. # define IR_PROTOCOLS_USE_SHARP     1
  40. #endif
  41. #ifndef IR_PROTOCOLS_USE_NEC
  42. # define IR_PROTOCOLS_USE_NEC       1
  43. #endif
  44. #ifndef IR_PROTOCOLS_USE_SAMSUNG
  45. # define IR_PROTOCOLS_USE_SAMSUNG   1
  46. #endif
  47. #ifndef IR_PROTOCOLS_USE_MARANTZ
  48. # define IR_PROTOCOLS_USE_MARANTZ   1
  49. #endif
  50. #ifndef IR_PROTOCOLS_USE_PANASONIC
  51. # define IR_PROTOCOLS_USE_PANASONIC 1
  52. #endif
  53. #ifndef IR_PROTOCOLS_USE_SKY
  54. # define IR_PROTOCOLS_USE_SKY       1
  55. #endif
  56. #ifndef IR_PROTOCOLS_USE_NEXA2
  57. # define IR_PROTOCOLS_USE_NEXA2 1
  58. #endif
  59. #ifndef IR_PROTOCOLS_USE_NEXA1
  60. # define IR_PROTOCOLS_USE_NEXA1 1
  61. #endif
  62. #ifndef IR_PROTOCOLS_USE_VIKING
  63. # define IR_PROTOCOLS_USE_VIKING    1
  64. #endif
  65. #ifndef IR_PROTOCOLS_USE_VIKING_STEAK
  66. # define IR_PROTOCOLS_USE_VIKING_STEAK  1
  67. #endif
  68. #ifndef IR_PROTOCOLS_USE_RUBICSON
  69. # define IR_PROTOCOLS_USE_RUBICSON  1
  70. #endif
  71.  
  72.  
  73.  
  74. /* All these functions take a buffer with pulse times and tries to parse it
  75.  * to a Ir_Protocol_Data_t structure. They return IR_OK on success
  76.  * and IR_NOT_CORRECT_DATA if there was no match. */
  77. #if (IR_PROTOCOLS_USE_SIRC)
  78. int8_t parseSIRC(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  79. #endif
  80. #if (IR_PROTOCOLS_USE_RC5)
  81. int8_t parseRC5(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  82. #endif
  83. #if (IR_PROTOCOLS_USE_SHARP)
  84. int8_t parseSharp(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  85. #endif
  86. #if (IR_PROTOCOLS_USE_NEC)
  87. int8_t parseNEC(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  88. #endif
  89. #if (IR_PROTOCOLS_USE_SAMSUNG)
  90. int8_t parseSamsung(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  91. #endif
  92. #if (IR_PROTOCOLS_USE_MARANTZ)
  93. int8_t parseMarantz(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  94. #endif
  95. #if (IR_PROTOCOLS_USE_PANASONIC)
  96. int8_t parsePanasonic(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  97. #endif
  98. #if (IR_PROTOCOLS_USE_SKY)
  99. int8_t parseSky(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  100. #endif
  101.  
  102. /* RF protocols needs index parameter */
  103. #if (IR_PROTOCOLS_USE_NEXA2)
  104. int8_t parseNexa2(const uint16_t *buf, uint8_t len, uint8_t index, Ir_Protocol_Data_t *proto);
  105. #endif
  106. #if (IR_PROTOCOLS_USE_NEXA1)
  107. int8_t parseNexa1(const uint16_t *buf, uint8_t len, uint8_t index, Ir_Protocol_Data_t *proto);
  108. #endif
  109. #if (IR_PROTOCOLS_USE_VIKING)
  110. int8_t parseViking(const uint16_t *buf, uint8_t len, uint8_t index, Ir_Protocol_Data_t *proto);
  111. #endif
  112. #if (IR_PROTOCOLS_USE_VIKING_STEAK)
  113. int8_t parseVikingSteak(const uint16_t *buf, uint8_t len, uint8_t index, Ir_Protocol_Data_t *proto);
  114. #endif
  115. #if (IR_PROTOCOLS_USE_RUBICSON)
  116. int8_t parseRubicson(const uint16_t *buf, uint8_t len, uint8_t index, Ir_Protocol_Data_t *proto);
  117. #endif
  118.  
  119.  
  120. /* Try to parse all above protocols until a match is found. */
  121. int8_t parseProtocol(const uint16_t *buf, uint8_t len, uint8_t index, Ir_Protocol_Data_t *proto);
  122. /* The Hash protocol always succeeds and creates a one-way signature of the
  123.  * pulse times buffer that is supposed to be unique and constant for a specific
  124.  * IR event. It may be used to send a valid event even if the protocol hasn't
  125.  * been implemented or decoded yet. */
  126. int8_t parseHash(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  127.  
  128. /* These functions expand a Ir_Protocol_Data_t structure into a raw buffer with
  129.  * pulse lengths. They return IR_OK on success and IR_NOT_CORRECT_DATA if the
  130.  * Ir_Protocol_Data_t structure is for another protocol or contains invalid
  131.  * data. */
  132. int8_t expandSIRC(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  133. int8_t expandRC5(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  134. int8_t expandSharp(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  135. int8_t expandNEC(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  136. int8_t expandSamsung(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  137. int8_t expandMarantz(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  138. int8_t expandPanasonic(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  139. int8_t expandSky(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  140. int8_t expandNexa2(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  141. int8_t expandNexa1(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  142. /* Pass the Ir_Protocol_Data_t automatically to the correct function. */
  143. int8_t expandProtocol(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  144.  
  145.  
  146. #define IR_OK           1
  147. #define IR_NO_PROTOCOL      2
  148. #define IR_TIME_OVFL        3
  149. #define IR_NO_DATA      4
  150. #define IR_NOT_CORRECT_DATA     5
  151. #define IR_TO_MUCH_DATA     6
  152. #define IR_NOT_FINISHED     7
  153. #define IR_SEND_DEBUG       8
  154. #define IR_BUTTON_DOWN      0x0
  155. #define IR_BUTTON_UP        0xf
  156.  
  157. // defined for the module, uses same definitions for pressed and released as other buttons
  158. #define IR_BUTTON_RELEASED  0x0
  159. #define IR_BUTTON_PRESSED   0x1
  160.  
  161.  
  162. #define CYCLES_PER_US       (F_CPU/1000000UL)
  163. #define TIMER_PRESC         (8)
  164.  
  165. #ifndef IR_MIN_PULSE_WIDTH
  166. #define IR_MIN_PULSE_WIDTH  (0)                                 //us, used in continuous mode
  167. #endif
  168. #ifndef IR_MIN_STARTPULSE_WIDTH
  169. #define IR_MIN_STARTPULSE_WIDTH (0UL)                           //us, not used when set to 0
  170. #endif
  171. #ifndef IR_MAX_PULSE_WIDTH
  172. #define IR_MAX_PULSE_WIDTH  (12000UL)                           //us
  173. #endif
  174.  
  175. /* RC5 Implementation
  176.  * Receiver: DONE
  177.  * Transmitter: DONE
  178.  */
  179. #define IR_PROTO_RC5        (0)
  180. #define IR_RC5_HALF_BIT     (889*CYCLES_PER_US/TIMER_PRESC)     //us
  181. #define IR_RC5_BIT          (889*2*CYCLES_PER_US/TIMER_PRESC)   //us
  182. #define IR_RC5_TIMEOUT      (117-IR_MAX_PULSE_WIDTH/1000)       //ms    (time between ir frames)
  183. #define IR_RC5_REPS         (1)                                 //      (minimum number of times to repeat code)
  184. #define IR_RC5_F_MOD        (36)                                //kHz   (modulation frequency)
  185. #define IR_RC5_TOL_DIV      (4)
  186.  
  187. /* RC6 Implementation
  188.  * Receiver:
  189.  * Transmitter:
  190.  */
  191. #define IR_PROTO_RC6        (1)
  192. #define IR_RC6_ST_BIT       (1*CYCLES_PER_US/TIMER_PRESC)       //us
  193. #define IR_RC6_TIMEOUT      (50-IR_MAX_PULSE_WIDTH/1000)        //ms    (time between ir frames)
  194. #define IR_RC6_REPS         (1)                                 //      (minimum number of times to repeat code)
  195. #define IR_RC6_F_MOD        (36)                                //kHz   (modulation frequency)
  196. #define IR_RC6_TOL_DIV      (4)
  197.  
  198. /* RCMM Implementation
  199.  * Receiver:
  200.  * Transmitter:
  201.  */
  202. #define IR_PROTO_RCMM       (2)
  203. #define IR_RCMM_ST_BIT      (256*CYCLES_PER_US/TIMER_PRESC)     //us
  204. #define IR_RCMM_TIMEOUT     (170-IR_MAX_PULSE_WIDTH/1000)       //ms    (time between ir frames)
  205. #define IR_RCMM_REPS        (1)                                 //      (minimum number of times to repeat code)
  206. #define IR_RCMM_F_MOD       (36)                                //kHz   (modulation frequency)
  207. #define IR_RCMM_TOL_DIV     (4)
  208.  
  209. /* SIRC Implementation
  210.  * Receiver: DONE
  211.  * Transmitter: DONE
  212.  */
  213. #define IR_PROTO_SIRC       (3)
  214. #define IR_SIRC_ST_BIT      (2400*CYCLES_PER_US/TIMER_PRESC)    //us
  215. #define IR_SIRC_LOW         (600*CYCLES_PER_US/TIMER_PRESC)     //us
  216. #define IR_SIRC_HIGH_ONE    (1200*CYCLES_PER_US/TIMER_PRESC)    //us
  217. #define IR_SIRC_HIGH_ZERO   (600*CYCLES_PER_US/TIMER_PRESC)     //us
  218. #define IR_SIRC_TIMEOUT     (52-IR_MAX_PULSE_WIDTH/1000)                                    //ms    (time between ir frames)
  219. #define IR_SIRC_REPS        (3)                                 //      (minimum number of times to repeat code)
  220. #define IR_SIRC_F_MOD       (40)                                //kHz   (modulation frequency)
  221. #define IR_SIRC_TOL_DIV     (4)
  222.  
  223. /* Sharp Implementation
  224.  * Receiver: DONE
  225.  * Transmitter:
  226.  */
  227. #define IR_PROTO_SHARP      (4)
  228. #define IR_SHARP_HIGH       (280*CYCLES_PER_US/TIMER_PRESC)     //us
  229. #define IR_SHARP_LOW_ONE    (1850*CYCLES_PER_US/TIMER_PRESC)    //us
  230. #define IR_SHARP_LOW_ZERO   (780*CYCLES_PER_US/TIMER_PRESC)     //us
  231. #define IR_SHARP_TIMEOUT    (67-IR_MAX_PULSE_WIDTH/1000)        //ms    (time between ir frames)
  232. #define IR_SHARP_REPS       (2)                                 //      (minimum number of times to repeat code)
  233. #define IR_SHARP_F_MOD      (38)                                //kHz   (modulation frequency)
  234. #define IR_SHARP_TOL_DIV    (4)
  235.  
  236. /* NEC Implementation
  237.  * Receiver: DONE
  238.  * Transmitter: DONE
  239.  */
  240. #define IR_PROTO_NEC        (5)
  241. #define IR_NEC_ST_BIT       (9000*CYCLES_PER_US/TIMER_PRESC)    //us
  242. #define IR_NEC_ST_PAUSE     (4500*CYCLES_PER_US/TIMER_PRESC)    //us
  243. #define IR_NEC_LOW_ONE      (1690*CYCLES_PER_US/TIMER_PRESC)    //us
  244. #define IR_NEC_LOW_ZERO     (560*CYCLES_PER_US/TIMER_PRESC)     //us
  245. #define IR_NEC_HIGH         (560*CYCLES_PER_US/TIMER_PRESC)     //us
  246. #define IR_NEC_TIMEOUT      (122-IR_MAX_PULSE_WIDTH/1000)       //ms    (time between ir frames)
  247. #define IR_NEC_ST_TIMEOUT   (65)                                //ms    (time between first ir frames and second)
  248. #define IR_NEC_REPS         (1)                                 //      (minimum number of times to repeat code)
  249. #define IR_NEC_F_MOD        (38)                                //kHz   (modulation frequency)
  250. #define IR_NEC_TOL_DIV      (4)
  251.  
  252. /* Samsung Implementation
  253.  * Receiver: DONE
  254.  * Transmitter: DONE
  255.  */
  256. #define IR_PROTO_SAMS       (6)
  257. #define IR_SAMS_ST_BIT      (4500*CYCLES_PER_US/TIMER_PRESC)    //us
  258. #define IR_SAMS_ST_PAUSE    (4500*CYCLES_PER_US/TIMER_PRESC)    //us
  259. #define IR_SAMS_LOW_ONE     (1720*CYCLES_PER_US/TIMER_PRESC)    //us
  260. #define IR_SAMS_LOW_ZERO    (650*CYCLES_PER_US/TIMER_PRESC)     //us
  261. #define IR_SAMS_HIGH        (500*CYCLES_PER_US/TIMER_PRESC)     //us
  262. #define IR_SAMS_TIMEOUT     (62-IR_MAX_PULSE_WIDTH/1000)        //ms    (time between ir frames)
  263. #define IR_SAMS_REPS        (1)                                 //      (minimum number of times to repeat code)
  264. #define IR_SAMS_F_MOD       (38)                                //kHz   (modulation frequency)
  265. #define IR_SAMS_TOL_DIV     (4)
  266.  
  267. /* Marantz Implementation
  268.  * Receiver: DONE (has not been tested with odd adressbits)
  269.  * Transmitter: DONE
  270.  */
  271. #define IR_PROTO_MARANTZ        (7)
  272. #define IR_MARANTZ_HALF_BIT     (889*CYCLES_PER_US/TIMER_PRESC)     //us
  273. #define IR_MARANTZ_BIT          (889*2*CYCLES_PER_US/TIMER_PRESC)   //us
  274. #define IR_MARANTZ_TIMEOUT      (117-IR_MAX_PULSE_WIDTH/1000)       //ms    (time between ir frames)
  275. #define IR_MARANTZ_REPS         (1)                                 //      (minimum number of times to repeat code)
  276. #define IR_MARANTZ_F_MOD        (36)                                //kHz   (modulation frequency)
  277. #define IR_MARANTZ_TOL_DIV      (4)
  278.  
  279. /* Panasonic Implementation
  280.  * Receiver: DONE
  281.  * Transmitter: DONE
  282.  */
  283. #define IR_PROTO_PANASONIC  (8)
  284. #define IR_PANA_ST_BIT      (3570*CYCLES_PER_US/TIMER_PRESC)    //us
  285. #define IR_PANA_ST_PAUSE    (1630*CYCLES_PER_US/TIMER_PRESC)    //us
  286. #define IR_PANA_LOW_ONE     (1240*CYCLES_PER_US/TIMER_PRESC)    //us
  287. #define IR_PANA_LOW_ZERO    (400*CYCLES_PER_US/TIMER_PRESC)     //us
  288. #define IR_PANA_HIGH        (495*CYCLES_PER_US/TIMER_PRESC)     //us
  289. #define IR_PANA_TIMEOUT     (92-IR_MAX_PULSE_WIDTH/1000)        //ms    (time between ir frames)
  290. #define IR_PANA_REPS        (1)                                 //      (minimum number of times to repeat code)
  291. #define IR_PANA_F_MOD       (38)                                //kHz   (modulation frequency)
  292. #define IR_PANA_TOL_DIV     (4)
  293.  
  294. /* Sky Implementation
  295.  * Receiver: DONE
  296.  * Transmitter:
  297.  */
  298. #define IR_PROTO_SKY        (9)
  299. #define IR_SKY_ST_BIT       (2800*CYCLES_PER_US/TIMER_PRESC)    //us
  300. #define IR_SKY_SHORT        (460*CYCLES_PER_US/TIMER_PRESC)     //us
  301. #define IR_SKY_LONG         (920*CYCLES_PER_US/TIMER_PRESC)     //us
  302. #define IR_SKY_TIMEOUT      (162-IR_MAX_PULSE_WIDTH/1000)       //ms    (time between ir frames)
  303. #define IR_SKY_REPS         (1)                                 //      (minimum number of times to repeat code)
  304. #define IR_SKY_F_MOD        (38)                                //kHz   (modulation frequency)
  305. #define IR_SKY_TOL_DIV      (4)
  306.  
  307.  
  308. /* Nexa2 Implementation
  309.  * Receiver: DONE
  310.  * Transmitter: DONE
  311.  */
  312. #define IR_PROTO_NEXA2      (10)
  313. #define IR_NEXA2_START1     (10000*CYCLES_PER_US/TIMER_PRESC)   //us
  314. #define IR_NEXA2_START2     (2500*CYCLES_PER_US/TIMER_PRESC)    //us
  315. #define IR_NEXA2_HIGH       (320*CYCLES_PER_US/TIMER_PRESC)     //us
  316. #define IR_NEXA2_LOW_ONE    (210*CYCLES_PER_US/TIMER_PRESC)     //us
  317. #define IR_NEXA2_LOW_ZERO   (1200*CYCLES_PER_US/TIMER_PRESC)    //us
  318. #define IR_NEXA2_TIMEOUT    (200)                               //ms    (time between ir frames)
  319. #define IR_NEXA2_REPS       (5)                                 //      (minimum number of times to repeat code)
  320. #define IR_NEXA2_F_MOD      (38)                                //kHz   (modulation frequency)
  321. #define IR_NEXA2_TOL_DIV    (2)
  322.  
  323.  
  324. /* Nexa1 Implementation
  325.  * Receiver: DONE
  326.  * Transmitter:
  327.  */
  328. #define IR_PROTO_NEXA1      (11)
  329. #define IR_NEXA1_START      (10000*CYCLES_PER_US/TIMER_PRESC)   //us
  330. #define IR_NEXA1_SHORT      (370*CYCLES_PER_US/TIMER_PRESC)     //us
  331. #define IR_NEXA1_LONG       (1050*CYCLES_PER_US/TIMER_PRESC)    //us
  332. #define IR_NEXA1_TIMEOUT    (200)                               //ms    (time between ir frames)
  333. #define IR_NEXA1_REPS       (4)                                 //      (minimum number of times to repeat code)
  334. #define IR_NEXA1_F_MOD      (38)                                //kHz   (modulation frequency)
  335. #define IR_NEXA1_TOL_DIV    (2)
  336.  
  337.  
  338. /* Viking Temperature sensor Implementation
  339.  * Receiver:
  340.  */
  341. #define IR_PROTO_VIKING     (12)
  342. #define IR_VIKING_LOW       (940*CYCLES_PER_US/TIMER_PRESC)     //us
  343. #define IR_VIKING_HIGH_ONE  (1483*CYCLES_PER_US/TIMER_PRESC)        //us
  344. #define IR_VIKING_HIGH_ZERO (550*CYCLES_PER_US/TIMER_PRESC) //us
  345. #define IR_VIKING_TIMEOUT   (0)                                 //ms BURST! (time between ir frames)
  346. #define IR_VIKING_REPS      (1)                                 //      (minimum number of times to repeat code)
  347. #define IR_VIKING_F_MOD     (38)                                //kHz   (modulation frequency)
  348. #define IR_VIKING_TOL_DIV   (3)
  349.  
  350. /* Viking Steak temperature sensor Implementation
  351.  * Receiver:
  352.  */
  353. #define IR_PROTO_VIKING_STEAK       (13)
  354. #define IR_VIKING_STEAK_HIGH        (700*CYCLES_PER_US/TIMER_PRESC)     //us
  355. #define IR_VIKING_STEAK_LOW_ONE (4000*CYCLES_PER_US/TIMER_PRESC)        //us
  356. #define IR_VIKING_STEAK_LOW_ZERO    (1700*CYCLES_PER_US/TIMER_PRESC)    //us
  357. #define IR_VIKING_STEAK_LOW_START   (7800*CYCLES_PER_US/TIMER_PRESC)        //us
  358. #define IR_VIKING_STEAK_TIMEOUT (200)                                   //ms BURST! (time between ir frames)
  359. #define IR_VIKING_STEAK_REPS        (1)                                 //      (minimum number of times to repeat code)
  360. #define IR_VIKING_STEAK_F_MOD       (38)                                //kHz   (modulation frequency)
  361. #define IR_VIKING_STEAK_TOL_DIV (4)
  362.  
  363. /* Rubicson temperature sensor Implementation
  364.  * Receiver:
  365.  */
  366. #define IR_PROTO_RUBICSON       (14)
  367. #define IR_RUBICSON_HIGH        (550*CYCLES_PER_US/TIMER_PRESC)     //us
  368. #define IR_RUBICSON_LOW_ONE     (1880*CYCLES_PER_US/TIMER_PRESC)        //us
  369. #define IR_RUBICSON_LOW_ZERO        (900*CYCLES_PER_US/TIMER_PRESC) //us
  370. #define IR_RUBICSON_LOW_START       (3850*CYCLES_PER_US/TIMER_PRESC)        //us
  371. #define IR_RUBICSON_TIMEOUT     (200)                                   //ms BURST! (time between ir frames)
  372. #define IR_RUBICSON_REPS        (1)                                 //      (minimum number of times to repeat code)
  373. #define IR_RUBICSON_F_MOD       (38)                                //kHz   (modulation frequency)
  374. #define IR_RUBICSON_TOL_DIV     (4)
  375.  
  376. #define IR_PROTO_HASH       0xfe
  377. #define IR_PROTO_UNKNOWN    0xff                                //
  378.  
  379.  
  380.  
  381. /**@}*/
  382. #endif /*IR_PROTOCOLS_H_*/
  383.