Subversion Repositories HomeAutomation

Rev

Rev 1715 | Rev 1823 | 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.  
  70. #if (IR_PROTOCOLS_USE_NEXA2)
  71. int8_t parseNexa2(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  72. #endif
  73.  
  74. /* Try to parse all above protocols until a match is found. */
  75. int8_t parseProtocol(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  76. /* The Hash protocol always succeeds and creates a one-way signature of the
  77.  * pulse times buffer that is supposed to be unique and constant for a specific
  78.  * IR event. It may be used to send a valid event even if the protocol hasn't
  79.  * been implemented or decoded yet. */
  80. int8_t parseHash(const uint16_t *buf, uint8_t len, Ir_Protocol_Data_t *proto);
  81.  
  82. /* These functions expand a Ir_Protocol_Data_t structure into a raw buffer with
  83.  * pulse lengths. They return IR_OK on success and IR_NOT_CORRECT_DATA if the
  84.  * Ir_Protocol_Data_t structure is for another protocol or contains invalid
  85.  * data. */
  86. int8_t expandSIRC(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  87. int8_t expandRC5(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  88. int8_t expandSharp(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  89. int8_t expandNEC(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  90. int8_t expandSamsung(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  91. int8_t expandMarantz(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  92. int8_t expandPanasonic(uint16_t *buf, uint8_t *len, Ir_Protocol_Data_t *proto);
  93. int8_t expandSky(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. #define IR_MAX_PULSE_WIDTH  12000                               //us
  119.  
  120. /* RC5 Implementation
  121.  * Receiver: DONE
  122.  * Transmitter: DONE
  123.  */
  124. #define IR_PROTO_RC5        0
  125. #define IR_RC5_HALF_BIT     889*CYCLES_PER_US/TIMER_PRESC       //us
  126. #define IR_RC5_BIT          889*2*CYCLES_PER_US/TIMER_PRESC     //us
  127. #define IR_RC5_TIMEOUT      105                                 //ms    (time between ir frames)
  128. #define IR_RC5_REPS         1                                   //      (minimum number of times to repeat code)
  129. #define IR_RC5_F_MOD        36                                  //kHz   (modulation frequency)
  130. #define IR_RC5_TOL_DIV      4
  131.  
  132. /* RC6 Implementation
  133.  * Receiver:
  134.  * Transmitter:
  135.  */
  136. #define IR_PROTO_RC6        1
  137. #define IR_RC6_ST_BIT       1*CYCLES_PER_US/TIMER_PRESC         //us
  138. #define IR_RC6_TIMEOUT      1                                   //ms    (time between ir frames)
  139. #define IR_RC6_REPS         1                                   //      (minimum number of times to repeat code)
  140. #define IR_RC6_F_MOD        36                                  //kHz   (modulation frequency)
  141. #define IR_RC6_TOL_DIV      4
  142.  
  143. /* RCMM Implementation
  144.  * Receiver:
  145.  * Transmitter:
  146.  */
  147. #define IR_PROTO_RCMM       2
  148. #define IR_RCMM_ST_BIT      256*CYCLES_PER_US/TIMER_PRESC       //us
  149. #define IR_RCMM_TIMEOUT     158                                 //ms    (time between ir frames)
  150. #define IR_RCMM_REPS        1                                   //      (minimum number of times to repeat code)
  151. #define IR_RCMM_F_MOD       36                                  //kHz   (modulation frequency)
  152. #define IR_RCMM_TOL_DIV     4
  153.  
  154. /* SIRC Implementation
  155.  * Receiver: DONE
  156.  * Transmitter: DONE
  157.  */
  158. #define IR_PROTO_SIRC       3
  159. #define IR_SIRC_ST_BIT      2400*CYCLES_PER_US/TIMER_PRESC      //us
  160. #define IR_SIRC_LOW         600*CYCLES_PER_US/TIMER_PRESC       //us
  161. #define IR_SIRC_HIGH_ONE    1200*CYCLES_PER_US/TIMER_PRESC      //us
  162. #define IR_SIRC_HIGH_ZERO   600*CYCLES_PER_US/TIMER_PRESC       //us
  163. #define IR_SIRC_TIMEOUT     40                                  //ms    (time between ir frames)
  164. #define IR_SIRC_REPS        3                                   //      (minimum number of times to repeat code)
  165. #define IR_SIRC_F_MOD       40                                  //kHz   (modulation frequency)
  166. #define IR_SIRC_TOL_DIV     4
  167.  
  168. /* Sharp Implementation
  169.  * Receiver: DONE
  170.  * Transmitter:
  171.  */
  172. #define IR_PROTO_SHARP      4
  173. #define IR_SHARP_HIGH       280*CYCLES_PER_US/TIMER_PRESC       //us
  174. #define IR_SHARP_LOW_ONE    1850*CYCLES_PER_US/TIMER_PRESC      //us
  175. #define IR_SHARP_LOW_ZERO   780*CYCLES_PER_US/TIMER_PRESC       //us
  176. #define IR_SHARP_TIMEOUT    55                                  //ms    (time between ir frames)
  177. #define IR_SHARP_REPS       2                                   //      (minimum number of times to repeat code)
  178. #define IR_SHARP_F_MOD      38                                  //kHz   (modulation frequency)
  179. #define IR_SHARP_TOL_DIV    4
  180.  
  181. /* NEC Implementation
  182.  * Receiver: DONE
  183.  * Transmitter: DONE
  184.  */
  185. #define IR_PROTO_NEC        5
  186. #define IR_NEC_ST_BIT       9000*CYCLES_PER_US/TIMER_PRESC      //us
  187. #define IR_NEC_ST_PAUSE     4500*CYCLES_PER_US/TIMER_PRESC      //us
  188. #define IR_NEC_LOW_ONE      1690*CYCLES_PER_US/TIMER_PRESC      //us
  189. #define IR_NEC_LOW_ZERO     560*CYCLES_PER_US/TIMER_PRESC       //us
  190. #define IR_NEC_HIGH         560*CYCLES_PER_US/TIMER_PRESC       //us
  191. #define IR_NEC_TIMEOUT      110                                 //ms    (time between ir frames)
  192. #define IR_NEC_ST_TIMEOUT   65                                  //ms    (time between first ir frames and second)
  193. #define IR_NEC_REPS         1                                   //      (minimum number of times to repeat code)
  194. #define IR_NEC_F_MOD        38                                  //kHz   (modulation frequency)
  195. #define IR_NEC_TOL_DIV      4
  196.  
  197. /* Samsung Implementation
  198.  * Receiver: DONE
  199.  * Transmitter: DONE
  200.  */
  201. #define IR_PROTO_SAMS       6
  202. #define IR_SAMS_ST_BIT      4500*CYCLES_PER_US/TIMER_PRESC      //us
  203. #define IR_SAMS_ST_PAUSE    4500*CYCLES_PER_US/TIMER_PRESC      //us
  204. #define IR_SAMS_LOW_ONE     1720*CYCLES_PER_US/TIMER_PRESC      //us
  205. #define IR_SAMS_LOW_ZERO    650*CYCLES_PER_US/TIMER_PRESC       //us
  206. #define IR_SAMS_HIGH        500*CYCLES_PER_US/TIMER_PRESC       //us
  207. #define IR_SAMS_TIMEOUT     50                                  //ms    (time between ir frames)
  208. #define IR_SAMS_REPS        1                                   //      (minimum number of times to repeat code)
  209. #define IR_SAMS_F_MOD       38                                  //kHz   (modulation frequency)
  210. #define IR_SAMS_TOL_DIV     4
  211.  
  212. /* Marantz Implementation
  213.  * Receiver: DONE (has not been tested with odd adressbits)
  214.  * Transmitter: DONE
  215.  */
  216. #define IR_PROTO_MARANTZ        7
  217. #define IR_MARANTZ_HALF_BIT     889*CYCLES_PER_US/TIMER_PRESC       //us
  218. #define IR_MARANTZ_BIT          889*2*CYCLES_PER_US/TIMER_PRESC     //us
  219. #define IR_MARANTZ_TIMEOUT      105                                 //ms    (time between ir frames)
  220. #define IR_MARANTZ_REPS         1                                   //      (minimum number of times to repeat code)
  221. #define IR_MARANTZ_F_MOD        36                                  //kHz   (modulation frequency)
  222. #define IR_MARANTZ_TOL_DIV      4
  223.  
  224. /* Panasonic Implementation
  225.  * Receiver: DONE
  226.  * Transmitter: DONE
  227.  */
  228. #define IR_PROTO_PANASONIC  8
  229. #define IR_PANA_ST_BIT      3570*CYCLES_PER_US/TIMER_PRESC      //us
  230. #define IR_PANA_ST_PAUSE    1630*CYCLES_PER_US/TIMER_PRESC      //us
  231. #define IR_PANA_LOW_ONE     1240*CYCLES_PER_US/TIMER_PRESC      //us
  232. #define IR_PANA_LOW_ZERO    400*CYCLES_PER_US/TIMER_PRESC       //us
  233. #define IR_PANA_HIGH        495*CYCLES_PER_US/TIMER_PRESC       //us
  234. #define IR_PANA_TIMEOUT     80                                  //ms    (time between ir frames)
  235. #define IR_PANA_REPS        1                                   //      (minimum number of times to repeat code)
  236. #define IR_PANA_F_MOD       38                                  //kHz   (modulation frequency)
  237. #define IR_PANA_TOL_DIV     4
  238.  
  239. /* Sky Implementation
  240.  * Receiver: DONE
  241.  * Transmitter:
  242.  */
  243. #define IR_PROTO_SKY        9
  244. #define IR_SKY_ST_BIT       2800*CYCLES_PER_US/TIMER_PRESC      //us
  245. #define IR_SKY_SHORT        460*CYCLES_PER_US/TIMER_PRESC       //us
  246. #define IR_SKY_LONG         920*CYCLES_PER_US/TIMER_PRESC       //us
  247. #define IR_SKY_TIMEOUT      150                                 //ms    (time between ir frames)
  248. #define IR_SKY_REPS         1                                   //      (minimum number of times to repeat code)
  249. #define IR_SKY_F_MOD        38                                  //kHz   (modulation frequency)
  250. #define IR_SKY_TOL_DIV      4
  251.  
  252.  
  253. /* Nexa2 Implementation
  254.  * Receiver:
  255.  * Transmitter:
  256.  */
  257. #define IR_PROTO_NEXA2      10
  258. #define IR_NEXA2_START      2500*CYCLES_PER_US/TIMER_PRESC      //us
  259. #define IR_NEXA2_HIGH       320*CYCLES_PER_US/TIMER_PRESC       //us
  260. #define IR_NEXA2_LOW_ONE    210*CYCLES_PER_US/TIMER_PRESC       //us
  261. #define IR_NEXA2_LOW_ZERO   1200*CYCLES_PER_US/TIMER_PRESC      //us
  262. #define IR_NEXA2_TIMEOUT    10                                  //ms    (time between ir frames)
  263. #define IR_NEXA2_REPS       4                                   //      (minimum number of times to repeat code)
  264. #define IR_NEXA2_TOL_DIV    4
  265.  
  266.  
  267. #define IR_PROTO_HASH       0xfe
  268. #define IR_PROTO_UNKNOWN    0xff                                //
  269.  
  270.  
  271.  
  272. /**@}*/
  273. #endif /*IR_PROTOCOLS_H_*/
  274.