├── LICENSE.md
├── README.md
├── examples
└── Example1_Listening
│ └── Example1_Listening.ino
├── keywords.txt
├── library.properties
└── src
├── CEC
├── CEC.cpp
├── CEC.h
├── CEC_Device.cpp
├── CEC_Device.h
├── CEC_Electrical.cpp
├── CEC_Electrical.h
├── Common.cpp
├── Common.h
├── Serial.cpp
└── Serial.h
├── CEClient.cpp
└── CEClient.h
/LICENSE.md:
--------------------------------------------------------------------------------
1 | ### GNU GENERAL PUBLIC LICENSE
2 |
3 | Version 3, 29 June 2007
4 |
5 | Copyright (C) 2007 Free Software Foundation, Inc.
6 |
7 |
8 | Everyone is permitted to copy and distribute verbatim copies of this
9 | license document, but changing it is not allowed.
10 |
11 | ### Preamble
12 |
13 | The GNU General Public License is a free, copyleft license for
14 | software and other kinds of works.
15 |
16 | The licenses for most software and other practical works are designed
17 | to take away your freedom to share and change the works. By contrast,
18 | the GNU General Public License is intended to guarantee your freedom
19 | to share and change all versions of a program--to make sure it remains
20 | free software for all its users. We, the Free Software Foundation, use
21 | the GNU General Public License for most of our software; it applies
22 | also to any other work released this way by its authors. You can apply
23 | it to your programs, too.
24 |
25 | When we speak of free software, we are referring to freedom, not
26 | price. Our General Public Licenses are designed to make sure that you
27 | have the freedom to distribute copies of free software (and charge for
28 | them if you wish), that you receive source code or can get it if you
29 | want it, that you can change the software or use pieces of it in new
30 | free programs, and that you know you can do these things.
31 |
32 | To protect your rights, we need to prevent others from denying you
33 | these rights or asking you to surrender the rights. Therefore, you
34 | have certain responsibilities if you distribute copies of the
35 | software, or if you modify it: responsibilities to respect the freedom
36 | of others.
37 |
38 | For example, if you distribute copies of such a program, whether
39 | gratis or for a fee, you must pass on to the recipients the same
40 | freedoms that you received. You must make sure that they, too, receive
41 | or can get the source code. And you must show them these terms so they
42 | know their rights.
43 |
44 | Developers that use the GNU GPL protect your rights with two steps:
45 | (1) assert copyright on the software, and (2) offer you this License
46 | giving you legal permission to copy, distribute and/or modify it.
47 |
48 | For the developers' and authors' protection, the GPL clearly explains
49 | that there is no warranty for this free software. For both users' and
50 | authors' sake, the GPL requires that modified versions be marked as
51 | changed, so that their problems will not be attributed erroneously to
52 | authors of previous versions.
53 |
54 | Some devices are designed to deny users access to install or run
55 | modified versions of the software inside them, although the
56 | manufacturer can do so. This is fundamentally incompatible with the
57 | aim of protecting users' freedom to change the software. The
58 | systematic pattern of such abuse occurs in the area of products for
59 | individuals to use, which is precisely where it is most unacceptable.
60 | Therefore, we have designed this version of the GPL to prohibit the
61 | practice for those products. If such problems arise substantially in
62 | other domains, we stand ready to extend this provision to those
63 | domains in future versions of the GPL, as needed to protect the
64 | freedom of users.
65 |
66 | Finally, every program is threatened constantly by software patents.
67 | States should not allow patents to restrict development and use of
68 | software on general-purpose computers, but in those that do, we wish
69 | to avoid the special danger that patents applied to a free program
70 | could make it effectively proprietary. To prevent this, the GPL
71 | assures that patents cannot be used to render the program non-free.
72 |
73 | The precise terms and conditions for copying, distribution and
74 | modification follow.
75 |
76 | ### TERMS AND CONDITIONS
77 |
78 | #### 0. Definitions.
79 |
80 | "This License" refers to version 3 of the GNU General Public License.
81 |
82 | "Copyright" also means copyright-like laws that apply to other kinds
83 | of works, such as semiconductor masks.
84 |
85 | "The Program" refers to any copyrightable work licensed under this
86 | License. Each licensee is addressed as "you". "Licensees" and
87 | "recipients" may be individuals or organizations.
88 |
89 | To "modify" a work means to copy from or adapt all or part of the work
90 | in a fashion requiring copyright permission, other than the making of
91 | an exact copy. The resulting work is called a "modified version" of
92 | the earlier work or a work "based on" the earlier work.
93 |
94 | A "covered work" means either the unmodified Program or a work based
95 | on the Program.
96 |
97 | To "propagate" a work means to do anything with it that, without
98 | permission, would make you directly or secondarily liable for
99 | infringement under applicable copyright law, except executing it on a
100 | computer or modifying a private copy. Propagation includes copying,
101 | distribution (with or without modification), making available to the
102 | public, and in some countries other activities as well.
103 |
104 | To "convey" a work means any kind of propagation that enables other
105 | parties to make or receive copies. Mere interaction with a user
106 | through a computer network, with no transfer of a copy, is not
107 | conveying.
108 |
109 | An interactive user interface displays "Appropriate Legal Notices" to
110 | the extent that it includes a convenient and prominently visible
111 | feature that (1) displays an appropriate copyright notice, and (2)
112 | tells the user that there is no warranty for the work (except to the
113 | extent that warranties are provided), that licensees may convey the
114 | work under this License, and how to view a copy of this License. If
115 | the interface presents a list of user commands or options, such as a
116 | menu, a prominent item in the list meets this criterion.
117 |
118 | #### 1. Source Code.
119 |
120 | The "source code" for a work means the preferred form of the work for
121 | making modifications to it. "Object code" means any non-source form of
122 | a work.
123 |
124 | A "Standard Interface" means an interface that either is an official
125 | standard defined by a recognized standards body, or, in the case of
126 | interfaces specified for a particular programming language, one that
127 | is widely used among developers working in that language.
128 |
129 | The "System Libraries" of an executable work include anything, other
130 | than the work as a whole, that (a) is included in the normal form of
131 | packaging a Major Component, but which is not part of that Major
132 | Component, and (b) serves only to enable use of the work with that
133 | Major Component, or to implement a Standard Interface for which an
134 | implementation is available to the public in source code form. A
135 | "Major Component", in this context, means a major essential component
136 | (kernel, window system, and so on) of the specific operating system
137 | (if any) on which the executable work runs, or a compiler used to
138 | produce the work, or an object code interpreter used to run it.
139 |
140 | The "Corresponding Source" for a work in object code form means all
141 | the source code needed to generate, install, and (for an executable
142 | work) run the object code and to modify the work, including scripts to
143 | control those activities. However, it does not include the work's
144 | System Libraries, or general-purpose tools or generally available free
145 | programs which are used unmodified in performing those activities but
146 | which are not part of the work. For example, Corresponding Source
147 | includes interface definition files associated with source files for
148 | the work, and the source code for shared libraries and dynamically
149 | linked subprograms that the work is specifically designed to require,
150 | such as by intimate data communication or control flow between those
151 | subprograms and other parts of the work.
152 |
153 | The Corresponding Source need not include anything that users can
154 | regenerate automatically from other parts of the Corresponding Source.
155 |
156 | The Corresponding Source for a work in source code form is that same
157 | work.
158 |
159 | #### 2. Basic Permissions.
160 |
161 | All rights granted under this License are granted for the term of
162 | copyright on the Program, and are irrevocable provided the stated
163 | conditions are met. This License explicitly affirms your unlimited
164 | permission to run the unmodified Program. The output from running a
165 | covered work is covered by this License only if the output, given its
166 | content, constitutes a covered work. This License acknowledges your
167 | rights of fair use or other equivalent, as provided by copyright law.
168 |
169 | You may make, run and propagate covered works that you do not convey,
170 | without conditions so long as your license otherwise remains in force.
171 | You may convey covered works to others for the sole purpose of having
172 | them make modifications exclusively for you, or provide you with
173 | facilities for running those works, provided that you comply with the
174 | terms of this License in conveying all material for which you do not
175 | control copyright. Those thus making or running the covered works for
176 | you must do so exclusively on your behalf, under your direction and
177 | control, on terms that prohibit them from making any copies of your
178 | copyrighted material outside their relationship with you.
179 |
180 | Conveying under any other circumstances is permitted solely under the
181 | conditions stated below. Sublicensing is not allowed; section 10 makes
182 | it unnecessary.
183 |
184 | #### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
185 |
186 | No covered work shall be deemed part of an effective technological
187 | measure under any applicable law fulfilling obligations under article
188 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
189 | similar laws prohibiting or restricting circumvention of such
190 | measures.
191 |
192 | When you convey a covered work, you waive any legal power to forbid
193 | circumvention of technological measures to the extent such
194 | circumvention is effected by exercising rights under this License with
195 | respect to the covered work, and you disclaim any intention to limit
196 | operation or modification of the work as a means of enforcing, against
197 | the work's users, your or third parties' legal rights to forbid
198 | circumvention of technological measures.
199 |
200 | #### 4. Conveying Verbatim Copies.
201 |
202 | You may convey verbatim copies of the Program's source code as you
203 | receive it, in any medium, provided that you conspicuously and
204 | appropriately publish on each copy an appropriate copyright notice;
205 | keep intact all notices stating that this License and any
206 | non-permissive terms added in accord with section 7 apply to the code;
207 | keep intact all notices of the absence of any warranty; and give all
208 | recipients a copy of this License along with the Program.
209 |
210 | You may charge any price or no price for each copy that you convey,
211 | and you may offer support or warranty protection for a fee.
212 |
213 | #### 5. Conveying Modified Source Versions.
214 |
215 | You may convey a work based on the Program, or the modifications to
216 | produce it from the Program, in the form of source code under the
217 | terms of section 4, provided that you also meet all of these
218 | conditions:
219 |
220 | - a) The work must carry prominent notices stating that you modified
221 | it, and giving a relevant date.
222 | - b) The work must carry prominent notices stating that it is
223 | released under this License and any conditions added under
224 | section 7. This requirement modifies the requirement in section 4
225 | to "keep intact all notices".
226 | - c) You must license the entire work, as a whole, under this
227 | License to anyone who comes into possession of a copy. This
228 | License will therefore apply, along with any applicable section 7
229 | additional terms, to the whole of the work, and all its parts,
230 | regardless of how they are packaged. This License gives no
231 | permission to license the work in any other way, but it does not
232 | invalidate such permission if you have separately received it.
233 | - d) If the work has interactive user interfaces, each must display
234 | Appropriate Legal Notices; however, if the Program has interactive
235 | interfaces that do not display Appropriate Legal Notices, your
236 | work need not make them do so.
237 |
238 | A compilation of a covered work with other separate and independent
239 | works, which are not by their nature extensions of the covered work,
240 | and which are not combined with it such as to form a larger program,
241 | in or on a volume of a storage or distribution medium, is called an
242 | "aggregate" if the compilation and its resulting copyright are not
243 | used to limit the access or legal rights of the compilation's users
244 | beyond what the individual works permit. Inclusion of a covered work
245 | in an aggregate does not cause this License to apply to the other
246 | parts of the aggregate.
247 |
248 | #### 6. Conveying Non-Source Forms.
249 |
250 | You may convey a covered work in object code form under the terms of
251 | sections 4 and 5, provided that you also convey the machine-readable
252 | Corresponding Source under the terms of this License, in one of these
253 | ways:
254 |
255 | - a) Convey the object code in, or embodied in, a physical product
256 | (including a physical distribution medium), accompanied by the
257 | Corresponding Source fixed on a durable physical medium
258 | customarily used for software interchange.
259 | - b) Convey the object code in, or embodied in, a physical product
260 | (including a physical distribution medium), accompanied by a
261 | written offer, valid for at least three years and valid for as
262 | long as you offer spare parts or customer support for that product
263 | model, to give anyone who possesses the object code either (1) a
264 | copy of the Corresponding Source for all the software in the
265 | product that is covered by this License, on a durable physical
266 | medium customarily used for software interchange, for a price no
267 | more than your reasonable cost of physically performing this
268 | conveying of source, or (2) access to copy the Corresponding
269 | Source from a network server at no charge.
270 | - c) Convey individual copies of the object code with a copy of the
271 | written offer to provide the Corresponding Source. This
272 | alternative is allowed only occasionally and noncommercially, and
273 | only if you received the object code with such an offer, in accord
274 | with subsection 6b.
275 | - d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 | - e) Convey the object code using peer-to-peer transmission,
288 | provided you inform other peers where the object code and
289 | Corresponding Source of the work are being offered to the general
290 | public at no charge under subsection 6d.
291 |
292 | A separable portion of the object code, whose source code is excluded
293 | from the Corresponding Source as a System Library, need not be
294 | included in conveying the object code work.
295 |
296 | A "User Product" is either (1) a "consumer product", which means any
297 | tangible personal property which is normally used for personal,
298 | family, or household purposes, or (2) anything designed or sold for
299 | incorporation into a dwelling. In determining whether a product is a
300 | consumer product, doubtful cases shall be resolved in favor of
301 | coverage. For a particular product received by a particular user,
302 | "normally used" refers to a typical or common use of that class of
303 | product, regardless of the status of the particular user or of the way
304 | in which the particular user actually uses, or expects or is expected
305 | to use, the product. A product is a consumer product regardless of
306 | whether the product has substantial commercial, industrial or
307 | non-consumer uses, unless such uses represent the only significant
308 | mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to
312 | install and execute modified versions of a covered work in that User
313 | Product from a modified version of its Corresponding Source. The
314 | information must suffice to ensure that the continued functioning of
315 | the modified object code is in no case prevented or interfered with
316 | solely because modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or
331 | updates for a work that has been modified or installed by the
332 | recipient, or for the User Product in which it has been modified or
333 | installed. Access to a network may be denied when the modification
334 | itself materially and adversely affects the operation of the network
335 | or violates the rules and protocols for communication across the
336 | network.
337 |
338 | Corresponding Source conveyed, and Installation Information provided,
339 | in accord with this section must be in a format that is publicly
340 | documented (and with an implementation available to the public in
341 | source code form), and must require no special password or key for
342 | unpacking, reading or copying.
343 |
344 | #### 7. Additional Terms.
345 |
346 | "Additional permissions" are terms that supplement the terms of this
347 | License by making exceptions from one or more of its conditions.
348 | Additional permissions that are applicable to the entire Program shall
349 | be treated as though they were included in this License, to the extent
350 | that they are valid under applicable law. If additional permissions
351 | apply only to part of the Program, that part may be used separately
352 | under those permissions, but the entire Program remains governed by
353 | this License without regard to the additional permissions.
354 |
355 | When you convey a copy of a covered work, you may at your option
356 | remove any additional permissions from that copy, or from any part of
357 | it. (Additional permissions may be written to require their own
358 | removal in certain cases when you modify the work.) You may place
359 | additional permissions on material, added by you to a covered work,
360 | for which you have or can give appropriate copyright permission.
361 |
362 | Notwithstanding any other provision of this License, for material you
363 | add to a covered work, you may (if authorized by the copyright holders
364 | of that material) supplement the terms of this License with terms:
365 |
366 | - a) Disclaiming warranty or limiting liability differently from the
367 | terms of sections 15 and 16 of this License; or
368 | - b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 | - c) Prohibiting misrepresentation of the origin of that material,
372 | or requiring that modified versions of such material be marked in
373 | reasonable ways as different from the original version; or
374 | - d) Limiting the use for publicity purposes of names of licensors
375 | or authors of the material; or
376 | - e) Declining to grant rights under trademark law for use of some
377 | trade names, trademarks, or service marks; or
378 | - f) Requiring indemnification of licensors and authors of that
379 | material by anyone who conveys the material (or modified versions
380 | of it) with contractual assumptions of liability to the recipient,
381 | for any liability that these contractual assumptions directly
382 | impose on those licensors and authors.
383 |
384 | All other non-permissive additional terms are considered "further
385 | restrictions" within the meaning of section 10. If the Program as you
386 | received it, or any part of it, contains a notice stating that it is
387 | governed by this License along with a term that is a further
388 | restriction, you may remove that term. If a license document contains
389 | a further restriction but permits relicensing or conveying under this
390 | License, you may add to a covered work material governed by the terms
391 | of that license document, provided that the further restriction does
392 | not survive such relicensing or conveying.
393 |
394 | If you add terms to a covered work in accord with this section, you
395 | must place, in the relevant source files, a statement of the
396 | additional terms that apply to those files, or a notice indicating
397 | where to find the applicable terms.
398 |
399 | Additional terms, permissive or non-permissive, may be stated in the
400 | form of a separately written license, or stated as exceptions; the
401 | above requirements apply either way.
402 |
403 | #### 8. Termination.
404 |
405 | You may not propagate or modify a covered work except as expressly
406 | provided under this License. Any attempt otherwise to propagate or
407 | modify it is void, and will automatically terminate your rights under
408 | this License (including any patent licenses granted under the third
409 | paragraph of section 11).
410 |
411 | However, if you cease all violation of this License, then your license
412 | from a particular copyright holder is reinstated (a) provisionally,
413 | unless and until the copyright holder explicitly and finally
414 | terminates your license, and (b) permanently, if the copyright holder
415 | fails to notify you of the violation by some reasonable means prior to
416 | 60 days after the cessation.
417 |
418 | Moreover, your license from a particular copyright holder is
419 | reinstated permanently if the copyright holder notifies you of the
420 | violation by some reasonable means, this is the first time you have
421 | received notice of violation of this License (for any work) from that
422 | copyright holder, and you cure the violation prior to 30 days after
423 | your receipt of the notice.
424 |
425 | Termination of your rights under this section does not terminate the
426 | licenses of parties who have received copies or rights from you under
427 | this License. If your rights have been terminated and not permanently
428 | reinstated, you do not qualify to receive new licenses for the same
429 | material under section 10.
430 |
431 | #### 9. Acceptance Not Required for Having Copies.
432 |
433 | You are not required to accept this License in order to receive or run
434 | a copy of the Program. Ancillary propagation of a covered work
435 | occurring solely as a consequence of using peer-to-peer transmission
436 | to receive a copy likewise does not require acceptance. However,
437 | nothing other than this License grants you permission to propagate or
438 | modify any covered work. These actions infringe copyright if you do
439 | not accept this License. Therefore, by modifying or propagating a
440 | covered work, you indicate your acceptance of this License to do so.
441 |
442 | #### 10. Automatic Licensing of Downstream Recipients.
443 |
444 | Each time you convey a covered work, the recipient automatically
445 | receives a license from the original licensors, to run, modify and
446 | propagate that work, subject to this License. You are not responsible
447 | for enforcing compliance by third parties with this License.
448 |
449 | An "entity transaction" is a transaction transferring control of an
450 | organization, or substantially all assets of one, or subdividing an
451 | organization, or merging organizations. If propagation of a covered
452 | work results from an entity transaction, each party to that
453 | transaction who receives a copy of the work also receives whatever
454 | licenses to the work the party's predecessor in interest had or could
455 | give under the previous paragraph, plus a right to possession of the
456 | Corresponding Source of the work from the predecessor in interest, if
457 | the predecessor has it or can get it with reasonable efforts.
458 |
459 | You may not impose any further restrictions on the exercise of the
460 | rights granted or affirmed under this License. For example, you may
461 | not impose a license fee, royalty, or other charge for exercise of
462 | rights granted under this License, and you may not initiate litigation
463 | (including a cross-claim or counterclaim in a lawsuit) alleging that
464 | any patent claim is infringed by making, using, selling, offering for
465 | sale, or importing the Program or any portion of it.
466 |
467 | #### 11. Patents.
468 |
469 | A "contributor" is a copyright holder who authorizes use under this
470 | License of the Program or a work on which the Program is based. The
471 | work thus licensed is called the contributor's "contributor version".
472 |
473 | A contributor's "essential patent claims" are all patent claims owned
474 | or controlled by the contributor, whether already acquired or
475 | hereafter acquired, that would be infringed by some manner, permitted
476 | by this License, of making, using, or selling its contributor version,
477 | but do not include claims that would be infringed only as a
478 | consequence of further modification of the contributor version. For
479 | purposes of this definition, "control" includes the right to grant
480 | patent sublicenses in a manner consistent with the requirements of
481 | this License.
482 |
483 | Each contributor grants you a non-exclusive, worldwide, royalty-free
484 | patent license under the contributor's essential patent claims, to
485 | make, use, sell, offer for sale, import and otherwise run, modify and
486 | propagate the contents of its contributor version.
487 |
488 | In the following three paragraphs, a "patent license" is any express
489 | agreement or commitment, however denominated, not to enforce a patent
490 | (such as an express permission to practice a patent or covenant not to
491 | sue for patent infringement). To "grant" such a patent license to a
492 | party means to make such an agreement or commitment not to enforce a
493 | patent against the party.
494 |
495 | If you convey a covered work, knowingly relying on a patent license,
496 | and the Corresponding Source of the work is not available for anyone
497 | to copy, free of charge and under the terms of this License, through a
498 | publicly available network server or other readily accessible means,
499 | then you must either (1) cause the Corresponding Source to be so
500 | available, or (2) arrange to deprive yourself of the benefit of the
501 | patent license for this particular work, or (3) arrange, in a manner
502 | consistent with the requirements of this License, to extend the patent
503 | license to downstream recipients. "Knowingly relying" means you have
504 | actual knowledge that, but for the patent license, your conveying the
505 | covered work in a country, or your recipient's use of the covered work
506 | in a country, would infringe one or more identifiable patents in that
507 | country that you have reason to believe are valid.
508 |
509 | If, pursuant to or in connection with a single transaction or
510 | arrangement, you convey, or propagate by procuring conveyance of, a
511 | covered work, and grant a patent license to some of the parties
512 | receiving the covered work authorizing them to use, propagate, modify
513 | or convey a specific copy of the covered work, then the patent license
514 | you grant is automatically extended to all recipients of the covered
515 | work and works based on it.
516 |
517 | A patent license is "discriminatory" if it does not include within the
518 | scope of its coverage, prohibits the exercise of, or is conditioned on
519 | the non-exercise of one or more of the rights that are specifically
520 | granted under this License. You may not convey a covered work if you
521 | are a party to an arrangement with a third party that is in the
522 | business of distributing software, under which you make payment to the
523 | third party based on the extent of your activity of conveying the
524 | work, and under which the third party grants, to any of the parties
525 | who would receive the covered work from you, a discriminatory patent
526 | license (a) in connection with copies of the covered work conveyed by
527 | you (or copies made from those copies), or (b) primarily for and in
528 | connection with specific products or compilations that contain the
529 | covered work, unless you entered into that arrangement, or that patent
530 | license was granted, prior to 28 March 2007.
531 |
532 | Nothing in this License shall be construed as excluding or limiting
533 | any implied license or other defenses to infringement that may
534 | otherwise be available to you under applicable patent law.
535 |
536 | #### 12. No Surrender of Others' Freedom.
537 |
538 | If conditions are imposed on you (whether by court order, agreement or
539 | otherwise) that contradict the conditions of this License, they do not
540 | excuse you from the conditions of this License. If you cannot convey a
541 | covered work so as to satisfy simultaneously your obligations under
542 | this License and any other pertinent obligations, then as a
543 | consequence you may not convey it at all. For example, if you agree to
544 | terms that obligate you to collect a royalty for further conveying
545 | from those to whom you convey the Program, the only way you could
546 | satisfy both those terms and this License would be to refrain entirely
547 | from conveying the Program.
548 |
549 | #### 13. Use with the GNU Affero General Public License.
550 |
551 | Notwithstanding any other provision of this License, you have
552 | permission to link or combine any covered work with a work licensed
553 | under version 3 of the GNU Affero General Public License into a single
554 | combined work, and to convey the resulting work. The terms of this
555 | License will continue to apply to the part which is the covered work,
556 | but the special requirements of the GNU Affero General Public License,
557 | section 13, concerning interaction through a network will apply to the
558 | combination as such.
559 |
560 | #### 14. Revised Versions of this License.
561 |
562 | The Free Software Foundation may publish revised and/or new versions
563 | of the GNU General Public License from time to time. Such new versions
564 | will be similar in spirit to the present version, but may differ in
565 | detail to address new problems or concerns.
566 |
567 | Each version is given a distinguishing version number. If the Program
568 | specifies that a certain numbered version of the GNU General Public
569 | License "or any later version" applies to it, you have the option of
570 | following the terms and conditions either of that numbered version or
571 | of any later version published by the Free Software Foundation. If the
572 | Program does not specify a version number of the GNU General Public
573 | License, you may choose any version ever published by the Free
574 | Software Foundation.
575 |
576 | If the Program specifies that a proxy can decide which future versions
577 | of the GNU General Public License can be used, that proxy's public
578 | statement of acceptance of a version permanently authorizes you to
579 | choose that version for the Program.
580 |
581 | Later license versions may give you additional or different
582 | permissions. However, no additional obligations are imposed on any
583 | author or copyright holder as a result of your choosing to follow a
584 | later version.
585 |
586 | #### 15. Disclaimer of Warranty.
587 |
588 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
589 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
590 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
591 | WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
592 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
593 | A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
594 | PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
595 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
596 | CORRECTION.
597 |
598 | #### 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
602 | CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
603 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
604 | ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
605 | NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
606 | LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
607 | TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
608 | PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
609 |
610 | #### 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | ### How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these
626 | terms.
627 |
628 | To do so, attach the following notices to the program. It is safest to
629 | attach them to the start of each source file to most effectively state
630 | the exclusion of warranty; and each file should have at least the
631 | "copyright" line and a pointer to where the full notice is found.
632 |
633 |
634 | Copyright (C)
635 |
636 | This program is free software: you can redistribute it and/or modify
637 | it under the terms of the GNU General Public License as published by
638 | the Free Software Foundation, either version 3 of the License, or
639 | (at your option) any later version.
640 |
641 | This program is distributed in the hope that it will be useful,
642 | but WITHOUT ANY WARRANTY; without even the implied warranty of
643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
644 | GNU General Public License for more details.
645 |
646 | You should have received a copy of the GNU General Public License
647 | along with this program. If not, see .
648 |
649 | Also add information on how to contact you by electronic and paper
650 | mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands \`show w' and \`show c' should show the
661 | appropriate parts of the General Public License. Of course, your
662 | program's commands might be different; for a GUI interface, you would
663 | use an "about box".
664 |
665 | You should also get your employer (if you work as a programmer) or
666 | school, if any, to sign a "copyright disclaimer" for the program, if
667 | necessary. For more information on this, and how to apply and follow
668 | the GNU GPL, see .
669 |
670 | The GNU General Public License does not permit incorporating your
671 | program into proprietary programs. If your program is a subroutine
672 | library, you may consider it more useful to permit linking proprietary
673 | applications with the library. If this is what you want to do, use the
674 | GNU Lesser General Public License instead of this License. But first,
675 | please read .
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # CEClient
2 | Arduino library for HDMI CEC communication
3 |
4 | Original code at: https://code.google.com/archive/p/cec-arduino/ (c) Phil Burr and Andrew N. Carr
5 |
6 | Based on the work of Florian Echtler: https://github.com/floe/CEC
7 |
--------------------------------------------------------------------------------
/examples/Example1_Listening/Example1_Listening.ino:
--------------------------------------------------------------------------------
1 | /*
2 | Example1_Listening.ino
3 |
4 | Basic example to demonstrate the use of the CEClient library
5 | The client is configured in promiscuous and monitor mode
6 | to receive all the messages on the CEC bus
7 |
8 | No specific callback function is defined, therefore the client
9 | calls the default one, which prints the packets on the Serial port
10 |
11 | Use http://www.cec-o-matic.com/ to decode captured messages
12 | */
13 |
14 | #include "CEClient.h"
15 |
16 | #define CEC_PHYSICAL_ADDRESS 0x1000
17 | #define CEC_INPUT_PIN 2
18 | #define CEC_OUTPUT_PIN 3
19 |
20 | // create a CEC client
21 | CEClient ceclient(CEC_PHYSICAL_ADDRESS, CEC_INPUT_PIN, CEC_OUTPUT_PIN);
22 |
23 |
24 | void setup() {
25 |
26 | Serial.begin(115200);
27 |
28 | // initialize the client with the default device type (PLAYBACK)
29 | ceclient.begin();
30 |
31 | // enable promiscuous mode (print all the incoming messages)
32 | ceclient.setPromiscuous(true);
33 |
34 | // enable monitor mode (do not transmit)
35 | ceclient.setMonitorMode(true);
36 | }
37 |
38 | void loop() {
39 |
40 | // run the client
41 | ceclient.run();
42 | }
--------------------------------------------------------------------------------
/keywords.txt:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/arpruss/ArduinoLib_CEClient/738ab23154fe3232fa1ffc7079547b44c23b1341/keywords.txt
--------------------------------------------------------------------------------
/library.properties:
--------------------------------------------------------------------------------
1 | name=CEClient
2 | version=0.0.2
3 | author=Luca Dentella , Florian Echtler, Phil Burr, Andrew N. Carr
4 | maintainer=Luca Dentella
5 | sentence=A library which allows communication with HDMI CEC capable devices.
6 | paragraph=Supports HDMI v1.3a CEC wire protocol.
7 | category=Communication
8 | url=https://github.com/lucadentella/ArduinoLib_CEClient
9 | architectures=avr
10 | includes=CEClient.h
11 |
--------------------------------------------------------------------------------
/src/CEC/CEC.cpp:
--------------------------------------------------------------------------------
1 | #include "CEC.h"
2 |
3 | int CEC_LogicalDevice::_validLogicalAddresses[6][5] =
4 | { {CLA_TV, CLA_FREE_USE, CLA_UNREGISTERED, CLA_UNREGISTERED, CLA_UNREGISTERED, },
5 | {CLA_RECORDING_DEVICE_1, CLA_RECORDING_DEVICE_2, CLA_RECORDING_DEVICE_3, CLA_UNREGISTERED, CLA_UNREGISTERED, },
6 | {CLA_UNREGISTERED, CLA_UNREGISTERED, CLA_UNREGISTERED, CLA_UNREGISTERED, CLA_UNREGISTERED, },
7 | {CLA_TUNER_1, CLA_TUNER_2, CLA_TUNER_3, CLA_TUNER_4, CLA_UNREGISTERED, },
8 | {CLA_PLAYBACK_DEVICE_1, CLA_PLAYBACK_DEVICE_2, CLA_PLAYBACK_DEVICE_3, CLA_UNREGISTERED, CLA_UNREGISTERED, },
9 | {CLA_AUDIO_SYSTEM, CLA_UNREGISTERED, CLA_UNREGISTERED, CLA_UNREGISTERED, CLA_UNREGISTERED, },
10 | };
11 |
12 | #define MAKE_ADDRESS(s,d) ((((s) & 0xf) << 4) | ((d) & 0xf))
13 |
14 |
15 | CEC_LogicalDevice::CEC_LogicalDevice(int physicalAddress)
16 | : CEC_Electrical(CLA_UNREGISTERED)
17 | , _physicalAddress(physicalAddress)
18 | , _logicalAddress(CLA_UNREGISTERED)
19 | , _done(false)
20 | , _waitTime(0)
21 | , _primaryState(CEC_ALLOCATE_LOGICAL_ADDRESS)
22 | , _deviceType(CDT_OTHER)
23 | {
24 | _secondaryState = CEC_XMIT_POLLING_MESSAGE;
25 | _tertiaryState = 0;
26 | }
27 |
28 | void CEC_LogicalDevice::Initialize(CEC_DEVICE_TYPE type)
29 | {
30 | CEC_Electrical::Initialize();
31 | _deviceType = type;
32 |
33 | if (MonitorMode)
34 | {
35 | _primaryState = CEC_READY;
36 | }
37 | else
38 | {
39 | _primaryState = CEC_ALLOCATE_LOGICAL_ADDRESS;
40 | _logicalAddress = CLA_UNREGISTERED;
41 | }
42 |
43 | }
44 |
45 | bool CEC_LogicalDevice::ProcessStateMachine(bool* success)
46 | {
47 | unsigned char buffer[1];
48 | bool wait = false;
49 |
50 | switch (_primaryState)
51 | {
52 | case CEC_ALLOCATE_LOGICAL_ADDRESS:
53 | switch (_secondaryState)
54 | {
55 | case CEC_XMIT_POLLING_MESSAGE:
56 | // Section 6.1.3 specifies that while allocating a Logical Address
57 | // will have the same initiator and destination address
58 | buffer[0] = MAKE_ADDRESS(_validLogicalAddresses[_deviceType][_tertiaryState], _validLogicalAddresses[_deviceType][_tertiaryState]);
59 | ClearTransmitBuffer();
60 | Transmit(buffer, 1);
61 |
62 | _secondaryState = CEC_RCV_POLLING_MESSAGE;
63 | wait = true;
64 | break;
65 |
66 | case CEC_RCV_POLLING_MESSAGE:
67 | if (success)
68 | {
69 | if (*success)
70 | {
71 | // Someone is there, try the next
72 | _tertiaryState++;
73 | if (_validLogicalAddresses[_deviceType][_tertiaryState] != CLA_UNREGISTERED)
74 | _secondaryState = CEC_XMIT_POLLING_MESSAGE;
75 | else
76 | {
77 | _logicalAddress = CLA_UNREGISTERED;
78 | //DbgPrint("Logical address assigned: %d\n", _logicalAddress);
79 | _primaryState = CEC_READY;
80 | }
81 | }
82 | else
83 | {
84 | // We hereby claim this as our logical address!
85 | _logicalAddress = _validLogicalAddresses[_deviceType][_tertiaryState];
86 | SetAddress(_logicalAddress);
87 | //DbgPrint("Logical address assigned: %d\n", _logicalAddress);
88 | _primaryState = CEC_READY;
89 | }
90 | }
91 | else
92 | wait = true;
93 | break;
94 | }
95 | break;
96 |
97 | case CEC_READY:
98 | _primaryState = CEC_IDLE;
99 | OnReady();
100 | wait = true;
101 | break;
102 |
103 | case CEC_IDLE:
104 | wait = true;
105 | break;
106 | }
107 |
108 | return wait;
109 | }
110 |
111 | void CEC_LogicalDevice::OnReceiveComplete(unsigned char* buffer, int count)
112 | {
113 | ASSERT(count >= 1);
114 | int sourceAddress = (buffer[0] >> 4) & 0x0f;
115 | int targetAddress = buffer[0] & 0x0f;
116 | OnReceive(sourceAddress, targetAddress, buffer + 1, count - 1);
117 | }
118 |
119 | bool CEC_LogicalDevice::TransmitFrame(int targetAddress, unsigned char* buffer, int count, int sourceAddress)
120 | {
121 | if (_primaryState != CEC_IDLE)
122 | return false;
123 |
124 | unsigned char addr[1];
125 |
126 | addr[0] = MAKE_ADDRESS(sourceAddress < 0 ? _logicalAddress : sourceAddress, targetAddress);
127 | ClearTransmitBuffer();
128 | if (!TransmitPartial(addr, 1))
129 | return false;
130 | return Transmit(buffer, count);
131 | }
132 |
133 | void CEC_LogicalDevice::OnTransmitComplete(bool success)
134 | {
135 | if (_primaryState == CEC_ALLOCATE_LOGICAL_ADDRESS &&
136 | _secondaryState == CEC_RCV_POLLING_MESSAGE &&
137 | _logicalAddress == CLA_UNREGISTERED)
138 | {
139 | while (!ProcessStateMachine(&success))
140 | ;
141 | }
142 | //else
143 | //DbgPrint("Transmit: %d\n", success);
144 | }
145 |
146 | void CEC_LogicalDevice::Run()
147 | {
148 | // Initial pump for the state machine (this will cause a transmit to occur)
149 | while (!ProcessStateMachine(NULL))
150 | ;
151 |
152 | if (((_waitTime == (unsigned long)-1 && !TransmitPending()) || (_waitTime != (unsigned long)-1 && _waitTime > micros())) && !IsISRTriggered())
153 | return;
154 |
155 | unsigned long wait = Process();
156 | if (wait != (unsigned long)-2)
157 | _waitTime = wait;
158 | return;
159 | }
160 |
161 |
162 |
--------------------------------------------------------------------------------
/src/CEC/CEC.h:
--------------------------------------------------------------------------------
1 | #ifndef CEC_H__
2 | #define CEC_H__
3 |
4 | #include "CEC_Electrical.h"
5 |
6 | class CEC_LogicalDevice : public CEC_Electrical
7 | {
8 | public:
9 | typedef enum {
10 | CDT_TV,
11 | CDT_RECORDING_DEVICE,
12 | CDT_OTHER, // Not a real CEC type..
13 | CDT_TUNER,
14 | CDT_PLAYBACK_DEVICE,
15 | CDT_AUDIO_SYSTEM,
16 | } CEC_DEVICE_TYPE;
17 |
18 | public:
19 | CEC_LogicalDevice(int physicalAddress);
20 | void Initialize(CEC_DEVICE_TYPE type);
21 |
22 | virtual void Run();
23 | virtual bool TransmitFrame(int targetAddress, unsigned char* buffer, int count, int sourceAddress=-1);
24 |
25 | void setPhysicalAddress(int physicalAddress) {
26 | _physicalAddress = physicalAddress;
27 | }
28 |
29 | protected:
30 | virtual bool IsISRTriggered() = 0;
31 |
32 | bool ProcessStateMachine(bool* success);
33 |
34 | virtual void OnReceiveComplete(unsigned char* buffer, int count);
35 | virtual void OnTransmitComplete(bool);
36 |
37 | virtual void OnReady() {;}
38 | virtual void OnReceive(int sourceAddress, int targetAddress, unsigned char* buffer, int count) = 0;
39 |
40 | private:
41 | typedef enum {
42 | CLA_TV = 0,
43 | CLA_RECORDING_DEVICE_1,
44 | CLA_RECORDING_DEVICE_2,
45 | CLA_TUNER_1,
46 | CLA_PLAYBACK_DEVICE_1,
47 | CLA_AUDIO_SYSTEM,
48 | CLA_TUNER_2,
49 | CLA_TUNER_3,
50 | CLA_PLAYBACK_DEVICE_2,
51 | CLA_RECORDING_DEVICE_3,
52 | CLA_TUNER_4,
53 | CLA_PLAYBACK_DEVICE_3,
54 | CLA_RESERVED_1,
55 | CLA_RESERVED_2,
56 | CLA_FREE_USE,
57 | CLA_UNREGISTERED,
58 | } CEC_LOGICAL_ADDRESS;
59 |
60 | typedef enum {
61 | CEC_IDLE,
62 | CEC_READY,
63 | CEC_ALLOCATE_LOGICAL_ADDRESS,
64 | } CEC_PRIMARY_STATE;
65 |
66 | typedef enum {
67 | CEC_XMIT_POLLING_MESSAGE,
68 | CEC_RCV_POLLING_MESSAGE,
69 | } CEC_SECONDARY_STATE;
70 |
71 | typedef enum {
72 | } CEC_TERTIARY_STATE;
73 |
74 | protected:
75 | static int _validLogicalAddresses[6][5];
76 | int _logicalAddress;
77 | int _physicalAddress;
78 | unsigned long _waitTime;
79 | bool _done;
80 |
81 | CEC_DEVICE_TYPE _deviceType;
82 | CEC_PRIMARY_STATE _primaryState;
83 | CEC_SECONDARY_STATE _secondaryState;
84 | int _tertiaryState;
85 |
86 | };
87 |
88 | #endif // CEC_H__
89 |
--------------------------------------------------------------------------------
/src/CEC/CEC_Device.cpp:
--------------------------------------------------------------------------------
1 | #include "CEC_Device.h"
2 | #include
3 |
4 | #if defined(ARDUINO_ARCH_STM32F1) || defined(ARDUINO_ARCH_STM32F2) || defined(ARDUINO_ARCH_STM32F3) || defined(ARDUINO_ARCH_STM32F4)
5 | # define STM32
6 | # define CEC_HIGH 1
7 | # define CEC_LOW 0
8 | #else
9 | # define CEC_HIGH LOW
10 | # define CEC_LOW HIGH
11 | #endif
12 |
13 | CEC_Device::CEC_Device(int physicalAddress, int in_line, int out_line)
14 | : CEC_LogicalDevice(physicalAddress)
15 | , _isrTriggered(false)
16 | , _lastLineState2(true)
17 | , _in_line(in_line)
18 | , _out_line(out_line)
19 | {
20 | }
21 |
22 | void CEC_Device::Initialize(CEC_DEVICE_TYPE type)
23 | {
24 | #ifdef STM32
25 | gpio_set_mode(digitalPinToPort(_in_line), PIN_MAP[_in_line].gpio_bit, GPIO_OUTPUT_OD); // set open drain output
26 | _out_line = _in_line;
27 | #else
28 | pinMode(_out_line, OUTPUT);
29 | pinMode( _in_line, INPUT);
30 | #endif
31 |
32 | digitalWrite(_out_line, CEC_HIGH);
33 | delay(200);
34 |
35 | CEC_LogicalDevice::Initialize(type);
36 | }
37 |
38 | void CEC_Device::OnReady()
39 | {
40 | // This is called after the logical address has been
41 | // allocated
42 | DbgPrint("Device ready\n");
43 | }
44 |
45 | void CEC_Device::OnReceive(int source, int dest, unsigned char* buffer, int count)
46 | {
47 | // This is called when a frame is received. To transmit
48 | // a frame call TransmitFrame. To receive all frames, even
49 | // those not addressed to this device, set Promiscuous to true.
50 | DbgPrint("Packet received at %ld: %02d -> %02d: %02X", millis(), source, dest, ((source&0x0f)<<4)|(dest&0x0f));
51 | for (int i = 0; i < count; i++)
52 | DbgPrint(":%02X", buffer[i]);
53 | DbgPrint("\n");
54 | }
55 |
56 | bool CEC_Device::LineState()
57 | {
58 | int state = digitalRead(_in_line);
59 | return state == CEC_HIGH;
60 | }
61 |
62 | void CEC_Device::SetLineState(bool state)
63 | {
64 | digitalWrite(_out_line, state?CEC_HIGH:CEC_LOW);
65 | // give enough time for the line to settle before sampling
66 | // it
67 | delayMicroseconds(50);
68 | _lastLineState2 = LineState();
69 | }
70 |
71 | void CEC_Device::SignalIRQ()
72 | {
73 | // This is called when the line has changed state
74 | _isrTriggered = true;
75 | }
76 |
77 | bool CEC_Device::IsISRTriggered()
78 | {
79 | if (_isrTriggered)
80 | {
81 | _isrTriggered = false;
82 | return true;
83 | }
84 | return false;
85 | }
86 |
87 | void CEC_Device::Run()
88 | {
89 | bool state = LineState();
90 | if (_lastLineState2 != state)
91 | {
92 | _lastLineState2 = state;
93 | SignalIRQ();
94 | }
95 | CEC_LogicalDevice::Run();
96 | }
97 |
--------------------------------------------------------------------------------
/src/CEC/CEC_Device.h:
--------------------------------------------------------------------------------
1 | #ifndef CEC_DEVICE_H__
2 | #define CEC_DEVICE_H__
3 |
4 | #include "CEC.h"
5 |
6 | class CEC_Device : public CEC_LogicalDevice
7 | {
8 | public:
9 | CEC_Device(int physicalAddress, int in_line, int out_line);
10 |
11 | void Initialize(CEC_DEVICE_TYPE type);
12 | virtual void Run();
13 |
14 | protected:
15 | virtual bool LineState();
16 | virtual void SetLineState(bool);
17 | virtual void SignalIRQ();
18 | virtual bool IsISRTriggered();
19 | virtual bool IsISRTriggered2() { return _isrTriggered; }
20 |
21 | virtual void OnReady();
22 | virtual void OnReceive(int source, int dest, unsigned char* buffer, int count);
23 |
24 | private:
25 | bool _isrTriggered;
26 | bool _lastLineState2;
27 | int _in_line, _out_line;
28 | };
29 |
30 | #endif // CEC_DEVICE_H__
31 |
--------------------------------------------------------------------------------
/src/CEC/CEC_Electrical.cpp:
--------------------------------------------------------------------------------
1 | #include "CEC_Electrical.h"
2 |
3 | CEC_Electrical::CEC_Electrical(int address)
4 | {
5 | MonitorMode = false;
6 | Promiscuous = false;
7 |
8 | _address = address & 0x0f;
9 | _amLastTransmittor = false;
10 | _transmitPending = false;
11 | _xmitretry = 0;
12 | ResetState();
13 | }
14 |
15 | void CEC_Electrical::Initialize()
16 | {
17 | _lastLineState = LineState();
18 | _lastStateChangeTime = micros();
19 | }
20 |
21 | void CEC_Electrical::SetAddress(int address)
22 | {
23 | _address = address & 0x0f;
24 | }
25 |
26 | bool CEC_Electrical::Raise()
27 | {
28 | if (MonitorMode && !MonitorModeWriting)
29 | return LineState();
30 |
31 | unsigned long time = micros();
32 | SetLineState(1);
33 | // Only update state if the line was actually changed (i.e. it wasn't already in its new state)
34 | if (LineState())
35 | {
36 | _lastLineState = true;
37 | _lastStateChangeTime = time;
38 | return true;
39 | }
40 | return false;
41 | }
42 |
43 | bool CEC_Electrical::Lower()
44 | {
45 | if (MonitorMode && !MonitorModeWriting)
46 | return LineState();
47 |
48 | unsigned long time = micros();
49 | SetLineState(0);
50 | // Only update state if the line was actually changed (i.e. it wasn't already in its new state)
51 | if (!LineState())
52 | {
53 | if (_lastLineState)
54 | _bitStartTime = time;
55 | _lastLineState = false;
56 | _lastStateChangeTime = time;
57 | return false;
58 | }
59 | return true;
60 | }
61 |
62 | void CEC_Electrical::HasRaised(unsigned long time)
63 | {
64 | _lastLineState = true;
65 | _lastStateChangeTime = time;
66 | }
67 |
68 | void CEC_Electrical::HasLowered(unsigned long time)
69 | {
70 | _lastLineState = false;
71 | _lastStateChangeTime = time;
72 | _bitStartTime = time;
73 | }
74 |
75 | bool CEC_Electrical::CheckAddress()
76 | {
77 | if (ReceivedBytes() == 1)
78 | {
79 | int address = _receiveBuffer[0] & 0x0f;
80 | if (address != _address && address != 0x0f)
81 | {
82 | // It's not addressed to us and it's not a broadcast.
83 | // Reset and wait for the next start bit
84 | return false;
85 | }
86 | // It is either addressed to this device or its a broadcast
87 | if (address == 0x0f)
88 | _broadcast = true;
89 | else
90 | _follower = true;
91 | }
92 | return true;
93 | }
94 |
95 | void CEC_Electrical::ReceivedBit(bool state)
96 | {
97 | if (_tertiaryState == CEC_RCV_BIT_EOM)
98 | {
99 | //DbgPrint("%p: Received eom %d\n", this, state?1:0);
100 | _eom = state;
101 | }
102 | else
103 | {
104 | //DbgPrint("%p: Received bit %d\n", this, state?1:0);
105 | if (state)
106 | PushReceiveBit(1);
107 | else
108 | PushReceiveBit(0);
109 | }
110 | }
111 |
112 | unsigned long CEC_Electrical::LineError()
113 | {
114 | //DbgPrint("%p: Line Error!\n", this);
115 | if (_follower || _broadcast)
116 | {
117 | _secondaryState = CEC_RCV_LINEERROR;
118 | if (!MonitorMode) Lower();
119 | return micros() + 3600;
120 | }
121 | return ResetState() ? micros() : (unsigned long)-1;
122 | }
123 |
124 | ///
125 | /// CEC_Electrical::Process implements our main state machine
126 | /// which includes all reading and writing of state including
127 | /// acknowledgements and arbitration
128 | ///
129 |
130 | unsigned long CEC_Electrical::Process()
131 | {
132 | // We are either called because of an INTerrupt in which case
133 | // state has changed or because of a poll (during write).
134 |
135 | bool currentLineState = LineState();
136 | bool lastLineState = _lastLineState;
137 | unsigned long waitTime = -1; // INFINITE; (== wait until an external event has occurred)
138 | unsigned long time = micros();
139 |
140 | //DbgPrint("%d %d %d\n", _primaryState, _secondaryState, _tertiaryState);
141 | // If the state hasn't changed and we're not in a transmit
142 | // state then this is spurrious.
143 | if( currentLineState == lastLineState &&
144 | !(_primaryState == CEC_TRANSMIT ||
145 | (_primaryState == CEC_RECEIVE &&
146 | (_secondaryState == CEC_RCV_ACK_SENT ||
147 | _secondaryState == CEC_RCV_LINEERROR))))
148 | return waitTime;
149 |
150 | unsigned long lasttime = _lastStateChangeTime;
151 | unsigned long difftime = time - _bitStartTime;
152 |
153 | if( currentLineState != lastLineState )
154 | {
155 | // Line state has changed, update our internal state
156 | if (currentLineState)
157 | HasRaised(time);
158 | else
159 | HasLowered(time);
160 | }
161 |
162 | switch (_primaryState)
163 | {
164 | case CEC_IDLE:
165 | // If a high to low transition occurs, then we must be
166 | // beginning a start bit
167 | if (lastLineState && !currentLineState)
168 | {
169 | _primaryState = CEC_RECEIVE;
170 | _secondaryState = CEC_RCV_STARTBIT1;
171 | _follower = false;
172 | _broadcast = false;
173 | _amLastTransmittor = false;
174 | break;
175 | }
176 |
177 | // Nothing to do until we have a need to transmit
178 | // or we detect the falling edge of the start bit
179 | break;
180 |
181 | case CEC_RECEIVE:
182 | switch (_secondaryState)
183 | {
184 | case CEC_RCV_STARTBIT1:
185 | // We're waiting for the rising edge of the start bit
186 | if (difftime >= 3500 && difftime <= 3900)
187 | {
188 | // We now need to wait for the next falling edge
189 | _secondaryState = CEC_RCV_STARTBIT2;
190 | break;
191 | }
192 | // Illegal state. Go back to CEC_IDLE to wait for a valid
193 | // start bit
194 | //DbgPrint("1: %ld %ld\n", difftime, micros());
195 | waitTime = ResetState() ? micros() : (unsigned long)-1;
196 | break;
197 |
198 | case CEC_RCV_STARTBIT2:
199 | // This should be the falling edge of the start bit
200 | if (difftime >= 4300 && difftime <= 4700)
201 | {
202 | // We've fully received the start bit. Begin receiving
203 | // a data bit
204 | _secondaryState = CEC_RCV_DATABIT1;
205 | _tertiaryState = CEC_RCV_BIT0;
206 | break;
207 | }
208 | // Illegal state. Go back to CEC_IDLE to wait for a valid
209 | // start bit
210 | //DbgPrint("2: %ld %ld\n", difftime, micros());
211 | waitTime = ResetState() ? micros() : (unsigned long)-1;
212 | break;
213 |
214 | case CEC_RCV_DATABIT1:
215 | // We've received the rising edge of the data bit
216 | if (difftime >= 400 && difftime <= 800)
217 | {
218 | // We're receiving bit '1'
219 | ReceivedBit(true);
220 | _secondaryState = CEC_RCV_DATABIT2;
221 | break;
222 | }
223 | else if (difftime >= 1300 && difftime <= 1700)
224 | {
225 | // We're receiving bit '0'
226 | ReceivedBit(false);
227 | _secondaryState = CEC_RCV_DATABIT2;
228 | break;
229 | }
230 | // Illegal state. Go back to CEC_IDLE to wait for a valid
231 | // start bit
232 | waitTime = LineError();
233 | break;
234 |
235 | case CEC_RCV_DATABIT2:
236 | // We've received the falling edge of the data bit
237 | if (difftime >= 2050 && difftime <= 2750)
238 | {
239 | if (_tertiaryState == CEC_RCV_BIT_EOM)
240 | {
241 | _secondaryState = CEC_RCV_ACK1;
242 | _tertiaryState = (CEC_TERTIARY_STATE)(_tertiaryState + 1);
243 |
244 | // Check to see if the frame is addressed to us
245 | // or if we are in promiscuous mode (in which case we'll receive everything)
246 | if (!CheckAddress() && !Promiscuous)
247 | {
248 | // It's not addressed to us. Reset and wait for the next start bit
249 | waitTime = ResetState() ? micros() : (unsigned long)-1;
250 | break;
251 | }
252 |
253 | // If we're the follower, go low for a while
254 | if (_follower)
255 | {
256 | if (!MonitorMode) Lower();
257 |
258 | _secondaryState = CEC_RCV_ACK_SENT;
259 | waitTime = _bitStartTime + 1500;
260 | }
261 | break;
262 | }
263 | // Receive another bit
264 | _secondaryState = CEC_RCV_DATABIT1;
265 | _tertiaryState = (CEC_TERTIARY_STATE)(_tertiaryState + 1);
266 | break;
267 | }
268 | // Illegal state. Go back to CEC_IDLE to wait for a valid
269 | // start bit
270 | waitTime = LineError();
271 | break;
272 |
273 | case CEC_RCV_ACK_SENT:
274 | // We're done holding the line low... release it
275 | Raise();
276 | if (_eom)
277 | {
278 | // We're not going to receive anything more from
279 | // the initiator (EOM has been received)
280 | // And we've sent the ACK for the most recent bit
281 | // therefore this message is all done. Go back
282 | // to the IDLE state and wait for another start bit.
283 | ProcessFrame();
284 | waitTime = ResetState() ? micros() : (unsigned long)-1;
285 | break;
286 | }
287 | // We need to wait for the falling edge of the ACK
288 | // to finish processing this ack
289 | _secondaryState = CEC_RCV_ACK2;
290 | _tertiaryState = CEC_ACK;
291 | break;
292 |
293 | // FIXME: This is dead state
294 | // Code currently exists in CEC_RCV_DATABIT2 that checks the address
295 | // of the frame and if it isn't addressed to this device it goes back
296 | // to watching for a start bit state. This state, CEC_RCV_ACK1, was
297 | // from when we didn't do that and we followed state for all frames
298 | // regardless of addressing. However, I'm not removing this code because
299 | // it will be needed when we support broadcast frames.
300 | case CEC_RCV_ACK1:
301 | {
302 | int ack;
303 | if (difftime >= 400 && difftime <= 800)
304 | ack = _broadcast ? CEC_ACK : CEC_NAK;
305 | else if (difftime >= 1300 && difftime <= 1700)
306 | ack = _broadcast ? CEC_NAK : CEC_ACK;
307 | else
308 | {
309 | // Illegal state. Go back to CEC_IDLE to wait for a valid
310 | // start bit
311 | waitTime = LineError();
312 | break;
313 | }
314 |
315 | if (_eom && ack == CEC_ACK)
316 | {
317 | // We're not going to receive anything more from
318 | // the initiator (EOM has been received)
319 | // And we've seen the ACK for the most recent bit
320 | // therefore this message is all done. Go back
321 | // to the IDLE state and wait for another start bit.
322 | ProcessFrame();
323 | waitTime = ResetState() ? micros() : (unsigned long)-1;
324 | break;
325 | }
326 | if (ack == CEC_NAK)
327 | {
328 | waitTime = ResetState() ? micros() : (unsigned long)-1;
329 | break;
330 | }
331 |
332 | // receive the rest of the ACK (or rather the beginning of the next bit)
333 | _secondaryState = CEC_RCV_ACK2;
334 | break;
335 | }
336 |
337 | case CEC_RCV_ACK2:
338 | // We're receiving the falling edge of the ack
339 | if (difftime >= 2050 && difftime <= 2750)
340 | {
341 | _secondaryState = CEC_RCV_DATABIT1;
342 | _tertiaryState = CEC_RCV_BIT0;
343 | break;
344 | }
345 | // Illegal state (or NACK). Either way, go back to CEC_IDLE
346 | // to wait for next start bit (maybe a retransmit)..
347 | waitTime = LineError();
348 | break;
349 |
350 | case CEC_RCV_LINEERROR:
351 | //DbgPrint("%p: Done signaling line error\n", this);
352 | Raise();
353 | waitTime = ResetState() ? micros() : (unsigned long)-1;
354 | break;
355 |
356 | }
357 |
358 | break;
359 |
360 | case CEC_TRANSMIT:
361 | if (lastLineState != currentLineState)
362 | {
363 | // Someone else is mucking with the line. Wait for the
364 | // line to clear before appropriately before (re)transmit
365 |
366 | // However it is OK for a follower to ACK if we are in an
367 | // ACK state
368 | if (_secondaryState != CEC_XMIT_ACK &&
369 | _secondaryState != CEC_XMIT_ACK2 &&
370 | _secondaryState != CEC_XMIT_ACK3 &&
371 | _secondaryState != CEC_XMIT_ACK_TEST)
372 | {
373 | // If a state changed TO LOW during IDLE wait, someone could be legitimately transmitting
374 | if (_secondaryState == CEC_IDLE_WAIT)
375 | {
376 | if (currentLineState == false)
377 | {
378 | _primaryState = CEC_RECEIVE;
379 | _secondaryState = CEC_RCV_STARTBIT1;
380 | _transmitPending = true;
381 | }
382 | break;
383 | }
384 | else
385 | {
386 | // Transmit collision
387 | ResetTransmit(true);
388 | waitTime = 0;
389 | break;
390 | }
391 | }
392 | else
393 | {
394 | // This is a state change from an ACK and isn't part of our state
395 | // tracking.
396 | waitTime = -2;
397 | break;
398 | }
399 | }
400 |
401 | unsigned long neededIdleTime = 0;
402 | switch (_secondaryState)
403 | {
404 | case CEC_IDLE_WAIT:
405 | // We need to wait a certain amount of time before we can
406 | // transmit..
407 |
408 | // If the line is low, we can't do anything now. Wait
409 | // indefinitely until a line state changes which will
410 | // catch in the code just above
411 | if (currentLineState == 0)
412 | break;
413 |
414 | // The line is high. Have we waited long enough?
415 | neededIdleTime = 0;
416 | switch (_tertiaryState)
417 | {
418 | case CEC_IDLE_RETRANSMIT_FRAME:
419 | neededIdleTime = 3 * 2400;
420 | break;
421 |
422 | case CEC_IDLE_NEW_FRAME:
423 | neededIdleTime = 5 * 2400;
424 | break;
425 |
426 | case CEC_IDLE_SUBSEQUENT_FRAME:
427 | neededIdleTime = 7 * 2400;
428 | break;
429 | }
430 |
431 | if (time - _lastStateChangeTime < neededIdleTime)
432 | {
433 | // not waited long enough, wait some more!
434 | waitTime = lasttime + neededIdleTime;
435 | break;
436 | }
437 |
438 | // we've wait long enough, begin start bit
439 | Lower();
440 | _amLastTransmittor = true;
441 | _broadcast = (_transmitBuffer[0] & 0x0f) == 0x0f;
442 |
443 | // wait 3700 microsec
444 | waitTime = _bitStartTime + 3700;
445 |
446 | // and transition to our next state
447 | _secondaryState = CEC_XMIT_STARTBIT1;
448 | break;
449 |
450 | case CEC_XMIT_STARTBIT1:
451 | if (!Raise())
452 | {
453 | //DbgPrint("%p: Received Line Error\n", this);
454 | ResetTransmit(true);
455 | break;
456 | }
457 |
458 | waitTime = _bitStartTime + 4500;
459 | _secondaryState = CEC_XMIT_STARTBIT2;
460 | break;
461 |
462 | case CEC_XMIT_STARTBIT2:
463 | case CEC_XMIT_ACK3:
464 | if (!MonitorMode || MonitorModeWriting || _secondaryState == CEC_XMIT_STARTBIT2) Lower();
465 |
466 | _secondaryState = CEC_XMIT_DATABIT1;
467 | _tertiaryState = CEC_XMIT_BIT0;
468 |
469 | if (PopTransmitBit())
470 | {
471 | // Sending bit '1'
472 | //DbgPrint("%p: Sending bit 1\n", this);
473 | waitTime = _bitStartTime + 600;
474 | }
475 | else
476 | {
477 | // Sending bit '0'
478 | //DbgPrint("%p: Sending bit 0\n", this);
479 | waitTime = _bitStartTime + 1500;
480 | }
481 | break;
482 |
483 | case CEC_XMIT_DATABIT1:
484 | if (!Raise())
485 | {
486 | //DbgPrint("%p: Received Line Error\n", this);
487 | ResetTransmit(true);
488 | break;
489 | }
490 |
491 | waitTime = _bitStartTime + 2400;
492 |
493 | if (_tertiaryState == CEC_XMIT_BIT_EOM)
494 | {
495 | // We've just finished transmitting the EOM
496 | // move on to the ACK
497 | _secondaryState = CEC_XMIT_ACK;
498 | }
499 | else
500 | _secondaryState = CEC_XMIT_DATABIT2;
501 | break;
502 |
503 | case CEC_XMIT_DATABIT2:
504 | Lower();
505 |
506 | _tertiaryState = (CEC_TERTIARY_STATE)(_tertiaryState + 1);
507 |
508 | if (_tertiaryState == CEC_XMIT_BIT_EOM)
509 | {
510 | if (RemainingTransmitBytes() == 0)
511 | {
512 | // Sending eom '1'
513 | //DbgPrint("%p: Sending eom 1\n", this);
514 | waitTime = _bitStartTime + 600;
515 | }
516 | else
517 | {
518 | // Sending eom '0'
519 | //DbgPrint("%p: Sending eom 0\n", this);
520 | waitTime = _bitStartTime + 1500;
521 | }
522 | }
523 | else
524 | {
525 | if (PopTransmitBit())
526 | {
527 | // Sending bit '1'
528 | //DbgPrint("%p: Sending bit 1\n", this);
529 | waitTime = _bitStartTime + 600;
530 | }
531 | else
532 | {
533 | // Sending bit '0'
534 | //DbgPrint("%p: Sending bit 0\n", this);
535 | waitTime = _bitStartTime + 1500;
536 | }
537 | }
538 | _secondaryState = CEC_XMIT_DATABIT1;
539 | break;
540 |
541 | case CEC_XMIT_ACK:
542 | if (!MonitorMode || MonitorModeWriting) Lower();
543 |
544 | // We transmit a '1'
545 | //DbgPrint("%p: Sending ack\n", this);
546 | waitTime = _bitStartTime + 600;
547 | _secondaryState = CEC_XMIT_ACK2;
548 | break;
549 |
550 | case CEC_XMIT_ACK2:
551 | Raise();
552 |
553 | // we need to sample the state in a little bit
554 | waitTime = _bitStartTime + 1050;
555 | _secondaryState = CEC_XMIT_ACK_TEST;
556 | break;
557 |
558 | case CEC_XMIT_ACK_TEST:
559 | //DbgPrint("%p: Testing ack: %d\n", this, (currentLineState == 0) != _broadcast?1:0);
560 | if ((currentLineState != 0) != _broadcast)
561 | {
562 | // not being acknowledged
563 | // normally we retransmit. But this is NOT the case for as its
564 | // function is basically to 'ping' a logical address in which case we just want
565 | // acknowledgement that it has succeeded or failed
566 | if (RemainingTransmitBytes() == 0 && TransmitSize() == 1)
567 | {
568 | ResetState();
569 | //DbgPrint("Transmit failed, no acknowledge.\n");
570 | OnTransmitComplete(false);
571 | }
572 | else
573 | {
574 | ResetTransmit(true);
575 | waitTime = 0;
576 | }
577 | break;
578 | }
579 |
580 | _lastStateChangeTime = lasttime;
581 |
582 | if (RemainingTransmitBytes() == 0)
583 | {
584 | // Nothing left to transmit, go back to idle
585 | ResetState();
586 | OnTransmitComplete(true);
587 | break;
588 | }
589 |
590 | // We have more to transmit, so do so...
591 | waitTime = _bitStartTime + 2400;
592 | _secondaryState = CEC_XMIT_ACK3;
593 | break;
594 | }
595 | }
596 | return waitTime;
597 | }
598 |
599 | bool CEC_Electrical::ResetState()
600 | {
601 | _primaryState = CEC_IDLE;
602 | _secondaryState = (CEC_SECONDARY_STATE)0;
603 | _tertiaryState = (CEC_TERTIARY_STATE)0;
604 | _eom = false;
605 | _follower = false;
606 | _broadcast = false;
607 | ResetReceiveBuffer();
608 |
609 | if (_transmitPending)
610 | {
611 | ResetTransmit(false);
612 | return true;
613 | }
614 | return false;
615 | }
616 |
617 | void CEC_Electrical::ResetTransmit(bool retransmit)
618 | {
619 | _primaryState = CEC_TRANSMIT;
620 | _secondaryState = CEC_IDLE_WAIT;
621 | _tertiaryState = CEC_IDLE_NEW_FRAME;
622 | _transmitPending = false;
623 |
624 | if (retransmit)
625 | {
626 | if (++_xmitretry == CEC_MAX_RETRANSMIT)
627 | {
628 | // No more
629 | ResetState();
630 | //DbgPrint("Transmit failed, max retries reached.\n");
631 | OnTransmitComplete(false);
632 | }
633 | else
634 | {
635 | //DbgPrint("%p: Retransmitting current frame\n", this);
636 | _tertiaryState = CEC_IDLE_RETRANSMIT_FRAME;
637 | ResetTransmitBuffer();
638 | }
639 | }
640 | else
641 | {
642 | _xmitretry = 0;
643 | if (_amLastTransmittor)
644 | {
645 | _tertiaryState = CEC_IDLE_SUBSEQUENT_FRAME;
646 | }
647 | }
648 | }
649 |
650 | void CEC_Electrical::ProcessFrame()
651 | {
652 | // We've successfully received a frame in the serial line buffer
653 | // Allow it to be processed
654 | OnReceiveComplete(_receiveBuffer, _receiveBufferByte);
655 | }
656 |
657 | void CEC_Electrical::OnTransmitBegin()
658 | {
659 | if (!MonitorMode || MonitorModeWriting)
660 | {
661 | if (_primaryState == CEC_IDLE)
662 | {
663 | ResetTransmit(false);
664 | return;
665 | }
666 | _transmitPending = true;
667 | }
668 | }
669 |
670 | void CEC_Electrical::OnTransmitComplete(bool success)
671 | {
672 | }
673 |
--------------------------------------------------------------------------------
/src/CEC/CEC_Electrical.h:
--------------------------------------------------------------------------------
1 | #ifndef CECWIRE_H__
2 | #define CECWIRE_H__
3 |
4 | #include "Serial.h"
5 |
6 | #define CEC_MAX_RETRANSMIT 5
7 |
8 | class CEC_Electrical : public SerialLine
9 | {
10 | public:
11 | CEC_Electrical(int address);
12 | void Initialize();
13 | void SetAddress(int address);
14 |
15 | unsigned long Process();
16 | bool TransmitPending() { return _primaryState == CEC_TRANSMIT && _secondaryState == CEC_IDLE_WAIT; }
17 |
18 | int Promiscuous;
19 | int MonitorMode;
20 | int MonitorModeWriting;
21 |
22 | protected:
23 | virtual bool LineState() = 0;
24 | virtual void SetLineState(bool) = 0;
25 |
26 | private:
27 | typedef enum {
28 | CEC_IDLE,
29 | CEC_TRANSMIT,
30 | CEC_RECEIVE,
31 | } CEC_PRIMARY_STATE;
32 |
33 | typedef enum {
34 | CEC_RCV_STARTBIT1,
35 | CEC_RCV_STARTBIT2,
36 | CEC_RCV_DATABIT1,
37 | CEC_RCV_DATABIT2,
38 | CEC_RCV_ACK_SENT,
39 | CEC_RCV_ACK1,
40 | CEC_RCV_ACK2,
41 | CEC_RCV_LINEERROR,
42 |
43 | CEC_IDLE_WAIT,
44 | CEC_XMIT_STARTBIT1,
45 | CEC_XMIT_STARTBIT2,
46 | CEC_XMIT_DATABIT1,
47 | CEC_XMIT_DATABIT2,
48 | CEC_XMIT_ACK,
49 | CEC_XMIT_ACK2,
50 | CEC_XMIT_ACK3,
51 | CEC_XMIT_ACK_TEST,
52 | } CEC_SECONDARY_STATE;
53 |
54 | typedef enum {
55 | CEC_RCV_BIT0,
56 | CEC_RCV_BIT1,
57 | CEC_RCV_BIT2,
58 | CEC_RCV_BIT3,
59 | CEC_RCV_BIT4,
60 | CEC_RCV_BIT5,
61 | CEC_RCV_BIT6,
62 | CEC_RCV_BIT7,
63 | CEC_RCV_BIT_EOM,
64 | CEC_RCV_BIT_ACK,
65 |
66 | CEC_ACK,
67 | CEC_NAK,
68 |
69 | CEC_XMIT_BIT0,
70 | CEC_XMIT_BIT1,
71 | CEC_XMIT_BIT2,
72 | CEC_XMIT_BIT3,
73 | CEC_XMIT_BIT4,
74 | CEC_XMIT_BIT5,
75 | CEC_XMIT_BIT6,
76 | CEC_XMIT_BIT7,
77 | CEC_XMIT_BIT_EOM,
78 | CEC_XMIT_BIT_ACK,
79 |
80 |
81 | CEC_IDLE_RETRANSMIT_FRAME,
82 | CEC_IDLE_NEW_FRAME,
83 | CEC_IDLE_SUBSEQUENT_FRAME,
84 | } CEC_TERTIARY_STATE;
85 |
86 | private:
87 | bool ResetState();
88 | void ResetTransmit(bool retransmit);
89 | virtual void OnTransmitBegin();
90 | virtual void OnTransmitComplete(bool);
91 |
92 | void ProcessFrame();
93 |
94 | // Helper functions
95 | bool Raise();
96 | bool Lower();
97 | void HasRaised(unsigned long);
98 | void HasLowered(unsigned long);
99 | bool CheckAddress();
100 | void ReceivedBit(bool);
101 | unsigned long LineError();
102 |
103 | int _address;
104 |
105 | bool _lastLineState;
106 | unsigned long _lastStateChangeTime;
107 | unsigned long _bitStartTime;
108 |
109 | int _xmitretry;
110 |
111 | bool _eom;
112 | bool _follower;
113 | bool _broadcast;
114 | bool _amLastTransmittor;
115 | bool _transmitPending;
116 |
117 | CEC_PRIMARY_STATE _primaryState;
118 | CEC_SECONDARY_STATE _secondaryState;
119 | CEC_TERTIARY_STATE _tertiaryState;
120 | };
121 |
122 |
123 |
124 | #endif // CECWIRE_H__
125 |
--------------------------------------------------------------------------------
/src/CEC/Common.cpp:
--------------------------------------------------------------------------------
1 | #include
2 | #include "Common.h"
3 |
4 | #ifdef WIN32
5 |
6 | static char FormatBuffer[4096];
7 | static CRITICAL_SECTION CriticalSection;
8 | static bool CriticalSectionInitialized = false;
9 |
10 | void DbgPrint(const char* fmt, ...)
11 | {
12 | va_list args;
13 |
14 | if (!CriticalSectionInitialized)
15 | {
16 | InitializeCriticalSection(&CriticalSection);
17 | CriticalSectionInitialized = true;
18 | }
19 |
20 | EnterCriticalSection(&CriticalSection);
21 |
22 | va_start(args, fmt);
23 | vsprintf_s(FormatBuffer, 4096, fmt, args);
24 | OutputDebugStringA(FormatBuffer);
25 |
26 | LeaveCriticalSection(&CriticalSection);
27 | }
28 |
29 | #else
30 |
31 | //#include
32 | //#include
33 | #include
34 | #include
35 | #include
36 | //#include
37 | #include
38 |
39 | #ifdef SERIAL_DEBUG
40 | void DbgPrint(const char* fmt, ...)
41 | {
42 | char FormatBuffer[128];
43 | va_list args;
44 | va_start(args, fmt);
45 | vsprintf(FormatBuffer, fmt, args);
46 |
47 | char c;
48 | char* addr = FormatBuffer;
49 |
50 | while ((c = *addr++))
51 | {
52 | Serial.print(c);
53 | }
54 | }
55 | #endif
56 |
57 | #endif
58 |
--------------------------------------------------------------------------------
/src/CEC/Common.h:
--------------------------------------------------------------------------------
1 | #ifndef COMMON_H__
2 | #define COMMON_H__
3 |
4 | #if defined(ARDUINO_ARCH_STM32F1) || defined(ARDUINO_ARCH_STM32F2) || defined(ARDUINO_ARCH_STM32F3) || defined(ARDUINO_ARCH_STM32F4)
5 | # define STM32
6 | #endif
7 |
8 | #undef SERIAL_DEBUG
9 |
10 | #ifdef WIN32
11 | #include
12 | #include
13 | #include
14 |
15 | #define ASSERT(x) assert(x)
16 | void DbgPrint(const char* fmt, ...);
17 |
18 | extern "C"
19 | {
20 | extern unsigned long micros();
21 | extern void delayMicroseconds(unsigned int);
22 | }
23 |
24 | #elif defined(STM32)
25 |
26 | #include "dwt.h"
27 |
28 | #define ASSERT(x) ((void)0)
29 | #ifdef SERIAL_DEBUG
30 | void DbgPrint(const char* fmt, ...);
31 | #else
32 | #define DbgPrint(...) ((void)0)
33 | #endif
34 |
35 | #ifndef NULL
36 | #define NULL 0
37 | #endif
38 |
39 | #else
40 |
41 | #define ASSERT(x) ((void)0)
42 | #ifdef SERIAL_DEBUG
43 | void DbgPrint(const char* fmt, ...);
44 | #else
45 | #define DbgPrint(...) ((void)0)
46 | #endif
47 | #ifndef NULL
48 | #define NULL 0
49 | #endif
50 |
51 |
52 | extern "C"
53 | {
54 | extern unsigned long micros();
55 | extern void delayMicroseconds(unsigned int);
56 | }
57 |
58 | #endif
59 |
60 | #endif // COMMON_H__
61 |
--------------------------------------------------------------------------------
/src/CEC/Serial.cpp:
--------------------------------------------------------------------------------
1 | #include "Serial.h"
2 |
3 | SerialLine::SerialLine()
4 | {
5 | _transmitBufferCount = 0;
6 | _transmitBufferBit = 7;
7 | _transmitBufferByte = 0;
8 | _receiveBufferCount = 0;
9 | _receiveBufferBit = 7;
10 | _receiveBufferByte = 0;
11 | }
12 |
13 | void SerialLine::OnReceiveComplete(unsigned char* buffer, int count)
14 | {
15 | ResetReceiveBuffer();
16 | }
17 |
18 | void SerialLine::ClearTransmitBuffer()
19 | {
20 | _transmitBufferCount = 0;
21 | _transmitBufferBit = 7;
22 | _transmitBufferByte = 0;
23 | }
24 |
25 | bool SerialLine::Transmit(unsigned char* buffer, int count)
26 | {
27 | if (!TransmitPartial(buffer, count))
28 | return false;
29 |
30 | OnTransmitBegin();
31 | return true;
32 | }
33 |
34 | bool SerialLine::TransmitPartial(unsigned char* buffer, int count)
35 | {
36 | if (count < 0 || count >= (SERIAL_BUFFER_SIZE - _transmitBufferCount))
37 | return false;
38 |
39 | for (int i = 0; i < count; i++)
40 | _transmitBuffer[_transmitBufferCount + i] = buffer[i];
41 | _transmitBufferCount += count;
42 | _transmitBufferBit = 7;
43 | _transmitBufferByte = 0;
44 | return true;
45 | }
46 |
47 | int SerialLine::PopTransmitBit()
48 | {
49 | if (_transmitBufferByte == _transmitBufferCount)
50 | return 0;
51 |
52 | int bit = (_transmitBuffer[_transmitBufferByte] >> _transmitBufferBit) & 1;
53 | if( _transmitBufferBit-- == 0 )
54 | {
55 | _transmitBufferBit = 7;
56 | _transmitBufferByte++;
57 | }
58 | return bit;
59 | }
60 |
61 | int SerialLine::RemainingTransmitBytes()
62 | {
63 | return _transmitBufferCount - _transmitBufferByte;
64 | }
65 |
66 | int SerialLine::TransmitSize()
67 | {
68 | return _transmitBufferCount;
69 | }
70 |
71 | void SerialLine::PushReceiveBit(int bit)
72 | {
73 | _receiveBuffer[_receiveBufferByte] &= ~(1 << _receiveBufferBit);
74 | _receiveBuffer[_receiveBufferByte] |= bit << _receiveBufferBit;
75 | if (_receiveBufferBit-- == 0)
76 | {
77 | _receiveBufferBit = 7;
78 | _receiveBufferByte++;
79 | }
80 | }
81 |
82 | int SerialLine::ReceivedBytes()
83 | {
84 | return _receiveBufferByte;
85 | }
86 |
87 | void SerialLine::ResetReceiveBuffer()
88 | {
89 | _receiveBufferBit = 7;
90 | _receiveBufferByte = 0;
91 | }
92 |
93 | void SerialLine::ResetTransmitBuffer()
94 | {
95 | _transmitBufferBit = 7;
96 | _transmitBufferByte = 0;
97 | }
--------------------------------------------------------------------------------
/src/CEC/Serial.h:
--------------------------------------------------------------------------------
1 | #ifndef SERIAL_H__
2 | #define SERIAL_H__
3 |
4 | #include "Common.h"
5 |
6 | #define SERIAL_BUFFER_SIZE 16
7 |
8 | class SerialLine
9 | {
10 | public:
11 | SerialLine();
12 |
13 | void ClearTransmitBuffer();
14 | virtual bool Transmit(unsigned char* buffer, int count);
15 | virtual bool TransmitPartial(unsigned char* buffer, int count);
16 | void RegisterReceiveHandler();
17 |
18 | protected:
19 | unsigned char _transmitBuffer[SERIAL_BUFFER_SIZE];
20 | unsigned char _receiveBuffer[SERIAL_BUFFER_SIZE];
21 | int _transmitBufferCount;
22 | int _transmitBufferBit;
23 | int _transmitBufferByte;
24 | int _receiveBufferCount;
25 | int _receiveBufferBit;
26 | int _receiveBufferByte;
27 |
28 | virtual void OnTransmitBegin() {;}
29 | virtual void OnReceiveComplete(unsigned char* buffer, int count);
30 |
31 | int PopTransmitBit();
32 | int RemainingTransmitBytes();
33 | int TransmitSize();
34 | void ResetTransmitBuffer();
35 |
36 | void PushReceiveBit(int);
37 | int ReceivedBytes();
38 | void ResetReceiveBuffer();
39 | };
40 |
41 | #endif // SERIAL_H__
42 |
--------------------------------------------------------------------------------
/src/CEClient.cpp:
--------------------------------------------------------------------------------
1 | #include "CEClient.h"
2 |
3 | // create a new instance of CEClient
4 | CEClient::CEClient(int physicalAddress, int inputPin, int outputPin) :
5 | CEC_Device(physicalAddress, inputPin, outputPin<0 ? inputPin : outputPin) {
6 |
7 | _ready = false;
8 | }
9 |
10 | // init CEClient
11 | void CEClient::begin(CEC_DEVICE_TYPE type) {
12 |
13 | CEC_Device::Initialize(type);
14 | }
15 |
16 | // return the ready state
17 | bool CEClient::isReady() {
18 |
19 | return _ready;
20 | }
21 |
22 | // write a packet on the bus
23 | bool CEClient::write(int targetAddress, unsigned char* buffer, int count, int source) {
24 | if (MonitorMode && !MonitorModeWriting)
25 | return false;
26 | return CEC_Device::TransmitFrame(targetAddress, buffer, count, source);
27 | }
28 |
29 | // return the logical address
30 | int CEClient::getLogicalAddress() {
31 |
32 | return _logicalAddress;
33 | }
34 |
35 | // enable-disable promiscuous mode
36 | void CEClient::setPromiscuous(bool promiscuous) {
37 |
38 | Promiscuous = promiscuous;
39 | }
40 |
41 | // enable-disable monitor mode
42 | void CEClient::setMonitorMode(bool monitorMode) {
43 |
44 | MonitorMode = monitorMode;
45 | }
46 |
47 | // enable-disable raw mode
48 | void CEClient::setMonitorModeWriting(bool writing) {
49 |
50 | MonitorModeWriting = writing;
51 | }
52 |
53 | // set callback function when a transmit is complete
54 | void CEClient::onTransmitCompleteCallback(OnTransmitCompleteCallbackFunction callback) {
55 |
56 | _onTransmitCompleteCallback = callback;
57 | }
58 |
59 | // set callback function when a new packet is received
60 | void CEClient::onReceiveCallback(OnReceiveCallbackFunction callback) {
61 |
62 | _onReceiveCallback = callback;
63 | }
64 |
65 | // run, to be executed in the loop for the FSM
66 | void CEClient::run() {
67 |
68 | CEC_Device::Run();
69 | }
70 |
71 |
72 | // ----- PRIVATE METHODS -----
73 |
74 | // OnTransmitComplete redefinition, if a callback function is available, call it
75 | void CEClient::OnTransmitComplete(bool success) {
76 |
77 | if(_onTransmitCompleteCallback)
78 | _onTransmitCompleteCallback(success);
79 |
80 | CEC_Device::OnTransmitComplete(success);
81 | }
82 |
83 | // OnReceive redefinition, if a callback function is available, call it
84 | // if not, call the parent function
85 | void CEClient::OnReceive(int source, int dest, unsigned char* buffer, int count) {
86 | if (MonitorMode && buffer[0] == 0x84 && buffer[1] == (_physicalAddress >> 8) && buffer[2] == (_physicalAddress & 0xFF)) {
87 | _logicalAddress = source;
88 | }
89 |
90 | if(_onReceiveCallback)
91 | _onReceiveCallback(source, dest, buffer, count);
92 | else
93 | CEC_Device::OnReceive(source, dest, buffer, count);
94 |
95 | if (!MonitorMode && dest == _logicalAddress && count == 1 && buffer[0] == 0x83) {
96 | unsigned char buffer[4];
97 | buffer[0] = 0x84;
98 | buffer[1] = _physicalAddress >> 8;
99 | buffer[2] = _physicalAddress;
100 | buffer[3] = _deviceType;
101 | TransmitFrame(0xF, buffer, 4);
102 | }
103 | }
104 |
105 |
106 | // OnReady redefinition, to save the current status
107 | void CEClient::OnReady() {
108 |
109 | _ready = true;
110 | }
111 |
--------------------------------------------------------------------------------
/src/CEClient.h:
--------------------------------------------------------------------------------
1 | #ifndef CEClient_H__
2 | #define CEClient_H__
3 |
4 | #include "CEC/CEC_Device.h"
5 |
6 | class CEClient : public CEC_Device {
7 |
8 | typedef void (*OnReceiveCallbackFunction)(int, int, unsigned char*, int);
9 | typedef void (*OnTransmitCompleteCallbackFunction)(bool);
10 |
11 | public:
12 | CEClient(int physicalAddress, int inputPin, int outputPin=-1);
13 | void begin(CEC_DEVICE_TYPE type = CEC_LogicalDevice::CDT_PLAYBACK_DEVICE);
14 | bool isReady();
15 | bool write(int targetAddress, unsigned char* buffer, int count, int source=-1);
16 | int getLogicalAddress();
17 | void setPromiscuous(bool promiscuous);
18 | void setMonitorMode(bool monitorMode);
19 | void setMonitorModeWriting(bool writing);
20 | void onTransmitCompleteCallback(OnTransmitCompleteCallbackFunction);
21 | void onReceiveCallback(OnReceiveCallbackFunction);
22 | void run();
23 |
24 | private:
25 | void OnTransmitComplete(bool);
26 | void OnReceive(int source, int dest, unsigned char* buffer, int count);
27 | void OnReady();
28 | OnTransmitCompleteCallbackFunction _onTransmitCompleteCallback;
29 | OnReceiveCallbackFunction _onReceiveCallback;
30 | bool _ready;
31 | };
32 | #endif // CEClient_H__
--------------------------------------------------------------------------------