Subversion Repositories HomeAutomation

Rev

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