Subversion Repositories HomeAutomation

Rev

Rev 2199 | Rev 2236 | 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.  
  66. /* All these functions take a buffer with pulse times and tries to parse it
  67.  * to a Ir_Protocol_Data_t structure. They return IR_OK on success
  68.  * and IR_NOT_CORRECT_DATA if there was no match. */
  69. #if (IR_PROTOCOLS_USE_SIRC)
  70. int8_t parseSIRC(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  71. #endif
  72. #if (IR_PROTOCOLS_USE_RC5)
  73. int8_t parseRC5(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  74. #endif
  75. #if (IR_PROTOCOLS_USE_SHARP)
  76. int8_t parseSharp(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  77. #endif
  78. #if (IR_PROTOCOLS_USE_NEC)
  79. int8_t parseNEC(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  80. #endif
  81. #if (IR_PROTOCOLS_USE_SAMSUNG)
  82. int8_t parseSamsung(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  83. #endif
  84. #if (IR_PROTOCOLS_USE_MARANTZ)
  85. int8_t parseMarantz(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  86. #endif
  87. #if (IR_PROTOCOLS_USE_PANASONIC)
  88. int8_t parsePanasonic(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  89. #endif
  90. #if (IR_PROTOCOLS_USE_SKY)
  91. int8_t parseSky(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  92. #endif
  93.  
  94. /* RF protocols needs index parameter */
  95. #if (IR_PROTOCOLS_USE_NEXA2)
  96. int8_t parseNexa2(const uint16_t *buf, uint8_t len, uint8_t index, Ir_Protocol_Data_t *proto);
  97. #endif
  98. #if (IR_PROTOCOLS_USE_NEXA1)
  99. int8_t parseNexa1(const uint16_t *buf, uint8_t len, uint8_t index, Ir_Protocol_Data_t *proto);
  100. #endif
  101. #if (IR_PROTOCOLS_USE_VIKING)
  102. int8_t parseViking(const uint16_t *buf, uint8_t len, uint8_t index, Ir_Protocol_Data_t *proto);
  103. #endif
  104.  
  105. /* Try to parse all above protocols until a match is found. */
  106. int8_t parseProtocol(const uint16_t *buf, uint8_t len, uint8_t index, Ir_Protocol_Data_t *proto);
  107. /* The Hash protocol always succeeds and creates a one-way signature of the
  108.  * pulse times buffer that is supposed to be unique and constant for a specific
  109.  * IR event. It may be used to send a valid event even if the protocol hasn't
  110.  * been implemented or decoded yet. */
  111. int8_t parseHash(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  112.  
  113. /* These functions expand a Ir_Protocol_Data_t structure into a raw buffer with
  114.  * pulse lengths. They return IR_OK on success and IR_NOT_CORRECT_DATA if the
  115.  * Ir_Protocol_Data_t structure is for another protocol or contains invalid
  116.  * data. */
  117. int8_t expandSIRC(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  118. int8_t expandRC5(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  119. int8_t expandSharp(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  120. int8_t expandNEC(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  121. int8_t expandSamsung(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  122. int8_t expandMarantz(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  123. int8_t expandPanasonic(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  124. int8_t expandSky(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  125. int8_t expandNexa2(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  126. int8_t expandNexa1(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  127. /* Pass the Ir_Protocol_Data_t automatically to the correct function. */
  128. int8_t expandProtocol(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  129.  
  130.  
  131. #define IR_OK               1
  132. #define IR_NO_PROTOCOL      2
  133. #define IR_TIME_OVFL        3
  134. #define IR_NO_DATA          4
  135. #define IR_NOT_CORRECT_DATA 5
  136. #define IR_TO_MUCH_DATA     6
  137. #define IR_NOT_FINISHED     7
  138.  
  139. #define IR_BUTTON_DOWN      0x0
  140. #define IR_BUTTON_UP        0xf
  141.  
  142. // defined for the module, uses same definitions for pressed and released as other buttons
  143. #define IR_BUTTON_RELEASED  0x0
  144. #define IR_BUTTON_PRESSED   0x1
  145.  
  146.  
  147. #define CYCLES_PER_US       (F_CPU/1000000UL)
  148. #define TIMER_PRESC         (8)
  149.  
  150. #ifndef IR_MIN_PULSE_WIDTH
  151. #define IR_MIN_PULSE_WIDTH  (0)                                 //us, used in continuous mode
  152. #endif
  153. #ifndef IR_MIN_STARTPULSE_WIDTH
  154. #define IR_MIN_STARTPULSE_WIDTH (0UL)                           //us, not used when set to 0
  155. #endif
  156. #ifndef IR_MAX_PULSE_WIDTH
  157. #define IR_MAX_PULSE_WIDTH  (12000UL)                           //us
  158. #endif
  159.  
  160. /* RC5 Implementation
  161.  * Receiver: DONE
  162.  * Transmitter: DONE
  163.  */
  164. #define IR_PROTO_RC5        (0)
  165. #define IR_RC5_HALF_BIT     (889*CYCLES_PER_US/TIMER_PRESC)     //us
  166. #define IR_RC5_BIT          (889*2*CYCLES_PER_US/TIMER_PRESC)   //us
  167. #define IR_RC5_TIMEOUT      (117-IR_MAX_PULSE_WIDTH/1000)       //ms    (time between ir frames)
  168. #define IR_RC5_REPS         (1)                                 //      (minimum number of times to repeat code)
  169. #define IR_RC5_F_MOD        (36)                                //kHz   (modulation frequency)
  170. #define IR_RC5_TOL_DIV      (4)
  171.  
  172. /* RC6 Implementation
  173.  * Receiver:
  174.  * Transmitter:
  175.  */
  176. #define IR_PROTO_RC6        (1)
  177. #define IR_RC6_ST_BIT       (1*CYCLES_PER_US/TIMER_PRESC)       //us
  178. #define IR_RC6_TIMEOUT      (50-IR_MAX_PULSE_WIDTH/1000)        //ms    (time between ir frames)
  179. #define IR_RC6_REPS         (1)                                 //      (minimum number of times to repeat code)
  180. #define IR_RC6_F_MOD        (36)                                //kHz   (modulation frequency)
  181. #define IR_RC6_TOL_DIV      (4)
  182.  
  183. /* RCMM Implementation
  184.  * Receiver:
  185.  * Transmitter:
  186.  */
  187. #define IR_PROTO_RCMM       (2)
  188. #define IR_RCMM_ST_BIT      (256*CYCLES_PER_US/TIMER_PRESC)     //us
  189. #define IR_RCMM_TIMEOUT     (170-IR_MAX_PULSE_WIDTH/1000)       //ms    (time between ir frames)
  190. #define IR_RCMM_REPS        (1)                                 //      (minimum number of times to repeat code)
  191. #define IR_RCMM_F_MOD       (36)                                //kHz   (modulation frequency)
  192. #define IR_RCMM_TOL_DIV     (4)
  193.  
  194. /* SIRC Implementation
  195.  * Receiver: DONE
  196.  * Transmitter: DONE
  197.  */
  198. #define IR_PROTO_SIRC       (3)
  199. #define IR_SIRC_ST_BIT      (2400*CYCLES_PER_US/TIMER_PRESC)    //us
  200. #define IR_SIRC_LOW         (600*CYCLES_PER_US/TIMER_PRESC)     //us
  201. #define IR_SIRC_HIGH_ONE    (1200*CYCLES_PER_US/TIMER_PRESC)    //us
  202. #define IR_SIRC_HIGH_ZERO   (600*CYCLES_PER_US/TIMER_PRESC)     //us
  203. #define IR_SIRC_TIMEOUT     (52-IR_MAX_PULSE_WIDTH/1000)                                    //ms    (time between ir frames)
  204. #define IR_SIRC_REPS        (3)                                 //      (minimum number of times to repeat code)
  205. #define IR_SIRC_F_MOD       (40)                                //kHz   (modulation frequency)
  206. #define IR_SIRC_TOL_DIV     (4)
  207.  
  208. /* Sharp Implementation
  209.  * Receiver: DONE
  210.  * Transmitter:
  211.  */
  212. #define IR_PROTO_SHARP      (4)
  213. #define IR_SHARP_HIGH       (280*CYCLES_PER_US/TIMER_PRESC)     //us
  214. #define IR_SHARP_LOW_ONE    (1850*CYCLES_PER_US/TIMER_PRESC)    //us
  215. #define IR_SHARP_LOW_ZERO   (780*CYCLES_PER_US/TIMER_PRESC)     //us
  216. #define IR_SHARP_TIMEOUT    (67-IR_MAX_PULSE_WIDTH/1000)        //ms    (time between ir frames)
  217. #define IR_SHARP_REPS       (2)                                 //      (minimum number of times to repeat code)
  218. #define IR_SHARP_F_MOD      (38)                                //kHz   (modulation frequency)
  219. #define IR_SHARP_TOL_DIV    (4)
  220.  
  221. /* NEC Implementation
  222.  * Receiver: DONE
  223.  * Transmitter: DONE
  224.  */
  225. #define IR_PROTO_NEC        (5)
  226. #define IR_NEC_ST_BIT       (9000*CYCLES_PER_US/TIMER_PRESC)    //us
  227. #define IR_NEC_ST_PAUSE     (4500*CYCLES_PER_US/TIMER_PRESC)    //us
  228. #define IR_NEC_LOW_ONE      (1690*CYCLES_PER_US/TIMER_PRESC)    //us
  229. #define IR_NEC_LOW_ZERO     (560*CYCLES_PER_US/TIMER_PRESC)     //us
  230. #define IR_NEC_HIGH         (560*CYCLES_PER_US/TIMER_PRESC)     //us
  231. #define IR_NEC_TIMEOUT      (122-IR_MAX_PULSE_WIDTH/1000)       //ms    (time between ir frames)
  232. #define IR_NEC_ST_TIMEOUT   (65)                                //ms    (time between first ir frames and second)
  233. #define IR_NEC_REPS         (1)                                 //      (minimum number of times to repeat code)
  234. #define IR_NEC_F_MOD        (38)                                //kHz   (modulation frequency)
  235. #define IR_NEC_TOL_DIV      (4)
  236.  
  237. /* Samsung Implementation
  238.  * Receiver: DONE
  239.  * Transmitter: DONE
  240.  */
  241. #define IR_PROTO_SAMS       (6)
  242. #define IR_SAMS_ST_BIT      (4500*CYCLES_PER_US/TIMER_PRESC)    //us
  243. #define IR_SAMS_ST_PAUSE    (4500*CYCLES_PER_US/TIMER_PRESC)    //us
  244. #define IR_SAMS_LOW_ONE     (1720*CYCLES_PER_US/TIMER_PRESC)    //us
  245. #define IR_SAMS_LOW_ZERO    (650*CYCLES_PER_US/TIMER_PRESC)     //us
  246. #define IR_SAMS_HIGH        (500*CYCLES_PER_US/TIMER_PRESC)     //us
  247. #define IR_SAMS_TIMEOUT     (62-IR_MAX_PULSE_WIDTH/1000)        //ms    (time between ir frames)
  248. #define IR_SAMS_REPS        (1)                                 //      (minimum number of times to repeat code)
  249. #define IR_SAMS_F_MOD       (38)                                //kHz   (modulation frequency)
  250. #define IR_SAMS_TOL_DIV     (4)
  251.  
  252. /* Marantz Implementation
  253.  * Receiver: DONE (has not been tested with odd adressbits)
  254.  * Transmitter: DONE
  255.  */
  256. #define IR_PROTO_MARANTZ        (7)
  257. #define IR_MARANTZ_HALF_BIT     (889*CYCLES_PER_US/TIMER_PRESC)     //us
  258. #define IR_MARANTZ_BIT          (889*2*CYCLES_PER_US/TIMER_PRESC)   //us
  259. #define IR_MARANTZ_TIMEOUT      (117-IR_MAX_PULSE_WIDTH/1000)       //ms    (time between ir frames)
  260. #define IR_MARANTZ_REPS         (1)                                 //      (minimum number of times to repeat code)
  261. #define IR_MARANTZ_F_MOD        (36)                                //kHz   (modulation frequency)
  262. #define IR_MARANTZ_TOL_DIV      (4)
  263.  
  264. /* Panasonic Implementation
  265.  * Receiver: DONE
  266.  * Transmitter: DONE
  267.  */
  268. #define IR_PROTO_PANASONIC  (8)
  269. #define IR_PANA_ST_BIT      (3570*CYCLES_PER_US/TIMER_PRESC)    //us
  270. #define IR_PANA_ST_PAUSE    (1630*CYCLES_PER_US/TIMER_PRESC)    //us
  271. #define IR_PANA_LOW_ONE     (1240*CYCLES_PER_US/TIMER_PRESC)    //us
  272. #define IR_PANA_LOW_ZERO    (400*CYCLES_PER_US/TIMER_PRESC)     //us
  273. #define IR_PANA_HIGH        (495*CYCLES_PER_US/TIMER_PRESC)     //us
  274. #define IR_PANA_TIMEOUT     (92-IR_MAX_PULSE_WIDTH/1000)        //ms    (time between ir frames)
  275. #define IR_PANA_REPS        (1)                                 //      (minimum number of times to repeat code)
  276. #define IR_PANA_F_MOD       (38)                                //kHz   (modulation frequency)
  277. #define IR_PANA_TOL_DIV     (4)
  278.  
  279. /* Sky Implementation
  280.  * Receiver: DONE
  281.  * Transmitter:
  282.  */
  283. #define IR_PROTO_SKY        (9)
  284. #define IR_SKY_ST_BIT       (2800*CYCLES_PER_US/TIMER_PRESC)    //us
  285. #define IR_SKY_SHORT        (460*CYCLES_PER_US/TIMER_PRESC)     //us
  286. #define IR_SKY_LONG         (920*CYCLES_PER_US/TIMER_PRESC)     //us
  287. #define IR_SKY_TIMEOUT      (162-IR_MAX_PULSE_WIDTH/1000)       //ms    (time between ir frames)
  288. #define IR_SKY_REPS         (1)                                 //      (minimum number of times to repeat code)
  289. #define IR_SKY_F_MOD        (38)                                //kHz   (modulation frequency)
  290. #define IR_SKY_TOL_DIV      (4)
  291.  
  292.  
  293. /* Nexa2 Implementation
  294.  * Receiver: DONE
  295.  * Transmitter: DONE
  296.  */
  297. #define IR_PROTO_NEXA2      (10)
  298. #define IR_NEXA2_START1     (10000*CYCLES_PER_US/TIMER_PRESC)   //us
  299. #define IR_NEXA2_START2     (2500*CYCLES_PER_US/TIMER_PRESC)    //us
  300. #define IR_NEXA2_HIGH       (320*CYCLES_PER_US/TIMER_PRESC)     //us
  301. #define IR_NEXA2_LOW_ONE    (210*CYCLES_PER_US/TIMER_PRESC)     //us
  302. #define IR_NEXA2_LOW_ZERO   (1200*CYCLES_PER_US/TIMER_PRESC)    //us
  303. #define IR_NEXA2_TIMEOUT    (200)                               //ms    (time between ir frames)
  304. #define IR_NEXA2_REPS       (5)                                 //      (minimum number of times to repeat code)
  305. #define IR_NEXA2_F_MOD      (38)                                //kHz   (modulation frequency)
  306. #define IR_NEXA2_TOL_DIV    (2)
  307.  
  308.  
  309. /* Nexa1 Implementation
  310.  * Receiver: DONE
  311.  * Transmitter:
  312.  */
  313. #define IR_PROTO_NEXA1      (11)
  314. #define IR_NEXA1_START      (10000*CYCLES_PER_US/TIMER_PRESC)   //us
  315. #define IR_NEXA1_SHORT      (370*CYCLES_PER_US/TIMER_PRESC)     //us
  316. #define IR_NEXA1_LONG       (1050*CYCLES_PER_US/TIMER_PRESC)    //us
  317. #define IR_NEXA1_TIMEOUT    (200)                               //ms    (time between ir frames)
  318. #define IR_NEXA1_REPS       (4)                                 //      (minimum number of times to repeat code)
  319. #define IR_NEXA1_F_MOD      (38)                                //kHz   (modulation frequency)
  320. #define IR_NEXA1_TOL_DIV    (2)
  321.  
  322.  
  323. /* Viking Temperature sensor Implementation
  324.  * Receiver:
  325.  */
  326. #define IR_PROTO_VIKING     (12)
  327. #define IR_VIKING_LOW       (940*CYCLES_PER_US/TIMER_PRESC)     //us
  328. #define IR_VIKING_HIGH_ONE  (1483*CYCLES_PER_US/TIMER_PRESC)        //us
  329. #define IR_VIKING_HIGH_ZERO (550*CYCLES_PER_US/TIMER_PRESC) //us
  330. #define IR_VIKING_TIMEOUT   (0)                                 //ms BURST! (time between ir frames)
  331. #define IR_VIKING_REPS      (1)                                 //      (minimum number of times to repeat code)
  332. #define IR_VIKING_F_MOD     (38)                                //kHz   (modulation frequency)
  333. #define IR_VIKING_TOL_DIV   (3)
  334.  
  335.  
  336. #define IR_PROTO_HASH       0xfe
  337. #define IR_PROTO_UNKNOWN    0xff                                //
  338.  
  339.  
  340.  
  341. /**@}*/
  342. #endif /*IR_PROTOCOLS_H_*/
  343.