Subversion Repositories HomeAutomation

Rev

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