commit 16d538369ac482a36c8d634b5b1cd459e5ecfaef Author: Aeris Date: Tue Jul 10 00:04:36 2018 +0200 Initial Commit diff --git a/IRremoteESP8266/.github/CONTRIBUTING.md b/IRremoteESP8266/.github/CONTRIBUTING.md new file mode 100644 index 0000000..9614d90 --- /dev/null +++ b/IRremoteESP8266/.github/CONTRIBUTING.md @@ -0,0 +1,82 @@ +# Contributing to the IRremoteESP8266 library + +:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: + +The following is a set of guidelines for contributing to the IRremoteESP8266 library, hosted on GitHub. These are guidelines, [not rules](http://imgur.com/mSHi8). Use your best judgment, and feel free to propose changes to this document in a pull request. + +#### Table Of Contents + +[Code of Conduct](#code-of-conduct) + +[How Can I Contribute?](#how-can-i-contribute) + * [Reporting Bugs](#reporting-bugs) + * [Pull Requests](#pull-requests) + +[Styleguides](#styleguides) + * [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) + * [Git Commit Messages](#git-commit-messages) + + +## Code of Conduct + +This project and everyone participating in it is governed by the principle of ["Be excellent to each other"](http://www.imdb.com/title/tt0096928/quotes). That's it. TL;DR: _Don't be a jerk._ + +## How Can I Contribute? + +### Reporting Bugs + +This section guides you through submitting a bug report for the library. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:. + +Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as much detail as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](issue_template.md), the information it asks for helps us resolve issues faster. + +> **Note:** If you find a **Closed** issue that seems like it's the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. + +#### Before Submitting A Bug Report + +* **Check the [Troubleshooting Guide](https://github.com/markszabo/IRremoteESP8266/wiki/Troubleshooting-Guide).** You might be able to find the cause of the problem and fix it yourself. Most importantly, check if you can reproduce the problem in the latest version (a.k.a. 'master') of the library. +* **Perform a [cursory search](https://github.com/issues?q=+is%3Aissue+repo%3Amarkszabo/IRremoteESP8266)** to see if the problem is already reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. + +#### How Do I Submit A (Good) Bug Report? + +Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue and provide the following information by filling in [the template](issue_template.md). + +Explain the problem and include any additional details to help maintainers reproduce the problem: + +* **Use a clear and descriptive title** for the issue to identify the problem. +* **Describe the exact steps which reproduce the problem** in as much detail as possible. +* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). +* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. +* **Explain which behavior you expected to see instead and why.** +* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below. + +Provide more context by answering these questions: + +* **Can you reproduce the problem in one of the code examples?** +* **Did the problem start happening recently** (e.g. after updating to a new version of Arduino or the library) or was this always a problem? +* If the problem started happening recently, **can you reproduce the problem in an older version of the library?** What's the most recent version in which the problem doesn't happen? You can download older versions of the library from [the releases page](https://github.com/markszabo/IRremoteESP8266/releases). +* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens. + +Include details about your configuration, circuit and environment: + +* **Which version of the library are you using?** You can get the exact version by inspecting the `library.json` file in the root directory of the library. +* **What board are you running this on?** + +### Pull Requests + +* Do not include issue numbers in the PR title +* Include as much data and comments as practicle. +* Follow the [C++ style guide](https://google.github.io/styleguide/cppguide.html). +* Please write or ensure Unit Tests cover the change you are making, if you can. +* End all files with a newline +* Avoid platform-dependent code. +* Use c98 types where possible for better portablity. +* In almost all cases, code & documentation should be peer-reviewed by at least one other contributor. +* The code should pass all the existing testing infrastructure in Travis. e.g. Unit tests, cpplint, and basic compilation. +* State if you have tested this under real conditions if you have, and what other tests you may have carried out. + +### Git Commit Messages + +* Limit the first line to 72 characters or less +* Reference issues and pull requests liberally after the first line +* Humour is always acceptable. Be liberal with it. ;-) +* While not required, a comprehensive description of all the changes in the PR is best. diff --git a/IRremoteESP8266/.github/Contributors.md b/IRremoteESP8266/.github/Contributors.md new file mode 100644 index 0000000..69f1d30 --- /dev/null +++ b/IRremoteESP8266/.github/Contributors.md @@ -0,0 +1,16 @@ +## Contributors of this project +### Main contributors & maintainers +- [Mark Szabo](https://github.com/markszabo/) : Initial IR sending on ESP8266 +- [Sébastien Warin](https://github.com/sebastienwarin/) (http://sebastien.warin.fr) : Initial IR receiving on ESP8266 +- [David Conran](https://github.com/crankyoldgit/) +- [Roi Dayan](https://github.com/roidayan/) +- [Marcos de Alcântara Marinho](https://github.com/marcosamarinho/) +- [Massimiliano Pinto](https://github.com/pintomax/) +- [Darsh Patel](https://github.com/darshkpatel/) +- [Jonny Graham](https://github.com/jonnygraham/) +- [Stu Fisher](https://github.com/stufisher/) +- [Jorge Cisneros](https://github.com/jorgecis/) + +All contributors can be found on the [contributors site](https://github.com/markszabo/IRremoteESP8266/graphs/contributors). + +### Contributors of the [original project](https://github.com/z3t0/Arduino-IRremote) can be found on the [original project's contributors page](https://github.com/z3t0/Arduino-IRremote/blob/master/Contributors.md) diff --git a/IRremoteESP8266/.github/issue_template.md b/IRremoteESP8266/.github/issue_template.md new file mode 100644 index 0000000..664b995 --- /dev/null +++ b/IRremoteESP8266/.github/issue_template.md @@ -0,0 +1,39 @@ +_(Please use this template for reporting issues. You can delete what ever is not relevant. Giving us this information will help us help you faster. Please also read the [FAQ](https://github.com/markszabo/IRremoteESP8266/wiki/Frequently-Asked-Questions) & [Troubleshooting Guide](https://github.com/markszabo/IRremoteESP8266/wiki/Troubleshooting-Guide). Your problem may already have an answer there.)_ + +### Version/revison of the library used +_Typically located in the `library.json` file in the root directory of the library. +e.g. v2.0.0, or 'master' as at 1st of June, 2017. etc._ + +### Expected behavior +_What steps did you do and what should it have done?_ + +e.g. +1. Initialise the IRsend class. +2. IRsend.sendFoobar(0xdeadbeef); +3. Foobar branded BBQ turns on and cooks me some ribs. + +### Actual behavior +_What steps did you do, and what did or didn't actually happen?_ + +e.g. +1. Initialise the IRsend class. +2. IRsend.sendFoobar(0xdeadbeef); +3. Foobar BBQ went into Cow(er)-saving mode and fried me a couple of eggs instead. + +#### Output of raw data from IRrecvDumpV2.ino (if applicable) +_Include some raw dumps of what the device saw._ + +### Steps to reproduce the behavior +_What can we do to (pref. reliably) repeat what is happening?_ + +#### Example code used +_Include all relevant code snippets or links to the actual code files. Tip: [How to quote your code so it is still readable](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code)._ + +#### Circuit diagram and hardware used (if applicable) +_Link to an image of the circuit diagram used._ + +### I have followed the steps in the [Troubleshooting Guide](https://github.com/markszabo/IRremoteESP8266/wiki/Troubleshooting-Guide) & read the [FAQ](https://github.com/markszabo/IRremoteESP8266/wiki/Frequently-Asked-Questions) +_Yes/No._ + +### Other useful information +_More information is always welcome. Be verbose._ diff --git a/IRremoteESP8266/.gitignore b/IRremoteESP8266/.gitignore new file mode 100644 index 0000000..6d57eba --- /dev/null +++ b/IRremoteESP8266/.gitignore @@ -0,0 +1,39 @@ +#----------------------------------------# +# .gitingore for IRremoteESP8266 library # +#----------------------------------------# + +### Files to ignore. + +## Editors +# vi/vim +**/*.swp + +## Build environments +# Platformio +**/.pioenvs/ +**/.piolibdeps/ +**/.clang_complete +**/.gcc-flags.json +examples/**/lib +examples/**/.travis.yml +examples/**/.gitignore +lib/readme.txt +lib/googletest/**/* + +# GCC pre-compiled headers. +**/*.gch + +# Unit Test builds +test/*.o +test/*.a +test/*_test + +# Tools builds +tools/*.o +tools/*.a +tools/gc_decode + +.pioenvs +.piolibdeps +.clang_complete +.gcc-flags.json diff --git a/IRremoteESP8266/.gitmodules b/IRremoteESP8266/.gitmodules new file mode 100644 index 0000000..80925b8 --- /dev/null +++ b/IRremoteESP8266/.gitmodules @@ -0,0 +1,3 @@ +[submodule "lib/googletest"] + path = lib/googletest + url = https://github.com/google/googletest.git diff --git a/IRremoteESP8266/.travis.yml b/IRremoteESP8266/.travis.yml new file mode 100644 index 0000000..adfd968 --- /dev/null +++ b/IRremoteESP8266/.travis.yml @@ -0,0 +1,58 @@ +language: c +env: + - BD=esp8266:esp8266:nodemcuv2:CpuFrequency=80,FlashSize=4M3M + - BD=esp8266:esp8266:d1_mini:CpuFrequency=80,FlashSize=4M3M +before_install: + - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_1.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :1 -ac -screen 0 1280x1024x16" + - sleep 3 + - export DISPLAY=:1.0 + - wget http://downloads.arduino.cc/arduino-1.8.2-linux64.tar.xz + - tar xf arduino-1.8.2-linux64.tar.xz + - sudo mv arduino-1.8.2 /usr/local/share/arduino + - sudo ln -s /usr/local/share/arduino/arduino /usr/local/bin/arduino + - wget https://raw.githubusercontent.com/google/styleguide/gh-pages/cpplint/cpplint.py +install: + - ln -s $PWD /usr/local/share/arduino/libraries/ + - git clone https://github.com/tzapu/WiFiManager.git /usr/local/share/arduino/libraries/WiFiManager + - git clone https://github.com/knolleary/pubsubclient.git /usr/local/share/arduino/libraries/PubSubClient + - arduino --pref "boardsmanager.additional.urls=http://arduino.esp8266.com/stable/package_esp8266com_index.json" --save-prefs + - arduino --install-boards esp8266:esp8266 + - arduino --board $BD --save-prefs + - arduino --pref "compiler.warning_level=all" --save-prefs + - sudo apt-get install jq +script: + # Check that everything compiles. + - arduino --verify --board $BD $PWD/examples/IRrecvDemo/IRrecvDemo.ino + - arduino --verify --board $BD $PWD/examples/IRGCSendDemo/IRGCSendDemo.ino + - arduino --verify --board $BD $PWD/examples/IRGCTCPServer/IRGCTCPServer.ino + - arduino --verify --board $BD $PWD/examples/IRServer/IRServer.ino + - arduino --verify --board $BD $PWD/examples/IRrecvDumpV2/IRrecvDumpV2.ino + - arduino --verify --board $BD $PWD/examples/IRsendDemo/IRsendDemo.ino + - arduino --verify --board $BD $PWD/examples/JVCPanasonicSendDemo/JVCPanasonicSendDemo.ino + - arduino --verify --board $BD $PWD/examples/TurnOnDaikinAC/TurnOnDaikinAC.ino + - arduino --verify --board $BD $PWD/examples/TurnOnFujitsuAC/TurnOnFujitsuAC.ino + - arduino --verify --board $BD $PWD/examples/TurnOnKelvinatorAC/TurnOnKelvinatorAC.ino + - arduino --verify --board $BD $PWD/examples/TurnOnMitsubishiAC/TurnOnMitsubishiAC.ino + - arduino --verify --board $BD $PWD/examples/IRsendProntoDemo/IRsendProntoDemo.ino + - arduino --verify --board $BD $PWD/examples/TurnOnTrotecAC/TurnOnTrotecAC.ino + - arduino --verify --board $BD $PWD/examples/LGACSend/LGACSend.ino + - arduino --verify --board $BD $PWD/examples/TurnOnArgoAC/TurnOnArgoAC.ino + - arduino --verify --board $BD $PWD/examples/IRMQTTServer/IRMQTTServer.ino + - arduino --verify --board $BD $PWD/examples/TurnOnToshibaAC/TurnOnToshibaAC.ino + # Also check the tools programs compile. + - (cd tools; make all) + # Check for lint issues. + - shopt -s nullglob + - python cpplint.py --extensions=c,cc,cpp,ino --headers=h,hpp {src,test,tools}/*.{h,c,cc,cpp,hpp,ino} examples/*/*.{h,c,cc,cpp,hpp,ino} + - shopt -u nullglob + # Build and run the unit tests. + - (cd test; make run) + # Check the version numbers match. + - LIB_VERSION=$(egrep "^#define\s+_IRREMOTEESP8266_VERSION_\s+" src/IRremoteESP8266.h | cut -d\" -f2) + - test ${LIB_VERSION} == "$(jq -r .version library.json)" + - grep -q "^version=${LIB_VERSION}$" library.properties + +notifications: + email: + on_success: change + on_failure: change diff --git a/IRremoteESP8266/CPPLINT.cfg b/IRremoteESP8266/CPPLINT.cfg new file mode 100644 index 0000000..181f520 --- /dev/null +++ b/IRremoteESP8266/CPPLINT.cfg @@ -0,0 +1,3 @@ +set noparent +root=src +linelength=80 diff --git a/IRremoteESP8266/LICENSE.txt b/IRremoteESP8266/LICENSE.txt new file mode 100644 index 0000000..77cec6d --- /dev/null +++ b/IRremoteESP8266/LICENSE.txt @@ -0,0 +1,458 @@ + + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + diff --git a/IRremoteESP8266/README.md b/IRremoteESP8266/README.md new file mode 100644 index 0000000..0bf31a9 --- /dev/null +++ b/IRremoteESP8266/README.md @@ -0,0 +1,86 @@ +# IRremote ESP8266 Library + +[![Build Status](https://travis-ci.org/markszabo/IRremoteESP8266.svg?branch=master)](https://travis-ci.org/markszabo/IRremoteESP8266) +[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/markszabo/IRremoteESP8266.svg)](http://isitmaintained.com/project/markszabo/IRremoteESP8266 "Average time to resolve an issue") +[![Percentage of issues still open](http://isitmaintained.com/badge/open/markszabo/IRremoteESP8266.svg)](http://isitmaintained.com/project/markszabo/IRremoteESP8266 "Percentage of issues still open") +[![GitLicense](https://gitlicense.com/badge/markszabo/IRremoteESP8266)](https://gitlicense.com/license/markszabo/IRremoteESP8266) + +This library enables you to **send _and_ receive** infra-red signals on an [ESP8266 using the Arduino framework](https://github.com/esp8266/Arduino) using common 940nm IR LEDs and common IR receiver modules. e.g. TSOP{17,22,24,36,38,44,48}* etc. + +## v2.3.2 Now Available +Version 2.3.2 of the library is now [available](https://github.com/markszabo/IRremoteESP8266/releases/latest). You can view the [Release Notes](ReleaseNotes.md) for all the significant changes. + +#### Upgrading from pre-v2.0 +Usage of the library slight changed at v2.0. You will need to change your usage to work with v2.0 and beyond. You can read more about the changes required on our [Upgrade to v2.0](https://github.com/markszabo/IRremoteESP8266/wiki/Upgrading-to-v2.0) page. + +## Troubleshooting +Before reporting an issue or asking for help, please try to follow our [Troubleshooting Guide](https://github.com/markszabo/IRremoteESP8266/wiki/Troubleshooting-Guide) first. + +## Frequently Asked Questions +Some common answers to common questions and problems are on our [F.A.Q. wiki page](https://github.com/markszabo/IRremoteESP8266/wiki/Frequently-Asked-Questions). + +## Library History +This library was originally based on Ken Shirriff's work (https://github.com/shirriff/Arduino-IRremote/) + +[Mark Szabo](https://github.com/markszabo/IRremoteESP8266) has updated the IRsend class to work on ESP8266 and [Sebastien Warin](https://github.com/sebastienwarin/IRremoteESP8266) the receiving & decoding part (IRrecv class). + +As of v2.0, the library was almost entirely re-written with the ESP8266's resources in mind. + +## Installation +##### Official releases via the Arduino IDE v1.8+ (Windows & Linux) +1. Click the _"Sketch"_ -> _"Include Library"_ -> _"Manage Libraries..."_ Menu items. +1. Enter `IRremoteESP8266` into the _"Filter your search..."_ top right search box. +1. Click on the IRremoteESP8266 result of the search. +1. Select the version you wish to install and click _"Install"_. + +##### Manual Installation for Windows +1. Click on _"Clone or Download"_ button, then _"[Download ZIP](https://github.com/markszabo/IRremoteESP8266/archive->master.zip)"_ on the page. +1. Extract the contents of the downloaded zip file. +1. Rename the extracted folder to _"IRremoteESP8266"_. +1. Move this folder to your libraries directory. (under windows: `C:\Users\YOURNAME\Documents\Arduino\libraries\`) +1. Restart your Arduino IDE. +1. Check out the examples. + +##### Using Git to install library ( Linux ) +``` +cd ~/Arduino/libraries +git clone https://github.com/markszabo/IRremoteESP8266.git +``` +###### To Update to the latest version of the library +``` +cd ~/Arduino/libraries/IRremoteESP8266 && git pull +``` + +## Unit Tests +_**For Library Developers**_
+The [Unit Tests](https://en.wikipedia.org/wiki/Unit_testing) under the [test/](https://github.com/markszabo/IRremoteESP8266/tree/master/test) directory are for a Unix machine, **not** the micro-controller (ESP8266). +The tests are for execution under [Travis](https://travis-ci.org/) and on a developer's machine. +All internal library code _must_ use [c99 exact-width type definitions](https://en.wikipedia.org/wiki/C_data_types#Fixed-width_integer_types). +e.g. uint16_t etc. +You _must_ disable any Arduino/ESP8266 specific code _(e.g. `Serial.print()` etc.)_ using something like: +``` +#ifndef UNIT_TEST + +#endif +``` + +Unit Tests & Test Coverage are not perfect as we can not emulate hardware specific features and differences. e.g. Interrupts, GPIOs, CPU instruction timing etc, etc. + +The example code has no unit tests. + +To run all the tests yourself, try the following: +``` +$ cd test +$ make run +``` + +## Contributing +If you want to [contribute](.github/CONTRIBUTING.md#how-can-i-contribute) to this project, consider: +- [Report](.github/CONTRIBUTING.md#reporting-bugs) bugs and errors +- Ask for enhancements +- Improve our documentation +- [Create issues](.github/CONTRIBUTING.md#reporting-bugs) and [pull requests](.github/CONTRIBUTING.md#pull-requests) +- Tell other people about this library + +## Contributors +Available [here](.github/Contributors.md) diff --git a/IRremoteESP8266/ReleaseNotes.md b/IRremoteESP8266/ReleaseNotes.md new file mode 100644 index 0000000..b5474c8 --- /dev/null +++ b/IRremoteESP8266/ReleaseNotes.md @@ -0,0 +1,169 @@ +# Release Notes + +## _v2.3.2 (20180126)_ + +**[Bug Fixes]** +- Integer underflow caused device not to respond in `sendJVC()` (#401) + +**[Features]** +- Initial support for sending & receiving Carrier HVAC codes. (#387) +- Add Pronto HEX code support to _gc_decode_ tool. (#388) + +**[Misc]** +- Make mDNS independent of MQTT in IRMQTTServer example code. (#390 #391) + + +## _v2.3.1 (20171229)_ + +**[Bug Fixes]** +- Setting `#define SEND_FUJITSU_AC false` caused a compilation error (#375) +- Integer underflow caused huge `space()` in `sendGeneric()` (#381) + +**[Features]** +- Support sending & receiving Lasertag codes. (#374) +- Reduce the library footprint by using a new `sendGeneric()` routine. (#373) + +**[Misc]** +- Lots of grammar & typo fixes. (#378) +- Update keywords.txt for Arduino IDE users (#371) +- Update pins in examples so they are compatible with Adafruit boards. (#383) + + +## _v2.3.0 (20171208)_ + +**[Bug Fixes]** +- Panasonic-based protocols had incorrect message gap. (#358) +- Formatting error for large rawData values in example code. (#355) +- Off-by-one error in payload_copy malloc. (#337) +- Off-by-one error in unit test helper routines (#363) + +**[Features]** +- Support sending and receiving Midea A/C codes. +- Support for receiving Kelvinator A/C codes. (#332) +- Support more operation features for Daikin A/Cs. +- Support for decoding Daikin A/Cs. +- Support sending and receiving Toshiba A/Cs. (#333) +- Support sending and receiving AR-DB1 Fujitsu A/C codes. (#367) +- Add new AutoAnalyseRawData.sh & RawToGlobalCache.sh tools (#345) (#343) +- Support for MagiQuest wands. (#365) + +**[Misc]** +- Add checksum verification to Kelvinator A/C decodes. (#348) +- Changes to the threshold reporting of UNKNOWN messages (#347) +- Major re-work of Daikin A/C support. +- Sending for all A/Cs added to MQTT example code. +- MQTT example code improvements. (#334) +- IRrecvDumpV2 significant output improvements. (#363) +- Improved unit test coverage for the library. + + +## _v2.2.1 (20171025)_ + +**[Features]** +- Support for sending and decoding Nikai TV messages. (#311, #313) +- gc_decode: External utility to decode Global Cache codes. (#308, #312) +- IRMQTTServer: Example code to send IR messages via HTTP & MQTT. (#316, #323) +- Improve converting 64bit values to hexadecimal. (#318) + +**[Misc]** +- IRrecvDump.ino code is now deprecated. Use IRrecvDumpV2.ino instead. (#314) + + +## _v2.2.0 (20170922)_ + +**[Bug Fixes]** +- Add printing output of RC-MM and RC-5X protocols in example code. (#284) +- LG timing improvements based on observations (#291) + +**[Features]** +- Automatic capture timing calibration for some protocols. (#268) +- Support for creating & sending Trotec AC codes. (#279) +- Support for creating & sending Argo Ulisse 13 DCI codes. (#280 #300) +- Move to 2 microsecond timing resolution for capture of codes. (#287) +- Capture buffer changes: +- Size at runtime. (#276) +- Message timeout at runtime. (#294) +- Simplify creating & using a second buffer (#303) +- New example code: + - Trotec A/C (#279) + - LG A/C units (#289) + - Argo Ulisse 13 DCI codes. (#300) + + +## _v2.1.1 (20170711)_ + +**[Bug Fixes]** +- GlobalCache incorrectly using hardware offset for period calc. (#267) + +**[Features]** +- Support reporting of 'NEC'-like 32-bit protocols. e.g. Apple TV remote (#265) +- Add an example of sendRaw() to IRsendDemo.ino (#270) + + +## _v2.1.0 (20170704)_ + +**[Features]** +- Support for sending Pronto IR codes. (#248) +- Support for sending Fujitsu A/C codes. (#88) +- Minor improvements to examples. + + +## _v2.0.3 (20170618)_ + +**[Bug fixes]** +- Capture buffer could become corrupt after large message, breaking subsequent decodes. (#253) + + +## _v2.0.2 (20170615)_ + +**[Bug fixes]** +- Correct decode issue introduced in v2.0.1 affecting multiple protocol decoders (#243) +- Correct post-message gap for the Panasonic protocol(s) (#245) +- Incorrect display of the decoded uint64_t value in the example code. (#245) + + +## _v2.0.1 (20170614)_ + +**[Bug fixes]** +- Decoding protocols when it doesn't detect a post-command gap, and there is no more data. (#243) +- Incorrect minimum size calculation when there is no post-command gap. (#243) + + +## _v2.0.0 - 64 bit support and major improvements (20170612)_ + +**[Misc]** +- This is almost a complete re-write of the library. + +**[Features]** +- All suitable protocols now handle 64-bit data messages and are repeatable via an optional argument. +- Unit tests for all protocols. +- Far better and stricter decoding for most protocols. +- Address & command decoding for protocols where that information is available. +- Much more precise timing for generation of signals sent. +- Lower duty-cycles for some protocols. +- Several new protocols added, and some new sending and decoding routines for existing ones. +- Ability to optionally chose which protocols are included, enabling faster decoding and smaller code footprints if desired. +- Support for far larger capture buffers. (e.g. RAWLEN > 256) + +**[Bug fixes]** +- Numerous bug fixes. + + +## _v1.2.0 (20170429)_ + +**[Features]** +- Add ability to copy IR capture buffer, and continue capturing. Means faster and better IR command decoding. +- Reduce IRAM usage by 28 bytes. +- Improve capture of RC-MM & Panasonic protocols. +- Upgrade IRrecvDumpV2 to new IR capture buffer. Much fewer corrupted/truncated IR messages. + + +## _v1.1.1 (20170413)_ + +**[Bug fixes]** +- Fix a reported problem when sending the LG protocol. Preemptive fix for possible similar cases. +- Fix minor issues in examples. + +**[Features]** +- Add documentation to some examples to aid new people. +- Add ALPHA support for RC-MM protocol. (Known to be currently not 100% working.) diff --git a/IRremoteESP8266/examples/IRGCSendDemo/IRGCSendDemo.ino b/IRremoteESP8266/examples/IRGCSendDemo/IRGCSendDemo.ino new file mode 100644 index 0000000..54cf0ab --- /dev/null +++ b/IRremoteESP8266/examples/IRGCSendDemo/IRGCSendDemo.ino @@ -0,0 +1,67 @@ +/* + * IRremoteESP8266: IRsendGCDemo + * demonstrates sending Global Cache-formatted IR codes with IRsend + * Copyright 2009 Ken Shirriff + * http://arcfn.com + * + * Version 0.2 June, 2017 + * Added helpful comments + * Better includes files. + * Version 0.1 30 March, 2016 + * Based on Ken Shirriff's IrsendDemo + * Version 0.1 July, 2009 + * + * An IR LED circuit *MUST* be connected to ESP8266 pin 4 (D2). + * + * TL;DR: The IR LED needs to be driven by a transistor for a good result. + * + * Suggested circuit: + * https://github.com/markszabo/IRremoteESP8266/wiki#ir-sending + * + * Common mistakes & tips: + * * Don't just connect the IR LED directly to the pin, it won't + * have enough current to drive the IR LED effectively. + * * Make sure you have the IR LED polarity correct. + * See: https://learn.sparkfun.com/tutorials/polarity/diode-and-led-polarity + * * Typical digital camera/phones can be used to see if the IR LED is flashed. + * Replace the IR LED with a normal LED if you don't have a digital camera + * when debugging. + * * Avoid using the following pins unless you really know what you are doing: + * * Pin 0/D3: Can interfere with the boot/program mode & support circuits. + * * Pin 1/TX/TXD0: Any serial transmissions from the ESP8266 will interfere. + * * Pin 3/RX/RXD0: Any serial transmissions to the ESP8266 will interfere. + * * ESP-01 modules are tricky. We suggest you use a module with more GPIOs + * for your first time. e.g. ESP-12 etc. + */ + +#ifndef UNIT_TEST +#include +#endif +#include +#include + +// Codes are in Global Cache format less the emitter ID and request ID. +// These codes can be found in GC's Control Tower database. + +uint16_t Samsung_power_toggle[71] = { + 38000, 1, 1, 170, 170, 20, 63, 20, 63, 20, 63, 20, 20, 20, 20, 20, 20, 20, + 20, 20, 20, 20, 63, 20, 63, 20, 63, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, + 20, 20, 20, 63, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 63, 20, + 20, 20, 63, 20, 63, 20, 63, 20, 63, 20, 63, 20, 63, 20, 1798}; + +IRsend irsend(4); // An IR LED is controlled by GPIO pin 4 (D2) + +void setup() { + irsend.begin(); + Serial.begin(115200); +} + +void loop() { + Serial.println("Toggling power"); +#if SEND_GLOBALCACHE + irsend.sendGC(Samsung_power_toggle, 71); +#else // SEND_GLOBALCACHE + Serial.println("Can't send because SEND_GLOBALCACHE has been disabled."); +#endif // SEND_GLOBALCACHE + delay(10000); +} diff --git a/IRremoteESP8266/examples/IRGCSendDemo/platformio.ini b/IRremoteESP8266/examples/IRGCSendDemo/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/IRGCSendDemo/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/IRGCTCPServer/IRGCTCPServer.ino b/IRremoteESP8266/examples/IRGCTCPServer/IRGCTCPServer.ino new file mode 100644 index 0000000..ad01cba --- /dev/null +++ b/IRremoteESP8266/examples/IRGCTCPServer/IRGCTCPServer.ino @@ -0,0 +1,131 @@ +/* + * IRremoteESP8266: IRGCTCPServer - send Global Cache-formatted codes via TCP. + * An IR emitter must be connected to GPIO pin 4. + * Version 0.2 May, 2017 + * Copyright 2016 Hisham Khalifa, http://www.hishamkhalifa.com + * Copyright 2017 David Conran + * + * Example command - Samsung TV power toggle: 38000,1,1,170,170,20,63,20,63,20,63,20,20,20,20,20,20,20,20,20,20,20,63,20,63,20,63,20,20,20,20,20,20,20,20,20,20,20,20,20,63,20,20,20,20,20,20,20,20,20,20,20,20,20,63,20,20,20,63,20,63,20,63,20,63,20,63,20,63,20,1798\r\n + * For more codes, visit: https://irdb.globalcache.com/ + * + * How to use this program: + * 1) Update "ssid" and "password" below for your WIFI network. + * 2) Compile and upload the sketch to your ESP8266 module. + * 3) (Optional) Use the serial connection to confirm it started and get the + * IP address. + * 4) From a client machine, connect to port 4998 on the ESP8266, using + * 'telnet', 'nc' (netcat), 'putty' or similar command, etc. + * You may need to install one. + * Unix/OSX: + * Start a shell. Then type: + * telnet 4998 + * Windows: + * Start a new CMD window, then type: + * telnet 4998 + * + * 5) Enter a Global Cache-formatted code, starting at the frequency, + * and then a return/enter at the end. No spaces. e.g.: + * + * 38000,1,1,170,170,20,63,20,63,20,63,20,20,20,20,20,20,20,20,20,20,20,63,20,63,20,63,20,20,20,20,20,20,20,20,20,20,20,20,20,63,20,20,20,20,20,20,20,20,20,20,20,20,20,63,20,20,20,63,20,63,20,63,20,63,20,63,20,63,20,1798 + * + * To exit the 'telnet' command: + * press + <]> at the same time, then press 'q', and then . + * or: + * + might work. + * + * This program will display the ESP's IP address on the serial console, or you + * can check your wifi router for it's address. + */ + +#ifndef UNIT_TEST +#include +#endif +#include +#include +#include +#include +#include + +const char* ssid = "..."; // Put your WIFI SSID here. +const char* password = "..."; // Put your WIFI password here. + +WiFiServer server(4998); // Uses port 4998. +WiFiClient client; + +uint16_t *code_array; +IRsend irsend(4); // An IR LED is controlled by GPIO pin 4 (D2) + +void sendGCString(String str) { + int16_t index; + uint16_t count; + + // Find out how many items there are in the string. + index = -1; + count = 1; + do { + index = str.indexOf(',', index + 1); + count++; + } while (index != -1); + + // Now we know how many there are, allocate the memory to store them all. + code_array = reinterpret_cast(malloc(count * sizeof(uint16_t))); + // Check we malloc'ed successfully. + if (code_array == NULL) { // malloc failed, so give up. + Serial.printf("\nCan't allocate %d bytes. (%d bytes free)\n", + count * sizeof(uint16_t), ESP.getFreeHeap()); + Serial.println("Giving up & forcing a reboot."); + ESP.restart(); // Reboot. + delay(500); // Wait for the restart to happen. + return; // Should never get here, but just in case. + } + + // Now convert the strings to integers and place them in code_array. + count = 0; + uint16_t start_from = 0; + do { + index = str.indexOf(',', start_from); + code_array[count] = str.substring(start_from, index).toInt(); + start_from = index + 1; + count++; + } while (index != -1); + +#if SEND_GLOBALCACHE + irsend.sendGC(code_array, count); // All done. Send it. +#endif // SEND_GLOBALCACHE + free(code_array); // Free up the memory allocated. +} + +void setup() { + // initialize serial: + Serial.begin(115200); + delay(100); + Serial.println(" "); + Serial.println("IR TCP Server"); + + while (WiFi.status() != WL_CONNECTED) { + delay(900); + Serial.print("."); + } + + server.begin(); + IPAddress myAddress = WiFi.localIP(); + Serial.println(myAddress); + irsend.begin(); +} + +void loop() { + while (!client) + client = server.available(); + + while (!client.connected()) { + delay(900); + client = server.available(); + } + + if (client.available()) { + String ir_code_str = client.readStringUntil('\r'); // Exclusive of \r + client.readStringUntil('\n'); // Skip new line as well + client.flush(); + sendGCString(ir_code_str); + } +} diff --git a/IRremoteESP8266/examples/IRGCTCPServer/platformio.ini b/IRremoteESP8266/examples/IRGCTCPServer/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/IRGCTCPServer/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/IRMQTTServer/IRMQTTServer.ino b/IRremoteESP8266/examples/IRMQTTServer/IRMQTTServer.ino new file mode 100644 index 0000000..a25fef6 --- /dev/null +++ b/IRremoteESP8266/examples/IRMQTTServer/IRMQTTServer.ino @@ -0,0 +1,1211 @@ +/* + * Send arbitrary IR codes via a web server or MQTT. + * Copyright David Conran 2016, 2017, 2018 + * Version 0.3 Oct, 2017 + * + * NOTE: An IR LED circuit *MUST* be connected to ESP8266 pin 4 (D2). See IR_LED + * + * WARN: This is very advanced & complicated example code. Not for beginners. + * You are strongly suggested to try & look at other example code first. + * + * # Instructions + * + * ## Before First Boot (i.e. Compile time) + * - Set the MQTT_SERVER define below to the address of your MQTT server. + * - Arduino IDE: + * o Install the following libraries via Library Manager + * - WiFiManager (https://github.com/tzapu/WiFiManager) + * - PubSubClient (https://pubsubclient.knolleary.net/) + * o You MUST change to have the following (or larger) value: + * #define MQTT_MAX_PACKET_SIZE 512 + * - PlatformIO IDE: + * If you are using PlatformIO, this should already been done for you in + * the accompanying platformio.ini file. + * + * ## First Boot (Initial setup) + * The ESP8266 board will boot into the WiFiManager's AP mode. + * i.e. It will create a WiFi Access Point with a SSID like: "ESP123456" etc. + * Connect to that SSID. Then point your browser to http://192.168.4.1/ and + * configure the ESP8266 to connect to your desired WiFi network. + * It will remember the new WiFi connection details on next boot. + * More information can be found here: + * https://github.com/tzapu/WiFiManager#how-it-works + * + * If you need to reset the WiFi settings, visit: + * http:///reset + * + * ## Normal Use (After setup) + * Enter 'http:///ir?type=7&code=E0E09966 + * http:///ir?type=4&code=0xf50&bits=12 + * http:///ir?code=C1A2E21D&repeats=8&type=19 + * http:///ir?type=31&code=40000,1,1,96,24,24,24,48,24,24,24,24,24,48,24,24,24,24,24,48,24,24,24,24,24,24,24,24,1058 + * http:///ir?type=18&code=190B8050000000E0190B8070000010f0 + * http:///ir?repeats=1&type=25&code=0000,006E,0022,0002,0155,00AA,0015,0040,0015,0040,0015,0015,0015,0015,0015,0015,0015,0015,0015,0015,0015,0040,0015,0040,0015,0015,0015,0040,0015,0015,0015,0015,0015,0015,0015,0040,0015,0015,0015,0015,0015,0040,0015,0040,0015,0015,0015,0015,0015,0015,0015,0015,0015,0015,0015,0040,0015,0015,0015,0015,0015,0040,0015,0040,0015,0040,0015,0040,0015,0040,0015,0640,0155,0055,0015,0E40 + * + * or + * + * Send a MQTT message to the topic 'ir_server/send' using the following + * format (Order is important): + * protocol_num,hexcode e.g. 7,E0E09966 which is Samsung(7), Power On code, + * default bit size, default nr. of repeats. + * protocol_num,hexcode,bits e.g. 4,f50,12 which is Sony(4), Power Off code, + * 12 bits & default nr. of repeats. + * protocol_num,hexcode,bits,repeats e.g. 19,C1A2E21D,0,8 which is + * Sherwood(19), Vol Up, default bit size & + * repeated 8 times. + * 30,frequency,raw_string e.g. 30,38000,9000,4500,500,1500,500,750,500,750 + * Raw (30) @ 38kHz with a raw code of "9000,4500,500,1500,500,750,500,750" + * 31,code_string e.g. 31,40000,1,1,96,24,24,24,48,24,24,24,24,24,48,24,24,24,24,24,48,24,24,24,24,24,24,24,24,1058 + * GlobalCache (31) & "40000,1,1,96,..." (Sony Vol Up) + * 25,Rrepeats,hex_code_string e.g. 25,R1,0000,006E,0022,0002,0155,00AA,0015,0040,0015,0040,0015,0015,0015,0015,0015,0015,0015,0015,0015,0015,0015,0040,0015,0040,0015,0015,0015,0040,0015,0015,0015,0015,0015,0015,0015,0040,0015,0015,0015,0015,0015,0040,0015,0040,0015,0015,0015,0015,0015,0015,0015,0015,0015,0015,0015,0040,0015,0015,0015,0015,0015,0040,0015,0040,0015,0040,0015,0040,0015,0040,0015,0640,0155,0055,0015,0E40 + * Pronto (25), 1 repeat, & "0000 006E 0022 0002 ..." (Sherwood Amp Tape Input) + * ac_protocol_num,really_long_hexcode e.g. 18,190B8050000000E0190B8070000010F0 + * Kelvinator (18) Air Con on, Low Fan, 25 deg etc. + * NOTE: Ensure you zero-pad to the correct number of + * digits for the bit/byte size you want to send + * as some A/C units have units have different + * sized messages. e.g. Fujitsu A/C units. + * In short: + * No spaces after/before commas. + * Values are comma separated. + * The first value is always in Decimal. + * For simple protocols, the next value (hexcode) is always hexadecimal. + * The optional bit size is in decimal. + * + * Unix command line usage example: + * # Install a MQTT client + * $ sudo apt install mosquitto-clients + * # Send a 32-bit NEC code of 0x1234abcd via MQTT. + * $ mosquitto_pub -h 10.20.0.253 -t ir_server/send -m '3,1234abcd,32' + * + * This server will send (back) what ever IR message it just transmitted to + * the MQTT topic 'ir_server/sent' to confirm it has been performed. This works + * for messages requested via MQTT or via HTTP. + * Note: Other status messages are also sent to 'ir_server/sent' from time to + * time. + * Unix command line usage example: + * # Listen to MQTT acknowledgements. + * $ mosquitto_sub -h 10.20.0.253 -t ir_server/sent + * + * If DEBUG is turned on, there is additional information printed on the Serial + * Port. + * + * ## Updates + * You can upload new firmware over the air (OTA) via the form on the device's + * main page. No need to connect to the device again via USB. \o/ + * Your WiFi settings should be remembered between updates. \o/ \o/ + * + * Copyright Notice: + * Code for this has been borrowed from lots of other OpenSource projects & + * resources. I'm *NOT* claiming complete Copyright ownership of all the code. + * Likewise, feel free to borrow from this as much as you want. + */ + +#define MQTT_ENABLE // Comment this out if you don't want to use MQTT at all. + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#ifdef MQTT_ENABLE +// -------------------------------------------------------------------- +// * * * IMPORTANT * * * +// You must change to have the following value. +// #define MQTT_MAX_PACKET_SIZE 512 +// -------------------------------------------------------------------- +#include +#endif // MQTT_ENABLE +#include +#include + +// Configuration parameters +#define IR_LED 4 // GPIO the IR LED is connected to/controlled by. GPIO 4 = D2. +#define HTTP_PORT 80 // The port the HTTP server is listening on. +#define HOSTNAME "ir_server" // Name of the device you want in mDNS. + +#ifdef MQTT_ENABLE +// Address of your MQTT server. +#define MQTT_SERVER "10.20.0.253" // <=- CHANGE ME +#define MQTT_PORT 1883 // Default port used by MQTT servers. +// Set if your MQTT server requires a Username & Password to connect. +const char* mqtt_user = ""; +const char* mqtt_password = ""; +#define MQTT_RECONNECT_TIME 5000 // Delay(ms) between reconnect tries. + +#define MQTTprefix HOSTNAME // Change this if you want the MQTT topic to be + // independent of the hostname. +#define MQTTack MQTTprefix "/sent" // Topic we send back acknowledgements on +#define MQTTcommand MQTTprefix "/send" // Topic we get new commands from. +#endif // MQTT_ENABLE + +// HTML arguments we will parse for IR code information. +#define argType "type" +#define argData "code" +#define argBits "bits" +#define argRepeat "repeats" +#define DEBUG True + +// Globals +ESP8266WebServer server(HTTP_PORT); +IRsend irsend = IRsend(IR_LED); +MDNSResponder mdns; +WiFiClient espClient; +WiFiManager wifiManager; + +uint16_t *codeArray; +uint32_t lastReconnectAttempt = 0; // MQTT last attempt reconnection number +bool boot = true; +bool ir_lock = false; // Primitive locking for gating the IR LED. + +#ifdef MQTT_ENABLE +// MQTT client parameters +void callback(char* topic, byte* payload, unsigned int length); +PubSubClient mqtt_client(MQTT_SERVER, MQTT_PORT, callback, espClient); +// Create a unique MQTT client id. +const char* mqtt_clientid = String(MQTTprefix + + String(ESP.getChipId(), HEX)).c_str(); +#endif // MQTT_ENABLE + +// Debug messages get sent to the serial port. +void debug(String str) { +#ifdef DEBUG + uint32_t now = millis(); + Serial.printf("%07u.%03u: %s\n", now / 1000, now % 1000, str.c_str()); +#endif // DEBUG +} + +// Root web page with example usage etc. +void handleRoot() { + server.send(200, "text/html", + "IR MQTT server" + "" + "

ESP8266 IR MQTT Server

" + "
" + "

Connection details

" + "

IP address: " + WiFi.localIP().toString() + "

" +#ifdef MQTT_ENABLE + "

MQTT server: " MQTT_SERVER ":" + String(MQTT_PORT) + " ("+ + (mqtt_client.connected() ? "Connected" : "Disconnected") + ")
" + "Command topic: " MQTTcommand "
" + "Acknowledgements topic: " MQTTack "

" +#endif // MQTT_ENABLE + "
" + "

Hardcoded examples

" + "

" + "Sherwood Amp On (GlobalCache)

" + "

" + "Sherwood Amp Off (Raw)

" + "

" + "Sherwood Amp Input TAPE (Pronto)

" + "

TV on (Samsung)

" + "

Power Off (Sony 12bit)

" + "
" + "

Send a simple IR message

" + "

" + "Type: " + "" + " Code: 0x" + " Bit size: " + "" + " Repeats: " + " " + "
" + "
" + "

Send an IRremote Raw IR message

" + "

" + "" + "String: (freq,array data) " + " " + "
" + "
" + "

Send a GlobalCache" + " IR message

" + "

" + "" + "String: 1:1,1," + " " + "
" + "
" + "

Send a Pronto code IR message

" + "

" + "" + "String (comma separated): " + " Repeats: " + " " + "
" + "
" + "

Send an Air Conditioner IR message

" + "

" + "Type: " + "" + " State code: 0x" + "" + " " + "
" + "
" + "

Update IR Server firmware

" + "Warning:
" + "Updating your firmware may screw up your access to the device. " + "If you are going to use this, know what you are doing first " + "(and you probably do).
" + "

" + "Firmware to upload: " + "" + "
" + ""); +} + +// Reset web page +void handleReset() { + server.send(200, "text/html", + "Reset Config" + "" + "

Resetting the WiFiManager config back to defaults.

" + "

Device restarting. Try connecting in a few seconds.

" + ""); + // Do the reset. + wifiManager.resetSettings(); + delay(10); + ESP.restart(); + delay(1000); +} + +// Parse an Air Conditioner A/C Hex String/code and send it. +// Args: +// irType: Nr. of the protocol we need to send. +// str: A hexadecimal string containing the state to be sent. +void parseStringAndSendAirCon(const uint16_t irType, const String str) { + uint8_t strOffset = 0; + uint8_t state[STATE_SIZE_MAX] = {0}; // All array elements are set to 0. + uint16_t stateSize = 0; + + if (str.startsWith("0x") || str.startsWith("0X")) + strOffset = 2; + // Calculate how many hexadecimal characters there are. + uint16_t inputLength = str.length() - strOffset; + if (inputLength == 0) { + debug("Zero length AirCon code encountered. Ignored."); + return; // No input. Abort. + } + + switch (irType) { // Get the correct state size for the protocol. + case KELVINATOR: + stateSize = KELVINATOR_STATE_LENGTH; + break; + case TOSHIBA_AC: + stateSize = TOSHIBA_AC_STATE_LENGTH; + break; + case DAIKIN: + stateSize = DAIKIN_COMMAND_LENGTH; + break; + case MITSUBISHI_AC: + stateSize = MITSUBISHI_AC_STATE_LENGTH; + break; + case TROTEC: + stateSize = TROTEC_COMMAND_LENGTH; + break; + case ARGO: + stateSize = ARGO_COMMAND_LENGTH; + break; + case GREE: + stateSize = GREE_STATE_LENGTH; + break; + case FUJITSU_AC: + // Fujitsu has four distinct & different size states, so make a best guess + // which one we are being presented with based on the number of + // hexadecimal digits provided. i.e. Zero-pad if you need to to get + // the correct length/byte size. + stateSize = inputLength / 2; // Every two hex chars is a byte. + // Use at least the minimum size. + stateSize = std::max(stateSize, + (uint16_t) (FUJITSU_AC_STATE_LENGTH_SHORT - 1)); + // If we think it isn't a "short" message. + if (stateSize > FUJITSU_AC_STATE_LENGTH_SHORT) + // Then it has to be at least the smaller version of the "normal" size. + stateSize = std::max(stateSize, + (uint16_t) (FUJITSU_AC_STATE_LENGTH - 1)); + // Lastly, it should never exceed the maximum "normal" size. + stateSize = std::min(stateSize, (uint16_t) FUJITSU_AC_STATE_LENGTH); + break; + case HAIER_AC: + stateSize = HAIER_AC_STATE_LENGTH; + break; + default: // Not a protocol we expected. Abort. + debug("Unexpected AirCon protocol detected. Ignoring."); + return; + } + if (inputLength > stateSize * 2) { + debug("AirCon code to large for the given protocol."); + return; + } + + // Ptr to the least significant byte of the resulting state for this protocol. + uint8_t *statePtr = &state[stateSize - 1]; + + // Convert the string into a state array of the correct length. + for (uint16_t i = 0; i < inputLength; i++) { + // Grab the next least sigificant hexadecimal digit from the string. + uint8_t c = tolower(str[inputLength + strOffset - i - 1]); + if (isxdigit(c)) { + if (isdigit(c)) + c -= '0'; + else + c = c - 'a' + 10; + } else { + debug("Aborting! Non-hexadecimal char found in AirCon state: " + str); + return; + } + if (i % 2 == 1) { // Odd: Upper half of the byte. + *statePtr += (c << 4); + statePtr--; // Advance up to the next least significant byte of state. + } else { // Even: Lower half of the byte. + *statePtr = c; + } + } + + // Make the appropriate call for the protocol type. + switch (irType) { +#if SEND_KELVINATOR + case KELVINATOR: + irsend.sendKelvinator(reinterpret_cast(state)); + break; +#endif +#if SEND_TOSHIBA_AC + case TOSHIBA_AC: + irsend.sendToshibaAC(reinterpret_cast(state)); + break; +#endif +#if SEND_DAIKIN + case DAIKIN: + irsend.sendDaikin(reinterpret_cast(state)); + break; +#endif +#if MITSUBISHI_AC + case MITSUBISHI_AC: + irsend.sendMitsubishiAC(reinterpret_cast(state)); + break; +#endif +#if SEND_TROTEC + case TROTEC: + irsend.sendTrotec(reinterpret_cast(state)); + break; +#endif +#if SEND_ARGO + case ARGO: + irsend.sendArgo(reinterpret_cast(state)); + break; +#endif +#if SEND_GREE + case GREE: + irsend.sendGree(reinterpret_cast(state)); + break; +#endif +#if SEND_FUJITSU_AC + case FUJITSU_AC: + irsend.sendFujitsuAC(reinterpret_cast(state), stateSize); + break; +#endif + } +} + +// Count how many values are in the String. +// Args: +// str: String containing the values. +// sep: Character that separates the values. +// Returns: +// The number of values found in the String. +uint16_t countValuesInStr(const String str, char sep) { + int16_t index = -1; + uint16_t count = 1; + do { + index = str.indexOf(sep, index + 1); + count++; + } while (index != -1); + return count; +} + +// Dynamically allocate an array of uint16_t's. +// Args: +// size: Nr. of uint16_t's need to be in the new array. +// Returns: +// A Ptr to the new array. Restarts the ESP8266 if it fails. +uint16_t * newCodeArray(const uint16_t size) { + uint16_t *result; + + result = reinterpret_cast(malloc(size * sizeof(uint16_t))); + // Check we malloc'ed successfully. + if (result == NULL) { // malloc failed, so give up. + Serial.printf("\nCan't allocate %d bytes. (%d bytes free)\n", + size * sizeof(uint16_t), ESP.getFreeHeap()); + Serial.println("Giving up & forcing a reboot."); + ESP.restart(); // Reboot. + delay(500); // Wait for the restart to happen. + return result; // Should never get here, but just in case. + } + return result; +} + +#if SEND_GLOBALCACHE +// Parse a GlobalCache String/code and send it. +// Args: +// str: A GlobalCache formatted String of comma separated numbers. +// e.g. "38000,1,1,170,170,20,63,20,63,20,63,20,20,20,20,20,20,20,20,20, +// 20,20,63,20,63,20,63,20,20,20,20,20,20,20,20,20,20,20,20,20,63, +// 20,20,20,20,20,20,20,20,20,20,20,20,20,63,20,20,20,63,20,63,20, +// 63,20,63,20,63,20,63,20,1798" +// Note: The leading "1:1,1," of normal GC codes should be removed. +void parseStringAndSendGC(const String str) { + uint16_t count; + uint16_t *code_array; + String tmp_str; + + // Remove the leading "1:1,1," if present. + if (str.startsWith("1:1,1,")) + tmp_str = str.substring(6); + else + tmp_str = str; + + // Find out how many items there are in the string. + count = countValuesInStr(tmp_str, ','); + + // Now we know how many there are, allocate the memory to store them all. + code_array = newCodeArray(count); + + // Now convert the strings to integers and place them in code_array. + count = 0; + uint16_t start_from = 0; + int16_t index = -1; + do { + index = tmp_str.indexOf(',', start_from); + code_array[count] = tmp_str.substring(start_from, index).toInt(); + start_from = index + 1; + count++; + } while (index != -1); + + irsend.sendGC(code_array, count); // All done. Send it. + free(code_array); // Free up the memory allocated. +} +#endif // SEND_GLOBALCACHE + +#if SEND_PRONTO +// Parse a Pronto Hex String/code and send it. +// Args: +// str: A comma-separated String of nr. of repeats, then hexadecimal numbers. +// e.g. "R1,0000,0067,0000,0015,0060,0018,0018,0018,0030,0018,0030,0018, +// 0030,0018,0018,0018,0030,0018,0018,0018,0018,0018,0030,0018, +// 0018,0018,0030,0018,0030,0018,0030,0018,0018,0018,0018,0018, +// 0030,0018,0018,0018,0018,0018,0030,0018,0018,03f6" +// or +// "0000,0067,0000,0015,0060,0018". i.e. without the Repeat value +// Requires at least PRONTO_MIN_LENGTH comma-separated values. +// sendPronto() only supports raw pronto code types, thus so does this. +// repeats: Nr. of times the message is to be repeated. +// This value is ignored if an embeddd repeat is found in str. +void parseStringAndSendPronto(const String str, uint16_t repeats) { + uint16_t count; + uint16_t *code_array; + int16_t index = -1; + uint16_t start_from = 0; + + // Find out how many items there are in the string. + count = countValuesInStr(str, ','); + + // Check if we have the optional embedded repeats value in the code string. + if (str.startsWith("R") || str.startsWith("r")) { + // Grab the first value from the string, as it is the nr. of repeats. + index = str.indexOf(',', start_from); + repeats = str.substring(start_from + 1, index).toInt(); // Skip the 'R'. + start_from = index + 1; + count--; // We don't count the repeats value as part of the code array. + } + + // We need at least PRONTO_MIN_LENGTH values for the code part. + if (count < PRONTO_MIN_LENGTH) return; + + // Now we know how many there are, allocate the memory to store them all. + code_array = newCodeArray(count); + + // Rest of the string are values for the code array. + // Now convert the hex strings to integers and place them in code_array. + count = 0; + do { + index = str.indexOf(',', start_from); + // Convert the hexadecimal value string to an unsigned integer. + code_array[count] = strtoul(str.substring(start_from, index).c_str(), + NULL, 16); + start_from = index + 1; + count++; + } while (index != -1); + + irsend.sendPronto(code_array, count, repeats); // All done. Send it. + free(code_array); // Free up the memory allocated. +} +#endif // SEND_PRONTO + +#if SEND_RAW +// Parse an IRremote Raw Hex String/code and send it. +// Args: +// str: A comma-separated String containing the freq and raw IR data. +// e.g. "38000,9000,4500,600,1450,600,900,650,1500,..." +// Requires at least two comma-separated values. +// First value is the transmission frequency in Hz or kHz. +void parseStringAndSendRaw(const String str) { + uint16_t count; + uint16_t freq = 38000; // Default to 38kHz. + uint16_t *raw_array; + + // Find out how many items there are in the string. + count = countValuesInStr(str, ','); + + // We expect the frequency as the first comma separated value, so we need at + // least two values. If not, bail out. + if (count < 2) return; + count--; // We don't count the frequency value as part of the raw array. + + // Now we know how many there are, allocate the memory to store them all. + raw_array = newCodeArray(count); + + // Grab the first value from the string, as it is the frequency. + int16_t index = str.indexOf(',', 0); + freq = str.substring(0, index).toInt(); + uint16_t start_from = index + 1; + // Rest of the string are values for the raw array. + // Now convert the strings to integers and place them in raw_array. + count = 0; + do { + index = str.indexOf(',', start_from); + raw_array[count] = str.substring(start_from, index).toInt(); + start_from = index + 1; + count++; + } while (index != -1); + + irsend.sendRaw(raw_array, count, freq); // All done. Send it. + free(raw_array); // Free up the memory allocated. +} +#endif // SEND_RAW + +// Parse the URL args to find the IR code. +void handleIr() { + uint64_t data = 0; + String data_str = ""; + int ir_type = 3; // Default to NEC codes. + uint16_t nbits = 0; + uint16_t repeat = 0; + + for (uint16_t i = 0; i < server.args(); i++) { + if (server.argName(i) == argType) + ir_type = atoi(server.arg(i).c_str()); + if (server.argName(i) == argData) { + data = getUInt64fromHex(server.arg(i).c_str()); + data_str = server.arg(i); + } + if (server.argName(i) == argBits) + nbits = atoi(server.arg(i).c_str()); + if (server.argName(i) == argRepeat) + repeat = atoi(server.arg(i).c_str()); + } + debug("New code received via HTTP"); + sendIRCode(ir_type, data, data_str.c_str(), nbits, repeat); + handleRoot(); +} + +void handleNotFound() { + String message = "File Not Found\n\n"; + message += "URI: "; + message += server.uri(); + message += "\nMethod: "; + message += (server.method() == HTTP_GET)?"GET":"POST"; + message += "\nArguments: "; + message += server.args(); + message += "\n"; + for (uint8_t i=0; i < server.args(); i++) + message += " " + server.argName(i) + ": " + server.arg(i) + "\n"; + server.send(404, "text/plain", message); +} + +void setup_wifi() { + delay(10); + // We start by connecting to a WiFi network + + wifiManager.setTimeout(300); // Time out after 5 mins. + if (!wifiManager.autoConnect()) { + debug("Wifi failed to connect and hit timeout."); + delay(3000); + // Reboot. A.k.a. "Have you tried turning it Off and On again?" + ESP.reset(); + delay(5000); + } + + debug("WiFi connected. IP address: " + WiFi.localIP()); +} + +void setup(void) { + irsend.begin(); + + #ifdef DEBUG + Serial.begin(115200); + #endif // DEBUG + + setup_wifi(); + + // Wait a bit for things to settle. + delay(1500); + + lastReconnectAttempt = 0; + + if (mdns.begin(HOSTNAME, WiFi.localIP())) { + debug("MDNS responder started"); + } + + // Setup the root web page. + server.on("/", handleRoot); + // Setup the page to handle web-based IR codes. + server.on("/ir", handleIr); + // Setup a reset page to cause WiFiManager information to be reset. + server.on("/reset", handleReset); + + // Setup the URL to allow Over-The-Air (OTA) firmware updates. + server.on("/update", HTTP_POST, [](){ + server.sendHeader("Connection", "close"); + server.send(200, "text/plain", (Update.hasError())?"FAIL":"OK"); + ESP.restart(); + }, [](){ + HTTPUpload& upload = server.upload(); + if (upload.status == UPLOAD_FILE_START) { + WiFiUDP::stopAll(); + debug("Update: " + upload.filename); + uint32_t maxSketchSpace = (ESP.getFreeSketchSpace() - 0x1000) & + 0xFFFFF000; + if (!Update.begin(maxSketchSpace)) { // start with max available size +#ifdef DEBUG + Update.printError(Serial); +#endif // DEBUG + } + } else if (upload.status == UPLOAD_FILE_WRITE) { + if (Update.write(upload.buf, upload.currentSize) != + upload.currentSize) { +#ifdef DEBUG + Update.printError(Serial); +#endif // DEBUG + } + } else if (upload.status == UPLOAD_FILE_END) { + if (Update.end(true)) { // true to set the size to the current progress + debug("Update Success: " + (String) upload.totalSize + + "\nRebooting..."); + } + } + yield(); + }); + + // Set up an error page. + server.onNotFound(handleNotFound); + + server.begin(); + debug("HTTP server started"); +} + +#ifdef MQTT_ENABLE +// MQTT subscribing to topic +void subscribing(const String topic_name) { + // subscription to topic for receiving data + if (mqtt_client.subscribe(topic_name.c_str())) { + debug("Subscription OK to " + topic_name); + } +} + +bool reconnect() { + // Loop a few times or until we're reconnected + uint16_t tries = 1; + while (!mqtt_client.connected() && tries <= 3) { + int connected = false; + // Attempt to connect + debug("Attempting MQTT connection to " MQTT_SERVER ":" + String(MQTT_PORT) + + "... "); + if (mqtt_user && mqtt_password) + connected = mqtt_client.connect(mqtt_clientid, mqtt_user, mqtt_password); + else + connected = mqtt_client.connect(mqtt_clientid); + if (connected) { + // Once connected, publish an announcement... + mqtt_client.publish(MQTTack, "Connected"); + debug("connected."); + // Subscribing to topic(s) + subscribing(MQTTcommand); + } else { + debug("failed, rc=" + String(mqtt_client.state()) + + " Try again in a bit."); + // Wait for a bit before retrying + delay(tries << 7); // Linear increasing back-off (x128) + } + tries++; + } + return mqtt_client.connected(); +} +#endif // MQTT_ENABLE + +void loop(void) { + server.handleClient(); + +#ifdef MQTT_ENABLE + // MQTT client connection management + if (!mqtt_client.connected()) { + uint32_t now = millis(); + // Reconnect if it's longer than MQTT_RECONNECT_TIME since we last tried. + if (now - lastReconnectAttempt > MQTT_RECONNECT_TIME) { + lastReconnectAttempt = now; + debug("client mqtt not connected, trying to connect"); + // Attempt to reconnect + if (reconnect()) { + lastReconnectAttempt = 0; + if (boot) { + mqtt_client.publish(MQTTack, "IR Server just booted"); + boot = false; + } else { + mqtt_client.publish(MQTTack, "IR Server just (re)connected to MQTT"); + } + } + } + } else { + // MQTT loop + mqtt_client.loop(); + } +#endif // MQTT_ENABLE + delay(100); +} + +// Arduino framework doesn't support strtoull(), so make our own one. +uint64_t getUInt64fromHex(char const *str) { + uint64_t result = 0; + uint16_t offset = 0; + // Skip any leading '0x' or '0X' prefix. + if (str[0] == '0' && (str[1] == 'x' || str[1] == 'X')) + offset = 2; + for (; isxdigit((unsigned char)str[offset]); offset++) { + char c = str[offset]; + result *= 16; + if (isdigit(c)) /* '0' .. '9' */ + result += c - '0'; + else if (isupper(c)) /* 'A' .. 'F' */ + result += c - 'A' + 10; + else /* 'a' .. 'f'*/ + result += c - 'a' + 10; + } + return result; +} + +// Transmit the given IR message. +// +// Args: +// ir_type: enum of the protocol to be sent. +// code: Numeric payload of the IR message. Most protocols use this. +// code_str: The unparsed code to be sent. Used by complex protocol encodings. +// bits: Nr. of bits in the protocol. 0 means use the protocol's default. +// repeat: Nr. of times the message is to be repeated. (Not all protcols.) +void sendIRCode(int const ir_type, uint64_t const code, char const * code_str, + uint16_t bits, uint16_t repeat) { + // Create a pseudo-lock so we don't try to send two codes at the same time. + while (ir_lock) + delay(20); + ir_lock = true; + + // send the IR message. + switch (ir_type) { +#if SEND_RC5 + case RC5: // 1 + if (bits == 0) + bits = RC5_BITS; + irsend.sendRC5(code, bits, repeat); + break; +#endif +#if SEND_RC6 + case RC6: // 2 + if (bits == 0) + bits = RC6_MODE0_BITS; + irsend.sendRC6(code, bits, repeat); + break; +#endif +#if SEND_NEC + case NEC: // 3 + if (bits == 0) + bits = NEC_BITS; + irsend.sendNEC(code, bits, repeat); + break; +#endif +#if SEND_SONY + case SONY: // 4 + if (bits == 0) + bits = SONY_12_BITS; + repeat = std::max(repeat, (uint16_t) SONY_MIN_REPEAT); + irsend.sendSony(code, bits, repeat); + break; +#endif +#if SEND_PANASONIC + case PANASONIC: // 5 + if (bits == 0) + bits = PANASONIC_BITS; + irsend.sendPanasonic64(code, bits, repeat); + break; +#endif +#if SEND_JVC + case JVC: // 6 + if (bits == 0) + bits = JVC_BITS; + irsend.sendJVC(code, bits, repeat); + break; +#endif +#if SEND_SAMSUNG + case SAMSUNG: // 7 + if (bits == 0) + bits = SAMSUNG_BITS; + irsend.sendSAMSUNG(code, bits, repeat); + break; +#endif +#if SEND_WHYNTER + case WHYNTER: // 8 + if (bits == 0) + bits = WHYNTER_BITS; + irsend.sendWhynter(code, bits, repeat); + break; +#endif +#if SEND_AIWA_RC_T501 + case AIWA_RC_T501: // 9 + if (bits == 0) + bits = AIWA_RC_T501_BITS; + repeat = std::max(repeat, (uint16_t) AIWA_RC_T501_MIN_REPEAT); + irsend.sendAiwaRCT501(code, bits, repeat); + break; +#endif +#if SEND_LG + case LG: // 10 + if (bits == 0) + bits = LG_BITS; + irsend.sendLG(code, bits, repeat); + break; +#endif +#if SEND_MITSUBISHI + case MITSUBISHI: // 12 + if (bits == 0) + bits = MITSUBISHI_BITS; + repeat = std::max(repeat, (uint16_t) MITSUBISHI_MIN_REPEAT); + irsend.sendMitsubishi(code, bits, repeat); + break; +#endif +#if SEND_DISH + case DISH: // 13 + if (bits == 0) + bits = DISH_BITS; + repeat = std::max(repeat, (uint16_t) DISH_MIN_REPEAT); + irsend.sendDISH(code, bits, repeat); + break; +#endif +#if SEND_SHARP + case SHARP: // 14 + if (bits == 0) + bits = SHARP_BITS; + irsend.sendSharpRaw(code, bits, repeat); + break; +#endif +#if SEND_COOLIX + case COOLIX: // 15 + if (bits == 0) + bits = COOLIX_BITS; + irsend.sendCOOLIX(code, bits, repeat); + break; +#endif + case DAIKIN: // 16 + case KELVINATOR: // 18 + case MITSUBISHI_AC: // 20 + case GREE: // 24 + case ARGO: // 27 + case TROTEC: // 28 + case TOSHIBA_AC: // 32 + case FUJITSU_AC: // 33 + parseStringAndSendAirCon(ir_type, code_str); + break; +#if SEND_DENON + case DENON: // 17 + if (bits == 0) + bits = DENON_BITS; + irsend.sendDenon(code, bits, repeat); + break; +#endif +#if SEND_SHERWOOD + case SHERWOOD: // 19 + if (bits == 0) + bits = SHERWOOD_BITS; + repeat = std::max(repeat, (uint16_t) SHERWOOD_MIN_REPEAT); + irsend.sendSherwood(code, bits, repeat); + break; +#endif +#if SEND_RCMM + case RCMM: // 21 + if (bits == 0) + bits == RCMM_BITS; + irsend.sendRCMM(code, bits, repeat); + break; +#endif +#if SEND_SANYO + case SANYO_LC7461: // 22 + if (bits == 0) + bits = SANYO_LC7461_BITS; + irsend.sendSanyoLC7461(code, bits, repeat); + break; +#endif +#if SEND_RC5 + case RC5X: // 23 + if (bits == 0) + bits = RC5X_BITS; + irsend.sendRC5(code, bits, repeat); + break; +#endif +#if SEND_PRONTO + case PRONTO: // 25 + parseStringAndSendPronto(code_str, repeat); + break; +#endif +#if SEND_NIKAI + case NIKAI: // 29 + if (bits == 0) + bits = NIKAI_BITS; + irsend.sendNikai(code, bits, repeat); + break; +#endif +#if SEND_RAW + case RAW: // 30 + parseStringAndSendRaw(code_str); + break; +#endif +#if SEND_GLOBALCACHE + case GLOBALCACHE: // 31 + parseStringAndSendGC(code_str); + break; +#endif +#if SEND_MIDEA + case MIDEA: // 34 + if (bits == 0) + bits = MIDEA_BITS; + irsend.sendMidea(code, bits, repeat); + break; +#endif +#if SEND_MAGIQUEST + case MAGIQUEST: // 35 + if (bits == 0) + bits = MAGIQUEST_BITS; + irsend.sendMagiQuest(code, bits, repeat); + break; +#endif +#if SEND_LASERTAG + case LASERTAG: // 36 + if (bits == 0) + bits = LASERTAG_BITS; + irsend.sendLasertag(code, bits, repeat); + break; +#endif +#if SEND_CARRIER_AC + case CARRIER_AC: // 37 + if (bits == 0) + bits = CARRIER_AC_BITS; + irsend.sendCarrierAC(code, bits, repeat); + break; +#endif + } + + // Release the lock. + ir_lock = false; + + // Indicate that we sent the message. + debug("Sent the IR message."); + debug("Type: " + String(ir_type)); + switch (ir_type) { + case KELVINATOR: + case PRONTO: + case RAW: + case GLOBALCACHE: + debug("Code: "); + debug(code_str); + debug("Repeats: " + String(repeat)); + // Confirm what we were asked to send was sent. +#ifdef MQTT_ENABLE + if (ir_type == PRONTO && repeat > 0) + mqtt_client.publish(MQTTack, (String(ir_type) + ",R" + + String(repeat) + "," + + String(code_str)).c_str()); + else + mqtt_client.publish(MQTTack, (String(ir_type) + "," + + String(code_str)).c_str()); +#endif // MQTT_ENABLE + break; + default: + debug("Code: 0x" + uint64ToString(code, 16)); + debug("Bits: " + String(bits)); + debug("Repeats: " + String(repeat)); + +#ifdef MQTT_ENABLE + mqtt_client.publish(MQTTack, (String(ir_type) + "," + + uint64ToString(code, 16) + + "," + String(bits) + "," + + String(repeat)).c_str()); +#endif // MQTT_ENABLE + } +} + +#ifdef MQTT_ENABLE +void receivingMQTT(String const topic_name, String const callback_str) { + char* tok_ptr; + uint64_t code = 0; + uint16_t nbits = 0; + uint16_t repeat = 0; + + debug("Receiving data by MQTT topic " + topic_name); + + // Make a copy of the callback string as strtok destroys it. + char* callback_c_str = strdup(callback_str.c_str()); + debug("MQTT Payload (raw): " + callback_str); + + // Get the numeric protocol type. + int ir_type = strtoul(strtok_r(callback_c_str, ",", &tok_ptr), NULL, 10); + char* next = strtok_r(NULL, ",", &tok_ptr); + // If there is unparsed string left, try to convert it assuming it's hex. + if (next != NULL) { + code = getUInt64fromHex(next); + next = strtok_r(NULL, ",", &tok_ptr); + } else { + // We require at least two value in the string. Give up. + return; + } + // If there is still string left, assume it is the bit size. + if (next != NULL) { + nbits = atoi(next); + next = strtok_r(NULL, ",", &tok_ptr); + } + // If there is still string left, assume it is the repeat count. + if (next != NULL) + repeat = atoi(next); + + free(callback_c_str); + + + // send received MQTT value by IR signal + sendIRCode(ir_type, code, + callback_str.substring(callback_str.indexOf(",") + 1).c_str(), + nbits, repeat); +} + +// Callback function, when the gateway receive an MQTT value on the topics +// subscribed this function is called +void callback(char* topic, byte* payload, unsigned int length) { + // In order to republish this payload, a copy must be made + // as the orignal payload buffer will be overwritten whilst + // constructing the PUBLISH packet. + // Allocate the correct amount of memory for the payload copy + byte* payload_copy = reinterpret_cast(malloc(length + 1)); + // Copy the payload to the new buffer + memcpy(payload_copy, payload, length); + + // Conversion to a printable string + payload_copy[length] = '\0'; + String callback_string = String(reinterpret_cast(payload_copy)); + String topic_name = String(reinterpret_cast(topic)); + + // launch the function to treat received data + receivingMQTT(topic_name, callback_string); + + // Free the memory + free(payload_copy); +} +#endif // MQTT_ENABLE diff --git a/IRremoteESP8266/examples/IRMQTTServer/platformio.ini b/IRremoteESP8266/examples/IRMQTTServer/platformio.ini new file mode 100644 index 0000000..c87e569 --- /dev/null +++ b/IRremoteESP8266/examples/IRMQTTServer/platformio.ini @@ -0,0 +1,28 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = -DMQTT_MAX_PACKET_SIZE=512 +lib_deps_builtin = +lib_deps_external = + PubSubClient + WifiManager@0.12 + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} + +[env:d1_mini] +platform=espressif8266 +framework=arduino +board=d1_mini +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/IRServer/IRServer.ino b/IRremoteESP8266/examples/IRServer/IRServer.ino new file mode 100644 index 0000000..eeec9f4 --- /dev/null +++ b/IRremoteESP8266/examples/IRServer/IRServer.ino @@ -0,0 +1,123 @@ +/* + * IRremoteESP8266: IRServer - demonstrates sending IR codes controlled from a webserver + * Version 0.2 June, 2017 + * Copyright 2015 Mark Szabo + * + * An IR LED circuit *MUST* be connected to ESP8266 pin 4 (D2). + * + * TL;DR: The IR LED needs to be driven by a transistor for a good result. + * + * Suggested circuit: + * https://github.com/markszabo/IRremoteESP8266/wiki#ir-sending + * + * Common mistakes & tips: + * * Don't just connect the IR LED directly to the pin, it won't + * have enough current to drive the IR LED effectively. + * * Make sure you have the IR LED polarity correct. + * See: https://learn.sparkfun.com/tutorials/polarity/diode-and-led-polarity + * * Typical digital camera/phones can be used to see if the IR LED is flashed. + * Replace the IR LED with a normal LED if you don't have a digital camera + * when debugging. + * * Avoid using the following pins unless you really know what you are doing: + * * Pin 0/D3: Can interfere with the boot/program mode & support circuits. + * * Pin 1/TX/TXD0: Any serial transmissions from the ESP8266 will interfere. + * * Pin 3/RX/RXD0: Any serial transmissions to the ESP8266 will interfere. + * * ESP-01 modules are tricky. We suggest you use a module with more GPIOs + * for your first time. e.g. ESP-12 etc. + */ +#ifndef UNIT_TEST +#include +#endif +#include +#include +#include +#include +#include +#include + +const char* ssid = "....."; +const char* password = "....."; +MDNSResponder mdns; + +ESP8266WebServer server(80); + +IRsend irsend(4); // An IR LED is controlled by GPIO pin 4 (D2) + +void handleRoot() { + server.send(200, "text/html", + "" \ + "ESP8266 Demo" \ + "" \ + "

Hello from ESP8266, you can send NEC encoded IR" \ + "signals from here!

" \ + "

Send 0xFFE01F

" \ + "

Send 0xFAB123

" \ + "

Send 0xFFE896

" \ + "" \ + ""); +} + +void handleIr() { + for (uint8_t i = 0; i < server.args(); i++) { + if (server.argName(i) == "code") { + uint32_t code = strtoul(server.arg(i).c_str(), NULL, 10); +#if SEND_NEC + irsend.sendNEC(code, 32); +#endif // SEND_NEC + } + } + handleRoot(); +} + +void handleNotFound() { + String message = "File Not Found\n\n"; + message += "URI: "; + message += server.uri(); + message += "\nMethod: "; + message += (server.method() == HTTP_GET)?"GET":"POST"; + message += "\nArguments: "; + message += server.args(); + message += "\n"; + for (uint8_t i = 0; i < server.args(); i++) + message += " " + server.argName(i) + ": " + server.arg(i) + "\n"; + server.send(404, "text/plain", message); +} + +void setup(void) { + irsend.begin(); + + Serial.begin(115200); + WiFi.begin(ssid, password); + Serial.println(""); + + // Wait for connection + while (WiFi.status() != WL_CONNECTED) { + delay(500); + Serial.print("."); + } + Serial.println(""); + Serial.print("Connected to "); + Serial.println(ssid); + Serial.print("IP address: "); + Serial.println(WiFi.localIP()); + + if (mdns.begin("esp8266", WiFi.localIP())) { + Serial.println("MDNS responder started"); + } + + server.on("/", handleRoot); + server.on("/ir", handleIr); + + server.on("/inline", [](){ + server.send(200, "text/plain", "this works as well"); + }); + + server.onNotFound(handleNotFound); + + server.begin(); + Serial.println("HTTP server started"); +} + +void loop(void) { + server.handleClient(); +} diff --git a/IRremoteESP8266/examples/IRServer/platformio.ini b/IRremoteESP8266/examples/IRServer/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/IRServer/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/IRrecvDemo/IRrecvDemo.ino b/IRremoteESP8266/examples/IRrecvDemo/IRrecvDemo.ino new file mode 100644 index 0000000..c7936e5 --- /dev/null +++ b/IRremoteESP8266/examples/IRrecvDemo/IRrecvDemo.ino @@ -0,0 +1,52 @@ +/* + * IRremoteESP8266: IRrecvDemo - demonstrates receiving IR codes with IRrecv + * This is very simple teaching code to show you how to use the library. + * If you are trying to decode your Infra-Red remote(s) for later replay, + * use the IRrecvDumpV2.ino example code instead of this. + * An IR detector/demodulator must be connected to the input RECV_PIN. + * Copyright 2009 Ken Shirriff, http://arcfn.com + * Example circuit diagram: + * https://github.com/markszabo/IRremoteESP8266/wiki#ir-receiving + * Changes: + * Version 0.2 June, 2017 + * Changed GPIO pin to the same as other examples. + * Used our own method for printing a uint64_t. + * Changed the baud rate to 115200. + * Version 0.1 Sept, 2015 + * Based on Ken Shirriff's IrsendDemo Version 0.1 July, 2009 + */ + +#ifndef UNIT_TEST +#include +#endif +#include +#include +#include + +// An IR detector/demodulator is connected to GPIO pin 14(D5 on a NodeMCU +// board). +uint16_t RECV_PIN = 14; + +IRrecv irrecv(RECV_PIN); + +decode_results results; + +void setup() { + Serial.begin(115200); + irrecv.enableIRIn(); // Start the receiver + while (!Serial) // Wait for the serial connection to be establised. + delay(50); + Serial.println(); + Serial.print("IRrecvDemo is now running and waiting for IR message on Pin "); + Serial.println(RECV_PIN); +} + +void loop() { + if (irrecv.decode(&results)) { + // print() & println() can't handle printing long longs. (uint64_t) + serialPrintUint64(results.value, HEX); + Serial.println(""); + irrecv.resume(); // Receive the next value + } + delay(100); +} diff --git a/IRremoteESP8266/examples/IRrecvDemo/platformio.ini b/IRremoteESP8266/examples/IRrecvDemo/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/IRrecvDemo/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/IRrecvDump/IRrecvDump.ino b/IRremoteESP8266/examples/IRrecvDump/IRrecvDump.ino new file mode 100644 index 0000000..8564496 --- /dev/null +++ b/IRremoteESP8266/examples/IRrecvDump/IRrecvDump.ino @@ -0,0 +1,104 @@ +/* + * IRremoteESP8266: IRrecvDump - dump details of IR codes with IRrecv + * Copyright 2009 Ken Shirriff, http://arcfn.com + * + ***** DEPRECATED - DO NOT USE ***** + * Unless you know what you are doing, you should be using the + * IRrecvDumpV2.ino sketch/example instead for capturing & decoding IR messages. + * In almost ALL ways it is BETTER, FASTER, and MORE DETAILED. + * + * This code is left only for legacy reasons, and as another simple example of + * how to use the IRremoteESP8266 library. + * + * As of November 2017 it will no longer be updated or supported. + * You have been warned. + ***** DEPRECATED - DO NOT USE ***** + * + * An IR detector/demodulator must be connected to the input RECV_PIN. + * Version 0.2 Oct 2017 + * Based on Ken Shirriff's IrsendDemo Version 0.1 July, 2009, + * JVC and Panasonic protocol added by Kristian Lauszus + * (Thanks to zenwheel and other people at the original blog post) + * LG added by Darryl Smith (based on the JVC protocol) + */ + +#ifndef UNIT_TEST +#include +#endif +#include +#include +#include + +// an IR detector/demodulator is connected to GPIO pin 2 +uint16_t RECV_PIN = 2; + +IRrecv irrecv(RECV_PIN); + +decode_results results; + +void setup() { + Serial.begin(115200); + irrecv.enableIRIn(); // Start the receiver +} + +void dump(decode_results *results) { + // Dumps out the decode_results structure. + // Call this after IRrecv::decode() + uint16_t count = results->rawlen; + if (results->decode_type == UNKNOWN) { + Serial.print("Unknown encoding: "); + } else if (results->decode_type == NEC) { + Serial.print("Decoded NEC: "); + } else if (results->decode_type == SONY) { + Serial.print("Decoded SONY: "); + } else if (results->decode_type == RC5) { + Serial.print("Decoded RC5: "); + } else if (results->decode_type == RC5X) { + Serial.print("Decoded RC5X: "); + } else if (results->decode_type == RC6) { + Serial.print("Decoded RC6: "); + } else if (results->decode_type == RCMM) { + Serial.print("Decoded RCMM: "); + } else if (results->decode_type == PANASONIC) { + Serial.print("Decoded PANASONIC - Address: "); + Serial.print(results->address, HEX); + Serial.print(" Value: "); + } else if (results->decode_type == LG) { + Serial.print("Decoded LG: "); + } else if (results->decode_type == JVC) { + Serial.print("Decoded JVC: "); + } else if (results->decode_type == AIWA_RC_T501) { + Serial.print("Decoded AIWA RC T501: "); + } else if (results->decode_type == WHYNTER) { + Serial.print("Decoded Whynter: "); + } else if (results->decode_type == NIKAI) { + Serial.print("Decoded Nikai: "); + } + serialPrintUint64(results->value, 16); + Serial.print(" ("); + Serial.print(results->bits, DEC); + Serial.println(" bits)"); + Serial.print("Raw ("); + Serial.print(count, DEC); + Serial.print("): {"); + + for (uint16_t i = 1; i < count; i++) { + if (i % 100 == 0) + yield(); // Preemptive yield every 100th entry to feed the WDT. + if (i & 1) { + Serial.print(results->rawbuf[i] * RAWTICK, DEC); + } else { + Serial.print(", "); + Serial.print((uint32_t) results->rawbuf[i] * RAWTICK, DEC); + } + } + Serial.println("};"); +} + +void loop() { + if (irrecv.decode(&results)) { + dump(&results); + Serial.println("DEPRECATED: Please use IRrecvDumpV2.ino instead!"); + irrecv.resume(); // Receive the next value + } +} diff --git a/IRremoteESP8266/examples/IRrecvDump/platformio.ini b/IRremoteESP8266/examples/IRrecvDump/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/IRrecvDump/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/IRrecvDumpV2/IRrecvDumpV2.ino b/IRremoteESP8266/examples/IRrecvDumpV2/IRrecvDumpV2.ino new file mode 100644 index 0000000..105a7d4 --- /dev/null +++ b/IRremoteESP8266/examples/IRrecvDumpV2/IRrecvDumpV2.ino @@ -0,0 +1,212 @@ +/* + * IRremoteESP8266: IRrecvDumpV2 - dump details of IR codes with IRrecv + * An IR detector/demodulator must be connected to the input RECV_PIN. + * + * Copyright 2009 Ken Shirriff, http://arcfn.com + * Copyright 2017 David Conran + * + * Example circuit diagram: + * https://github.com/markszabo/IRremoteESP8266/wiki#ir-receiving + * + * Changes: + * Version 0.3 November, 2017 + * - Support for A/C decoding for some protcols. + * Version 0.2 April, 2017 + * - Decode from a copy of the data so we can start capturing faster thus + * reduce the likelihood of miscaptures. + * Based on Ken Shirriff's IrsendDemo Version 0.1 July, 2009, + */ + +#ifndef UNIT_TEST +#include +#endif +#include +#include +#include +#if DECODE_AC +#include +#include +#include +#include +#include +#include +#include +#endif // DECODE_AC + +// ==================== start of TUNEABLE PARAMETERS ==================== +// An IR detector/demodulator is connected to GPIO pin 14 +// e.g. D5 on a NodeMCU board. +#define RECV_PIN 14 + +// The Serial connection baud rate. +// i.e. Status message will be sent to the PC at this baud rate. +// Try to avoid slow speeds like 9600, as you will miss messages and +// cause other problems. 115200 (or faster) is recommended. +// NOTE: Make sure you set your Serial Monitor to the same speed. +#define BAUD_RATE 115200 + +// As this program is a special purpose capture/decoder, let us use a larger +// than normal buffer so we can handle Air Conditioner remote codes. +#define CAPTURE_BUFFER_SIZE 1024 + +// TIMEOUT is the Nr. of milli-Seconds of no-more-data before we consider a +// message ended. +// This parameter is an interesting trade-off. The longer the timeout, the more +// complex a message it can capture. e.g. Some device protocols will send +// multiple message packets in quick succession, like Air Conditioner remotes. +// Air Coniditioner protocols often have a considerable gap (20-40+ms) between +// packets. +// The downside of a large timeout value is a lot of less complex protocols +// send multiple messages when the remote's button is held down. The gap between +// them is often also around 20+ms. This can result in the raw data be 2-3+ +// times larger than needed as it has captured 2-3+ messages in a single +// capture. Setting a low timeout value can resolve this. +// So, choosing the best TIMEOUT value for your use particular case is +// quite nuanced. Good luck and happy hunting. +// NOTE: Don't exceed MAX_TIMEOUT_MS. Typically 130ms. +#if DECODE_AC +#define TIMEOUT 50U // Some A/C units have gaps in their protocols of ~40ms. + // e.g. Kelvinator + // A value this large may swallow repeats of some protocols +#else // DECODE_AC +#define TIMEOUT 15U // Suits most messages, while not swallowing many repeats. +#endif // DECODE_AC +// Alternatives: +// #define TIMEOUT 90U // Suits messages with big gaps like XMP-1 & some aircon + // units, but can accidentally swallow repeated messages + // in the rawData[] output. +// #define TIMEOUT MAX_TIMEOUT_MS // This will set it to our currently allowed + // maximum. Values this high are problematic + // because it is roughly the typical boundary + // where most messages repeat. + // e.g. It will stop decoding a message and + // start sending it to serial at precisely + // the time when the next message is likely + // to be transmitted, and may miss it. + +// Set the smallest sized "UNKNOWN" message packets we actually care about. +// This value helps reduce the false-positive detection rate of IR background +// noise as real messages. The chances of background IR noise getting detected +// as a message increases with the length of the TIMEOUT value. (See above) +// The downside of setting this message too large is you can miss some valid +// short messages for protocols that this library doesn't yet decode. +// +// Set higher if you get lots of random short UNKNOWN messages when nothing +// should be sending a message. +// Set lower if you are sure your setup is working, but it doesn't see messages +// from your device. (e.g. Other IR remotes work.) +// NOTE: Set this value very high to effectively turn off UNKNOWN detection. +#define MIN_UNKNOWN_SIZE 12 +// ==================== end of TUNEABLE PARAMETERS ==================== + + +// Use turn on the save buffer feature for more complete capture coverage. +IRrecv irrecv(RECV_PIN, CAPTURE_BUFFER_SIZE, TIMEOUT, true); + +decode_results results; // Somewhere to store the results + +// Display the human readable state of an A/C message if we can. +void dumpACInfo(decode_results *results) { + String description = ""; +#if DECODE_DAIKIN + if (results->decode_type == DAIKIN) { + IRDaikinESP ac(0); + ac.setRaw(results->state); + description = ac.toString(); + } +#endif // DECODE_DAIKIN +#if DECODE_FUJITSU_AC + if (results->decode_type == FUJITSU_AC) { + IRFujitsuAC ac(0); + ac.setRaw(results->state, results->bits / 8); + description = ac.toString(); + } +#endif // DECODE_FUJITSU_AC +#if DECODE_KELVINATOR + if (results->decode_type == KELVINATOR) { + IRKelvinatorAC ac(0); + ac.setRaw(results->state); + description = ac.toString(); + } +#endif // DECODE_KELVINATOR +#if DECODE_TOSHIBA_AC + if (results->decode_type == TOSHIBA_AC) { + IRToshibaAC ac(0); + ac.setRaw(results->state); + description = ac.toString(); + } +#endif // DECODE_TOSHIBA_AC +#if DECODE_GREE + if (results->decode_type == GREE) { + IRGreeAC ac(0); + ac.setRaw(results->state); + description = ac.toString(); + } +#endif // DECODE_GREE +#if DECODE_MIDEA + if (results->decode_type == MIDEA) { + IRMideaAC ac(0); + ac.setRaw(results->value); // Midea uses value instead of state. + description = ac.toString(); + } +#endif // DECODE_MIDEA +#if DECODE_HAIER_AC + if (results->decode_type == HAIER_AC) { + IRHaierAC ac(0); + ac.setRaw(results->state); + description = ac.toString(); + } +#endif // DECODE_HAIER_AC + // If we got a human-readable description of the message, display it. + if (description != "") Serial.println("Mesg Desc.: " + description); +} + +// The section of code run only once at start-up. +void setup() { + Serial.begin(BAUD_RATE, SERIAL_8N1, SERIAL_TX_ONLY); + while (!Serial) // Wait for the serial connection to be establised. + delay(50); + Serial.println(); + Serial.print("IRrecvDumpV2 is now running and waiting for IR input on Pin "); + Serial.println(RECV_PIN); + +#if DECODE_HASH + // Ignore messages with less than minimum on or off pulses. + irrecv.setUnknownThreshold(MIN_UNKNOWN_SIZE); +#endif // DECODE_HASH + irrecv.enableIRIn(); // Start the receiver +} + +// The repeating section of the code +// +void loop() { + // Check if the IR code has been received. + if (irrecv.decode(&results)) { + // Display a crude timestamp. + uint32_t now = millis(); + Serial.printf("Timestamp : %06u.%03u\n", now / 1000, now % 1000); + if (results.overflow) + Serial.printf("WARNING: IR code is too big for buffer (>= %d). " + "This result shouldn't be trusted until this is resolved. " + "Edit & increase CAPTURE_BUFFER_SIZE.\n", + CAPTURE_BUFFER_SIZE); + // Display the basic output of what we found. + Serial.print(resultToHumanReadableBasic(&results)); + dumpACInfo(&results); // Display any extra A/C info if we have it. + yield(); // Feed the WDT as the text output can take a while to print. + + // Display the library version the message was captured with. + Serial.print("Library : v"); + Serial.println(_IRREMOTEESP8266_VERSION_); + Serial.println(); + + // Output RAW timing info of the result. + Serial.println(resultToTimingInfo(&results)); + yield(); // Feed the WDT (again) + + // Output the results as source code + Serial.println(resultToSourceCode(&results)); + Serial.println(""); // Blank line between entries + yield(); // Feed the WDT (again) + } +} diff --git a/IRremoteESP8266/examples/IRrecvDumpV2/platformio.ini b/IRremoteESP8266/examples/IRrecvDumpV2/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/IRrecvDumpV2/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/IRsendDemo/IRsendDemo.ino b/IRremoteESP8266/examples/IRsendDemo/IRsendDemo.ino new file mode 100644 index 0000000..c785d26 --- /dev/null +++ b/IRremoteESP8266/examples/IRsendDemo/IRsendDemo.ino @@ -0,0 +1,68 @@ +/* IRremoteESP8266: IRsendDemo - demonstrates sending IR codes with IRsend. + * + * Version 1.0 April, 2017 + * Based on Ken Shirriff's IrsendDemo Version 0.1 July, 2009, + * Copyright 2009 Ken Shirriff, http://arcfn.com + * + * An IR LED circuit *MUST* be connected to ESP8266 pin 4 (D2). + * + * TL;DR: The IR LED needs to be driven by a transistor for a good result. + * + * Suggested circuit: + * https://github.com/markszabo/IRremoteESP8266/wiki#ir-sending + * + * Common mistakes & tips: + * * Don't just connect the IR LED directly to the pin, it won't + * have enough current to drive the IR LED effectively. + * * Make sure you have the IR LED polarity correct. + * See: https://learn.sparkfun.com/tutorials/polarity/diode-and-led-polarity + * * Typical digital camera/phones can be used to see if the IR LED is flashed. + * Replace the IR LED with a normal LED if you don't have a digital camera + * when debugging. + * * Avoid using the following pins unless you really know what you are doing: + * * Pin 0/D3: Can interfere with the boot/program mode & support circuits. + * * Pin 1/TX/TXD0: Any serial transmissions from the ESP8266 will interfere. + * * Pin 3/RX/RXD0: Any serial transmissions to the ESP8266 will interfere. + * * ESP-01 modules are tricky. We suggest you use a module with more GPIOs + * for your first time. e.g. ESP-12 etc. + */ + +#ifndef UNIT_TEST +#include +#endif +#include +#include + +IRsend irsend(4); // An IR LED is controlled by GPIO pin 4 (D2) + +// Example of data captured by IRrecvDumpV2.ino +uint16_t rawData[67] = {9000, 4500, 650, 550, 650, 1650, 600, 550, 650, 550, + 600, 1650, 650, 550, 600, 1650, 650, 1650, 650, 1650, + 600, 550, 650, 1650, 650, 1650, 650, 550, 600, 1650, + 650, 1650, 650, 550, 650, 550, 650, 1650, 650, 550, + 650, 550, 650, 550, 600, 550, 650, 550, 650, 550, + 650, 1650, 600, 550, 650, 1650, 650, 1650, 650, 1650, + 650, 1650, 650, 1650, 650, 1650, 600}; + +void setup() { + irsend.begin(); + Serial.begin(115200, SERIAL_8N1, SERIAL_TX_ONLY); +} + +void loop() { +#if SEND_NEC + Serial.println("NEC"); + irsend.sendNEC(0x00FFE01FUL, 32); +#endif // SEND_NEC + delay(2000); +#if SEND_SONY + Serial.println("Sony"); + irsend.sendSony(0xa90, 12, 2); +#endif // SEND_SONY + delay(2000); +#if SEND_RAW + Serial.println("a rawData capture from IRrecvDumpV2"); + irsend.sendRaw(rawData, 67, 38); // Send a raw data capture at 38kHz. +#endif // SEND_RAW + delay(2000); +} diff --git a/IRremoteESP8266/examples/IRsendDemo/platformio.ini b/IRremoteESP8266/examples/IRsendDemo/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/IRsendDemo/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/IRsendProntoDemo/IRsendProntoDemo.ino b/IRremoteESP8266/examples/IRsendProntoDemo/IRsendProntoDemo.ino new file mode 100644 index 0000000..5d8389d --- /dev/null +++ b/IRremoteESP8266/examples/IRsendProntoDemo/IRsendProntoDemo.ino @@ -0,0 +1,110 @@ +/* IRremoteESP8266: IRsendProntoDemo + * Copyright 2017 David Conran + * + * Demonstrates sending Pronto codes with IRsend. + * + * Version 1.0 June, 2017 + * + * An IR LED circuit *MUST* be connected to ESP8266 pin 4 (D2), unless you + * change the irsend() value below. + * + * TL;DR: The IR LED needs to be driven by a transistor for a good result. + * + * Suggested circuit: + * https://github.com/markszabo/IRremoteESP8266/wiki#ir-sending + * + * Common mistakes & tips: + * * Don't just connect the IR LED directly to the pin, it won't + * have enough current to drive the IR LED effectively. + * * Make sure you have the IR LED polarity correct. + * See: https://learn.sparkfun.com/tutorials/polarity/diode-and-led-polarity + * * Typical digital camera/phones can be used to see if the IR LED is flashed. + * Replace the IR LED with a normal LED if you don't have a digital camera + * when debugging. + * * Avoid using the following pins unless you really know what you are doing: + * * Pin 0/D3: Can interfere with the boot/program mode & support circuits. + * * Pin 1/TX/TXD0: Any serial transmissions from the ESP8266 will interfere. + * * Pin 3/RX/RXD0: Any serial transmissions to the ESP8266 will interfere. + * * ESP-01 modules are tricky. We suggest you use a module with more GPIOs + * for your first time. e.g. ESP-12 etc. + */ + +#ifndef UNIT_TEST +#include +#endif +#include +#include + +IRsend irsend(4); // An IR LED is controlled by GPIO pin 4 (D2) + +// Panasonic Plasma TV Descrete code (Power On). +// Acquired from: +// https://irdb.globalcache.com/ +// e.g. +// 0000 006D 0000 0022 00ac 00ac 0016 0040 0016 0040 0016 0040 0016 0015 0016 +// 0015 0016 0015 0016 0015 0016 0015 0016 0040 0016 0040 0016 0040 0016 0015 +// 0016 0015 0016 0015 0016 0015 0016 0015 0016 0040 0016 0015 0016 0015 0016 +// 0040 0016 0040 0016 0015 0016 0015 0016 0040 0016 0015 0016 0040 0016 0040 +// 0016 0015 0016 0015 0016 0040 0016 0040 0016 0015 0016 071c +// +// Or the equiv. of sendSamsung(0xE0E09966); +uint16_t samsungProntoCode[72] = { + 0x0000, 0x006D, 0x0000, 0x0022, + 0x00ac, 0x00ac, 0x0016, 0x0040, 0x0016, 0x0040, 0x0016, 0x0040, + 0x0016, 0x0015, 0x0016, 0x0015, 0x0016, 0x0015, 0x0016, 0x0015, + 0x0016, 0x0015, 0x0016, 0x0040, 0x0016, 0x0040, 0x0016, 0x0040, + 0x0016, 0x0015, 0x0016, 0x0015, 0x0016, 0x0015, 0x0016, 0x0015, + 0x0016, 0x0015, 0x0016, 0x0040, 0x0016, 0x0015, 0x0016, 0x0015, + 0x0016, 0x0040, 0x0016, 0x0040, 0x0016, 0x0015, 0x0016, 0x0015, + 0x0016, 0x0040, 0x0016, 0x0015, 0x0016, 0x0040, 0x0016, 0x0040, + 0x0016, 0x0015, 0x0016, 0x0015, 0x0016, 0x0040, 0x0016, 0x0040, + 0x0016, 0x0015, 0x0016, 0x071c +}; + +// Panasonic Plasma TV Descrete code (Power On). +// Acquired from: +// ftp://ftp.panasonic.com/pub/panasonic/drivers/monitors/Discrete-remote-control-codesProntoCCFformat.pdf +// e.g. +// 0000 0071 0000 0032 0080 003F 0010 0010 0010 0030 0010 0010 0010 0010 0010 +// 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 +// 0010 0010 0010 0030 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 +// 0010 0010 0010 0010 0010 0010 0010 0010 0030 0010 0010 0010 0010 0010 0010 +// 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 0010 0030 0010 +// 0030 0010 0030 0010 0030 0010 0030 0010 0010 0010 0010 0010 0010 0010 0030 +// 0010 0030 0010 0030 0010 0030 0010 0030 0010 0010 0010 0030 0010 0A98 +// +// Or the equiv. of sendPanasonic64(0x400401007C7D); +uint16_t panasonicProntoCode[104] = { + 0x0000, 0x0071, 0x0000, 0x0032, + 0x0080, 0x003F, 0x0010, 0x0010, 0x0010, 0x0030, 0x0010, 0x0010, + 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, + 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, + 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0030, 0x0010, 0x0010, + 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, + 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, + 0x0010, 0x0030, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, + 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, + 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0030, 0x0010, 0x0030, + 0x0010, 0x0030, 0x0010, 0x0030, 0x0010, 0x0030, 0x0010, 0x0010, + 0x0010, 0x0010, 0x0010, 0x0010, 0x0010, 0x0030, 0x0010, 0x0030, + 0x0010, 0x0030, 0x0010, 0x0030, 0x0010, 0x0030, 0x0010, 0x0010, + 0x0010, 0x0030, 0x0010, 0x0A98}; + +void setup() { + irsend.begin(); + Serial.begin(115200, SERIAL_8N1, SERIAL_TX_ONLY); +} + +void loop() { +#if SEND_PRONTO + Serial.println("Sending a Samsung TV 'on' command."); + irsend.sendPronto(samsungProntoCode, 72); + delay(2000); + Serial.println("Sending a Panasonic Plasma TV 'on' command."); + irsend.sendPronto(panasonicProntoCode, 104); + delay(2000); +#else // SEND_PRONTO + Serial.println("Can't send because SEND_PRONTO has been disabled."); + delay(10000); +#endif // SEND_PRONTO +} diff --git a/IRremoteESP8266/examples/IRsendProntoDemo/platformio.ini b/IRremoteESP8266/examples/IRsendProntoDemo/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/IRsendProntoDemo/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/JVCPanasonicSendDemo/JVCPanasonicSendDemo.ino b/IRremoteESP8266/examples/JVCPanasonicSendDemo/JVCPanasonicSendDemo.ino new file mode 100644 index 0000000..009b25e --- /dev/null +++ b/IRremoteESP8266/examples/JVCPanasonicSendDemo/JVCPanasonicSendDemo.ino @@ -0,0 +1,64 @@ +/* + * IRremoteESP8266: IRsendDemo - demonstrates sending IR codes with IRsend + * Version 0.1 June, 2015 + * Based on Ken Shirriff's IrsendDemo Version 0.1 July, 2009, Copyright 2009 Ken Shirriff, http://arcfn.com + * JVC and Panasonic protocol added by Kristian Lauszus (Thanks to zenwheel and other people at the original blog post) + * + * An IR LED circuit *MUST* be connected to ESP8266 pin 4 (D2). + * + * TL;DR: The IR LED needs to be driven by a transistor for a good result. + * + * Suggested circuit: + * https://github.com/markszabo/IRremoteESP8266/wiki#ir-sending + * + * Common mistakes & tips: + * * Don't just connect the IR LED directly to the pin, it won't + * have enough current to drive the IR LED effectively. + * * Make sure you have the IR LED polarity correct. + * See: https://learn.sparkfun.com/tutorials/polarity/diode-and-led-polarity + * * Typical digital camera/phones can be used to see if the IR LED is flashed. + * Replace the IR LED with a normal LED if you don't have a digital camera + * when debugging. + * * Avoid using the following pins unless you really know what you are doing: + * * Pin 0/D3: Can interfere with the boot/program mode & support circuits. + * * Pin 1/TX/TXD0: Any serial transmissions from the ESP8266 will interfere. + * * Pin 3/RX/RXD0: Any serial transmissions to the ESP8266 will interfere. + * * ESP-01 modules are tricky. We suggest you use a module with more GPIOs + * for your first time. e.g. ESP-12 etc. + */ + +#ifndef UNIT_TEST +#include +#endif +#include +#include + +#define PanasonicAddress 0x4004 // Panasonic address (Pre data) +#define PanasonicPower 0x100BCBD // Panasonic Power button + +#define JVCPower 0xC5E8 + +IRsend irsend(4); // An IR LED is controlled by GPIO pin 4 (D2) + +void setup() { + irsend.begin(); +} + +void loop() { + // This should turn your TV on and off +#if SEND_PANASONIC + irsend.sendPanasonic(PanasonicAddress, PanasonicPower); +#else // SEND_PANASONIC + Serial.println("Can't send because SEND_PANASONIC has been disabled."); +#endif // SEND_PANASONIC + +#if SEND_JVC + irsend.sendJVC(JVCPower, 16, 0); // hex value, 16 bits, no repeat + // see http://www.sbprojects.com/knowledge/ir/jvc.php for information + delayMicroseconds(50); + irsend.sendJVC(JVCPower, 16, 1); // hex value, 16 bits, repeat + delayMicroseconds(50); +#else // SEND_JVC + Serial.println("Can't send because SEND_JVC has been disabled."); +#endif // SEND_JVC +} diff --git a/IRremoteESP8266/examples/JVCPanasonicSendDemo/platformio.ini b/IRremoteESP8266/examples/JVCPanasonicSendDemo/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/JVCPanasonicSendDemo/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/LGACSend/LGACSend.ino b/IRremoteESP8266/examples/LGACSend/LGACSend.ino new file mode 100644 index 0000000..493d2a8 --- /dev/null +++ b/IRremoteESP8266/examples/LGACSend/LGACSend.ino @@ -0,0 +1,263 @@ +// Copyright 2015 chaeplin +// Copyright 2017 xpokor22 +// This is based on: +// https://github.com/z3t0/Arduino-IRremote/blob/master/examples/LGACSendDemo/LGACSendDemo.ino + +#include +#include + + +IRsend irsend(14); // An IR LED is controlled by GPIO pin 14 (D5) + +// 0 : TOWER +// 1 : WALL +const unsigned int kAc_Type = 1; + +// 0 : cooling +// 1 : heating +unsigned int ac_heat = 1; + +// 0 : off +// 1 : on +unsigned int ac_power_on = 0; + +// 0 : off +// 1 : on --> power on +unsigned int ac_air_clean_state = 0; + +// temperature : 18 ~ 30 +unsigned int ac_temperature = 24; + +// 0 : low +// 1 : mid +// 2 : high +// if kAc_Type = 1, 3 : change +unsigned int ac_flow = 0; + +const uint8_t kAc_Flow_Tower[3] = {0, 4, 6}; +const uint8_t kAc_Flow_Wall[4] = {0, 2, 4, 5}; + +uint32_t ac_code_to_sent; + +void Ac_Send_Code(uint32_t code) { + Serial.print("code to send : "); + Serial.print(code, BIN); + Serial.print(" : "); + Serial.println(code, HEX); + +#if SEND_LG + irsend.sendLG(code, 28); +#else // SEND_LG + Serial.println("Can't send because SEND_LG has been disabled."); +#endif // SEND_LG +} + +void Ac_Activate(unsigned int temperature, unsigned int air_flow, + unsigned int heat) { + ac_heat = heat; + unsigned int ac_msbits1 = 8; + unsigned int ac_msbits2 = 8; + unsigned int ac_msbits3 = 0; + unsigned int ac_msbits4; + if (ac_heat == 1) + ac_msbits4 = 4; // heating + else + ac_msbits4 = 0; // cooling + unsigned int ac_msbits5 = (temperature < 15) ? 0 : temperature - 15; + unsigned int ac_msbits6; + + if (0 <= air_flow && air_flow <= 2) { + if (kAc_Type == 0) + ac_msbits6 = kAc_Flow_Tower[air_flow]; + else + ac_msbits6 = kAc_Flow_Wall[air_flow]; + } + + // calculating using other values + unsigned int ac_msbits7 = (ac_msbits3 + ac_msbits4 + ac_msbits5 + + ac_msbits6) & B00001111; + ac_code_to_sent = ac_msbits1 << 4; + ac_code_to_sent = (ac_code_to_sent + ac_msbits2) << 4; + ac_code_to_sent = (ac_code_to_sent + ac_msbits3) << 4; + ac_code_to_sent = (ac_code_to_sent + ac_msbits4) << 4; + ac_code_to_sent = (ac_code_to_sent + ac_msbits5) << 4; + ac_code_to_sent = (ac_code_to_sent + ac_msbits6) << 4; + ac_code_to_sent = (ac_code_to_sent + ac_msbits7); + + Ac_Send_Code(ac_code_to_sent); + + ac_power_on = 1; + ac_temperature = temperature; + ac_flow = air_flow; +} + +void Ac_Change_Air_Swing(int air_swing) { + if (kAc_Type == 0) { + if (air_swing == 1) + ac_code_to_sent = 0x881316B; + else + ac_code_to_sent = 0x881317C; + } else { + if (air_swing == 1) + ac_code_to_sent = 0x8813149; + else + ac_code_to_sent = 0x881315A; + } + Ac_Send_Code(ac_code_to_sent); +} + +void Ac_Power_Down() { + ac_code_to_sent = 0x88C0051; + + Ac_Send_Code(ac_code_to_sent); + + ac_power_on = 0; +} + +void Ac_Air_Clean(int air_clean) { + if (air_clean == '1') + ac_code_to_sent = 0x88C000C; + else + ac_code_to_sent = 0x88C0084; + + Ac_Send_Code(ac_code_to_sent); + + ac_air_clean_state = air_clean; +} + +void setup() { + Serial.begin(115200); + delay(1000); + irsend.begin(); +} + +void loop() { + char b; + Serial.println("# a : mode or temp b : air_flow, temp, swing, clean," + " cooling/heating"); + Serial.println("# 0 : off 0"); + Serial.println("# 1 : on 0"); + Serial.println("# 2 : air_swing 0 or 1"); + Serial.println("# 3 : air_clean 0 or 1"); + Serial.println("# 4 : air_flow 0 ~ 2 : flow"); + Serial.println("# + : temp + 1"); + Serial.println("# - : temp - 1"); + Serial.println("# c : cooling"); + Serial.println("# h : heating"); + Serial.println("# m : change cooling to air clean, air clean to cooling"); + + Serial.println("a="); // Prompt User for input + while (Serial.available() == 0) { // Wait for user input + } + char a = Serial.read(); // Read user input into a + switch (a) { + case '0': + case '1': + case '+': + case '-': + case 'c': + case 'h': + case 'm': + break; + default: + Serial.println("b="); // Prompt User for input + while (Serial.available() == 0) {} + char b = Serial.read(); + } + + /* + # a : mode or temp b : air_flow, temp, swing, clean, cooling/heating + # 18 ~ 30 : temp 0 ~ 2 : flow // on + # 0 : off 0 + # 1 : on 0 + # 2 : air_swing 0 or 1 + # 3 : air_clean 0 or 1 + # 4 : air_flow 0 ~ 3 : flow + # + : temp + 1 + # - : temp - 1 + # c : cooling + # h : heating + # m : change cooling to air clean, air clean to cooling + */ + Serial.print("a : "); + Serial.print(a); + Serial.print(" b : "); + Serial.println(b); + + switch (a) { + case '0': // off + Ac_Power_Down(); + break; + case '1': // on + Ac_Activate(ac_temperature, ac_flow, ac_heat); + break; + case '2': + if (b == '0') + Ac_Change_Air_Swing(0); + else + Ac_Change_Air_Swing(1); + break; + case '3': // 1 : clean on, power on + if (b == '0' | b == '1') + Ac_Air_Clean(b); + break; + case '4': + switch (b) { + case '1': + Ac_Activate(ac_temperature, 1, ac_heat); + break; + case '2': + Ac_Activate(ac_temperature, 2, ac_heat); + break; + case '3': + Ac_Activate(ac_temperature, 3, ac_heat); + break; + default: + Ac_Activate(ac_temperature, 0, ac_heat); + } + break; + case '+': + if (18 <= ac_temperature && ac_temperature <= 29) + Ac_Activate((ac_temperature + 1), ac_flow, ac_heat); + break; + case '-': + if (19 <= ac_temperature && ac_temperature <= 30) + Ac_Activate((ac_temperature - 1), ac_flow, ac_heat); + break; + case 'c': + ac_heat = 0; + Ac_Activate(ac_temperature, ac_flow, ac_heat); + break; + case 'h': + ac_heat = 1; + Ac_Activate(ac_temperature, ac_flow, ac_heat); + break; + case 'm': + /* + if ac is on, 1) turn off, 2) turn on Ac_Air_Clean(1) + if ac is off, 1) turn on, 2) turn off Ac_Air_Clean(0) + */ + if (ac_power_on == 1) { + Ac_Power_Down(); + delay(100); + Ac_Air_Clean(1); + } else { + if (ac_air_clean_state == 1) { + Ac_Air_Clean(0); + delay(100); + } + Ac_Activate(ac_temperature, ac_flow, ac_heat); + } + break; + } + + delay(100); + Serial.println("ac_temperature"); + Serial.println(ac_temperature); + Serial.println("ac_flow"); + Serial.println(ac_flow); + Serial.println("ac_heat"); + Serial.println(ac_heat); + Serial.println("ac_power_on"); + Serial.println(ac_power_on); +} diff --git a/IRremoteESP8266/examples/TurnOnArgoAC/TurnOnArgoAC.ino b/IRremoteESP8266/examples/TurnOnArgoAC/TurnOnArgoAC.ino new file mode 100644 index 0000000..9e73c59 --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnArgoAC/TurnOnArgoAC.ino @@ -0,0 +1,56 @@ +/* Copyright 2017 crankyoldgit +* An IR LED circuit *MUST* be connected to ESP8266 GPIO4. +* +* TL;DR: The IR LED needs to be driven by a transistor for a good result. +* +* Suggested circuit: +* https://github.com/markszabo/IRremoteESP8266/wiki#ir-sending +* +* Common mistakes & tips: +* * Don't just connect the IR LED directly to the pin, it won't +* have enough current to drive the IR LED effectively. +* * Make sure you have the IR LED polarity correct. +* See: https://learn.sparkfun.com/tutorials/polarity/diode-and-led-polarity +* * Typical digital camera/phones can be used to see if the IR LED is flashed. +* Replace the IR LED with a normal LED if you don't have a digital camera +* when debugging. +* * Avoid using the following pins unless you really know what you are doing: +* * Pin 0/D3: Can interfere with the boot/program mode & support circuits. +* * Pin 1/TX/TXD0: Any serial transmissions from the ESP8266 will interfere. +* * Pin 3/RX/RXD0: Any serial transmissions to the ESP8266 will interfere. +* * ESP-01 modules are tricky. We suggest you use a module with more GPIOs +* for your first time. e.g. ESP-12 etc. +*/ + +#ifndef UNIT_TEST +#include +#endif +#include +#include +#include + +IRArgoAC argoir(4); // An IR LED is controlled by GPIO4, NodeMCU D2 + +void setup() { + argoir.begin(); + Serial.begin(115200); +} + +void loop() { + Serial.println("Sending..."); + + // Set up what we want to send. See ir_Argo.cpp for all the options. + argoir.setPower(true); + argoir.setFan(ARGO_FAN_1); + argoir.setCoolMode(ARGO_COOL_AUTO); + argoir.setTemp(25); + +#if SEND_ARGO + // Now send the IR signal. + argoir.send(); +#else // SEND_ARGO + Serial.println("Can't send because SEND_ARGO has been disabled."); +#endif // SEND_ARGO + + delay(5000); +} diff --git a/IRremoteESP8266/examples/TurnOnArgoAC/platformio.ini b/IRremoteESP8266/examples/TurnOnArgoAC/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnArgoAC/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/TurnOnDaikinAC/TurnOnDaikinAC.ino b/IRremoteESP8266/examples/TurnOnDaikinAC/TurnOnDaikinAC.ino new file mode 100644 index 0000000..abee409 --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnDaikinAC/TurnOnDaikinAC.ino @@ -0,0 +1,67 @@ +/* Copyright 2017 sillyfrog +* +* An IR LED circuit *MUST* be connected to ESP8266 GPIO4. +* +* TL;DR: The IR LED needs to be driven by a transistor for a good result. +* +* Suggested circuit: +* https://github.com/markszabo/IRremoteESP8266/wiki#ir-sending +* +* Common mistakes & tips: +* * Don't just connect the IR LED directly to the pin, it won't +* have enough current to drive the IR LED effectively. +* * Make sure you have the IR LED polarity correct. +* See: https://learn.sparkfun.com/tutorials/polarity/diode-and-led-polarity +* * Typical digital camera/phones can be used to see if the IR LED is flashed. +* Replace the IR LED with a normal LED if you don't have a digital camera +* when debugging. +* * Avoid using the following pins unless you really know what you are doing: +* * Pin 0/D3: Can interfere with the boot/program mode & support circuits. +* * Pin 1/TX/TXD0: Any serial transmissions from the ESP8266 will interfere. +* * Pin 3/RX/RXD0: Any serial transmissions to the ESP8266 will interfere. +* * ESP-01 modules are tricky. We suggest you use a module with more GPIOs +* for your first time. e.g. ESP-12 etc. +*/ + +#ifndef UNIT_TEST +#include +#endif +#include +#include +#include + +IRDaikinESP daikinir(4); // An IR LED is controlled by GPIO4, NodeMCU D2 + +void setup() { + daikinir.begin(); + Serial.begin(115200); +} + + +void loop() { + Serial.println("Sending..."); + + // Set up what we want to send. See ir_Daikin.cpp for all the options. + daikinir.on(); + daikinir.setFan(1); + daikinir.setMode(DAIKIN_COOL); + daikinir.setTemp(25); + daikinir.setSwingVertical(false); + daikinir.setSwingHorizontal(false); + + // Set the current time to 1:33PM (13:33) + // Time works in minutes past midnight + daikinir.setCurrentTime((13*60) + 33); + // Turn off about 1 hour later at 2:30PM (15:30) + daikinir.enableOffTimer((14*60) + 30); + + // Display what we are going to send. + Serial.println(daikinir.toString()); + + // Now send the IR signal. +#if SEND_DAIKIN + daikinir.send(); +#endif // SEND_DAIKIN + + delay(15000); +} diff --git a/IRremoteESP8266/examples/TurnOnDaikinAC/platformio.ini b/IRremoteESP8266/examples/TurnOnDaikinAC/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnDaikinAC/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/TurnOnFujitsuAC/TurnOnFujitsuAC.ino b/IRremoteESP8266/examples/TurnOnFujitsuAC/TurnOnFujitsuAC.ino new file mode 100644 index 0000000..86c6ab9 --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnFujitsuAC/TurnOnFujitsuAC.ino @@ -0,0 +1,48 @@ +// Copyright 2017 Jonny Graham +#include +#include + +IRFujitsuAC fujitsu(5); // IR led controlled by Pin D1. + +void printState() { + // Display the settings. + Serial.println("Fujitsu A/C remote is in the following state:"); + Serial.printf(" Command:%d, Mode: %d, Temp: %dC, Fan Speed: %d," \ + " Swing Mode: %d\n", + fujitsu.getCmd(), fujitsu.getMode(), fujitsu.getTemp(), + fujitsu.getFanSpeed(), fujitsu.getSwing()); + // Display the encoded IR sequence. + unsigned char* ir_code = fujitsu.getRaw(); + Serial.print("IR Code: 0x"); + for (uint8_t i = 0; i < fujitsu.getStateLength(); i++) + Serial.printf("%02X", ir_code[i]); + Serial.println(); +} + +void setup() { + fujitsu.begin(); + Serial.begin(115200); + delay(200); + + // Set up what we want to send. See ir_Fujitsu.cpp for all the options. + Serial.println("Default state of the remote."); + printState(); + Serial.println("Setting desired state for A/C."); + fujitsu.setCmd(FUJITSU_AC_CMD_TURN_ON); + fujitsu.setSwing(FUJITSU_AC_SWING_BOTH); + fujitsu.setMode(FUJITSU_AC_MODE_COOL); + fujitsu.setFanSpeed(FUJITSU_AC_FAN_HIGH); + fujitsu.setTemp(24); +} + +void loop() { + // Now send the IR signal. + Serial.println("Sending IR command to A/C ..."); +#if SEND_FUJITSU_AC + fujitsu.send(); +#else // SEND_FUJITSU_AC + Serial.println("Can't send because SEND_FUJITSU_AC has been disabled."); +#endif // SEND_FUJITSU_AC + printState(); + delay(5000); +} diff --git a/IRremoteESP8266/examples/TurnOnFujitsuAC/platformio.ini b/IRremoteESP8266/examples/TurnOnFujitsuAC/platformio.ini new file mode 100644 index 0000000..129404e --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnFujitsuAC/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/TurnOnKelvinatorAC/TurnOnKelvinatorAC.ino b/IRremoteESP8266/examples/TurnOnKelvinatorAC/TurnOnKelvinatorAC.ino new file mode 100644 index 0000000..6c669f3 --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnKelvinatorAC/TurnOnKelvinatorAC.ino @@ -0,0 +1,82 @@ +/* Copyright 2016 David Conran +* +* An IR LED circuit *MUST* be connected to ESP8266 GPIO4. +* +* TL;DR: The IR LED needs to be driven by a transistor for a good result. +* +* Suggested circuit: +* https://github.com/markszabo/IRremoteESP8266/wiki#ir-sending +* +* Common mistakes & tips: +* * Don't just connect the IR LED directly to the pin, it won't +* have enough current to drive the IR LED effectively. +* * Make sure you have the IR LED polarity correct. +* See: https://learn.sparkfun.com/tutorials/polarity/diode-and-led-polarity +* * Typical digital camera/phones can be used to see if the IR LED is flashed. +* Replace the IR LED with a normal LED if you don't have a digital camera +* when debugging. +* * Avoid using the following pins unless you really know what you are doing: +* * Pin 0/D3: Can interfere with the boot/program mode & support circuits. +* * Pin 1/TX/TXD0: Any serial transmissions from the ESP8266 will interfere. +* * Pin 3/RX/RXD0: Any serial transmissions to the ESP8266 will interfere. +* * ESP-01 modules are tricky. We suggest you use a module with more GPIOs +* for your first time. e.g. ESP-12 etc. +*/ +#ifndef UNIT_TEST +#include +#endif +#include +#include +#include + +IRKelvinatorAC kelvir(4); // An IR LED is controlled by GPIO4, NodeMCU D2 + +void printState() { + // Display the settings. + Serial.println("Kelvinator A/C remote is in the following state:"); + Serial.printf(" Basic\n Power: %d, Mode: %d, Temp: %dC, Fan Speed: %d\n", + kelvir.getPower(), kelvir.getMode(), kelvir.getTemp(), + kelvir.getFan()); + Serial.printf(" Options\n X-Fan: %d, Light: %d, Ion Filter: %d\n", + kelvir.getXFan(), kelvir.getLight(), kelvir.getIonFilter()); + Serial.printf(" Swing (V): %d, Swing (H): %d, Turbo: %d, Quiet: %d\n", + kelvir.getSwingVertical(), kelvir.getSwingHorizontal(), + kelvir.getTurbo(), kelvir.getQuiet()); + // Display the encoded IR sequence. + unsigned char* ir_code = kelvir.getRaw(); + Serial.print("IR Code: 0x"); + for (uint8_t i = 0; i < KELVINATOR_STATE_LENGTH; i++) + Serial.printf("%02X", ir_code[i]); + Serial.println(); +} + +void setup() { + kelvir.begin(); + Serial.begin(115200); + delay(200); + + // Set up what we want to send. See ir_Kelvinator.cpp for all the options. + // Most things default to off. + Serial.println("Default state of the remote."); + printState(); + Serial.println("Setting desired state for A/C."); + kelvir.on(); + kelvir.setFan(1); + kelvir.setMode(KELVINATOR_COOL); + kelvir.setTemp(26); + kelvir.setSwingVertical(false); + kelvir.setSwingHorizontal(true); + kelvir.setXFan(true); + kelvir.setIonFilter(false); + kelvir.setLight(true); +} + +void loop() { + // Now send the IR signal. +#if SEND_KELVINATOR + Serial.println("Sending IR command to A/C ..."); + kelvir.send(); +#endif // SEND_KELVINATOR + printState(); + delay(5000); +} diff --git a/IRremoteESP8266/examples/TurnOnKelvinatorAC/platformio.ini b/IRremoteESP8266/examples/TurnOnKelvinatorAC/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnKelvinatorAC/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/TurnOnMitsubishiAC/TurnOnMitsubishiAC.ino b/IRremoteESP8266/examples/TurnOnMitsubishiAC/TurnOnMitsubishiAC.ino new file mode 100644 index 0000000..cf7d175 --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnMitsubishiAC/TurnOnMitsubishiAC.ino @@ -0,0 +1,73 @@ +/* Copyright 2017 David Conran +* +* An IR LED circuit *MUST* be connected to ESP8266 GPIO4. +* +* TL;DR: The IR LED needs to be driven by a transistor for a good result. +* +* Suggested circuit: +* https://github.com/markszabo/IRremoteESP8266/wiki#ir-sending +* +* Common mistakes & tips: +* * Don't just connect the IR LED directly to the pin, it won't +* have enough current to drive the IR LED effectively. +* * Make sure you have the IR LED polarity correct. +* See: https://learn.sparkfun.com/tutorials/polarity/diode-and-led-polarity +* * Typical digital camera/phones can be used to see if the IR LED is flashed. +* Replace the IR LED with a normal LED if you don't have a digital camera +* when debugging. +* * Avoid using the following pins unless you really know what you are doing: +* * Pin 0/D3: Can interfere with the boot/program mode & support circuits. +* * Pin 1/TX/TXD0: Any serial transmissions from the ESP8266 will interfere. +* * Pin 3/RX/RXD0: Any serial transmissions to the ESP8266 will interfere. +* * ESP-01 modules are tricky. We suggest you use a module with more GPIOs +* for your first time. e.g. ESP-12 etc. +*/ +#ifndef UNIT_TEST +#include +#endif +#include +#include +#include + +IRMitsubishiAC mitsubir(4); // An IR LED is controlled by GPIO4, NodeMCU D2 + +void printState() { + // Display the settings. + Serial.println("Mitsubishi A/C remote is in the following state:"); + Serial.printf(" Power: %d, Mode: %d, Temp: %dC, Fan Speed: %d," \ + " Vane Mode: %d\n", + mitsubir.getPower(), mitsubir.getMode(), mitsubir.getTemp(), + mitsubir.getFan(), mitsubir.getVane()); + // Display the encoded IR sequence. + unsigned char* ir_code = mitsubir.getRaw(); + Serial.print("IR Code: 0x"); + for (uint8_t i = 0; i < MITSUBISHI_AC_STATE_LENGTH; i++) + Serial.printf("%02X", ir_code[i]); + Serial.println(); +} + +void setup() { + mitsubir.begin(); + Serial.begin(115200); + delay(200); + + // Set up what we want to send. See ir_Mitsubishi.cpp for all the options. + Serial.println("Default state of the remote."); + printState(); + Serial.println("Setting desired state for A/C."); + mitsubir.on(); + mitsubir.setFan(1); + mitsubir.setMode(MITSUBISHI_AC_COOL); + mitsubir.setTemp(26); + mitsubir.setVane(MITSUBISHI_AC_VANE_AUTO); +} + +void loop() { + // Now send the IR signal. +#if SEND_MITSUBISHI_AC + Serial.println("Sending IR command to A/C ..."); + mitsubir.send(); +#endif // SEND_MITSUBISHI_AC + printState(); + delay(5000); +} diff --git a/IRremoteESP8266/examples/TurnOnMitsubishiAC/platformio.ini b/IRremoteESP8266/examples/TurnOnMitsubishiAC/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnMitsubishiAC/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/TurnOnToshibaAC/TurnOnToshibaAC.ino b/IRremoteESP8266/examples/TurnOnToshibaAC/TurnOnToshibaAC.ino new file mode 100644 index 0000000..9e2bed5 --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnToshibaAC/TurnOnToshibaAC.ino @@ -0,0 +1,71 @@ +/* Copyright 2017 David Conran +* +* An IR LED circuit *MUST* be connected to ESP8266 GPIO4. +* +* TL;DR: The IR LED needs to be driven by a transistor for a good result. +* +* Suggested circuit: +* https://github.com/markszabo/IRremoteESP8266/wiki#ir-sending +* +* Common mistakes & tips: +* * Don't just connect the IR LED directly to the pin, it won't +* have enough current to drive the IR LED effectively. +* * Make sure you have the IR LED polarity correct. +* See: https://learn.sparkfun.com/tutorials/polarity/diode-and-led-polarity +* * Typical digital camera/phones can be used to see if the IR LED is flashed. +* Replace the IR LED with a normal LED if you don't have a digital camera +* when debugging. +* * Avoid using the following pins unless you really know what you are doing: +* * Pin 0/D3: Can interfere with the boot/program mode & support circuits. +* * Pin 1/TX/TXD0: Any serial transmissions from the ESP8266 will interfere. +* * Pin 3/RX/RXD0: Any serial transmissions to the ESP8266 will interfere. +* * ESP-01 modules are tricky. We suggest you use a module with more GPIOs +* for your first time. e.g. ESP-12 etc. +*/ +#ifndef UNIT_TEST +#include +#endif +#include +#include +#include + +IRToshibaAC toshibair(4); // An IR LED is controlled by GPIO4, NodeMCU D2 + +void printState() { + // Display the settings. + Serial.println("Toshiba A/C remote is in the following state:"); + Serial.printf(" Power: %d, Mode: %d, Temp: %dC, Fan Speed: %d\n", + toshibair.getPower(), toshibair.getMode(), toshibair.getTemp(), + toshibair.getFan()); + // Display the encoded IR sequence. + unsigned char* ir_code = toshibair.getRaw(); + Serial.print("IR Code: 0x"); + for (uint8_t i = 0; i < TOSHIBA_AC_STATE_LENGTH; i++) + Serial.printf("%02X", ir_code[i]); + Serial.println(); +} + +void setup() { + toshibair.begin(); + Serial.begin(115200); + delay(200); + + // Set up what we want to send. See ir_Toshiba.cpp for all the options. + Serial.println("Default state of the remote."); + printState(); + Serial.println("Setting desired state for A/C."); + toshibair.on(); + toshibair.setFan(1); + toshibair.setMode(TOSHIBA_AC_COOL); + toshibair.setTemp(26); +} + +void loop() { + // Now send the IR signal. +#if SEND_TOSHIBA_AC + Serial.println("Sending IR command to A/C ..."); + toshibair.send(); +#endif // SEND_TOSHIBA_AC + printState(); + delay(5000); +} diff --git a/IRremoteESP8266/examples/TurnOnToshibaAC/platformio.ini b/IRremoteESP8266/examples/TurnOnToshibaAC/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnToshibaAC/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/examples/TurnOnTrotecAC/TurnOnTrotecAC.ino b/IRremoteESP8266/examples/TurnOnTrotecAC/TurnOnTrotecAC.ino new file mode 100644 index 0000000..b78957f --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnTrotecAC/TurnOnTrotecAC.ino @@ -0,0 +1,56 @@ +/* Copyright 2017 stufisher +* An IR LED circuit *MUST* be connected to ESP8266 GPIO4. +* +* TL;DR: The IR LED needs to be driven by a transistor for a good result. +* +* Suggested circuit: +* https://github.com/markszabo/IRremoteESP8266/wiki#ir-sending +* +* Common mistakes & tips: +* * Don't just connect the IR LED directly to the pin, it won't +* have enough current to drive the IR LED effectively. +* * Make sure you have the IR LED polarity correct. +* See: https://learn.sparkfun.com/tutorials/polarity/diode-and-led-polarity +* * Typical digital camera/phones can be used to see if the IR LED is flashed. +* Replace the IR LED with a normal LED if you don't have a digital camera +* when debugging. +* * Avoid using the following pins unless you really know what you are doing: +* * Pin 0/D3: Can interfere with the boot/program mode & support circuits. +* * Pin 1/TX/TXD0: Any serial transmissions from the ESP8266 will interfere. +* * Pin 3/RX/RXD0: Any serial transmissions to the ESP8266 will interfere. +* * ESP-01 modules are tricky. We suggest you use a module with more GPIOs +* for your first time. e.g. ESP-12 etc. +*/ + +#ifndef UNIT_TEST +#include +#endif +#include +#include +#include + +IRTrotecESP trotecir(4); // An IR LED is controlled by GPIO4, NodeMCU D2 + +void setup() { + trotecir.begin(); + Serial.begin(115200); +} + +void loop() { + Serial.println("Sending..."); + + // Set up what we want to send. See ir_Trotec.cpp for all the options. + trotecir.setPower(true); + trotecir.setSpeed(TROTEC_FAN_LOW); + trotecir.setMode(TROTEC_COOL); + trotecir.setTemp(25); + + // Now send the IR signal. +#if SEND_TROTEC + trotecir.send(); +#else // SEND_TROTEC + Serial.println("Can't send because SEND_TROTEC has been disabled."); +#endif // SEND_TROTEC + + delay(5000); +} diff --git a/IRremoteESP8266/examples/TurnOnTrotecAC/platformio.ini b/IRremoteESP8266/examples/TurnOnTrotecAC/platformio.ini new file mode 100644 index 0000000..eeb8d1f --- /dev/null +++ b/IRremoteESP8266/examples/TurnOnTrotecAC/platformio.ini @@ -0,0 +1,17 @@ +[platformio] +lib_extra_dirs = ../../ +src_dir=. + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/keywords.txt b/IRremoteESP8266/keywords.txt new file mode 100644 index 0000000..f5cea44 --- /dev/null +++ b/IRremoteESP8266/keywords.txt @@ -0,0 +1,962 @@ +######################################### +# Syntax Coloring Map For IRremoteESP8266 +######################################### + +################################################ +# WARNING: Do NOT edit this file directly. +# It is generated by 'tools/mkkeywords' +# e.g. tools/mkkeywords > keywords.txt +################################################ + +####################################################### +# The Arduino IDE requires the use of a tab separator +# between the name and identifier. Without this tab the +# keyword is not highlighted. +# +# Reference: https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification#keywords +####################################################### + +####################################### +# Datatypes & Classes (KEYWORD1) +####################################### + +IRArgoAC KEYWORD1 +IRDaikinESP KEYWORD1 +IRFujitsuAC KEYWORD1 +IRKelvinatorAC KEYWORD1 +IRMideaAC KEYWORD1 +IRMitsubishiAC KEYWORD1 +IRToshibaAC KEYWORD1 +IRTrotecESP KEYWORD1 +IRrecv KEYWORD1 +IRsend KEYWORD1 +IRtimer KEYWORD1 +decode_results KEYWORD1 +ir_params_t KEYWORD1 +match_result_t KEYWORD1 + +####################################### +# Methods and Functions (KEYWORD2) +####################################### + +addbit KEYWORD2 +begin KEYWORD2 +buildFromState KEYWORD2 +buildState KEYWORD2 +calcBlockChecksum KEYWORD2 +calcChecksum KEYWORD2 +calcLGChecksum KEYWORD2 +calcUSecPeriod KEYWORD2 +calibrate KEYWORD2 +checkheader KEYWORD2 +checksum KEYWORD2 +clearBit KEYWORD2 +copyIrParams KEYWORD2 +decode KEYWORD2 +decodeAiwaRCT501 KEYWORD2 +decodeCOOLIX KEYWORD2 +decodeCarrierAC KEYWORD2 +decodeDISH KEYWORD2 +decodeDaikin KEYWORD2 +decodeDenon KEYWORD2 +decodeFujitsuAC KEYWORD2 +decodeHash KEYWORD2 +decodeJVC KEYWORD2 +decodeKelvinator KEYWORD2 +decodeLG KEYWORD2 +decodeLasertag KEYWORD2 +decodeMagiQuest KEYWORD2 +decodeMidea KEYWORD2 +decodeMitsubishi KEYWORD2 +decodeNEC KEYWORD2 +decodeNikai KEYWORD2 +decodePanasonic KEYWORD2 +decodeRC5 KEYWORD2 +decodeRC6 KEYWORD2 +decodeRCMM KEYWORD2 +decodeSAMSUNG KEYWORD2 +decodeSanyo KEYWORD2 +decodeSanyoLC7461 KEYWORD2 +decodeSharp KEYWORD2 +decodeSony KEYWORD2 +decodeToshibaAC KEYWORD2 +decodeWhynter KEYWORD2 +disableIRIn KEYWORD2 +disableOffTimer KEYWORD2 +disableOnTimer KEYWORD2 +elapsed KEYWORD2 +enableIRIn KEYWORD2 +enableIROut KEYWORD2 +enableOffTimer KEYWORD2 +enableOnTimer KEYWORD2 +encodeJVC KEYWORD2 +encodeLG KEYWORD2 +encodeMagiQuest KEYWORD2 +encodeNEC KEYWORD2 +encodePanasonic KEYWORD2 +encodeRC5 KEYWORD2 +encodeRC5X KEYWORD2 +encodeRC6 KEYWORD2 +encodeSAMSUNG KEYWORD2 +encodeSanyoLC7461 KEYWORD2 +encodeSharp KEYWORD2 +encodeSony KEYWORD2 +fixup KEYWORD2 +getBit KEYWORD2 +getBufSize KEYWORD2 +getCmd KEYWORD2 +getCommand KEYWORD2 +getCoolMode KEYWORD2 +getCorrectedRawLength KEYWORD2 +getCurrentTime KEYWORD2 +getEcono KEYWORD2 +getEye KEYWORD2 +getFan KEYWORD2 +getFanSpeed KEYWORD2 +getFlap KEYWORD2 +getHeatMode KEYWORD2 +getIonFilter KEYWORD2 +getLight KEYWORD2 +getMax KEYWORD2 +getMode KEYWORD2 +getMold KEYWORD2 +getNight KEYWORD2 +getOffTime KEYWORD2 +getOffTimerEnabled KEYWORD2 +getOnTime KEYWORD2 +getOnTimerEnabled KEYWORD2 +getPower KEYWORD2 +getPowerful KEYWORD2 +getQuiet KEYWORD2 +getRaw KEYWORD2 +getSensor KEYWORD2 +getSleep KEYWORD2 +getSpeed KEYWORD2 +getStateLength KEYWORD2 +getSwing KEYWORD2 +getSwingHorizontal KEYWORD2 +getSwingVertical KEYWORD2 +getTemp KEYWORD2 +getTimer KEYWORD2 +getTurbo KEYWORD2 +getVane KEYWORD2 +getXFan KEYWORD2 +getiFeel KEYWORD2 +hasACState KEYWORD2 +invertBits KEYWORD2 +ledOff KEYWORD2 +mark KEYWORD2 +match KEYWORD2 +matchAtLeast KEYWORD2 +matchData KEYWORD2 +matchMark KEYWORD2 +matchSpace KEYWORD2 +off KEYWORD2 +on KEYWORD2 +printState KEYWORD2 +readbits KEYWORD2 +renderTime KEYWORD2 +reset KEYWORD2 +resultToHumanReadableBasic KEYWORD2 +resultToSourceCode KEYWORD2 +resultToTimingInfo KEYWORD2 +resume KEYWORD2 +reverseBits KEYWORD2 +send KEYWORD2 +sendAiwaRCT501 KEYWORD2 +sendArgo KEYWORD2 +sendCOOLIX KEYWORD2 +sendCarrierAC KEYWORD2 +sendDISH KEYWORD2 +sendDaikin KEYWORD2 +sendData KEYWORD2 +sendDenon KEYWORD2 +sendFujitsuAC KEYWORD2 +sendGC KEYWORD2 +sendGeneric KEYWORD2 +sendGree KEYWORD2 +sendJVC KEYWORD2 +sendKelvinator KEYWORD2 +sendLG KEYWORD2 +sendLasertag KEYWORD2 +sendMagiQuest KEYWORD2 +sendMidea KEYWORD2 +sendMitsubishi KEYWORD2 +sendMitsubishiAC KEYWORD2 +sendNEC KEYWORD2 +sendNikai KEYWORD2 +sendPanasonic KEYWORD2 +sendPanasonic64 KEYWORD2 +sendPronto KEYWORD2 +sendRC5 KEYWORD2 +sendRC6 KEYWORD2 +sendRCMM KEYWORD2 +sendRaw KEYWORD2 +sendSAMSUNG KEYWORD2 +sendSanyoLC7461 KEYWORD2 +sendSharp KEYWORD2 +sendSharpRaw KEYWORD2 +sendSherwood KEYWORD2 +sendSony KEYWORD2 +sendToshibaAC KEYWORD2 +sendTrotec KEYWORD2 +sendWhynter KEYWORD2 +serialPrintUint64 KEYWORD2 +setBit KEYWORD2 +setCmd KEYWORD2 +setCommand KEYWORD2 +setCoolMode KEYWORD2 +setCurrentTime KEYWORD2 +setEcono KEYWORD2 +setEye KEYWORD2 +setFan KEYWORD2 +setFanSpeed KEYWORD2 +setFlap KEYWORD2 +setHeatMode KEYWORD2 +setIonFilter KEYWORD2 +setLight KEYWORD2 +setMax KEYWORD2 +setMode KEYWORD2 +setModel KEYWORD2 +setMold KEYWORD2 +setNight KEYWORD2 +setPower KEYWORD2 +setPowerful KEYWORD2 +setQuiet KEYWORD2 +setRaw KEYWORD2 +setRoomTemp KEYWORD2 +setSensor KEYWORD2 +setSleep KEYWORD2 +setSpeed KEYWORD2 +setSwing KEYWORD2 +setSwingHorizontal KEYWORD2 +setSwingVertical KEYWORD2 +setTemp KEYWORD2 +setTime KEYWORD2 +setTimer KEYWORD2 +setTurbo KEYWORD2 +setUnknownThreshold KEYWORD2 +setVane KEYWORD2 +setXFan KEYWORD2 +setiFeel KEYWORD2 +space KEYWORD2 +stateReset KEYWORD2 +stepHoriz KEYWORD2 +stepVert KEYWORD2 +sumBytes KEYWORD2 +ticksHigh KEYWORD2 +ticksLow KEYWORD2 +toString KEYWORD2 +toggleRC5 KEYWORD2 +toggleRC6 KEYWORD2 +typeToString KEYWORD2 +uint64ToString KEYWORD2 +validChecksum KEYWORD2 + +####################################### +# Constants (LITERAL1) +####################################### + +AIWA_RC_T501 LITERAL1 +AIWA_RC_T501_BITS LITERAL1 +AIWA_RC_T501_MIN_REPEAT LITERAL1 +AIWA_RC_T501_POST_BITS LITERAL1 +AIWA_RC_T501_POST_DATA LITERAL1 +AIWA_RC_T501_PRE_BITS LITERAL1 +AIWA_RC_T501_PRE_DATA LITERAL1 +ARDB1 LITERAL1 +ARGO LITERAL1 +ARGO_BIT_MARK LITERAL1 +ARGO_COMMAND_LENGTH LITERAL1 +ARGO_COOL_AUTO LITERAL1 +ARGO_COOL_OFF LITERAL1 +ARGO_COOL_ON LITERAL1 +ARGO_COOl_HUM LITERAL1 +ARGO_FAN_1 LITERAL1 +ARGO_FAN_2 LITERAL1 +ARGO_FAN_3 LITERAL1 +ARGO_FAN_AUTO LITERAL1 +ARGO_FLAP_1 LITERAL1 +ARGO_FLAP_2 LITERAL1 +ARGO_FLAP_3 LITERAL1 +ARGO_FLAP_4 LITERAL1 +ARGO_FLAP_5 LITERAL1 +ARGO_FLAP_6 LITERAL1 +ARGO_FLAP_AUTO LITERAL1 +ARGO_FLAP_FULL LITERAL1 +ARGO_HDR_MARK LITERAL1 +ARGO_HDR_SPACE LITERAL1 +ARGO_HEAT_AUTO LITERAL1 +ARGO_HEAT_BLINK LITERAL1 +ARGO_HEAT_ON LITERAL1 +ARGO_MAX_TEMP LITERAL1 +ARGO_MIN_TEMP LITERAL1 +ARGO_ONE_SPACE LITERAL1 +ARGO_ZERO_SPACE LITERAL1 +ARRAH2E LITERAL1 +CARRIER_AC LITERAL1 +CARRIER_AC_BITS LITERAL1 +CARRIER_AC_BIT_MARK LITERAL1 +CARRIER_AC_GAP LITERAL1 +CARRIER_AC_HDR_MARK LITERAL1 +CARRIER_AC_HDR_SPACE LITERAL1 +CARRIER_AC_MIN_REPEAT LITERAL1 +CARRIER_AC_ONE_SPACE LITERAL1 +CARRIER_AC_ZERO_SPACE LITERAL1 +COOLIX LITERAL1 +COOLIX_BITS LITERAL1 +COOLIX_BIT_MARK LITERAL1 +COOLIX_BIT_MARK_TICKS LITERAL1 +COOLIX_HDR_MARK LITERAL1 +COOLIX_HDR_MARK_TICKS LITERAL1 +COOLIX_HDR_SPACE LITERAL1 +COOLIX_HDR_SPACE_TICKS LITERAL1 +COOLIX_MIN_GAP_TICKS LITERAL1 +COOLIX_ONE_SPACE LITERAL1 +COOLIX_ONE_SPACE_TICKS LITERAL1 +COOLIX_TICK LITERAL1 +COOLIX_ZERO_SPACE LITERAL1 +COOLIX_ZERO_SPACE_TICKS LITERAL1 +DAIKIN LITERAL1 +DAIKIN_AUTO LITERAL1 +DAIKIN_BITS LITERAL1 +DAIKIN_BIT_ECONO LITERAL1 +DAIKIN_BIT_EYE LITERAL1 +DAIKIN_BIT_MARK LITERAL1 +DAIKIN_BIT_MOLD LITERAL1 +DAIKIN_BIT_OFF_TIMER LITERAL1 +DAIKIN_BIT_ON_TIMER LITERAL1 +DAIKIN_BIT_POWER LITERAL1 +DAIKIN_BIT_POWERFUL LITERAL1 +DAIKIN_BIT_SENSOR LITERAL1 +DAIKIN_BIT_SILENT LITERAL1 +DAIKIN_BYTE_ECONO LITERAL1 +DAIKIN_BYTE_EYE LITERAL1 +DAIKIN_BYTE_MOLD LITERAL1 +DAIKIN_BYTE_OFF_TIMER LITERAL1 +DAIKIN_BYTE_ON_TIMER LITERAL1 +DAIKIN_BYTE_POWER LITERAL1 +DAIKIN_BYTE_POWERFUL LITERAL1 +DAIKIN_BYTE_SENSOR LITERAL1 +DAIKIN_BYTE_SILENT LITERAL1 +DAIKIN_COMMAND_LENGTH LITERAL1 +DAIKIN_COOL LITERAL1 +DAIKIN_CURBIT LITERAL1 +DAIKIN_CURINDEX LITERAL1 +DAIKIN_DEBUG LITERAL1 +DAIKIN_DRY LITERAL1 +DAIKIN_FAN LITERAL1 +DAIKIN_FAN_AUTO LITERAL1 +DAIKIN_FAN_MAX LITERAL1 +DAIKIN_FAN_MIN LITERAL1 +DAIKIN_FAN_QUIET LITERAL1 +DAIKIN_FIRST_HEADER64 LITERAL1 +DAIKIN_GAP LITERAL1 +DAIKIN_HDR_MARK LITERAL1 +DAIKIN_HDR_SPACE LITERAL1 +DAIKIN_HEAT LITERAL1 +DAIKIN_MARK_EXCESS LITERAL1 +DAIKIN_MAX_TEMP LITERAL1 +DAIKIN_MIN_TEMP LITERAL1 +DAIKIN_ONE_SPACE LITERAL1 +DAIKIN_RAW_BITS LITERAL1 +DAIKIN_TOLERANCE LITERAL1 +DAIKIN_ZERO_SPACE LITERAL1 +DECODE_AC LITERAL1 +DECODE_AIWA_RC_T501 LITERAL1 +DECODE_ARGO LITERAL1 +DECODE_CARRIER_AC LITERAL1 +DECODE_COOLIX LITERAL1 +DECODE_DAIKIN LITERAL1 +DECODE_DENON LITERAL1 +DECODE_DISH LITERAL1 +DECODE_FUJITSU_AC LITERAL1 +DECODE_GLOBALCACHE LITERAL1 +DECODE_GREE LITERAL1 +DECODE_HASH LITERAL1 +DECODE_JVC LITERAL1 +DECODE_KELVINATOR LITERAL1 +DECODE_LASERTAG LITERAL1 +DECODE_LG LITERAL1 +DECODE_MAGIQUEST LITERAL1 +DECODE_MIDEA LITERAL1 +DECODE_MITSUBISHI LITERAL1 +DECODE_MITSUBISHI_AC LITERAL1 +DECODE_NEC LITERAL1 +DECODE_NIKAI LITERAL1 +DECODE_PANASONIC LITERAL1 +DECODE_PRONTO LITERAL1 +DECODE_RC5 LITERAL1 +DECODE_RC6 LITERAL1 +DECODE_RCMM LITERAL1 +DECODE_SAMSUNG LITERAL1 +DECODE_SANYO LITERAL1 +DECODE_SHARP LITERAL1 +DECODE_SHERWOOD LITERAL1 +DECODE_SONY LITERAL1 +DECODE_TOSHIBA_AC LITERAL1 +DECODE_TROTEC LITERAL1 +DECODE_WHYNTER LITERAL1 +DENON LITERAL1 +DENON_48_BITS LITERAL1 +DENON_BITS LITERAL1 +DENON_BIT_MARK LITERAL1 +DENON_BIT_MARK_TICKS LITERAL1 +DENON_HDR_MARK LITERAL1 +DENON_HDR_MARK_TICKS LITERAL1 +DENON_HDR_SPACE LITERAL1 +DENON_HDR_SPACE_TICKS LITERAL1 +DENON_LEGACY_BITS LITERAL1 +DENON_MANUFACTURER LITERAL1 +DENON_MIN_COMMAND_LENGTH LITERAL1 +DENON_MIN_COMMAND_LENGTH_TICKS LITERAL1 +DENON_MIN_GAP_TICKS LITERAL1 +DENON_ONE_SPACE LITERAL1 +DENON_ONE_SPACE_TICKS LITERAL1 +DENON_TICK LITERAL1 +DENON_ZERO_SPACE LITERAL1 +DENON_ZERO_SPACE_TICKS LITERAL1 +DISH LITERAL1 +DISH_BITS LITERAL1 +DISH_BIT_MARK LITERAL1 +DISH_BIT_MARK_TICKS LITERAL1 +DISH_HDR_MARK LITERAL1 +DISH_HDR_MARK_TICKS LITERAL1 +DISH_HDR_SPACE LITERAL1 +DISH_HDR_SPACE_TICKS LITERAL1 +DISH_MIN_REPEAT LITERAL1 +DISH_ONE_SPACE LITERAL1 +DISH_ONE_SPACE_TICKS LITERAL1 +DISH_RPT_SPACE LITERAL1 +DISH_RPT_SPACE_TICKS LITERAL1 +DISH_TICK LITERAL1 +DISH_ZERO_SPACE LITERAL1 +DISH_ZERO_SPACE_TICKS LITERAL1 +DUTY_DEFAULT LITERAL1 +FNV_BASIS_32 LITERAL1 +FNV_PRIME_32 LITERAL1 +FOOTER LITERAL1 +FUJITSU_AC LITERAL1 +FUJITSU_AC_BITS LITERAL1 +FUJITSU_AC_BIT_MARK LITERAL1 +FUJITSU_AC_CMD_STAY_ON LITERAL1 +FUJITSU_AC_CMD_STEP_HORIZ LITERAL1 +FUJITSU_AC_CMD_STEP_VERT LITERAL1 +FUJITSU_AC_CMD_TURN_OFF LITERAL1 +FUJITSU_AC_CMD_TURN_ON LITERAL1 +FUJITSU_AC_FAN_AUTO LITERAL1 +FUJITSU_AC_FAN_HIGH LITERAL1 +FUJITSU_AC_FAN_LOW LITERAL1 +FUJITSU_AC_FAN_MED LITERAL1 +FUJITSU_AC_FAN_QUIET LITERAL1 +FUJITSU_AC_HDR_MARK LITERAL1 +FUJITSU_AC_HDR_SPACE LITERAL1 +FUJITSU_AC_MAX_TEMP LITERAL1 +FUJITSU_AC_MIN_BITS LITERAL1 +FUJITSU_AC_MIN_GAP LITERAL1 +FUJITSU_AC_MIN_REPEAT LITERAL1 +FUJITSU_AC_MIN_TEMP LITERAL1 +FUJITSU_AC_MODE_AUTO LITERAL1 +FUJITSU_AC_MODE_COOL LITERAL1 +FUJITSU_AC_MODE_DRY LITERAL1 +FUJITSU_AC_MODE_FAN LITERAL1 +FUJITSU_AC_MODE_HEAT LITERAL1 +FUJITSU_AC_ONE_SPACE LITERAL1 +FUJITSU_AC_STATE_LENGTH LITERAL1 +FUJITSU_AC_STATE_LENGTH_SHORT LITERAL1 +FUJITSU_AC_SWING_BOTH LITERAL1 +FUJITSU_AC_SWING_HORIZ LITERAL1 +FUJITSU_AC_SWING_OFF LITERAL1 +FUJITSU_AC_SWING_VERT LITERAL1 +FUJITSU_AC_ZERO_SPACE LITERAL1 +GLOBALCACHE LITERAL1 +GLOBALCACHE_FREQ_INDEX LITERAL1 +GLOBALCACHE_MAX_REPEAT LITERAL1 +GLOBALCACHE_MIN_USEC LITERAL1 +GLOBALCACHE_RPT_INDEX LITERAL1 +GLOBALCACHE_RPT_START_INDEX LITERAL1 +GLOBALCACHE_START_INDEX LITERAL1 +GREE LITERAL1 +GREE_BITS LITERAL1 +GREE_BIT_MARK LITERAL1 +GREE_HDR_MARK LITERAL1 +GREE_HDR_SPACE LITERAL1 +GREE_MSG_SPACE LITERAL1 +GREE_ONE_SPACE LITERAL1 +GREE_STATE_LENGTH LITERAL1 +GREE_ZERO_SPACE LITERAL1 +HEADER LITERAL1 +HIGH LITERAL1 +ICACHE_RAM_ATTR LITERAL1 +JVC LITERAL1 +JVC_BITS LITERAL1 +JVC_BIT_MARK LITERAL1 +JVC_BIT_MARK_TICKS LITERAL1 +JVC_HDR_MARK LITERAL1 +JVC_HDR_MARK_TICKS LITERAL1 +JVC_HDR_SPACE LITERAL1 +JVC_HDR_SPACE_TICKS LITERAL1 +JVC_MIN_GAP_TICKS LITERAL1 +JVC_ONE_SPACE LITERAL1 +JVC_ONE_SPACE_TICKS LITERAL1 +JVC_RPT_LENGTH LITERAL1 +JVC_RPT_LENGTH_TICKS LITERAL1 +JVC_TICK LITERAL1 +JVC_ZERO_SPACE LITERAL1 +JVC_ZERO_SPACE_TICKS LITERAL1 +KELVINATOR LITERAL1 +KELVINATOR_AUTO LITERAL1 +KELVINATOR_AUTO_TEMP LITERAL1 +KELVINATOR_BASIC_FAN_MASK LITERAL1 +KELVINATOR_BASIC_FAN_MAX LITERAL1 +KELVINATOR_BITS LITERAL1 +KELVINATOR_BIT_MARK LITERAL1 +KELVINATOR_BIT_MARK_TICKS LITERAL1 +KELVINATOR_CHECKSUM_START LITERAL1 +KELVINATOR_CMD_FOOTER LITERAL1 +KELVINATOR_CMD_FOOTER_BITS LITERAL1 +KELVINATOR_COOL LITERAL1 +KELVINATOR_DRY LITERAL1 +KELVINATOR_FAN LITERAL1 +KELVINATOR_FAN_AUTO LITERAL1 +KELVINATOR_FAN_MASK LITERAL1 +KELVINATOR_FAN_MAX LITERAL1 +KELVINATOR_FAN_OFFSET LITERAL1 +KELVINATOR_GAP_SPACE LITERAL1 +KELVINATOR_GAP_SPACE_TICKS LITERAL1 +KELVINATOR_HDR_MARK LITERAL1 +KELVINATOR_HDR_MARK_TICKS LITERAL1 +KELVINATOR_HDR_SPACE LITERAL1 +KELVINATOR_HDR_SPACE_TICKS LITERAL1 +KELVINATOR_HEAT LITERAL1 +KELVINATOR_ION_FILTER LITERAL1 +KELVINATOR_ION_FILTER_OFFSET LITERAL1 +KELVINATOR_LIGHT LITERAL1 +KELVINATOR_LIGHT_OFFSET LITERAL1 +KELVINATOR_MAX_TEMP LITERAL1 +KELVINATOR_MIN_TEMP LITERAL1 +KELVINATOR_MODE_MASK LITERAL1 +KELVINATOR_ONE_SPACE LITERAL1 +KELVINATOR_ONE_SPACE_TICKS LITERAL1 +KELVINATOR_POWER LITERAL1 +KELVINATOR_QUIET LITERAL1 +KELVINATOR_QUIET_OFFSET LITERAL1 +KELVINATOR_SLEEP_1_AND_3 LITERAL1 +KELVINATOR_STATE_LENGTH LITERAL1 +KELVINATOR_TICK LITERAL1 +KELVINATOR_TURBO LITERAL1 +KELVINATOR_TURBO_OFFSET LITERAL1 +KELVINATOR_VENT_SWING LITERAL1 +KELVINATOR_VENT_SWING_H LITERAL1 +KELVINATOR_VENT_SWING_OFFSET LITERAL1 +KELVINATOR_VENT_SWING_V LITERAL1 +KELVINATOR_XFAN LITERAL1 +KELVINATOR_XFAN_OFFSET LITERAL1 +KELVINATOR_ZERO_SPACE LITERAL1 +KELVINATOR_ZERO_SPACE_TICKS LITERAL1 +LASERTAG LITERAL1 +LASERTAG_BITS LITERAL1 +LASERTAG_DELTA LITERAL1 +LASERTAG_EXCESS LITERAL1 +LASERTAG_MIN_GAP LITERAL1 +LASERTAG_MIN_REPEAT LITERAL1 +LASERTAG_TICK LITERAL1 +LASERTAG_TOLERANCE LITERAL1 +LG LITERAL1 +LG32_BITS LITERAL1 +LG32_HDR_MARK LITERAL1 +LG32_HDR_MARK_TICKS LITERAL1 +LG32_HDR_SPACE LITERAL1 +LG32_HDR_SPACE_TICKS LITERAL1 +LG32_RPT_HDR_MARK LITERAL1 +LG32_RPT_HDR_MARK_TICKS LITERAL1 +LG_BITS LITERAL1 +LG_BIT_MARK LITERAL1 +LG_BIT_MARK_TICKS LITERAL1 +LG_HDR_MARK LITERAL1 +LG_HDR_MARK_TICKS LITERAL1 +LG_HDR_SPACE LITERAL1 +LG_HDR_SPACE_TICKS LITERAL1 +LG_MIN_GAP LITERAL1 +LG_MIN_GAP_TICKS LITERAL1 +LG_MIN_MESSAGE_LENGTH LITERAL1 +LG_MIN_MESSAGE_LENGTH_TICKS LITERAL1 +LG_ONE_SPACE LITERAL1 +LG_ONE_SPACE_TICKS LITERAL1 +LG_RPT_SPACE LITERAL1 +LG_RPT_SPACE_TICKS LITERAL1 +LG_TICK LITERAL1 +LG_ZERO_SPACE LITERAL1 +LG_ZERO_SPACE_TICKS LITERAL1 +LOW LITERAL1 +MAGIQUEST LITERAL1 +MAGIQUEST_BITS LITERAL1 +MAGIQUEST_GAP LITERAL1 +MAGIQUEST_MARK_ONE LITERAL1 +MAGIQUEST_MARK_ZERO LITERAL1 +MAGIQUEST_ONE_RATIO LITERAL1 +MAGIQUEST_PERIOD LITERAL1 +MAGIQUEST_SPACE_ONE LITERAL1 +MAGIQUEST_SPACE_ZERO LITERAL1 +MAGIQUEST_TOTAL_USEC LITERAL1 +MAGIQUEST_ZERO_RATIO LITERAL1 +MARK_EXCESS LITERAL1 +MAX_TIMEOUT_MS LITERAL1 +MIDEA LITERAL1 +MIDEA_AC_AUTO LITERAL1 +MIDEA_AC_CHECKSUM_MASK LITERAL1 +MIDEA_AC_COOL LITERAL1 +MIDEA_AC_DRY LITERAL1 +MIDEA_AC_FAN LITERAL1 +MIDEA_AC_FAN_AUTO LITERAL1 +MIDEA_AC_FAN_HI LITERAL1 +MIDEA_AC_FAN_LOW LITERAL1 +MIDEA_AC_FAN_MASK LITERAL1 +MIDEA_AC_FAN_MED LITERAL1 +MIDEA_AC_HEAT LITERAL1 +MIDEA_AC_MAX_TEMP_C LITERAL1 +MIDEA_AC_MAX_TEMP_F LITERAL1 +MIDEA_AC_MIN_TEMP_C LITERAL1 +MIDEA_AC_MIN_TEMP_F LITERAL1 +MIDEA_AC_MODE_MASK LITERAL1 +MIDEA_AC_POWER LITERAL1 +MIDEA_AC_SLEEP LITERAL1 +MIDEA_AC_STATE_MASK LITERAL1 +MIDEA_AC_TEMP_MASK LITERAL1 +MIDEA_BITS LITERAL1 +MIDEA_BIT_MARK LITERAL1 +MIDEA_BIT_MARK_TICKS LITERAL1 +MIDEA_HDR_MARK LITERAL1 +MIDEA_HDR_MARK_TICKS LITERAL1 +MIDEA_HDR_SPACE LITERAL1 +MIDEA_HDR_SPACE_TICKS LITERAL1 +MIDEA_MIN_GAP_TICKS LITERAL1 +MIDEA_MIN_REPEAT LITERAL1 +MIDEA_ONE_SPACE LITERAL1 +MIDEA_ONE_SPACE_TICKS LITERAL1 +MIDEA_TICK LITERAL1 +MIDEA_TOLERANCE LITERAL1 +MIDEA_ZERO_SPACE LITERAL1 +MIDEA_ZERO_SPACE_TICKS LITERAL1 +MIN_LASERTAG_SAMPLES LITERAL1 +MIN_RC5_SAMPLES LITERAL1 +MIN_RC6_SAMPLES LITERAL1 +MITSUBISHI LITERAL1 +MITSUBISHI_AC LITERAL1 +MITSUBISHI_AC_AUTO LITERAL1 +MITSUBISHI_AC_BIT_MARK LITERAL1 +MITSUBISHI_AC_COOL LITERAL1 +MITSUBISHI_AC_DRY LITERAL1 +MITSUBISHI_AC_FAN_AUTO LITERAL1 +MITSUBISHI_AC_FAN_MAX LITERAL1 +MITSUBISHI_AC_FAN_REAL_MAX LITERAL1 +MITSUBISHI_AC_FAN_SILENT LITERAL1 +MITSUBISHI_AC_HDR_SPACE LITERAL1 +MITSUBISHI_AC_HEAT LITERAL1 +MITSUBISHI_AC_MAX_TEMP LITERAL1 +MITSUBISHI_AC_MIN_REPEAT LITERAL1 +MITSUBISHI_AC_MIN_TEMP LITERAL1 +MITSUBISHI_AC_ONE_SPACE LITERAL1 +MITSUBISHI_AC_POWER LITERAL1 +MITSUBISHI_AC_RPT_MARK LITERAL1 +MITSUBISHI_AC_RPT_SPACE LITERAL1 +MITSUBISHI_AC_STATE_LENGTH LITERAL1 +MITSUBISHI_AC_VANE_AUTO LITERAL1 +MITSUBISHI_AC_VANE_AUTO_MOVE LITERAL1 +MITSUBISHI_AC_ZERO_SPACE LITERAL1 +MITSUBISHI_BITS LITERAL1 +MITSUBISHI_BIT_MARK LITERAL1 +MITSUBISHI_BIT_MARK_TICKS LITERAL1 +MITSUBISHI_MIN_COMMAND_LENGTH LITERAL1 +MITSUBISHI_MIN_GAP LITERAL1 +MITSUBISHI_MIN_REPEAT LITERAL1 +MITSUBISHI_ONE_SPACE LITERAL1 +MITSUBISHI_TICK LITERAL1 +MITSUBISHI_ZERO_SPACE LITERAL1 +NEC LITERAL1 +NEC_BITS LITERAL1 +NEC_BIT_MARK LITERAL1 +NEC_BIT_MARK_TICKS LITERAL1 +NEC_HDR_MARK LITERAL1 +NEC_HDR_MARK_TICKS LITERAL1 +NEC_HDR_SPACE LITERAL1 +NEC_HDR_SPACE_TICKS LITERAL1 +NEC_LIKE LITERAL1 +NEC_MIN_COMMAND_LENGTH LITERAL1 +NEC_MIN_COMMAND_LENGTH_TICKS LITERAL1 +NEC_MIN_GAP LITERAL1 +NEC_ONE_SPACE LITERAL1 +NEC_ONE_SPACE_TICKS LITERAL1 +NEC_RPT_LENGTH LITERAL1 +NEC_RPT_SPACE LITERAL1 +NEC_RPT_SPACE_TICKS LITERAL1 +NEC_TICK LITERAL1 +NEC_ZERO_SPACE LITERAL1 +NEC_ZERO_SPACE_TICKS LITERAL1 +NIKAI LITERAL1 +NIKAI_BITS LITERAL1 +NIKAI_BIT_MARK LITERAL1 +NIKAI_BIT_MARK_TICKS LITERAL1 +NIKAI_HDR_MARK LITERAL1 +NIKAI_HDR_MARK_TICKS LITERAL1 +NIKAI_HDR_SPACE LITERAL1 +NIKAI_HDR_SPACE_TICKS LITERAL1 +NIKAI_MIN_GAP LITERAL1 +NIKAI_MIN_GAP_TICKS LITERAL1 +NIKAI_ONE_SPACE LITERAL1 +NIKAI_ONE_SPACE_TICKS LITERAL1 +NIKAI_ZERO_SPACE LITERAL1 +NIKAI_ZERO_SPACE_TICKS LITERAL1 +OFFSET_ERR LITERAL1 +OFFSET_START LITERAL1 +PANASONIC LITERAL1 +PANASONIC_BITS LITERAL1 +PANASONIC_BIT_MARK LITERAL1 +PANASONIC_BIT_MARK_TICKS LITERAL1 +PANASONIC_HDR_MARK LITERAL1 +PANASONIC_HDR_MARK_TICKS LITERAL1 +PANASONIC_HDR_SPACE LITERAL1 +PANASONIC_HDR_SPACE_TICKS LITERAL1 +PANASONIC_MANUFACTURER LITERAL1 +PANASONIC_MIN_COMMAND_LENGTH LITERAL1 +PANASONIC_MIN_COMMAND_LENGTH_TICKS LITERAL1 +PANASONIC_MIN_GAP_TICKS LITERAL1 +PANASONIC_ONE_SPACE LITERAL1 +PANASONIC_ONE_SPACE_TICKS LITERAL1 +PANASONIC_TICK LITERAL1 +PANASONIC_ZERO_SPACE LITERAL1 +PANASONIC_ZERO_SPACE_TICKS LITERAL1 +PERIOD_OFFSET LITERAL1 +PRONTO LITERAL1 +PRONTO_DATA_OFFSET LITERAL1 +PRONTO_FREQ_FACTOR LITERAL1 +PRONTO_FREQ_OFFSET LITERAL1 +PRONTO_MIN_LENGTH LITERAL1 +PRONTO_SEQ_1_LEN_OFFSET LITERAL1 +PRONTO_SEQ_2_LEN_OFFSET LITERAL1 +PRONTO_TYPE_OFFSET LITERAL1 +RAW LITERAL1 +RAWBUF LITERAL1 +RAWTICK LITERAL1 +RC5 LITERAL1 +RC5X LITERAL1 +RC5X_BITS LITERAL1 +RC5_BITS LITERAL1 +RC5_MIN_COMMAND_LENGTH LITERAL1 +RC5_MIN_GAP LITERAL1 +RC5_RAW_BITS LITERAL1 +RC5_T1 LITERAL1 +RC5_TOGGLE_MASK LITERAL1 +RC6 LITERAL1 +RC6_36_BITS LITERAL1 +RC6_36_TOGGLE_MASK LITERAL1 +RC6_HDR_MARK LITERAL1 +RC6_HDR_MARK_TICKS LITERAL1 +RC6_HDR_SPACE LITERAL1 +RC6_HDR_SPACE_TICKS LITERAL1 +RC6_MODE0_BITS LITERAL1 +RC6_RPT_LENGTH LITERAL1 +RC6_RPT_LENGTH_TICKS LITERAL1 +RC6_TICK LITERAL1 +RC6_TOGGLE_MASK LITERAL1 +RCMM LITERAL1 +RCMM_BITS LITERAL1 +RCMM_BIT_MARK LITERAL1 +RCMM_BIT_MARK_TICKS LITERAL1 +RCMM_BIT_SPACE_0 LITERAL1 +RCMM_BIT_SPACE_0_TICKS LITERAL1 +RCMM_BIT_SPACE_1 LITERAL1 +RCMM_BIT_SPACE_1_TICKS LITERAL1 +RCMM_BIT_SPACE_2 LITERAL1 +RCMM_BIT_SPACE_2_TICKS LITERAL1 +RCMM_BIT_SPACE_3 LITERAL1 +RCMM_BIT_SPACE_3_TICKS LITERAL1 +RCMM_EXCESS LITERAL1 +RCMM_HDR_MARK LITERAL1 +RCMM_HDR_MARK_TICKS LITERAL1 +RCMM_HDR_SPACE LITERAL1 +RCMM_HDR_SPACE_TICKS LITERAL1 +RCMM_MIN_GAP LITERAL1 +RCMM_MIN_GAP_TICKS LITERAL1 +RCMM_RPT_LENGTH LITERAL1 +RCMM_RPT_LENGTH_TICKS LITERAL1 +RCMM_TICK LITERAL1 +RCMM_TOLERANCE LITERAL1 +REPEAT LITERAL1 +SAMSUNG LITERAL1 +SAMSUNG_BITS LITERAL1 +SAMSUNG_BIT_MARK LITERAL1 +SAMSUNG_BIT_MARK_TICKS LITERAL1 +SAMSUNG_HDR_MARK LITERAL1 +SAMSUNG_HDR_MARK_TICKS LITERAL1 +SAMSUNG_HDR_SPACE LITERAL1 +SAMSUNG_HDR_SPACE_TICKS LITERAL1 +SAMSUNG_MIN_MESSAGE_LENGTH LITERAL1 +SAMSUNG_MIN_MESSAGE_LENGTH_TICKS LITERAL1 +SAMSUNG_ONE_SPACE LITERAL1 +SAMSUNG_ONE_SPACE_TICKS LITERAL1 +SAMSUNG_RPT_SPACE LITERAL1 +SAMSUNG_RPT_SPACE_TICKS LITERAL1 +SAMSUNG_TICK LITERAL1 +SAMSUNG_ZERO_SPACE LITERAL1 +SAMSUNG_ZERO_SPACE_TICKS LITERAL1 +SANYO LITERAL1 +SANYO_LC7461 LITERAL1 +SANYO_LC7461_ADDRESS_BITS LITERAL1 +SANYO_LC7461_ADDRESS_MASK LITERAL1 +SANYO_LC7461_BITS LITERAL1 +SANYO_LC7461_BIT_MARK LITERAL1 +SANYO_LC7461_COMMAND_BITS LITERAL1 +SANYO_LC7461_COMMAND_MASK LITERAL1 +SANYO_LC7461_HDR_MARK LITERAL1 +SANYO_LC7461_HDR_SPACE LITERAL1 +SANYO_LC7461_MIN_COMMAND_LENGTH LITERAL1 +SANYO_LC7461_MIN_GAP LITERAL1 +SANYO_LC7461_ONE_SPACE LITERAL1 +SANYO_LC7461_ZERO_SPACE LITERAL1 +SANYO_SA8650B_BITS LITERAL1 +SANYO_SA8650B_DOUBLE_SPACE_USECS LITERAL1 +SANYO_SA8650B_HDR_MARK LITERAL1 +SANYO_SA8650B_HDR_SPACE LITERAL1 +SANYO_SA8650B_ONE_MARK LITERAL1 +SANYO_SA8650B_RPT_LENGTH LITERAL1 +SANYO_SA8650B_ZERO_MARK LITERAL1 +SEND_AIWA_RC_T501 LITERAL1 +SEND_ARGO LITERAL1 +SEND_CARRIER_AC LITERAL1 +SEND_COOLIX LITERAL1 +SEND_DAIKIN LITERAL1 +SEND_DENON LITERAL1 +SEND_DISH LITERAL1 +SEND_FUJITSU_AC LITERAL1 +SEND_GLOBALCACHE LITERAL1 +SEND_GREE LITERAL1 +SEND_JVC LITERAL1 +SEND_KELVINATOR LITERAL1 +SEND_LASERTAG LITERAL1 +SEND_LG LITERAL1 +SEND_MAGIQUEST LITERAL1 +SEND_MIDEA LITERAL1 +SEND_MITSUBISHI LITERAL1 +SEND_MITSUBISHI_AC LITERAL1 +SEND_NEC LITERAL1 +SEND_NIKAI LITERAL1 +SEND_PANASONIC LITERAL1 +SEND_PRONTO LITERAL1 +SEND_RAW LITERAL1 +SEND_RC5 LITERAL1 +SEND_RC6 LITERAL1 +SEND_RCMM LITERAL1 +SEND_SAMSUNG LITERAL1 +SEND_SANYO LITERAL1 +SEND_SHARP LITERAL1 +SEND_SHERWOOD LITERAL1 +SEND_SONY LITERAL1 +SEND_TOSHIBA_AC LITERAL1 +SEND_TROTEC LITERAL1 +SEND_WHYNTER LITERAL1 +SHARP LITERAL1 +SHARP_ADDRESS_MASK LITERAL1 +SHARP_BITS LITERAL1 +SHARP_BIT_MARK LITERAL1 +SHARP_BIT_MARK_TICKS LITERAL1 +SHARP_COMMAND_BITS LITERAL1 +SHARP_COMMAND_MASK LITERAL1 +SHARP_GAP LITERAL1 +SHARP_GAP_TICKS LITERAL1 +SHARP_ONE_SPACE LITERAL1 +SHARP_ONE_SPACE_TICKS LITERAL1 +SHARP_TOGGLE_MASK LITERAL1 +SHARP_ZERO_SPACE LITERAL1 +SHARP_ZERO_SPACE_TICKS LITERAL1 +SHERWOOD LITERAL1 +SHERWOOD_BITS LITERAL1 +SHERWOOD_MIN_REPEAT LITERAL1 +SONY LITERAL1 +SONY_12_BITS LITERAL1 +SONY_15_BITS LITERAL1 +SONY_20_BITS LITERAL1 +SONY_HDR_MARK LITERAL1 +SONY_HDR_MARK_TICKS LITERAL1 +SONY_MIN_BITS LITERAL1 +SONY_MIN_GAP LITERAL1 +SONY_MIN_GAP_TICKS LITERAL1 +SONY_MIN_REPEAT LITERAL1 +SONY_ONE_MARK LITERAL1 +SONY_ONE_MARK_TICKS LITERAL1 +SONY_RPT_LENGTH LITERAL1 +SONY_RPT_LENGTH_TICKS LITERAL1 +SONY_SPACE LITERAL1 +SONY_SPACE_TICKS LITERAL1 +SONY_TICK LITERAL1 +SONY_ZERO_MARK LITERAL1 +SONY_ZERO_MARK_TICKS LITERAL1 +STATE_IDLE LITERAL1 +STATE_MARK LITERAL1 +STATE_SIZE_MAX LITERAL1 +STATE_SPACE LITERAL1 +STATE_STOP LITERAL1 +TIMEOUT_MS LITERAL1 +TOLERANCE LITERAL1 +TOSHIBA_AC LITERAL1 +TOSHIBA_AC_AUTO LITERAL1 +TOSHIBA_AC_BITS LITERAL1 +TOSHIBA_AC_BIT_MARK LITERAL1 +TOSHIBA_AC_COOL LITERAL1 +TOSHIBA_AC_DRY LITERAL1 +TOSHIBA_AC_FAN_AUTO LITERAL1 +TOSHIBA_AC_FAN_MAX LITERAL1 +TOSHIBA_AC_HDR_MARK LITERAL1 +TOSHIBA_AC_HDR_SPACE LITERAL1 +TOSHIBA_AC_HEAT LITERAL1 +TOSHIBA_AC_MAX_TEMP LITERAL1 +TOSHIBA_AC_MIN_GAP LITERAL1 +TOSHIBA_AC_MIN_REPEAT LITERAL1 +TOSHIBA_AC_MIN_TEMP LITERAL1 +TOSHIBA_AC_ONE_SPACE LITERAL1 +TOSHIBA_AC_POWER LITERAL1 +TOSHIBA_AC_STATE_LENGTH LITERAL1 +TOSHIBA_AC_ZERO_SPACE LITERAL1 +TROTEC LITERAL1 +TROTEC_AUTO LITERAL1 +TROTEC_COMMAND_LENGTH LITERAL1 +TROTEC_COOL LITERAL1 +TROTEC_DEF_TEMP LITERAL1 +TROTEC_DRY LITERAL1 +TROTEC_FAN LITERAL1 +TROTEC_FAN_HIGH LITERAL1 +TROTEC_FAN_LOW LITERAL1 +TROTEC_FAN_MED LITERAL1 +TROTEC_GAP LITERAL1 +TROTEC_GAP_END LITERAL1 +TROTEC_HDR_MARK LITERAL1 +TROTEC_HDR_SPACE LITERAL1 +TROTEC_INTRO1 LITERAL1 +TROTEC_INTRO2 LITERAL1 +TROTEC_MAX_TEMP LITERAL1 +TROTEC_MAX_TIMER LITERAL1 +TROTEC_MIN_TEMP LITERAL1 +TROTEC_MIN_TIMER LITERAL1 +TROTEC_OFF LITERAL1 +TROTEC_ON LITERAL1 +TROTEC_ONE_MARK LITERAL1 +TROTEC_ONE_SPACE LITERAL1 +TROTEC_SLEEP_ON LITERAL1 +TROTEC_TIMER_ON LITERAL1 +TROTEC_ZERO_MARK LITERAL1 +TROTEC_ZERO_SPACE LITERAL1 +UNKNOWN LITERAL1 +UNKNOWN_THRESHOLD LITERAL1 +UNUSED LITERAL1 +WHYNTER LITERAL1 +WHYNTER_BITS LITERAL1 +WHYNTER_BIT_MARK LITERAL1 +WHYNTER_HDR_MARK LITERAL1 +WHYNTER_HDR_MARK_TICKS LITERAL1 +WHYNTER_HDR_SPACE LITERAL1 +WHYNTER_HDR_SPACE_TICKS LITERAL1 +WHYNTER_MIN_COMMAND_LENGTH LITERAL1 +WHYNTER_ONE_SPACE LITERAL1 +WHYNTER_ONE_SPACE_TICKS LITERAL1 +WHYNTER_TICK LITERAL1 +WHYNTER_ZERO_SPACE LITERAL1 diff --git a/IRremoteESP8266/library.json b/IRremoteESP8266/library.json new file mode 100644 index 0000000..5089b74 --- /dev/null +++ b/IRremoteESP8266/library.json @@ -0,0 +1,44 @@ +{ + "name": "IRremoteESP8266", + "version": "2.3.2", + "keywords": "infrared, ir, remote, esp8266", + "description": "Send and receive infrared signals with multiple protocols (ESP8266)", + "repository": + { + "type": "git", + "url": "https://github.com/markszabo/IRremoteESP8266.git" + }, + "authors": [ + { + "name": "Ken Shirriff", + "email": "zetoslab@gmail.com" + }, + { + "name": "Mark Szabo", + "url": "http://nomartini-noparty.blogspot.com/", + "maintainer": true + }, + { + "name": "Sebastien Warin", + "url": "http://sebastien.warin.fr", + "maintainer": true + }, + { + "name": "David Conran", + "url": "https://plus.google.com/+davidconran", + "maintainer": true + }, + { + "name": "Roi Dayan", + "url": "https://github.com/roidayan/", + "maintainer": true + }, + { + "name": "Massimiliano Pinto", + "url": "https://github.com/pintomax/", + "maintainer": true + } + ], + "frameworks": "arduino", + "platforms": "espressif8266" +} diff --git a/IRremoteESP8266/library.properties b/IRremoteESP8266/library.properties new file mode 100644 index 0000000..8d01cdb --- /dev/null +++ b/IRremoteESP8266/library.properties @@ -0,0 +1,9 @@ +name=IRremoteESP8266 +version=2.3.2 +author=Sebastien Warin, Mark Szabo, Ken Shirriff, David Conran +maintainer=Mark Szabo, David Conran, Sebastien Warin, Roi Dayan, Massimiliano Pinto +sentence=Send and receive infrared signals with multiple protocols (ESP8266) +paragraph=This library enables you to send and receive infra-red signals on an ESP8266. +category=Device Control +url=https://github.com/markszabo/IRremoteESP8266 +architectures=esp8266 diff --git a/IRremoteESP8266/platformio.ini b/IRremoteESP8266/platformio.ini new file mode 100644 index 0000000..63c3781 --- /dev/null +++ b/IRremoteESP8266/platformio.ini @@ -0,0 +1,26 @@ +[platformio] +lib_extra_dirs = . +src_dir = examples/IRrecvDumpV2 + +[common] +build_flags = +lib_deps_builtin = +lib_deps_external = + +[env:nodemcuv2] +platform = espressif8266 +framework = arduino +board = nodemcuv2 +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} + +[env:d1_mini] +platform = espressif8266 +framework = arduino +board = d1_mini +build_flags = ${common.build_flags} +lib_deps = + ${common.lib_deps_builtin} + ${common.lib_deps_external} diff --git a/IRremoteESP8266/src/CPPLINT.cfg b/IRremoteESP8266/src/CPPLINT.cfg new file mode 100644 index 0000000..fc30d70 --- /dev/null +++ b/IRremoteESP8266/src/CPPLINT.cfg @@ -0,0 +1 @@ +filter=-build/include,+build/include_alpha,+build/include_order,+build/include_what_you_use diff --git a/IRremoteESP8266/src/IRrecv.cpp b/IRremoteESP8266/src/IRrecv.cpp new file mode 100644 index 0000000..295d450 --- /dev/null +++ b/IRremoteESP8266/src/IRrecv.cpp @@ -0,0 +1,699 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2015 Mark Szabo +// Copyright 2015 Sebastien Warin +// Copyright 2017 David Conran + +#include "IRrecv.h" +#include +#ifndef UNIT_TEST +extern "C" { + #include + #include +} +#include +#endif +#include +#include "IRremoteESP8266.h" + +#ifdef UNIT_TEST +#undef ICACHE_RAM_ATTR +#define ICACHE_RAM_ATTR +#endif +// Updated by Sebastien Warin (http://sebastien.warin.fr) for receiving IR code +// on ESP8266 +// Updated by markszabo (https://github.com/markszabo/IRremoteESP8266) for +// sending IR code on ESP8266 + +// Globals +#ifndef UNIT_TEST +static ETSTimer timer; +#endif +volatile irparams_t irparams; +irparams_t *irparams_save; // A copy of the interrupt state while decoding. + +#ifndef UNIT_TEST +static void ICACHE_RAM_ATTR read_timeout(void *arg __attribute__((unused))) { + os_intr_lock(); + if (irparams.rawlen) + irparams.rcvstate = STATE_STOP; + os_intr_unlock(); +} + +static void ICACHE_RAM_ATTR gpio_intr() { + uint32_t now = system_get_time(); + uint32_t gpio_status = GPIO_REG_READ(GPIO_STATUS_ADDRESS); + static uint32_t start = 0; + + os_timer_disarm(&timer); + GPIO_REG_WRITE(GPIO_STATUS_W1TC_ADDRESS, gpio_status); + + // Grab a local copy of rawlen to reduce instructions used in IRAM. + // This is an ugly premature optimisation code-wise, but we do everything we + // can to save IRAM. + // It seems referencing the value via the structure uses more instructions. + // Less instructions means faster and less IRAM used. + // N.B. It saves about 13 bytes of IRAM. + uint16_t rawlen = irparams.rawlen; + + if (rawlen >= irparams.bufsize) { + irparams.overflow = true; + irparams.rcvstate = STATE_STOP; + } + + if (irparams.rcvstate == STATE_STOP) + return; + + if (irparams.rcvstate == STATE_IDLE) { + irparams.rcvstate = STATE_MARK; + irparams.rawbuf[rawlen] = 1; + } else { + if (now < start) + irparams.rawbuf[rawlen] = (UINT32_MAX - start + now) / RAWTICK; + else + irparams.rawbuf[rawlen] = (now - start) / RAWTICK; + } + irparams.rawlen++; + + start = now; + #define ONCE 0 + os_timer_arm(&timer, irparams.timeout, ONCE); +} +#endif // UNIT_TEST + +// Start of IRrecv class ------------------- + +// Class constructor +// Args: +// recvpin: GPIO pin the IR receiver module's data pin is connected to. +// bufsize: Nr. of entries to have in the capture buffer. (Default: RAWBUF) +// timeout: Nr. of milli-Seconds of no signal before we stop capturing data. +// (Default: TIMEOUT_MS) +// save_buffer: Use a second (save) buffer to decode from. (Def: false) +// Returns: +// An IRrecv class object. +IRrecv::IRrecv(uint16_t recvpin, uint16_t bufsize, uint8_t timeout, + bool save_buffer) { + irparams.recvpin = recvpin; + irparams.bufsize = bufsize; + // Ensure we are going to be able to store all possible values in the + // capture buffer. + irparams.timeout = std::min(timeout, (uint8_t) MAX_TIMEOUT_MS); + irparams.rawbuf = new uint16_t[bufsize]; + if (irparams.rawbuf == NULL) { + DPRINTLN("Could not allocate memory for the primary IR buffer.\n" + "Try a smaller size for CAPTURE_BUFFER_SIZE.\nRebooting!"); +#ifndef UNIT_TEST + ESP.restart(); // Mem alloc failure. Reboot. +#endif + } + // If we have been asked to use a save buffer (for decoding), then create one. + if (save_buffer) { + irparams_save = new irparams_t; + irparams_save->rawbuf = new uint16_t[bufsize]; + // Check we allocated the memory successfully. + if (irparams_save->rawbuf == NULL) { + DPRINTLN("Could not allocate memory for the second IR buffer.\n" + "Try a smaller size for CAPTURE_BUFFER_SIZE.\nRebooting!"); +#ifndef UNIT_TEST + ESP.restart(); // Mem alloc failure. Reboot. +#endif + } + } else { + irparams_save = NULL; + } +#if DECODE_HASH + unknown_threshold = UNKNOWN_THRESHOLD; +#endif // DECODE_HASH +} + +// Class destructor +IRrecv::~IRrecv(void) { + delete [] irparams.rawbuf; + if (irparams_save != NULL) { + delete [] irparams_save->rawbuf; + delete irparams_save; + } +} + +// initialization +void IRrecv::enableIRIn() { + // initialize state machine variables + resume(); + +#ifndef UNIT_TEST + // Initialize timer + os_timer_disarm(&timer); + os_timer_setfn(&timer, reinterpret_cast(read_timeout), + NULL); + + // Attach Interrupt + attachInterrupt(irparams.recvpin, gpio_intr, CHANGE); +#endif +} + +void IRrecv::disableIRIn() { +#ifndef UNIT_TEST + os_timer_disarm(&timer); + detachInterrupt(irparams.recvpin); +#endif +} + +void IRrecv::resume() { + irparams.rcvstate = STATE_IDLE; + irparams.rawlen = 0; + irparams.overflow = false; +} + +// Make a copy of the interrupt state & buffer data. +// Needed because irparams is marked as volatile, thus memcpy() isn't allowed. +// Only call this when you know the interrupt handlers won't modify anything. +// i.e. In STATE_STOP. +// +// Args: +// src: Pointer to an irparams_t structure to copy from. +// dst: Pointer to an irparams_t structure to copy to. +void IRrecv::copyIrParams(volatile irparams_t *src, irparams_t *dst) { + // Typecast src and dst addresses to (char *) + char *csrc = (char *) src; // NOLINT(readability/casting) + char *cdst = (char *) dst; // NOLINT(readability/casting) + + // Save the pointer to the destination's rawbuf so we don't lose it as + // the for-loop/copy after this will overwrite it with src's rawbuf pointer. + // This isn't immediately obvious due to typecasting/different variable names. + uint16_t *dst_rawbuf_ptr; + dst_rawbuf_ptr = dst->rawbuf; + + // Copy contents of src[] to dst[] + for (uint16_t i = 0; i < sizeof(irparams_t); i++) + cdst[i] = csrc[i]; + + // Restore the buffer pointer + dst->rawbuf = dst_rawbuf_ptr; + + // Copy the rawbuf + for (uint16_t i = 0; i < dst->bufsize; i++) + dst->rawbuf[i] = src->rawbuf[i]; +} + +// Obtain the maximum number of entries possible in the capture buffer. +// i.e. It's size. +uint16_t IRrecv::getBufSize() { + return irparams.bufsize; +} + +#if DECODE_HASH +// Set the minimum length we will consider for reporting UNKNOWN message types. +void IRrecv::setUnknownThreshold(uint16_t length) { + unknown_threshold = length; +} +#endif // DECODE_HASH + +// Decodes the received IR message. +// If the interrupt state is saved, we will immediately resume waiting +// for the next IR message to avoid missing messages. +// Note: There is a trade-off here. Saving the state means less time lost until +// we can receiving the next message vs. using more RAM. Choose appropriately. +// +// Args: +// results: A pointer to where the decoded IR message will be stored. +// save: A pointer to an irparams_t instance in which to save +// the interrupt's memory/state. NULL means don't save it. +// Returns: +// A boolean indicating if an IR message is ready or not. +bool IRrecv::decode(decode_results *results, irparams_t *save) { + // Proceed only if an IR message been received. +#ifndef UNIT_TEST + if (irparams.rcvstate != STATE_STOP) + return false; +#endif + + // Clear the entry we are currently pointing to when we got the timeout. + // i.e. Stopped collecting IR data. + // It's junk as we never wrote an entry to it and can only confuse decoding. + // This is done here rather than logically the best place in read_timeout() + // as it saves a few bytes of ICACHE_RAM as that routine is bound to an + // interrupt. decode() is not stored in ICACHE_RAM. + // Another better option would be to zero the entire irparams.rawbuf[] on + // resume() but that is a much more expensive operation compare to this. + irparams.rawbuf[irparams.rawlen] = 0; + + bool resumed = false; // Flag indicating if we have resumed. + + // If we were requested to use a save buffer previously, do so. + if (save == NULL) + save = irparams_save; + + if (save == NULL) { + // We haven't been asked to copy it so use the existing memory. +#ifndef UNIT_TEST + results->rawbuf = irparams.rawbuf; + results->rawlen = irparams.rawlen; + results->overflow = irparams.overflow; +#endif + } else { + copyIrParams(&irparams, save); // Duplicate the interrupt's memory. + resume(); // It's now safe to rearm. The IR message won't be overridden. + resumed = true; + // Point the results at the saved copy. + results->rawbuf = save->rawbuf; + results->rawlen = save->rawlen; + results->overflow = save->overflow; + } + + // Reset any previously partially processed results. + results->decode_type = UNKNOWN; + results->bits = 0; + results->value = 0; + results->address = 0; + results->command = 0; + results->repeat = false; + +#if DECODE_AIWA_RC_T501 + DPRINTLN("Attempting Aiwa RC T501 decode"); + // Try decodeAiwaRCT501() before decodeSanyoLC7461() & decodeNEC() + // because the protocols are similar. This protocol is more specific than + // those ones, so should got before them. + if (decodeAiwaRCT501(results)) + return true; +#endif +#if DECODE_SANYO + DPRINTLN("Attempting Sanyo LC7461 decode"); + // Try decodeSanyoLC7461() before decodeNEC() because the protocols are + // similar in timings & structure, but the Sanyo one is much longer than the + // NEC protocol (42 vs 32 bits) so this one should be tried first to try to + // reduce false detection as a NEC packet. + if (decodeSanyoLC7461(results)) + return true; +#endif +#if DECODE_CARRIER_AC + DPRINTLN("Attempting Carrier AC decode"); + // Try decodeCarrierAC() before decodeNEC() because the protocols are + // similar in timings & structure, but the Carrier one is much longer than the + // NEC protocol (3x32 bits vs 1x32 bits) so this one should be tried first to + // try to reduce false detection as a NEC packet. + if (decodeCarrierAC(results)) + return true; +#endif +#if DECODE_NEC + DPRINTLN("Attempting NEC decode"); + if (decodeNEC(results)) + return true; +#endif +#if DECODE_SONY + DPRINTLN("Attempting Sony decode"); + if (decodeSony(results)) + return true; +#endif +#if DECODE_MITSUBISHI + DPRINTLN("Attempting Mitsubishi decode"); + if (decodeMitsubishi(results)) + return true; +#endif +#if DECODE_RC5 + DPRINTLN("Attempting RC5 decode"); + if (decodeRC5(results)) + return true; +#endif +#if DECODE_RC6 + DPRINTLN("Attempting RC6 decode"); + if (decodeRC6(results)) + return true; +#endif +#if DECODE_RCMM + DPRINTLN("Attempting RC-MM decode"); + if (decodeRCMM(results)) + return true; +#endif +#if DECODE_FUJITSU_AC + // Fujitsu A/C needs to precede Panasonic and Denon as it has a short + // message which looks exactly the same as a Panasonic/Denon message. + DPRINTLN("Attempting Fujitsu A/C decode"); + if (decodeFujitsuAC(results)) + return true; +#endif +#if DECODE_DENON + // Denon needs to precede Panasonic as it is a special case of Panasonic. + DPRINTLN("Attempting Denon decode"); + if (decodeDenon(results, DENON_48_BITS) || + decodeDenon(results, DENON_BITS) || + decodeDenon(results, DENON_LEGACY_BITS)) + return true; +#endif +#if DECODE_PANASONIC + DPRINTLN("Attempting Panasonic decode"); + if (decodePanasonic(results)) + return true; +#endif +#if DECODE_LG + DPRINTLN("Attempting LG (28-bit) decode"); + if (decodeLG(results, LG_BITS, true)) + return true; + DPRINTLN("Attempting LG (32-bit) decode"); + // LG32 should be tried before Samsung + if (decodeLG(results, LG32_BITS, true)) + return true; +#endif +#if DECODE_JVC + DPRINTLN("Attempting JVC decode"); + if (decodeJVC(results)) + return true; +#endif +#if DECODE_SAMSUNG + DPRINTLN("Attempting SAMSUNG decode"); + if (decodeSAMSUNG(results)) + return true; +#endif +#if DECODE_WHYNTER + DPRINTLN("Attempting Whynter decode"); + if (decodeWhynter(results)) + return true; +#endif +#if DECODE_DISH + DPRINTLN("Attempting DISH decode"); + if (decodeDISH(results)) + return true; +#endif +#if DECODE_SHARP + DPRINTLN("Attempting Sharp decode"); + if (decodeSharp(results)) + return true; +#endif +#if DECODE_COOLIX + DPRINTLN("Attempting Coolix decode"); + if (decodeCOOLIX(results)) + return true; +#endif +#if DECODE_NIKAI + DPRINTLN("Attempting Nikai decode"); + if (decodeNikai(results)) + return true; +#endif +#if DECODE_KELVINATOR +// Kelvinator based-devices use a similar code to Gree ones, to avoid false +// matches this needs to happen before decodeGree(). + DPRINTLN("Attempting Kelvinator decode"); + if (decodeKelvinator(results)) + return true; +#endif +#if DECODE_DAIKIN + DPRINTLN("Attempting Daikin decode"); + if (decodeDaikin(results)) + return true; +#endif +#if DECODE_TOSHIBA_AC + DPRINTLN("Attempting Toshiba AC decode"); + if (decodeToshibaAC(results)) + return true; +#endif +#if DECODE_MIDEA + DPRINTLN("Attempting Midea decode"); + if (decodeMidea(results)) + return true; +#endif +#if DECODE_MAGIQUEST + DPRINTLN("Attempting Magiquest decode"); + if (decodeMagiQuest(results)) + return true; +#endif +/* NOTE: Disabled due to poor quality. +#if DECODE_SANYO + // The Sanyo S866500B decoder is very poor quality & depricated. + // *IF* you are going to enable it, do it near last to avoid false positive + // matches. + DPRINTLN("Attempting Sanyo SA8650B decode"); + if (decodeSanyo(results)) + return true; +#endif +*/ +#if DECODE_NEC + // Some devices send NEC-like codes that don't follow the true NEC spec. + // This should detect those. e.g. Apple TV remote etc. + // This needs to be done after all other codes that use strict and some + // other protocols that are NEC-like as well, as turning off strict may + // cause this to match other valid protocols. + DPRINTLN("Attempting NEC (non-strict) decode"); + if (decodeNEC(results, NEC_BITS, false)) { + results->decode_type = NEC_LIKE; + return true; + } +#endif +#if DECODE_LASERTAG + DPRINTLN("Attempting Lasertag decode"); + if (decodeLasertag(results)) + return true; +#endif +#if DECODE_GREE + // Gree based-devices use a similar code to Kelvinator ones, to avoid false + // matches this needs to happen after decodeKelvinator(). + DPRINTLN("Attempting Gree decode"); + if (decodeGree(results)) + return true; +#endif +#if DECODE_HAIER_AC + DPRINTLN("Attempting Haier AC decode"); + if (decodeHaierAC(results)) + return true; +#endif +#if DECODE_HASH + // decodeHash returns a hash on any input. + // Thus, it needs to be last in the list. + // If you add any decodes, add them before this. + if (decodeHash(results)) { + return true; + } +#endif // DECODE_HASH + // Throw away and start over + if (!resumed) // Check if we have already resumed. + resume(); + return false; +} + +// Calculate the lower bound of the nr. of ticks. +// +// Args: +// usecs: Nr. of uSeconds. +// tolerance: Percent as an integer. e.g. 10 is 10% +// delta: A non-scaling amount to reduce usecs by. +// Returns: +// Nr. of ticks. +uint32_t IRrecv::ticksLow(uint32_t usecs, uint8_t tolerance, uint16_t delta) { + // max() used to ensure the result can't drop below 0 before the cast. + return((uint32_t) std::max( + (int32_t) (usecs * (1.0 - tolerance / 100.0) - delta), 0)); +} + +// Calculate the upper bound of the nr. of ticks. +// +// Args: +// usecs: Nr. of uSeconds. +// tolerance: Percent as an integer. e.g. 10 is 10% +// delta: A non-scaling amount to increase usecs by. +// Returns: +// Nr. of ticks. +uint32_t IRrecv::ticksHigh(uint32_t usecs, uint8_t tolerance, uint16_t delta) { + return((uint32_t) (usecs * (1.0 + tolerance / 100.0)) + 1 + delta); +} + +// Check if we match a pulse(measured) with the desired within +// +/-tolerance percent and/or +/- a fixed delta range. +// +// Args: +// measured: The recorded period of the signal pulse. +// desired: The expected period (in useconds) we are matching against. +// tolerance: A percentage expressed as an integer. e.g. 10 is 10%. +// delta: A non-scaling (+/-) error margin (in useconds). +// +// Returns: +// Boolean: true if it matches, false if it doesn't. +bool IRrecv::match(uint32_t measured, uint32_t desired, + uint8_t tolerance, uint16_t delta) { + measured *= RAWTICK; // Convert to uSecs. + DPRINT("Matching: "); + DPRINT(ticksLow(desired, tolerance, delta)); + DPRINT(" <= "); + DPRINT(measured); + DPRINT(" <= "); + DPRINTLN(ticksHigh(desired, tolerance, delta)); + return (measured >= ticksLow(desired, tolerance, delta) && + measured <= ticksHigh(desired, tolerance, delta)); +} + + +// Check if we match a pulse(measured) of at least desired within +// tolerance percent and/or a fixed delta margin. +// +// Args: +// measured: The recorded period of the signal pulse. +// desired: The expected period (in useconds) we are matching against. +// tolerance: A percentage expressed as an integer. e.g. 10 is 10%. +// delta: A non-scaling amount to reduce usecs by. + +// +// Returns: +// Boolean: true if it matches, false if it doesn't. +bool IRrecv::matchAtLeast(uint32_t measured, uint32_t desired, + uint8_t tolerance, uint16_t delta) { + measured *= RAWTICK; // Convert to uSecs. + DPRINT("Matching ATLEAST "); + DPRINT(measured); + DPRINT(" vs "); + DPRINT(desired); + DPRINT(". Matching: "); + DPRINT(measured); + DPRINT(" >= "); + DPRINT(ticksLow(std::min(desired, MS_TO_USEC(irparams.timeout)), tolerance, + delta)); + DPRINT(" [min("); + DPRINT(ticksLow(desired, tolerance, delta)); + DPRINT(", "); + DPRINT(ticksLow(MS_TO_USEC(irparams.timeout), tolerance, delta)); + DPRINTLN(")]"); + // We really should never get a value of 0, except as the last value + // in the buffer. If that is the case, then assume infinity and return true. + if (measured == 0) return true; + return measured >= ticksLow(std::min(desired, MS_TO_USEC(irparams.timeout)), + tolerance, delta); +} + +// Check if we match a mark signal(measured) with the desired within +// +/-tolerance percent, after an expected is excess is added. +// +// Args: +// measured: The recorded period of the signal pulse. +// desired: The expected period (in useconds) we are matching against. +// tolerance: A percentage expressed as an integer. e.g. 10 is 10%. +// excess: Nr. of useconds. +// +// Returns: +// Boolean: true if it matches, false if it doesn't. +bool IRrecv::matchMark(uint32_t measured, uint32_t desired, + uint8_t tolerance, int16_t excess) { + DPRINT("Matching MARK "); + DPRINT(measured * RAWTICK); + DPRINT(" vs "); + DPRINT(desired); + DPRINT(" + "); + DPRINT(excess); + DPRINT(". "); + return match(measured, desired + excess, tolerance); +} + +// Check if we match a space signal(measured) with the desired within +// +/-tolerance percent, after an expected is excess is removed. +// +// Args: +// measured: The recorded period of the signal pulse. +// desired: The expected period (in useconds) we are matching against. +// tolerance: A percentage expressed as an integer. e.g. 10 is 10%. +// excess: Nr. of useconds. +// +// Returns: +// Boolean: true if it matches, false if it doesn't. +bool IRrecv::matchSpace(uint32_t measured, uint32_t desired, + uint8_t tolerance, int16_t excess) { + DPRINT("Matching SPACE "); + DPRINT(measured * RAWTICK); + DPRINT(" vs "); + DPRINT(desired); + DPRINT(" - "); + DPRINT(excess); + DPRINT(". "); + return match(measured, desired - excess, tolerance); +} + +/* ----------------------------------------------------------------------- + * hashdecode - decode an arbitrary IR code. + * Instead of decoding using a standard encoding scheme + * (e.g. Sony, NEC, RC5), the code is hashed to a 32-bit value. + * + * The algorithm: look at the sequence of MARK signals, and see if each one + * is shorter (0), the same length (1), or longer (2) than the previous. + * Do the same with the SPACE signals. Hash the resulting sequence of 0's, + * 1's, and 2's to a 32-bit value. This will give a unique value for each + * different code (probably), for most code systems. + * + * http://arcfn.com/2010/01/using-arbitrary-remotes-with-arduino.html + */ + +// Compare two tick values, returning 0 if newval is shorter, +// 1 if newval is equal, and 2 if newval is longer +// Use a tolerance of 20% +int16_t IRrecv::compare(uint16_t oldval, uint16_t newval) { + if (newval < oldval * 0.8) + return 0; + else if (oldval < newval * 0.8) + return 2; + else + return 1; +} + +#if DECODE_HASH +/* Converts the raw code values into a 32-bit hash code. + * Hopefully this code is unique for each button. + * This isn't a "real" decoding, just an arbitrary value. + */ +bool IRrecv::decodeHash(decode_results *results) { + // Require at least some samples to prevent triggering on noise + if (results->rawlen < unknown_threshold) + return false; + int32_t hash = FNV_BASIS_32; + // 'rawlen - 2' to avoid the look ahead from going out of bounds. + // Should probably be -3 to avoid comparing the trailing space entry, + // however it is left this way for compatibility with previously captured + // values. + for (uint16_t i = 1; i < results->rawlen - 2; i++) { + int16_t value = compare(results->rawbuf[i], results->rawbuf[i + 2]); + // Add value into the hash + hash = (hash * FNV_PRIME_32) ^ value; + } + results->value = hash & 0xFFFFFFFF; + results->bits = results->rawlen / 2; + results->address = 0; + results->command = 0; + results->decode_type = UNKNOWN; + return true; +} +#endif // DECODE_HASH + +// Match & decode the typical data section of an IR message. +// The data value constructed as the Most Significant Bit first. +// +// Args: +// data_ptr: A pointer to where we are at in the capture buffer. +// nbits: Nr. of data bits we expect. +// onemark: Nr. of uSeconds in an expected mark signal for a '1' bit. +// onespace: Nr. of uSeconds in an expected space signal for a '1' bit. +// zeromark: Nr. of uSeconds in an expected mark signal for a '0' bit. +// zerospace: Nr. of uSeconds in an expected space signal for a '0' bit. +// tolerance: Percentage error margin to allow. +// Returns: +// A match_result_t structure containing the success (or not), the data value, +// and how many buffer entries were used. +match_result_t IRrecv::matchData(volatile uint16_t *data_ptr, + const uint16_t nbits, const uint16_t onemark, + const uint32_t onespace, + const uint16_t zeromark, + const uint32_t zerospace, + const uint8_t tolerance) { + match_result_t result; + result.success = false; // Fail by default. + result.data = 0; + for (result.used = 0; + result.used < nbits * 2; + result.used += 2, data_ptr += 2) { + // Is the bit a '1'? + if (matchMark(*data_ptr, onemark, tolerance) && + matchSpace(*(data_ptr + 1), onespace, tolerance)) + result.data = (result.data << 1) | 1; + // or is the bit a '0'? + else if (matchMark(*data_ptr, zeromark, tolerance) && + matchSpace(*(data_ptr + 1), zerospace, tolerance)) + result.data <<= 1; + else + return result; // It's neither, so fail. + } + result.success = true; + return result; +} + +// End of IRrecv class ------------------- diff --git a/IRremoteESP8266/src/IRrecv.h b/IRremoteESP8266/src/IRrecv.h new file mode 100644 index 0000000..a5f2166 --- /dev/null +++ b/IRremoteESP8266/src/IRrecv.h @@ -0,0 +1,274 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2015 Mark Szabo +// Copyright 2015 Sebastien Warin +// Copyright 2017 David Conran + +#ifndef IRRECV_H_ +#define IRRECV_H_ + +#ifndef UNIT_TEST +#include +#endif +#include +#define __STDC_LIMIT_MACROS +#include +#include "IRremoteESP8266.h" + +// Constants +#define HEADER 2U // Usual nr. of header entries. +#define FOOTER 2U // Usual nr. of footer (stop bits) entries. +#define OFFSET_START 1U // Usual rawbuf entry to start processing from. +#define MS_TO_USEC(x) (x * 1000U) // Convert milli-Seconds to micro-Seconds. +// Marks tend to be 100us too long, and spaces 100us too short +// when received due to sensor lag. +#define MARK_EXCESS 50U +#define RAWBUF 100U // Default length of raw capture buffer +#define REPEAT UINT64_MAX +#define UNKNOWN_THRESHOLD 6U // Default min size of reported UNKNOWN messages. +// receiver states +#define STATE_IDLE 2U +#define STATE_MARK 3U +#define STATE_SPACE 4U +#define STATE_STOP 5U +#define TOLERANCE 25U // default percent tolerance in measurements +#define RAWTICK 2U // Capture tick to uSec factor. +// How long (ms) before we give up wait for more data? +// Don't exceed MAX_TIMEOUT_MS without a good reason. +// That is the capture buffers maximum value size. (UINT16_MAX / RAWTICK) +// Typically messages/protocols tend to repeat around the 100ms timeframe, +// thus we should timeout before that to give us some time to try to decode +// before we need to start capturing a possible new message. +// Typically 15ms suits most applications. However, some protocols demand a +// higher value. e.g. 90ms for XMP-1 and some aircon units. +#define TIMEOUT_MS 15U // In MilliSeconds. +#define MAX_TIMEOUT_MS (RAWTICK * UINT16_MAX / MS_TO_USEC(1)) + +// Use FNV hash algorithm: http://isthe.com/chongo/tech/comp/fnv/#FNV-param +#define FNV_PRIME_32 16777619UL +#define FNV_BASIS_32 2166136261UL + +// Daikin is the current largest state size (by far). +#define STATE_SIZE_MAX DAIKIN_COMMAND_LENGTH + +// Types +// information for the interrupt handler +typedef struct { + uint8_t recvpin; // pin for IR data from detector + uint8_t rcvstate; // state machine + uint16_t timer; // state timer, counts 50uS ticks. + uint16_t bufsize; // max. nr. of entries in the capture buffer. + uint16_t *rawbuf; // raw data + // uint16_t is used for rawlen as it saves 3 bytes of iram in the interrupt + // handler. Don't ask why, I don't know. It just does. + uint16_t rawlen; // counter of entries in rawbuf. + uint8_t overflow; // Buffer overflow indicator. + uint8_t timeout; // Nr. of milliSeconds before we give up. +} irparams_t; + +// results from a data match +typedef struct { + bool success; // Was the match successful? + uint64_t data; // The data found. + uint16_t used; // How many buffer positions were used. +} match_result_t; + +// Classes + +// Results returned from the decoder +class decode_results { + public: + decode_type_t decode_type; // NEC, SONY, RC5, UNKNOWN + // value, address, & command are all mutually exclusive with state. + // i.e. They MUST NOT be used at the same time as state, so we can use a union + // structure to save us a handful of valuable bytes of memory. + union { + struct { + uint64_t value; // Decoded value + uint32_t address; // Decoded device address. + uint32_t command; // Decoded command. + }; +#if DECODE_AC // Only include state if we must. It's big. + uint8_t state[STATE_SIZE_MAX]; // Complex multi-byte A/C result. +#endif + }; + uint16_t bits; // Number of bits in decoded value + volatile uint16_t *rawbuf; // Raw intervals in .5 us ticks + uint16_t rawlen; // Number of records in rawbuf. + bool overflow; + bool repeat; // Is the result a repeat code? +}; + +// main class for receiving IR +class IRrecv { + public: + explicit IRrecv(uint16_t recvpin, uint16_t bufsize = RAWBUF, + uint8_t timeout = TIMEOUT_MS, + bool save_buffer = false); // Constructor + ~IRrecv(); // Destructor + bool decode(decode_results *results, irparams_t *save = NULL); + void enableIRIn(); + void disableIRIn(); + void resume(); + uint16_t getBufSize(); +#if DECODE_HASH + void setUnknownThreshold(uint16_t length); +#endif + static bool match(uint32_t measured, uint32_t desired, + uint8_t tolerance = TOLERANCE, uint16_t delta = 0); + static bool matchMark(uint32_t measured, uint32_t desired, + uint8_t tolerance = TOLERANCE, int16_t excess = MARK_EXCESS); + static bool matchSpace(uint32_t measured, uint32_t desired, + uint8_t tolerance = TOLERANCE, int16_t excess = MARK_EXCESS); +#ifndef UNIT_TEST + + private: +#endif + irparams_t *irparams_save; +#if DECODE_HASH + uint16_t unknown_threshold; +#endif + // These are called by decode + void copyIrParams(volatile irparams_t *src, irparams_t *dst); + int16_t compare(uint16_t oldval, uint16_t newval); + static uint32_t ticksLow(uint32_t usecs, uint8_t tolerance = TOLERANCE, + uint16_t delta = 0); + static uint32_t ticksHigh(uint32_t usecs, uint8_t tolerance = TOLERANCE, + uint16_t delta = 0); + bool matchAtLeast(uint32_t measured, uint32_t desired, + uint8_t tolerance = TOLERANCE, uint16_t delta = 0); + match_result_t matchData(volatile uint16_t *data_ptr, const uint16_t nbits, + const uint16_t onemark, const uint32_t onespace, + const uint16_t zeromark, const uint32_t zerospace, + const uint8_t tolerance = TOLERANCE); + bool decodeHash(decode_results *results); +#if (DECODE_NEC || DECODE_SHERWOOD || DECODE_AIWA_RC_T501 || SEND_SANYO) + bool decodeNEC(decode_results *results, uint16_t nbits = NEC_BITS, + bool strict = true); +#endif +#if DECODE_SONY + bool decodeSony(decode_results *results, uint16_t nbits = SONY_MIN_BITS, + bool strict = false); +#endif +#if DECODE_SANYO + // DISABLED due to poor quality. + // bool decodeSanyo(decode_results *results, + // uint16_t nbits = SANYO_SA8650B_BITS, + // bool strict = false); + bool decodeSanyoLC7461(decode_results *results, + uint16_t nbits = SANYO_LC7461_BITS, + bool strict = true); +#endif +#if DECODE_MITSUBISHI + bool decodeMitsubishi(decode_results *results, + uint16_t nbits = MITSUBISHI_BITS, + bool strict = true); +#endif +#if (DECODE_RC5 || DECODE_R6 || DECODE_LASERTAG) + int16_t getRClevel(decode_results *results, uint16_t *offset, uint16_t *used, + uint16_t bitTime, uint8_t tolerance = TOLERANCE, + int16_t excess = MARK_EXCESS, uint16_t delta = 0); +#endif +#if DECODE_RC5 + bool decodeRC5(decode_results *results, uint16_t nbits = RC5X_BITS, + bool strict = true); +#endif +#if DECODE_RC6 + bool decodeRC6(decode_results *results, uint16_t nbits = RC6_MODE0_BITS, + bool strict = false); +#endif +#if DECODE_RCMM + bool decodeRCMM(decode_results *results, uint16_t nbits = RCMM_BITS, + bool strict = false); +#endif +#if (DECODE_PANASONIC || DECODE_DENON) + bool decodePanasonic(decode_results *results, uint16_t nbits = PANASONIC_BITS, + bool strict = false, + uint32_t manufacturer = PANASONIC_MANUFACTURER); +#endif +#if DECODE_LG + bool decodeLG(decode_results *results, uint16_t nbits = LG_BITS, + bool strict = false); +#endif +#if DECODE_JVC + bool decodeJVC(decode_results *results, uint16_t nbits = JVC_BITS, + bool strict = true); +#endif +#if DECODE_SAMSUNG + bool decodeSAMSUNG(decode_results *results, uint16_t nbits = SAMSUNG_BITS, + bool strict = true); +#endif +#if DECODE_WHYNTER + bool decodeWhynter(decode_results *results, uint16_t nbits = WHYNTER_BITS, + bool strict = true); +#endif +#if DECODE_COOLIX + bool decodeCOOLIX(decode_results *results, uint16_t nbits = COOLIX_BITS, + bool strict = true); +#endif +#if DECODE_DENON + bool decodeDenon(decode_results *results, uint16_t nbits = DENON_BITS, + bool strict = true); +#endif +#if DECODE_DISH + bool decodeDISH(decode_results *results, uint16_t nbits = DISH_BITS, + bool strict = true); +#endif +#if (DECODE_SHARP || DECODE_DENON) + bool decodeSharp(decode_results *results, uint16_t nbits = SHARP_BITS, + bool strict = true, bool expansion = true); +#endif +#if DECODE_AIWA_RC_T501 + bool decodeAiwaRCT501(decode_results *results, + uint16_t nbits = AIWA_RC_T501_BITS, bool strict = true); +#endif +#if DECODE_NIKAI + bool decodeNikai(decode_results *results, uint16_t nbits = NIKAI_BITS, + bool strict = true); +#endif +#if DECODE_MAGIQUEST + bool decodeMagiQuest(decode_results *results, uint16_t nbits = MAGIQUEST_BITS, + bool strict = true); +#endif +#if DECODE_KELVINATOR + bool decodeKelvinator(decode_results *results, + uint16_t nbits = KELVINATOR_BITS, + bool strict = true); +#endif +#if DECODE_DAIKIN + bool decodeDaikin(decode_results *results, uint16_t nbits = DAIKIN_RAW_BITS, + bool strict = true); +#endif +#if DECODE_TOSHIBA_AC + bool decodeToshibaAC(decode_results *results, + uint16_t nbytes = TOSHIBA_AC_BITS, + bool strict = true); +#endif +#if DECODE_MIDEA + bool decodeMidea(decode_results *results, uint16_t nbits = MIDEA_BITS, + bool strict = true); +#endif +#if DECODE_FUJITSU_AC + bool decodeFujitsuAC(decode_results *results, + uint16_t nbits = FUJITSU_AC_BITS, + bool strict = false); +#endif +#if DECODE_LASERTAG + bool decodeLasertag(decode_results *results, uint16_t nbits = LASERTAG_BITS, + bool strict = true); +#endif +#if DECODE_CARRIER_AC + bool decodeCarrierAC(decode_results *results, + uint16_t nbits = CARRIER_AC_BITS, + bool strict = true); +#endif +#if DECODE_GREE + bool decodeGree(decode_results *results, + uint16_t nbits = GREE_BITS, bool strict = true); +#endif +#if DECODE_HAIER_AC + bool decodeHaierAC(decode_results *results, + uint16_t nbits = HAIER_AC_BITS, bool strict = true); +#endif +}; + +#endif // IRRECV_H_ diff --git a/IRremoteESP8266/src/IRremoteESP8266.h b/IRremoteESP8266/src/IRremoteESP8266.h new file mode 100644 index 0000000..05099ce --- /dev/null +++ b/IRremoteESP8266/src/IRremoteESP8266.h @@ -0,0 +1,309 @@ + /*************************************************** + * IRremote for ESP8266 + * + * Based on the IRremote library for Arduino by Ken Shirriff + * Version 0.11 August, 2009 + * Copyright 2009 Ken Shirriff + * For details, see http://arcfn.com/2009/08/multi-protocol-infrared-remote-library.html + * + * Edited by Mitra to add new controller SANYO + * + * Interrupt code based on NECIRrcv by Joe Knapp + * http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1210243556 + * Also influenced by http://zovirl.com/2008/11/12/building-a-universal-remote-with-an-arduino/ + * + * JVC and Panasonic protocol added by Kristian Lauszus (Thanks to zenwheel and other people at the original blog post) + * LG added by Darryl Smith (based on the JVC protocol) + * Whynter A/C ARC-110WD added by Francesco Meschia + * Coolix A/C / heatpump added by (send) bakrus & (decode) crankyoldgit + * Denon: sendDenon, decodeDenon added by Massimiliano Pinto + (from https://github.com/z3t0/Arduino-IRremote/blob/master/ir_Denon.cpp) + * Kelvinator A/C and Sherwood added by crankyoldgit + * Mitsubishi (TV) sending added by crankyoldgit + * Pronto code sending added by crankyoldgit + * Mitsubishi & Toshiba A/C added by crankyoldgit + * (derived from https://github.com/r45635/HVAC-IR-Control) + * DISH decode by marcosamarinho + * Gree Heatpump sending added by Ville Skyttä (scop) + * (derived from https://github.com/ToniA/arduino-heatpumpir/blob/master/GreeHeatpumpIR.cpp) + * Updated by markszabo (https://github.com/markszabo/IRremoteESP8266) for sending IR code on ESP8266 + * Updated by Sebastien Warin (http://sebastien.warin.fr) for receiving IR code on ESP8266 + * + * Updated by sillyfrog for Daikin, adopted from + * (https://github.com/mharizanov/Daikin-AC-remote-control-over-the-Internet/) + * Fujitsu A/C code added by jonnygraham + * Trotec AC code by stufisher + * Carrier AC code by crankyoldgit + * + * GPL license, all text above must be included in any redistribution + ****************************************************/ + +#ifndef IRREMOTEESP8266_H_ +#define IRREMOTEESP8266_H_ + +#define __STDC_LIMIT_MACROS +#include +#ifdef UNIT_TEST +#include +#endif + +// Library Version +#define _IRREMOTEESP8266_VERSION_ "2.3.2" +// Supported IR protocols +// Each protocol you include costs memory and, during decode, costs time +// Disable (set to false) all the protocols you do not need/want! +// The Air Conditioner protocols are the most expensive memory-wise. +// +#define DECODE_HASH true // Semi-unique code for unknown messages + +#define SEND_RAW true + +#define DECODE_NEC true +#define SEND_NEC true + +#define DECODE_SHERWOOD true // Doesn't exist. Actually is DECODE_NEC +#define SEND_SHERWOOD true + +#define DECODE_RC5 true +#define SEND_RC5 true + +#define DECODE_RC6 true +#define SEND_RC6 true + +#define DECODE_RCMM true +#define SEND_RCMM true + +#define DECODE_SONY true +#define SEND_SONY true + +#define DECODE_PANASONIC true +#define SEND_PANASONIC true + +#define DECODE_JVC true +#define SEND_JVC true + +#define DECODE_SAMSUNG true +#define SEND_SAMSUNG true + +#define DECODE_WHYNTER true +#define SEND_WHYNTER true + +#define DECODE_AIWA_RC_T501 true +#define SEND_AIWA_RC_T501 true + +#define DECODE_LG true +#define SEND_LG true + +#define DECODE_SANYO true +#define SEND_SANYO true + +#define DECODE_MITSUBISHI true +#define SEND_MITSUBISHI true + +#define DECODE_DISH true +#define SEND_DISH true + +#define DECODE_SHARP true +#define SEND_SHARP true + +#define DECODE_DENON true +#define SEND_DENON true + +#define DECODE_KELVINATOR true +#define SEND_KELVINATOR true + +#define DECODE_MITSUBISHI_AC false // Not written. +#define SEND_MITSUBISHI_AC true + +#define DECODE_FUJITSU_AC true +#define SEND_FUJITSU_AC true + +#define DECODE_DAIKIN true +#define SEND_DAIKIN true + +#define DECODE_COOLIX true +#define SEND_COOLIX true + +#define DECODE_GLOBALCACHE false // Not written. +#define SEND_GLOBALCACHE true + +#define DECODE_GREE true +#define SEND_GREE true + +#define DECODE_PRONTO false // Not written. +#define SEND_PRONTO true + +#define DECODE_ARGO false // Not written. +#define SEND_ARGO true + +#define DECODE_TROTEC false // Not implemented. +#define SEND_TROTEC true + +#define DECODE_NIKAI true +#define SEND_NIKAI true + +#define DECODE_TOSHIBA_AC true +#define SEND_TOSHIBA_AC true + +#define DECODE_MAGIQUEST true +#define SEND_MAGIQUEST true + +#define DECODE_MIDEA true +#define SEND_MIDEA true + +#define DECODE_LASERTAG true +#define SEND_LASERTAG true + +#define DECODE_CARRIER_AC true +#define SEND_CARRIER_AC true + +#define DECODE_HAIER_AC true +#define SEND_HAIER_AC true + +#if (DECODE_ARGO || DECODE_DAIKIN || DECODE_FUJITSU_AC || DECODE_GREE || \ + DECODE_KELVINATOR || DECODE_MITSUBISHI_AC || DECODE_TOSHIBA_AC || \ + DECODE_TROTEC || DECODE_HAIER_AC) +#define DECODE_AC true // We need some common infrastructure for decoding A/Cs. +#else +#define DECODE_AC false // We don't need that infrastructure. +#endif + +/* + * Always add to the end of the list and should never remove entries + * or change order. Projects may save the type number for later usage + * so numbering should always stay the same. + */ +enum decode_type_t { + UNKNOWN = -1, + UNUSED = 0, + RC5, + RC6, + NEC, + SONY, + PANASONIC, + JVC, + SAMSUNG, + WHYNTER, + AIWA_RC_T501, + LG, + SANYO, + MITSUBISHI, + DISH, + SHARP, + COOLIX, + DAIKIN, + DENON, + KELVINATOR, + SHERWOOD, + MITSUBISHI_AC, + RCMM, + SANYO_LC7461, + RC5X, + GREE, + PRONTO, // Technically not a protocol, but an encoding. + NEC_LIKE, + ARGO, + TROTEC, + NIKAI, + RAW, // Technically not a protocol, but an encoding. + GLOBALCACHE, // Technically not a protocol, but an encoding. + TOSHIBA_AC, + FUJITSU_AC, + MIDEA, + MAGIQUEST, + LASERTAG, + CARRIER_AC, + HAIER_AC +}; + +// Message lengths & required repeat values +#define AIWA_RC_T501_BITS 15U +#define AIWA_RC_T501_MIN_REPEAT 1U +#define COOLIX_BITS 24U +#define CARRIER_AC_BITS 32U +#define CARRIER_AC_MIN_REPEAT 0U +// Daikin has a lot of static stuff that is discarded +#define DAIKIN_RAW_BITS 583U +#define DAIKIN_COMMAND_LENGTH 27U +#define DAIKIN_BITS (DAIKIN_COMMAND_LENGTH * 8) +#define DENON_BITS SHARP_BITS +#define DENON_48_BITS PANASONIC_BITS +#define DENON_LEGACY_BITS 14U +#define DISH_BITS 16U +#define DISH_MIN_REPEAT 3U +#define GREE_STATE_LENGTH 8U +#define GREE_BITS (GREE_STATE_LENGTH * 8) +#define HAIER_AC_STATE_LENGTH 9U +#define HAIER_AC_BITS (HAIER_AC_STATE_LENGTH * 8) +#define JVC_BITS 16U +#define KELVINATOR_STATE_LENGTH 16U +#define KELVINATOR_BITS (KELVINATOR_STATE_LENGTH * 8) +#define LG_BITS 28U +#define LG32_BITS 32U +#define MITSUBISHI_BITS 16U +// TODO(anyone): Verify that the Mitsubishi repeat is really needed. +#define MITSUBISHI_MIN_REPEAT 1U // Based on marcosamarinho's code. +#define MITSUBISHI_AC_STATE_LENGTH 18U +#define MITSUBISHI_AC_MIN_REPEAT 1U +#define FUJITSU_AC_MIN_REPEAT 0U +#define FUJITSU_AC_STATE_LENGTH 16U +#define FUJITSU_AC_STATE_LENGTH_SHORT 7U +#define FUJITSU_AC_BITS (FUJITSU_AC_STATE_LENGTH * 8) +#define FUJITSU_AC_MIN_BITS ((FUJITSU_AC_STATE_LENGTH_SHORT - 1) * 8) +#define NEC_BITS 32U +#define PANASONIC_BITS 48U +#define PANASONIC_MANUFACTURER 0x4004ULL +#define PRONTO_MIN_LENGTH 6U +#define RC5_RAW_BITS 14U +#define RC5_BITS RC5_RAW_BITS - 2U +#define RC5X_BITS RC5_RAW_BITS - 1U +#define RC6_MODE0_BITS 20U // Excludes the 'start' bit. +#define RC6_36_BITS 36U // Excludes the 'start' bit. +#define RCMM_BITS 24U +#define SAMSUNG_BITS 32U +#define SANYO_SA8650B_BITS 12U +#define SANYO_LC7461_ADDRESS_BITS 13U +#define SANYO_LC7461_COMMAND_BITS 8U +#define SANYO_LC7461_BITS ((SANYO_LC7461_ADDRESS_BITS + \ + SANYO_LC7461_COMMAND_BITS) * 2) +#define SHARP_ADDRESS_BITS 5U +#define SHARP_COMMAND_BITS 8U +#define SHARP_BITS (SHARP_ADDRESS_BITS + SHARP_COMMAND_BITS + 2) // 15U +#define SHERWOOD_BITS NEC_BITS +#define SHERWOOD_MIN_REPEAT 1U +#define SONY_12_BITS 12U +#define SONY_15_BITS 15U +#define SONY_20_BITS 20U +#define SONY_MIN_BITS SONY_12_BITS +#define SONY_MIN_REPEAT 2U +#define TOSHIBA_AC_STATE_LENGTH 9U +#define TOSHIBA_AC_BITS (TOSHIBA_AC_STATE_LENGTH * 8) +#define TOSHIBA_AC_MIN_REPEAT 1U +#define TROTEC_COMMAND_LENGTH 9U +#define WHYNTER_BITS 32U +#define ARGO_COMMAND_LENGTH 12U +#define NIKAI_BITS 24U +#define MAGIQUEST_BITS 56U +#define MIDEA_BITS 48U +#define MIDEA_MIN_REPEAT 0U +#define LASERTAG_BITS 13U +#define LASERTAG_MIN_REPEAT 0U + +// Turn on Debugging information by uncommenting the following line. +// #define DEBUG 1 + +#ifdef DEBUG +#ifdef UNIT_TEST +#define DPRINT(x) do { std::cout << x; } while (0) +#define DPRINTLN(x) do { std::cout << x << std::endl; } while (0) +#endif // UNIT_TEST +#ifdef ARDUINO +#define DPRINT(x) do { Serial.print(x); } while (0) +#define DPRINTLN(x) do { Serial.println(x); } while (0) +#endif // ARDUINO +#else // DEBUG +#define DPRINT(x) +#define DPRINTLN(x) +#endif // DEBUG + +#endif // IRREMOTEESP8266_H_ diff --git a/IRremoteESP8266/src/IRsend.cpp b/IRremoteESP8266/src/IRsend.cpp new file mode 100644 index 0000000..ba7f804 --- /dev/null +++ b/IRremoteESP8266/src/IRsend.cpp @@ -0,0 +1,491 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2015 Mark Szabo +// Copyright 2017 David Conran + +#include "IRsend.h" +#ifndef UNIT_TEST +#include +#else +#define __STDC_LIMIT_MACROS +#include +#endif +#include +#ifdef UNIT_TEST +#include +#endif +#include "IRtimer.h" + +// Originally from https://github.com/shirriff/Arduino-IRremote/ +// Updated by markszabo (https://github.com/markszabo/IRremoteESP8266) for +// sending IR code on ESP8266 + +// IRsend ---------------------------------------------------------------------- +// Create an IRsend object. +// +// Args: +// IRsendPin: Which GPIO pin to use when sending an IR command. +// inverted: *DANGER* Optional flag to invert the output. (default = false) +// e.g. LED is illuminated when GPIO is LOW rather than HIGH. +// Setting this to something other than the default could +// easily destroy your IR LED if you are overdriving it. +// Unless you *REALLY* know what you are doing, don't change this. +// Returns: +// An IRsend object. +IRsend::IRsend(uint16_t IRsendPin, bool inverted) : IRpin(IRsendPin), + periodOffset(PERIOD_OFFSET) { + if (inverted) { + outputOn = LOW; + outputOff = HIGH; + } else { + outputOn = HIGH; + outputOff = LOW; + } +} + +// Enable the pin for output. +void IRsend::begin() { +#ifndef UNIT_TEST + pinMode(IRpin, OUTPUT); +#endif + ledOff(); // Ensure the LED is in a known safe state when we start. +} + +// Turn off the IR LED. +void IRsend::ledOff() { +#ifndef UNIT_TEST + digitalWrite(IRpin, outputOff); +#endif +} + +// Calculate the period for a given frequency. (T = 1/f) +// +// Args: +// freq: Frequency in Hz. +// use_offset: Should we use the calculated offset or not? +// Returns: +// nr. of uSeconds. +uint32_t IRsend::calcUSecPeriod(uint32_t hz, bool use_offset) { + if (hz == 0) hz = 1; // Avoid Zero hz. Divide by Zero is nasty. + uint32_t period = (1000000UL + hz/2) / hz; // The equiv of round(1000000/hz). + // Apply the offset and ensure we don't result in a <= 0 value. + if (use_offset) + return std::max((uint32_t) 1, period + periodOffset); + else + return std::max((uint32_t) 1, period); +} + +// Set the output frequency modulation and duty cycle. +// +// Args: +// freq: The freq we want to modulate at. Assumes < 1000 means kHz else Hz. +// duty: Percentage duty cycle of the LED. e.g. 25 = 25% = 1/4 on, 3/4 off. +// +// Note: +// Integer timing functions & math mean we can't do fractions of +// microseconds timing. Thus minor changes to the freq & duty values may have +// limited effect. You've been warned. +void IRsend::enableIROut(uint32_t freq, uint8_t duty) { + // Can't have more than 100% duty cycle. + duty = std::min(duty, (uint8_t) 100); + if (freq < 1000) // Were we given kHz? Supports the old call usage. + freq *= 1000; + uint32_t period = calcUSecPeriod(freq); + // Nr. of uSeconds the LED will be on per pulse. + onTimePeriod = (period * duty) / 100; + // Nr. of uSeconds the LED will be off per pulse. + offTimePeriod = period - onTimePeriod; +} + +// Modulate the IR LED for the given period (usec) and at the duty cycle set. +// +// Args: +// usec: The period of time to modulate the IR LED for, in microseconds. +// Returns: +// Nr. of pulses actually sent. +// +// Note: +// The ESP8266 has no good way to do hardware PWM, so we have to do it all +// in software. There is a horrible kludge/brilliant hack to use the second +// serial TX line to do fairly accurate hardware PWM, but it is only +// available on a single specific GPIO and only available on some modules. +// e.g. It's not available on the ESP-01 module. +// Hence, for greater compatibility & choice, we don't use that method. +// Ref: +// https://www.analysir.com/blog/2017/01/29/updated-esp8266-nodemcu-backdoor-upwm-hack-for-ir-signals/ +uint16_t IRsend::mark(uint16_t usec) { + uint16_t counter = 0; + IRtimer usecTimer = IRtimer(); + // Cache the time taken so far. This saves us calling time, and we can be + // assured that we can't have odd math problems. i.e. unsigned under/overflow. + uint32_t elapsed = usecTimer.elapsed(); + + while (elapsed < usec) { // Loop until we've met/exceeded our required time. +#ifndef UNIT_TEST + digitalWrite(IRpin, outputOn); // Turn the LED on. + // Calculate how long we should pulse on for. + // e.g. Are we to close to the end of our requested mark time (usec)? + delayMicroseconds(std::min((uint32_t) onTimePeriod, usec - elapsed)); + digitalWrite(IRpin, outputOff); // Turn the LED off. +#endif + counter++; + if (elapsed + onTimePeriod >= usec) + return counter; // LED is now off & we've passed our allotted time. + // Wait for the lesser of the rest of the duty cycle, or the time remaining. +#ifndef UNIT_TEST + delayMicroseconds(std::min(usec - elapsed - onTimePeriod, + (uint32_t) offTimePeriod)); +#endif + elapsed = usecTimer.elapsed(); // Update & recache the actual elapsed time. + } + return counter; +} + +// Turn the pin (LED) off for a given time. +// Sends an IR space for the specified number of microseconds. +// A space is no output, so the PWM output is disabled. +// +// Args: +// time: Time in microseconds (us). +void IRsend::space(uint32_t time) { + ledOff(); + if (time == 0) return; +#ifndef UNIT_TEST + // delayMicroseconds is only accurate to 16383us. + // Ref: https://www.arduino.cc/en/Reference/delayMicroseconds + if (time <= 16383) { + delayMicroseconds(time); + } else { + // Invoke a delay(), where possible, to avoid triggering the WDT. + delay(time / 1000UL); // Delay for as many whole milliseconds as we can. + // Delay the remaining sub-millisecond. + delayMicroseconds(static_cast(time % 1000UL)); + } +#endif +} + +// Calculate & set any offsets to account for execution times. +// +// Args: +// hz: The frequency to calibrate at >= 1000Hz. Default is 38000Hz. +// +// Status: ALPHA / Untested. +// +// NOTE: +// This will generate an 65535us mark() IR LED signal. +// This only needs to be called once, if at all. +void IRsend::calibrate(uint16_t hz) { + if (hz < 1000) // Were we given kHz? Supports the old call usage. + hz *= 1000; + periodOffset = 0; // Turn off any existing offset while we calibrate. + enableIROut(hz); + IRtimer usecTimer = IRtimer(); // Start a timer *just* before we do the call. + uint16_t pulses = mark(UINT16_MAX); // Generate a PWM of 65,535 us. (Max.) + uint32_t timeTaken = usecTimer.elapsed(); // Record the time it took. + // While it shouldn't be necessary, assume at least 1 pulse, to avoid a + // divide by 0 situation. + pulses = std::max(pulses, (uint16_t) 1U); + uint32_t calcPeriod = calcUSecPeriod(hz); // e.g. @38kHz it should be 26us. + // Assuming 38kHz for the example calculations: + // In a 65535us pulse, we should have 2520.5769 pulses @ 26us periods. + // e.g. 65535.0us / 26us = 2520.5769 + // This should have caused approx 2520 loops through the main loop in mark(). + // The average over that many interations should give us a reasonable + // approximation at what offset we need to use to account for instruction + // execution times. + // + // Calculate the actual period from the actual time & the actual pulses + // generated. + double_t actualPeriod = (double_t) timeTaken / (double_t) pulses; + // Store the difference between the actual time per period vs. calculated. + periodOffset = (int8_t) ((double_t) calcPeriod - actualPeriod); +} + +// Generic method for sending data that is common to most protocols. +// Will send leading or trailing 0's if the nbits is larger than the number +// of bits in data. +// +// Args: +// onemark: Nr. of usecs for the led to be pulsed for a '1' bit. +// onespace: Nr. of usecs for the led to be fully off for a '1' bit. +// zeromark: Nr. of usecs for the led to be pulsed for a '0' bit. +// zerospace: Nr. of usecs for the led to be fully off for a '0' bit. +// data: The data to be transmitted. +// nbits: Nr. of bits of data to be sent. +// MSBfirst: Flag for bit transmission order. Defaults to MSB->LSB order. +void IRsend::sendData(uint16_t onemark, uint32_t onespace, + uint16_t zeromark, uint32_t zerospace, + uint64_t data, uint16_t nbits, bool MSBfirst) { + if (nbits == 0) // If we are asked to send nothing, just return. + return; + if (MSBfirst) { // Send the MSB first. + // Send 0's until we get down to a bit size we can actually manage. + while (nbits > sizeof(data) * 8) { + mark(zeromark); + space(zerospace); + nbits--; + } + // Send the supplied data. + for (uint64_t mask = 1ULL << (nbits - 1); mask; mask >>= 1) + if (data & mask) { // Send a 1 + mark(onemark); + space(onespace); + } else { // Send a 0 + mark(zeromark); + space(zerospace); + } + } else { // Send the Least Significant Bit (LSB) first / MSB last. + for (uint16_t bit = 0; bit < nbits; bit++, data >>= 1) + if (data & 1) { // Send a 1 + mark(onemark); + space(onespace); + } else { // Send a 0 + mark(zeromark); + space(zerospace); + } + } +} + +// Generic method for sending simple protocol messages. +// Will send leading or trailing 0's if the nbits is larger than the number +// of bits in data. +// +// Args: +// headermark: Nr. of usecs for the led to be pulsed for the header mark. +// A value of 0 means no header mark. +// headerspace: Nr. of usecs for the led to be off after the header mark. +// A value of 0 means no header space. +// onemark: Nr. of usecs for the led to be pulsed for a '1' bit. +// onespace: Nr. of usecs for the led to be fully off for a '1' bit. +// zeromark: Nr. of usecs for the led to be pulsed for a '0' bit. +// zerospace: Nr. of usecs for the led to be fully off for a '0' bit. +// footermark: Nr. of usecs for the led to be pulsed for the footer mark. +// A value of 0 means no footer mark. +// gap: Nr. of usecs for the led to be off after the footer mark. +// This is effectively the gap between messages. +// A value of 0 means no gap space. +// data: The data to be transmitted. +// nbits: Nr. of bits of data to be sent. +// frequency: The frequency we want to modulate at. +// Assumes < 1000 means kHz otherwise it is in Hz. +// Most common value is 38000 or 38, for 38kHz. +// MSBfirst: Flag for bit transmission order. Defaults to MSB->LSB order. +// repeat: Nr. of extra times the message will be sent. +// e.g. 0 = 1 message sent, 1 = 1 initial + 1 repeat = 2 messages +// dutycycle: Percentage duty cycle of the LED. +// e.g. 25 = 25% = 1/4 on, 3/4 off. +// If you are not sure, try 50 percent. +void IRsend::sendGeneric(const uint16_t headermark, const uint32_t headerspace, + const uint16_t onemark, const uint32_t onespace, + const uint16_t zeromark, const uint32_t zerospace, + const uint16_t footermark, const uint32_t gap, + const uint64_t data, const uint16_t nbits, + const uint16_t frequency, const bool MSBfirst, + const uint16_t repeat, const uint8_t dutycycle) { + sendGeneric(headermark, headerspace, onemark, onespace, zeromark, zerospace, + footermark, gap, 0U, data, nbits, frequency, MSBfirst, repeat, + dutycycle); +} + +// Generic method for sending simple protocol messages. +// Will send leading or trailing 0's if the nbits is larger than the number +// of bits in data. +// +// Args: +// headermark: Nr. of usecs for the led to be pulsed for the header mark. +// A value of 0 means no header mark. +// headerspace: Nr. of usecs for the led to be off after the header mark. +// A value of 0 means no header space. +// onemark: Nr. of usecs for the led to be pulsed for a '1' bit. +// onespace: Nr. of usecs for the led to be fully off for a '1' bit. +// zeromark: Nr. of usecs for the led to be pulsed for a '0' bit. +// zerospace: Nr. of usecs for the led to be fully off for a '0' bit. +// footermark: Nr. of usecs for the led to be pulsed for the footer mark. +// A value of 0 means no footer mark. +// gap: Min. nr. of usecs for the led to be off after the footer mark. +// This is effectively the absolute minimum gap between messages. +// mesgtime: Min. nr. of usecs a single message needs to be. +// This is effectively the min. total length of a single message. +// data: The data to be transmitted. +// nbits: Nr. of bits of data to be sent. +// frequency: The frequency we want to modulate at. +// Assumes < 1000 means kHz otherwise it is in Hz. +// Most common value is 38000 or 38, for 38kHz. +// MSBfirst: Flag for bit transmission order. Defaults to MSB->LSB order. +// repeat: Nr. of extra times the message will be sent. +// e.g. 0 = 1 message sent, 1 = 1 initial + 1 repeat = 2 messages +// dutycycle: Percentage duty cycle of the LED. +// e.g. 25 = 25% = 1/4 on, 3/4 off. +// If you are not sure, try 50 percent. +void IRsend::sendGeneric(const uint16_t headermark, const uint32_t headerspace, + const uint16_t onemark, const uint32_t onespace, + const uint16_t zeromark, const uint32_t zerospace, + const uint16_t footermark, const uint32_t gap, + const uint32_t mesgtime, + const uint64_t data, const uint16_t nbits, + const uint16_t frequency, const bool MSBfirst, + const uint16_t repeat, const uint8_t dutycycle) { + // Setup + enableIROut(frequency, dutycycle); + IRtimer usecs = IRtimer(); + + // We always send a message, even for repeat=0, hence '<= repeat'. + for (uint16_t r = 0; r <= repeat; r++) { + usecs.reset(); + + // Header + if (headermark) mark(headermark); + if (headerspace) space(headerspace); + + // Data + sendData(onemark, onespace, zeromark, zerospace, data, nbits, MSBfirst); + + // Footer + if (footermark) mark(footermark); + uint32_t elapsed = usecs.elapsed(); + // Avoid potential unsigned integer underflow. e.g. when mesgtime is 0. + if (elapsed >= mesgtime) + space(gap); + else + space(std::max(gap, mesgtime - elapsed)); + } +} + +// Generic method for sending simple protocol messages. +// +// Args: +// headermark: Nr. of usecs for the led to be pulsed for the header mark. +// A value of 0 means no header mark. +// headerspace: Nr. of usecs for the led to be off after the header mark. +// A value of 0 means no header space. +// onemark: Nr. of usecs for the led to be pulsed for a '1' bit. +// onespace: Nr. of usecs for the led to be fully off for a '1' bit. +// zeromark: Nr. of usecs for the led to be pulsed for a '0' bit. +// zerospace: Nr. of usecs for the led to be fully off for a '0' bit. +// footermark: Nr. of usecs for the led to be pulsed for the footer mark. +// A value of 0 means no footer mark. +// gap: Nr. of usecs for the led to be off after the footer mark. +// This is effectively the gap between messages. +// A value of 0 means no gap space. +// dataptr: Pointer to the data to be transmitted. +// nbytes: Nr. of bytes of data to be sent. +// frequency: The frequency we want to modulate at. +// Assumes < 1000 means kHz otherwise it is in Hz. +// Most common value is 38000 or 38, for 38kHz. +// MSBfirst: Flag for bit transmission order. Defaults to MSB->LSB order. +// repeat: Nr. of extra times the message will be sent. +// e.g. 0 = 1 message sent, 1 = 1 initial + 1 repeat = 2 messages +// dutycycle: Percentage duty cycle of the LED. +// e.g. 25 = 25% = 1/4 on, 3/4 off. +// If you are not sure, try 50 percent. +void IRsend::sendGeneric(const uint16_t headermark, const uint32_t headerspace, + const uint16_t onemark, const uint32_t onespace, + const uint16_t zeromark, const uint32_t zerospace, + const uint16_t footermark, const uint32_t gap, + const uint8_t *dataptr, const uint16_t nbytes, + const uint16_t frequency, const bool MSBfirst, + const uint16_t repeat, const uint8_t dutycycle) { + // Setup + enableIROut(frequency, dutycycle); + // We always send a message, even for repeat=0, hence '<= repeat'. + for (uint16_t r = 0; r <= repeat; r++) { + // Header + if (headermark) mark(headermark); + if (headerspace) space(headerspace); + + // Data + for (uint16_t i = 0; i < nbytes; i++) + sendData(onemark, onespace, zeromark, zerospace, + *(dataptr + i), 8, MSBfirst); + + // Footer + if (footermark) mark(footermark); + space(gap); + } +} + +#if SEND_RAW +// Send a raw IRremote message. +// +// Args: +// buf: An array of uint16_t's that has microseconds elements. +// len: Nr. of elements in the buf[] array. +// hz: Frequency to send the message at. (kHz < 1000; Hz >= 1000) +// +// Status: STABLE / Known working. +// +// Notes: +// Even elements are Mark times (On), Odd elements are Space times (Off). +// +// Ref: +// examples/IRrecvDumpV2/IRrecvDumpV2.ino +void IRsend::sendRaw(uint16_t buf[], uint16_t len, uint16_t hz) { + // Set IR carrier frequency + enableIROut(hz); + for (uint16_t i = 0; i < len; i++) { + if (i & 1) { // Odd bit. + space(buf[i]); + } else { // Even bit. + mark(buf[i]); + } + } + ledOff(); // We potentially have ended with a mark(), so turn of the LED. +} +#endif // SEND_RAW + +#ifndef UNIT_TEST +void IRsend::send(uint16_t type, uint64_t data, uint16_t nbits) { + switch (type) { +#if SEND_NEC + case NEC: sendNEC(data, nbits); break; +#endif +#if SEND_SONY + case SONY: sendSony(data, nbits); break; +#endif +#if SEND_RC5 + case RC5: sendRC5(data, nbits); break; +#endif +#if SEND_RC6 + case RC6: sendRC6(data, nbits); break; +#endif +#if SEND_DISH + case DISH: sendDISH(data, nbits); break; +#endif +#if SEND_JVC + case JVC: sendJVC(data, nbits); break; +#endif +#if SEND_SAMSUNG + case SAMSUNG: sendSAMSUNG(data, nbits); break; +#endif +#if SEND_LG + case LG: sendLG(data, nbits); break; +#endif +#if SEND_WHYNTER + case WHYNTER: sendWhynter(data, nbits); break; +#endif +#if SEND_COOLIX + case COOLIX: sendCOOLIX(data, nbits); break; +#endif +#if SEND_DENON + case DENON: sendDenon(data, nbits); break; +#endif +#if SEND_SHERWOOD + case SHERWOOD: sendSherwood(data, nbits); break; +#endif +#if SEND_RCMM + case RCMM: sendRCMM(data, nbits); break; +#endif +#if SEND_MITSUBISHI + case MITSUBISHI: sendMitsubishi(data, nbits); break; +#endif +#if SEND_SHARP + case SHARP: sendSharpRaw(data, nbits); break; +#endif +#if SEND_AIWA_RC_T501 + case AIWA_RC_T501: sendAiwaRCT501(data, nbits); break; +#endif +#if SEND_MIDEA + case MIDEA: sendMidea(data, nbits); break; +#endif + } +} +#endif diff --git a/IRremoteESP8266/src/IRsend.h b/IRremoteESP8266/src/IRsend.h new file mode 100644 index 0000000..20995a5 --- /dev/null +++ b/IRremoteESP8266/src/IRsend.h @@ -0,0 +1,259 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2015 Mark Szabo +// Copyright 2017 David Conran +#ifndef IRSEND_H_ +#define IRSEND_H_ + +#define __STDC_LIMIT_MACROS +#include +#include "IRremoteESP8266.h" + +// Originally from https://github.com/shirriff/Arduino-IRremote/ +// Updated by markszabo (https://github.com/markszabo/IRremoteESP8266) for +// sending IR code on ESP8266 + +#if TEST || UNIT_TEST +#define VIRTUAL virtual +#else +#define VIRTUAL +#endif + +// Constants +// Offset (in microseconds) to use in Period time calculations to account for +// code excution time in producing the software PWM signal. +// Value determined in https://github.com/markszabo/IRremoteESP8266/issues/62 +#define PERIOD_OFFSET -3 +#define DUTY_DEFAULT 50 + +// Classes +class IRsend { + public: + explicit IRsend(uint16_t IRsendPin, bool inverted = false); + void begin(); + void enableIROut(uint32_t freq, uint8_t duty = DUTY_DEFAULT); + VIRTUAL uint16_t mark(uint16_t usec); + VIRTUAL void space(uint32_t usec); + void calibrate(uint16_t hz = 38000U); + void sendRaw(uint16_t buf[], uint16_t len, uint16_t hz); + void sendData(uint16_t onemark, uint32_t onespace, uint16_t zeromark, + uint32_t zerospace, uint64_t data, uint16_t nbits, + bool MSBfirst = true); + void sendGeneric(const uint16_t headermark, const uint32_t headerspace, + const uint16_t onemark, const uint32_t onespace, + const uint16_t zeromark, const uint32_t zerospace, + const uint16_t footermark, const uint32_t gap, + const uint64_t data, const uint16_t nbits, + const uint16_t frequency, const bool MSBfirst, + const uint16_t repeat, const uint8_t dutycycle); + void sendGeneric(const uint16_t headermark, const uint32_t headerspace, + const uint16_t onemark, const uint32_t onespace, + const uint16_t zeromark, const uint32_t zerospace, + const uint16_t footermark, const uint32_t gap, + const uint32_t mesgtime, + const uint64_t data, const uint16_t nbits, + const uint16_t frequency, const bool MSBfirst, + const uint16_t repeat, const uint8_t dutycycle); + void sendGeneric(const uint16_t headermark, const uint32_t headerspace, + const uint16_t onemark, const uint32_t onespace, + const uint16_t zeromark, const uint32_t zerospace, + const uint16_t footermark, const uint32_t gap, + const uint8_t *dataptr, const uint16_t nbytes, + const uint16_t frequency, const bool MSBfirst, + const uint16_t repeat, const uint8_t dutycycle); +void send(uint16_t type, uint64_t data, uint16_t nbits); +#if (SEND_NEC || SEND_SHERWOOD || SEND_AIWA_RC_T501 || SEND_SANYO) + void sendNEC(uint64_t data, uint16_t nbits = NEC_BITS, uint16_t repeat = 0); + uint32_t encodeNEC(uint16_t address, uint16_t command); +#endif +#if SEND_SONY + // sendSony() should typically be called with repeat=2 as Sony devices + // expect the code to be sent at least 3 times. (code + 2 repeats = 3 codes) + // Legacy use of this procedure was to only send a single code so call it with + // repeat=0 for backward compatibility. As of v2.0 it defaults to sending + // a Sony command that will be accepted be a device. + void sendSony(uint64_t data, uint16_t nbits = SONY_20_BITS, + uint16_t repeat = SONY_MIN_REPEAT); + uint32_t encodeSony(uint16_t nbits, uint16_t command, uint16_t address, + uint16_t extended = 0); +#endif +#if SEND_SHERWOOD + void sendSherwood(uint64_t data, uint16_t nbits = SHERWOOD_BITS, + uint16_t repeat = SHERWOOD_MIN_REPEAT); +#endif +#if SEND_SAMSUNG + void sendSAMSUNG(uint64_t data, uint16_t nbits = SAMSUNG_BITS, + uint16_t repeat = 0); + uint32_t encodeSAMSUNG(uint8_t customer, uint8_t command); +#endif +#if SEND_LG + void sendLG(uint64_t data, uint16_t nbits = LG_BITS, uint16_t repeat = 0); + uint32_t encodeLG(uint16_t address, uint16_t command); +#endif +#if (SEND_SHARP || SEND_DENON) + uint32_t encodeSharp(uint16_t address, uint16_t command, + uint16_t expansion = 1, uint16_t check = 0, + bool MSBfirst = false); + void sendSharp(uint16_t address, uint16_t command, + uint16_t nbits = SHARP_BITS, uint16_t repeat = 0); + void sendSharpRaw(uint64_t data, uint16_t nbits = SHARP_BITS, + uint16_t repeat = 0); +#endif +#if SEND_JVC + void sendJVC(uint64_t data, uint16_t nbits = JVC_BITS, uint16_t repeat = 0); + uint16_t encodeJVC(uint8_t address, uint8_t command); +#endif +#if SEND_DENON + void sendDenon(uint64_t data, uint16_t nbits = DENON_BITS, + uint16_t repeat = 0); +#endif +#if SEND_SANYO + uint64_t encodeSanyoLC7461(uint16_t address, uint8_t command); + void sendSanyoLC7461(uint64_t data, uint16_t nbits = SANYO_LC7461_BITS, + uint16_t repeat = 0); +#endif +#if SEND_DISH + // sendDISH() should typically be called with repeat=3 as DISH devices + // expect the code to be sent at least 4 times. (code + 3 repeats = 4 codes) + // Legacy use of this procedure was only to send a single code + // so use repeat=0 for backward compatibility. + void sendDISH(uint64_t data, uint16_t nbits = DISH_BITS, + uint16_t repeat = DISH_MIN_REPEAT); +#endif +#if (SEND_PANASONIC || SEND_DENON) + void sendPanasonic64(uint64_t data, uint16_t nbits = PANASONIC_BITS, + uint16_t repeat = 0); + void sendPanasonic(uint16_t address, uint32_t data, + uint16_t nbits = PANASONIC_BITS, uint16_t repeat = 0); + uint64_t encodePanasonic(uint16_t manufacturer, uint8_t device, + uint8_t subdevice, uint8_t function); +#endif +#if SEND_RC5 + void sendRC5(uint64_t data, uint16_t nbits = RC5X_BITS, uint16_t repeat = 0); + uint16_t encodeRC5(uint8_t address, uint8_t command, + bool key_released = false); + uint16_t encodeRC5X(uint8_t address, uint8_t command, + bool key_released = false); + uint64_t toggleRC5(uint64_t data); +#endif +#if SEND_RC6 + void sendRC6(uint64_t data, uint16_t nbits = RC6_MODE0_BITS, + uint16_t repeat = 0); + uint64_t encodeRC6(uint32_t address, uint8_t command, + uint16_t mode = RC6_MODE0_BITS); + uint64_t toggleRC6(uint64_t data, uint16_t nbits = RC6_MODE0_BITS); +#endif +#if SEND_RCMM + void sendRCMM(uint64_t data, uint16_t nbits = RCMM_BITS, uint16_t repeat = 0); +#endif +#if SEND_COOLIX + void sendCOOLIX(uint64_t data, uint16_t nbits = COOLIX_BITS, + uint16_t repeat = 0); +#endif +#if SEND_WHYNTER + void sendWhynter(uint64_t data, uint16_t nbits = WHYNTER_BITS, + uint16_t repeat = 0); +#endif +#if SEND_MITSUBISHI + void sendMitsubishi(uint64_t data, uint16_t nbits = MITSUBISHI_BITS, + uint16_t repeat = MITSUBISHI_MIN_REPEAT); +#endif +#if SEND_MITSUBISHI_AC + void sendMitsubishiAC(unsigned char data[], + uint16_t nbytes = MITSUBISHI_AC_STATE_LENGTH, + uint16_t repeat = MITSUBISHI_AC_MIN_REPEAT); +#endif +#if SEND_FUJITSU_AC + void sendFujitsuAC(unsigned char data[], + uint16_t nbytes, + uint16_t repeat = FUJITSU_AC_MIN_REPEAT); +#endif +#if SEND_GLOBALCACHE + void sendGC(uint16_t buf[], uint16_t len); +#endif +#if SEND_KELVINATOR + void sendKelvinator(unsigned char data[], + uint16_t nbytes = KELVINATOR_STATE_LENGTH, + uint16_t repeat = 0); +#endif +#if SEND_DAIKIN + void sendDaikin(unsigned char data[], + uint16_t nbytes = DAIKIN_COMMAND_LENGTH, + uint16_t repeat = 0); + void sendDaikinGapHeader(); +#endif +#if SEND_AIWA_RC_T501 + void sendAiwaRCT501(uint64_t data, uint16_t nbits = AIWA_RC_T501_BITS, + uint16_t repeat = AIWA_RC_T501_MIN_REPEAT); +#endif +#if SEND_GREE + void sendGree(uint64_t data, uint16_t nbits = GREE_BITS, uint16_t repeat = 0); + void sendGree(uint8_t data[], uint16_t nbytes = GREE_STATE_LENGTH, + uint16_t repeat = 0); +#endif +#if SEND_PRONTO + void sendPronto(uint16_t data[], uint16_t len, uint16_t repeat = 0); +#endif +#if SEND_ARGO + void sendArgo(unsigned char data[], + uint16_t nbytes = ARGO_COMMAND_LENGTH, + uint16_t repeat = 0); +#endif +#if SEND_TROTEC + void sendTrotec(unsigned char data[], + uint16_t nbytes = TROTEC_COMMAND_LENGTH, + uint16_t repeat = 0); +#endif +#if SEND_NIKAI + void sendNikai(uint64_t data, uint16_t nbits = NIKAI_BITS, + uint16_t repeat = 0); +#endif +#if SEND_TOSHIBA_AC + void sendToshibaAC(unsigned char data[], + uint16_t nbytes = TOSHIBA_AC_STATE_LENGTH, + uint16_t repeat = TOSHIBA_AC_MIN_REPEAT); +#endif +#if SEND_MIDEA + void sendMidea(uint64_t data, uint16_t nbits = MIDEA_BITS, + uint16_t repeat = MIDEA_MIN_REPEAT); +#endif +#if SEND_MAGIQUEST + void sendMagiQuest(uint64_t data, uint16_t nbits = MAGIQUEST_BITS, + uint16_t repeat = 0); + uint64_t encodeMagiQuest(uint32_t wand_id, uint16_t magnitude); +#endif +#if SEND_LASERTAG + void sendLasertag(uint64_t data, uint16_t nbits = LASERTAG_BITS, + uint16_t repeat = LASERTAG_MIN_REPEAT); +#endif +#if SEND_CARRIER_AC + void sendCarrierAC(uint64_t data, uint16_t nbits = CARRIER_AC_BITS, + uint16_t repeat = CARRIER_AC_MIN_REPEAT); +#endif +#if SEND_HAIER_AC + void sendHaierAC(unsigned char data[], + uint16_t nbytes = HAIER_AC_STATE_LENGTH, + uint16_t repeat = 0); +#endif + + protected: +#ifdef UNIT_TEST +#ifndef HIGH +#define HIGH 0x1 +#endif +#ifndef LOW +#define LOW 0x0 +#endif +#endif // UNIT_TEST + uint8_t outputOn; + uint8_t outputOff; + + private: + uint16_t onTimePeriod; + uint16_t offTimePeriod; + uint16_t IRpin; + int8_t periodOffset; + void ledOff(); + uint32_t calcUSecPeriod(uint32_t hz, bool use_offset = true); +}; + +#endif // IRSEND_H_ diff --git a/IRremoteESP8266/src/IRtimer.cpp b/IRremoteESP8266/src/IRtimer.cpp new file mode 100644 index 0000000..cf980e7 --- /dev/null +++ b/IRremoteESP8266/src/IRtimer.cpp @@ -0,0 +1,45 @@ +// Copyright 2017 David Conran + +#include "IRtimer.h" +#ifndef UNIT_TEST +#include +#endif + +#ifdef UNIT_TEST +// Used to help simulate elapsed time in unit tests. +extern uint32_t _IRtimer_unittest_now; +#endif // UNIT_TEST + +// This class performs a simple time in useconds since instantiated. +// Handles when the system timer wraps around (once). + +IRtimer::IRtimer() { + reset(); +} + +void IRtimer::reset() { +#ifndef UNIT_TEST + start = micros(); +#else + start = _IRtimer_unittest_now; +#endif +} + +uint32_t IRtimer::elapsed() { +#ifndef UNIT_TEST + uint32_t now = micros(); +#else + uint32_t now = _IRtimer_unittest_now; +#endif + if (start <= now) // Check if the system timer has wrapped. + return now - start; // No wrap. + else + return UINT32_MAX - start + now; // Has wrapped. +} + +// Only used in unit testing. +void IRtimer::add(uint32_t usecs) { +#ifdef UNIT_TEST + _IRtimer_unittest_now += usecs; +#endif // UNIT_TEST +} diff --git a/IRremoteESP8266/src/IRtimer.h b/IRremoteESP8266/src/IRtimer.h new file mode 100644 index 0000000..79f6c22 --- /dev/null +++ b/IRremoteESP8266/src/IRtimer.h @@ -0,0 +1,21 @@ +// Copyright 2017 David Conran + +#ifndef IRTIMER_H_ +#define IRTIMER_H_ + +#define __STDC_LIMIT_MACROS +#include + +// Classes +class IRtimer { + public: + IRtimer(); + void reset(); + uint32_t elapsed(); + static void add(uint32_t usecs); + + private: + uint32_t start; +}; + +#endif // IRTIMER_H_ diff --git a/IRremoteESP8266/src/IRutils.cpp b/IRremoteESP8266/src/IRutils.cpp new file mode 100644 index 0000000..bdbecab --- /dev/null +++ b/IRremoteESP8266/src/IRutils.cpp @@ -0,0 +1,331 @@ +// Copyright 2017 David Conran + +#include "IRutils.h" +#ifndef UNIT_TEST +#include +#endif + +#define __STDC_LIMIT_MACROS +#include +#include +#ifndef ARDUINO +#include +#endif +#include "IRrecv.h" +#include "IRremoteESP8266.h" + +// Reverse the order of the requested least significant nr. of bits. +// Args: +// input: Bit pattern/integer to reverse. +// nbits: Nr. of bits to reverse. +// Returns: +// The reversed bit pattern. +uint64_t reverseBits(uint64_t input, uint16_t nbits) { + if (nbits <= 1) + return input; // Reversing <= 1 bits makes no change at all. + // Cap the nr. of bits to rotate to the max nr. of bits in the input. + nbits = std::min(nbits, (uint16_t) (sizeof(input) * 8)); + uint64_t output = 0; + for (uint16_t i = 0; i < nbits; i++) { + output <<= 1; + output |= (input & 1); + input >>= 1; + } + // Merge any remaining unreversed bits back to the top of the reversed bits. + return (input << nbits) | output; +} + +// Convert a uint64_t (unsigned long long) to a string. +// Arduino String/toInt/Serial.print() can't handle printing 64 bit values. +// +// Args: +// input: The value to print +// base: The output base. +// Returns: +// A string representation of the integer. +// Note: Based on Arduino's Print::printNumber() +#ifdef ARDUINO // Arduino's & C++'s string implementations can't co-exist. +String uint64ToString(uint64_t input, uint8_t base) { + String result = ""; +#else +std::string uint64ToString(uint64_t input, uint8_t base) { + std::string result = ""; +#endif + // prevent issues if called with base <= 1 + if (base < 2) base = 10; + // Check we have a base that we can actually print. + // i.e. [0-9A-Z] == 36 + if (base > 36) base = 10; + + do { + char c = input % base; + input /= base; + + if (c < 10) + c +='0'; + else + c += 'A' - 10; + result = c + result; + } while (input); + return result; +} + +#ifdef ARDUINO +// Print a uint64_t/unsigned long long to the Serial port +// Serial.print() can't handle printing long longs. (uint64_t) +// +// Args: +// input: The value to print +// base: The output base. +void serialPrintUint64(uint64_t input, uint8_t base) { + Serial.print(uint64ToString(input, base)); +} +#endif + +// Convert a protocol type (enum etc) to a human readable string. +// Args: +// protocol: Nr. (enum) of the protocol. +// isRepeat: A flag indicating if it is a repeat message of the protocol. +// Returns: +// A string containing the protocol name. +#ifdef ARDUINO // Arduino's & C++'s string implementations can't co-exist. +String typeToString(const decode_type_t protocol, const bool isRepeat) { + String result = ""; +#else +std::string typeToString(const decode_type_t protocol, + const bool isRepeat) { + std::string result = ""; +#endif + switch (protocol) { + default: + case UNKNOWN: result = "UNKNOWN"; break; + case UNUSED: result = "UNUSED"; break; + case AIWA_RC_T501: result = "AIWA_RC_T501"; break; + case ARGO: result = "ARGO"; break; + case CARRIER_AC: result = "CARRIER_AC"; break; + case COOLIX: result = "COOLIX"; break; + case DAIKIN: result = "DAIKIN"; break; + case DENON: result = "DENON"; break; + case DISH: result = "DISH"; break; + case FUJITSU_AC: result = "FUJITSU_AC"; break; + case GLOBALCACHE: result = "GLOBALCACHE"; break; + case GREE: result = "GREE"; break; + case HAIER_AC: result = "HAIER_AC"; break; + case JVC: result = "JVC"; break; + case KELVINATOR: result = "KELVINATOR"; break; + case LG: result = "LG"; break; + case LASERTAG: result = "LASERTAG"; break; + case MAGIQUEST: result = "MAGIQUEST"; break; + case MIDEA: result = "MIDEA"; break; + case MITSUBISHI: result = "MITSUBISHI"; break; + case MITSUBISHI_AC: result = "MITSUBISHI_AC"; break; + case NEC: result = "NEC"; break; + case NEC_LIKE: result = "NEC (non-strict)"; break; + case NIKAI: result = "NIKAI"; break; + case PANASONIC: result = "PANASONIC"; break; + case PRONTO: result = "PRONTO"; break; + case RAW: result = "RAW"; break; + case RC5: result = "RC5"; break; + case RC5X: result = "RC5X"; break; + case RC6: result = "RC6"; break; + case RCMM: result = "RCMM"; break; + case SAMSUNG: result = "SAMSUNG"; break; + case SANYO: result = "SANYO"; break; + case SANYO_LC7461: result = "SANYO_LC7461"; break; + case SHARP: result = "SHARP"; break; + case SHERWOOD: result = "SHERWOOD"; break; + case SONY: result = "SONY"; break; + case TOSHIBA_AC: result = "TOSHIBA_AC"; break; + case TROTEC: result = "TROTEC"; break; + case WHYNTER: result = "WHYNTER"; break; + } + if (isRepeat) result += " (Repeat)"; + return result; +} + +// Does the given protocol use a complex state as part of the decode? +bool hasACState(const decode_type_t protocol) { + switch (protocol) { + case DAIKIN: + case FUJITSU_AC: + case GREE: + case HAIER_AC: + case KELVINATOR: + case TOSHIBA_AC: + return true; + default: + return false; + } +} + +// Return the corrected length of a 'raw' format array structure +// after over-large values are converted into multiple entries. +// Args: +// results: A ptr to a decode result. +// Returns: +// A uint16_t containing the length. +uint16_t getCorrectedRawLength(const decode_results *results) { + uint16_t extended_length = results->rawlen - 1; + for (uint16_t i = 0; i < results->rawlen - 1; i++) { + uint32_t usecs = results->rawbuf[i] * RAWTICK; + // Add two extra entries for multiple larger than UINT16_MAX it is. + extended_length += (usecs / (UINT16_MAX + 1)) * 2; + } + return extended_length; +} + +// Return a string containing the key values of a decode_results structure +// in a C/C++ code style format. +#ifdef ARDUINO +String resultToSourceCode(const decode_results *results) { + String output = ""; +#else +std::string resultToSourceCode(const decode_results *results) { + std::string output = ""; +#endif + // Start declaration + output += "uint16_t "; // variable type + output += "rawData["; // array name + output += uint64ToString(getCorrectedRawLength(results), 10); + // array size + output += "] = {"; // Start declaration + + // Dump data + for (uint16_t i = 1; i < results->rawlen; i++) { + uint32_t usecs; + for (usecs = results->rawbuf[i] * RAWTICK; + usecs > UINT16_MAX; + usecs -= UINT16_MAX) { + output += uint64ToString(UINT16_MAX); + if (i % 2) + output += ", 0, "; + else + output += ", 0, "; + } + output += uint64ToString(usecs, 10); + if (i < results->rawlen - 1) + output += ", "; // ',' not needed on the last one + if (i % 2 == 0) output += " "; // Extra if it was even. + } + + // End declaration + output +="};"; + + // Comment + output += " // " + typeToString(results->decode_type, results->repeat); + // Only display the value if the decode type doesn't have an A/C state. + if (!hasACState(results->decode_type)) + output += " " + uint64ToString(results->value, 16); + output += "\n"; + + // Now dump "known" codes + if (results->decode_type != UNKNOWN) { + if (hasACState(results->decode_type)) { +#if DECODE_AC + uint16_t nbytes = results->bits / 8; + output += "uint8_t state[" + uint64ToString(nbytes) + "] = {"; + for (uint16_t i = 0; i < nbytes; i++) { + output += "0x"; + if (results->state[i] < 0x10) output += "0"; + output += uint64ToString(results->state[i], 16); + if (i < nbytes - 1) + output += ", "; + } + output += "};\n"; +#endif // DECODE_AC + } else { + // Simple protocols + // Some protocols have an address &/or command. + // NOTE: It will ignore the atypical case when a message has been + // decoded but the address & the command are both 0. + if (results->address > 0 || results->command > 0) { + output += "uint32_t address = 0x" + + uint64ToString(results->address, 16) + ";\n"; + output += "uint32_t command = 0x" + + uint64ToString(results->command, 16) + ";\n"; + } + // Most protocols have data + output += "uint64_t data = 0x" + uint64ToString(results->value, 16) + + ";\n"; + } + } + return output; +} + +// Dump out the decode_results structure. +// +#ifdef ARDUINO +String resultToTimingInfo(const decode_results *results) { + String output = ""; + String value = ""; +#else +std::string resultToTimingInfo(const decode_results *results) { + std::string output = ""; + std::string value = ""; +#endif + output += "Raw Timing[" + uint64ToString(results->rawlen - 1, 10) + "]:\n"; + + for (uint16_t i = 1; i < results->rawlen; i++) { + if (i % 2 == 0) + output += "-"; // even + else + output += " +"; // odd + value = uint64ToString(results->rawbuf[i] * RAWTICK); + // Space pad the value till it is at least 6 chars long. + while (value.length() < 6) + value = " " + value; + output += value; + if (i < results->rawlen - 1) + output += ", "; // ',' not needed for last one + if (!(i % 8)) output += "\n"; // Newline every 8 entries. + } + output += "\n"; + return output; +} + +// Dump out the decode_results structure. +// +#ifdef ARDUINO +String resultToHumanReadableBasic(const decode_results *results) { + String output = ""; +#else +std::string resultToHumanReadableBasic(const decode_results *results) { + std::string output = ""; +#endif + // Show Encoding standard + output += "Encoding : " + + typeToString(results->decode_type, results->repeat) + "\n"; + + // Show Code & length + output += "Code : "; + if (hasACState(results->decode_type)) { +#if DECODE_AC + for (uint16_t i = 0; results->bits > i * 8; i++) { + if (results->state[i] < 0x10) output += "0"; // Zero pad + output += uint64ToString(results->state[i], 16); + } +#endif // DECODE_AC + } else { + output += uint64ToString(results->value, 16); + } + output += " (" + uint64ToString(results->bits) + " bits)\n"; + return output; +} + +uint8_t sumBytes(uint8_t *start, const uint16_t length, const uint8_t init) { + uint8_t checksum = init; + uint8_t *ptr; + for (ptr = start; ptr - start < length; ptr++) + checksum += *ptr; + return checksum; +} + +uint64_t invertBits(const uint64_t data, const uint16_t nbits) { + // No change if we are asked to invert no bits. + if (nbits == 0) return data; + uint64_t result = ~data; + // If we are asked to invert all the bits or more than we have, it's simple. + if (nbits >= sizeof(data) * 8) return result; + // Mask off any unwanted bits and return the result. + return (result & ((1ULL << nbits) - 1)); +} diff --git a/IRremoteESP8266/src/IRutils.h b/IRremoteESP8266/src/IRutils.h new file mode 100644 index 0000000..3da62df --- /dev/null +++ b/IRremoteESP8266/src/IRutils.h @@ -0,0 +1,39 @@ +#ifndef IRUTILS_H_ +#define IRUTILS_H_ + +// Copyright 2017 David Conran + +#ifndef UNIT_TEST +#include +#endif +#define __STDC_LIMIT_MACROS +#include +#ifndef ARDUINO +#include +#endif +#include "IRremoteESP8266.h" +#include "IRrecv.h" + +uint64_t reverseBits(uint64_t input, uint16_t nbits); +#ifdef ARDUINO // Arduino's & C++'s string implementations can't co-exist. +String uint64ToString(uint64_t input, uint8_t base = 10); +String typeToString(const decode_type_t protocol, + const bool isRepeat = false); +void serialPrintUint64(uint64_t input, uint8_t base = 10); +String resultToSourceCode(const decode_results *results); +String resultToTimingInfo(const decode_results *results); +String resultToHumanReadableBasic(const decode_results *results); +#else +std::string uint64ToString(uint64_t input, uint8_t base = 10); +std::string typeToString(const decode_type_t protocol, + const bool isRepeat = false); +std::string resultToSourceCode(const decode_results *results); +std::string resultToTimingInfo(const decode_results *results); +std::string resultToHumanReadableBasic(const decode_results *results); +#endif +bool hasACState(const decode_type_t protocol); +uint16_t getCorrectedRawLength(const decode_results *results); +uint8_t sumBytes(uint8_t *start, const uint16_t length, const uint8_t init = 0); +uint64_t invertBits(const uint64_t data, const uint16_t nbits); + +#endif // IRUTILS_H_ diff --git a/IRremoteESP8266/src/ir_Aiwa.cpp b/IRremoteESP8266/src/ir_Aiwa.cpp new file mode 100644 index 0000000..6863caa --- /dev/null +++ b/IRremoteESP8266/src/ir_Aiwa.cpp @@ -0,0 +1,117 @@ +// Copyright 2017 David Conran + +#include "IRrecv.h" +#include "IRsend.h" + +// AAA IIIII W W AAA +// A A I W W A A +// AAAAA I W W W AAAAA +// A A I W W W A A +// A A IIIII WWW A A + +// Based off the RC-T501 RCU +// Added by David Conran. (Inspired by IRremoteESP8266's implementation: +// https://github.com/z3t0/Arduino-IRremote) + +#define AIWA_RC_T501_PRE_BITS 26U +#define AIWA_RC_T501_POST_BITS 1U +// NOTE: These are the compliment (inverted) of lirc values as +// lirc uses a '0' for a mark, and a '1' for a space. +#define AIWA_RC_T501_PRE_DATA 0x1D8113FULL // 26-bits +#define AIWA_RC_T501_POST_DATA 1ULL + +#if SEND_AIWA_RC_T501 +// Send an Aiwa RC T501 formatted message. +// +// Args: +// data: The message to be sent. +// nbits: The number of bits of the message to be sent. +// Typically AIWA_RC_T501_BITS. Max is 37 = (64 - 27) +// repeat: The number of times the command is to be repeated. +// +// Status: BETA / Should work. +// +// Ref: +// http://lirc.sourceforge.net/remotes/aiwa/RC-T501 +void IRsend::sendAiwaRCT501(uint64_t data, uint16_t nbits, uint16_t repeat) { + // Appears to be an extended NEC1 protocol. i.e. 42 bits instead of 32 bits. + // So use sendNEC instead, however the twist is it has a fixed 26 bit + // prefix, and a fixed postfix bit. + uint64_t new_data = ( + (AIWA_RC_T501_PRE_DATA << (nbits + AIWA_RC_T501_POST_BITS)) | + (data << AIWA_RC_T501_POST_BITS) | AIWA_RC_T501_POST_DATA); + nbits += AIWA_RC_T501_PRE_BITS + AIWA_RC_T501_POST_BITS; + if (nbits > sizeof(new_data) * 8) + return; // We are overflowing. Abort, and don't send. + sendNEC(new_data, nbits, repeat); +} +#endif + +#if DECODE_AIWA_RC_T501 +// Decode the supplied Aiwa RC T501 message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. Typically AIWA_RC_T501_BITS. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / Should work. +// +// Notes: +// Aiwa RC T501 appears to be a 42 bit variant of the NEC1 protocol. +// However, we historically (original Arduino IRremote project) treats it as +// a 15 bit (data) protocol. So, we expect nbits to typically be 15, and we +// will remove the prefix and postfix from the raw data, and use that as +// the result. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/nec.php +bool IRrecv::decodeAiwaRCT501(decode_results *results, uint16_t nbits, + bool strict) { + // Compliance + if (strict && nbits != AIWA_RC_T501_BITS) + return false; // Doesn't match our protocol defn. + + // Add on the pre & post bits to our requested bit length. + uint16_t expected_nbits = nbits + AIWA_RC_T501_PRE_BITS + + AIWA_RC_T501_POST_BITS; + uint64_t new_data; + if (expected_nbits > sizeof(new_data) * 8) + return false; // We can't possibly match something that big. + // Decode it as a much bigger (non-standard) NEC message, so we have to turn + // off strict mode checking for NEC. + if (!decodeNEC(results, expected_nbits, false)) + return false; // The NEC decode had a problem, so we should too. + uint16_t actual_bits = results->bits; + new_data = results->value; + if (actual_bits < expected_nbits) + return false; // The data we caught was undersized. Throw it back. + if ((new_data & 0x1ULL) != AIWA_RC_T501_POST_DATA) + return false; // The post data doesn't match, so it can't be this protocol. + // Trim off the post data bit. + new_data >>= AIWA_RC_T501_POST_BITS; + actual_bits -= AIWA_RC_T501_POST_BITS; + + // Extract out our likely new value and put it back in the results. + actual_bits -= AIWA_RC_T501_PRE_BITS; + results->value = new_data & ((1ULL << actual_bits) - 1); + + // Check the prefix data matches. + new_data >>= actual_bits; // Trim off the new data to expose the prefix. + if (new_data != AIWA_RC_T501_PRE_DATA) // Check the prefix. + return false; + + // Compliance + if (strict && results->bits != expected_nbits) + return false; + + // Success + results->decode_type = AIWA_RC_T501; + results->bits = actual_bits; + results->address = 0; + results->command = 0; + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Argo.cpp b/IRremoteESP8266/src/ir_Argo.cpp new file mode 100644 index 0000000..eaa1c51 --- /dev/null +++ b/IRremoteESP8266/src/ir_Argo.cpp @@ -0,0 +1,256 @@ +/* +Node MCU/ESP8266 Sketch to emulate Argo Ulisse 13 DCI remote +Controls Argo Ulisse 13 DCI A/C +Copyright 2017 Schmolders +*/ + +#include "ir_Argo.h" +#include +#include "IRremoteESP8266.h" +#include "IRutils.h" + +// Constants +// using SPACE modulation. MARK is always const 400u +#define ARGO_HDR_MARK 6400U // Mark +#define ARGO_HDR_SPACE 3300U // Space +#define ARGO_BIT_MARK 400U +#define ARGO_ONE_SPACE 2200U +#define ARGO_ZERO_SPACE 900U + +#if SEND_ARGO +// Send an Argo A/C message. +// +// Args: +// data: An array of ARGO_COMMAND_LENGTH bytes containing the IR command. +// +// Status: ALPHA / Untested. + +void IRsend::sendArgo(unsigned char data[], uint16_t nbytes, uint16_t repeat) { + // Check if we have enough bytes to send a proper message. + if (nbytes < ARGO_COMMAND_LENGTH) return; + // TODO(kaschmo): validate + sendGeneric(ARGO_HDR_MARK, ARGO_HDR_SPACE, + ARGO_BIT_MARK, ARGO_ONE_SPACE, + ARGO_BIT_MARK, ARGO_ZERO_SPACE, + 0, 0, // No Footer. + data, nbytes, 38, false, repeat, 50); +} +#endif // SEND_ARGO + +IRArgoAC::IRArgoAC(uint16_t pin) : _irsend(pin) { + stateReset(); +} + +void IRArgoAC::begin() { + _irsend.begin(); +} + +#if SEND_ARGO +void IRArgoAC::send() { + checksum(); // Create valid checksum before sending + _irsend.sendArgo(argo); +} +#endif // SEND_ARGO + +void IRArgoAC::checksum() { + uint8_t sum = 2; // Corresponds to byte 11 being constant 0b01 + uint8_t i; + + // Only add up bytes to 9. byte 10 is 0b01 constant anyway. + // Assume that argo array is MSB first (left) + for (i = 0; i < 10; i++) + sum += argo[i]; + + sum = sum % 256; // modulo 256 + // Append sum to end of array + // Set const part of checksum bit 10 + argo[10] = 0b00000010; + argo[10] += sum << 2; // Shift up 2 bits and append to byte 10 + argo[11] = sum >> 6; // Shift down 6 bits and add in two LSBs of bit 11 +} + +void IRArgoAC::stateReset() { + for (uint8_t i = 0; i < ARGO_COMMAND_LENGTH; i++) + argo[i] = 0x0; + + // Argo Message. Store MSB left. + // Default message: + argo[0] = 0b10101100; // LSB first (as sent) 0b00110101; //const preamble + argo[1] = 0b11110101; // LSB first: 0b10101111; //const preamble + // Keep payload 2-9 at zero + argo[10] = 0b00000010; // Const 01, checksum 6bit + argo[11] = 0b00000000; // Checksum 2bit + + this->off(); + this->setTemp(20); + this->setRoomTemp(25); + this->setCoolMode(ARGO_COOL_AUTO); + this->setFan(ARGO_FAN_AUTO); +} + +uint8_t* IRArgoAC::getRaw() { + checksum(); // Ensure correct bit array before returning + return argo; +} + +void IRArgoAC::on() { + // state = ON; + ac_state = 1; + // Bit 5 of byte 9 is on/off + // in MSB first + argo[9] = argo[9] | 0b00100000; // Set ON/OFF bit to 1 +} + +void IRArgoAC::off() { + // state = OFF; + ac_state = 0; + // in MSB first + // bit 5 of byte 9 to off + argo[9] = argo[9] & 0b11011111; // Set on/off bit to 0 +} + +void IRArgoAC::setPower(bool state) { + if (state) + on(); + else + off(); +} + +uint8_t IRArgoAC::getPower() { + return ac_state; +} + +void IRArgoAC::setMax(bool state) { + max_mode = state; + if (max_mode) + argo[9] |= 0b00001000; + else + argo[9] &= 0b11110111; +} + +bool IRArgoAC::getMax() { + return max_mode; +} + +// Set the temp in deg C +// Sending 0 equals +4 +void IRArgoAC::setTemp(uint8_t temp) { + if (temp < ARGO_MIN_TEMP) + temp = ARGO_MIN_TEMP; + else if (temp > ARGO_MAX_TEMP) + temp = ARGO_MAX_TEMP; + + // Store in attributes + set_temp = temp; + // offset 4 degrees. "If I want 12 degrees, I need to send 8" + temp -= 4; + // Settemp = Bit 6,7 of byte 2, and bit 0-2 of byte 3 + // mask out bits + // argo[13] & 0x00000100; // mask out ON/OFF Bit + argo[2] &= 0b00111111; + argo[3] &= 0b11111000; + + argo[2] += temp << 6; // append to bit 6,7 + argo[3] += temp >> 2; // remove lowest to bits and append in 0-2 +} + +uint8_t IRArgoAC::getTemp() { + return set_temp; +} + +// Set the speed of the fan +void IRArgoAC::setFan(uint8_t fan) { + // Set the fan speed bits, leave low 4 bits alone + fan_mode = fan; + // Mask out bits + argo[3] &= 0b11100111; + // Set fan mode at bit positions + argo[3] += fan << 3; +} + +uint8_t IRArgoAC::getFan() { + return fan_mode; +} + +void IRArgoAC::setFlap(uint8_t flap) { + flap_mode = flap; + // TODO(kaschmo): set correct bits for flap mode +} + +uint8_t IRArgoAC::getFlap() { + return flap_mode; +} + +uint8_t IRArgoAC::getMode() { + // return cooling 0, heating 1 + return ac_mode; +} + +void IRArgoAC::setCoolMode(uint8_t mode) { + ac_mode = 0; // Set ac mode to cooling + cool_mode = mode; + // Mask out bits, also leave bit 5 on 0 for cooling + argo[2] &= 0b11000111; + + // Set cool mode at bit positions + argo[2] += mode << 3; +} + +uint8_t IRArgoAC::getCoolMode() { + return cool_mode; +} + +void IRArgoAC::setHeatMode(uint8_t mode) { + ac_mode = 1; // Set ac mode to heating + heat_mode = mode; + // Mask out bits + argo[2] &= 0b11000111; + // Set heating bit + argo[2] |= 0b00100000; + // Set cool mode at bit positions + argo[2] += mode << 3; +} + +uint8_t IRArgoAC::getHeatMode() { + return heat_mode; +} + +void IRArgoAC::setNight(bool state) { + night_mode = state; + if (night_mode) + // Set bit at night position: bit 2 + argo[9] |= 0b00000100; + else + argo[9] &= 0b11111011; +} + +bool IRArgoAC::getNight() { + return night_mode; +} + +void IRArgoAC::setiFeel(bool state) { + ifeel_mode = state; + if (ifeel_mode) + // Set bit at iFeel position: bit 7 + argo[9] |= 0b10000000; + else + argo[9] &= 0b01111111; +} + +bool IRArgoAC::getiFeel() { + return ifeel_mode; +} + +void IRArgoAC::setTime() { + // TODO(kaschmo): use function call from checksum to set time first +} + +void IRArgoAC::setRoomTemp(uint8_t temp) { + temp -= 4; + // Mask out bits + argo[3] &= 0b00011111; + argo[4] &= 0b11111100; + + argo[3] += temp << 5; // Append to bit 5,6,7 + argo[4] += temp >> 3; // Remove lowest 3 bits and append in 0,1 +} diff --git a/IRremoteESP8266/src/ir_Argo.h b/IRremoteESP8266/src/ir_Argo.h new file mode 100644 index 0000000..d59fb77 --- /dev/null +++ b/IRremoteESP8266/src/ir_Argo.h @@ -0,0 +1,124 @@ +/* Copyright 2017 Schmolders +// Adds support for Argo Ulisse 13 DCI Mobile Split ACs. +*/ +#ifndef IR_ARGO_H_ +#define IR_ARGO_H_ + +#include "IRremoteESP8266.h" +#include "IRsend.h" + +// ARGO Ulisse DCI + +/* + Protocol Description: + All in LSB first as it is sent. argo message array will be stored MSB first! + do LSB-MSB conversion in sendData + Byte 0: const 0 0 1 1 0 1 0 1 + Byte 1: const 1 0 1 0 1 1 1 1 + Byte 2: 0 0 0, 3bit Cool/Heat Mode, 2bit start SetTemp LSB first + Byte 3: 3bit End SetTemp, 2bit Fan Mode, 3bit RoomTemp LSB first + Byte 4: 2bit RoomTemp, 3bit Flap Mode, 3bit OnTimer + Byte 5: 8bit OnTimer + Byte 6: 8Bit OffTimer + Byte 7: 3bit OffTimer, 5bit Time + Byte 8: 6bit Time, 1bit Timer On/Off, 1bit Timer Program + Byte 9: 1bit Timer Program, 1bit Timer 1h, 1 bit Night Mode, 1bit Max Mode, 1bit Filter, 1bit on/off, 1bit const 0, 1bit iFeel + Byte 10: 2bit const 0 1, 6bit Checksum + Byte 11: 2bit Checksum +*/ + +// Constants. Store MSB left. + +#define ARGO_COOL_ON 0U // 0b000 +#define ARGO_COOL_OFF 3U // 0b110 +#define ARGO_COOL_AUTO 2U // 0b010 +#define ARGO_COOl_HUM 1U // 0b100 + +#define ARGO_HEAT_ON 0U // 0b001 +#define ARGO_HEAT_AUTO 1U // 0b101 +#define ARGO_HEAT_BLINK 2U // 0b011 // ??no idea what mode that is + + +#define ARGO_MIN_TEMP 10U // Celsius offset +4 +#define ARGO_MAX_TEMP 32U // Celsius + +#define ARGO_FAN_AUTO 0U // 0b00 +#define ARGO_FAN_3 3U // 0b11 +#define ARGO_FAN_2 2U // 0b01 +#define ARGO_FAN_1 1U // 0b10 + +#define ARGO_FLAP_AUTO 0U // 0b000 +#define ARGO_FLAP_1 1U // 0b100 +#define ARGO_FLAP_2 2U // 0b010 +#define ARGO_FLAP_3 3U // 0b110 +#define ARGO_FLAP_4 4U // 0b001 +#define ARGO_FLAP_5 5U // 0b101 +#define ARGO_FLAP_6 6U // 0b011 +#define ARGO_FLAP_FULL 7U // 0b111 + + +class IRArgoAC { + public: + explicit IRArgoAC(uint16_t pin); + +#if SEND_ARGO + void send(); +#endif // SEND_ARGO + void begin(); + void on(); + void off(); + + void setPower(bool state); + uint8_t getPower(); + + void setTemp(uint8_t temp); + uint8_t getTemp(); + + void setFan(uint8_t fan); + uint8_t getFan(); + + void setFlap(uint8_t flap); + uint8_t getFlap(); + + void setCoolMode(uint8_t mode); + uint8_t getCoolMode(); + + void setHeatMode(uint8_t mode); + uint8_t getHeatMode(); + uint8_t getMode(); + + void setMax(bool state); + bool getMax(); + + void setNight(bool state); + bool getNight(); + + void setiFeel(bool state); + bool getiFeel(); + + void setTime(); + void setRoomTemp(uint8_t temp); + + uint8_t* getRaw(); + + private: + // # of bytes per command + uint8_t argo[ARGO_COMMAND_LENGTH]; // Defined in IRremoteESP8266.h + void stateReset(); + void checksum(); + IRsend _irsend; // instance of the IR send class + + // Attributes + uint8_t set_temp; + uint8_t fan_mode; + uint8_t flap_mode; + uint8_t ac_state; + uint8_t ac_mode; // heat 1, cool 0 + uint8_t heat_mode; + uint8_t cool_mode; + uint8_t night_mode; // on/off + uint8_t max_mode; // on/off + uint8_t ifeel_mode; // on/off +}; + +#endif // IR_ARGO_H_ diff --git a/IRremoteESP8266/src/ir_Carrier.cpp b/IRremoteESP8266/src/ir_Carrier.cpp new file mode 100644 index 0000000..968c2f5 --- /dev/null +++ b/IRremoteESP8266/src/ir_Carrier.cpp @@ -0,0 +1,116 @@ +// Copyright 2018 David Conran + +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// CCCCC AAA RRRRRR RRRRRR IIIII EEEEEEE RRRRRR +// CC C AAAAA RR RR RR RR III EE RR RR +// CC AA AA RRRRRR RRRRRR III EEEEE RRRRRR +// CC C AAAAAAA RR RR RR RR III EE RR RR +// CCCCC AA AA RR RR RR RR IIIII EEEEEEE RR RR + +// Suits Carrier/Surrey HVAC models: +// 42QG5A55970 (remote) +// 619EGX0090E0 / 619EGX0120E0 / 619EGX0180E0 / 619EGX0220E0 (indoor units) +// 53NGK009/012 (inverter) + +// Constants +// Ref: +// https://github.com/markszabo/IRremoteESP8266/issues/385 +#define CARRIER_AC_HDR_MARK 8532U +#define CARRIER_AC_HDR_SPACE 4228U +#define CARRIER_AC_BIT_MARK 628U +#define CARRIER_AC_ONE_SPACE 1320U +#define CARRIER_AC_ZERO_SPACE 532U +#define CARRIER_AC_GAP 20000U + +#if SEND_CARRIER_AC +// Send a Carrier HVAC formatted message. +// +// Args: +// data: The message to be sent. +// nbits: The bit size of the message being sent. typically CARRIER_AC_BITS. +// repeat: The number of times the message is to be repeated. +// +// Status: BETA / Appears to work on real devices. +// +void IRsend::sendCarrierAC(uint64_t data, uint16_t nbits, uint16_t repeat) { + for (uint16_t r = 0; r <= repeat; r++) { + uint64_t temp_data = data; + // Carrier sends the data block three times. normal + inverted + normal. + for (uint16_t i = 0; i < 3; i++) { + sendGeneric(CARRIER_AC_HDR_MARK, CARRIER_AC_HDR_SPACE, + CARRIER_AC_BIT_MARK, CARRIER_AC_ONE_SPACE, + CARRIER_AC_BIT_MARK, CARRIER_AC_ZERO_SPACE, + CARRIER_AC_BIT_MARK, CARRIER_AC_GAP, + temp_data, nbits, 38, true, 0, 50); + temp_data = invertBits(temp_data, nbits); + } + } +} +#endif + +#if DECODE_CARRIER_AC +// Decode the supplied Carrier HVAC message. +// Carrier HVAC messages contain only 32 bits, but it is sent three(3) times. +// i.e. normal + inverted + normal +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of bits to expect in the data portion. +// Typically CARRIER_AC_BITS. +// strict: Flag to indicate if we strictly adhere to the specification. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: ALPHA / Untested. +// +bool IRrecv::decodeCarrierAC(decode_results *results, uint16_t nbits, + bool strict) { + if (results->rawlen < ((2 * nbits + HEADER + FOOTER) * 3) - 1) + return false; // Can't possibly be a valid Carrier message. + if (strict && nbits != CARRIER_AC_BITS) + return false; // We expect Carrier to be 32 bits of message. + + uint64_t data = 0; + uint64_t prev_data = 0; + uint16_t offset = OFFSET_START; + + for (uint8_t i = 0; i < 3; i++) { + prev_data = data; + // Header + if (!matchMark(results->rawbuf[offset++], CARRIER_AC_HDR_MARK)) + return false; + if (!matchSpace(results->rawbuf[offset++], CARRIER_AC_HDR_SPACE)) + return false; + // Data + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + CARRIER_AC_BIT_MARK, + CARRIER_AC_ONE_SPACE, + CARRIER_AC_BIT_MARK, + CARRIER_AC_ZERO_SPACE); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + // Footer + if (!matchMark(results->rawbuf[offset++], CARRIER_AC_BIT_MARK)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset++], CARRIER_AC_GAP)) + return false; + // Compliance. + if (strict) { + // Check if the data is an inverted copy of the previous data. + if (i > 0 && prev_data != invertBits(data, nbits)) return false; + } + } + + // Success + results->bits = nbits; + results->value = data; + results->decode_type = CARRIER_AC; + results->address = data >> 16; + results->command = data & 0xFFFF; + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Coolix.cpp b/IRremoteESP8266/src/ir_Coolix.cpp new file mode 100644 index 0000000..82d59de --- /dev/null +++ b/IRremoteESP8266/src/ir_Coolix.cpp @@ -0,0 +1,166 @@ +// Copyright bakrus +// Copyright 2017 David Conran + +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// CCCCC OOOOO OOOOO LL IIIII XX XX +// CC C OO OO OO OO LL III XX XX +// CC OO OO OO OO LL III XXXX +// CC C OO OO OO OO LL III XX XX +// CCCCC OOOO0 OOOO0 LLLLLLL IIIII XX XX + +// Coolix A/C / heatpump added by (send) bakrus & (decode) crankyoldgit + +// Constants +// Pulse parms are *50-100 for the Mark and *50+100 for the space +// First MARK is the one after the long gap +// pulse parameters in usec +#define COOLIX_TICK 560U // Approximately 21 cycles at 38kHz +#define COOLIX_BIT_MARK_TICKS 1U +#define COOLIX_BIT_MARK (COOLIX_BIT_MARK_TICKS * COOLIX_TICK) +#define COOLIX_ONE_SPACE_TICKS 3U +#define COOLIX_ONE_SPACE (COOLIX_ONE_SPACE_TICKS * COOLIX_TICK) +#define COOLIX_ZERO_SPACE_TICKS 1U +#define COOLIX_ZERO_SPACE (COOLIX_ZERO_SPACE_TICKS * COOLIX_TICK) +#define COOLIX_HDR_MARK_TICKS 8U +#define COOLIX_HDR_MARK (COOLIX_HDR_MARK_TICKS * COOLIX_TICK) +#define COOLIX_HDR_SPACE_TICKS 8U +#define COOLIX_HDR_SPACE (COOLIX_HDR_SPACE_TICKS * COOLIX_TICK) +#define COOLIX_MIN_GAP_TICKS (COOLIX_HDR_MARK_TICKS + \ + COOLIX_ZERO_SPACE_TICKS) +#define COOLIX_MIN_GAP (COOLIX_MIN_GAP_TICKS * COOLIX_TICK) + +#if SEND_COOLIX +// Send a Coolix message +// +// Args: +// data: Contents of the message to be sent. +// nbits: Nr. of bits of data to be sent. Typically COOLIX_BITS. +// repeat: Nr. of additional times the message is to be sent. +// +// Status: BETA / Probably works. +// +// Ref: +// https://github.com/z3t0/Arduino-IRremote/blob/master/ir_COOLIX.cpp +// TODO(anyone): Verify repeat functionality against a real unit. +void IRsend::sendCOOLIX(uint64_t data, uint16_t nbits, uint16_t repeat) { + if (nbits % 8 != 0) + return; // nbits is required to be a multiple of 8. + + // Set IR carrier frequency + enableIROut(38); + + for (uint16_t r = 0; r <= repeat; r++) { + // Header + mark(COOLIX_HDR_MARK); + space(COOLIX_HDR_SPACE); + + // Data + // Break data into byte segments, starting at the Most Significant + // Byte. Each byte then being sent normal, then followed inverted. + for (uint16_t i = 8; i <= nbits; i += 8) { + // Grab a bytes worth of data. + uint8_t segment = (data >> (nbits - i)) & 0xFF; + // Normal + sendData(COOLIX_BIT_MARK, COOLIX_ONE_SPACE, + COOLIX_BIT_MARK, COOLIX_ZERO_SPACE, + segment, 8, true); + // Inverted. + sendData(COOLIX_BIT_MARK, COOLIX_ONE_SPACE, + COOLIX_BIT_MARK, COOLIX_ZERO_SPACE, + segment ^ 0xFF, 8, true); + } + + // Footer + mark(COOLIX_BIT_MARK); + space(COOLIX_MIN_GAP); // Pause before repeating + } +} +#endif + +#if DECODE_COOLIX +// Decode the supplied Coolix message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. Typically COOLIX_BITS. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / Probably working. +bool IRrecv::decodeCOOLIX(decode_results *results, uint16_t nbits, + bool strict) { + // The protocol sends the data normal + inverted, alternating on + // each byte. Hence twice the number of expected data bits. + if (results->rawlen < 2 * 2 * nbits + HEADER + FOOTER - 1) + return false; // Can't possibly be a valid COOLIX message. + if (strict && nbits != COOLIX_BITS) + return false; // Not strictly a COOLIX message. + if (nbits % 8 != 0) // nbits has to be a multiple of nr. of bits in a byte. + return false; + + uint64_t data = 0; + uint64_t inverted = 0; + uint16_t offset = OFFSET_START; + + if (nbits > sizeof(data) * 8) + return false; // We can't possibly capture a Coolix packet that big. + + // Header + if (!matchMark(results->rawbuf[offset], COOLIX_HDR_MARK)) return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t m_tick = results->rawbuf[offset++] * RAWTICK / COOLIX_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset], COOLIX_HDR_SPACE)) return false; + // Calculate how long the common tick time is based on the header space. + uint32_t s_tick = results->rawbuf[offset++] * RAWTICK / + COOLIX_HDR_SPACE_TICKS; + + // Data + // Twice as many bits as there are normal plus inverted bits. + for (uint16_t i = 0; i < nbits * 2; i++, offset++) { + bool flip = (i / 8) % 2; + if (!matchMark(results->rawbuf[offset++], COOLIX_BIT_MARK_TICKS * m_tick)) + return false; + if (matchSpace(results->rawbuf[offset], COOLIX_ONE_SPACE_TICKS * s_tick)) { + if (flip) + inverted = (inverted << 1) | 1; + else + data = (data << 1) | 1; + } else if (matchSpace(results->rawbuf[offset], + COOLIX_ZERO_SPACE_TICKS * s_tick)) { + if (flip) + inverted <<= 1; + else + data <<= 1; + } else { + return false; + } + } + + // Footer + if (!matchMark(results->rawbuf[offset++], COOLIX_BIT_MARK_TICKS * m_tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], COOLIX_MIN_GAP_TICKS * s_tick)) + return false; + + // Compliance + uint64_t orig = data; // Save a copy of the data. + if (strict) { + for (uint16_t i = 0; i < nbits; i += 8, data >>= 8, inverted >>= 8) + if ((data & 0xFF) != ((inverted & 0xFF) ^ 0xFF)) + return false; + } + + // Success + results->decode_type = COOLIX; + results->bits = nbits; + results->value = orig; + results->address = 0; + results->command = 0; + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Daikin.cpp b/IRremoteESP8266/src/ir_Daikin.cpp new file mode 100644 index 0000000..caf0359 --- /dev/null +++ b/IRremoteESP8266/src/ir_Daikin.cpp @@ -0,0 +1,789 @@ +/* +An Arduino sketch to emulate IR Daikin ARC433** remote control unit +Read more at: +http://harizanov.com/2012/02/control-daikin-air-conditioner-over-the-internet/ + +Copyright 2016 sillyfrog +Copyright 2017 sillyfrog, crankyoldgit +*/ + +#include "ir_Daikin.h" +#include +#ifndef ARDUINO +#include +#endif +#include "IRremoteESP8266.h" +#include "IRutils.h" +#include "IRrecv.h" +#include "IRsend.h" + +// DDDDD AAA IIIII KK KK IIIII NN NN +// DD DD AAAAA III KK KK III NNN NN +// DD DD AA AA III KKKK III NN N NN +// DD DD AAAAAAA III KK KK III NN NNN +// DDDDDD AA AA IIIII KK KK IIIII NN NN + +// Constants +// Ref: +// https://github.com/mharizanov/Daikin-AC-remote-control-over-the-Internet/tree/master/IRremote +// http://rdlab.cdmt.vn/project-2013/daikin-ir-protocol + +#if SEND_DAIKIN +// Original header +// static uint8_t header1[DAIKIN_HEADER1_LENGTH]; +// header1[0] = 0b00010001; +// header1[1] = 0b11011010; +// header1[2] = 0b00100111; +// header1[3] = 0b00000000; +// header1[4] = 0b11000101; +// header1[5] = 0b00000000; +// header1[6] = 0b00000000; +// header1[7] = 0b11010111; + +// Send a Daikin A/C message. +// +// Args: +// data: An array of DAIKIN_COMMAND_LENGTH bytes containing the IR command. +// +// Status: STABLE +// +// Ref: +// IRDaikinESP.cpp +// https://github.com/mharizanov/Daikin-AC-remote-control-over-the-Internet/tree/master/IRremote +void IRsend::sendDaikin(unsigned char data[], uint16_t nbytes, + uint16_t repeat) { + if (nbytes < DAIKIN_COMMAND_LENGTH) + return; // Not enough bytes to send a proper message. + + for (uint16_t r = 0; r <= repeat; r++) { + // Send the header, 0b00000 + sendGeneric(0, 0, // No header for the header + DAIKIN_BIT_MARK, DAIKIN_ONE_SPACE, + DAIKIN_BIT_MARK, DAIKIN_ZERO_SPACE, + DAIKIN_BIT_MARK, DAIKIN_ZERO_SPACE + DAIKIN_GAP, + (uint64_t) 0b00000, 5, 38, false, 0, 50); + // Leading header + // Do this as a constant to save RAM and keep in flash memory + sendGeneric(DAIKIN_HDR_MARK, DAIKIN_HDR_SPACE, + DAIKIN_BIT_MARK, DAIKIN_ONE_SPACE, + DAIKIN_BIT_MARK, DAIKIN_ZERO_SPACE, + DAIKIN_BIT_MARK, DAIKIN_ZERO_SPACE + DAIKIN_GAP, + DAIKIN_FIRST_HEADER64, 64, 38, false, 0, 50); + // Data #1 + sendGeneric(DAIKIN_HDR_MARK, DAIKIN_HDR_SPACE, + DAIKIN_BIT_MARK, DAIKIN_ONE_SPACE, + DAIKIN_BIT_MARK, DAIKIN_ZERO_SPACE, + DAIKIN_BIT_MARK, DAIKIN_ZERO_SPACE + DAIKIN_GAP, + data, 8, 38, false, 0, 50); + // Data #2 + sendGeneric(DAIKIN_HDR_MARK, DAIKIN_HDR_SPACE, + DAIKIN_BIT_MARK, DAIKIN_ONE_SPACE, + DAIKIN_BIT_MARK, DAIKIN_ZERO_SPACE, + DAIKIN_BIT_MARK, DAIKIN_ZERO_SPACE + DAIKIN_GAP, + data + 8, nbytes - 8, 38, false, 0, 50); + } +} +#endif // SEND_DAIKIN + +IRDaikinESP::IRDaikinESP(uint16_t pin) : _irsend(pin) { + stateReset(); +} + +void IRDaikinESP::begin() { + _irsend.begin(); +} + +#if SEND_DAIKIN +void IRDaikinESP::send() { + checksum(); + _irsend.sendDaikin(daikin); +} +#endif // SEND_DAIKIN + +// Calculate the checksum for a given data block. +// Args: +// block: Ptr to the start of the data block. +// length: Nr. of bytes to checksum. +// Returns: +// A byte containing the calculated checksum. +uint8_t IRDaikinESP::calcBlockChecksum(const uint8_t *block, + const uint16_t length) { + uint8_t sum = 0; + // Daikin checksum is just the addition of all the data bytes + // in the block but capped to 8 bits. + for (uint16_t i = 0; i < length; i++, block++) + sum += *block; + return sum & 0xFFU; +} + +// Verify the checksum is valid for a given state. +// Args: +// state: The array to verify the checksum of. +// length: The size of the state. +// Returns: +// A boolean. +bool IRDaikinESP::validChecksum(const uint8_t state[], + const uint16_t length) { + if (length < 8 || state[7] != calcBlockChecksum(state, 7)) return false; + if (length < 10 || + state[length - 1] != calcBlockChecksum(state + 8, length - 9)) + return false; + return true; +} + +// Calculate and set the checksum values for the internal state. +void IRDaikinESP::checksum() { + daikin[7] = calcBlockChecksum(daikin, 7); + daikin[26] = calcBlockChecksum(daikin + 8, 17); +} + +void IRDaikinESP::stateReset() { + for (uint8_t i = 0; i < DAIKIN_COMMAND_LENGTH; i++) + daikin[i] = 0x0; + + daikin[0] = 0x11; + daikin[1] = 0xDA; + daikin[2] = 0x27; + daikin[4] = 0x42; + // daikin[7] is a checksum byte, it will be set by checksum(). + daikin[8] = 0x11; + daikin[9] = 0xDA; + daikin[10] = 0x27; + daikin[13] = 0x49; + daikin[14] = 0x1E; + daikin[16] = 0xB0; + daikin[19] = 0x06; + daikin[20] = 0x60; + daikin[23] = 0xC0; + // daikin[26] is a checksum byte, it will be set by checksum(). + checksum(); +} + +uint8_t* IRDaikinESP::getRaw() { + checksum(); // Ensure correct settings before sending. + return daikin; +} + +void IRDaikinESP::setRaw(uint8_t new_code[]) { + for (uint8_t i = 0; i < DAIKIN_COMMAND_LENGTH; i++) + daikin[i] = new_code[i]; +} + +void IRDaikinESP::on() { + // state = ON; + setBit(DAIKIN_BYTE_POWER, DAIKIN_BIT_POWER); +} + +void IRDaikinESP::off() { + // state = OFF; + clearBit(DAIKIN_BYTE_POWER, DAIKIN_BIT_POWER); +} + +void IRDaikinESP::setPower(bool state) { + if (state) + on(); + else + off(); +} + +bool IRDaikinESP::getPower() { + return (getBit(DAIKIN_BYTE_POWER, DAIKIN_BIT_POWER) > 0); +} + +// Set the temp in deg C +void IRDaikinESP::setTemp(uint8_t temp) { + if (temp < DAIKIN_MIN_TEMP) + temp = DAIKIN_MIN_TEMP; + else if (temp > DAIKIN_MAX_TEMP) + temp = DAIKIN_MAX_TEMP; + daikin[14] = temp * 2; +} + +uint8_t IRDaikinESP::getTemp() { + return daikin[14] / 2; +} + +// Set the speed of the fan, 1-5 or DAIKIN_FAN_AUTO or DAIKIN_FAN_QUIET +void IRDaikinESP::setFan(uint8_t fan) { + // Set the fan speed bits, leave low 4 bits alone + uint8_t fanset; + if (fan == DAIKIN_FAN_QUIET || fan == DAIKIN_FAN_AUTO) + fanset = fan; + else if (fan < DAIKIN_FAN_MIN || fan > DAIKIN_FAN_MAX) + fanset = DAIKIN_FAN_AUTO; + else + fanset = 2 + fan; + daikin[16] &= 0x0F; + daikin[16] |= (fanset << 4); +} + +uint8_t IRDaikinESP::getFan() { + uint8_t fan = daikin[16] >> 4; + if (fan != DAIKIN_FAN_QUIET && fan != DAIKIN_FAN_AUTO) + fan -= 2; + return fan; +} + +uint8_t IRDaikinESP::getMode() { + /* + DAIKIN_COOL + DAIKIN_HEAT + DAIKIN_FAN + DAIKIN_AUTO + DAIKIN_DRY + */ + return daikin[13] >> 4; +} + +void IRDaikinESP::setMode(uint8_t mode) { + switch (mode) { + case DAIKIN_COOL: + case DAIKIN_HEAT: + case DAIKIN_FAN: + case DAIKIN_DRY: + break; + default: + mode = DAIKIN_AUTO; + } + mode <<= 4; + daikin[13] &= 0b10001111; + daikin[13] |= mode; +} + +void IRDaikinESP::setSwingVertical(bool state) { + if (state) + daikin[16] |= 0x0F; + else + daikin[16] &= 0xF0; +} + +bool IRDaikinESP::getSwingVertical() { + return daikin[16] & 0x01; +} + +void IRDaikinESP::setSwingHorizontal(bool state) { + if (state) + daikin[17] |= 0x0F; + else + daikin[17] &= 0xF0; +} + +bool IRDaikinESP::getSwingHorizontal() { + return daikin[17] & 0x01; +} + +void IRDaikinESP::setQuiet(bool state) { + if (state) { + setBit(DAIKIN_BYTE_SILENT, DAIKIN_BIT_SILENT); + // Powerful & Quiet mode being on are mutually exclusive. + setPowerful(false); + } else { + clearBit(DAIKIN_BYTE_SILENT, DAIKIN_BIT_SILENT); + } +} + +bool IRDaikinESP::getQuiet() { + return (getBit(DAIKIN_BYTE_SILENT, DAIKIN_BIT_SILENT) > 0); +} + +void IRDaikinESP::setPowerful(bool state) { + if (state) { + setBit(DAIKIN_BYTE_POWERFUL, DAIKIN_BIT_POWERFUL); + // Powerful, Quiet, & Econo mode being on are mutually exclusive. + setQuiet(false); + setEcono(false); + } else { + clearBit(DAIKIN_BYTE_POWERFUL, DAIKIN_BIT_POWERFUL); + } +} + +bool IRDaikinESP::getPowerful() { + return (getBit(DAIKIN_BYTE_POWERFUL, DAIKIN_BIT_POWERFUL) > 0); +} + +void IRDaikinESP::setSensor(bool state) { + if (state) + setBit(DAIKIN_BYTE_SENSOR, DAIKIN_BIT_SENSOR); + else + clearBit(DAIKIN_BYTE_SENSOR, DAIKIN_BIT_SENSOR); +} + +bool IRDaikinESP::getSensor() { + return (getBit(DAIKIN_BYTE_SENSOR, DAIKIN_BIT_SENSOR) > 0); +} + +void IRDaikinESP::setEcono(bool state) { + if (state) { + setBit(DAIKIN_BYTE_ECONO, DAIKIN_BIT_ECONO); + // Powerful & Econo mode being on are mutually exclusive. + setPowerful(false); + } else { + clearBit(DAIKIN_BYTE_ECONO, DAIKIN_BIT_ECONO); + } +} + +bool IRDaikinESP::getEcono() { + return (getBit(DAIKIN_BYTE_ECONO, DAIKIN_BIT_ECONO) > 0); +} + +void IRDaikinESP::setEye(bool state) { + if (state) + setBit(DAIKIN_BYTE_EYE, DAIKIN_BIT_EYE); + else + clearBit(DAIKIN_BYTE_EYE, DAIKIN_BIT_EYE); +} + +bool IRDaikinESP::getEye() { + return (getBit(DAIKIN_BYTE_EYE, DAIKIN_BIT_EYE) > 0); +} + +void IRDaikinESP::setMold(bool state) { + if (state) + setBit(DAIKIN_BYTE_MOLD, DAIKIN_BIT_MOLD); + else + clearBit(DAIKIN_BYTE_MOLD, DAIKIN_BIT_MOLD); +} + +bool IRDaikinESP::getMold() { + return (getBit(DAIKIN_BYTE_MOLD, DAIKIN_BIT_MOLD) > 0); +} + +void IRDaikinESP::setBit(uint8_t byte, uint8_t bitmask) { + daikin[byte] |= bitmask; +} + +void IRDaikinESP::clearBit(uint8_t byte, uint8_t bitmask) { + bitmask = ~bitmask; + daikin[byte] &= bitmask; +} + +uint8_t IRDaikinESP::getBit(uint8_t byte, uint8_t bitmask) { + return daikin[byte] & bitmask; +} + +// starttime: Number of minutes after midnight, in 10 minutes increments +void IRDaikinESP::enableOnTimer(uint16_t starttime) { + setBit(DAIKIN_BYTE_ON_TIMER, DAIKIN_BIT_ON_TIMER); + daikin[18] = (uint8_t) (starttime & 0x00FF); + // only keep 4 bits + daikin[19] &= 0xF0; + daikin[19] |= (uint8_t) ((starttime >> 8) & 0x0F); +} + +void IRDaikinESP::disableOnTimer() { + enableOnTimer(0x600); + clearBit(DAIKIN_BYTE_ON_TIMER, DAIKIN_BIT_ON_TIMER); +} + +uint16_t IRDaikinESP::getOnTime() { + uint16_t ret; + ret = daikin[19] & 0x0F; + ret = ret << 8; + ret += daikin[18]; + return ret; +} + +bool IRDaikinESP::getOnTimerEnabled() { + return getBit(DAIKIN_BYTE_ON_TIMER, DAIKIN_BIT_ON_TIMER); +} + +// endtime: Number of minutes after midnight, in 10 minutes increments +void IRDaikinESP::enableOffTimer(uint16_t endtime) { + setBit(DAIKIN_BYTE_OFF_TIMER, DAIKIN_BIT_OFF_TIMER); + daikin[20] = (uint8_t)((endtime >> 4) & 0xFF); + daikin[19] &= 0x0F; + daikin[19] |= (uint8_t) ((endtime & 0x000F) << 4); +} + +void IRDaikinESP::disableOffTimer() { + enableOffTimer(0x600); + clearBit(DAIKIN_BYTE_OFF_TIMER, DAIKIN_BIT_OFF_TIMER); +} + +uint16_t IRDaikinESP::getOffTime() { + uint16_t ret, tmp; + ret = daikin[20]; + ret <<= 4; + tmp = daikin[19] & 0xF0; + tmp >>= 4; + ret += tmp; + return ret; +} + +bool IRDaikinESP::getOffTimerEnabled() { + return getBit(DAIKIN_BYTE_OFF_TIMER, DAIKIN_BIT_OFF_TIMER); +} + +void IRDaikinESP::setCurrentTime(uint16_t numMins) { + if (numMins > 24 * 60) numMins = 0; // If > 23:59, set to 00:00 + daikin[5] = (uint8_t) (numMins & 0x00FF); + // only keep 4 bits + daikin[6] &= 0xF0; + daikin[6] |= (uint8_t) ((numMins >> 8) & 0x0F); +} + +uint16_t IRDaikinESP::getCurrentTime() { + uint16_t ret; + ret = daikin[6] & 0x0F; + ret <<= 8; + ret += daikin[5]; + return ret; +} + +#ifdef ARDUINO +String IRDaikinESP::renderTime(uint16_t timemins) { + String ret; +#else // ARDUINO +std::string IRDaikinESP::renderTime(uint16_t timemins) { + std::string ret; +#endif // ARDUINO + uint16_t hours, mins; + hours = timemins / 60; + ret = uint64ToString(hours) + ":"; + mins = timemins - (hours * 60); + if (mins < 10) + ret += "0"; + ret += uint64ToString(mins); + return ret; +} + +// Convert the internal state into a human readable string. +#ifdef ARDUINO +String IRDaikinESP::toString() { + String result = ""; +#else // ARDUINO +std::string IRDaikinESP::toString() { + std::string result = ""; +#endif // ARDUINO + result += "Power: "; + if (getPower()) + result += "On"; + else + result += "Off"; + result += ", Mode: " + uint64ToString(getMode()); + switch (getMode()) { + case DAIKIN_AUTO: + result += " (AUTO)"; + break; + case DAIKIN_COOL: + result += " (COOL)"; + break; + case DAIKIN_HEAT: + result += " (HEAT)"; + break; + case DAIKIN_DRY: + result += " (DRY)"; + break; + case DAIKIN_FAN: + result += " (FAN)"; + break; + default: + result += " (UNKNOWN)"; + } + result += ", Temp: " + uint64ToString(getTemp()) + "C"; + result += ", Fan: " + uint64ToString(getFan()); + switch (getFan()) { + case DAIKIN_FAN_AUTO: + result += " (AUTO)"; + break; + case DAIKIN_FAN_QUIET: + result += " (QUIET)"; + break; + case DAIKIN_FAN_MIN: + result += " (MIN)"; + break; + case DAIKIN_FAN_MAX: + result += " (MAX)"; + break; + } + result += ", Powerful: "; + if (getPowerful()) + result += "On"; + else + result += "Off"; + result += ", Quiet: "; + if (getQuiet()) + result += "On"; + else + result += "Off"; + result += ", Sensor: "; + if (getSensor()) + result += "On"; + else + result += "Off"; + result += ", Eye: "; + if (getEye()) + result += "On"; + else + result += "Off"; + result += ", Mold: "; + if (getMold()) + result += "On"; + else + result += "Off"; + result += ", Swing (Horizontal): "; + if (getSwingHorizontal()) + result += "On"; + else + result += "Off"; + result += ", Swing (Vertical): "; + if (getSwingVertical()) + result += "On"; + else + result += "Off"; + result += ", Current Time: " + renderTime(getCurrentTime()); + result += ", On Time: "; + if (getOnTimerEnabled()) + result += renderTime(getOnTime()); + else + result += "Off"; + result += ", Off Time: "; + if (getOffTimerEnabled()) + result += renderTime(getOffTime()); + else + result += "Off"; + + return result; +} + +#if DAIKIN_DEBUG +// Print what we have +void IRDaikinESP::printState() { +#ifdef ARDUINO + String strbits; +#else // ARDUINO + std::string strbits; +#endif // ARDUINO + DPRINTLN("Raw Bits:"); + for (uint8_t i = 0; i < DAIKIN_COMMAND_LENGTH; i++) { + strbits = uint64ToString(daikin[i], BIN); + while (strbits.length() < 8) + strbits = "0" + strbits; + DPRINT(strbits); + DPRINT(" "); + } + DPRINTLN(""); + DPRINTLN(toString()); +} +#endif // DAIKIN_DEBUG + +/* + * Return most important bits to allow replay + * layout is: + * 0: Power + * 1-3: Mode + * 4-7: Fan speed/mode + * 8-14: Target Temperature + * 15: Econo + * 16: Powerful + * 17: Quiet + * 18: Sensor + * 19: Swing Vertical + * 20-31: Current time (mins since midnight) + * */ +uint32_t IRDaikinESP::getCommand() { + uint32_t ret = 0; + uint32_t tmp = 0; + if (getPower()) + ret |= 0b00000000000000000000000000000001; + tmp = getMode(); + tmp = tmp << 1; + ret |= tmp; + + tmp = getFan(); + tmp <<= 4; + ret |= tmp; + + tmp = getTemp(); + tmp <<= 8; + ret |= tmp; + + if (getEcono()) + ret |= 0b00000000000000001000000000000000; + if (getPowerful()) + ret |= 0b00000000000000010000000000000000; + if (getQuiet()) + ret |= 0b00000000000000100000000000000000; + if (getSensor()) + ret |= 0b00000000000001000000000000000000; + if (getSwingVertical()) + ret |= 0b00000000000010000000000000000000; + ret |= (getCurrentTime() << 20); + return ret; +} + +void IRDaikinESP::setCommand(uint32_t value) { + uint32_t tmp = 0; + if (value & 0b00000000000000000000000000000001) + setPower(true); + tmp = value & 0b00000000000000000000000000001110; + tmp >>= 1; + setMode(tmp); + + tmp = value & 0b00000000000000000000000011110000; + tmp >>= 4; + setFan(tmp); + + tmp = value & 0b00000000000000000111111100000000; + tmp >>= 8; + setTemp(tmp); + + if (value & 0b00000000000000001000000000000000) + setEcono(true); + if (value & 0b00000000000000010000000000000000) + setPowerful(true); + if (value & 0b00000000000000100000000000000000) + setQuiet(true); + if (value & 0b00000000000001000000000000000000) + setSensor(true); + if (value & 0b00000000000010000000000000000000) + setSwingVertical(true); + + value >>= 20; + setCurrentTime(value); +} + +#if DECODE_DAIKIN + +void addbit(bool val, unsigned char data[]) { + uint8_t curbit = data[DAIKIN_CURBIT]; + uint8_t curindex = data[DAIKIN_CURINDEX]; + if (val) { + unsigned char bit = 1; + bit = bit << curbit; + data[curindex] |= bit; + } + curbit++; + if (curbit == 8) { + curbit = 0; + curindex++; + } + data[DAIKIN_CURBIT] = curbit; + data[DAIKIN_CURINDEX] = curindex; +} + +bool checkheader(decode_results *results, uint16_t* offset) { + if (!IRrecv::matchMark(results->rawbuf[(*offset)++], DAIKIN_BIT_MARK, + DAIKIN_TOLERANCE, DAIKIN_MARK_EXCESS)) + return false; + if (!IRrecv::matchSpace(results->rawbuf[(*offset)++], + DAIKIN_ZERO_SPACE + DAIKIN_GAP, + DAIKIN_TOLERANCE, DAIKIN_MARK_EXCESS)) + return false; + if (!IRrecv::matchMark(results->rawbuf[(*offset)++], DAIKIN_HDR_MARK, + DAIKIN_TOLERANCE, DAIKIN_MARK_EXCESS)) + return false; + if (!IRrecv::matchSpace(results->rawbuf[(*offset)++], DAIKIN_HDR_SPACE, + DAIKIN_TOLERANCE, DAIKIN_MARK_EXCESS)) + return false; + + return true; +} + +bool readbits(decode_results *results, uint16_t *offset, + unsigned char daikin_code[], uint16_t countbits) { + for (uint16_t i = 0; i < countbits && *offset < results->rawlen - 1; + i++, (*offset)++) { + if (!IRrecv::matchMark(results->rawbuf[(*offset)++], DAIKIN_BIT_MARK, + DAIKIN_TOLERANCE, DAIKIN_MARK_EXCESS)) + return false; + if (IRrecv::matchSpace(results->rawbuf[*offset], DAIKIN_ONE_SPACE, + DAIKIN_TOLERANCE, DAIKIN_MARK_EXCESS)) + addbit(1, daikin_code); + else if (IRrecv::matchSpace(results->rawbuf[*offset], DAIKIN_ZERO_SPACE, + DAIKIN_TOLERANCE, DAIKIN_MARK_EXCESS)) + addbit(0, daikin_code); + else + return false; + } + return true; +} + +// Decode the supplied Daikin A/C message. +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of bits to expect in the data portion. (DAIKIN_RAW_BITS) +// strict: Flag to indicate if we strictly adhere to the specification. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / Should be working. +// +// Notes: +// If DAIKIN_DEBUG enabled, will print all the set options and values. +// +// Ref: +// https://github.com/mharizanov/Daikin-AC-remote-control-over-the-Internet/tree/master/IRremote +bool IRrecv::decodeDaikin(decode_results *results, uint16_t nbits, + bool strict) { + if (results->rawlen < DAIKIN_RAW_BITS) + return false; + + // Compliance + if (strict && nbits != DAIKIN_RAW_BITS) + return false; + + uint16_t offset = OFFSET_START; + unsigned char daikin_code[DAIKIN_COMMAND_LENGTH + 2]; + for (uint8_t i = 0; i < DAIKIN_COMMAND_LENGTH+2; i++) + daikin_code[i] = 0; + + // Header (#1) + for (uint8_t i = 0; i < 10; i++) { + if (!matchMark(results->rawbuf[offset++], DAIKIN_BIT_MARK)) + return false; + } + if (!checkheader(results, &offset)) return false; + + // Data (#1) + if (!readbits(results, &offset, daikin_code, 8 * 8)) return false; + + // Ignore everything that has just been captured as it is not needed. + // Some remotes may not send this portion, my remote did, but it's not + // required. + for (uint8_t i = 0; i < DAIKIN_COMMAND_LENGTH + 2; i++) + daikin_code[i] = 0; + + // Header (#2) + if (!checkheader(results, &offset)) return false; + + // Data (#2) + if (!readbits(results, &offset, daikin_code, 8 * 8)) return false; + + // Header (#3) + if (!checkheader(results, &offset)) return false; + + // Data (#3), read up everything else + if (!readbits(results, &offset, daikin_code, DAIKIN_BITS - (8 * 8))) + return false; + + // Footer + if (!matchMark(results->rawbuf[offset++], DAIKIN_BIT_MARK)) + return false; + if (offset < results->rawlen && !matchAtLeast(results->rawbuf[offset], + DAIKIN_GAP)) + return false; + + // Compliance + if (strict) { + if (!IRDaikinESP::validChecksum(daikin_code)) return false; + } + + // Success +#if DAIKIN_DEBUG + IRDaikinESP dako = IRDaikinESP(0); + dako.setRaw(daikin_code); +#ifdef ARDUINO + yield(); +#endif // ARDUINO + dako.printState(); +#endif // DAIKIN_DEBUG + + // Copy across the bits to state + for (uint8_t i = 0; i < DAIKIN_COMMAND_LENGTH; i++) + results->state[i] = daikin_code[i]; + results->bits = DAIKIN_COMMAND_LENGTH * 8; + results->decode_type = DAIKIN; + return true; +} +#endif // DECODE_DAIKIN diff --git a/IRremoteESP8266/src/ir_Daikin.h b/IRremoteESP8266/src/ir_Daikin.h new file mode 100644 index 0000000..9ad9323 --- /dev/null +++ b/IRremoteESP8266/src/ir_Daikin.h @@ -0,0 +1,204 @@ +// Copyright 2016 sillyfrog +// Copyright 2017 sillyfrog, crankyoldgit +#ifndef IR_DAIKIN_H_ +#define IR_DAIKIN_H_ + +#ifndef UNIT_TEST +#include +#else +#include +#endif +#include "IRremoteESP8266.h" +#include "IRrecv.h" +#include "IRsend.h" + +// Option to disable the additional Daikin debug info to conserve memory +#define DAIKIN_DEBUG false + +// DDDDD AAA IIIII KK KK IIIII NN NN +// DD DD AAAAA III KK KK III NNN NN +// DD DD AA AA III KKKK III NN N NN +// DD DD AAAAAAA III KK KK III NN NNN +// DDDDDD AA AA IIIII KK KK IIIII NN NN + +/* + Daikin AC map + byte 5=Current time, mins past midnight, low bits + byte 6 + b0-b3=Current time, mins past midnight, high bits + byte 7= checksum of the first part (and last byte before a 29ms pause) + byte 13=mode + b7 = 0 + b6+b5+b4 = Mode + Modes: b6+b5+b4 + 011 = Cool + 100 = Heat (temp 23) + 110 = FAN (temp not shown, but 25) + 000 = Fully Automatic (temp 25) + 010 = DRY (temp 0xc0 = 96 degrees c) + b3 = 1 + b2 = OFF timer set + b1 = ON timer set + b0 = Air Conditioner ON + byte 14=temp*2 (Temp should be between 10 - 32) + byte 16=Fan + FAN control + b7+b6+b5+b4 = Fan speed + Fan: b7+b6+b5+b4 + 0×3 = 1 bar + 0×4 = 2 bar + 0×5 = 3 bar + 0×6 = 4 bar + 0×7 = 5 bar + 0xa = Auto + 0xb = Quite + b3+b2+b1+b0 = Swing control up/down + Swing control up/down: + 0000 = Swing up/down off + 1111 = Swing up/down on + byte 17 + Swing control left/right: + 0000 = Swing left/right off + 1111 = Swing left/right on + byte 18=On timer mins past midnight, low bits + byte 19 + b0-b3=On timer mins past midnight, high bits + b4-b7=Off timer mins past midnight, low bits + byte 20=Off timer mins past midnight, high bits + byte 21=Aux -> Powerful (bit 1), Silent (bit 5) + byte 24=Aux2 + b1: Sensor + b2: Econo mode + b7: Intelligent eye on + byte 25=Aux3 + b1: Mold Proof + byte 26= checksum of the second part +*/ + +// Constants +#define DAIKIN_COOL 0b011 +#define DAIKIN_HEAT 0b100 +#define DAIKIN_FAN 0b110 +#define DAIKIN_AUTO 0b000 +#define DAIKIN_DRY 0b010 +#define DAIKIN_MIN_TEMP 10U // Celsius +#define DAIKIN_MAX_TEMP 32U // Celsius +#define DAIKIN_FAN_MIN (uint8_t) 1U +#define DAIKIN_FAN_MAX (uint8_t) 5U +#define DAIKIN_FAN_AUTO (uint8_t) 0b1010 +#define DAIKIN_FAN_QUIET (uint8_t) 0b1011 + +#define DAIKIN_BYTE_POWER 13 +#define DAIKIN_BIT_POWER 0b00000001 + +#define DAIKIN_BYTE_POWERFUL 21 +#define DAIKIN_BIT_POWERFUL 0b00000001 +#define DAIKIN_BYTE_SILENT 21 +#define DAIKIN_BIT_SILENT 0b00100000 + +#define DAIKIN_BYTE_SENSOR 24 +#define DAIKIN_BIT_SENSOR 0b00000010 +#define DAIKIN_BYTE_ECONO 24 +#define DAIKIN_BIT_ECONO 0b00000100 +#define DAIKIN_BYTE_EYE 24 +#define DAIKIN_BIT_EYE 0b10000000 +#define DAIKIN_BYTE_MOLD 25 +#define DAIKIN_BIT_MOLD 0b00000010 + +#define DAIKIN_BYTE_OFF_TIMER 13 +#define DAIKIN_BIT_OFF_TIMER 0b00000100 +#define DAIKIN_BYTE_ON_TIMER 13 +#define DAIKIN_BIT_ON_TIMER 0b00000010 + +#define DAIKIN_CURBIT DAIKIN_COMMAND_LENGTH +#define DAIKIN_CURINDEX (DAIKIN_COMMAND_LENGTH + 1) +#define OFFSET_ERR 65432 + +#define DAIKIN_TOLERANCE 35 +#define DAIKIN_MARK_EXCESS MARK_EXCESS + +#define DAIKIN_HDR_MARK 3650U // DAIKIN_BIT_MARK * 8 +#define DAIKIN_HDR_SPACE 1623U // DAIKIN_BIT_MARK * 4 +#define DAIKIN_BIT_MARK 428U +#define DAIKIN_ZERO_SPACE 428U +#define DAIKIN_ONE_SPACE 1280U +#define DAIKIN_GAP 29000U + +// Note bits in each octet swapped so can be sent as a single value +#define DAIKIN_FIRST_HEADER64 \ + 0b1101011100000000000000001100010100000000001001111101101000010001 + +class IRDaikinESP { + public: + explicit IRDaikinESP(uint16_t pin); + +#if SEND_DAIKIN + void send(); +#endif + void begin(); + void on(); + void off(); + void setPower(bool state); + bool getPower(); + void setTemp(uint8_t temp); + uint8_t getTemp(); + void setFan(uint8_t fan); + uint8_t getFan(); + uint8_t getMode(); + void setMode(uint8_t mode); + void setSwingVertical(bool state); + bool getSwingVertical(); + void setSwingHorizontal(bool state); + bool getSwingHorizontal(); + bool getQuiet(); + void setQuiet(bool state); + bool getPowerful(); + void setPowerful(bool state); + void setSensor(bool state); + bool getSensor(); + void setEcono(bool state); + bool getEcono(); + void setEye(bool state); + bool getEye(); + void setMold(bool state); + bool getMold(); + void enableOnTimer(uint16_t starttime); + void disableOnTimer(); + uint16_t getOnTime(); + bool getOnTimerEnabled(); + void enableOffTimer(uint16_t endtime); + void disableOffTimer(); + uint16_t getOffTime(); + bool getOffTimerEnabled(); + void setCurrentTime(uint16_t time); + uint16_t getCurrentTime(); + uint8_t* getRaw(); + void setRaw(uint8_t new_code[]); +#if DAIKIN_DEBUG + void printState(); +#endif // DAIKIN_DEBUG + uint32_t getCommand(); + void setCommand(uint32_t value); + static bool validChecksum(const uint8_t state[], + const uint16_t length = DAIKIN_COMMAND_LENGTH); +#ifdef ARDUINO + String toString(); + static String renderTime(uint16_t timemins); +#else + std::string toString(); + static std::string renderTime(uint16_t timemins); +#endif + + private: + // # of bytes per command + uint8_t daikin[DAIKIN_COMMAND_LENGTH]; + void stateReset(); + static uint8_t calcBlockChecksum(const uint8_t *block, const uint16_t length); + void checksum(); + void setBit(uint8_t byte, uint8_t bitmask); + void clearBit(uint8_t byte, uint8_t bitmask); + uint8_t getBit(uint8_t byte, uint8_t bitmask); + IRsend _irsend; +}; + +#endif // IR_DAIKIN_H_ diff --git a/IRremoteESP8266/src/ir_Denon.cpp b/IRremoteESP8266/src/ir_Denon.cpp new file mode 100644 index 0000000..a4feb55 --- /dev/null +++ b/IRremoteESP8266/src/ir_Denon.cpp @@ -0,0 +1,152 @@ +// Copyright 2016 Massimiliano Pinto +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// DDDD EEEEE N N OOO N N +// D D E NN N O O NN N +// D D EEE N N N O O N N N +// D D E N NN O O N NN +// DDDD EEEEE N N OOO N N + +// Original Denon support added by https://github.com/csBlueChip +// Ported over by Massimiliano Pinto + +// Constants +// Ref: +// https://github.com/z3t0/Arduino-IRremote/blob/master/ir_Denon.cpp +#define DENON_TICK 263U +#define DENON_HDR_MARK_TICKS 1U +#define DENON_HDR_MARK (DENON_HDR_MARK_TICKS * DENON_TICK) +#define DENON_HDR_SPACE_TICKS 3U +#define DENON_HDR_SPACE (DENON_HDR_SPACE_TICKS * DENON_TICK) +#define DENON_BIT_MARK_TICKS 1U +#define DENON_BIT_MARK (DENON_BIT_MARK_TICKS * DENON_TICK) +#define DENON_ONE_SPACE_TICKS 7U +#define DENON_ONE_SPACE (DENON_ONE_SPACE_TICKS * DENON_TICK) +#define DENON_ZERO_SPACE_TICKS 3U +#define DENON_ZERO_SPACE (DENON_ZERO_SPACE_TICKS * DENON_TICK) +#define DENON_MIN_COMMAND_LENGTH_TICKS 510U +#define DENON_MIN_COMMAND_LENGTH (DENON_MIN_COMMAND_LENGTH_TICKS * DENON_TICK) +#define DENON_MIN_GAP_TICKS (DENON_MIN_COMMAND_LENGTH_TICKS - \ + (DENON_HDR_MARK_TICKS + DENON_HDR_SPACE_TICKS + \ + DENON_BITS * (DENON_BIT_MARK_TICKS + DENON_ONE_SPACE_TICKS) + \ + DENON_BIT_MARK_TICKS)) +#define DENON_MIN_GAP (DENON_MIN_GAP_TICKS * DENON_TICK) +#define DENON_MANUFACTURER 0x2A4CULL + +#if SEND_DENON +// Send a Denon message +// +// Args: +// data: Contents of the message to be sent. +// nbits: Nr. of bits of data to be sent. Typically DENON_BITS. +// repeat: Nr. of additional times the message is to be sent. +// +// Status: BETA / Should be working. +// +// Notes: +// Some Denon devices use a Kaseikyo/Panasonic 48-bit format +// Others use the Sharp protocol. +// Ref: +// https://github.com/z3t0/Arduino-IRremote/blob/master/ir_Denon.cpp +// http://assets.denon.com/documentmaster/us/denon%20master%20ir%20hex.xls +void IRsend::sendDenon(uint64_t data, uint16_t nbits, uint16_t repeat) { + if (nbits >= PANASONIC_BITS) // Is this really Panasonic? + sendPanasonic64(data, nbits, repeat); + else if (nbits == DENON_LEGACY_BITS) + // Support legacy (broken) calls of sendDenon(). + sendSharpRaw(data & (~0x2000ULL), nbits + 1, repeat); + else + sendSharpRaw(data, nbits, repeat); +} +#endif + +#if DECODE_DENON +// Decode a Denon message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Expected nr. of data bits. (Typically DENON_BITS) +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / Should work fine. +// +// Ref: +// https://github.com/z3t0/Arduino-IRremote/blob/master/ir_Denon.cpp +bool IRrecv::decodeDenon(decode_results *results, uint16_t nbits, bool strict) { + // Compliance + if (strict) { + switch (nbits) { + case DENON_BITS: + case DENON_48_BITS: + case DENON_LEGACY_BITS: + break; + default: + return false; + } + } + + // Denon uses the Sharp & Panasonic(Kaseikyo) protocol for some + // devices, so check for those first. + // It is not exactly like Sharp's protocols, but close enough. + // e.g. The expansion bit is not set for Denon vs. set for Sharp. + // Ditto for Panasonic, it's the same except for a different + // manufacturer code. + + if (!decodeSharp(results, nbits, true, false) && + !decodePanasonic(results, nbits, true, DENON_MANUFACTURER)) { + // We couldn't decode it as expected, so try the old legacy method. + // NOTE: I don't think this following protocol actually exists. + // Looks like a partial version of the Sharp protocol. + // Check we have enough data + if (results->rawlen < 2 * nbits + HEADER + FOOTER - 1) + return false; + if (strict && nbits != DENON_LEGACY_BITS) + return false; + + uint64_t data = 0; + uint16_t offset = OFFSET_START; + + // Header + if (!matchMark(results->rawbuf[offset], DENON_HDR_MARK)) return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t m_tick = results->rawbuf[offset++] * RAWTICK / + DENON_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset], DENON_HDR_SPACE)) return false; + uint32_t s_tick = results->rawbuf[offset++] * RAWTICK / + DENON_HDR_SPACE_TICKS; + + // Data + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + DENON_BIT_MARK_TICKS * m_tick, + DENON_ONE_SPACE_TICKS * s_tick, + DENON_BIT_MARK_TICKS * m_tick, + DENON_ZERO_SPACE_TICKS * s_tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + + // Footer + if (!matchMark(results->rawbuf[offset++], DENON_BIT_MARK_TICKS * m_tick)) + return false; + + // Success + results->bits = nbits; + results->value = data; + results->address = 0; + results->command = 0; + } // Legacy decode. + + // Compliance + if (strict && nbits != results->bits) return false; + + // Success + results->decode_type = DENON; + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Dish.cpp b/IRremoteESP8266/src/ir_Dish.cpp new file mode 100644 index 0000000..f5daf21 --- /dev/null +++ b/IRremoteESP8266/src/ir_Dish.cpp @@ -0,0 +1,139 @@ +// Copyright Todd Treece +// Copyright 2017 David Conran + +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// DDDD IIIII SSSS H H +// D D I S H H +// D D I SSS HHHHH +// D D I S H H +// DDDD IIIII SSSS H H + +// DISH support originally by Todd Treece +// http://unionbridge.org/design/ircommand + +// Constants +// Ref: +// https://github.com/marcosamarinho/IRremoteESP8266/blob/master/ir_Dish.cpp +// http://www.hifi-remote.com/wiki/index.php?title=Dish +#define DISH_TICK 100U +#define DISH_HDR_MARK_TICKS 4U +#define DISH_HDR_MARK (DISH_HDR_MARK_TICKS * DISH_TICK) +#define DISH_HDR_SPACE_TICKS 61U +#define DISH_HDR_SPACE (DISH_HDR_SPACE_TICKS * DISH_TICK) +#define DISH_BIT_MARK_TICKS 4U +#define DISH_BIT_MARK (DISH_BIT_MARK_TICKS * DISH_TICK) +#define DISH_ONE_SPACE_TICKS 17U +#define DISH_ONE_SPACE (DISH_ONE_SPACE_TICKS * DISH_TICK) +#define DISH_ZERO_SPACE_TICKS 28U +#define DISH_ZERO_SPACE (DISH_ZERO_SPACE_TICKS * DISH_TICK) +#define DISH_RPT_SPACE_TICKS DISH_HDR_SPACE_TICKS +#define DISH_RPT_SPACE (DISH_RPT_SPACE_TICKS * DISH_TICK) + +#if SEND_DISH +// Send an IR command to a DISH NETWORK device. +// +// Args: +// data: The contents of the command you want to send. +// nbits: The bit size of the command being sent. +// repeat: The number of times you want the command to be repeated. +// +// Status: BETA / Previously working. +// +// Note: +// Dishplayer is a different protocol. +// Typically a DISH device needs to get a command a total of at least 4 +// times to accept it. e.g. repeat=3 +// +// Here is the LIRC file I found that seems to match the remote codes from the +// oscilloscope: +// DISH NETWORK (echostar 301): +// http://lirc.sourceforge.net/remotes/echostar/301_501_3100_5100_58xx_59xx +// +// Ref: +// http://www.hifi-remote.com/wiki/index.php?title=Dish +void IRsend::sendDISH(uint64_t data, uint16_t nbits, uint16_t repeat) { + enableIROut(57600); // Set modulation freq. to 57.6kHz. + // Header is only ever sent once. + mark(DISH_HDR_MARK); + space(DISH_HDR_SPACE); + + sendGeneric(0, 0, // No headers from here on in. + DISH_BIT_MARK, DISH_ONE_SPACE, + DISH_BIT_MARK, DISH_ZERO_SPACE, + DISH_BIT_MARK, DISH_RPT_SPACE, + data, nbits, 57600, true, repeat, 50); +} +#endif + +#if DECODE_DISH +// Decode the supplied DISH NETWORK message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of bits to expect in the data portion. Typically DISH_BITS. +// strict: Flag to indicate if we strictly adhere to the specification. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: ALPHA (untested and unconfirmed.) +// +// Note: +// Dishplayer is a different protocol. +// Typically a DISH device needs to get a command a total of at least 4 +// times to accept it. +// Ref: +// http://www.hifi-remote.com/wiki/index.php?title=Dish +// http://lirc.sourceforge.net/remotes/echostar/301_501_3100_5100_58xx_59xx +// https://github.com/marcosamarinho/IRremoteESP8266/blob/master/ir_Dish.cpp +bool IRrecv::decodeDISH(decode_results *results, uint16_t nbits, bool strict) { + if (results->rawlen < 2 * nbits + HEADER + FOOTER - 1) + return false; // Not enough entries to be valid. + if (strict && nbits != DISH_BITS) + return false; // Not strictly compliant. + + uint64_t data = 0; + uint16_t offset = OFFSET_START; + + // Header + if (!match(results->rawbuf[offset], DISH_HDR_MARK)) return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t m_tick = results->rawbuf[offset++] * RAWTICK / DISH_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset], DISH_HDR_SPACE)) return false; + // Calculate how long the common tick time is based on the header space. + uint32_t s_tick = results->rawbuf[offset++] * RAWTICK / DISH_HDR_SPACE_TICKS; + + // Data + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + DISH_BIT_MARK_TICKS * m_tick, + DISH_ONE_SPACE_TICKS * s_tick, + DISH_BIT_MARK_TICKS * m_tick, + DISH_ZERO_SPACE_TICKS * s_tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + + // Footer + if (!matchMark(results->rawbuf[offset++], DISH_BIT_MARK_TICKS * m_tick)) + return false; + + // Compliance + if (strict) { + // The DISH protocol calls for a repeated message, so strictly speaking + // there should be a code following this. Only require it if we are set to + // strict matching. + if (!matchSpace(results->rawbuf[offset], DISH_RPT_SPACE_TICKS * s_tick)) + return false; + } + + // Success + results->decode_type = DISH; + results->bits = nbits; + results->value = data; + results->address = 0; + results->command = 0; + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Fujitsu.cpp b/IRremoteESP8266/src/ir_Fujitsu.cpp new file mode 100644 index 0000000..70e786b --- /dev/null +++ b/IRremoteESP8266/src/ir_Fujitsu.cpp @@ -0,0 +1,547 @@ +// Copyright 2017 Jonny Graham, David Conran +#include "ir_Fujitsu.h" +#include +#ifndef ARDUINO +#include +#endif +#include "IRsend.h" +#include "IRutils.h" + + +// Fujitsu A/C support added by Jonny Graham & David Conran + +// Equipment it seems compatible with: +// * Fujitsu ASYG30LFCA with remote AR-RAH2E +// * Fujitsu AST9RSGCW with remote AR-DB1 +// * + +// Ref: +// These values are based on averages of measurements +#define FUJITSU_AC_HDR_MARK 3324U +#define FUJITSU_AC_HDR_SPACE 1574U +#define FUJITSU_AC_BIT_MARK 448U +#define FUJITSU_AC_ONE_SPACE 1182U +#define FUJITSU_AC_ZERO_SPACE 390U +#define FUJITSU_AC_MIN_GAP 8100U + +#if SEND_FUJITSU_AC +// Send a Fujitsu A/C message. +// +// Args: +// data: An array of bytes containing the IR command. +// nbytes: Nr. of bytes of data in the array. Typically one of: +// FUJITSU_AC_STATE_LENGTH +// FUJITSU_AC_STATE_LENGTH - 1 +// FUJITSU_AC_STATE_LENGTH_SHORT +// FUJITSU_AC_STATE_LENGTH_SHORT - 1 +// repeat: Nr. of times the message is to be repeated. +// (Default = FUJITSU_AC_MIN_REPEAT). +// +// Status: BETA / Appears to be working. +// +void IRsend::sendFujitsuAC(unsigned char data[], uint16_t nbytes, + uint16_t repeat) { + sendGeneric(FUJITSU_AC_HDR_MARK, FUJITSU_AC_HDR_SPACE, + FUJITSU_AC_BIT_MARK, FUJITSU_AC_ONE_SPACE, + FUJITSU_AC_BIT_MARK, FUJITSU_AC_ZERO_SPACE, + FUJITSU_AC_BIT_MARK, FUJITSU_AC_MIN_GAP, + data, nbytes, 38, false, repeat, 50); +} +#endif // SEND_FUJITSU_AC + +// Code to emulate Fujitsu A/C IR remote control unit. + +// Initialise the object. +IRFujitsuAC::IRFujitsuAC(uint16_t pin, fujitsu_ac_remote_model_t model) + : _irsend(pin) { + setModel(model); + stateReset(); +} + +void IRFujitsuAC::setModel(fujitsu_ac_remote_model_t model) { + _model = model; + switch (model) { + case ARDB1: + _state_length = FUJITSU_AC_STATE_LENGTH - 1; + _state_length_short = FUJITSU_AC_STATE_LENGTH_SHORT - 1; + break; + default: + _state_length = FUJITSU_AC_STATE_LENGTH; + _state_length_short = FUJITSU_AC_STATE_LENGTH_SHORT; + } +} + +// Reset the state of the remote to a known good state/sequence. +void IRFujitsuAC::stateReset() { + _temp = 24; + _fanSpeed = FUJITSU_AC_FAN_HIGH; + _mode = FUJITSU_AC_MODE_COOL; + _swingMode = FUJITSU_AC_SWING_BOTH; + _cmd = FUJITSU_AC_CMD_TURN_ON; + buildState(); +} + +// Configure the pin for output. +void IRFujitsuAC::begin() { + _irsend.begin(); +} + +#if SEND_FUJITSU_AC +// Send the current desired state to the IR LED. +void IRFujitsuAC::send() { + getRaw(); + _irsend.sendFujitsuAC(remote_state, getStateLength()); +} +#endif // SEND_FUJITSU_AC + +void IRFujitsuAC::buildState() { + remote_state[0] = 0x14; + remote_state[1] = 0x63; + remote_state[2] = 0x00; + remote_state[3] = 0x10; + remote_state[4] = 0x10; + bool fullCmd = false; + switch (_cmd) { + case FUJITSU_AC_CMD_TURN_OFF: + remote_state[5] = 0x02; + break; + case FUJITSU_AC_CMD_STEP_HORIZ: + remote_state[5] = 0x79; + break; + case FUJITSU_AC_CMD_STEP_VERT: + remote_state[5] = 0x6C; + break; + default: + switch (_model) { + case ARRAH2E: + remote_state[5] = 0xFE; + break; + case ARDB1: + remote_state[5] = 0xFC; + break; + } + fullCmd = true; + break; + } + if (fullCmd) { // long codes + uint8_t tempByte = _temp - FUJITSU_AC_MIN_TEMP; + // Nr. of bytes in the message after this byte. + remote_state[6] = _state_length - 7; + + remote_state[7] = 0x30; + remote_state[8] = (_cmd == FUJITSU_AC_CMD_TURN_ON) | (tempByte << 4); + remote_state[9] = _mode | 0 << 4; // timer off + remote_state[10] = _fanSpeed | _swingMode << 4; + remote_state[11] = 0; // timerOff values + remote_state[12] = 0; // timerOff/On values + remote_state[13] = 0; // timerOn values + if (_model == ARRAH2E) + remote_state[14] = 0x20; + else + remote_state[14] = 0x00; + + uint8_t checksum = 0; + uint8_t checksum_complement = 0; + if (_model == ARRAH2E) { + checksum = sumBytes(remote_state + _state_length_short, + _state_length - _state_length_short - 1); + } else if (_model == ARDB1) { + checksum = sumBytes(remote_state, _state_length - 1); + checksum_complement = 0x9B; + } + // and negate the checksum and store it in the last byte. + remote_state[_state_length - 1] = checksum_complement - checksum; + } else { // short codes + if (_model == ARRAH2E) + // The last byte is the inverse of penultimate byte + remote_state[_state_length_short - 1] = ~remote_state[_state_length_short + - 2]; + // Zero the rest of the state. + for (uint8_t i = _state_length_short; + i < FUJITSU_AC_STATE_LENGTH; + i++) + remote_state[i] = 0; + } +} + +uint8_t IRFujitsuAC::getStateLength() { + buildState(); // Force an update of the internal state. + if ((_model == ARRAH2E && remote_state[5] != 0xFE) || + (_model == ARDB1 && remote_state[5] != 0xFC)) + return _state_length_short; + else + return _state_length; +} + +// Return a pointer to the internal state date of the remote. +uint8_t* IRFujitsuAC::getRaw() { + buildState(); + return remote_state; +} + +void IRFujitsuAC::buildFromState(const uint16_t length) { + switch (length) { + case FUJITSU_AC_STATE_LENGTH - 1: + case FUJITSU_AC_STATE_LENGTH_SHORT - 1: + setModel(ARDB1); + break; + default: + setModel(ARRAH2E); + } + switch (remote_state[6]) { + case 8: + setModel(ARDB1); + break; + case 9: + setModel(ARRAH2E); + break; + } + setTemp((remote_state[8] >> 4) + FUJITSU_AC_MIN_TEMP); + if (remote_state[8] & 0x1) + setCmd(FUJITSU_AC_CMD_TURN_ON); + else + setCmd(FUJITSU_AC_CMD_STAY_ON); + setMode(remote_state[9] & 0b111); + setFanSpeed(remote_state[10] & 0b111); + setSwing(remote_state[10] >> 4); + switch (remote_state[5]) { + case FUJITSU_AC_CMD_TURN_OFF: + case FUJITSU_AC_CMD_STEP_HORIZ: + case FUJITSU_AC_CMD_STEP_VERT: + setCmd(remote_state[5]); + break; + } +} + +bool IRFujitsuAC::setRaw(const uint8_t newState[], const uint16_t length) { + if (length > FUJITSU_AC_STATE_LENGTH) return false; + for (uint16_t i = 0; i < FUJITSU_AC_STATE_LENGTH; i++) { + if (i < length) + remote_state[i] = newState[i]; + else + remote_state[i] = 0; + } + buildFromState(length); + return true; +} + +// Set the requested power state of the A/C to off. +void IRFujitsuAC::off() { + _cmd = FUJITSU_AC_CMD_TURN_OFF; +} + +void IRFujitsuAC::stepHoriz() { + switch (_model) { + case ARDB1: break; // This remote doesn't have a horizontal option. + default: + _cmd = FUJITSU_AC_CMD_STEP_HORIZ; + } +} + +void IRFujitsuAC::stepVert() { + _cmd = FUJITSU_AC_CMD_STEP_VERT; +} + +// Set the requested command of the A/C. +void IRFujitsuAC::setCmd(uint8_t cmd) { + switch (cmd) { + case FUJITSU_AC_CMD_TURN_OFF: + case FUJITSU_AC_CMD_TURN_ON: + case FUJITSU_AC_CMD_STAY_ON: + case FUJITSU_AC_CMD_STEP_VERT: + _cmd = cmd; + break; + case FUJITSU_AC_CMD_STEP_HORIZ: + if (_model != ARDB1) // AR-DB1 remote doesn't have step horizontal. + _cmd = cmd; + default: + _cmd = FUJITSU_AC_CMD_STAY_ON; + break; + } +} + +uint8_t IRFujitsuAC::getCmd() { + return _cmd; +} + +bool IRFujitsuAC::getPower() { + return _cmd != FUJITSU_AC_CMD_TURN_OFF; +} + +// Set the temp. in deg C +void IRFujitsuAC::setTemp(uint8_t temp) { + temp = std::max((uint8_t) FUJITSU_AC_MIN_TEMP, temp); + temp = std::min((uint8_t) FUJITSU_AC_MAX_TEMP, temp); + _temp = temp; +} + +uint8_t IRFujitsuAC::getTemp() { + return _temp; +} + +// Set the speed of the fan +void IRFujitsuAC::setFanSpeed(uint8_t fanSpeed) { + if (fanSpeed > FUJITSU_AC_FAN_QUIET) + fanSpeed = FUJITSU_AC_FAN_HIGH; // Set the fan to maximum if out of range. + _fanSpeed = fanSpeed; +} +uint8_t IRFujitsuAC::getFanSpeed() { + return _fanSpeed; +} + +// Set the requested climate operation mode of the a/c unit. +void IRFujitsuAC::setMode(uint8_t mode) { + if (mode > FUJITSU_AC_MODE_HEAT) + mode = FUJITSU_AC_MODE_HEAT; // Set the mode to maximum if out of range. + _mode = mode; +} + +uint8_t IRFujitsuAC::getMode() { + return _mode; +} +// Set the requested swing operation mode of the a/c unit. +void IRFujitsuAC::setSwing(uint8_t swingMode) { + switch (_model) { + case ARDB1: + // Set the mode to max if out of range + if (swingMode > FUJITSU_AC_SWING_VERT) + swingMode = FUJITSU_AC_SWING_VERT; + break; + case ARRAH2E: + default: + // Set the mode to max if out of range + if (swingMode > FUJITSU_AC_SWING_BOTH) + swingMode = FUJITSU_AC_SWING_BOTH; + } + _swingMode = swingMode; +} + +uint8_t IRFujitsuAC::getSwing() { + return _swingMode; +} + +bool IRFujitsuAC::validChecksum(uint8_t state[], uint16_t length) { + uint8_t sum = 0; + uint8_t sum_complement = 0; + uint8_t checksum = 0; + switch (length) { + case FUJITSU_AC_STATE_LENGTH_SHORT: // ARRAH2E + return state[length - 1] == (uint8_t) ~state[length - 2]; + case FUJITSU_AC_STATE_LENGTH - 1: // ARDB1 + sum = sumBytes(state, length - 1); + sum_complement = 0x9B; + checksum = state[length - 1]; + break; + case FUJITSU_AC_STATE_LENGTH: // ARRAH2E + sum = sumBytes(state + FUJITSU_AC_STATE_LENGTH_SHORT, + length - 1 - FUJITSU_AC_STATE_LENGTH_SHORT); + default: // Includes ARDB1 short. + return true; // Assume the checksum is valid for other lengths. + } + return checksum == (uint8_t) (sum_complement - sum); // Does it match? +} + +// Convert the internal state into a human readable string. +#ifdef ARDUINO +String IRFujitsuAC::toString() { + String result = ""; +#else +std::string IRFujitsuAC::toString() { + std::string result = ""; +#endif // ARDUINO + result += "Power: "; + if (getPower()) + result += "On"; + else + result += "Off"; + result += ", Mode: " + uint64ToString(getMode()); + switch (getMode()) { + case FUJITSU_AC_MODE_AUTO: + result += " (AUTO)"; + break; + case FUJITSU_AC_MODE_COOL: + result += " (COOL)"; + break; + case FUJITSU_AC_MODE_HEAT: + result += " (HEAT)"; + break; + case FUJITSU_AC_MODE_DRY: + result += " (DRY)"; + break; + case FUJITSU_AC_MODE_FAN: + result += " (FAN)"; + break; + default: + result += " (UNKNOWN)"; + } + result += ", Temp: " + uint64ToString(getTemp()) + "C"; + result += ", Fan: " + uint64ToString(getFanSpeed()); + switch (getFanSpeed()) { + case FUJITSU_AC_FAN_AUTO: + result += " (AUTO)"; + break; + case FUJITSU_AC_FAN_HIGH: + result += " (HIGH)"; + break; + case FUJITSU_AC_FAN_MED: + result += " (MED)"; + break; + case FUJITSU_AC_FAN_LOW: + result += " (LOW)"; + break; + case FUJITSU_AC_FAN_QUIET: + result += " (QUIET)"; + break; + } + result += ", Swing: "; + switch (getSwing()) { + case FUJITSU_AC_SWING_OFF: + result += "Off"; + break; + case FUJITSU_AC_SWING_VERT: + result += "Vert"; + break; + case FUJITSU_AC_SWING_HORIZ: + result += "Horiz"; + break; + case FUJITSU_AC_SWING_BOTH: + result += "Vert + Horiz"; + break; + default: + result += "UNKNOWN"; + } + result += ", Command: "; + switch (getCmd()) { + case FUJITSU_AC_CMD_STEP_HORIZ: + result += "Step vane horizontally"; + break; + case FUJITSU_AC_CMD_STEP_VERT: + result += "Step vane vertically"; + break; + default: + result += "N/A"; + } + return result; +} + +#if DECODE_FUJITSU_AC +// Decode a Fujitsu AC IR message if possible. +// Places successful decode information in the results pointer. +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. Typically FUJITSU_AC_BITS. +// strict: Flag to indicate if we strictly adhere to the specification. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: ALPHA / Untested. +// +// Ref: +// +bool IRrecv::decodeFujitsuAC(decode_results *results, uint16_t nbits, + bool strict) { + uint16_t offset = OFFSET_START; + uint16_t dataBitsSoFar = 0; + + // Have we got enough data to successfully decode? + if (results->rawlen < (2 * FUJITSU_AC_MIN_BITS) + HEADER + FOOTER - 1) + return false; // Can't possibly be a valid message. + + + // Compliance + if (strict) { + switch (nbits) { + case FUJITSU_AC_BITS: + case FUJITSU_AC_BITS - 8: + case FUJITSU_AC_MIN_BITS: + case FUJITSU_AC_MIN_BITS + 8: + break; + default: + return false; // Must be called with the correct nr. of bits. + } + } + + // Header + if (!matchMark(results->rawbuf[offset++], FUJITSU_AC_HDR_MARK)) + return false; + if (!matchSpace(results->rawbuf[offset++], FUJITSU_AC_HDR_SPACE)) + return false; + + // Data (Fixed signature) + match_result_t data_result = matchData(&(results->rawbuf[offset]), + FUJITSU_AC_MIN_BITS - 8, + FUJITSU_AC_BIT_MARK, + FUJITSU_AC_ONE_SPACE, + FUJITSU_AC_BIT_MARK, + FUJITSU_AC_ZERO_SPACE); + if (data_result.success == false) return false; // Fail + if (reverseBits(data_result.data, FUJITSU_AC_MIN_BITS - 8) != 0x1010006314) + return false; // Signature failed. + dataBitsSoFar += FUJITSU_AC_MIN_BITS - 8; + offset += data_result.used; + results->state[0] = 0x14; + results->state[1] = 0x63; + results->state[2] = 0x00; + results->state[3] = 0x10; + results->state[4] = 0x10; + + // Keep reading bytes until we either run out of message or state to fill. + for (uint16_t i = 5; + offset <= results->rawlen - 16 && i < FUJITSU_AC_STATE_LENGTH; + i++, dataBitsSoFar += 8, offset += data_result.used) { + data_result = matchData(&(results->rawbuf[offset]), 8, + FUJITSU_AC_BIT_MARK, + FUJITSU_AC_ONE_SPACE, + FUJITSU_AC_BIT_MARK, + FUJITSU_AC_ZERO_SPACE); + if (data_result.success == false) break; // Fail + results->state[i] = (uint8_t) reverseBits(data_result.data, 8); + } + + // Footer + if (offset > results->rawlen || + !matchMark(results->rawbuf[offset++], FUJITSU_AC_BIT_MARK)) return false; + // The space is optional if we are out of capture. + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], FUJITSU_AC_MIN_GAP)) return false; + + // Compliance + if (strict) { + if (dataBitsSoFar != nbits) return false; + } + + results->decode_type = FUJITSU_AC; + results->bits = dataBitsSoFar; + + // Compliance + switch (dataBitsSoFar) { + case FUJITSU_AC_MIN_BITS: + // Check if this values indicate that this should have been a long state + // message. + if (results->state[5] == 0xFC) return false; + return true; // Success + case FUJITSU_AC_MIN_BITS + 8: + // Check if this values indicate that this should have been a long state + // message. + if (results->state[5] == 0xFE) return false; + // The last byte needs to be the inverse of the penultimate byte. + if (results->state[5] != (uint8_t) ~results->state[6]) return false; + return true; // Success + case FUJITSU_AC_BITS - 8: + // Long messages of this size require this byte be correct. + if (results->state[5] != 0xFC) return false; + break; + case FUJITSU_AC_BITS: + // Long messages of this size require this byte be correct. + if (results->state[5] != 0xFE) return false; + break; + default: + return false; // Unexpected size. + } + if (!IRFujitsuAC::validChecksum(results->state, dataBitsSoFar / 8)) + return false; + + // Success + return true; // All good. +} +#endif // DECODE_FUJITSU_AC diff --git a/IRremoteESP8266/src/ir_Fujitsu.h b/IRremoteESP8266/src/ir_Fujitsu.h new file mode 100644 index 0000000..ed6317d --- /dev/null +++ b/IRremoteESP8266/src/ir_Fujitsu.h @@ -0,0 +1,102 @@ +// Copyright 2017 Jonny Graham +#ifndef IR_FUJITSU_H_ +#define IR_FUJITSU_H_ + +#define __STDC_LIMIT_MACROS +#include +#ifdef ARDUINO +#include +#else +#include +#endif +#include "IRremoteESP8266.h" +#include "IRrecv.h" +#include "IRsend.h" + + +// FUJITSU A/C support added by Jonny Graham + +// Constants + +#define FUJITSU_AC_MODE_AUTO 0x00U +#define FUJITSU_AC_MODE_COOL 0x01U +#define FUJITSU_AC_MODE_DRY 0x02U +#define FUJITSU_AC_MODE_FAN 0x03U +#define FUJITSU_AC_MODE_HEAT 0x04U + +#define FUJITSU_AC_CMD_STAY_ON 0x00U +#define FUJITSU_AC_CMD_TURN_ON 0x01U +#define FUJITSU_AC_CMD_TURN_OFF 0x02U +#define FUJITSU_AC_CMD_STEP_HORIZ 0x79U +#define FUJITSU_AC_CMD_STEP_VERT 0x6CU + +#define FUJITSU_AC_FAN_AUTO 0x00U +#define FUJITSU_AC_FAN_HIGH 0x01U +#define FUJITSU_AC_FAN_MED 0x02U +#define FUJITSU_AC_FAN_LOW 0x03U +#define FUJITSU_AC_FAN_QUIET 0x04U + +#define FUJITSU_AC_MIN_TEMP 16U // 16C +#define FUJITSU_AC_MAX_TEMP 30U // 30C + +#define FUJITSU_AC_SWING_OFF 0x00U +#define FUJITSU_AC_SWING_VERT 0x01U +#define FUJITSU_AC_SWING_HORIZ 0x02U +#define FUJITSU_AC_SWING_BOTH 0x03U + + +enum fujitsu_ac_remote_model_t { + ARRAH2E = 1, + ARDB1, +}; + +class IRFujitsuAC { + public: + explicit IRFujitsuAC(uint16_t pin, fujitsu_ac_remote_model_t model = ARRAH2E); + + void setModel(fujitsu_ac_remote_model_t model); + void stateReset(); +#if SEND_FUJITSU_AC + void send(); +#endif // SEND_FUJITSU_AC + void begin(); + void off(); + void stepHoriz(); + void stepVert(); + void setCmd(uint8_t cmd); + uint8_t getCmd(); + void setTemp(uint8_t temp); + uint8_t getTemp(); + void setFanSpeed(uint8_t fan); + uint8_t getFanSpeed(); + void setMode(uint8_t mode); + uint8_t getMode(); + void setSwing(uint8_t mode); + uint8_t getSwing(); + uint8_t* getRaw(); + bool setRaw(const uint8_t newState[], const uint16_t length); + uint8_t getStateLength(); + static bool validChecksum(uint8_t *state, uint16_t length); + bool getPower(); + #ifdef ARDUINO + String toString(); + #else + std::string toString(); + #endif + + private: + uint8_t remote_state[FUJITSU_AC_STATE_LENGTH]; + IRsend _irsend; + uint8_t _temp; + uint8_t _fanSpeed; + uint8_t _mode; + uint8_t _swingMode; + uint8_t _cmd; + fujitsu_ac_remote_model_t _model; + uint8_t _state_length; + uint8_t _state_length_short; + void buildState(); + void buildFromState(const uint16_t length); +}; + +#endif // IR_FUJITSU_H_ diff --git a/IRremoteESP8266/src/ir_GlobalCache.cpp b/IRremoteESP8266/src/ir_GlobalCache.cpp new file mode 100644 index 0000000..bf0a82a --- /dev/null +++ b/IRremoteESP8266/src/ir_GlobalCache.cpp @@ -0,0 +1,71 @@ +// Copyright 2016 Hisham Khalifa +// Copyright 2017 David Conran + +#include +#include "IRsend.h" + +// GGG L OOOO BBBB AA L CCCC AA CCCC H H EEEEEE +// G G L O O B B AAAA L C C AAAA C C H H E +// G L O O BBBBB A A L C A A C HHHHHH EEEE +// G GG L O O B BB AAAAAA L C C AAAAAA C C H H E +// GGGGG LLLLLL OOOO BBBBB A A LLLLLL CCCC A A CCCC H H EEEEEE + +// Global Cache IR format sender originally added by Hisham Khalifa +// (http://www.hishamkhalifa.com) + +// Constants +#define GLOBALCACHE_MAX_REPEAT 50U +#define GLOBALCACHE_MIN_USEC 80U +#define GLOBALCACHE_FREQ_INDEX 0U +#define GLOBALCACHE_RPT_INDEX GLOBALCACHE_FREQ_INDEX + 1U +#define GLOBALCACHE_RPT_START_INDEX GLOBALCACHE_RPT_INDEX + 1U +#define GLOBALCACHE_START_INDEX GLOBALCACHE_RPT_START_INDEX + 1U + +#if SEND_GLOBALCACHE +// Send a shortened GlobalCache (GC) IRdb/control tower formatted message. +// +// Args: +// buf: An array of uint16_t containing the shortened GlobalCache data. +// len: Nr. of entries in the buf[] array. +// +// Status: STABLE / Known working. +// +// Note: +// Global Cache format without the emitter ID or request ID. +// Starts at the frequency (Hertz), followed by nr. of times to emit (count), +// then the offset for repeats (where a repeat will start from), +// then the rest of entries are the actual IR message as units of periodic +// time. +// e.g. sendir,1:1,1,38000,1,1,9,70,9,30,9,... -> 38000,1,1,9,70,9,30,9,... +// Ref: +// https://irdb.globalcache.com/Home/Database +void IRsend::sendGC(uint16_t buf[], uint16_t len) { + uint16_t hz = buf[GLOBALCACHE_FREQ_INDEX]; // GC frequency is in Hz. + enableIROut(hz); + uint32_t periodic_time = calcUSecPeriod(hz, false); + uint8_t emits = std::min(buf[GLOBALCACHE_RPT_INDEX], + (uint16_t) GLOBALCACHE_MAX_REPEAT); + // Repeat + for (uint8_t repeat = 0; repeat < emits; repeat++) { + // First time through, start at the beginning (GLOBALCACHE_START_INDEX), + // otherwise for repeats, we start a specified offset from that. + uint16_t offset = GLOBALCACHE_START_INDEX; + if (repeat) + offset += buf[GLOBALCACHE_RPT_START_INDEX] - 1; + // Data + for (; offset < len; offset++) { + // Convert periodic units to microseconds. + // Minimum is GLOBALCACHE_MIN_USEC for actual GC units. + uint32_t microseconds = std::max(buf[offset] * periodic_time, + GLOBALCACHE_MIN_USEC); + // These codes start at an odd index (not even as with sendRaw). + if (offset & 1) // Odd bit. + mark(microseconds); + else // Even bit. + space(microseconds); + } + } + // It's possible that we've ended on a mark(), thus ensure the LED is off. + ledOff(); +} +#endif diff --git a/IRremoteESP8266/src/ir_Gree.cpp b/IRremoteESP8266/src/ir_Gree.cpp new file mode 100644 index 0000000..885b06a --- /dev/null +++ b/IRremoteESP8266/src/ir_Gree.cpp @@ -0,0 +1,498 @@ +// Copyright 2017 Ville Skyttä (scop) +// Copyright 2017, 2018 David Conran +// +// Code to emulate Gree protocol compatible HVAC devices. +// Should be compatible with: +// * Heat pumps carrying the "Ultimate" brand name. +// * EKOKAI air conditioners. +// + +#include "ir_Gree.h" +#include +#ifndef ARDUINO +#include +#endif +#include "IRremoteESP8266.h" +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" +#include "ir_Kelvinator.h" + +// GGGG RRRRRR EEEEEEE EEEEEEE +// GG GG RR RR EE EE +// GG RRRRRR EEEEE EEEEE +// GG GG RR RR EE EE +// GGGGGG RR RR EEEEEEE EEEEEEE + +// Constants +// Ref: https://github.com/ToniA/arduino-heatpumpir/blob/master/GreeHeatpumpIR.h +#define GREE_HDR_MARK 9000U +#define GREE_HDR_SPACE 4000U +#define GREE_BIT_MARK 620U +#define GREE_ONE_SPACE 1600U +#define GREE_ZERO_SPACE 540U +#define GREE_MSG_SPACE 19000U +#define GREE_BLOCK_FOOTER 0b010U +#define GREE_BLOCK_FOOTER_BITS 3U + +#if SEND_GREE +// Send a Gree Heat Pump message. +// +// Args: +// data: An array of bytes containing the IR command. +// nbytes: Nr. of bytes of data in the array. (>=GREE_STATE_LENGTH) +// repeat: Nr. of times the message is to be repeated. (Default = 0). +// +// Status: ALPHA / Untested. +// +// Ref: +// https://github.com/ToniA/arduino-heatpumpir/blob/master/GreeHeatpumpIR.cpp +void IRsend::sendGree(unsigned char data[], uint16_t nbytes, uint16_t repeat) { + if (nbytes < GREE_STATE_LENGTH) + return; // Not enough bytes to send a proper message. + + for (uint16_t r = 0; r <= repeat; r++) { + // Block #1 + sendGeneric(GREE_HDR_MARK, GREE_HDR_SPACE, + GREE_BIT_MARK, GREE_ONE_SPACE, + GREE_BIT_MARK, GREE_ZERO_SPACE, + 0, 0, // No Footer. + data, 4, 38, false, 0, 50); + // Footer #1 + sendGeneric(0, 0, // No Header + GREE_BIT_MARK, GREE_ONE_SPACE, + GREE_BIT_MARK, GREE_ZERO_SPACE, + GREE_BIT_MARK, GREE_MSG_SPACE, + 0b010, 3, 38, true, 0, false); + + // Block #2 + sendGeneric(0, 0, // No Header for Block #2 + GREE_BIT_MARK, GREE_ONE_SPACE, + GREE_BIT_MARK, GREE_ZERO_SPACE, + GREE_BIT_MARK, GREE_MSG_SPACE, + data + 4, nbytes - 4, 38, false, 0, 50); + } +} + +// Send a Gree Heat Pump message. +// +// Args: +// data: The raw message to be sent. +// nbits: Nr. of bits of data in the message. (Default is GREE_BITS) +// repeat: Nr. of times the message is to be repeated. (Default = 0). +// +// Status: ALPHA / Untested. +// +// Ref: +// https://github.com/ToniA/arduino-heatpumpir/blob/master/GreeHeatpumpIR.cpp +void IRsend::sendGree(uint64_t data, uint16_t nbits, uint16_t repeat) { + if (nbits != GREE_BITS) + return; // Wrong nr. of bits to send a proper message. + // Set IR carrier frequency + enableIROut(38); + + for (uint16_t r = 0; r <= repeat; r++) { + // Header + mark(GREE_HDR_MARK); + space(GREE_HDR_SPACE); + + // Data + for (int16_t i = 8; i <= nbits; i += 8) { + sendData(GREE_BIT_MARK, GREE_ONE_SPACE, GREE_BIT_MARK, GREE_ZERO_SPACE, + (data >> (nbits - i)) & 0xFF, 8, false); + if (i == nbits / 2) { + // Send the mid-message Footer. + sendData(GREE_BIT_MARK, GREE_ONE_SPACE, GREE_BIT_MARK, GREE_ZERO_SPACE, + 0b010, 3); + mark(GREE_BIT_MARK); + space(GREE_MSG_SPACE); + } + } + // Footer + mark(GREE_BIT_MARK); + space(GREE_MSG_SPACE); + } +} +#endif // SEND_GREE + +IRGreeAC::IRGreeAC(uint16_t pin) : _irsend(pin) { + stateReset(); +} + +void IRGreeAC::stateReset() { + // This resets to a known-good state to Power Off, Fan Auto, Mode Auto, 25C. + for (uint8_t i = 0; i < GREE_STATE_LENGTH; i++) + remote_state[i] = 0x0; + remote_state[1] = 0x09; + remote_state[2] = 0x20; + remote_state[3] = 0x50; + remote_state[5] = 0x20; + remote_state[7] = 0x50; +} + +void IRGreeAC::fixup() { + checksum(); // Calculate the checksums +} + +void IRGreeAC::begin() { + _irsend.begin(); +} + +#if SEND_GREE +void IRGreeAC::send() { + fixup(); // Ensure correct settings before sending. + _irsend.sendGree(remote_state); +} +#endif // SEND_GREE + +uint8_t* IRGreeAC::getRaw() { + fixup(); // Ensure correct settings before sending. + return remote_state; +} + +void IRGreeAC::setRaw(uint8_t new_code[]) { + for (uint8_t i = 0; i < GREE_STATE_LENGTH; i++) { + remote_state[i] = new_code[i]; + } +} + +void IRGreeAC::checksum(const uint16_t length) { + // Gree uses the same checksum alg. as Kelvinator's block checksum. + uint8_t sum = IRKelvinatorAC::calcBlockChecksum(remote_state, length); + remote_state[length - 1] = (sum << 4) | (remote_state[length - 1] & 0xFU); +} + +// Verify the checksum is valid for a given state. +// Args: +// state: The array to verify the checksum of. +// length: The size of the state. +// Returns: +// A boolean. +bool IRGreeAC::validChecksum(const uint8_t state[], const uint16_t length) { + // Top 4 bits of the last byte in the state is the state's checksum. + if (state[length - 1] >> 4 == IRKelvinatorAC::calcBlockChecksum(state, + length)) + return true; + else + return false; +} + +void IRGreeAC::on() { + remote_state[0] |= GREE_POWER1_MASK; + remote_state[2] |= GREE_POWER2_MASK; +} + +void IRGreeAC::off() { + remote_state[0] &= ~GREE_POWER1_MASK; + remote_state[2] &= ~GREE_POWER2_MASK; +} + +void IRGreeAC::setPower(const bool state) { + if (state) + on(); + else + off(); +} + +bool IRGreeAC::getPower() { + return (remote_state[0] & GREE_POWER1_MASK) && + (remote_state[2] & GREE_POWER2_MASK); +} + +// Set the temp. in deg C +void IRGreeAC::setTemp(const uint8_t temp) { + uint8_t new_temp = std::max((uint8_t) GREE_MIN_TEMP, temp); + new_temp = std::min((uint8_t) GREE_MAX_TEMP, new_temp); + if (getMode() == GREE_AUTO) new_temp = 25; + remote_state[1] = (remote_state[1] & 0xF0U) | (new_temp - GREE_MIN_TEMP); +} + +// Return the set temp. in deg C +uint8_t IRGreeAC::getTemp() { + return ((remote_state[1] & 0xFU) + GREE_MIN_TEMP); +} + +// Set the speed of the fan, 0-3, 0 is auto, 1-3 is the speed +void IRGreeAC::setFan(const uint8_t speed) { + uint8_t fan = std::min((uint8_t) GREE_FAN_MAX, speed); // Bounds check + + if (getMode() == GREE_DRY) fan = 1; // DRY mode is always locked to fan 1. + // Set the basic fan values. + remote_state[0] &= ~GREE_FAN_MASK; + remote_state[0] |= (fan << 4); +} + +uint8_t IRGreeAC::getFan() { + return ((remote_state[0] & GREE_FAN_MASK) >> 4); +} + +void IRGreeAC::setMode(const uint8_t new_mode) { + uint8_t mode = new_mode; + switch (mode) { + case GREE_AUTO: + // AUTO is locked to 25C + setTemp(25); + break; + case GREE_DRY: + // DRY always sets the fan to 1. + setFan(1); + break; + case GREE_COOL: + case GREE_FAN: + case GREE_HEAT: + break; + default: + // If we get an unexpected mode, default to AUTO. + mode = GREE_AUTO; + } + remote_state[0] &= ~GREE_MODE_MASK; + remote_state[0] |= mode; +} + +uint8_t IRGreeAC::getMode() { + return (remote_state[0] & GREE_MODE_MASK); +} + +void IRGreeAC::setLight(const bool state) { + remote_state[2] &= ~GREE_LIGHT_MASK; + remote_state[2] |= (state << 5); +} + +bool IRGreeAC::getLight() { + return remote_state[2] & GREE_LIGHT_MASK; +} + +void IRGreeAC::setXFan(const bool state) { + remote_state[2] &= ~GREE_XFAN_MASK; + remote_state[2] |= (state << 7); +} + +bool IRGreeAC::getXFan() { + return remote_state[2] & GREE_XFAN_MASK; +} + +void IRGreeAC::setSleep(const bool state) { + remote_state[0] &= ~GREE_SLEEP_MASK; + remote_state[0] |= (state << 7); +} + +bool IRGreeAC::getSleep() { + return remote_state[0] & GREE_SLEEP_MASK; +} + +void IRGreeAC::setTurbo(const bool state) { + remote_state[2] &= ~GREE_TURBO_MASK; + remote_state[2] |= (state << 4); +} + +bool IRGreeAC::getTurbo() { + return remote_state[2] & GREE_TURBO_MASK; +} + +void IRGreeAC::setSwingVertical(const bool automatic, const uint8_t position) { + remote_state[0] &= ~GREE_SWING_AUTO_MASK; + remote_state[0] |= (automatic << 6); + uint8_t new_position = position; + if (!automatic) { + switch (position) { + case GREE_SWING_UP: + case GREE_SWING_MIDDLE_UP: + case GREE_SWING_MIDDLE: + case GREE_SWING_MIDDLE_DOWN: + case GREE_SWING_DOWN: + break; + default: + new_position = GREE_SWING_LAST_POS; + } + } else { + switch (position) { + case GREE_SWING_AUTO: + case GREE_SWING_DOWN_AUTO: + case GREE_SWING_MIDDLE_AUTO: + case GREE_SWING_UP_AUTO: + break; + default: + new_position = GREE_SWING_AUTO; + } + } + remote_state[4] &= ~GREE_SWING_POS_MASK; + remote_state[4] |= new_position; +} + +bool IRGreeAC::getSwingVerticalAuto() { + return remote_state[0] & GREE_SWING_AUTO_MASK; +} + +uint8_t IRGreeAC::getSwingVerticalPosition() { + return remote_state[4] & GREE_SWING_POS_MASK; +} + +// Convert the internal state into a human readable string. +#ifdef ARDUINO +String IRGreeAC::toString() { + String result = ""; +#else +std::string IRGreeAC::toString() { + std::string result = ""; +#endif // ARDUINO + result += "Power: "; + if (getPower()) + result += "On"; + else + result += "Off"; + result += ", Mode: " + uint64ToString(getMode()); + switch (getMode()) { + case GREE_AUTO: + result += " (AUTO)"; + break; + case GREE_COOL: + result += " (COOL)"; + break; + case GREE_HEAT: + result += " (HEAT)"; + break; + case GREE_DRY: + result += " (DRY)"; + break; + case GREE_FAN: + result += " (FAN)"; + break; + default: + result += " (UNKNOWN)"; + } + result += ", Temp: " + uint64ToString(getTemp()) + "C"; + result += ", Fan: " + uint64ToString(getFan()); + switch (getFan()) { + case 0: + result += " (AUTO)"; + break; + case GREE_FAN_MAX: + result += " (MAX)"; + break; + } + result += ", Turbo: "; + if (getTurbo()) + result += "On"; + else + result += "Off"; + result += ", XFan: "; + if (getXFan()) + result += "On"; + else + result += "Off"; + result += ", Light: "; + if (getLight()) + result += "On"; + else + result += "Off"; + result += ", Sleep: "; + if (getSleep()) + result += "On"; + else + result += "Off"; + result += ", Swing Vertical Mode: "; + if (getSwingVerticalAuto()) + result += "Auto"; + else + result += "Manual"; + result += ", Swing Vertical Pos: " + + uint64ToString(getSwingVerticalPosition()); + switch (getSwingVerticalPosition()) { + case GREE_SWING_LAST_POS: + result += " (Last Pos)"; + break; + case GREE_SWING_AUTO: + result += " (Auto)"; + break; + } + return result; +} + +#if DECODE_GREE +// Decode the supplied Gree message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. Typically GREE_BITS. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: ALPHA / Untested. +bool IRrecv::decodeGree(decode_results *results, uint16_t nbits, bool strict) { + if (results->rawlen < 2 * (nbits + GREE_BLOCK_FOOTER_BITS) + + (HEADER + FOOTER + 1)) + return false; // Can't possibly be a valid Gree message. + if (strict && nbits != GREE_BITS) + return false; // Not strictly a Gree message. + + uint32_t data; + uint16_t offset = OFFSET_START; + + // There are two blocks back-to-back in a full Gree IR message + // sequence. + int8_t state_pos = 0; + match_result_t data_result; + + // Header + if (!matchMark(results->rawbuf[offset++], GREE_HDR_MARK)) return false; + if (!matchSpace(results->rawbuf[offset++], GREE_HDR_SPACE)) return false; + // Data Block #1 (32 bits) + data_result = matchData(&(results->rawbuf[offset]), 32, GREE_BIT_MARK, + GREE_ONE_SPACE, GREE_BIT_MARK, GREE_ZERO_SPACE); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + + // Record Data Block #1 in the state. + for (int i = state_pos + 3; i >= state_pos; i--, data >>= 8) + results->state[i] = reverseBits(data & 0xFF, 8); + state_pos += 4; + + // Block #1 footer (3 bits, B010) + data_result = matchData(&(results->rawbuf[offset]), GREE_BLOCK_FOOTER_BITS, + GREE_BIT_MARK, GREE_ONE_SPACE, GREE_BIT_MARK, + GREE_ZERO_SPACE); + if (data_result.success == false) return false; + if (data_result.data != GREE_BLOCK_FOOTER) return false; + offset += data_result.used; + + // Inter-block gap. + if (!matchMark(results->rawbuf[offset++], GREE_BIT_MARK)) return false; + if (!matchSpace(results->rawbuf[offset++], GREE_MSG_SPACE)) return false; + + // Data Block #2 (32 bits) + data_result = matchData(&(results->rawbuf[offset]), 32, GREE_BIT_MARK, + GREE_ONE_SPACE, GREE_BIT_MARK, GREE_ZERO_SPACE); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + + // Record Data Block #2 in the state. + for (int i = state_pos + 3; i >= state_pos; i--, data >>= 8) + results->state[i] = reverseBits(data & 0xFF, 8); + state_pos += 4; + + // Footer. + if (!matchMark(results->rawbuf[offset++], GREE_BIT_MARK)) return false; + if (offset <= results->rawlen && + !matchAtLeast(results->rawbuf[offset], GREE_MSG_SPACE)) + return false; + + // Compliance + if (strict) { + // Correct size/length) + if (state_pos != GREE_STATE_LENGTH) return false; + // Verify the message's checksum is correct. + if (!IRGreeAC::validChecksum(results->state)) return false; + } + + // Success + results->decode_type = GREE; + results->bits = state_pos * 8; + // No need to record the state as we stored it as we decoded it. + // As we use result->state, we don't record value, address, or command as it + // is a union data type. + return true; +} +#endif // DECODE_GREE diff --git a/IRremoteESP8266/src/ir_Gree.h b/IRremoteESP8266/src/ir_Gree.h new file mode 100644 index 0000000..e44c97b --- /dev/null +++ b/IRremoteESP8266/src/ir_Gree.h @@ -0,0 +1,106 @@ +// Kelvinator A/C +// +// Copyright 2016 David Conran + +#ifndef IR_GREE_H_ +#define IR_GREE_H_ + +#define __STDC_LIMIT_MACROS +#include +#ifndef UNIT_TEST +#include +#else +#include +#endif +#include "IRremoteESP8266.h" +#include "IRsend.h" + +// GGGG RRRRRR EEEEEEE EEEEEEE +// GG GG RR RR EE EE +// GG RRRRRR EEEEE EEEEE +// GG GG RR RR EE EE +// GGGGGG RR RR EEEEEEE EEEEEEE + +// Constants +#define GREE_AUTO 0U +#define GREE_COOL 1U +#define GREE_DRY 2U +#define GREE_FAN 3U +#define GREE_HEAT 4U + +#define GREE_POWER1_MASK 0b00001000U +#define GREE_POWER2_MASK 0b01000000U +#define GREE_MIN_TEMP 16U // Celsius +#define GREE_MAX_TEMP 30U // Celsius +#define GREE_FAN_MAX 3U +#define GREE_FAN_MASK 0b00110000U +#define GREE_MODE_MASK 0b00000111U +#define GREE_TURBO_MASK 0b00010000U +#define GREE_LIGHT_MASK 0b00100000U +#define GREE_XFAN_MASK 0b10000000U +#define GREE_SLEEP_MASK 0b10000000U + +#define GREE_SWING_AUTO_MASK 0b01000000U +#define GREE_SWING_POS_MASK 0b00001111U +#define GREE_SWING_LAST_POS 0b00000000U +#define GREE_SWING_AUTO 0b00000001U +#define GREE_SWING_UP 0b00000010U +#define GREE_SWING_MIDDLE_UP 0b00000011U +#define GREE_SWING_MIDDLE 0b00000100U +#define GREE_SWING_MIDDLE_DOWN 0b00000101U +#define GREE_SWING_DOWN 0b00000110U +#define GREE_SWING_DOWN_AUTO 0b00000111U +#define GREE_SWING_MIDDLE_AUTO 0b00001001U +#define GREE_SWING_UP_AUTO 0b00001011U + +// Classes +class IRGreeAC { + public: + explicit IRGreeAC(uint16_t pin); + + void stateReset(); +#if SEND_GREE + void send(); +#endif // SEND_GREE + void begin(); + void on(); + void off(); + void setPower(const bool state); + bool getPower(); + void setTemp(const uint8_t temp); + uint8_t getTemp(); + void setFan(const uint8_t speed); + uint8_t getFan(); + void setMode(const uint8_t new_mode); + uint8_t getMode(); + void setLight(const bool state); + bool getLight(); + void setXFan(const bool state); + bool getXFan(); + void setSleep(const bool state); + bool getSleep(); + void setTurbo(const bool state); + bool getTurbo(); + void setSwingVertical(const bool automatic, const uint8_t position); + bool getSwingVerticalAuto(); + uint8_t getSwingVerticalPosition(); + + uint8_t* getRaw(); + void setRaw(uint8_t new_code[]); + static bool validChecksum(const uint8_t state[], + const uint16_t length = GREE_STATE_LENGTH); +#ifdef ARDUINO + String toString(); +#else + std::string toString(); +#endif + + private: + // The state of the IR remote in IR code form. + uint8_t remote_state[GREE_STATE_LENGTH]; + void checksum(const uint16_t length = GREE_STATE_LENGTH); + void fixup(); + IRsend _irsend; +}; + +#endif // IR_GREE_H_ diff --git a/IRremoteESP8266/src/ir_Haier.cpp b/IRremoteESP8266/src/ir_Haier.cpp new file mode 100644 index 0000000..ae5a44a --- /dev/null +++ b/IRremoteESP8266/src/ir_Haier.cpp @@ -0,0 +1,497 @@ +// Copyright 2018 crankyoldgit +// The specifics of reverse engineering the protocol details by kuzin2006 + +#include "ir_Haier.h" +#ifndef UNIT_TEST +#include +#else +#include +#endif +#include "IRremoteESP8266.h" +#include "IRutils.h" + +// HH HH AAA IIIII EEEEEEE RRRRRR +// HH HH AAAAA III EE RR RR +// HHHHHHH AA AA III EEEEE RRRRRR +// HH HH AAAAAAA III EE RR RR +// HH HH AA AA IIIII EEEEEEE RR RR + +// Supported devices: +// * Haier HSU07-HEA03 Remote control. + +// Ref: +// https://github.com/markszabo/IRremoteESP8266/issues/404 +// https://www.dropbox.com/s/mecyib3lhdxc8c6/IR%20data%20reverse%20engineering.xlsx?dl=0 + +// Constants +#define HAIER_AC_HDR 3000U +#define HAIER_AC_HDR_GAP 4300U + +#define HAIER_AC_BIT_MARK 520U +#define HAIER_AC_ONE_SPACE 1650U +#define HAIER_AC_ZERO_SPACE 650U +#define HAIER_AC_MIN_GAP 150000U // Completely made up value. + +#if SEND_HAIER_AC +// Send a Haier A/C message. +// +// Args: +// data: An array of bytes containing the IR command. +// nbytes: Nr. of bytes of data in the array. (>=HAIER_AC_STATE_LENGTH) +// repeat: Nr. of times the message is to be repeated. (Default = 0). +// +// Status: Beta / Probably working. +// +void IRsend::sendHaierAC(unsigned char data[], uint16_t nbytes, + uint16_t repeat) { + if (nbytes < HAIER_AC_STATE_LENGTH) + return; + + for (uint16_t r = 0; r <= repeat; r++) { + enableIROut(38000); + mark(HAIER_AC_HDR); + space(HAIER_AC_HDR); + sendGeneric(HAIER_AC_HDR, HAIER_AC_HDR_GAP, + HAIER_AC_BIT_MARK, HAIER_AC_ONE_SPACE, + HAIER_AC_BIT_MARK, HAIER_AC_ZERO_SPACE, + HAIER_AC_BIT_MARK, HAIER_AC_MIN_GAP, + data, nbytes, 38, true, 0, // Repeats handled elsewhere + 50); + } +} +#endif // SEND_HAIER_AC + +IRHaierAC::IRHaierAC(uint16_t pin) : _irsend(pin) { + stateReset(); +} + +void IRHaierAC::begin() { + _irsend.begin(); +} + +#if SEND_HAIER_AC +void IRHaierAC::send() { + checksum(); + _irsend.sendHaierAC(remote_state); +} +#endif // SEND_HAIER_AC + +void IRHaierAC::checksum() { + remote_state[8] = sumBytes(remote_state, HAIER_AC_STATE_LENGTH - 1); +} + +bool IRHaierAC::validChecksum(uint8_t state[], const uint16_t length) { + if (length < 2) return false; // 1 byte of data can't have a checksum. + return (state[length - 1] == sumBytes(state, length - 1)); +} + +void IRHaierAC::stateReset() { + for (uint8_t i = 1; i < HAIER_AC_STATE_LENGTH; i++) + remote_state[i] = 0x0; + remote_state[0] = HAIER_AC_PREFIX; + remote_state[2] = 0b00100000; + + setTemp(HAIER_AC_DEF_TEMP); + setFan(HAIER_AC_FAN_AUTO); + setMode(HAIER_AC_AUTO); + setCommand(HAIER_AC_CMD_ON); +} + +uint8_t* IRHaierAC::getRaw() { + checksum(); + return remote_state; +} + +void IRHaierAC::setRaw(uint8_t new_code[]) { + for (uint8_t i = 0; i < HAIER_AC_STATE_LENGTH; i++) { + remote_state[i] = new_code[i]; + } +} + +void IRHaierAC::setCommand(uint8_t state) { + remote_state[1] &= 0b11110000; + switch (state) { + case HAIER_AC_CMD_OFF: + case HAIER_AC_CMD_ON: + case HAIER_AC_CMD_MODE: + case HAIER_AC_CMD_FAN: + case HAIER_AC_CMD_TEMP_UP: + case HAIER_AC_CMD_TEMP_DOWN: + case HAIER_AC_CMD_SLEEP: + case HAIER_AC_CMD_TIMER_SET: + case HAIER_AC_CMD_TIMER_CANCEL: + case HAIER_AC_CMD_HEALTH: + case HAIER_AC_CMD_SWING: + remote_state[1] |= (state & 0b00001111); + } +} + +uint8_t IRHaierAC::getCommand() { + return remote_state[1] & (0b00001111); +} + +void IRHaierAC::setFan(uint8_t speed) { + uint8_t new_speed = HAIER_AC_FAN_AUTO; + switch (speed) { + case HAIER_AC_FAN_LOW: + new_speed = 3; + break; + case HAIER_AC_FAN_MED: + new_speed = 1; + break; + case HAIER_AC_FAN_HIGH: + new_speed = 2; + break; + default: + new_speed = HAIER_AC_FAN_AUTO; // Default to auto for anything else. + } + + if (speed != getFan()) setCommand(HAIER_AC_CMD_FAN); + remote_state[5] &= 0b11111100; + remote_state[5] |= new_speed; +} + +uint8_t IRHaierAC::getFan() { + switch (remote_state[5] & 0b00000011) { + case 1: + return HAIER_AC_FAN_MED; + case 2: + return HAIER_AC_FAN_HIGH; + case 3: + return HAIER_AC_FAN_LOW; + default: + return HAIER_AC_FAN_AUTO; + } +} + +void IRHaierAC::setMode(uint8_t mode) { + uint8_t new_mode = mode; + setCommand(HAIER_AC_CMD_MODE); + if (mode > HAIER_AC_FAN) // If out of range, default to auto mode. + new_mode = HAIER_AC_AUTO; + remote_state[7] &= 0b00011111; + remote_state[7] |= (new_mode << 5); +} + +uint8_t IRHaierAC::getMode() { + return (remote_state[7] & 0b11100000) >> 5; +} + +void IRHaierAC::setTemp(const uint8_t celcius ) { + uint8_t temp = celcius; + if (temp < HAIER_AC_MIN_TEMP) + temp = HAIER_AC_MIN_TEMP; + else if (temp > HAIER_AC_MAX_TEMP) + temp = HAIER_AC_MAX_TEMP; + + uint8_t old_temp = getTemp(); + if (old_temp == temp) return; + if (old_temp > temp) + setCommand(HAIER_AC_CMD_TEMP_DOWN); + else + setCommand(HAIER_AC_CMD_TEMP_UP); + + remote_state[1] &= 0b00001111; // Clear the previous temp. + remote_state[1] |= ((temp - HAIER_AC_MIN_TEMP) << 4); +} + +uint8_t IRHaierAC::getTemp() { + return ((remote_state[1] & 0b11110000) >> 4) + HAIER_AC_MIN_TEMP; +} + +void IRHaierAC::setHealth(bool state) { + setCommand(HAIER_AC_CMD_HEALTH); + remote_state[4] &= 0b11011111; + remote_state[4] |= (state << 5); +} + +bool IRHaierAC::getHealth(void) { + return remote_state[4] & (1 << 5); +} + +void IRHaierAC::setSleep(bool state) { + setCommand(HAIER_AC_CMD_SLEEP); + remote_state[7] &= 0b10111111; + remote_state[7] |= (state << 6); +} + +bool IRHaierAC::getSleep(void) { + return remote_state[7] & 0b01000000; +} + +uint16_t IRHaierAC::getTime(const uint8_t ptr[]) { + return (ptr[0] & 0b00011111) * 60 + (ptr[1] & 0b00111111); +} + +int16_t IRHaierAC::getOnTimer() { + if (remote_state[3] & 0b10000000) // Check if the timer is turned on. + return getTime(remote_state + 6); + else + return -1; +} + +int16_t IRHaierAC::getOffTimer() { + if (remote_state[3] & 0b01000000) // Check if the timer is turned on. + return getTime(remote_state + 4); + else + return -1; +} + +uint16_t IRHaierAC::getCurrTime() { + return getTime(remote_state + 2); +} + +void IRHaierAC::setTime(uint8_t ptr[], const uint16_t nr_mins) { + uint16_t mins = nr_mins; + if (nr_mins > HAIER_AC_MAX_TIME) + mins = HAIER_AC_MAX_TIME; + + // Hours + ptr[0] &= 0b11100000; + ptr[0] |= (mins / 60); + // Minutes + ptr[1] &= 0b11000000; + ptr[1] |= (mins % 60); +} + +void IRHaierAC::setOnTimer(const uint16_t nr_mins) { + setCommand(HAIER_AC_CMD_TIMER_SET); + remote_state[3] |= 0b10000000; + setTime(remote_state + 6, nr_mins); +} + +void IRHaierAC::setOffTimer(const uint16_t nr_mins) { + setCommand(HAIER_AC_CMD_TIMER_SET); + remote_state[3] |= 0b01000000; + setTime(remote_state + 4, nr_mins); +} + +void IRHaierAC::cancelTimers() { + setCommand(HAIER_AC_CMD_TIMER_CANCEL); + remote_state[3] &= 0b00111111; +} + +void IRHaierAC::setCurrTime(const uint16_t nr_mins) { + setTime(remote_state + 2, nr_mins); +} + +uint8_t IRHaierAC::getSwing() { + return (remote_state[2] & 0b11000000) >> 6; +} + +void IRHaierAC::setSwing(const uint8_t state) { + if (state == getSwing()) return; // Nothing to do. + setCommand(HAIER_AC_CMD_SWING); + switch (state) { + case HAIER_AC_SWING_OFF: + case HAIER_AC_SWING_UP: + case HAIER_AC_SWING_DOWN: + case HAIER_AC_SWING_CHG: + remote_state[2] &= 0b00111111; + remote_state[2] |= (state << 6); + break; + } +} + +// Convert a Haier time into a human readable string. +#ifdef ARDUINO +String IRHaierAC::timeToString(const uint16_t nr_mins) { + String result = ""; +#else +std::string IRHaierAC::timeToString(const uint16_t nr_mins) { + std::string result = ""; +#endif // ARDUINO + + if (nr_mins / 24 < 10) result += "0"; // Zero pad. + result += uint64ToString(nr_mins / 60); + result += ":"; + if (nr_mins % 60 < 10) result += "0"; // Zero pad. + result += uint64ToString(nr_mins % 60); + return result; +} + +// Convert the internal state into a human readable string. +#ifdef ARDUINO +String IRHaierAC::toString() { + String result = ""; +#else +std::string IRHaierAC::toString() { + std::string result = ""; +#endif // ARDUINO + uint8_t cmd = getCommand(); + result += "Command: " + uint64ToString(cmd) +" ("; + switch (cmd) { + case HAIER_AC_CMD_OFF: + result += "Off"; + break; + case HAIER_AC_CMD_ON: + result += "On"; + break; + case HAIER_AC_CMD_MODE: + result += "Mode"; + break; + case HAIER_AC_CMD_FAN: + result += "Fan"; + break; + case HAIER_AC_CMD_TEMP_UP: + result += "Temp Up"; + break; + case HAIER_AC_CMD_TEMP_DOWN: + result += "Temp Down"; + break; + case HAIER_AC_CMD_SLEEP: + result += "Sleep"; + break; + case HAIER_AC_CMD_TIMER_SET: + result += "Timer Set"; + break; + case HAIER_AC_CMD_TIMER_CANCEL: + result += "Timer Cancel"; + break; + case HAIER_AC_CMD_HEALTH: + result += "Health"; + break; + case HAIER_AC_CMD_SWING: + result += "Swing"; + break; + default: + result += "Unknown"; + } + result += ")"; + result += ", Mode: " + uint64ToString(getMode()); + switch (getMode()) { + case HAIER_AC_AUTO: + result += " (AUTO)"; + break; + case HAIER_AC_COOL: + result += " (COOL)"; + break; + case HAIER_AC_HEAT: + result += " (HEAT)"; + break; + case HAIER_AC_DRY: + result += " (DRY)"; + break; + case HAIER_AC_FAN: + result += " (FAN)"; + break; + default: + result += " (UNKNOWN)"; + } + result += ", Temp: " + uint64ToString(getTemp()) + "C"; + result += ", Fan: " + uint64ToString(getFan()); + switch (getFan()) { + case HAIER_AC_FAN_AUTO: + result += " (AUTO)"; + break; + case HAIER_AC_FAN_HIGH: + result += " (MAX)"; + break; + } + result += ", Swing: " + uint64ToString(getSwing()) + " ("; + switch (getSwing()) { + case HAIER_AC_SWING_OFF: + result += "Off"; + break; + case HAIER_AC_SWING_UP: + result += "Up"; + break; + case HAIER_AC_SWING_DOWN: + result += "Down"; + break; + case HAIER_AC_SWING_CHG: + result += "Chg"; + break; + default: + result += "Unknown"; + } + result += ")"; + result += ", Sleep: "; + if (getSleep()) + result += "On"; + else + result += "Off"; + result += ", Health: "; + if (getHealth()) + result += "On"; + else + result += "Off"; + result += ", Current Time: " + timeToString(getCurrTime()); + result += ", On Timer: "; + if (getOnTimer() >= 0) + result += timeToString(getOnTimer()); + else + result += "Off"; + result += ", Off Timer: "; + if (getOffTimer() >= 0) + result += timeToString(getOffTimer()); + else + result += "Off"; + + return result; +} + +#if DECODE_HAIER_AC +// Decode the supplied Haier message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. Typically HAIER_AC_BITS. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / Appears to be working. +// +bool IRrecv::decodeHaierAC(decode_results *results, uint16_t nbits, + bool strict) { + if (nbits % 8 != 0) // nbits has to be a multiple of nr. of bits in a byte. + return false; + + if (strict) { + if (nbits != HAIER_AC_BITS) + return false; // Not strictly a HAIER_AC message. + } + + if (results->rawlen < (2 * nbits + HEADER) + FOOTER - 1) + return false; // Can't possibly be a valid HAIER_AC message. + + uint16_t offset = OFFSET_START; + + + // Header + if (!matchMark(results->rawbuf[offset++], HAIER_AC_HDR)) return false; + if (!matchSpace(results->rawbuf[offset++], HAIER_AC_HDR)) return false; + if (!matchMark(results->rawbuf[offset++], HAIER_AC_HDR)) return false; + if (!matchSpace(results->rawbuf[offset++], HAIER_AC_HDR_GAP)) return false; + + // Data + for (uint16_t i = 0; i < nbits / 8; i++) { + match_result_t data_result = matchData(&(results->rawbuf[offset]), 8, + HAIER_AC_BIT_MARK, + HAIER_AC_ONE_SPACE, + HAIER_AC_BIT_MARK, + HAIER_AC_ZERO_SPACE); + if (data_result.success == false) return false; + offset += data_result.used; + results->state[i] = (uint8_t) data_result.data; + } + + // Footer + if (!matchMark(results->rawbuf[offset++], HAIER_AC_BIT_MARK)) return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset++], HAIER_AC_MIN_GAP)) + return false; + + // Compliance + if (strict) { + if (results->state[0] != HAIER_AC_PREFIX) return false; + if (!IRHaierAC::validChecksum(results->state, nbits / 8)) return false; + } + + // Success + results->decode_type = HAIER_AC; + results->bits = nbits; + return true; +} +#endif // DECODE_HAIER_AC diff --git a/IRremoteESP8266/src/ir_Haier.h b/IRremoteESP8266/src/ir_Haier.h new file mode 100644 index 0000000..ac0f022 --- /dev/null +++ b/IRremoteESP8266/src/ir_Haier.h @@ -0,0 +1,126 @@ +// Copyright 2018 crankyoldgit +// The specifics of reverse engineering the protocol details by kuzin2006 + +#ifndef IR_HAIER_H_ +#define IR_HAIER_H_ + +#ifndef UNIT_TEST +#include +#else +#include +#endif +#include "IRremoteESP8266.h" +#include "IRsend.h" + +// HH HH AAA IIIII EEEEEEE RRRRRR +// HH HH AAAAA III EE RR RR +// HHHHHHH AA AA III EEEEE RRRRRR +// HH HH AAAAAAA III EE RR RR +// HH HH AA AA IIIII EEEEEEE RR RR + +// Ref: +// https://github.com/markszabo/IRremoteESP8266/issues/404 +// https://www.dropbox.com/s/mecyib3lhdxc8c6/IR%20data%20reverse%20engineering.xlsx?dl=0 + +// Constants +// Byte 0 +#define HAIER_AC_PREFIX 0b10100101 + +// Byte 1 +#define HAIER_AC_MIN_TEMP 16 +#define HAIER_AC_MAX_TEMP 30 +#define HAIER_AC_DEF_TEMP 25 + +#define HAIER_AC_CMD_OFF 0b00000000 +#define HAIER_AC_CMD_ON 0b00000001 +#define HAIER_AC_CMD_MODE 0b00000010 +#define HAIER_AC_CMD_FAN 0b00000011 +#define HAIER_AC_CMD_TEMP_UP 0b00000110 +#define HAIER_AC_CMD_TEMP_DOWN 0b00000111 +#define HAIER_AC_CMD_SLEEP 0b00001000 +#define HAIER_AC_CMD_TIMER_SET 0b00001001 +#define HAIER_AC_CMD_TIMER_CANCEL 0b00001010 +#define HAIER_AC_CMD_HEALTH 0b00001100 +#define HAIER_AC_CMD_SWING 0b00001101 + +// Byte 2 +#define HAIER_AC_SWING_OFF 0b00000000 +#define HAIER_AC_SWING_UP 0b00000001 +#define HAIER_AC_SWING_DOWN 0b00000010 +#define HAIER_AC_SWING_CHG 0b00000011 + +// Byte 6 +#define HAIER_AC_AUTO 0 +#define HAIER_AC_COOL 1 +#define HAIER_AC_DRY 2 +#define HAIER_AC_HEAT 3 +#define HAIER_AC_FAN 4 + +#define HAIER_AC_FAN_AUTO 0 +#define HAIER_AC_FAN_LOW 1 +#define HAIER_AC_FAN_MED 2 +#define HAIER_AC_FAN_HIGH 3 + +#define HAIER_AC_MAX_TIME (23 * 60 + 59) + + +class IRHaierAC { + public: + explicit IRHaierAC(uint16_t pin); + +#if SEND_HAIER_AC + void send(); +#endif // SEND_HAIER_AC + void begin(); + + void setCommand(const uint8_t command); + uint8_t getCommand(); + + void setTemp(const uint8_t temp); + uint8_t getTemp(); + + void setFan(const uint8_t speed); + uint8_t getFan(); + + uint8_t getMode(); + void setMode(const uint8_t mode); + + bool getSleep(); + void setSleep(const bool state); + bool getHealth(); + void setHealth(const bool state); + + int16_t getOnTimer(); + void setOnTimer(const uint16_t mins); + int16_t getOffTimer(); + void setOffTimer(const uint16_t mins); + void cancelTimers(); + + uint16_t getCurrTime(); + void setCurrTime(const uint16_t mins); + + uint8_t getSwing(); + void setSwing(const uint8_t state); + + uint8_t* getRaw(); + void setRaw(uint8_t new_code[]); + static bool validChecksum(uint8_t state[], + const uint16_t length = HAIER_AC_STATE_LENGTH); + #ifdef ARDUINO + String toString(); + static String timeToString(const uint16_t nr_mins); + #else + std::string toString(); + static std::string timeToString(const uint16_t nr_mins); + #endif + + private: + uint8_t remote_state[HAIER_AC_STATE_LENGTH]; + void stateReset(); + void checksum(); + static uint16_t getTime(const uint8_t ptr[]); + static void setTime(uint8_t ptr[], const uint16_t nr_mins); + IRsend _irsend; +}; + +#endif // IR_HAIER_H_ diff --git a/IRremoteESP8266/src/ir_JVC.cpp b/IRremoteESP8266/src/ir_JVC.cpp new file mode 100644 index 0000000..5a4017e --- /dev/null +++ b/IRremoteESP8266/src/ir_JVC.cpp @@ -0,0 +1,170 @@ +// Copyright 2015 Kristian Lauszus +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRtimer.h" +#include "IRutils.h" + +// JJJJJ V V CCCC +// J V V C +// J V V C +// J J V V C +// J V CCCC + +// JVC originally added by Kristian Lauszus +// (Thanks to zenwheel and other people at the original blog post) + +// Constants +// Ref: +// http://www.sbprojects.com/knowledge/ir/jvc.php +#define JVC_TICK 75U +#define JVC_HDR_MARK_TICKS 112U +#define JVC_HDR_MARK (JVC_HDR_MARK_TICKS * JVC_TICK) +#define JVC_HDR_SPACE_TICKS 56U +#define JVC_HDR_SPACE (JVC_HDR_SPACE_TICKS * JVC_TICK) +#define JVC_BIT_MARK_TICKS 7U +#define JVC_BIT_MARK (JVC_BIT_MARK_TICKS * JVC_TICK) +#define JVC_ONE_SPACE_TICKS 23U +#define JVC_ONE_SPACE (JVC_ONE_SPACE_TICKS * JVC_TICK) +#define JVC_ZERO_SPACE_TICKS 7U +#define JVC_ZERO_SPACE (JVC_ZERO_SPACE_TICKS * JVC_TICK) +#define JVC_RPT_LENGTH_TICKS 800U +#define JVC_RPT_LENGTH (JVC_RPT_LENGTH_TICKS * JVC_TICK) +#define JVC_MIN_GAP_TICKS (JVC_RPT_LENGTH_TICKS - \ + (JVC_HDR_MARK_TICKS + JVC_HDR_SPACE_TICKS + \ + JVC_BITS * (JVC_BIT_MARK_TICKS + JVC_ONE_SPACE_TICKS) + \ + JVC_BIT_MARK_TICKS)) +#define JVC_MIN_GAP (JVC_MIN_GAP_TICKS * JVC_TICK) + +#if SEND_JVC +// Send a JVC message. +// +// Args: +// data: The contents of the command you want to send. +// nbits: The bit size of the command being sent. (JVC_BITS) +// repeat: The number of times you want the command to be repeated. +// +// Status: STABLE. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/jvc.php +void IRsend::sendJVC(uint64_t data, uint16_t nbits, uint16_t repeat) { + // Set 38kHz IR carrier frequency & a 1/3 (33%) duty cycle. + enableIROut(38, 33); + + IRtimer usecs = IRtimer(); + // Header + // Only sent for the first message. + mark(JVC_HDR_MARK); + space(JVC_HDR_SPACE); + + // We always send the data & footer at least once, hence '<= repeat'. + for (uint16_t i = 0; i <= repeat; i++) { + sendGeneric(0, 0, // No Header + JVC_BIT_MARK, JVC_ONE_SPACE, + JVC_BIT_MARK, JVC_ZERO_SPACE, + JVC_BIT_MARK, JVC_MIN_GAP, + data, nbits, 38, true, 0, // Repeats are handles elsewhere. + 33); + // Wait till the end of the repeat time window before we send another code. + uint32_t elapsed = usecs.elapsed(); + // Avoid potential unsigned integer underflow. + // e.g. when elapsed > JVC_RPT_LENGTH. + if (elapsed < JVC_RPT_LENGTH) + space(JVC_RPT_LENGTH - elapsed); + usecs.reset(); + } +} + +// Calculate the raw JVC data based on address and command. +// +// Args: +// address: An 8-bit address value. +// command: An 8-bit command value. +// Returns: +// A raw JVC message. +// +// Status: BETA / Should work fine. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/jvc.php +uint16_t IRsend::encodeJVC(uint8_t address, uint8_t command) { + return reverseBits((command << 8) | address, 16); +} +#endif + +#if DECODE_JVC +// Decode the supplied JVC message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of bits of data to expect. Typically JVC_BITS. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: STABLE +// +// Note: +// JVC repeat codes don't have a header. +// Ref: +// http://www.sbprojects.com/knowledge/ir/jvc.php +bool IRrecv::decodeJVC(decode_results *results, uint16_t nbits, bool strict) { + if (strict && nbits != JVC_BITS) + return false; // Must be called with the correct nr. of bits. + if (results->rawlen < 2 * nbits + FOOTER - 1) + return false; // Can't possibly be a valid JVC message. + + uint64_t data = 0; + uint16_t offset = OFFSET_START; + bool isRepeat = true; + + uint32_t m_tick; + uint32_t s_tick; + // Header + // (Optional as repeat codes don't have the header) + if (matchMark(results->rawbuf[offset], JVC_HDR_MARK)) { + isRepeat = false; + m_tick = results->rawbuf[offset++] * RAWTICK / JVC_HDR_MARK_TICKS; + if (results->rawlen < 2 * nbits + 4) + return false; // Can't possibly be a valid JVC message with a header. + if (!matchSpace(results->rawbuf[offset], JVC_HDR_SPACE)) + return false; + s_tick = results->rawbuf[offset++] * RAWTICK / JVC_HDR_SPACE_TICKS; + } else { + // We can't easily auto-calibrate as there is no header, so assume + // the default tick time. + m_tick = JVC_TICK; + s_tick = JVC_TICK; + } + + // Data + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + JVC_BIT_MARK_TICKS * m_tick, + JVC_ONE_SPACE_TICKS * s_tick, + JVC_BIT_MARK_TICKS * m_tick, + JVC_ZERO_SPACE_TICKS * s_tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + + // Footer + if (!matchMark(results->rawbuf[offset++], JVC_BIT_MARK_TICKS * m_tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], JVC_MIN_GAP_TICKS * s_tick)) + return false; + + // Success + results->decode_type = JVC; + results->bits = nbits; + results->value = data; + // command & address are transmitted LSB first, so we need to reverse them. + results->address = reverseBits(data >> 8, 8); // The first 8 bits sent. + results->command = reverseBits(data & 0xFF, 8); // The last 8 bits sent. + results->repeat = isRepeat; + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Kelvinator.cpp b/IRremoteESP8266/src/ir_Kelvinator.cpp new file mode 100644 index 0000000..0a7f43d --- /dev/null +++ b/IRremoteESP8266/src/ir_Kelvinator.cpp @@ -0,0 +1,562 @@ +// Copyright 2016 David Conran +// +// Code to emulate IR Kelvinator YALIF remote control unit, which should control +// at least the following Kelvinator A/C units: +// KSV26CRC, KSV26HRC, KSV35CRC, KSV35HRC, KSV53HRC, KSV62HRC, KSV70CRC, +// KSV70HRC, KSV80HRC. +// +// Note: +// * Unsupported: +// - All Sleep modes. +// - All Timer modes. +// - "I Feel" button & mode. +// - Energy Saving mode. +// - Low Heat mode. +// - Fahrenheit. + +#include "ir_Kelvinator.h" +#include +#ifndef ARDUINO +#include +#endif +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// KK KK EEEEEEE LL VV VV IIIII NN NN AAA TTTTTTT OOOOO RRRRRR +// KK KK EE LL VV VV III NNN NN AAAAA TTT OO OO RR RR +// KKKK EEEEE LL VV VV III NN N NN AA AA TTT OO OO RRRRRR +// KK KK EE LL VV VV III NN NNN AAAAAAA TTT OO OO RR RR +// KK KK EEEEEEE LLLLLLL VVV IIIII NN NN AA AA TTT OOOO0 RR RR + +// Constants +#define KELVINATOR_TICK 85U +#define KELVINATOR_HDR_MARK_TICKS 106U +#define KELVINATOR_HDR_MARK (KELVINATOR_HDR_MARK_TICKS * KELVINATOR_TICK) +#define KELVINATOR_HDR_SPACE_TICKS 53U +#define KELVINATOR_HDR_SPACE (KELVINATOR_HDR_SPACE_TICKS * KELVINATOR_TICK) +#define KELVINATOR_BIT_MARK_TICKS 8U +#define KELVINATOR_BIT_MARK (KELVINATOR_BIT_MARK_TICKS * KELVINATOR_TICK) +#define KELVINATOR_ONE_SPACE_TICKS 18U +#define KELVINATOR_ONE_SPACE (KELVINATOR_ONE_SPACE_TICKS * KELVINATOR_TICK) +#define KELVINATOR_ZERO_SPACE_TICKS 6U +#define KELVINATOR_ZERO_SPACE (KELVINATOR_ZERO_SPACE_TICKS * KELVINATOR_TICK) +#define KELVINATOR_GAP_SPACE_TICKS 235U +#define KELVINATOR_GAP_SPACE (KELVINATOR_GAP_SPACE_TICKS * KELVINATOR_TICK) +#define KELVINATOR_CMD_FOOTER 2U +#define KELVINATOR_CMD_FOOTER_BITS 3U + +#define KELVINATOR_POWER 8U +#define KELVINATOR_MODE_MASK 0xF8U +#define KELVINATOR_FAN_OFFSET 4U +#define KELVINATOR_BASIC_FAN_MASK uint8_t(0xFFU ^ (3U << KELVINATOR_FAN_OFFSET)) +#define KELVINATOR_FAN_MASK uint8_t(0xFFU ^ (7U << KELVINATOR_FAN_OFFSET)) +#define KELVINATOR_CHECKSUM_START 10U +#define KELVINATOR_VENT_SWING_OFFSET 6U +#define KELVINATOR_VENT_SWING uint8_t(1U << KELVINATOR_VENT_SWING_OFFSET) +#define KELVINATOR_VENT_SWING_V uint8_t(1U) +#define KELVINATOR_VENT_SWING_H uint8_t(1U << 4) +#define KELVINATOR_SLEEP_1_AND_3 uint8_t(1U << 7) +#define KELVINATOR_QUIET_OFFSET 7U +#define KELVINATOR_QUIET uint8_t(1U << KELVINATOR_QUIET_OFFSET) +#define KELVINATOR_ION_FILTER_OFFSET 6U +#define KELVINATOR_ION_FILTER uint8_t(1U << KELVINATOR_ION_FILTER_OFFSET) +#define KELVINATOR_LIGHT_OFFSET 5U +#define KELVINATOR_LIGHT uint8_t(1U << KELVINATOR_LIGHT_OFFSET) +#define KELVINATOR_XFAN_OFFSET 7U +#define KELVINATOR_XFAN uint8_t(1U << KELVINATOR_XFAN_OFFSET) +#define KELVINATOR_TURBO_OFFSET 4U +#define KELVINATOR_TURBO uint8_t(1U << KELVINATOR_TURBO_OFFSET) + +#if SEND_KELVINATOR +// Send a Kelvinator A/C message. +// +// Args: +// data: An array of bytes containing the IR command. +// nbytes: Nr. of bytes of data in the array. (>=KELVINATOR_STATE_LENGTH) +// repeat: Nr. of times the message is to be repeated. (Default = 0). +// +// Status: STABLE / Known working. +// +void IRsend::sendKelvinator(unsigned char data[], uint16_t nbytes, + uint16_t repeat) { + if (nbytes < KELVINATOR_STATE_LENGTH) + return; // Not enough bytes to send a proper message. + + for (uint16_t r = 0; r <= repeat; r++) { + // Command Block #1 (4 bytes) + sendGeneric(KELVINATOR_HDR_MARK, KELVINATOR_HDR_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_ONE_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_ZERO_SPACE, + 0, 0, // No Footer yet. + data, 4, 38, false, 0, 50); + // Send Footer for the command block (3 bits (B010)) + sendGeneric(0, 0, // No Header + KELVINATOR_BIT_MARK, KELVINATOR_ONE_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_ZERO_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_GAP_SPACE, + KELVINATOR_CMD_FOOTER, KELVINATOR_CMD_FOOTER_BITS, + 38, false, 0, 50); + // Data Block #1 (4 bytes) + sendGeneric(0, 0, // No header + KELVINATOR_BIT_MARK, KELVINATOR_ONE_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_ZERO_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_GAP_SPACE * 2, + data + 4, 4, 38, false, 0, 50); + // Command Block #2 (4 bytes) + sendGeneric(KELVINATOR_HDR_MARK, KELVINATOR_HDR_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_ONE_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_ZERO_SPACE, + 0, 0, // No Footer yet. + data + 8, 4, 38, false, 0, 50); + // Send Footer for the command block (3 bits (B010)) + sendGeneric(0, 0, // No Header + KELVINATOR_BIT_MARK, KELVINATOR_ONE_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_ZERO_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_GAP_SPACE, + KELVINATOR_CMD_FOOTER, KELVINATOR_CMD_FOOTER_BITS, + 38, false, 0, 50); + // Data Block #2 (4 bytes) + sendGeneric(0, 0, // No header + KELVINATOR_BIT_MARK, KELVINATOR_ONE_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_ZERO_SPACE, + KELVINATOR_BIT_MARK, KELVINATOR_GAP_SPACE * 2, + data + 12, 4, 38, false, 0, 50); + } +} +#endif // SEND_KELVINATOR + +IRKelvinatorAC::IRKelvinatorAC(uint16_t pin) : _irsend(pin) { + stateReset(); +} + +void IRKelvinatorAC::stateReset() { + for (uint8_t i = 0; i < KELVINATOR_STATE_LENGTH; i++) + remote_state[i] = 0x0; + remote_state[3] = 0x50; + remote_state[11] = 0x70; +} + +void IRKelvinatorAC::begin() { + _irsend.begin(); +} + +void IRKelvinatorAC::fixup() { + // X-Fan mode is only valid in COOL or DRY modes. + if (getMode() != KELVINATOR_COOL && getMode() != KELVINATOR_DRY) + setXFan(false); + checksum(); // Calculate the checksums +} + +#if SEND_KELVINATOR +void IRKelvinatorAC::send() { + fixup(); // Ensure correct settings before sending. + _irsend.sendKelvinator(remote_state); +} +#endif // SEND_KELVINATOR + +uint8_t* IRKelvinatorAC::getRaw() { + fixup(); // Ensure correct settings before sending. + return remote_state; +} + +void IRKelvinatorAC::setRaw(uint8_t new_code[]) { + for (uint8_t i = 0; i < KELVINATOR_STATE_LENGTH; i++) { + remote_state[i] = new_code[i]; + } +} + +uint8_t IRKelvinatorAC::calcBlockChecksum(const uint8_t *block, + const uint16_t length) { + uint8_t sum = KELVINATOR_CHECKSUM_START; + // Sum the lower half of the first 4 bytes of this block. + for (uint8_t i = 0; i < 4 && i < length - 1; i++, block++) + sum += (*block & 0x0FU); + // then sum the upper half of the next 3 bytes. + for (uint8_t i = 4; i < length - 1; i++, block++) + sum += (*block >> 4); + // Trim it down to fit into the 4 bits allowed. i.e. Mod 16. + return sum & 0x0FU; +} + +// Many Bothans died to bring us this information. +void IRKelvinatorAC::checksum(const uint16_t length) { + // For each command + options block. + for (uint16_t offset = 0; offset + 7 < length; offset += 8) { + uint8_t sum = calcBlockChecksum(remote_state + offset); + remote_state[7 + offset] = (sum << 4) | (remote_state[7 + offset] & 0xFU); + } +} + +// Verify the checksum is valid for a given state. +// Args: +// state: The array to verify the checksum of. +// length: The size of the state. +// Returns: +// A boolean. +bool IRKelvinatorAC::validChecksum(const uint8_t state[], + const uint16_t length) { + for (uint16_t offset = 0; offset + 7 < length; offset += 8) { + // Top 4 bits of the last byte in the block is the block's checksum. + if (state[offset + 7] >> 4 != calcBlockChecksum(state + offset)) + return false; + } + return true; +} + +void IRKelvinatorAC::on() { + remote_state[0] |= KELVINATOR_POWER; + remote_state[8] = remote_state[0]; // Duplicate to the 2nd command chunk. +} + +void IRKelvinatorAC::off() { + remote_state[0] &= ~KELVINATOR_POWER; + remote_state[8] = remote_state[0]; // Duplicate to the 2nd command chunk. +} + +void IRKelvinatorAC::setPower(bool state) { + if (state) + on(); + else + off(); +} + +bool IRKelvinatorAC::getPower() { + return ((remote_state[0] & KELVINATOR_POWER) != 0); +} + +// Set the temp. in deg C +void IRKelvinatorAC::setTemp(uint8_t temp) { + temp = std::max((uint8_t) KELVINATOR_MIN_TEMP, temp); + temp = std::min((uint8_t) KELVINATOR_MAX_TEMP, temp); + remote_state[1] = (remote_state[1] & 0xF0U) | (temp - KELVINATOR_MIN_TEMP); + remote_state[9] = remote_state[1]; // Duplicate to the 2nd command chunk. +} + +// Return the set temp. in deg C +uint8_t IRKelvinatorAC::getTemp() { + return ((remote_state[1] & 0xFU) + KELVINATOR_MIN_TEMP); +} + +// Set the speed of the fan, 0-5, 0 is auto, 1-5 is the speed +void IRKelvinatorAC::setFan(uint8_t fan) { + fan = std::min((uint8_t) KELVINATOR_FAN_MAX, fan); // Bounds check + + // Only change things if we need to. + if (fan != getFan()) { + // Set the basic fan values. + uint8_t fan_basic = std::min((uint8_t) KELVINATOR_BASIC_FAN_MAX, fan); + remote_state[0] = (remote_state[0] & KELVINATOR_BASIC_FAN_MASK) | + (fan_basic << KELVINATOR_FAN_OFFSET); + remote_state[8] = remote_state[0]; // Duplicate to the 2nd command chunk. + // Set the advanced(?) fan value. + remote_state[14] = (remote_state[14] & KELVINATOR_FAN_MASK) | + (fan << KELVINATOR_FAN_OFFSET); + setTurbo(false); // Turbo mode is turned off if we change the fan settings. + } +} + +uint8_t IRKelvinatorAC::getFan() { + return ((remote_state[14] & ~KELVINATOR_FAN_MASK) >> KELVINATOR_FAN_OFFSET); +} + +uint8_t IRKelvinatorAC::getMode() { + return (remote_state[0] & ~KELVINATOR_MODE_MASK); +} + +void IRKelvinatorAC::setMode(uint8_t mode) { + // If we get an unexpected mode, default to AUTO. + if (mode > KELVINATOR_HEAT) mode = KELVINATOR_AUTO; + remote_state[0] = (remote_state[0] & KELVINATOR_MODE_MASK) | mode; + remote_state[8] = remote_state[0]; // Duplicate to the 2nd command chunk. + if (mode == KELVINATOR_AUTO || KELVINATOR_DRY) + // When the remote is set to Auto or Dry, it defaults to 25C and doesn't + // show it. + setTemp(KELVINATOR_AUTO_TEMP); +} + +void IRKelvinatorAC::setSwingVertical(bool state) { + if (state) { + remote_state[0] |= KELVINATOR_VENT_SWING; + remote_state[4] |= KELVINATOR_VENT_SWING_V; + } else { + remote_state[4] &= ~KELVINATOR_VENT_SWING_V; + if (!getSwingHorizontal()) + remote_state[0] &= ~KELVINATOR_VENT_SWING; + } + remote_state[8] = remote_state[0]; // Duplicate to the 2nd command chunk. +} + +bool IRKelvinatorAC::getSwingVertical() { + return ((remote_state[4] & KELVINATOR_VENT_SWING_V) != 0); +} + +void IRKelvinatorAC::setSwingHorizontal(bool state) { + if (state) { + remote_state[0] |= KELVINATOR_VENT_SWING; + remote_state[4] |= KELVINATOR_VENT_SWING_H; + } else { + remote_state[4] &= ~KELVINATOR_VENT_SWING_H; + if (!getSwingVertical()) + remote_state[0] &= ~KELVINATOR_VENT_SWING; + } + remote_state[8] = remote_state[0]; // Duplicate to the 2nd command chunk. +} + +bool IRKelvinatorAC::getSwingHorizontal() { + return ((remote_state[4] & KELVINATOR_VENT_SWING_H) != 0); +} + +void IRKelvinatorAC::setQuiet(bool state) { + remote_state[12] &= ~KELVINATOR_QUIET; + remote_state[12] |= (state << KELVINATOR_QUIET_OFFSET); +} + +bool IRKelvinatorAC::getQuiet() { + return ((remote_state[12] & KELVINATOR_QUIET) != 0); +} + +void IRKelvinatorAC::setIonFilter(bool state) { + remote_state[2] &= ~KELVINATOR_ION_FILTER; + remote_state[2] |= (state << KELVINATOR_ION_FILTER_OFFSET); + remote_state[10] = remote_state[2]; // Duplicate to the 2nd command chunk. +} + +bool IRKelvinatorAC::getIonFilter() { + return ((remote_state[2] & KELVINATOR_ION_FILTER) != 0); +} + +void IRKelvinatorAC::setLight(bool state) { + remote_state[2] &= ~KELVINATOR_LIGHT; + remote_state[2] |= (state << KELVINATOR_LIGHT_OFFSET); + remote_state[10] = remote_state[2]; // Duplicate to the 2nd command chunk. +} + +bool IRKelvinatorAC::getLight() { + return ((remote_state[2] & KELVINATOR_LIGHT) != 0); +} + +// Note: XFan mode is only valid in Cool or Dry mode. +void IRKelvinatorAC::setXFan(bool state) { + remote_state[2] &= ~KELVINATOR_XFAN; + remote_state[2] |= (state << KELVINATOR_XFAN_OFFSET); + remote_state[10] = remote_state[2]; // Duplicate to the 2nd command chunk. +} + +bool IRKelvinatorAC::getXFan() { + return ((remote_state[2] & KELVINATOR_XFAN) != 0); +} + +// Note: Turbo mode is turned off if the fan speed is changed. +void IRKelvinatorAC::setTurbo(bool state) { + remote_state[2] &= ~KELVINATOR_TURBO; + remote_state[2] |= (state << KELVINATOR_TURBO_OFFSET); + remote_state[10] = remote_state[2]; // Duplicate to the 2nd command chunk. +} + +bool IRKelvinatorAC::getTurbo() { + return ((remote_state[2] & KELVINATOR_TURBO) != 0); +} + +// Convert the internal state into a human readable string. +#ifdef ARDUINO +String IRKelvinatorAC::toString() { + String result = ""; +#else +std::string IRKelvinatorAC::toString() { + std::string result = ""; +#endif // ARDUINO + result += "Power: "; + if (getPower()) + result += "On"; + else + result += "Off"; + result += ", Mode: " + uint64ToString(getMode()); + switch (getMode()) { + case KELVINATOR_AUTO: + result += " (AUTO)"; + break; + case KELVINATOR_COOL: + result += " (COOL)"; + break; + case KELVINATOR_HEAT: + result += " (HEAT)"; + break; + case KELVINATOR_DRY: + result += " (DRY)"; + break; + case KELVINATOR_FAN: + result += " (FAN)"; + break; + default: + result += " (UNKNOWN)"; + } + result += ", Temp: " + uint64ToString(getTemp()) + "C"; + result += ", Fan: " + uint64ToString(getFan()); + switch (getFan()) { + case KELVINATOR_FAN_AUTO: + result += " (AUTO)"; + break; + case KELVINATOR_FAN_MAX: + result += " (MAX)"; + break; + } + result += ", Turbo: "; + if (getTurbo()) + result += "On"; + else + result += "Off"; + result += ", Quiet: "; + if (getQuiet()) + result += "On"; + else + result += "Off"; + result += ", XFan: "; + if (getXFan()) + result += "On"; + else + result += "Off"; + result += ", IonFilter: "; + if (getIonFilter()) + result += "On"; + else + result += "Off"; + result += ", Light: "; + if (getLight()) + result += "On"; + else + result += "Off"; + result += ", Swing (Horizontal): "; + if (getSwingHorizontal()) + result += "On"; + else + result += "Off"; + result += ", Swing (Vertical): "; + if (getSwingVertical()) + result += "On"; + else + result += "Off"; + return result; +} + +#if DECODE_KELVINATOR +// Decode the supplied Kelvinator message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. Typically KELVINATOR_BITS. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: ALPHA / Untested. +bool IRrecv::decodeKelvinator(decode_results *results, uint16_t nbits, + bool strict) { + if (results->rawlen < 2 * (nbits + KELVINATOR_CMD_FOOTER_BITS) + + (HEADER + FOOTER + 1) * 2 - 1) + return false; // Can't possibly be a valid Kelvinator message. + if (strict && nbits != KELVINATOR_BITS) + return false; // Not strictly a Kelvinator message. + + uint32_t data; + uint16_t offset = OFFSET_START; + + // There are two messages back-to-back in a full Kelvinator IR message + // sequence. + int8_t state_pos = 0; + for (uint8_t s = 0; s < 2; s++) { + match_result_t data_result; + + // Header + if (!matchMark(results->rawbuf[offset], KELVINATOR_HDR_MARK)) return false; + // Calculate how long the lowest tick time is based on the header mark. + uint32_t mark_tick = results->rawbuf[offset++] * RAWTICK / + KELVINATOR_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset], KELVINATOR_HDR_SPACE)) + return false; + // Calculate how long the common tick time is based on the header space. + uint32_t space_tick = results->rawbuf[offset++] * RAWTICK / + KELVINATOR_HDR_SPACE_TICKS; + + // Data (Command) (32 bits) + data_result = matchData(&(results->rawbuf[offset]), 32, + KELVINATOR_BIT_MARK_TICKS * mark_tick, + KELVINATOR_ONE_SPACE_TICKS * space_tick, + KELVINATOR_BIT_MARK_TICKS * mark_tick, + KELVINATOR_ZERO_SPACE_TICKS * space_tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + + // Record command data in the state. + for (int i = state_pos + 3; i >= state_pos; i--, data >>= 8) + results->state[i] = reverseBits(data & 0xFF, 8); + state_pos += 4; + + // Command data footer (3 bits, B010) + data_result = matchData(&(results->rawbuf[offset]), + KELVINATOR_CMD_FOOTER_BITS, + KELVINATOR_BIT_MARK_TICKS * mark_tick, + KELVINATOR_ONE_SPACE_TICKS * space_tick, + KELVINATOR_BIT_MARK_TICKS * mark_tick, + KELVINATOR_ZERO_SPACE_TICKS * space_tick); + if (data_result.success == false) return false; + if (data_result.data != KELVINATOR_CMD_FOOTER) return false; + offset += data_result.used; + + // Interdata gap. + if (!matchMark(results->rawbuf[offset++], + KELVINATOR_BIT_MARK_TICKS * mark_tick)) + return false; + if (!matchSpace(results->rawbuf[offset++], + KELVINATOR_GAP_SPACE_TICKS * space_tick)) + return false; + + // Data (Options) (32 bits) + data_result = matchData(&(results->rawbuf[offset]), 32, + KELVINATOR_BIT_MARK_TICKS * mark_tick, + KELVINATOR_ONE_SPACE_TICKS * space_tick, + KELVINATOR_BIT_MARK_TICKS * mark_tick, + KELVINATOR_ZERO_SPACE_TICKS * space_tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + + // Record option data in the state. + for (int i = state_pos + 3; i >= state_pos; i--, data >>= 8) + results->state[i] = reverseBits(data & 0xFF, 8); + state_pos += 4; + + // Inter-sequence gap. (Double length gap) + if (!matchMark(results->rawbuf[offset++], + KELVINATOR_BIT_MARK_TICKS * mark_tick)) + return false; + if (s == 0) { + if (!matchSpace(results->rawbuf[offset++], + KELVINATOR_GAP_SPACE_TICKS * space_tick * 2)) + return false; + } else { + if (offset <= results->rawlen && + !matchAtLeast(results->rawbuf[offset], + KELVINATOR_GAP_SPACE_TICKS * 2 * space_tick)) + return false; + } + } + + // Compliance + if (strict) { + // Correct size/length) + if (state_pos != KELVINATOR_STATE_LENGTH) return false; + // Verify the message's checksum is correct. + if (!IRKelvinatorAC::validChecksum(results->state)) return false; + } + + // Success + results->decode_type = KELVINATOR; + results->bits = state_pos * 8; + // No need to record the state as we stored it as we decoded it. + // As we use result->state, we don't record value, address, or command as it + // is a union data type. + return true; +} +#endif // DECODE_KELVINATOR diff --git a/IRremoteESP8266/src/ir_Kelvinator.h b/IRremoteESP8266/src/ir_Kelvinator.h new file mode 100644 index 0000000..6343b5a --- /dev/null +++ b/IRremoteESP8266/src/ir_Kelvinator.h @@ -0,0 +1,168 @@ +// Kelvinator A/C +// +// Copyright 2016 David Conran + +#ifndef IR_KELVINATOR_H_ +#define IR_KELVINATOR_H_ + +#define __STDC_LIMIT_MACROS +#include +#ifndef UNIT_TEST +#include +#else +#include +#endif +#include "IRremoteESP8266.h" +#include "IRsend.h" + +// KK KK EEEEEEE LL VV VV IIIII NN NN AAA TTTTTTT OOOOO RRRRRR +// KK KK EE LL VV VV III NNN NN AAAAA TTT OO OO RR RR +// KKKK EEEEE LL VV VV III NN N NN AA AA TTT OO OO RRRRRR +// KK KK EE LL VV VV III NN NNN AAAAAAA TTT OO OO RR RR +// KK KK EEEEEEE LLLLLLL VVV IIIII NN NN AA AA TTT OOOO0 RR RR + +// Constants +#define KELVINATOR_AUTO 0U +#define KELVINATOR_COOL 1U +#define KELVINATOR_DRY 2U +#define KELVINATOR_FAN 3U +#define KELVINATOR_HEAT 4U +#define KELVINATOR_BASIC_FAN_MAX 3U +#define KELVINATOR_FAN_AUTO 0U +#define KELVINATOR_FAN_MAX 5U +#define KELVINATOR_MIN_TEMP 16U // 16C +#define KELVINATOR_MAX_TEMP 30U // 30C +#define KELVINATOR_AUTO_TEMP 25U // 25C + +/* + Kelvinator AC map + + (header mark and space) + byte 0 = Basic Modes + b2-0 = Modes + Modes: + 000 = Auto (temp = 25C) + 001 = Cool + 010 = Dry (temp = 25C, but not shown) + 011 = Fan + 100 = Heat + b3 = Power Status (1 = On, 0 = Off) + b5-4 = Fan (Basic modes) + Fan: + 00 = Auto + 01 = Fan 1 + 10 = Fan 2 + 11 = Fan 3 or higher (See byte 14) + b6 = Vent swing (1 = On, 0 = Off) (See byte 4) + b7 = Sleep Modes 1 & 3 (1 = On, 0 = Off) + byte 1 = Temperature + b3-0: Degrees C. + 0000 (0) = 16C + 0001 (1) = 17C + 0010 (2) = 18C + ... + 1101 (13) = 29C + 1110 (14) = 30C + byte 2 = Extras + b3-0 = UNKNOWN, typically 0. + b4 = Turbo Fan (1 = On, 0 = Off) + b5 = Light (Display) (1 = On, 0 = Off) + b6 = Ion Filter (1 = On, 0 = Off) + b7 = X-Fan (Fan runs for a while after power off) (1 = On, 0 = Off) + byte 3 = Section Indicator + b3-0 = Unused (Typically 0) + b5-4 = Unknown (possibly timer related) (Typically 0b01) + b7-6 = End of command block (B01) + (B010 marker and a gap of 20ms) + byte 4 = Extended options + b0 = Swing Vent Vertical (1 = On, 0 = Off) + b4 = Swing Vent Horizontal (1 = On, 0 = Off) + byte 5-6 = Timer related. Typically 0 except when timer in use. + byte 7 = checksum + b3-0 = Unknown (Used in Timer mode) + b7-4 = checksum of the previous bytes (0-6) + (gap of 40ms) + (header mark and space) + byte 8 = Repeat of byte 0 + byte 9 = Repeat of byte 1 + byte 10 = Repeat of byte 2 + byte 11 = Section Indicator + b3-0 = Unused (Typically 0) + b5-4 = Unknown (possibly timer related) (Typically 0b11) + b7-6 = End of command block (B01) + (B010 marker and a gap of 20ms) + byte 12 = Extended options + b0 = Sleep mode 2 (1 = On, 0=Off) + b6-1 = Unknown (Used in Sleep Mode 3, Typically 0b000000) + b7 = Quiet Mode (1 = On, 0=Off) + byte 13 = Unknown (Sleep Mode 3 related, Typically 0x00) + byte 14 = Fan control + b3-0 = Unknown (Sleep Mode 3 related, Typically 0b0000) + b6-4 = Fan speed + 0b000 (0) = Automatic + 0b001 (1) = Fan 1 + 0b010 (2) = Fan 2 + 0b011 (3) = Fan 3 + 0b100 (4) = Fan 4 + 0b101 (5) = Fan 5 + byte 15 = checksum + b3-0 = Unknown (Typically 0b0000) + b7-4 = checksum of the previous bytes (8-14) +*/ + +// Classes +class IRKelvinatorAC { + public: + explicit IRKelvinatorAC(uint16_t pin); + + void stateReset(); +#if SEND_KELVINATOR + void send(); +#endif // SEND_KELVINATOR + void begin(); + void on(); + void off(); + void setPower(bool state); + bool getPower(); + void setTemp(uint8_t temp); + uint8_t getTemp(); + void setFan(uint8_t fan); + uint8_t getFan(); + void setMode(uint8_t mode); + uint8_t getMode(); + void setSwingVertical(bool state); + bool getSwingVertical(); + void setSwingHorizontal(bool state); + bool getSwingHorizontal(); + void setQuiet(bool state); + bool getQuiet(); + void setIonFilter(bool state); + bool getIonFilter(); + void setLight(bool state); + bool getLight(); + void setXFan(bool state); + bool getXFan(); + void setTurbo(bool state); + bool getTurbo(); + uint8_t* getRaw(); + void setRaw(uint8_t new_code[]); + static uint8_t calcBlockChecksum( + const uint8_t *block, + const uint16_t length = KELVINATOR_STATE_LENGTH / 2); + static bool validChecksum(const uint8_t state[], + const uint16_t length = KELVINATOR_STATE_LENGTH); +#ifdef ARDUINO + String toString(); +#else + std::string toString(); +#endif + + private: + // The state of the IR remote in IR code form. + uint8_t remote_state[KELVINATOR_STATE_LENGTH]; + void checksum(const uint16_t length = KELVINATOR_STATE_LENGTH); + void fixup(); + IRsend _irsend; +}; + +#endif // IR_KELVINATOR_H_ diff --git a/IRremoteESP8266/src/ir_LG.cpp b/IRremoteESP8266/src/ir_LG.cpp new file mode 100644 index 0000000..f2d3d06 --- /dev/null +++ b/IRremoteESP8266/src/ir_LG.cpp @@ -0,0 +1,218 @@ +// Copyright 2015 Darryl Smith +// Copyright 2015 cheaplin +// Copyright 2017 David Conran + +#include "ir_LG.h" +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// L GGGG +// L G +// L G GG +// L G G +// LLLLL GGG + +// LG decode originally added by Darryl Smith (based on the JVC protocol) +// LG send originally added by https://github.com/chaeplin + +// Constants +#define LG_TICK 50U +#define LG_HDR_MARK_TICKS 160U +#define LG_HDR_MARK (LG_HDR_MARK_TICKS * LG_TICK) +#define LG_HDR_SPACE_TICKS 80U +#define LG_HDR_SPACE (LG_HDR_SPACE_TICKS * LG_TICK) +#define LG_BIT_MARK_TICKS 11U +#define LG_BIT_MARK (LG_BIT_MARK_TICKS * LG_TICK) +#define LG_ONE_SPACE_TICKS 32U +#define LG_ONE_SPACE (LG_ONE_SPACE_TICKS * LG_TICK) +#define LG_ZERO_SPACE_TICKS 11U +#define LG_ZERO_SPACE (LG_ZERO_SPACE_TICKS * LG_TICK) +#define LG_RPT_SPACE_TICKS 45U +#define LG_RPT_SPACE (LG_RPT_SPACE_TICKS * LG_TICK) +#define LG_MIN_GAP_TICKS 795U +#define LG_MIN_GAP (LG_MIN_GAP_TICKS * LG_TICK) +#define LG_MIN_MESSAGE_LENGTH_TICKS 2161U +#define LG_MIN_MESSAGE_LENGTH (LG_MIN_MESSAGE_LENGTH_TICKS * LG_TICK) +#define LG32_HDR_MARK_TICKS 90U +#define LG32_HDR_MARK (LG32_HDR_MARK_TICKS * LG_TICK) +#define LG32_HDR_SPACE_TICKS 89U +#define LG32_HDR_SPACE (LG32_HDR_SPACE_TICKS * LG_TICK) +#define LG32_RPT_HDR_MARK_TICKS 179U +#define LG32_RPT_HDR_MARK (LG32_RPT_HDR_MARK_TICKS * LG_TICK) + +#if (SEND_LG || DECODE_LG) +// Calculate the rolling 4-bit wide checksum over all of the data. +// Args: +// data: The value to be checksum'ed. +// Returns: +// A 4-bit checksum. +uint8_t calcLGChecksum(uint16_t data) { + return(((data >> 12) + ((data >> 8) & 0xF) + ((data >> 4) & 0xF) + + (data & 0xF)) & 0xF); +} +#endif + +#if SEND_LG +// Send an LG formatted message. +// +// Args: +// data: The contents of the message you want to send. +// nbits: The bit size of the message being sent. +// Typically LG_BITS or LG32_BITS. +// repeat: The number of times you want the message to be repeated. +// +// Status: Beta / Should be working. +// +// Notes: +// LG has a separate message to indicate a repeat, like NEC does. +void IRsend::sendLG(uint64_t data, uint16_t nbits, uint16_t repeat) { + uint16_t repeatHeaderMark = 0; + + if (nbits >= LG32_BITS) { + // LG 32bit protocol is near identical to Samsung except for repeats. + sendSAMSUNG(data, nbits, 0); // Send it as a single Samsung message. + repeatHeaderMark = LG32_RPT_HDR_MARK; + repeat++; + } else { + // LG (28-bit) protocol. + repeatHeaderMark = LG_HDR_MARK; + sendGeneric(LG_HDR_MARK, LG_HDR_SPACE, + LG_BIT_MARK, LG_ONE_SPACE, + LG_BIT_MARK, LG_ZERO_SPACE, + LG_BIT_MARK, + LG_MIN_GAP, LG_MIN_MESSAGE_LENGTH, + data, nbits, 38, true, 0, // Repeats are handled later. + 50); + } + + // Repeat + // Protocol has a mandatory repeat-specific code sent after every command. + if (repeat) + sendGeneric(repeatHeaderMark, LG_RPT_SPACE, + 0, 0, 0, 0, // No data is sent. + LG_BIT_MARK, LG_MIN_GAP, LG_MIN_MESSAGE_LENGTH, + 0, 0, // No data. + 38, true, repeat - 1, 50); +} + +// Construct a raw 28-bit LG message from the supplied address & command. +// +// Args: +// address: The address code. +// command: The command code. +// Returns: +// A raw 28-bit LG message suitable for sendLG(). +// +// Status: BETA / Should work. +// +// Notes: +// e.g. Sequence of bits = address + command + checksum. +uint32_t IRsend::encodeLG(uint16_t address, uint16_t command) { + return ((address << 20) | (command << 4) | calcLGChecksum(command)); +} +#endif + +#if DECODE_LG +// Decode the supplied LG message. +// LG protocol has a repeat code which is 4 items long. +// Even though the protocol has 28/32 bits of data, only 24/28 bits are +// distinct. +// In transmission order, the 28/32 bits are constructed as follows: +// 8/12 bits of address + 16 bits of command + 4 bits of checksum. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of bits to expect in the data portion. +// Typically LG_BITS or LG32_BITS. +// strict: Flag to indicate if we strictly adhere to the specification. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / Should work. +// +// Note: +// LG 32bit protocol appears near identical to the Samsung protocol. +// They possibly differ on how they repeat and initial HDR mark. + +// Ref: +// https://funembedded.wordpress.com/2014/11/08/ir-remote-control-for-lg-conditioner-using-stm32f302-mcu-on-mbed-platform/ +bool IRrecv::decodeLG(decode_results *results, uint16_t nbits, bool strict) { + if (nbits >= LG32_BITS) { + if (results->rawlen < 2 * nbits + 2 * (HEADER + FOOTER) - 1) + return false; // Can't possibly be a valid LG32 message. + } else { + if (results->rawlen < 2 * nbits + HEADER + FOOTER - 1) + return false; // Can't possibly be a valid LG message. + } + if (strict && nbits != LG_BITS && nbits != LG32_BITS) + return false; // Doesn't comply with expected LG protocol. + + uint64_t data = 0; + uint16_t offset = OFFSET_START; + + // Header + if (!matchMark(results->rawbuf[offset], LG_HDR_MARK) && + !matchMark(results->rawbuf[offset], LG32_HDR_MARK)) return false; + uint32_t m_tick; + if (matchMark(results->rawbuf[offset], LG_HDR_MARK)) + m_tick = results->rawbuf[offset++] * RAWTICK / LG_HDR_MARK_TICKS; + else + m_tick = results->rawbuf[offset++] * RAWTICK / LG32_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset], LG_HDR_SPACE) && + !matchSpace(results->rawbuf[offset], LG32_HDR_SPACE)) return false; + uint32_t s_tick; + if (matchSpace(results->rawbuf[offset], LG_HDR_SPACE)) + s_tick = results->rawbuf[offset++] * RAWTICK / LG_HDR_SPACE_TICKS; + else + s_tick = results->rawbuf[offset++] * RAWTICK / LG32_HDR_SPACE_TICKS; + + // Data + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + LG_BIT_MARK_TICKS * m_tick, + LG_ONE_SPACE_TICKS * s_tick, + LG_BIT_MARK_TICKS * m_tick, + LG_ZERO_SPACE_TICKS * s_tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + + // Footer + if (!matchMark(results->rawbuf[offset++], LG_BIT_MARK_TICKS * m_tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], LG_MIN_GAP_TICKS * s_tick)) + return false; + + // Repeat + if (nbits >= LG32_BITS) { + // If we are expecting the LG 32-bit protocol, there is always + // a repeat message. So, check for it. + offset++; + if (!matchMark(results->rawbuf[offset++], LG32_RPT_HDR_MARK_TICKS * m_tick)) + return false; + if (!matchSpace(results->rawbuf[offset++], LG_RPT_SPACE_TICKS * s_tick)) + return false; + if (!matchMark(results->rawbuf[offset++], LG_BIT_MARK_TICKS * m_tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], LG_MIN_GAP_TICKS * s_tick)) + return false; + } + + // Compliance + uint16_t command = (data >> 4) & 0xFFFF; // The 16 bits before the checksum. + + if (strict && (data & 0xF) != calcLGChecksum(command)) + return false; // The last 4 bits sent are the expected checksum. + + // Success + results->decode_type = LG; + results->bits = nbits; + results->value = data; + results->command = command; + results->address = data >> 20; // The bits before the command. + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_LG.h b/IRremoteESP8266/src/ir_LG.h new file mode 100644 index 0000000..25d56bc --- /dev/null +++ b/IRremoteESP8266/src/ir_LG.h @@ -0,0 +1,17 @@ +// Copyright 2017 David Conran + +#ifndef IR_LG_H_ +#define IR_LG_H_ + +// L GGGG +// L G +// L G GG +// L G G +// LLLLL GGG + +#define __STDC_LIMIT_MACROS +#include + +uint8_t calcLGChecksum(uint16_t data); + +#endif // IR_LG_H_ diff --git a/IRremoteESP8266/src/ir_Lasertag.cpp b/IRremoteESP8266/src/ir_Lasertag.cpp new file mode 100644 index 0000000..2fc930b --- /dev/null +++ b/IRremoteESP8266/src/ir_Lasertag.cpp @@ -0,0 +1,124 @@ +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// LL AAA SSSSS EEEEEEE RRRRRR TTTTTTT AAA GGGG +// LL AAAAA SS EE RR RR TTT AAAAA GG GG +// LL AA AA SSSSS EEEEE RRRRRR TTT AA AA GG +// LL AAAAAAA SS EE RR RR TTT AAAAAAA GG GG +// LLLLLLL AA AA SSSSS EEEEEEE RR RR TTT AA AA GGGGGG + +// Constants +#define MIN_LASERTAG_SAMPLES 13U +#define LASERTAG_TICK 333U +#define LASERTAG_MIN_GAP 100000UL // Completely made up amount. +#define LASERTAG_TOLERANCE 0U // Percentage error margin +#define LASERTAG_EXCESS 0U // See MARK_EXCESS +#define LASERTAG_DELTA 150U // Use instead of EXCESS and TOLERANCE. +const int16_t kSPACE = 1; +const int16_t kMARK = 0; + +#if SEND_LASERTAG +// Send a Lasertag packet. +// This protocol is pretty much just raw Manchester encoding. +// +// Args: +// data: The message you wish to send. +// nbits: Bit size of the protocol you want to send. +// repeat: Nr. of extra times the data will be sent. +// +// Status: STABLE / Working. +// + +void IRsend::sendLasertag(uint64_t data, uint16_t nbits, uint16_t repeat) { + if (nbits > sizeof(data) * 8) + return; // We can't send something that big. + + // Set 36kHz IR carrier frequency & a 1/4 (25%) duty cycle. + // NOTE: duty cycle is not confirmed. Just guessing based on RC5/6 protocols. + enableIROut(36, 25); + + for (uint16_t i = 0; i <= repeat; i++) { + // Data + for (uint64_t mask = 1ULL << (nbits - 1); mask; mask >>= 1) + if (data & mask) { // 1 + space(LASERTAG_TICK); // 1 is space, then mark. + mark(LASERTAG_TICK); + } else { // 0 + mark(LASERTAG_TICK); // 0 is mark, then space. + space(LASERTAG_TICK); + } + // Footer + space(LASERTAG_MIN_GAP); + } +} +#endif // SEND_LASERTAG + +#if DECODE_LASERTAG +// Decode the supplied Lasertag message. +// This protocol is pretty much just raw Manchester encoding. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / Appears to be working 90% of the time. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/rc5.php +// https://en.wikipedia.org/wiki/RC-5 +// https://en.wikipedia.org/wiki/Manchester_code +bool IRrecv::decodeLasertag(decode_results *results, uint16_t nbits, + bool strict) { + if (results->rawlen < MIN_LASERTAG_SAMPLES) return false; + + // Compliance + if (strict && nbits != LASERTAG_BITS) return false; + + uint16_t offset = OFFSET_START; + uint16_t used = 0; + uint64_t data = 0; + uint16_t actual_bits = 0; + + // No Header + + // Data + for (; offset <= results->rawlen; actual_bits++) { + int16_t levelA = getRClevel(results, &offset, &used, LASERTAG_TICK, + LASERTAG_TOLERANCE, LASERTAG_EXCESS, + LASERTAG_DELTA); + int16_t levelB = getRClevel(results, &offset, &used, LASERTAG_TICK, + LASERTAG_TOLERANCE, LASERTAG_EXCESS, + LASERTAG_DELTA); + if (levelA == kSPACE && levelB == kMARK) { + data = (data << 1) | 1; // 1 + } else { + if (levelA == kMARK && levelB == kSPACE) { + data <<= 1; // 0 + } else { + break; + } + } + } + // Footer (None) + + // Compliance + if (actual_bits < nbits) return false; // Less data than we expected. + if (strict && actual_bits != LASERTAG_BITS) return false; + + // Success + results->decode_type = LASERTAG; + results->value = data; + results->address = data & 0xF; // Unit + results->command = data >> 4; // Team + results->repeat = false; + results->bits = actual_bits; + return true; +} +#endif // DECODE_LASERTAG diff --git a/IRremoteESP8266/src/ir_Magiquest.cpp b/IRremoteESP8266/src/ir_Magiquest.cpp new file mode 100644 index 0000000..dcf2174 --- /dev/null +++ b/IRremoteESP8266/src/ir_Magiquest.cpp @@ -0,0 +1,160 @@ +// Copyright 2013 mpflaga +// Copyright 2015 kitlaan +// Copyright 2017 Jason kendall, David Conran + +#include "ir_Magiquest.h" +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +#define IS_ZERO(m, s) (((m) * 100 / ((m) + (s))) <= MAGIQUEST_ZERO_RATIO) +#define IS_ONE(m, s) (((m) * 100 / ((m) + (s))) >= MAGIQUEST_ONE_RATIO) + +// Strips taken from: +// https://github.com/kitlaan/Arduino-IRremote/blob/master/ir_Magiquest.cpp +// and +// https://github.com/mpflaga/Arduino-IRremote + +// Source: https://github.com/mpflaga/Arduino-IRremote + +#if SEND_MAGIQUEST +// Send a MagiQuest formatted message. +// +// Args: +// data: The contents of the message you want to send. +// nbits: The bit size of the message being sent. +// Typically MAGIQUEST_BITS. +// repeat: The number of times you want the message to be repeated. +// +// Status: Alpha / Should be working. +// +void IRsend::sendMagiQuest(uint64_t data, uint16_t nbits, uint16_t repeat) { + sendGeneric(0, 0, // No Headers - Technically it's included in the data. + // i.e. 8 zeros. + MAGIQUEST_MARK_ONE, MAGIQUEST_SPACE_ONE, + MAGIQUEST_MARK_ZERO, MAGIQUEST_SPACE_ZERO, + 0, // No footer mark. + MAGIQUEST_GAP, + data, nbits, 36, true, repeat, 50); +} + +// Encode a MagiQuest wand_id, and a magnitude into a single 64bit value. +// (Only 48 bits of real data + 8 leading zero bits) +// This is suitable for calling sendMagiQuest() with. +// e.g. sendMagiQuest(encodeMagiQuest(wand_id, magnitude)); +uint64_t IRsend::encodeMagiQuest(uint32_t wand_id, uint16_t magnitude) { + uint64_t result = 0; + result = wand_id; + result <<= 16; + result |= magnitude; + // Shouldn't be needed, but ensure top 8/16 bit are zero. + result &= 0xFFFFFFFFFFFFULL; + return result; +} +#endif + +// Source: https://github.com/kitlaan/Arduino-IRremote/blob/master/ir_Magiquest.cpp + +#if DECODE_MAGIQUEST +// Decode the supplied MagiQuest message. +// MagiQuest protocol appears to be a header of 8 'zero' bits, followed +// by 32 bits of "wand ID" and finally 16 bits of "magnitude". +// Even though we describe this protocol as 56 bits, it really only has +// 48 bits of data that matter. +// +// In transmission order, 8 zeros + 32 wand_id + 16 magnitude. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of bits to expect in the data portion, inc. the 8 bit header. +// Typically MAGIQUEST_BITS. +// strict: Flag to indicate if we strictly adhere to the specification. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: Alpha / Should work. +// +// Ref: +// https://github.com/kitlaan/Arduino-IRremote/blob/master/ir_Magiquest.cpp +bool IRrecv::decodeMagiQuest(decode_results *results, uint16_t nbits, + bool strict) { + uint16_t bits = 0; + uint64_t data = 0; + uint16_t offset = OFFSET_START; + + if (results->rawlen < (2 * MAGIQUEST_BITS)) { + DPRINT("Not enough bits to be Magiquest - Rawlen: "); + DPRINT(results->rawlen); + DPRINT(" Expected: "); + DPRINTLN((2 * MAGIQUEST_BITS)); + return false; + } + + // Compliance + if (strict && nbits != MAGIQUEST_BITS) return false; + + // Of six wands as datapoints, so far they all start with 8 ZEROs. + // For example, here is the data from two wands + // 00000000 00100011 01001100 00100110 00000010 00000010 00010111 + // 00000000 00100000 10001000 00110001 00000010 00000010 10110100 + + // Decode the (MARK + SPACE) bits + while (offset + 1 < results->rawlen && bits < nbits - 1) { + uint16_t mark = results->rawbuf[offset]; + uint16_t space = results->rawbuf[offset + 1]; + if (!matchMark(mark + space, MAGIQUEST_TOTAL_USEC)) { + DPRINT("Not enough time to be Magiquest - Mark: "); + DPRINT(mark); + DPRINT(" Space: "); + DPRINT(space); + DPRINT(" Total: "); + DPRINT(mark+space); + DPRINT("Expected: "); + DPRINTLN(MAGIQUEST_TOTAL_USEC); + return false; + } + + if (IS_ZERO(mark, space)) data = (data << 1) | 0; + else if (IS_ONE( mark, space)) data = (data << 1) | 1; + else return false; + + bits++; + offset += 2; + + // Compliance + // The first 8 bits of this protocol are supposed to all be 0. + // Exit out early as it is never going to match. + if (strict && bits == 8 && data != 0) return false; + } + + // Last bit is special as the protocol ends with a SPACE, not a MARK. + // Grab the last MARK bit, assuming a good SPACE after it + if (offset < results->rawlen) { + uint16_t mark = results->rawbuf[offset]; + uint16_t space = (MAGIQUEST_TOTAL_USEC / RAWTICK) - mark; + + if (IS_ZERO(mark, space)) data = (data << 1) | 0; + else if (IS_ONE( mark, space)) data = (data << 1) | 1; + else return false; + + bits++; + } + + if (bits != nbits) return false; + + if (strict) { + // The top 8 bits of the 56 bits needs to be 0x00 to be valid. + // i.e. bits 56 to 49 are all zero. + if ((data >> (nbits - 8)) != 0) return false; + } + + // Success + results->decode_type = MAGIQUEST; + results->bits = bits; + results->value = data; + results->address = data >> 16; // Wand ID + results->command = data & 0xFFFF; // Magnitude + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Magiquest.h b/IRremoteESP8266/src/ir_Magiquest.h new file mode 100644 index 0000000..94cebfc --- /dev/null +++ b/IRremoteESP8266/src/ir_Magiquest.h @@ -0,0 +1,37 @@ +// Copyright 2013 mpflaga +// Copyright 2015 kitlaan +// Copyright 2017 Jason kendall, David Conran + +#ifndef IR_MAGIQUEST_H_ +#define IR_MAGIQUEST_H_ + +#define __STDC_LIMIT_MACROS +#include +#include "IRremoteESP8266.h" +#include "IRsend.h" + +// MagiQuest packet is both Wand ID and magnitude of swish and flick +union magiquest { + uint64_t llword; + uint8_t byte[8]; +// uint16_t word[4]; + uint32_t lword[2]; + struct { + uint16_t magnitude; + uint32_t wand_id; + uint8_t padding; + uint8_t scrap; + } cmd; +}; + +#define MAGIQUEST_TOTAL_USEC 1150U +#define MAGIQUEST_ZERO_RATIO 30U // usually <= ~25% +#define MAGIQUEST_ONE_RATIO 38U // usually >= ~50% + +#define MAGIQUEST_PERIOD 1150U +#define MAGIQUEST_MARK_ZERO 280U +#define MAGIQUEST_SPACE_ZERO 850U +#define MAGIQUEST_MARK_ONE 580U +#define MAGIQUEST_SPACE_ONE 600U +#define MAGIQUEST_GAP 100000UL // A guess of the gap between messages +#endif // IR_MAGIQUEST_H_ diff --git a/IRremoteESP8266/src/ir_Midea.cpp b/IRremoteESP8266/src/ir_Midea.cpp new file mode 100644 index 0000000..a3dd890 --- /dev/null +++ b/IRremoteESP8266/src/ir_Midea.cpp @@ -0,0 +1,426 @@ +// Copyright 2017 bwze, crankyoldgit + +#include "ir_Midea.h" +#include +#ifndef ARDUINO +#include +#endif +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// MM MM IIIII DDDDD EEEEEEE AAA +// MMM MMM III DD DD EE AAAAA +// MM MM MM III DD DD EEEEE AA AA +// MM MM III DD DD EE AAAAAAA +// MM MM IIIII DDDDDD EEEEEEE AA AA + +// Midea A/C added by (send) bwze/crankyoldgit & (decode) crankyoldgit +// +// Equipment it seems compatible with: +// * Pioneer System Model RYBO12GMFILCAD (12K BTU) +// * Pioneer System Model RUBO18GMFILCAD (18K BTU) +// * + +// Ref: +// https://docs.google.com/spreadsheets/d/1TZh4jWrx4h9zzpYUI9aYXMl1fYOiqu-xVuOOMqagxrs/edit?usp=sharing + +// Constants +#define MIDEA_TICK 80U +#define MIDEA_BIT_MARK_TICKS 7U +#define MIDEA_BIT_MARK (MIDEA_BIT_MARK_TICKS * MIDEA_TICK) +#define MIDEA_ONE_SPACE_TICKS 21U +#define MIDEA_ONE_SPACE (MIDEA_ONE_SPACE_TICKS * MIDEA_TICK) +#define MIDEA_ZERO_SPACE_TICKS 7U +#define MIDEA_ZERO_SPACE (MIDEA_ZERO_SPACE_TICKS * MIDEA_TICK) +#define MIDEA_HDR_MARK_TICKS 56U +#define MIDEA_HDR_MARK (MIDEA_HDR_MARK_TICKS * MIDEA_TICK) +#define MIDEA_HDR_SPACE_TICKS 56U +#define MIDEA_HDR_SPACE (MIDEA_HDR_SPACE_TICKS * MIDEA_TICK) +#define MIDEA_MIN_GAP_TICKS (MIDEA_HDR_MARK_TICKS + MIDEA_ZERO_SPACE_TICKS \ + + MIDEA_BIT_MARK_TICKS) +#define MIDEA_MIN_GAP (MIDEA_MIN_GAP_TICKS * MIDEA_TICK) +#define MIDEA_TOLERANCE 30U // Percent + +#if SEND_MIDEA +// Send a Midea message +// +// Args: +// data: Contents of the message to be sent. +// nbits: Nr. of bits of data to be sent. Typically MIDEA_BITS. +// repeat: Nr. of additional times the message is to be sent. +// +// Status: Alpha / Needs testing against a real device. +// +void IRsend::sendMidea(uint64_t data, uint16_t nbits, uint16_t repeat) { + if (nbits % 8 != 0) + return; // nbits is required to be a multiple of 8. + + // Set IR carrier frequency + enableIROut(38); + + for (uint16_t r = 0; r <= repeat; r++) { + // The protcol sends the message, then follows up with an entirely + // inverted payload. + for (size_t inner_loop = 0; inner_loop < 2; inner_loop++) { + // Header + mark(MIDEA_HDR_MARK); + space(MIDEA_HDR_SPACE); + // Data + // Break data into byte segments, starting at the Most Significant + // Byte. Each byte then being sent normal, then followed inverted. + for (uint16_t i = 8; i <= nbits; i += 8) { + // Grab a bytes worth of data. + uint8_t segment = (data >> (nbits - i)) & 0xFF; + sendData(MIDEA_BIT_MARK, MIDEA_ONE_SPACE, + MIDEA_BIT_MARK, MIDEA_ZERO_SPACE, + segment, 8, true); + } + // Footer + mark(MIDEA_BIT_MARK); + space(MIDEA_MIN_GAP); // Pause before repeating + + // Invert the data for the 2nd phase of the message. + // As we get called twice in the inner loop, we will always revert + // to the original 'data' state. + data = ~data; + } + } +} +#endif + +// Code to emulate Midea A/C IR remote control unit. +// Warning: Consider this very alpha code. + +// Initialise the object. +IRMideaAC::IRMideaAC(uint16_t pin) : _irsend(pin) { + stateReset(); +} + +// Reset the state of the remote to a known good state/sequence. +void IRMideaAC::stateReset() { + // Power On, Mode Auto, Fan Auto, Temp = 25C/77F + remote_state = 0xA1826FFFFF62; +} + +// Configure the pin for output. +void IRMideaAC::begin() { + _irsend.begin(); +} + +#if SEND_MIDEA +// Send the current desired state to the IR LED. +void IRMideaAC::send() { + checksum(); // Ensure correct checksum before sending. + _irsend.sendMidea(remote_state); +} +#endif // SEND_MIDEA + +// Return a pointer to the internal state date of the remote. +uint64_t IRMideaAC::getRaw() { + checksum(); + return remote_state & MIDEA_AC_STATE_MASK; +} + +// Override the internal state with the new state. +void IRMideaAC::setRaw(uint64_t newState) { + remote_state = newState & MIDEA_AC_STATE_MASK; +} + +// Set the requested power state of the A/C to off. +void IRMideaAC::on() { + remote_state |= MIDEA_AC_POWER; +} + +// Set the requested power state of the A/C to off. +void IRMideaAC::off() { + remote_state &= (MIDEA_AC_STATE_MASK ^ MIDEA_AC_POWER); +} + +// Set the requested power state of the A/C. +void IRMideaAC::setPower(const bool state) { + if (state) + on(); + else + off(); +} + +// Return the requested power state of the A/C. +bool IRMideaAC::getPower() { + return (remote_state & MIDEA_AC_POWER); +} + +// Set the temperature. +// Args: +// temp: Temp. in degrees. +// useCelsius: Degree type to use. celsius (true) or fahrenheit (false) +void IRMideaAC::setTemp(const uint8_t temp, const bool useCelsius) { + uint8_t new_temp = temp; + if (useCelsius) { + new_temp = std::max((uint8_t) MIDEA_AC_MIN_TEMP_C, new_temp); + new_temp = std::min((uint8_t) MIDEA_AC_MAX_TEMP_C, new_temp); + new_temp = (uint8_t) ((new_temp * 1.8) + 32.5); // 0.5 so we rounding. + } + new_temp = std::max((uint8_t) MIDEA_AC_MIN_TEMP_F, new_temp); + new_temp = std::min((uint8_t) MIDEA_AC_MAX_TEMP_F, new_temp); + new_temp -= MIDEA_AC_MIN_TEMP_F; + remote_state &= MIDEA_AC_TEMP_MASK; + remote_state |= ((uint64_t) new_temp << 24); +} + +// Return the set temp. +// Args: +// useCelsius: Flag indicating if the results are in celsius or fahrenheit. +// Returns: +// A uint8_t containing the temperature. +uint8_t IRMideaAC::getTemp(const bool useCelsius) { + uint8_t temp = ((remote_state >> 24) & 0x1F) + MIDEA_AC_MIN_TEMP_F; + if (useCelsius) { + temp = (uint8_t) ((temp - 32) / 1.8); + } + return temp; +} + +// Set the speed of the fan, +// 1-3 set the speed, 0 or anything else set it to auto. +void IRMideaAC::setFan(const uint8_t fan) { + uint64_t new_fan; + switch (fan) { + case MIDEA_AC_FAN_LOW: + case MIDEA_AC_FAN_MED: + case MIDEA_AC_FAN_HI: + new_fan = fan; + break; + default: + new_fan = MIDEA_AC_FAN_AUTO; + } + remote_state &= MIDEA_AC_FAN_MASK; + remote_state |= (new_fan << 35); +} + +// Return the requested state of the unit's fan. +uint8_t IRMideaAC::getFan() { + return (remote_state >> 35) & 0b111; +} + +// Get the requested climate operation mode of the a/c unit. +// Returns: +// A uint8_t containing the A/C mode. +uint8_t IRMideaAC::getMode() { + return ((remote_state >> 32) & 0b111); +} + +// Set the requested climate operation mode of the a/c unit. +void IRMideaAC::setMode(const uint8_t mode) { + // If we get an unexpected mode, default to AUTO. + uint64_t new_mode; + switch (mode) { + case MIDEA_AC_AUTO: + case MIDEA_AC_COOL: + case MIDEA_AC_HEAT: + case MIDEA_AC_DRY: + case MIDEA_AC_FAN: + new_mode = mode; + break; + default: + new_mode = MIDEA_AC_AUTO; + } + remote_state &= MIDEA_AC_MODE_MASK; + remote_state |= (new_mode << 32); +} + +// Set the Sleep state of the A/C. +void IRMideaAC::setSleep(const bool state) { + if (state) + remote_state |= MIDEA_AC_SLEEP; + else + remote_state &= (MIDEA_AC_STATE_MASK ^ MIDEA_AC_SLEEP); +} + +// Return the Sleep state of the A/C. +bool IRMideaAC::getSleep() { + return (remote_state & MIDEA_AC_SLEEP); +} + +// Calculate the checksum for a given array. +// Args: +// state: The state to calculate the checksum over. +// Returns: +// The 8 bit checksum value. +uint8_t IRMideaAC::calcChecksum(const uint64_t state) { + uint8_t sum = 0; + uint64_t temp_state = state; + + for (uint8_t i = 0; i < 5; i++) { + temp_state >>= 8; + sum += reverseBits((temp_state & 0xFF), 8); + } + sum = 256 - sum; + return reverseBits(sum, 8); +} + +// Verify the checksum is valid for a given state. +// Args: +// state: The state to verify the checksum of. +// Returns: +// A boolean. +bool IRMideaAC::validChecksum(const uint64_t state) { + return ((state & 0xFF) == calcChecksum(state)); +} + +// Calculate & set the checksum for the current internal state of the remote. +void IRMideaAC::checksum() { + // Stored the checksum value in the last byte. + remote_state &= MIDEA_AC_CHECKSUM_MASK; + remote_state |= calcChecksum(remote_state); +} + +// Convert the internal state into a human readable string. +#ifdef ARDUINO +String IRMideaAC::toString() { + String result = ""; +#else +std::string IRMideaAC::toString() { + std::string result = ""; +#endif // ARDUINO + result += "Power: "; + if (getPower()) + result += "On"; + else + result += "Off"; + result += ", Mode: " + uint64ToString(getMode()); + switch (getMode()) { + case MIDEA_AC_AUTO: + result += " (AUTO)"; + break; + case MIDEA_AC_COOL: + result += " (COOL)"; + break; + case MIDEA_AC_HEAT: + result += " (HEAT)"; + break; + case MIDEA_AC_DRY: + result += " (DRY)"; + break; + case MIDEA_AC_FAN: + result += " (FAN)"; + break; + default: + result += " (UNKNOWN)"; + } + result += ", Temp: " + uint64ToString(getTemp(true)) + "C/" + + uint64ToString(getTemp(false)) + "F"; + result += ", Fan: " + uint64ToString(getFan()); + switch (getFan()) { + case MIDEA_AC_FAN_AUTO: + result += " (AUTO)"; + break; + case MIDEA_AC_FAN_LOW: + result += " (LOW)"; + break; + case MIDEA_AC_FAN_MED: + result += " (MED)"; + break; + case MIDEA_AC_FAN_HI: + result += " (HI)"; + break; + } + result += ", Sleep: "; + if (getSleep()) + result += "On"; + else + result += "Off"; + return result; +} + +#if DECODE_MIDEA +// Decode the supplied Midea message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. Typically MIDEA_BITS. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: Alpha / Needs testing against a real device. +// +bool IRrecv::decodeMidea(decode_results *results, uint16_t nbits, + bool strict) { + if (nbits % 8 != 0) // nbits has to be a multiple of nr. of bits in a byte. + return false; + + uint8_t min_nr_of_messages = 1; + if (strict) { + if (nbits != MIDEA_BITS) + return false; // Not strictly a MIDEA message. + min_nr_of_messages = 2; + } + + // The protocol sends the data normal + inverted, alternating on + // each byte. Hence twice the number of expected data bits. + if (results->rawlen < min_nr_of_messages * (2 * nbits + HEADER + FOOTER) - 1) + return false; // Can't possibly be a valid MIDEA message. + + uint64_t data = 0; + uint64_t inverted = 0; + uint16_t offset = OFFSET_START; + + if (nbits > sizeof(data) * 8) + return false; // We can't possibly capture a Midea packet that big. + + for (uint8_t i = 0; i < min_nr_of_messages; i++) { + // Header + if (!matchMark(results->rawbuf[offset], MIDEA_HDR_MARK)) return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t m_tick = results->rawbuf[offset++] * RAWTICK / + MIDEA_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset], MIDEA_HDR_SPACE)) return false; + // Calculate how long the common tick time is based on the header space. + uint32_t s_tick = results->rawbuf[offset++] * RAWTICK / + MIDEA_HDR_SPACE_TICKS; + + // Data (Normal) + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + MIDEA_BIT_MARK_TICKS * m_tick, + MIDEA_ONE_SPACE_TICKS * s_tick, + MIDEA_BIT_MARK_TICKS * m_tick, + MIDEA_ZERO_SPACE_TICKS * s_tick, + MIDEA_TOLERANCE); + if (data_result.success == false) return false; + offset += data_result.used; + if (i % 2 == 0) + data = data_result.data; + else + inverted = data_result.data; + + // Footer + if (!matchMark(results->rawbuf[offset++], MIDEA_BIT_MARK_TICKS * m_tick, + MIDEA_TOLERANCE)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset++], MIDEA_MIN_GAP_TICKS * s_tick, + MIDEA_TOLERANCE)) + return false; + } + + + // Compliance + if (strict) { + // Protocol requires a second message with all the data bits inverted. + // We should have checked we got a second message in the previous loop. + // Just need to check it's value is an inverted copy of the first message. + uint64_t mask = (1ULL << MIDEA_BITS) - 1; + if ((data & mask) != ((inverted ^ mask) & mask)) return false; + if (!IRMideaAC::validChecksum(data)) return false; + } + + // Success + results->decode_type = MIDEA; + results->bits = nbits; + results->value = data; + results->address = 0; + results->command = 0; + return true; +} +#endif // DECODE_MIDEA diff --git a/IRremoteESP8266/src/ir_Midea.h b/IRremoteESP8266/src/ir_Midea.h new file mode 100644 index 0000000..692cdf0 --- /dev/null +++ b/IRremoteESP8266/src/ir_Midea.h @@ -0,0 +1,87 @@ +// Copyright 2017 David Conran +#ifndef IR_MIDEA_H_ +#define IR_MIDEA_H_ + +#define __STDC_LIMIT_MACROS +#include +#ifdef ARDUINO +#include +#else +#include +#endif +#include "IRremoteESP8266.h" +#include "IRsend.h" + +// MM MM IIIII DDDDD EEEEEEE AAA +// MMM MMM III DD DD EE AAAAA +// MM MM MM III DD DD EEEEE AA AA +// MM MM III DD DD EE AAAAAAA +// MM MM IIIII DDDDDD EEEEEEE AA AA + +// Midea added by crankyoldgit & bwze +// Ref: +// https://docs.google.com/spreadsheets/d/1TZh4jWrx4h9zzpYUI9aYXMl1fYOiqu-xVuOOMqagxrs/edit?usp=sharing + +// Constants +#define MIDEA_AC_COOL 0U // 0b000 +#define MIDEA_AC_DRY 1U // 0b001 +#define MIDEA_AC_AUTO 2U // 0b010 +#define MIDEA_AC_HEAT 3U // 0b011 +#define MIDEA_AC_FAN 4U // 0b100 +#define MIDEA_AC_POWER 1ULL << 39 +#define MIDEA_AC_SLEEP 1ULL << 38 +#define MIDEA_AC_FAN_AUTO 0U // 0b000 +#define MIDEA_AC_FAN_LOW 1U // 0b001 +#define MIDEA_AC_FAN_MED 2U // 0b010 +#define MIDEA_AC_FAN_HI 3U // 0b011 +#define MIDEA_AC_MIN_TEMP_F 62U // 62F +#define MIDEA_AC_MAX_TEMP_F 86U // 86F +#define MIDEA_AC_MIN_TEMP_C 16U // 16C +#define MIDEA_AC_MAX_TEMP_C 30U // 30C +#define MIDEA_AC_STATE_MASK 0x0000FFFFFFFFFFFFULL +#define MIDEA_AC_TEMP_MASK 0x0000FFFFE0FFFFFFULL +#define MIDEA_AC_FAN_MASK 0x0000FFC7FFFFFFFFULL +#define MIDEA_AC_MODE_MASK 0x0000FFF8FFFFFFFFULL +#define MIDEA_AC_CHECKSUM_MASK 0x0000FFFFFFFFFF00ULL + +class IRMideaAC { + public: + explicit IRMideaAC(uint16_t pin); + + void stateReset(); +#if SEND_MIDEA + void send(); +#endif // SEND_MIDEA + void begin(); + void on(); + void off(); + void setPower(const bool state); + bool getPower(); + void setTemp(const uint8_t temp, const bool useCelsius = false); + uint8_t getTemp(const bool useCelsius = false); + void setFan(const uint8_t fan); + uint8_t getFan(); + void setMode(const uint8_t mode); + uint8_t getMode(); + void setRaw(uint64_t newState); + uint64_t getRaw(); + static bool validChecksum(const uint64_t state); + void setSleep(const bool state); + bool getSleep(); +#ifdef ARDUINO + String toString(); +#else + std::string toString(); +#endif +#ifndef UNIT_TEST + + private: +#endif + uint64_t remote_state; + void checksum(); + static uint8_t calcChecksum(const uint64_t state); + IRsend _irsend; +}; + + +#endif // IR_MIDEA_H_ diff --git a/IRremoteESP8266/src/ir_Mitsubishi.cpp b/IRremoteESP8266/src/ir_Mitsubishi.cpp new file mode 100644 index 0000000..273a2db --- /dev/null +++ b/IRremoteESP8266/src/ir_Mitsubishi.cpp @@ -0,0 +1,329 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2017 David Conran + +#include "ir_Mitsubishi.h" +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// MMMMM IIIII TTTTT SSSS U U BBBB IIIII SSSS H H IIIII +// M M M I T S U U B B I S H H I +// M M M I T SSS U U BBBB I SSS HHHHH I +// M M I T S U U B B I S H H I +// M M IIIII T SSSS UUU BBBBB IIIII SSSS H H IIIII + +// Mitsubishi (TV) decoding added from https://github.com/z3t0/Arduino-IRremote +// Mitsubishi (TV) sending & Mitsubishi A/C support added by David Conran + +// Constants +// Mitsubishi TV +// period time is 1/33000Hz = 30.303 uSeconds (T) +// Ref: +// GlobalCache's Control Tower's Mitsubishi TV data. +// https://github.com/marcosamarinho/IRremoteESP8266/blob/master/ir_Mitsubishi.cpp +#define MITSUBISHI_TICK 30U +#define MITSUBISHI_BIT_MARK_TICKS 10U +#define MITSUBISHI_BIT_MARK (MITSUBISHI_BIT_MARK_TICKS * \ + MITSUBISHI_TICK) +#define MITSUBISHI_ONE_SPACE_TICKS 70U +#define MITSUBISHI_ONE_SPACE (MITSUBISHI_ONE_SPACE_TICKS * \ + MITSUBISHI_TICK) +#define MITSUBISHI_ZERO_SPACE_TICKS 30U +#define MITSUBISHI_ZERO_SPACE (MITSUBISHI_ZERO_SPACE_TICKS * \ + MITSUBISHI_TICK) +#define MITSUBISHI_MIN_COMMAND_LENGTH_TICKS 1786U +#define MITSUBISHI_MIN_COMMAND_LENGTH (MITSUBISHI_MIN_COMMAND_LENGTH_TICKS * \ + MITSUBISHI_TICK) +#define MITSUBISHI_MIN_GAP_TICKS 936U +#define MITSUBISHI_MIN_GAP (MITSUBISHI_MIN_GAP_TICKS * \ + MITSUBISHI_TICK) + +// Mitsubishi A/C +// Ref: +// https://github.com/r45635/HVAC-IR-Control/blob/master/HVAC_ESP8266/HVAC_ESP8266.ino#L84 +#define MITSUBISHI_AC_HDR_MARK 3400U +#define MITSUBISHI_AC_HDR_SPACE 1750U +#define MITSUBISHI_AC_BIT_MARK 450U +#define MITSUBISHI_AC_ONE_SPACE 1300U +#define MITSUBISHI_AC_ZERO_SPACE 420U +#define MITSUBISHI_AC_RPT_MARK 440U +#define MITSUBISHI_AC_RPT_SPACE 17100UL + +#if SEND_MITSUBISHI +// Send a Mitsubishi message +// +// Args: +// data: Contents of the message to be sent. +// nbits: Nr. of bits of data to be sent. Typically MITSUBISHI_BITS. +// repeat: Nr. of additional times the message is to be sent. +// +// Status: ALPHA / untested. +// +// Notes: +// This protocol appears to have no header. +// Ref: +// https://github.com/marcosamarinho/IRremoteESP8266/blob/master/ir_Mitsubishi.cpp +// GlobalCache's Control Tower's Mitsubishi TV data. +void IRsend::sendMitsubishi(uint64_t data, uint16_t nbits, uint16_t repeat) { + sendGeneric(0, 0, // No Header + MITSUBISHI_BIT_MARK, MITSUBISHI_ONE_SPACE, + MITSUBISHI_BIT_MARK, MITSUBISHI_ZERO_SPACE, + MITSUBISHI_BIT_MARK, MITSUBISHI_MIN_GAP, + MITSUBISHI_MIN_COMMAND_LENGTH, + data, nbits, 33, true, repeat, 50); +} +#endif + +#if DECODE_MITSUBISHI +// Decode the supplied Mitsubishi message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of data bits to expect. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / previously working. +// +// Notes: +// This protocol appears to have no header. +// +// Ref: +// GlobalCache's Control Tower's Mitsubishi TV data. +bool IRrecv::decodeMitsubishi(decode_results *results, uint16_t nbits, + bool strict) { + if (results->rawlen < 2 * nbits + FOOTER - 1) + return false; // Shorter than shortest possibly expected. + if (strict && nbits != MITSUBISHI_BITS) + return false; // Request is out of spec. + + uint16_t offset = OFFSET_START; + uint64_t data = 0; + + // No Header + // But try to auto-calibrate off the initial mark signal. + if (!matchMark(results->rawbuf[offset], MITSUBISHI_BIT_MARK, 30)) + return false; + // Calculate how long the common tick time is based on the initial mark. + uint32_t tick = results->rawbuf[offset] * RAWTICK / MITSUBISHI_BIT_MARK_TICKS; + + // Data + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + MITSUBISHI_BIT_MARK_TICKS * tick, + MITSUBISHI_ONE_SPACE_TICKS * tick, + MITSUBISHI_BIT_MARK_TICKS * tick, + MITSUBISHI_ZERO_SPACE_TICKS * tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + uint16_t actualBits = data_result.used / 2; + + // Footer + if (!matchMark(results->rawbuf[offset++], MITSUBISHI_BIT_MARK_TICKS * tick, + 30)) return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], MITSUBISHI_MIN_GAP_TICKS * tick)) + return false; + + // Compliance + if (actualBits < nbits) + return false; + if (strict && actualBits != nbits) + return false; // Not as we expected. + + // Success + results->decode_type = MITSUBISHI; + results->bits = actualBits; + results->value = data; + results->address = 0; + results->command = 0; + return true; +} +#endif + +#if SEND_MITSUBISHI_AC +// Send a Mitsubishi A/C message. +// +// Args: +// data: An array of bytes containing the IR command. +// nbytes: Nr. of bytes of data in the array. (>=MITSUBISHI_AC_STATE_LENGTH) +// repeat: Nr. of times the message is to be repeated. +// (Default = MITSUBISHI_AC_MIN_REPEAT). +// +// Status: BETA / Appears to be working. +// +void IRsend::sendMitsubishiAC(unsigned char data[], uint16_t nbytes, + uint16_t repeat) { + if (nbytes < MITSUBISHI_AC_STATE_LENGTH) + return; // Not enough bytes to send a proper message. + + sendGeneric(MITSUBISHI_AC_HDR_MARK, MITSUBISHI_AC_HDR_SPACE, + MITSUBISHI_AC_BIT_MARK, MITSUBISHI_AC_ONE_SPACE, + MITSUBISHI_AC_BIT_MARK, MITSUBISHI_AC_ZERO_SPACE, + MITSUBISHI_AC_RPT_MARK, MITSUBISHI_AC_RPT_SPACE, + data, nbytes, 38, false, repeat, 50); +} +#endif // SEND_MITSUBISHI_AC + +// Code to emulate Mitsubishi A/C IR remote control unit. +// Inspired and derived from the work done at: +// https://github.com/r45635/HVAC-IR-Control +// +// Warning: Consider this very alpha code. Seems to work, but not validated. +// +// Equipment it seems compatible with: +// * +// Initialise the object. +IRMitsubishiAC::IRMitsubishiAC(uint16_t pin) : _irsend(pin) { + stateReset(); +} + +// Reset the state of the remote to a known good state/sequence. +void IRMitsubishiAC::stateReset() { + // The state of the IR remote in IR code form. + // Known good state obtained from: + // https://github.com/r45635/HVAC-IR-Control/blob/master/HVAC_ESP8266/HVAC_ESP8266.ino#L108 + // Note: Can't use the following because it requires -std=c++11 + // uint8_t known_good_state[MITSUBISHI_AC_STATE_LENGTH] = { + // 0x23, 0xCB, 0x26, 0x01, 0x00, 0x20, 0x08, 0x06, 0x30, 0x45, 0x67, 0x00, + // 0x00, 0x00, 0x00, 0x00, 0x00, 0x1F}; + remote_state[0] = 0x23; + remote_state[1] = 0xCB; + remote_state[2] = 0x26; + remote_state[3] = 0x01; + remote_state[4] = 0x00; + remote_state[5] = 0x20; + remote_state[6] = 0x08; + remote_state[7] = 0x06; + remote_state[8] = 0x30; + remote_state[9] = 0x45; + remote_state[10] = 0x67; + for (uint8_t i = 11; i < MITSUBISHI_AC_STATE_LENGTH - 1; i++) + remote_state[i] = 0; + remote_state[MITSUBISHI_AC_STATE_LENGTH - 1] = 0x1F; + checksum(); // Calculate the checksum +} + +// Configure the pin for output. +void IRMitsubishiAC::begin() { + _irsend.begin(); +} + +#if SEND_MITSUBISHI_AC +// Send the current desired state to the IR LED. +void IRMitsubishiAC::send() { + checksum(); // Ensure correct checksum before sending. + _irsend.sendMitsubishiAC(remote_state); +} +#endif // SEND_MITSUBISHI_AC + +// Return a pointer to the internal state date of the remote. +uint8_t* IRMitsubishiAC::getRaw() { + checksum(); + return remote_state; +} + +// Calculate the checksum for the current internal state of the remote. +void IRMitsubishiAC::checksum() { + uint8_t sum = 0; + // Checksum is simple addition of all previous bytes stored + // as a 8 bit value. + for (uint8_t i = 0; i < 17; i++) + sum += remote_state[i]; + remote_state[17] = sum & 0xFFU; +} + +// Set the requested power state of the A/C to off. +void IRMitsubishiAC::on() { + // state = ON; + remote_state[5] |= MITSUBISHI_AC_POWER; +} + +// Set the requested power state of the A/C to off. +void IRMitsubishiAC::off() { + // state = OFF; + remote_state[5] &= ~MITSUBISHI_AC_POWER; +} + +// Set the requested power state of the A/C. +void IRMitsubishiAC::setPower(bool state) { + if (state) + on(); + else + off(); +} + +// Return the requested power state of the A/C. +bool IRMitsubishiAC::getPower() { + return((remote_state[5] & MITSUBISHI_AC_POWER) != 0); +} + +// Set the temp. in deg C +void IRMitsubishiAC::setTemp(uint8_t temp) { + temp = std::max((uint8_t) MITSUBISHI_AC_MIN_TEMP, temp); + temp = std::min((uint8_t) MITSUBISHI_AC_MAX_TEMP, temp); + remote_state[7] = temp - MITSUBISHI_AC_MIN_TEMP; +} + +// Return the set temp. in deg C +uint8_t IRMitsubishiAC::getTemp() { + return(remote_state[7] + MITSUBISHI_AC_MIN_TEMP); +} + +// Set the speed of the fan, 0-6. +// 0 is auto, 1-5 is the speed, 6 is silent. +void IRMitsubishiAC::setFan(uint8_t fan) { + // Bounds check + if (fan > MITSUBISHI_AC_FAN_SILENT) + fan = MITSUBISHI_AC_FAN_MAX; // Set the fan to maximum if out of range. + if (fan == MITSUBISHI_AC_FAN_AUTO) { // Automatic is a special case. + remote_state[9] = 0b10000000 | (remote_state[9] & 0b01111000); + return; + } else if (fan >= MITSUBISHI_AC_FAN_MAX) { + fan--; // There is no spoon^H^H^Heed 5 (max), pretend it doesn't exist. + } + remote_state[9] &= 0b01111000; // Clear the previous state + remote_state[9] |= fan; +} + +// Return the requested state of the unit's fan. +uint8_t IRMitsubishiAC::getFan() { + uint8_t fan = remote_state[9] & 0b111; + if (fan == MITSUBISHI_AC_FAN_MAX) + return MITSUBISHI_AC_FAN_SILENT; + return fan; +} + +// Return the requested climate operation mode of the a/c unit. +uint8_t IRMitsubishiAC::getMode() { + return(remote_state[6]); +} + +// Set the requested climate operation mode of the a/c unit. +void IRMitsubishiAC::setMode(uint8_t mode) { + // If we get an unexpected mode, default to AUTO. + switch (mode) { + case MITSUBISHI_AC_AUTO: break; + case MITSUBISHI_AC_COOL: break; + case MITSUBISHI_AC_DRY: break; + case MITSUBISHI_AC_HEAT: break; + default: mode = MITSUBISHI_AC_AUTO; + } + remote_state[6] = mode; +} + +// Set the requested vane operation mode of the a/c unit. +void IRMitsubishiAC::setVane(uint8_t mode) { + mode = std::min(mode, (uint8_t) 0b111); // bounds check + mode |= 0b1000; + mode <<= 3; + remote_state[9] &= 0b11000111; // Clear the previous setting. + remote_state[9] |= mode; +} + +// Return the requested vane operation mode of the a/c unit. +uint8_t IRMitsubishiAC::getVane() { + return ((remote_state[9] & 0b00111000) >> 3); +} diff --git a/IRremoteESP8266/src/ir_Mitsubishi.h b/IRremoteESP8266/src/ir_Mitsubishi.h new file mode 100644 index 0000000..ec4c01b --- /dev/null +++ b/IRremoteESP8266/src/ir_Mitsubishi.h @@ -0,0 +1,65 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2017 David Conran +#ifndef IR_MITSUBISHI_H_ +#define IR_MITSUBISHI_H_ + +#define __STDC_LIMIT_MACROS +#include +#include "IRremoteESP8266.h" +#include "IRsend.h" + +// MMMMM IIIII TTTTT SSSS U U BBBB IIIII SSSS H H IIIII +// M M M I T S U U B B I S H H I +// M M M I T SSS U U BBBB I SSS HHHHH I +// M M I T S U U B B I S H H I +// M M IIIII T SSSS UUU BBBBB IIIII SSSS H H IIIII + +// Mitsubishi (TV) decoding added from https://github.com/z3t0/Arduino-IRremote +// Mitsubishi (TV) sending & Mitsubishi A/C support added by David Conran + +// Constants +#define MITSUBISHI_AC_AUTO 0x20U +#define MITSUBISHI_AC_COOL 0x18U +#define MITSUBISHI_AC_DRY 0x10U +#define MITSUBISHI_AC_HEAT 0x08U +#define MITSUBISHI_AC_POWER 0x20U +#define MITSUBISHI_AC_FAN_AUTO 0U +#define MITSUBISHI_AC_FAN_MAX 5U +#define MITSUBISHI_AC_FAN_REAL_MAX 4U +#define MITSUBISHI_AC_FAN_SILENT 6U +#define MITSUBISHI_AC_MIN_TEMP 16U // 16C +#define MITSUBISHI_AC_MAX_TEMP 31U // 31C +#define MITSUBISHI_AC_VANE_AUTO 0U +#define MITSUBISHI_AC_VANE_AUTO_MOVE 7U + +class IRMitsubishiAC { + public: + explicit IRMitsubishiAC(uint16_t pin); + + void stateReset(); +#if SEND_MITSUBISHI_AC + void send(); +#endif // SEND_MITSUBISHI_AC + void begin(); + void on(); + void off(); + void setPower(bool state); + bool getPower(); + void setTemp(uint8_t temp); + uint8_t getTemp(); + void setFan(uint8_t fan); + uint8_t getFan(); + void setMode(uint8_t mode); + uint8_t getMode(); + void setVane(uint8_t mode); + uint8_t getVane(); + uint8_t* getRaw(); + + private: + uint8_t remote_state[MITSUBISHI_AC_STATE_LENGTH]; + void checksum(); + IRsend _irsend; +}; + + +#endif // IR_MITSUBISHI_H_ diff --git a/IRremoteESP8266/src/ir_NEC.cpp b/IRremoteESP8266/src/ir_NEC.cpp new file mode 100644 index 0000000..8c603f2 --- /dev/null +++ b/IRremoteESP8266/src/ir_NEC.cpp @@ -0,0 +1,200 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2017 David Conran + +#define __STDC_LIMIT_MACROS +#include +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// N N EEEEE CCCC +// NN N E C +// N N N EEE C +// N NN E C +// N N EEEEE CCCC + +// NEC originally added from https://github.com/shirriff/Arduino-IRremote/ + +// Constants +// Ref: +// http://www.sbprojects.com/knowledge/ir/nec.php +#define NEC_TICK 560U +#define NEC_HDR_MARK_TICKS 16U +#define NEC_HDR_MARK (NEC_HDR_MARK_TICKS * NEC_TICK) +#define NEC_HDR_SPACE_TICKS 8U +#define NEC_HDR_SPACE (NEC_HDR_SPACE_TICKS * NEC_TICK) +#define NEC_BIT_MARK_TICKS 1U +#define NEC_BIT_MARK (NEC_BIT_MARK_TICKS * NEC_TICK) +#define NEC_ONE_SPACE_TICKS 3U +#define NEC_ONE_SPACE (NEC_TICK * NEC_ONE_SPACE_TICKS) +#define NEC_ZERO_SPACE_TICKS 1U +#define NEC_ZERO_SPACE (NEC_TICK * NEC_ZERO_SPACE_TICKS) +#define NEC_RPT_SPACE_TICKS 4U +#define NEC_RPT_SPACE (NEC_RPT_SPACE_TICKS * NEC_TICK) +#define NEC_RPT_LENGTH 4U +#define NEC_MIN_COMMAND_LENGTH_TICKS 193U +#define NEC_MIN_COMMAND_LENGTH (NEC_MIN_COMMAND_LENGTH_TICKS * NEC_TICK) +#define NEC_MIN_GAP (NEC_MIN_COMMAND_LENGTH - \ + (NEC_HDR_MARK + NEC_HDR_SPACE + NEC_BITS * (NEC_BIT_MARK + NEC_ONE_SPACE) \ + + NEC_BIT_MARK)) +#define NEC_MIN_GAP_TICKS (NEC_MIN_COMMAND_LENGTH_TICKS - \ + (NEC_HDR_MARK_TICKS + NEC_HDR_SPACE_TICKS + \ + NEC_BITS * (NEC_BIT_MARK_TICKS + NEC_ONE_SPACE_TICKS) + \ + NEC_BIT_MARK_TICKS)) + +#if (SEND_NEC || SEND_SHERWOOD || SEND_AIWA_RC_T501 || SEND_SANYO) +// Send a raw NEC(Renesas) formatted message. +// +// Args: +// data: The message to be sent. +// nbits: The number of bits of the message to be sent. Typically NEC_BITS. +// repeat: The number of times the command is to be repeated. +// +// Status: STABLE / Known working. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/nec.php +void IRsend::sendNEC(uint64_t data, uint16_t nbits, uint16_t repeat) { + sendGeneric(NEC_HDR_MARK, NEC_HDR_SPACE, + NEC_BIT_MARK, NEC_ONE_SPACE, + NEC_BIT_MARK, NEC_ZERO_SPACE, + NEC_BIT_MARK, NEC_MIN_GAP, NEC_MIN_COMMAND_LENGTH, + data, nbits, 38, true, 0, // Repeats are handled later. + 33); + // Optional command repeat sequence. + if (repeat) + sendGeneric(NEC_HDR_MARK, NEC_RPT_SPACE, + 0, 0, 0, 0, // No actual data sent. + NEC_BIT_MARK, NEC_MIN_GAP, NEC_MIN_COMMAND_LENGTH, + 0, 0, // No data to be sent. + 38, true, repeat - 1, // We've already sent a one message. + 33); +} + +// Calculate the raw NEC data based on address and command. +// Args: +// address: An address value. +// command: An 8-bit command value. +// Returns: +// A raw 32-bit NEC message. +// +// Status: BETA / Expected to work. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/nec.php +uint32_t IRsend::encodeNEC(uint16_t address, uint16_t command) { + command &= 0xFF; // We only want the least significant byte of command. + // sendNEC() sends MSB first, but protocol says this is LSB first. + command = reverseBits(command, 8); + command = (command << 8) + (command ^ 0xFF); // Calculate the new command. + if (address > 0xFF) { // Is it Extended NEC? + address = reverseBits(address, 16); + return ((address << 16) + command); // Extended. + } else { + address = reverseBits(address, 8); + return (address << 24) + ((address ^ 0xFF) << 16) + command; // Normal. + } +} +#endif + +#if (DECODE_NEC || DECODE_SHERWOOD || DECODE_AIWA_RC_T501 || DECODE_SANYO) +// Decode the supplied NEC message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. Typically NEC_BITS. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: STABLE / Known good. +// +// Notes: +// NEC protocol has three varients/forms. +// Normal: a 8 bit address & a 8 bit command in 32 bit data form. +// i.e. address + inverted(address) + command + inverted(command) +// Extended: a 16 bit address & a 8 bit command in 32 bit data form. +// i.e. address + command + inverted(command) +// Repeat: a 0-bit code. i.e. No data bits. Just the header + footer. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/nec.php +bool IRrecv::decodeNEC(decode_results *results, uint16_t nbits, bool strict) { + if (results->rawlen < 2 * nbits + HEADER + FOOTER - 1 && + results->rawlen != NEC_RPT_LENGTH) + return false; // Can't possibly be a valid NEC message. + if (strict && nbits != NEC_BITS) + return false; // Not strictly an NEC message. + + uint64_t data = 0; + uint16_t offset = OFFSET_START; + + // Header + if (!matchMark(results->rawbuf[offset], NEC_HDR_MARK)) return false; + // Calculate how long the lowest tick time is based on the header mark. + uint32_t mark_tick = results->rawbuf[offset++] * RAWTICK / + NEC_HDR_MARK_TICKS; + // Check if it is a repeat code. + if (results->rawlen == NEC_RPT_LENGTH && + matchSpace(results->rawbuf[offset], NEC_RPT_SPACE) && + matchMark(results->rawbuf[offset + 1], NEC_BIT_MARK_TICKS * mark_tick)) { + results->value = REPEAT; + results->decode_type = NEC; + results->bits = 0; + results->address = 0; + results->command = 0; + results->repeat = true; + return true; + } + + // Header (cont.) + if (!matchSpace(results->rawbuf[offset], NEC_HDR_SPACE)) return false; + // Calculate how long the common tick time is based on the header space. + uint32_t space_tick = results->rawbuf[offset++] * RAWTICK / + NEC_HDR_SPACE_TICKS; + // Data + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + NEC_BIT_MARK_TICKS * mark_tick, + NEC_ONE_SPACE_TICKS * space_tick, + NEC_BIT_MARK_TICKS * mark_tick, + NEC_ZERO_SPACE_TICKS * space_tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + + // Footer + if (!matchMark(results->rawbuf[offset++], NEC_BIT_MARK_TICKS * mark_tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], NEC_MIN_GAP_TICKS * space_tick)) + return false; + + // Compliance + // Calculate command and optionally enforce integrity checking. + uint8_t command = (data & 0xFF00) >> 8; + // Command is sent twice, once as plain and then inverted. + if ((command ^ 0xFF) != (data & 0xFF)) { + if (strict) + return false; // Command integrity failed. + command = 0; // The command value isn't valid, so default to zero. + } + + // Success + results->bits = nbits; + results->value = data; + results->decode_type = NEC; + // NEC command and address are technically in LSB first order so the + // final versions have to be reversed. + results->command = reverseBits(command, 8); + // Normal NEC protocol has an 8 bit address sent, followed by it inverted. + uint8_t address = (data & 0xFF000000) >> 24; + uint8_t address_inverted = (data & 0x00FF0000) >> 16; + if (address == (address_inverted ^ 0xFF)) + // Inverted, so it is normal NEC protocol. + results->address = reverseBits(address, 8); + else // Not inverted, so must be Extended NEC protocol, thus 16 bit address. + results->address = reverseBits((data >> 16) & UINT16_MAX, 16); + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Nikai.cpp b/IRremoteESP8266/src/ir_Nikai.cpp new file mode 100644 index 0000000..cbb6500 --- /dev/null +++ b/IRremoteESP8266/src/ir_Nikai.cpp @@ -0,0 +1,110 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// NN NN IIIII KK KK AAA IIIII +// NNN NN III KK KK AAAAA III +// NN N NN III KKKK AA AA III +// NN NNN III KK KK AAAAAAA III +// NN NN IIIII KK KK AA AA IIIII + +// Constants +// Ref: +// https://github.com/markszabo/IRremoteESP8266/issues/309 +#define NIKAI_TICK 500U +#define NIKAI_HDR_MARK_TICKS 8U +#define NIKAI_HDR_MARK (NIKAI_HDR_MARK_TICKS * NIKAI_TICK) +#define NIKAI_HDR_SPACE_TICKS 8U +#define NIKAI_HDR_SPACE (NIKAI_HDR_SPACE_TICKS * NIKAI_TICK) +#define NIKAI_BIT_MARK_TICKS 1U +#define NIKAI_BIT_MARK (NIKAI_BIT_MARK_TICKS * NIKAI_TICK) +#define NIKAI_ONE_SPACE_TICKS 2U +#define NIKAI_ONE_SPACE (NIKAI_ONE_SPACE_TICKS * NIKAI_TICK) +#define NIKAI_ZERO_SPACE_TICKS 4U +#define NIKAI_ZERO_SPACE (NIKAI_ZERO_SPACE_TICKS * NIKAI_TICK) +#define NIKAI_MIN_GAP_TICKS 17U +#define NIKAI_MIN_GAP (NIKAI_MIN_GAP_TICKS * NIKAI_TICK) + + +#if SEND_NIKAI +// Send a Nikai TV formatted message. +// +// Args: +// data: The message to be sent. +// nbits: The bit size of the message being sent. typically NIKAI_BITS. +// repeat: The number of times the message is to be repeated. +// +// Status: STABLE / Working. +// +// Ref: https://github.com/markszabo/IRremoteESP8266/issues/309 +void IRsend::sendNikai(uint64_t data, uint16_t nbits, uint16_t repeat) { + sendGeneric(NIKAI_HDR_MARK, NIKAI_HDR_SPACE, + NIKAI_BIT_MARK, NIKAI_ONE_SPACE, + NIKAI_BIT_MARK, NIKAI_ZERO_SPACE, + NIKAI_BIT_MARK, NIKAI_MIN_GAP, + data, nbits, 38, true, repeat, 33); +} +#endif + +#if DECODE_NIKAI +// Decode the supplied Nikai message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of bits to expect in the data portion. +// Typically NIKAI_BITS. +// strict: Flag to indicate if we strictly adhere to the specification. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: STABLE / Working. +// +bool IRrecv::decodeNikai(decode_results *results, uint16_t nbits, bool strict) { + if (results->rawlen < 2 * nbits + HEADER + FOOTER - 1) + return false; // Can't possibly be a valid Nikai message. + if (strict && nbits != NIKAI_BITS) + return false; // We expect Nikai to be a certain sized message. + + uint64_t data = 0; + uint16_t offset = OFFSET_START; + + // Header + if (!matchMark(results->rawbuf[offset], NIKAI_HDR_MARK)) return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t m_tick = results->rawbuf[offset++] * RAWTICK / + NIKAI_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset], NIKAI_HDR_SPACE)) return false; + // Calculate how long the common tick time is based on the header space. + uint32_t s_tick = results->rawbuf[offset++] * RAWTICK / + NIKAI_HDR_SPACE_TICKS; + // Data + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + NIKAI_BIT_MARK_TICKS * m_tick, + NIKAI_ONE_SPACE_TICKS * s_tick, + NIKAI_BIT_MARK_TICKS * m_tick, + NIKAI_ZERO_SPACE_TICKS * s_tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + // Footer + if (!matchMark(results->rawbuf[offset++], NIKAI_BIT_MARK_TICKS * m_tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], NIKAI_MIN_GAP_TICKS * s_tick)) + return false; + + // Compliance + + // Success + results->bits = nbits; + results->value = data; + results->decode_type = NIKAI; + results->command = 0; + results->address = 0; + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Panasonic.cpp b/IRremoteESP8266/src/ir_Panasonic.cpp new file mode 100644 index 0000000..687f73c --- /dev/null +++ b/IRremoteESP8266/src/ir_Panasonic.cpp @@ -0,0 +1,183 @@ +// Copyright 2015 Kristian Lauszus +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// PPPP AAA N N AAA SSSS OOO N N IIIII CCCC +// P P A A NN N A A S O O NN N I C +// PPPP AAAAA N N N AAAAA SSS O O N N N I C +// P A A N NN A A S O O N NN I C +// P A A N N A A SSSS OOO N N IIIII CCCC + +// Panasonic protocol originally added by Kristian Lauszus from: +// https://github.com/z3t0/Arduino-IRremote +// (Thanks to zenwheel and other people at the original blog post) + +// Constants +// Ref: +// http://www.remotecentral.com/cgi-bin/mboard/rc-pronto/thread.cgi?26152 +#define PANASONIC_TICK 432U +#define PANASONIC_HDR_MARK_TICKS 8U +#define PANASONIC_HDR_MARK (PANASONIC_HDR_MARK_TICKS * PANASONIC_TICK) +#define PANASONIC_HDR_SPACE_TICKS 4U +#define PANASONIC_HDR_SPACE (PANASONIC_HDR_SPACE_TICKS * PANASONIC_TICK) +#define PANASONIC_BIT_MARK_TICKS 1U +#define PANASONIC_BIT_MARK (PANASONIC_BIT_MARK_TICKS * PANASONIC_TICK) +#define PANASONIC_ONE_SPACE_TICKS 3U +#define PANASONIC_ONE_SPACE (PANASONIC_ONE_SPACE_TICKS * PANASONIC_TICK) +#define PANASONIC_ZERO_SPACE_TICKS 1U +#define PANASONIC_ZERO_SPACE (PANASONIC_ZERO_SPACE_TICKS * PANASONIC_TICK) +#define PANASONIC_MIN_COMMAND_LENGTH_TICKS 378UL +#define PANASONIC_MIN_COMMAND_LENGTH (PANASONIC_MIN_COMMAND_LENGTH_TICKS * \ + PANASONIC_TICK) +#define PANASONIC_END_GAP 5000U // See issue #245 +#define PANASONIC_MIN_GAP_TICKS (PANASONIC_MIN_COMMAND_LENGTH_TICKS - \ + (PANASONIC_HDR_MARK_TICKS + PANASONIC_HDR_SPACE_TICKS + \ + PANASONIC_BITS * (PANASONIC_BIT_MARK_TICKS + PANASONIC_ONE_SPACE_TICKS) + \ + PANASONIC_BIT_MARK_TICKS)) +#define PANASONIC_MIN_GAP ((uint32_t)(PANASONIC_MIN_GAP_TICKS * PANASONIC_TICK)) +#if (SEND_PANASONIC || SEND_DENON) +// Send a Panasonic formatted message. +// +// Args: +// data: The message to be sent. +// nbits: The number of bits of the message to be sent. (PANASONIC_BITS). +// repeat: The number of times the command is to be repeated. +// +// Status: BETA / Should be working. +// +// Note: +// This protocol is a modified version of Kaseikyo. +void IRsend::sendPanasonic64(uint64_t data, uint16_t nbits, uint16_t repeat) { + sendGeneric(PANASONIC_HDR_MARK, PANASONIC_HDR_SPACE, + PANASONIC_BIT_MARK, PANASONIC_ONE_SPACE, + PANASONIC_BIT_MARK, PANASONIC_ZERO_SPACE, + PANASONIC_BIT_MARK, + PANASONIC_MIN_GAP, PANASONIC_MIN_COMMAND_LENGTH, + data, nbits, 36700U, true, repeat, 50); +} + +// Send a Panasonic formatted message. +// +// Args: +// address: The manufacturer code. +// data: The data portion to be sent. +// nbits: The number of bits of the message to be sent. (PANASONIC_BITS). +// repeat: The number of times the command is to be repeated. +// +// Status: STABLE. +// +// Note: +// This protocol is a modified version of Kaseikyo. +void IRsend::sendPanasonic(uint16_t address, uint32_t data, uint16_t nbits, + uint16_t repeat) { + sendPanasonic64(((uint64_t) address << 32) | (uint64_t) data, nbits, repeat); +} + +// Calculate the raw Panasonic data based on device, subdevice, & function. +// +// Args: +// manufacturer: A 16-bit manufacturer code. e.g. 0x4004 is Panasonic. +// device: An 8-bit code. +// subdevice: An 8-bit code. +// function: An 8-bit code. +// Returns: +// A raw uint64_t Panasonic message. +// +// Status: BETA / Should be working.. +// +// Note: +// Panasonic 48-bit protocol is a modified version of Kaseikyo. +// Ref: +// http://www.remotecentral.com/cgi-bin/mboard/rc-pronto/thread.cgi?2615 +uint64_t IRsend::encodePanasonic(uint16_t manufacturer, + uint8_t device, + uint8_t subdevice, + uint8_t function) { + uint8_t checksum = device ^ subdevice ^ function; + return (((uint64_t) manufacturer << 32) | + ((uint64_t) device << 24) | + ((uint64_t) subdevice << 16) | + ((uint64_t) function << 8) | + checksum); +} +#endif // (SEND_PANASONIC || SEND_DENON) + +#if (DECODE_PANASONIC || DECODE_DENON) +// Decode the supplied Panasonic message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of data bits to expect. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / Should be working. +// Note: +// Panasonic 48-bit protocol is a modified version of Kaseikyo. +// Ref: +// http://www.remotecentral.com/cgi-bin/mboard/rc-pronto/thread.cgi?26152 +// http://www.hifi-remote.com/wiki/index.php?title=Panasonic +bool IRrecv::decodePanasonic(decode_results *results, uint16_t nbits, + bool strict, uint32_t manufacturer) { + if (results->rawlen < 2 * nbits + HEADER + FOOTER - 1) + return false; // Not enough entries to be a Panasonic message. + if (strict && nbits != PANASONIC_BITS) + return false; // Request is out of spec. + + uint64_t data = 0; + uint16_t offset = OFFSET_START; + + // Header + if (!matchMark(results->rawbuf[offset], PANASONIC_HDR_MARK)) return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t m_tick = results->rawbuf[offset++] * RAWTICK / + PANASONIC_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset], PANASONIC_HDR_SPACE)) return false; + // Calculate how long the common tick time is based on the header space. + uint32_t s_tick = results->rawbuf[offset++] * RAWTICK / + PANASONIC_HDR_SPACE_TICKS; + + // Data + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + PANASONIC_BIT_MARK_TICKS * m_tick, + PANASONIC_ONE_SPACE_TICKS * s_tick, + PANASONIC_BIT_MARK_TICKS * m_tick, + PANASONIC_ZERO_SPACE_TICKS * s_tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + + // Footer + if (!match(results->rawbuf[offset++], PANASONIC_BIT_MARK_TICKS * m_tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], PANASONIC_END_GAP)) + return false; + + // Compliance + uint32_t address = data >> 32; + uint32_t command = data & 0xFFFFFFFF; + if (strict) { + if (address != manufacturer) // Verify the Manufacturer code. + return false; + // Verify the checksum. + uint8_t checksumOrig = data & 0xFF; + uint8_t checksumCalc = ((data >> 24) ^ (data >> 16) ^ (data >> 8)) & 0xFF; + if (checksumOrig != checksumCalc) + return false; + } + + // Success + results->value = data; + results->address = address; + results->command = command; + results->decode_type = PANASONIC; + results->bits = nbits; + return true; +} +#endif // (DECODE_PANASONIC || DECODE_DENON) diff --git a/IRremoteESP8266/src/ir_Pronto.cpp b/IRremoteESP8266/src/ir_Pronto.cpp new file mode 100644 index 0000000..28e8083 --- /dev/null +++ b/IRremoteESP8266/src/ir_Pronto.cpp @@ -0,0 +1,108 @@ +// Copyright 2017 David Conran + +#include +#include "IRsend.h" + +// PPPPPP tt +// PP PP rr rr oooo nn nnn tt oooo +// PPPPPP rrr r oo oo nnn nn tttt oo oo +// PP rr oo oo nn nn tt oo oo +// PP rr oooo nn nn tttt oooo + +// Constants +#define PRONTO_FREQ_FACTOR 0.241246 +#define PRONTO_TYPE_OFFSET 0U +#define PRONTO_FREQ_OFFSET 1U +#define PRONTO_SEQ_1_LEN_OFFSET 2U +#define PRONTO_SEQ_2_LEN_OFFSET 3U +#define PRONTO_DATA_OFFSET 4U + +#if SEND_PRONTO +// Send a Pronto Code formatted message. +// +// Args: +// data: An array of uint16_t containing the pronto codes. +// len: Nr. of entries in the data[] array. +// repeat: Nr. of times to repeat the message. +// +// Status: ALPHA / Not tested in the real world. +// +// Note: +// Pronto codes are typically represented in hexadecimal. +// You will need to convert the code to an array of integers, and calculate +// it's length. +// e.g. +// A Sony 20 bit DVD remote command. +// "0000 0067 0000 0015 0060 0018 0018 0018 0030 0018 0030 0018 0030 0018 +// 0018 0018 0030 0018 0018 0018 0018 0018 0030 0018 0018 0018 0030 0018 +// 0030 0018 0030 0018 0018 0018 0018 0018 0030 0018 0018 0018 0018 0018 +// 0030 0018 0018 03f6" +// +// converts to: +// +// uint16_t prontoCode[46] = { +// 0x0000, 0x0067, 0x0000, 0x0015, +// 0x0060, 0x0018, 0x0018, 0x0018, 0x0030, 0x0018, 0x0030, 0x0018, +// 0x0030, 0x0018, 0x0018, 0x0018, 0x0030, 0x0018, 0x0018, 0x0018, +// 0x0018, 0x0018, 0x0030, 0x0018, 0x0018, 0x0018, 0x0030, 0x0018, +// 0x0030, 0x0018, 0x0030, 0x0018, 0x0018, 0x0018, 0x0018, 0x0018, +// 0x0030, 0x0018, 0x0018, 0x0018, 0x0018, 0x0018, 0x0030, 0x0018, +// 0x0018, 0x03f6}; +// // Send the Pronto(Sony) code. Repeat twice as Sony's require that. +// sendPronto(prontoCode, 46, SONY_MIN_REPEAT); +// +// Ref: +// http://www.etcwiki.org/wiki/Pronto_Infrared_Format +// http://www.remotecentral.com/features/irdisp2.htm +void IRsend::sendPronto(uint16_t data[], uint16_t len, uint16_t repeat) { + // Check we have enough data to work out what to send. + if (len < PRONTO_MIN_LENGTH) return; + + // We only know how to deal with 'raw' pronto codes types. Reject all others. + if (data[PRONTO_TYPE_OFFSET] != 0) return; + + // Pronto frequency is in Hz. + uint16_t hz = (uint16_t) (1000000U / (data[PRONTO_FREQ_OFFSET] * + PRONTO_FREQ_FACTOR)); + enableIROut(hz); + + // Grab the length of the two sequences. + uint16_t seq_1_len = data[PRONTO_SEQ_1_LEN_OFFSET] * 2; + uint16_t seq_2_len = data[PRONTO_SEQ_2_LEN_OFFSET] * 2; + // Calculate where each sequence starts in the buffer. + uint16_t seq_1_start = PRONTO_DATA_OFFSET; + uint16_t seq_2_start = PRONTO_DATA_OFFSET + seq_1_len; + + uint32_t periodic_time = calcUSecPeriod(hz, false); + + // Normal (1st sequence) case. + // Is there a first (normal) sequence to send? + if (seq_1_len > 0) { + // Check we have enough data to send the complete first sequence. + if (seq_1_len + seq_1_start > len) return; + // Send the contents of the 1st sequence. + for (uint16_t i = seq_1_start; i < seq_1_start + seq_1_len; i += 2) { + mark(data[i] * periodic_time); + space(data[i + 1] * periodic_time); + } + } else { + // There was no first sequence to send, it is implied that we have to send + // the 2nd/repeat sequence an additional time. i.e. At least once. + repeat++; + } + + // Repeat (2nd sequence) case. + // Is there a second (repeat) sequence to be sent? + if (seq_2_len > 0) { + // Check we have enough data to send the complete second sequence. + if (seq_2_len + seq_2_start > len) return; + + // Send the contents of the 2nd sequence. + for (uint16_t r = 0; r < repeat; r++) + for (uint16_t i = seq_2_start; i < seq_2_start + seq_2_len; i += 2) { + mark(data[i] * periodic_time); + space(data[i + 1] * periodic_time); + } + } +} +#endif diff --git a/IRremoteESP8266/src/ir_RC5_RC6.cpp b/IRremoteESP8266/src/ir_RC5_RC6.cpp new file mode 100644 index 0000000..8fcd097 --- /dev/null +++ b/IRremoteESP8266/src/ir_RC5_RC6.cpp @@ -0,0 +1,527 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRtimer.h" +#include "IRutils.h" + +// RRRRRR CCCCC 555555 XX XX RRRRRR CCCCC 666 +// RR RR CC C 55 XX XX RR RR CC C 66 +// RRRRRR CC _____ 555555 XXXX RRRRRR CC _____ 666666 +// RR RR CC C 5555 XX XX RR RR CC C 66 66 +// RR RR CCCCC 555555 XX XX RR RR CCCCC 66666 + +// RC-5 & RC-6 support added from https://github.com/z3t0/Arduino-IRremote +// RC-5X support added by David Conran + +// Constants +// RC-5/RC-5X +// Ref: +// https://en.wikipedia.org/wiki/RC-5 +// http://www.sbprojects.com/knowledge/ir/rc5.php +#define MIN_RC5_SAMPLES 11U +#define MIN_RC6_SAMPLES 1U +#define RC5_T1 889U +#define RC5_MIN_COMMAND_LENGTH 113778UL +#define RC5_MIN_GAP (RC5_MIN_COMMAND_LENGTH - RC5_RAW_BITS * (2 * RC5_T1)) +#define RC5_TOGGLE_MASK 0x800U // (The 12th bit) +// RC-6 +// Ref: +// https://en.wikipedia.org/wiki/RC-6 +// http://www.pcbheaven.com/userpages/The_Philips_RC6_Protocol/ +#define RC6_TICK 444U +#define RC6_HDR_MARK_TICKS 6U +#define RC6_HDR_MARK (RC6_HDR_MARK_TICKS * RC6_TICK) +#define RC6_HDR_SPACE_TICKS 2U +#define RC6_HDR_SPACE (RC6_HDR_SPACE_TICKS * RC6_TICK) +#define RC6_RPT_LENGTH_TICKS 187U +#define RC6_RPT_LENGTH (RC6_RPT_LENGTH_TICKS * RC6_TICK) +#define RC6_TOGGLE_MASK 0x10000UL // (The 17th bit) +#define RC6_36_TOGGLE_MASK 0x8000U // (The 16th bit) + +// Common (getRClevel()) +const int16_t kMARK = 0; +const int16_t kSPACE = 1; + +#if SEND_RC5 +// Send a Philips RC-5/RC-5X packet. +// +// Args: +// data: The message you wish to send. +// nbits: Bit size of the protocol you want to send. +// repeat: Nr. of extra times the data will be sent. +// +// Status: RC-5 (stable), RC-5X (alpha) +// +// Note: +// Caller needs to take care of flipping the toggle bit. +// That bit differentiates between key press & key release. +// For RC-5 it is the MSB of the data. +// For RC-5X it is the 2nd MSB of the data. +// Ref: +// http://www.sbprojects.com/knowledge/ir/rc5.php +// https://en.wikipedia.org/wiki/RC-5 +// https://en.wikipedia.org/wiki/Manchester_code +// TODO(anyone): +// Testing of the RC-5X components. +void IRsend::sendRC5(uint64_t data, uint16_t nbits, uint16_t repeat) { + if (nbits > sizeof(data) * 8) + return; // We can't send something that big. + bool skipSpace = true; + bool field_bit = true; + // Set 36kHz IR carrier frequency & a 1/4 (25%) duty cycle. + enableIROut(36, 25); + + if (nbits >= RC5X_BITS) { // Is this a RC-5X message? + // field bit is the inverted MSB of RC-5X data. + field_bit = ((data >> (nbits - 1)) ^ 1) & 1; + nbits--; + } + + IRtimer usecTimer = IRtimer(); + for (uint16_t i = 0; i <= repeat; i++) { + usecTimer.reset(); + + // Header + // First start bit (0x1). space, then mark. + if (skipSpace) + skipSpace = false; // First time through, we assume the leading space(). + else + space(RC5_T1); + mark(RC5_T1); + // Field/Second start bit. + if (field_bit) { // Send a 1. Normal for RC-5. + space(RC5_T1); + mark(RC5_T1); + } else { // Send a 0. Special case for RC-5X. Means 7th command bit is 1. + mark(RC5_T1); + space(RC5_T1); + } + + // Data + for (uint64_t mask = 1ULL << (nbits - 1); mask; mask >>= 1) + if (data & mask) { // 1 + space(RC5_T1); // 1 is space, then mark. + mark(RC5_T1); + } else { // 0 + mark(RC5_T1); // 0 is mark, then space. + space(RC5_T1); + } + // Footer + space(std::max(RC5_MIN_GAP, RC5_MIN_COMMAND_LENGTH - usecTimer.elapsed())); + } +} + +// Encode a Philips RC-5 data message. +// +// Args: +// address: The 5-bit address value for the message. +// command: The 6-bit command value for the message. +// key_released: Boolean flag indicating if the remote key has been released. +// +// Returns: +// A data message suitable for use in sendRC5(). +// +// Status: Beta / Should be working. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/rc5.php +// https://en.wikipedia.org/wiki/RC-5 +uint16_t IRsend::encodeRC5(uint8_t address, uint8_t command, + bool key_released) { + return (key_released << (RC5_BITS - 1)) | + ((address & 0x1f) << 6) | + (command & 0x3F); +} + +// Encode a Philips RC-5X data message. +// +// Args: +// address: The 5-bit address value for the message. +// command: The 7-bit command value for the message. +// key_released: Boolean flag indicating if the remote key has been released. +// +// Returns: +// A data message suitable for use in sendRC5(). +// +// Status: Beta / Should be working. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/rc5.php +// https://en.wikipedia.org/wiki/RC-5 +uint16_t IRsend::encodeRC5X(uint8_t address, uint8_t command, + bool key_released) { + // The 2nd start/field bit (MSB of the return value) is the value of the 7th + // command bit. + bool s2 = (command >> 6) & 1; + return ((uint16_t) s2 << (RC5X_BITS - 1)) | + encodeRC5(address, command, key_released); +} + +// Flip the toggle bit of a Philips RC-5/RC-5X data message. +// Used to indicate a change of remote button's state. +// +// Args: +// data: The existing RC-5/RC-5X message. +// +// Returns: +// A data message suitable for use in sendRC5() with the toggle bit flipped. +// +// Status: STABLE. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/rc5.php +// https://en.wikipedia.org/wiki/RC-5 +uint64_t IRsend::toggleRC5(uint64_t data) { + return data ^ RC5_TOGGLE_MASK; +} +#endif // SEND_RC5 + +#if SEND_RC6 +// Flip the toggle bit of a Philips RC-6 data message. +// Used to indicate a change of remote button's state. +// For RC-6 (20-bits), it is the 17th least significant bit. +// for RC-6 (36-bits/Xbox-360), it is the 16th least significant bit. +// +// Args: +// data: The existing RC-6 message. +// nbits: Nr. of bits in the RC-6 protocol. +// +// Returns: +// A data message suitable for use in sendRC6() with the toggle bit flipped. +// +// Status: BETA / Should work fine. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/rc6.php +// http://www.righto.com/2010/12/64-bit-rc6-codes-arduino-and-xbox.html +uint64_t IRsend::toggleRC6(uint64_t data, uint16_t nbits) { + if (nbits == RC6_36_BITS) + return data ^ RC6_36_TOGGLE_MASK; + return data ^ RC6_TOGGLE_MASK; +} + +// Encode a Philips RC-6 data message. +// +// Args: +// address: The address (aka. control) value for the message. +// Includes the field/mode/toggle bits. +// command: The 8-bit command value for the message. (aka. information) +// mode: Which protocol to use. Defined by nr. of bits in the protocol. +// +// Returns: +// A data message suitable for use in sendRC6(). +// +// Status: Beta / Should be working. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/rc6.php +// http://www.righto.com/2010/12/64-bit-rc6-codes-arduino-and-xbox.html +// http://www.pcbheaven.com/userpages/The_Philips_RC6_Protocol/ +uint64_t IRsend::encodeRC6(uint32_t address, uint8_t command, + uint16_t mode) { + switch (mode) { + case RC6_MODE0_BITS: + return ((address & 0xFFF) << 8) | (command & 0xFF); + case RC6_36_BITS: + return ((uint64_t) (address & 0xFFFFFFF) << 8) | (command & 0xFF); + default: + return 0; + } +} + +// Send a Philips RC-6 packet. +// Note: Caller needs to take care of flipping the toggle bit (The 4th Most +// Significant Bit). That bit differentiates between key press & key release. +// +// Args: +// data: The message you wish to send. +// nbits: Bit size of the protocol you want to send. +// repeat: Nr. of extra times the data will be sent. +// +// Status: Stable. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/rc6.php +// http://www.righto.com/2010/12/64-bit-rc6-codes-arduino-and-xbox.html +// https://en.wikipedia.org/wiki/Manchester_code +void IRsend::sendRC6(uint64_t data, uint16_t nbits, uint16_t repeat) { + // Check we can send the number of bits requested. + if (nbits > sizeof(data) * 8) + return; + // Set 36kHz IR carrier frequency & a 1/3 (33%) duty cycle. + enableIROut(36, 33); + for (uint16_t r = 0; r <= repeat; r++) { + // Header + mark(RC6_HDR_MARK); + space(RC6_HDR_SPACE); + // Start bit. + mark(RC6_TICK); // mark, then space == 0x1. + space(RC6_TICK); + // Data + uint16_t bitTime; + for (uint64_t i = 1, mask = 1ULL << (nbits - 1); mask; i++, mask >>= 1) { + if (i == 4) // The fourth bit we send is a "double width trailer bit". + bitTime = 2 * RC6_TICK; // double-wide trailer bit + else + bitTime = RC6_TICK; // Normal bit + if (data & mask) { // 1 + mark(bitTime); + space(bitTime); + } else { // 0 + space(bitTime); + mark(bitTime); + } + } + // Footer + space(RC6_RPT_LENGTH); + } +} +#endif // SEND_RC6 + +#if (DECODE_RC5 || DECODE_RC6 || DECODE_LASERTAG) +// Gets one undecoded level at a time from the raw buffer. +// The RC5/6 decoding is easier if the data is broken into time intervals. +// E.g. if the buffer has MARK for 2 time intervals and SPACE for 1, +// successive calls to getRClevel will return MARK, MARK, SPACE. +// offset and used are updated to keep track of the current position. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// offset: Ptr to the currect offset to the rawbuf. +// used: Ptr to the current used counter. +// bitTime: Time interval of single bit in microseconds. +// Returns: +// int: MARK, SPACE, or -1 for error (The measured time interval is not a +// multiple of t1.) +// Ref: +// https://en.wikipedia.org/wiki/Manchester_code +int16_t IRrecv::getRClevel(decode_results *results, uint16_t *offset, + uint16_t *used, uint16_t bitTime, + uint8_t tolerance, int16_t excess, uint16_t delta) { + DPRINT("DEBUG: getRClevel: offset = "); + DPRINTLN(uint64ToString(*offset)); + if (*offset >= results->rawlen) { + DPRINTLN("DEBUG: getRClevel: SPACE, past end of rawbuf"); + return kSPACE; // After end of recorded buffer, assume SPACE. + } + uint16_t width = results->rawbuf[*offset]; + // If the value of offset is odd, it's a MARK. Even, it's a SPACE. + uint16_t val = ((*offset) % 2) ? kMARK : kSPACE; + // Check to see if we have hit an inter-message gap (> 20ms). + if (val == kSPACE && width > 20000 - delta) { + DPRINTLN("DEBUG: getRClevel: SPACE, hit end of mesg gap."); + return kSPACE; + } + int16_t correction = (val == kMARK) ? excess : -excess; + + // Calculate the look-ahead for our current position in the buffer. + uint16_t avail; + // Note: We want to match in greedy order as the other way leads to + // mismatches due to overlaps induced by the correction and tolerance + // values. + if (match(width, 3 * bitTime + correction, tolerance, delta)) { + avail = 3; + } else if (match(width, 2 * bitTime + correction, tolerance, delta)) { + avail = 2; + } else if (match(width, bitTime + correction, tolerance, delta)) { + avail = 1; + } else { + DPRINTLN("DEBUG: getRClevel: Unexpected width. Exiting."); + return -1; // The width is not what we expected. + } + + (*used)++; // Count another one of the avail slots as used. + if (*used >= avail) { // Are we out of look-ahead/avail slots? + // Yes, so reset the used counter, and move the offset ahead. + *used = 0; + (*offset)++; + } + if (val == kMARK) { + DPRINTLN("DEBUG: getRClevel: MARK"); + } else { + DPRINTLN("DEBUG: getRClevel: SPACE"); + } + + return val; +} +#endif // (DECODE_RC5 || DECODE_RC6 || DECODE_LASERTAG) + +#if DECODE_RC5 +// Decode the supplied RC-5/RC5X message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: RC-5 (stable), RC-5X (alpha) +// +// Note: +// The 'toggle' bit is included as the 6th (MSB) address bit, the MSB of data, +// & in the count of bits decoded. +// Ref: +// http://www.sbprojects.com/knowledge/ir/rc5.php +// https://en.wikipedia.org/wiki/RC-5 +// https://en.wikipedia.org/wiki/Manchester_code +// TODO(anyone): +// Serious testing of the RC-5X and strict aspects needs to be done. +bool IRrecv::decodeRC5(decode_results *results, uint16_t nbits, bool strict) { + if (results->rawlen < MIN_RC5_SAMPLES + HEADER - 1) return false; + + // Compliance + if (strict && nbits != RC5_BITS && nbits != RC5X_BITS) + return false; // It's neither RC-5 or RC-5X. + + uint16_t offset = OFFSET_START; + uint16_t used = 0; + bool is_rc5x = false; + uint64_t data = 0; + + // Header + // Get start bit #1. + if (getRClevel(results, &offset, &used, RC5_T1) != kMARK) return false; + // Get field/start bit #2 (inverted bit-7 of the command if RC-5X protocol) + uint16_t actual_bits = 1; + int16_t levelA = getRClevel(results, &offset, &used, RC5_T1); + int16_t levelB = getRClevel(results, &offset, &used, RC5_T1); + if (levelA == kSPACE && levelB == kMARK) { // Matched a 1. + is_rc5x = false; + } else if (levelA == kMARK && levelB == kSPACE) { // Matched a 0. + if (nbits <= RC5_BITS) return false; // Field bit must be '1' for RC5. + is_rc5x = true; + data = 1; + } else { + return false; // Not what we expected. + } + + // Data + for (; offset < results->rawlen; actual_bits++) { + int16_t levelA = getRClevel(results, &offset, &used, RC5_T1); + int16_t levelB = getRClevel(results, &offset, &used, RC5_T1); + if (levelA == kSPACE && levelB == kMARK) + data = (data << 1) | 1; // 1 + else if (levelA == kMARK && levelB == kSPACE) + data <<= 1; // 0 + else + break; + } + // Footer (None) + + // Compliance + if (actual_bits < nbits) return false; // Less data than we expected. + if (strict && actual_bits != RC5_BITS && + actual_bits != RC5X_BITS) return false; + + // Success + results->value = data; + results->address = (data >> 6) & 0x1F; + results->command = data & 0x3F; + results->repeat = false; + if (is_rc5x) { + results->decode_type = RC5X; + results->command |= ((uint32_t) is_rc5x) << 6; + } else { + results->decode_type = RC5; + actual_bits--; // RC5 doesn't count the field bit as data. + } + results->bits = actual_bits; + return true; +} +#endif // DECODE_RC5 + +#if DECODE_RC6 +// Decode the supplied RC6 message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: Stable. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/rc6.php +// https://en.wikipedia.org/wiki/Manchester_code +// TODO(anyone): +// Testing of the strict compliance aspects. +bool IRrecv::decodeRC6(decode_results *results, uint16_t nbits, bool strict) { + if (results->rawlen < HEADER + 2 + 4) // Up to the double-wide T bit. + return false; // Smaller than absolute smallest possible RC6 message. + + if (strict) { // Compliance + // Unlike typical protocols, the ability to have mark+space, and space+mark + // as data bits means it is possible to only have nbits of entries for the + // data portion, rather than the typically required 2 * nbits. + // Also due to potential melding with the start bit, we can only count + // the start bit as 1, instead of a more typical 2 value. The header still + // remains as normal. + if (results->rawlen < nbits + HEADER + 1) + return false; // Don't have enough entries/samples to be valid. + switch (nbits) { + case RC6_MODE0_BITS: + case RC6_36_BITS: + break; + default: + return false; // Asking for the wrong number of bits. + } + } + + uint16_t offset = OFFSET_START; + + // Header + if (!matchMark(results->rawbuf[offset], RC6_HDR_MARK)) return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t tick = results->rawbuf[offset++] * RAWTICK / RC6_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset++], RC6_HDR_SPACE_TICKS * tick)) + return false; + + uint16_t used = 0; + + // Get the start bit. e.g. 1. + if (getRClevel(results, &offset, &used, tick) != kMARK) return false; + if (getRClevel(results, &offset, &used, tick) != kSPACE) return false; + + uint16_t actual_bits; + uint64_t data = 0; + + // Data (Warning: Here be dragons^Wpointers!!) + for (actual_bits = 0; offset < results->rawlen; actual_bits++) { + int16_t levelA, levelB; // Next two levels + levelA = getRClevel(results, &offset, &used, tick); + // T bit is double wide; make sure second half matches + if (actual_bits == 3 && + levelA != getRClevel(results, &offset, &used, tick)) + return false; + levelB = getRClevel(results, &offset, &used, tick); + // T bit is double wide; make sure second half matches + if (actual_bits == 3 && + levelB != getRClevel(results, &offset, &used, tick)) + return false; + if (levelA == kMARK && levelB == kSPACE) // reversed compared to RC5 + data = (data << 1) | 1; // 1 + else if (levelA == kSPACE && levelB == kMARK) + data <<= 1; // 0 + else + break; + } + + // More compliance + if (strict && actual_bits != nbits) + return false; // Actual nr. of bits didn't match expected. + + // Success + results->decode_type = RC6; + results->bits = actual_bits; + results->value = data; + results->address = data >> 8; + results->command = data & 0xFF; + return true; +} +#endif // DECODE_RC6 diff --git a/IRremoteESP8266/src/ir_RCMM.cpp b/IRremoteESP8266/src/ir_RCMM.cpp new file mode 100644 index 0000000..3d8d244 --- /dev/null +++ b/IRremoteESP8266/src/ir_RCMM.cpp @@ -0,0 +1,174 @@ +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRtimer.h" +#include "IRutils.h" + +// RRRRRR CCCCC MM MM MM MM +// RR RR CC C MMM MMM MMM MMM +// RRRRRR CC _____ MM MM MM MM MM MM +// RR RR CC C MM MM MM MM +// RR RR CCCCC MM MM MM MM + +// Send & decode support for RC-MM added by David Conran + +// Constants +// Ref: +// http://www.sbprojects.com/knowledge/ir/rcmm.php +#define RCMM_TICK 28U // Technically it would be 27.777* +#define RCMM_HDR_MARK_TICKS 15U +#define RCMM_HDR_MARK 416U +#define RCMM_HDR_SPACE_TICKS 10U +#define RCMM_HDR_SPACE 277U +#define RCMM_BIT_MARK_TICKS 6U +#define RCMM_BIT_MARK 166U +#define RCMM_BIT_SPACE_0_TICKS 10U +#define RCMM_BIT_SPACE_0 277U +#define RCMM_BIT_SPACE_1_TICKS 16U +#define RCMM_BIT_SPACE_1 444U +#define RCMM_BIT_SPACE_2_TICKS 22U +#define RCMM_BIT_SPACE_2 611U +#define RCMM_BIT_SPACE_3_TICKS 28U +#define RCMM_BIT_SPACE_3 777U +#define RCMM_RPT_LENGTH_TICKS 992U +#define RCMM_RPT_LENGTH 27778U +#define RCMM_MIN_GAP_TICKS 120U +#define RCMM_MIN_GAP 3360U +// Use a tolerance of +/-10% when matching some data spaces. +#define RCMM_TOLERANCE 10U +#define RCMM_EXCESS 50U + +#if SEND_RCMM +// Send a Philips RC-MM packet. +// +// Args: +// data: The data we want to send. MSB first. +// nbits: The number of bits of data to send. (Typically 12, 24, or 32[Nokia]) +// repeat: The nr. of times the message should be sent. +// +// Status: BETA / Should be working. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/rcmm.php +void IRsend::sendRCMM(uint64_t data, uint16_t nbits, uint16_t repeat) { + // Set 36kHz IR carrier frequency & a 1/3 (33%) duty cycle. + enableIROut(36, 33); + IRtimer usecs = IRtimer(); + + for (uint16_t r = 0; r <= repeat; r++) { + usecs.reset(); + // Header + mark(RCMM_HDR_MARK); + space(RCMM_HDR_SPACE); + // Data + uint64_t mask = 0b11ULL << (nbits - 2); + // RC-MM sends data 2 bits at a time. + for (int32_t i = nbits; i > 0; i -= 2) { + mark(RCMM_BIT_MARK); + // Grab the next Most Significant Bits to send. + switch ((data & mask) >> (i - 2)) { + case 0b00: space(RCMM_BIT_SPACE_0); break; + case 0b01: space(RCMM_BIT_SPACE_1); break; + case 0b10: space(RCMM_BIT_SPACE_2); break; + case 0b11: space(RCMM_BIT_SPACE_3); break; + } + mask >>= 2; + } + // Footer + mark(RCMM_BIT_MARK); + // Protocol requires us to wait at least RCMM_RPT_LENGTH usecs from the + // start or RCMM_MIN_GAP usecs. + space(std::max(RCMM_RPT_LENGTH - usecs.elapsed(), RCMM_MIN_GAP)); + } +} +#endif + +#if DECODE_RCMM +// Decode a Philips RC-MM packet (between 12 & 32 bits) if possible. +// Places successful decode information in the results pointer. +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of bits to expect in the data portion. Typically RCMM_BITS. +// strict: Flag to indicate if we strictly adhere to the specification. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / Should be working. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/rcmm.php +bool IRrecv::decodeRCMM(decode_results *results, uint16_t nbits, bool strict) { + uint64_t data = 0; + uint16_t offset = OFFSET_START; + + if (results->rawlen <= 4) + return false; // Not enough entries to ever be RCMM. + + // Calc the maximum size in bits, the message can be, or that we can accept. + int16_t maxBitSize = std::min((uint16_t) results->rawlen - 5, + (uint16_t) sizeof(data) * 8); + // Compliance + if (strict) { + // Technically the spec says bit sizes should be 12 xor 24. however + // 32 bits has been seen from a device. We are going to assume + // 12 <= bits <= 32 is the 'required' bit length for the spec. + if (maxBitSize < 12 || maxBitSize > 32) + return false; + if (maxBitSize < nbits) + return false; // Short cut, we can never reach the expected nr. of bits. + } + // Header decode + if (!matchMark(results->rawbuf[offset], RCMM_HDR_MARK)) return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t m_tick = results->rawbuf[offset++] * RAWTICK / RCMM_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset], RCMM_HDR_SPACE)) return false; + // Calculate how long the common tick time is based on the header space. + uint32_t s_tick = results->rawbuf[offset++] * RAWTICK / RCMM_HDR_SPACE_TICKS; + + // Data decode + // RC-MM has two bits of data per mark/space pair. + uint16_t actualBits; + for (actualBits = 0; actualBits < maxBitSize; actualBits += 2, offset++) { + if (!match(results->rawbuf[offset++], RCMM_BIT_MARK_TICKS * m_tick)) + return false; + + data <<= 2; + // Use non-default tolerance & excess for matching some of the spaces as the + // defaults are too generous and causes mis-matches in some cases. + if (match(results->rawbuf[offset], RCMM_BIT_SPACE_0_TICKS * s_tick, + TOLERANCE)) + data += 0; + else if (match(results->rawbuf[offset], RCMM_BIT_SPACE_1_TICKS * s_tick, + TOLERANCE)) + data += 1; + else if (match(results->rawbuf[offset], RCMM_BIT_SPACE_2_TICKS * s_tick, + RCMM_TOLERANCE)) + data += 2; + else if (match(results->rawbuf[offset], RCMM_BIT_SPACE_3_TICKS * s_tick, + RCMM_TOLERANCE)) + data += 3; + else + return false; + } + // Footer decode + if (!match(results->rawbuf[offset++], RCMM_BIT_MARK_TICKS * m_tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], RCMM_MIN_GAP_TICKS * s_tick)) + return false; + + // Compliance + if (strict && actualBits != nbits) + return false; + + // Success + results->value = data; + results->decode_type = RCMM; + results->bits = actualBits; + results->address = 0; + results->command = 0; + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Samsung.cpp b/IRremoteESP8266/src/ir_Samsung.cpp new file mode 100644 index 0000000..a7acead --- /dev/null +++ b/IRremoteESP8266/src/ir_Samsung.cpp @@ -0,0 +1,162 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// SSSS AAA MMM SSSS U U N N GGGG +// S A A M M M S U U NN N G +// SSS AAAAA M M M SSS U U N N N G GG +// S A A M M S U U N NN G G +// SSSS A A M M SSSS UUU N N GGG + +// Samsung originally added from https://github.com/shirriff/Arduino-IRremote/ + +// Constants +// Ref: +// http://elektrolab.wz.cz/katalog/samsung_protocol.pdf +#define SAMSUNG_TICK 560U +#define SAMSUNG_HDR_MARK_TICKS 8U +#define SAMSUNG_HDR_MARK (SAMSUNG_HDR_MARK_TICKS * SAMSUNG_TICK) +#define SAMSUNG_HDR_SPACE_TICKS 8U +#define SAMSUNG_HDR_SPACE (SAMSUNG_HDR_SPACE_TICKS * SAMSUNG_TICK) +#define SAMSUNG_BIT_MARK_TICKS 1U +#define SAMSUNG_BIT_MARK (SAMSUNG_BIT_MARK_TICKS * SAMSUNG_TICK) +#define SAMSUNG_ONE_SPACE_TICKS 3U +#define SAMSUNG_ONE_SPACE (SAMSUNG_ONE_SPACE_TICKS * SAMSUNG_TICK) +#define SAMSUNG_ZERO_SPACE_TICKS 1U +#define SAMSUNG_ZERO_SPACE (SAMSUNG_ZERO_SPACE_TICKS * SAMSUNG_TICK) +#define SAMSUNG_RPT_SPACE_TICKS 4U +#define SAMSUNG_RPT_SPACE (SAMSUNG_RPT_SPACE_TICKS * SAMSUNG_TICK) +#define SAMSUNG_MIN_MESSAGE_LENGTH_TICKS 193U +#define SAMSUNG_MIN_MESSAGE_LENGTH (SAMSUNG_MIN_MESSAGE_LENGTH_TICKS * \ + SAMSUNG_TICK) +#define SAMSUNG_MIN_GAP_TICKS (SAMSUNG_MIN_MESSAGE_LENGTH_TICKS - \ + (SAMSUNG_HDR_MARK_TICKS + SAMSUNG_HDR_SPACE_TICKS + \ + SAMSUNG_BITS * (SAMSUNG_BIT_MARK_TICKS + SAMSUNG_ONE_SPACE_TICKS) + \ + SAMSUNG_BIT_MARK_TICKS)) +#define SAMSUNG_MIN_GAP (SAMSUNG_MIN_GAP_TICKS * SAMSUNG_TICK) + + + +#if SEND_SAMSUNG +// Send a Samsung formatted message. +// Samsung has a separate message to indicate a repeat, like NEC does. +// TODO(crankyoldgit): Confirm that is actually how Samsung sends a repeat. +// The refdoc doesn't indicate it is true. +// +// Args: +// data: The message to be sent. +// nbits: The bit size of the message being sent. typically SAMSUNG_BITS. +// repeat: The number of times the message is to be repeated. +// +// Status: BETA / Should be working. +// +// Ref: http://elektrolab.wz.cz/katalog/samsung_protocol.pdf +void IRsend::sendSAMSUNG(uint64_t data, uint16_t nbits, uint16_t repeat) { + sendGeneric(SAMSUNG_HDR_MARK, SAMSUNG_HDR_SPACE, + SAMSUNG_BIT_MARK, SAMSUNG_ONE_SPACE, + SAMSUNG_BIT_MARK, SAMSUNG_ZERO_SPACE, + SAMSUNG_BIT_MARK, + SAMSUNG_MIN_GAP, SAMSUNG_MIN_MESSAGE_LENGTH, + data, nbits, 38, true, repeat, 33); +} + +// Construct a raw Samsung message from the supplied customer(address) & +// command. +// +// Args: +// customer: The customer code. (aka. Address) +// command: The command code. +// Returns: +// A raw 32-bit Samsung message suitable for sendSAMSUNG(). +// +// Status: BETA / Should be working. +uint32_t IRsend::encodeSAMSUNG(uint8_t customer, uint8_t command) { + customer = reverseBits(customer, sizeof(customer) * 8); + command = reverseBits(command, sizeof(command) * 8); + return((command ^ 0xFF) | (command << 8) | + (customer << 16) | (customer << 24)); +} +#endif + +#if DECODE_SAMSUNG +// Decode the supplied Samsung message. +// Samsung messages whilst 32 bits in size, only contain 16 bits of distinct +// data. e.g. In transmition order: +// customer_byte + customer_byte(same) + address_byte + invert(address_byte) +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of bits to expect in the data portion. Typically SAMSUNG_BITS. +// strict: Flag to indicate if we strictly adhere to the specification. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: STABLE +// +// Note: +// LG 32bit protocol appears near identical to the Samsung protocol. +// They differ on their compliance criteria and how they repeat. +// Ref: +// http://elektrolab.wz.cz/katalog/samsung_protocol.pdf +bool IRrecv::decodeSAMSUNG(decode_results *results, uint16_t nbits, + bool strict) { + if (results->rawlen < 2 * nbits + HEADER + FOOTER - 1) + return false; // Can't possibly be a valid Samsung message. + if (strict && nbits != SAMSUNG_BITS) + return false; // We expect Samsung to be 32 bits of message. + + uint64_t data = 0; + uint16_t offset = OFFSET_START; + + // Header + if (!matchMark(results->rawbuf[offset], SAMSUNG_HDR_MARK)) return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t m_tick = results->rawbuf[offset++] * RAWTICK / + SAMSUNG_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset], SAMSUNG_HDR_SPACE)) return false; + // Calculate how long the common tick time is based on the header space. + uint32_t s_tick = results->rawbuf[offset++] * RAWTICK / + SAMSUNG_HDR_SPACE_TICKS; + // Data + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + SAMSUNG_BIT_MARK_TICKS * m_tick, + SAMSUNG_ONE_SPACE_TICKS * s_tick, + SAMSUNG_BIT_MARK_TICKS * m_tick, + SAMSUNG_ZERO_SPACE_TICKS * s_tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + // Footer + if (!matchMark(results->rawbuf[offset++], SAMSUNG_BIT_MARK_TICKS * m_tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], SAMSUNG_MIN_GAP_TICKS * s_tick)) + return false; + + // Compliance + + // According to the spec, the customer (address) code is the first 8 + // transmitted bits. It's then repeated. Check for that. + uint8_t address = data >> 24; + if (strict && address != ((data >> 16) & 0xFF)) + return false; + // Spec says the command code is the 3rd block of transmitted 8-bits, + // followed by the inverted command code. + uint8_t command = (data & 0xFF00) >> 8; + if (strict && command != ((data & 0xFF) ^ 0xFF)) + return false; + + // Success + results->bits = nbits; + results->value = data; + results->decode_type = SAMSUNG; + // command & address need to be reversed as they are transmitted LSB first, + results->command = reverseBits(command, sizeof(command) * 8); + results->address = reverseBits(address, sizeof(address) * 8); + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Sanyo.cpp b/IRremoteESP8266/src/ir_Sanyo.cpp new file mode 100644 index 0000000..fc9d64f --- /dev/null +++ b/IRremoteESP8266/src/ir_Sanyo.cpp @@ -0,0 +1,238 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2016 marcosamarinho +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" + +// SSSS AAA N N Y Y OOO +// S A A NN N Y Y O O +// SSS AAAAA N N N Y O O +// S A A N NN Y O O +// SSSS A A N N Y OOO + +// Sanyo SA 8650B originally added from: +// https://github.com/shirriff/Arduino-IRremote/ +// Sanyo LC7461 support originally by marcosamarinho + +// Constants +// Sanyo SA 8650B +// Ref: +// https://github.com/z3t0/Arduino-IRremote/blob/master/ir_Sanyo.cpp +#define SANYO_SA8650B_HDR_MARK 3500U // seen range 3500 +#define SANYO_SA8650B_HDR_SPACE 950U // seen 950 +#define SANYO_SA8650B_ONE_MARK 2400U // seen 2400 +#define SANYO_SA8650B_ZERO_MARK 700U // seen 700 +// usually see 713 - not using ticks as get number wrapround +#define SANYO_SA8650B_DOUBLE_SPACE_USECS 800U +#define SANYO_SA8650B_RPT_LENGTH 45000U +// Sanyo LC7461 +// Ref: +// https://github.com/marcosamarinho/IRremoteESP8266/blob/master/ir_Sanyo.cpp +// http://slydiman.narod.ru/scr/kb/sanyo.htm +// http://pdf.datasheetcatalog.com/datasheet/sanyo/LC7461.pdf +#define SANYO_LC7461_ADDRESS_MASK ((1 << SANYO_LC7461_ADDRESS_BITS) - 1) +#define SANYO_LC7461_COMMAND_MASK ((1 << SANYO_LC7461_COMMAND_BITS) - 1) +#define SANYO_LC7461_HDR_MARK 9000U +#define SANYO_LC7461_HDR_SPACE 4500U +#define SANYO_LC7461_BIT_MARK 560U // 1T +#define SANYO_LC7461_ONE_SPACE 1690U // 3T +#define SANYO_LC7461_ZERO_SPACE 560U // 1T +#define SANYO_LC7461_MIN_COMMAND_LENGTH 108000UL +#define SANYO_LC7461_MIN_GAP SANYO_LC7461_MIN_COMMAND_LENGTH - \ + (SANYO_LC7461_HDR_MARK + SANYO_LC7461_HDR_SPACE + SANYO_LC7461_BITS * \ + (SANYO_LC7461_BIT_MARK + (SANYO_LC7461_ONE_SPACE + \ + SANYO_LC7461_ZERO_SPACE) / 2) \ + + SANYO_LC7461_BIT_MARK) + +#if SEND_SANYO +// Construct a Sanyo LC7461 message. +// +// Args: +// address: The 13 bit value of the address(Custom) portion of the protocol. +// command: The 8 bit value of the command(Key) portion of the protocol. +// Returns: +// An uint64_t with the encoded raw 42 bit Sanyo LC7461 data value. +// +// Notes: +// This protocol uses the NEC protocol timings. However, data is +// formatted as : address(13 bits), !address, command(8 bits), !command. +// According with LIRC, this protocol is used on Sanyo, Aiwa and Chinon +uint64_t IRsend::encodeSanyoLC7461(uint16_t address, uint8_t command) { + // Mask our input values to ensure the correct bit sizes. + address &= SANYO_LC7461_ADDRESS_MASK; + command &= SANYO_LC7461_COMMAND_MASK; + + uint64_t data = address; + address ^= SANYO_LC7461_ADDRESS_MASK; // Invert the 13 LSBs. + // Append the now inverted address. + data = (data << SANYO_LC7461_ADDRESS_BITS) | address; + // Append the command. + data = (data << SANYO_LC7461_COMMAND_BITS) | command; + command ^= SANYO_LC7461_COMMAND_MASK; // Invert the command. + // Append the now inverted command. + data = (data << SANYO_LC7461_COMMAND_BITS) | command; + + return data; +} + +// Send a Sanyo LC7461 message. +// +// Args: +// data: The contents of the command you want to send. +// nbits: The bit size of the command being sent. +// repeat: The number of times you want the command to be repeated. +// +// Status: BETA / Probably works. +// +// Notes: +// Based on @marcosamarinho's work. +// This protocol uses the NEC protocol timings. However, data is +// formatted as : address(13 bits), !address, command (8 bits), !command. +// According with LIRC, this protocol is used on Sanyo, Aiwa and Chinon +// Information for this protocol is available at the Sanyo LC7461 datasheet. +// Repeats are performed similar to the NEC method of sending a special +// repeat message, rather than duplicating the entire message. +// Ref: +// https://github.com/marcosamarinho/IRremoteESP8266/blob/master/ir_Sanyo.cpp +// http://pdf.datasheetcatalog.com/datasheet/sanyo/LC7461.pdf +void IRsend::sendSanyoLC7461(uint64_t data, uint16_t nbits, uint16_t repeat) { + // This protocol appears to be another 42-bit variant of the NEC protcol. + sendNEC(data, nbits, repeat); +} +#endif // SEND_SANYO + +#if DECODE_SANYO +// Decode the supplied SANYO LC7461 message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of data bits to expect. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / Probably works. +// +// Notes: +// Based on @marcosamarinho's work. +// This protocol uses the NEC protocol. However, data is +// formatted as : address(13 bits), !address, command (8 bits), !command. +// According with LIRC, this protocol is used on Sanyo, Aiwa and Chinon +// Information for this protocol is available at the Sanyo LC7461 datasheet. +// Ref: +// http://slydiman.narod.ru/scr/kb/sanyo.htm +// https://github.com/marcosamarinho/IRremoteESP8266/blob/master/ir_Sanyo.cpp +// http://pdf.datasheetcatalog.com/datasheet/sanyo/LC7461.pdf +bool IRrecv::decodeSanyoLC7461(decode_results *results, uint16_t nbits, + bool strict) { + if (strict && nbits != SANYO_LC7461_BITS) + return false; // Not strictly in spec. + // This protocol is basically a 42-bit variant of the NEC protocol. + if (!decodeNEC(results, nbits, false)) + return false; // Didn't match a NEC format (without strict) + + // Bits 30 to 42+. + uint16_t address = results->value >> (SANYO_LC7461_BITS - + SANYO_LC7461_ADDRESS_BITS); + // Bits 9 to 16. + uint8_t command = (results->value >> SANYO_LC7461_COMMAND_BITS) & + SANYO_LC7461_COMMAND_MASK; + // Compliance + if (strict) { + if (results->bits != nbits) + return false; + // Bits 17 to 29. + uint16_t inverted_address = + (results->value >> (SANYO_LC7461_COMMAND_BITS * 2)) & + SANYO_LC7461_ADDRESS_MASK; + // Bits 1-8. + uint8_t inverted_command = results->value & SANYO_LC7461_COMMAND_MASK; + if ((address ^ SANYO_LC7461_ADDRESS_MASK) != inverted_address) + return false; // Address integrity check failed. + if ((command ^ SANYO_LC7461_COMMAND_MASK) != inverted_command) + return false; // Command integrity check failed. + } + + // Success + results->decode_type = SANYO_LC7461; + results->address = address; + results->command = command; + return true; +} + +/* NOTE: Disabled due to poor quality. +// Decode the supplied Sanyo SA 8650B message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of data bits to expect. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: Depricated. +// +// NOTE: This decoder looks like rubbish. Only keeping it for compatibility +// with the Arduino IRremote library. Seriously, don't trust it. +// If someone has a device that this is supposed to be for, please log an +// Issue on github with a rawData dump please. We should probably remove +// it. We think this is a Sanyo decoder - serial = SA 8650B +// Ref: +// https://github.com/z3t0/Arduino-IRremote/blob/master/ir_Sanyo.cpp +bool IRrecv::decodeSanyo(decode_results *results, uint16_t nbits, bool strict) { + if (results->rawlen < 2 * nbits + HEADER - 1) + return false; // Shorter than shortest possible. + if (strict && nbits != SANYO_SA8650B_BITS) + return false; // Doesn't match the spec. + + uint16_t offset = 0; + + // TODO(crankyoldgit): This repeat code looks like garbage, it should never + // match or if it does, it won't be reliable. We should probably just + // remove it. + if (results->rawbuf[offset++] < SANYO_SA8650B_DOUBLE_SPACE_USECS) { + results->bits = 0; + results->value = REPEAT; + results->decode_type = SANYO; + results->address = 0; + results->command = 0; + results->repeat = true; + return true; + } + + // Header + if (!matchMark(results->rawbuf[offset++], SANYO_SA8650B_HDR_MARK)) + return false; + // NOTE: These next two lines look very wrong. Treat as suspect. + if (!matchMark(results->rawbuf[offset++], SANYO_SA8650B_HDR_MARK)) + return false; + // Data + uint64_t data = 0; + while (offset + 1 < results->rawlen) { + if (!matchSpace(results->rawbuf[offset], SANYO_SA8650B_HDR_SPACE)) + break; + offset++; + if (matchMark(results->rawbuf[offset], SANYO_SA8650B_ONE_MARK)) + data = (data << 1) | 1; // 1 + else if (matchMark(results->rawbuf[offset], SANYO_SA8650B_ZERO_MARK)) + data <<= 1; // 0 + else + return false; + offset++; + } + + if (strict && SANYO_SA8650B_BITS > (offset - 1U) / 2U) + return false; + + // Success + results->bits = (offset - 1) / 2; + results->decode_type = SANYO; + results->value = data; + results->address = 0; + results->command = 0; + return true; +} +*/ +#endif // DECODE_SANYO diff --git a/IRremoteESP8266/src/ir_Sharp.cpp b/IRremoteESP8266/src/ir_Sharp.cpp new file mode 100644 index 0000000..982838d --- /dev/null +++ b/IRremoteESP8266/src/ir_Sharp.cpp @@ -0,0 +1,275 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// SSSS H H AAA RRRR PPPP +// S H H A A R R P P +// SSS HHHHH AAAAA RRRR PPPP +// S H H A A R R P +// SSSS H H A A R R P + +// Equipment it seems compatible with: +// * Sharp LC-52D62U +// * +// + +// Constants +// period time = 1/38000Hz = 26.316 microseconds. +// Ref: +// GlobalCache's IR Control Tower data. +// http://www.sbprojects.com/knowledge/ir/sharp.php +#define SHARP_TICK 26U +#define SHARP_BIT_MARK_TICKS 10U +#define SHARP_BIT_MARK (SHARP_BIT_MARK_TICKS * SHARP_TICK) +#define SHARP_ONE_SPACE_TICKS 70U +#define SHARP_ONE_SPACE (SHARP_ONE_SPACE_TICKS * SHARP_TICK) +#define SHARP_ZERO_SPACE_TICKS 30U +#define SHARP_ZERO_SPACE (SHARP_ZERO_SPACE_TICKS * SHARP_TICK) +#define SHARP_GAP_TICKS 1677U +#define SHARP_GAP (SHARP_GAP_TICKS * SHARP_TICK) + +// Address(5) + Command(8) + Expansion(1) + Check(1) +#define SHARP_TOGGLE_MASK ((1 << (SHARP_BITS - SHARP_ADDRESS_BITS)) - 1) +#define SHARP_ADDRESS_MASK ((1 << SHARP_ADDRESS_BITS) - 1) +#define SHARP_COMMAND_MASK ((1 << SHARP_COMMAND_BITS) - 1) + +#if (SEND_SHARP || SEND_DENON) +// Send a (raw) Sharp message +// +// Args: +// data: Contents of the message to be sent. +// nbits: Nr. of bits of data to be sent. Typically SHARP_BITS. +// repeat: Nr. of additional times the message is to be sent. +// +// Status: BETA / Previously working fine. +// +// Notes: +// This procedure handles the inversion of bits required per protocol. +// The protocol spec says to send the LSB first, but legacy code & usage +// has us sending the MSB first. Grrrr. Normal invocation of encodeSharp() +// handles this for you, assuming you are using the correct/standard values. +// e.g. sendSharpRaw(encodeSharp(address, command)); +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/sharp.htm +// http://lirc.sourceforge.net/remotes/sharp/GA538WJSA +// http://www.mwftr.com/ucF08/LEC14%20PIC%20IR.pdf +// http://www.hifi-remote.com/johnsfine/DecodeIR.html#Sharp +void IRsend::sendSharpRaw(uint64_t data, uint16_t nbits, uint16_t repeat) { + for (uint16_t i = 0; i <= repeat; i++) { + // Protocol demands that the data be sent twice; once normally, + // then with all but the address bits inverted. + // Note: Previously this used to be performed 3 times (normal, inverted, + // normal), however all data points to that being incorrect. + for (uint8_t n = 0; n < 2; n++) { + sendGeneric(0, 0, // No Header + SHARP_BIT_MARK, SHARP_ONE_SPACE, + SHARP_BIT_MARK, SHARP_ZERO_SPACE, + SHARP_BIT_MARK, SHARP_GAP, + data, nbits, 38, true, 0, // Repeats are handled already. + 33); + // Invert the data per protocol. This is always called twice, so it's + // retured to original upon exiting the inner loop. + data ^= SHARP_TOGGLE_MASK; + } + } +} + +// Encode a (raw) Sharp message from it's components. +// +// Args: +// address: The value of the address to be sent. +// command: The value of the address to be sent. (8 bits) +// expansion: The value of the expansion bit to use. (0 or 1, typically 1) +// check: The value of the check bit to use. (0 or 1, typically 0) +// MSBfirst: Flag indicating MSB first or LSB first order. (Default: false) +// Returns: +// An uint32_t containing the raw Sharp message for sendSharpRaw(). +// +// Status: BETA / Should work okay. +// +// Notes: +// Assumes the standard Sharp bit sizes. +// Historically sendSharp() sends address & command in +// MSB first order. This is actually incorrect. It should be sent in LSB +// order. The behaviour of sendSharp() hasn't been changed to maintain +// backward compatibility. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/sharp.htm +// http://lirc.sourceforge.net/remotes/sharp/GA538WJSA +// http://www.mwftr.com/ucF08/LEC14%20PIC%20IR.pdf +uint32_t IRsend::encodeSharp(uint16_t address, uint16_t command, + uint16_t expansion, uint16_t check, + bool MSBfirst) { + // Mask any unexpected bits. + address &= ((1 << SHARP_ADDRESS_BITS) - 1); + command &= ((1 << SHARP_COMMAND_BITS) - 1); + expansion &= 1; + check &= 1; + + if (!MSBfirst) { // Correct bit order if needed. + address = reverseBits(address, SHARP_ADDRESS_BITS); + command = reverseBits(command, SHARP_COMMAND_BITS); + } + // Concatinate all the bits. + return (address << (SHARP_COMMAND_BITS + 2)) | (command << 2) | + (expansion << 1) | check; +} + +// Send a Sharp message +// +// Args: +// address: Address value to be sent. +// command: Command value to be sent. +// nbits: Nr. of bits of data to be sent. Typically SHARP_BITS. +// repeat: Nr. of additional times the message is to be sent. +// +// Status: DEPRICATED / Previously working fine. +// +// Notes: +// This procedure has a non-standard invocation style compared to similar +// sendProtocol() routines. This is due to legacy, compatibility, & historic +// reasons. Normally the calling syntax version is like sendSharpRaw(). +// This procedure transmits the address & command in MSB first order, which is +// incorrect. This behaviour is left as-is to maintain backward +// compatibility with legacy code. +// In short, you should use sendSharpRaw(), encodeSharp(), and the correct +// values of address & command instead of using this, & the wrong values. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/sharp.htm +// http://lirc.sourceforge.net/remotes/sharp/GA538WJSA +// http://www.mwftr.com/ucF08/LEC14%20PIC%20IR.pdf +void IRsend::sendSharp(uint16_t address, uint16_t command, uint16_t nbits, + uint16_t repeat) { + sendSharpRaw(encodeSharp(address, command, 1, 0, true), nbits, repeat); +} +#endif // (SEND_SHARP || SEND_DENON) + +#if (DECODE_SHARP || DECODE_DENON) +// Decode the supplied Sharp message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of data bits to expect. Typically SHARP_BITS. +// strict: Flag indicating if we should perform strict matching. +// expansion: Should we expect the expansion bit to be set. Default is true. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: STABLE / Working fine. +// +// Note: +// This procedure returns a value suitable for use in sendSharpRaw(). +// TODO(crankyoldgit): Need to ensure capture of the inverted message as it can +// be missed due to the interrupt timeout used to detect an end of message. +// Several compliance checks are disabled until that is resolved. +// Ref: +// http://www.sbprojects.com/knowledge/ir/sharp.php +// http://www.mwftr.com/ucF08/LEC14%20PIC%20IR.pdf +// http://www.hifi-remote.com/johnsfine/DecodeIR.html#Sharp +bool IRrecv::decodeSharp(decode_results *results, uint16_t nbits, bool strict, + bool expansion) { + if (results->rawlen < 2 * nbits + FOOTER - 1) + return false; // Not enough entries to be a Sharp message. + // Compliance + if (strict) { + if (nbits != SHARP_BITS) + return false; // Request is out of spec. + // DISABLED - See TODO +#ifdef UNIT_TEST + // An in spec message has the data sent normally, then inverted. So we + // expect twice as many entries than to just get the results. + if (results->rawlen < 2 * (2 * nbits + FOOTER)) + return false; +#endif + } + + uint64_t data = 0; + uint16_t offset = OFFSET_START; + + // No header + // But try to auto-calibrate off the initial mark signal. + if (!matchMark(results->rawbuf[offset], SHARP_BIT_MARK, 35)) return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t tick = results->rawbuf[offset] * RAWTICK / SHARP_BIT_MARK_TICKS; + // Data + for (uint16_t i = 0; i < nbits; i++, offset++) { + // Use a higher tolerance value for SHARP_BIT_MARK as it is quite small. + if (!matchMark(results->rawbuf[offset++], SHARP_BIT_MARK_TICKS * tick, 35)) + return false; + if (matchSpace(results->rawbuf[offset], SHARP_ONE_SPACE_TICKS * tick)) + data = (data << 1) | 1; // 1 + else if (matchSpace(results->rawbuf[offset], SHARP_ZERO_SPACE_TICKS * tick)) + data <<= 1; // 0 + else + return false; + } + + // Footer + if (!match(results->rawbuf[offset++], SHARP_BIT_MARK_TICKS * tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], SHARP_GAP_TICKS * tick)) + return false; + + // Compliance + if (strict) { + // Check the state of the expansion bit is what we expect. + if ((data & 0b10) >> 1 != expansion) + return false; + // The check bit should be cleared in a normal message. + if (data & 0b1) + return false; + // DISABLED - See TODO +#ifdef UNIT_TEST + // Grab the second copy of the data (i.e. inverted) + // Header + // i.e. The inter-data/command repeat gap. + if (!matchSpace(results->rawbuf[offset++], SHARP_GAP_TICKS * tick)) + return false; + + // Data + uint64_t second_data = 0; + for (uint16_t i = 0; i < nbits; i++, offset++) { + // Use a higher tolerance value for SHARP_BIT_MARK as it is quite small. + if (!matchMark(results->rawbuf[offset++], SHARP_BIT_MARK_TICKS * tick, + 35)) + return false; + if (matchSpace(results->rawbuf[offset], SHARP_ONE_SPACE_TICKS * tick)) + second_data = (second_data << 1) | 1; // 1 + else if (matchSpace(results->rawbuf[offset], + SHARP_ZERO_SPACE_TICKS * tick)) + second_data <<= 1; // 0 + else + return false; + } + // Footer + if (!match(results->rawbuf[offset++], SHARP_BIT_MARK_TICKS * tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], SHARP_GAP_TICKS * tick)) + return false; + + // Check that second_data has been inverted correctly. + if (data != (second_data ^ SHARP_TOGGLE_MASK)) + return false; +#endif // UNIT_TEST + } + + // Success + results->decode_type = SHARP; + results->bits = nbits; + results->value = data; + // Address & command are actually transmitted in LSB first order. + results->address = reverseBits(data, nbits) & SHARP_ADDRESS_MASK; + results->command = reverseBits((data >> 2) & SHARP_COMMAND_MASK, + SHARP_COMMAND_BITS); + return true; +} +#endif // (DECODE_SHARP || DECODE_DENON) diff --git a/IRremoteESP8266/src/ir_Sherwood.cpp b/IRremoteESP8266/src/ir_Sherwood.cpp new file mode 100644 index 0000000..97e7506 --- /dev/null +++ b/IRremoteESP8266/src/ir_Sherwood.cpp @@ -0,0 +1,29 @@ +// Copyright 2017 David Conran + +#include +#include "IRsend.h" + +// SSSSS HH HH EEEEEEE RRRRRR WW WW OOOOO OOOOO DDDDD +// SS HH HH EE RR RR WW WW OO OO OO OO DD DD +// SSSSS HHHHHHH EEEEE RRRRRR WW W WW OO OO OO OO DD DD +// SS HH HH EE RR RR WW WWW WW OO OO OO OO DD DD +// SSSSS HH HH EEEEEEE RR RR WW WW OOOO0 OOOO0 DDDDDD + +#if SEND_SHERWOOD +// Send an IR command to a Sherwood device. +// +// Args: +// data: The contents of the command you want to send. +// nbits: The bit size of the command being sent. (SHERWOOD_BITS) +// repeat: The nr. of times you want the command to be repeated. (Default: 1) +// +// Status: STABLE / Known working. +// +// Note: +// Sherwood remote codes appear to be NEC codes with a manditory repeat code. +// i.e. repeat should be >= SHERWOOD_MIN_REPEAT (1). +void IRsend::sendSherwood(uint64_t data, uint16_t nbits, + uint16_t repeat) { + sendNEC(data, nbits, std::max((uint16_t) SHERWOOD_MIN_REPEAT, repeat)); +} +#endif diff --git a/IRremoteESP8266/src/ir_Sony.cpp b/IRremoteESP8266/src/ir_Sony.cpp new file mode 100644 index 0000000..132c18a --- /dev/null +++ b/IRremoteESP8266/src/ir_Sony.cpp @@ -0,0 +1,184 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2016 marcosamarinho +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// SSSS OOO N N Y Y +// S O O NN N Y Y +// SSS O O N N N Y +// S O O N NN Y +// SSSS OOO N N Y + +// Sony originally added from https://github.com/shirriff/Arduino-IRremote/ +// Updates from marcosamarinho + +// Constants +// Ref: +// http://www.sbprojects.com/knowledge/ir/sirc.php +#define SONY_TICK 200U +#define SONY_HDR_MARK_TICKS 12U +#define SONY_HDR_MARK (SONY_HDR_MARK_TICKS * SONY_TICK) +#define SONY_SPACE_TICKS 3U +#define SONY_SPACE (SONY_SPACE_TICKS * SONY_TICK) +#define SONY_ONE_MARK_TICKS 6U +#define SONY_ONE_MARK (SONY_ONE_MARK_TICKS * SONY_TICK) +#define SONY_ZERO_MARK_TICKS 3U +#define SONY_ZERO_MARK (SONY_ZERO_MARK_TICKS * SONY_TICK) +#define SONY_RPT_LENGTH_TICKS 225U +#define SONY_RPT_LENGTH (SONY_RPT_LENGTH_TICKS * SONY_TICK) +#define SONY_MIN_GAP_TICKS 50U +#define SONY_MIN_GAP (SONY_MIN_GAP_TICKS * SONY_TICK) + +#if SEND_SONY +// Send a Sony/SIRC(Serial Infra-Red Control) message. +// +// Args: +// data: message to be sent. +// nbits: Nr. of bits of the message to be sent. +// repeat: Nr. of additional times the message is to be sent. (Default: 2) +// +// Status: STABLE / Known working. +// +// Notes: +// sendSony() should typically be called with repeat=2 as Sony devices +// expect the message to be sent at least 3 times. +// +// Ref: +// http://www.sbprojects.com/knowledge/ir/sirc.php +void IRsend::sendSony(uint64_t data, uint16_t nbits, uint16_t repeat) { + sendGeneric(SONY_HDR_MARK, SONY_SPACE, + SONY_ONE_MARK, SONY_SPACE, + SONY_ZERO_MARK, SONY_SPACE, + 0, // No Footer mark. + SONY_MIN_GAP, SONY_RPT_LENGTH, + data, nbits, 40, true, repeat, 33); +} + +// Convert Sony/SIRC command, address, & extended bits into sendSony format. +// Args: +// nbits: Sony protocol bit size. +// command: Sony command bits. +// address: Sony address bits. +// extended: Sony extended bits. +// Returns: +// A sendSony compatible data message. +// +// Status: BETA / Should be working. +uint32_t IRsend::encodeSony(uint16_t nbits, uint16_t command, + uint16_t address, uint16_t extended) { + uint32_t result = 0; + switch (nbits) { + case 12: // 5 address bits. + result = address & 0x1F; + break; + case 15: // 8 address bits. + result = address & 0xFF; + break; + case 20: // 5 address bits, 8 extended bits. + result = address & 0x1F; + result |= (extended & 0xFF) << 5; + break; + default: + return 0; // This is not an expected Sony bit size/protocol. + } + result = (result << 7) | (command & 0x7F); // All sizes have 7 command bits. + return reverseBits(result, nbits); // sendSony uses reverse ordered bits. +} +#endif + +#if DECODE_SONY +// Decode the supplied Sony/SIRC message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA / Should be working. strict mode is ALPHA / Untested. +// +// Notes: +// SONY protocol, SIRC (Serial Infra-Red Control) can be 12,15,20 bits long. +// Ref: +// http://www.sbprojects.com/knowledge/ir/sirc.php +bool IRrecv::decodeSony(decode_results *results, uint16_t nbits, bool strict) { + if (results->rawlen < 2 * nbits + HEADER - 1) + return false; // Message is smaller than we expected. + + // Compliance + if (strict) { + switch (nbits) { // Check we've been called with a correct bit size. + case 12: + case 15: + case 20: + break; + default: + return false; // The request doesn't strictly match the protocol defn. + } + } + + uint64_t data = 0; + uint16_t offset = OFFSET_START; + uint16_t actualBits; + uint32_t timeSoFar = 0; // Time in uSecs of the message length. + + // Header + timeSoFar += results->rawbuf[offset] * RAWTICK; + if (!matchMark(results->rawbuf[offset], SONY_HDR_MARK)) + return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t tick = results->rawbuf[offset++] * RAWTICK / SONY_HDR_MARK_TICKS; + + // Data + for (actualBits = 0; offset < results->rawlen - 1; actualBits++, offset++) { + // The gap after a Sony packet for a repeat should be SONY_MIN_GAP or + // (SONY_RPT_LENGTH - timeSoFar) according to the spec. + if (matchSpace(results->rawbuf[offset], SONY_MIN_GAP_TICKS * tick) || + matchAtLeast(results->rawbuf[offset], SONY_RPT_LENGTH - timeSoFar)) + break; // Found a repeat space. + timeSoFar += results->rawbuf[offset] * RAWTICK; + if (!matchSpace(results->rawbuf[offset++], SONY_SPACE_TICKS * tick)) + return false; + timeSoFar += results->rawbuf[offset] * RAWTICK; + if (matchMark(results->rawbuf[offset], SONY_ONE_MARK_TICKS * tick)) + data = (data << 1) | 1; + else if (matchMark(results->rawbuf[offset], SONY_ZERO_MARK_TICKS * tick)) + data <<= 1; + else + return false; + } + // No Footer for Sony. + + // Compliance + if (strict && actualBits != nbits) + return false; // We got the wrong number of bits. + + // Success + results->bits = actualBits; + results->value = data; + results->decode_type = SONY; + // Message comes in LSB first. Convert ot MSB first. + data = reverseBits(data, actualBits); + // Decode the address & command from raw decode value. + switch (actualBits) { + case 12: // 7 command bits, 5 address bits. + case 15: // 7 command bits, 8 address bits. + results->command = data & 0x7F; // Bits 0-6 + results->address = data >> 7; // Bits 7-14 + break; + case 20: // 7 command bits, 5 address bits, 8 extended (command) bits. + results->command = (data & 0x7F) + ((data >> 12) << 7); // Bits 0-6,12-19 + results->address = (data >> 7) & 0x1F; // Bits 7-11 + break; + default: // Shouldn't happen, but just in case. + results->address = 0; + results->command = 0; + } + return true; +} +#endif diff --git a/IRremoteESP8266/src/ir_Toshiba.cpp b/IRremoteESP8266/src/ir_Toshiba.cpp new file mode 100644 index 0000000..bea29ce --- /dev/null +++ b/IRremoteESP8266/src/ir_Toshiba.cpp @@ -0,0 +1,349 @@ +// Copyright 2017 David Conran + +#include "ir_Toshiba.h" +#include +#ifndef ARDUINO +#include +#endif +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// TTTTTTT OOOOO SSSSS HH HH IIIII BBBBB AAA +// TTT OO OO SS HH HH III BB B AAAAA +// TTT OO OO SSSSS HHHHHHH III BBBBBB AA AA +// TTT OO OO SS HH HH III BB BB AAAAAAA +// TTT OOOO0 SSSSS HH HH IIIII BBBBBB AA AA + +// Toshiba A/C support added by David Conran +// +// Equipment it seems compatible with: +// * Toshiba RAS-B13N3KV2 / Akita EVO II +// * Toshiba RAS-B13N3KVP-E, RAS 18SKP-ES +// * Toshiba WH-TA04NE, WC-L03SE +// * + +// Constants + +// Toshiba A/C +// Ref: +// https://github.com/r45635/HVAC-IR-Control/blob/master/HVAC_ESP8266/HVAC_ESP8266T.ino#L77 +#define TOSHIBA_AC_HDR_MARK 4400U +#define TOSHIBA_AC_HDR_SPACE 4300U +#define TOSHIBA_AC_BIT_MARK 543U +#define TOSHIBA_AC_ONE_SPACE 1623U +#define TOSHIBA_AC_ZERO_SPACE 472U +#define TOSHIBA_AC_MIN_GAP 7048U + +#if SEND_TOSHIBA_AC +// Send a Toshiba A/C message. +// +// Args: +// data: An array of bytes containing the IR command. +// nbytes: Nr. of bytes of data in the array. (>=TOSHIBA_AC_STATE_LENGTH) +// repeat: Nr. of times the message is to be repeated. +// (Default = TOSHIBA_AC_MIN_REPEAT). +// +// Status: StABLE / Working. +// +void IRsend::sendToshibaAC(unsigned char data[], uint16_t nbytes, + uint16_t repeat) { + if (nbytes < TOSHIBA_AC_STATE_LENGTH) + return; // Not enough bytes to send a proper message. + sendGeneric(TOSHIBA_AC_HDR_MARK, TOSHIBA_AC_HDR_SPACE, + TOSHIBA_AC_BIT_MARK, TOSHIBA_AC_ONE_SPACE, + TOSHIBA_AC_BIT_MARK, TOSHIBA_AC_ZERO_SPACE, + TOSHIBA_AC_BIT_MARK, TOSHIBA_AC_MIN_GAP, + data, nbytes, 38, true, repeat, 50); +} +#endif // SEND_TOSHIBA_AC + +// Code to emulate Toshiba A/C IR remote control unit. +// Inspired and derived from the work done at: +// https://github.com/r45635/HVAC-IR-Control +// +// Status: STABLE / Working. +// +// Initialise the object. +IRToshibaAC::IRToshibaAC(uint16_t pin) : _irsend(pin) { + stateReset(); +} + +// Reset the state of the remote to a known good state/sequence. +void IRToshibaAC::stateReset() { + // The state of the IR remote in IR code form. + // Known good state obtained from: + // https://github.com/r45635/HVAC-IR-Control/blob/master/HVAC_ESP8266/HVAC_ESP8266T.ino#L103 + // Note: Can't use the following because it requires -std=c++11 + // uint8_t remote_state[TOSHIBA_AC_STATE_LENGTH] = { + // 0xF2, 0x0D, 0x03, 0xFC, 0x01, 0x00, 0x00, 0x00, 0x00 }; + remote_state[0] = 0xF2; + remote_state[1] = 0x0D; + remote_state[2] = 0x03; + remote_state[3] = 0xFC; + remote_state[4] = 0x01; + for (uint8_t i = 5; i < TOSHIBA_AC_STATE_LENGTH; i++) + remote_state[i] = 0; + mode_state = remote_state[6] & 0b00000011; + checksum(); // Calculate the checksum +} + +// Configure the pin for output. +void IRToshibaAC::begin() { + _irsend.begin(); +} + +#if SEND_TOSHIBA_AC +// Send the current desired state to the IR LED. +void IRToshibaAC::send() { + checksum(); // Ensure correct checksum before sending. + _irsend.sendToshibaAC(remote_state); +} +#endif // SEND_TOSHIBA_AC + +// Return a pointer to the internal state date of the remote. +uint8_t* IRToshibaAC::getRaw() { + checksum(); + return remote_state; +} + +// Override the internal state with the new state. +void IRToshibaAC::setRaw(uint8_t newState[]) { + for (uint8_t i = 0; i < TOSHIBA_AC_STATE_LENGTH; i++) { + remote_state[i] = newState[i]; + } + mode_state = getMode(true); +} + +// Calculate the checksum for a given array. +// Args: +// state: The array to calculate the checksum over. +// length: The size of the array. +// Returns: +// The 8 bit checksum value. +uint8_t IRToshibaAC::calcChecksum(const uint8_t state[], + const uint16_t length) { + uint8_t checksum = 0; + // Only calculate it for valid lengths. + if (length > 1) { + // Checksum is simple XOR of all bytes except the last one. + for (uint8_t i = 0; i < length - 1; i++) + checksum ^= state[i]; + } + return checksum; +} + +// Verify the checksum is valid for a given state. +// Args: +// state: The array to verify the checksum of. +// length: The size of the state. +// Returns: +// A boolean. +bool IRToshibaAC::validChecksum(const uint8_t state[], + const uint16_t length) { + return (length > 1 && state[length - 1] == calcChecksum(state, length)); +} + +// Calculate & set the checksum for the current internal state of the remote. +void IRToshibaAC::checksum(const uint16_t length) { + // Stored the checksum value in the last byte. + if (length > 1) + remote_state[length - 1] = calcChecksum(remote_state, length); +} + +// Set the requested power state of the A/C to off. +void IRToshibaAC::on() { + // state = ON; + remote_state[6] &= ~TOSHIBA_AC_POWER; + setMode(mode_state); +} + +// Set the requested power state of the A/C to off. +void IRToshibaAC::off() { + // state = OFF; + remote_state[6] |= (TOSHIBA_AC_POWER | 0b00000011); +} + +// Set the requested power state of the A/C. +void IRToshibaAC::setPower(bool state) { + if (state) + on(); + else + off(); +} + +// Return the requested power state of the A/C. +bool IRToshibaAC::getPower() { + return((remote_state[6] & TOSHIBA_AC_POWER) == 0); +} + +// Set the temp. in deg C +void IRToshibaAC::setTemp(uint8_t temp) { + temp = std::max((uint8_t) TOSHIBA_AC_MIN_TEMP, temp); + temp = std::min((uint8_t) TOSHIBA_AC_MAX_TEMP, temp); + remote_state[5] = (temp - TOSHIBA_AC_MIN_TEMP) << 4; +} + +// Return the set temp. in deg C +uint8_t IRToshibaAC::getTemp() { + return((remote_state[5] >> 4) + TOSHIBA_AC_MIN_TEMP); +} + +// Set the speed of the fan, 0-5. +// 0 is auto, 1-5 is the speed, 5 is Max. +void IRToshibaAC::setFan(uint8_t fan) { + // Bounds check + if (fan > TOSHIBA_AC_FAN_MAX) + fan = TOSHIBA_AC_FAN_MAX; // Set the fan to maximum if out of range. + if (fan > TOSHIBA_AC_FAN_AUTO) fan++; + remote_state[6] &= 0b00011111; // Clear the previous fan state + remote_state[6] |= (fan << 5); +} + +// Return the requested state of the unit's fan. +uint8_t IRToshibaAC::getFan() { + uint8_t fan = remote_state[6] >> 5; + if (fan == TOSHIBA_AC_FAN_AUTO) return TOSHIBA_AC_FAN_AUTO; + return --fan; +} + +// Get the requested climate operation mode of the a/c unit. +// Args: +// useRaw: Indicate to get the mode from the state array. (Default: false) +// Returns: +// A uint8_t containing the A/C mode. +uint8_t IRToshibaAC::getMode(bool useRaw) { + if (useRaw) + return (remote_state[6] & 0b00000011); + else + return mode_state; +} + +// Set the requested climate operation mode of the a/c unit. +void IRToshibaAC::setMode(uint8_t mode) { + // If we get an unexpected mode, default to AUTO. + switch (mode) { + case TOSHIBA_AC_AUTO: break; + case TOSHIBA_AC_COOL: break; + case TOSHIBA_AC_DRY: break; + case TOSHIBA_AC_HEAT: break; + default: mode = TOSHIBA_AC_AUTO; + } + mode_state = mode; + // Only adjust the remote_state if we have power set to on. + if (getPower()) { + remote_state[6] &= 0b11111100; // Clear the previous mode. + remote_state[6] |= mode_state; + } +} + +// Convert the internal state into a human readable string. +#ifdef ARDUINO +String IRToshibaAC::toString() { + String result = ""; +#else +std::string IRToshibaAC::toString() { + std::string result = ""; +#endif // ARDUINO + result += "Power: "; + if (getPower()) + result += "On"; + else + result += "Off"; + result += ", Mode: " + uint64ToString(getMode()); + switch (getMode()) { + case TOSHIBA_AC_AUTO: + result += " (AUTO)"; + break; + case TOSHIBA_AC_COOL: + result += " (COOL)"; + break; + case TOSHIBA_AC_HEAT: + result += " (HEAT)"; + break; + case TOSHIBA_AC_DRY: + result += " (DRY)"; + break; + default: + result += " (UNKNOWN)"; + } + result += ", Temp: " + uint64ToString(getTemp()) + "C"; + result += ", Fan: " + uint64ToString(getFan()); + switch (getFan()) { + case TOSHIBA_AC_FAN_AUTO: + result += " (AUTO)"; + break; + case TOSHIBA_AC_FAN_MAX: + result += " (MAX)"; + break; + } + return result; +} + +#if DECODE_TOSHIBA_AC +// Decode a Toshiba AC IR message if possible. +// Places successful decode information in the results pointer. +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: The number of data bits to expect. Typically TOSHIBA_AC_BITS. +// strict: Flag to indicate if we strictly adhere to the specification. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: STABLE / Working. +// +// Ref: +// +bool IRrecv::decodeToshibaAC(decode_results *results, uint16_t nbits, + bool strict) { + uint16_t offset = OFFSET_START; + uint16_t dataBitsSoFar = 0; + + // Have we got enough data to successfully decode? + if (results->rawlen < TOSHIBA_AC_BITS + HEADER + FOOTER - 1) + return false; // Can't possibly be a valid message. + + + // Compliance + if (strict && nbits != TOSHIBA_AC_BITS) + return false; // Must be called with the correct nr. of bytes. + + // Header + if (!matchMark(results->rawbuf[offset++], TOSHIBA_AC_HDR_MARK)) + return false; + if (!matchSpace(results->rawbuf[offset++], TOSHIBA_AC_HDR_SPACE)) + return false; + + // Data + for (uint8_t i = 0; i < TOSHIBA_AC_STATE_LENGTH; i++) { + // Read a byte's worth of data. + match_result_t data_result = matchData(&(results->rawbuf[offset]), 8, + TOSHIBA_AC_BIT_MARK, + TOSHIBA_AC_ONE_SPACE, + TOSHIBA_AC_BIT_MARK, + TOSHIBA_AC_ZERO_SPACE); + if (data_result.success == false) return false; // Fail + dataBitsSoFar += 8; + results->state[i] = (uint8_t) data_result.data; + offset += data_result.used; + } + + // Footer + if (!matchMark(results->rawbuf[offset++], TOSHIBA_AC_BIT_MARK)) return false; + if (!matchSpace(results->rawbuf[offset++], TOSHIBA_AC_MIN_GAP)) return false; + + // Compliance + if (strict) { + // Check that the checksum of the message is correct. + if (!IRToshibaAC::validChecksum(results->state)) return false; + } + + // Success + results->decode_type = TOSHIBA_AC; + results->bits = dataBitsSoFar; + // No need to record the state as we stored it as we decoded it. + // As we use result->state, we don't record value, address, or command as it + // is a union data type. + return true; +} +#endif // DECODE_TOSHIBA_AC diff --git a/IRremoteESP8266/src/ir_Toshiba.h b/IRremoteESP8266/src/ir_Toshiba.h new file mode 100644 index 0000000..a0c0df0 --- /dev/null +++ b/IRremoteESP8266/src/ir_Toshiba.h @@ -0,0 +1,74 @@ +// Copyright 2017 David Conran +#ifndef IR_TOSHIBA_H_ +#define IR_TOSHIBA_H_ + +#define __STDC_LIMIT_MACROS +#include +#ifdef ARDUINO +#include +#else +#include +#endif +#include "IRremoteESP8266.h" +#include "IRsend.h" + +// TTTTTTT OOOOO SSSSS HH HH IIIII BBBBB AAA +// TTT OO OO SS HH HH III BB B AAAAA +// TTT OO OO SSSSS HHHHHHH III BBBBBB AA AA +// TTT OO OO SS HH HH III BB BB AAAAAAA +// TTT OOOO0 SSSSS HH HH IIIII BBBBBB AA AA + +// Toshiba A/C support added by David Conran + +// Constants +#define TOSHIBA_AC_AUTO 0U +#define TOSHIBA_AC_COOL 1U +#define TOSHIBA_AC_DRY 2U +#define TOSHIBA_AC_HEAT 3U +#define TOSHIBA_AC_POWER 4U +#define TOSHIBA_AC_FAN_AUTO 0U +#define TOSHIBA_AC_FAN_MAX 5U +#define TOSHIBA_AC_MIN_TEMP 17U // 17C +#define TOSHIBA_AC_MAX_TEMP 30U // 30C + +class IRToshibaAC { + public: + explicit IRToshibaAC(uint16_t pin); + + void stateReset(); +#if SEND_TOSHIBA_AC + void send(); +#endif // SEND_TOSHIBA_AC + void begin(); + void on(); + void off(); + void setPower(bool state); + bool getPower(); + void setTemp(uint8_t temp); + uint8_t getTemp(); + void setFan(uint8_t fan); + uint8_t getFan(); + void setMode(uint8_t mode); + uint8_t getMode(bool useRaw = false); + void setRaw(uint8_t newState[]); + uint8_t* getRaw(); + static bool validChecksum(const uint8_t state[], + const uint16_t length = TOSHIBA_AC_STATE_LENGTH); +#ifdef ARDUINO + String toString(); +#else + std::string toString(); +#endif +#ifndef UNIT_TEST + + private: +#endif + uint8_t remote_state[TOSHIBA_AC_STATE_LENGTH]; + void checksum(const uint16_t length = TOSHIBA_AC_STATE_LENGTH); + static uint8_t calcChecksum(const uint8_t state[], + const uint16_t length = TOSHIBA_AC_STATE_LENGTH); + uint8_t mode_state; + IRsend _irsend; +}; + +#endif // IR_TOSHIBA_H_ diff --git a/IRremoteESP8266/src/ir_Trotec.cpp b/IRremoteESP8266/src/ir_Trotec.cpp new file mode 100644 index 0000000..6ecfcd8 --- /dev/null +++ b/IRremoteESP8266/src/ir_Trotec.cpp @@ -0,0 +1,146 @@ +// Copyright 2017 stufisher + +#include "ir_Trotec.h" +#include "IRremoteESP8266.h" +#include "IRutils.h" + +// Constants +#define TROTEC_HDR_MARK 5952U +#define TROTEC_HDR_SPACE 7364U +#define TROTEC_ONE_MARK 592U +#define TROTEC_ONE_SPACE 1560U +#define TROTEC_ZERO_MARK 592U +#define TROTEC_ZERO_SPACE 592U +#define TROTEC_GAP 6184U +#define TROTEC_GAP_END 1500U // made up value + +#if SEND_TROTEC + +void IRsend::sendTrotec(unsigned char data[], uint16_t nbytes, + uint16_t repeat) { + if (nbytes < TROTEC_COMMAND_LENGTH) + return; + + for (uint16_t r = 0; r <= repeat; r++) { + sendGeneric(TROTEC_HDR_MARK, TROTEC_HDR_SPACE, + TROTEC_ONE_MARK, TROTEC_ONE_SPACE, + TROTEC_ZERO_MARK, TROTEC_ZERO_SPACE, + TROTEC_ONE_MARK, TROTEC_GAP, + data, nbytes, 36, false, 0, // Repeats handled elsewhere + 50); + // More footer + enableIROut(36); + mark(TROTEC_ONE_MARK); + space(TROTEC_GAP_END); + } +} +#endif // SEND_TROTEC + +IRTrotecESP::IRTrotecESP(uint16_t pin) : _irsend(pin) { + stateReset(); +} + +void IRTrotecESP::begin() { + _irsend.begin(); +} + +#if SEND_TROTEC +void IRTrotecESP::send() { + checksum(); + _irsend.sendTrotec(trotec); +} +#endif // SEND_TROTEC + +void IRTrotecESP::checksum() { + uint8_t sum = 0; + uint8_t i; + + for (i = 2; i < 8; i++) sum += trotec[i]; + + trotec[8] = sum & 0xFF; +} + +void IRTrotecESP::stateReset() { + for (uint8_t i = 2; i < TROTEC_COMMAND_LENGTH; i++) + trotec[i] = 0x0; + + trotec[0] = TROTEC_INTRO1; + trotec[1] = TROTEC_INTRO2; + + setPower(false); + setTemp(TROTEC_DEF_TEMP); + setSpeed(TROTEC_FAN_MED); + setMode(TROTEC_AUTO); +} + +uint8_t* IRTrotecESP::getRaw() { + checksum(); + return trotec; +} + +void IRTrotecESP::setPower(bool state) { + if (state) + trotec[2] |= (TROTEC_ON << 3); + else + trotec[2] &= ~(TROTEC_ON << 3); +} + +uint8_t IRTrotecESP::getPower() { + return trotec[2] & (TROTEC_ON << 3); +} + +void IRTrotecESP::setSpeed(uint8_t speed) { + trotec[2] = (trotec[2] & 0xcf) | (speed << 4); +} + +uint8_t IRTrotecESP::getSpeed() { + return trotec[2] & 0x30; +} + +void IRTrotecESP::setMode(uint8_t mode) { + trotec[2] = (trotec[2] & 0xfc) | mode; +} + +uint8_t IRTrotecESP::getMode() { + return trotec[2] & 0x03; +} + +void IRTrotecESP::setTemp(uint8_t temp) { + if (temp < TROTEC_MIN_TEMP) + temp = TROTEC_MIN_TEMP; + else if (temp > TROTEC_MAX_TEMP) + temp = TROTEC_MAX_TEMP; + + trotec[3] = (trotec[3] & 0x80) | (temp - TROTEC_MIN_TEMP); +} + +uint8_t IRTrotecESP::getTemp() { + return trotec[3] & 0x7f; +} + +void IRTrotecESP::setSleep(bool sleep) { + if (sleep) + trotec[3] |= (TROTEC_SLEEP_ON << 7); + else + trotec[3] &= ~(TROTEC_SLEEP_ON << 7); +} + +bool IRTrotecESP::getSleep(void) { + return trotec[3] & (TROTEC_SLEEP_ON << 7); +} + +void IRTrotecESP::setTimer(uint8_t timer) { + if (timer > TROTEC_MAX_TIMER) timer = TROTEC_MAX_TIMER; + + if (timer) { + trotec[5] |= (TROTEC_TIMER_ON << 6); + trotec[6] = timer; + } else { + trotec[5] &= ~(TROTEC_TIMER_ON << 6); + trotec[6] = 0; + } +} + +uint8_t IRTrotecESP::getTimer() { + return trotec[6]; +} diff --git a/IRremoteESP8266/src/ir_Trotec.h b/IRremoteESP8266/src/ir_Trotec.h new file mode 100644 index 0000000..a02ab24 --- /dev/null +++ b/IRremoteESP8266/src/ir_Trotec.h @@ -0,0 +1,80 @@ +// Copyright 2017 stufisher + +#ifndef IR_TROTEC_H_ +#define IR_TROTEC_H_ + +#include "IRremoteESP8266.h" +#include "IRsend.h" + +// Constants +// Byte 0 +#define TROTEC_INTRO1 0x12 + +// Byte 1 +#define TROTEC_INTRO2 0x34 + +// Byte 2 +#define TROTEC_AUTO 0 +#define TROTEC_COOL 1 +#define TROTEC_DRY 2 +#define TROTEC_FAN 3 + +#define TROTEC_ON 1 +#define TROTEC_OFF 0 + +#define TROTEC_FAN_LOW 1 +#define TROTEC_FAN_MED 2 +#define TROTEC_FAN_HIGH 3 + +// Byte 3 +#define TROTEC_MIN_TEMP 18 +#define TROTEC_MAX_TEMP 32 +#define TROTEC_DEF_TEMP 25 + +#define TROTEC_SLEEP_ON 1 + +// Byte 5 +#define TROTEC_TIMER_ON 1 + +// Byte 6 +#define TROTEC_MIN_TIMER 0 +#define TROTEC_MAX_TIMER 23 + + +class IRTrotecESP { + public: + explicit IRTrotecESP(uint16_t pin); + +#if SEND_TROTEC + void send(); +#endif // SEND_TROTEC + void begin(); + + void setPower(bool state); + uint8_t getPower(); + + void setTemp(uint8_t temp); + uint8_t getTemp(); + + void setSpeed(uint8_t fan); + uint8_t getSpeed(); + + uint8_t getMode(); + void setMode(uint8_t mode); + + bool getSleep(); + void setSleep(bool sleep); + + uint8_t getTimer(); + void setTimer(uint8_t timer); + + uint8_t* getRaw(); + + private: + uint8_t trotec[TROTEC_COMMAND_LENGTH]; + void stateReset(); + void checksum(); + IRsend _irsend; +}; + +#endif // IR_TROTEC_H_ diff --git a/IRremoteESP8266/src/ir_Whynter.cpp b/IRremoteESP8266/src/ir_Whynter.cpp new file mode 100644 index 0000000..2306343 --- /dev/null +++ b/IRremoteESP8266/src/ir_Whynter.cpp @@ -0,0 +1,140 @@ +// Copyright 2009 Ken Shirriff +// Copyright 2017 David Conran + +#include +#include "IRrecv.h" +#include "IRsend.h" +#include "IRutils.h" + +// W W H H Y Y N N TTTTT EEEEE RRRRR +// W W H H Y Y NN N T E R R +// W W W HHHHH Y N N N T EEE RRRR +// W W W H H Y N NN T E R R +// WWW H H Y N N T EEEEE R R + +// Whynter A/C ARC-110WD added by Francesco Meschia +// Whynter originally added from https://github.com/shirriff/Arduino-IRremote/ + +// Constants +#define WHYNTER_TICK 50U +#define WHYNTER_HDR_MARK_TICKS 57U +#define WHYNTER_HDR_MARK (WHYNTER_HDR_MARK_TICKS * WHYNTER_TICK) +#define WHYNTER_HDR_SPACE_TICKS 57U +#define WHYNTER_HDR_SPACE (WHYNTER_HDR_SPACE_TICKS * \ + WHYNTER_TICK) +#define WHYNTER_BIT_MARK_TICKS 15U +#define WHYNTER_BIT_MARK (WHYNTER_BIT_MARK_TICKS * WHYNTER_TICK) +#define WHYNTER_ONE_SPACE_TICKS 43U +#define WHYNTER_ONE_SPACE (WHYNTER_ONE_SPACE_TICKS * \ + WHYNTER_TICK) +#define WHYNTER_ZERO_SPACE_TICKS 15U +#define WHYNTER_ZERO_SPACE (WHYNTER_ZERO_SPACE_TICKS * \ + WHYNTER_TICK) +#define WHYNTER_MIN_COMMAND_LENGTH_TICKS 2160U // Completely made up value. +#define WHYNTER_MIN_COMMAND_LENGTH (WHYNTER_MIN_COMMAND_LENGTH_TICKS * \ + WHYNTER_TICK) +#define WHYNTER_MIN_GAP_TICKS (WHYNTER_MIN_COMMAND_LENGTH_TICKS - \ + (2 * (WHYNTER_BIT_MARK_TICKS + WHYNTER_ZERO_SPACE_TICKS) + \ + WHYNTER_BITS * (WHYNTER_BIT_MARK_TICKS + WHYNTER_ONE_SPACE_TICKS))) +#define WHYNTER_MIN_GAP (WHYNTER_MIN_GAP_TICKS * WHYNTER_TICK) + +#if SEND_WHYNTER +// Send a Whynter message. +// +// Args: +// data: message to be sent. +// nbits: Nr. of bits of the message to be sent. +// repeat: Nr. of additional times the message is to be sent. +// +// Status: STABLE +// +// Ref: +// https://github.com/z3t0/Arduino-IRremote/blob/master/ir_Whynter.cpp +void IRsend::sendWhynter(uint64_t data, uint16_t nbits, uint16_t repeat) { + // Set IR carrier frequency + enableIROut(38); + + for (uint16_t i = 0; i <= repeat; i++) { + // (Pre-)Header + mark(WHYNTER_BIT_MARK); + space(WHYNTER_ZERO_SPACE); + sendGeneric(WHYNTER_HDR_MARK, WHYNTER_HDR_SPACE, + WHYNTER_BIT_MARK, WHYNTER_ONE_SPACE, + WHYNTER_BIT_MARK, WHYNTER_ZERO_SPACE, + WHYNTER_BIT_MARK, WHYNTER_MIN_GAP, + WHYNTER_MIN_COMMAND_LENGTH - (WHYNTER_BIT_MARK + + WHYNTER_ZERO_SPACE), + data, nbits, 38, true, 0, // Repeats are already handled. + 50); + } +} +#endif + +#if DECODE_WHYNTER +// Decode the supplied Whynter message. +// +// Args: +// results: Ptr to the data to decode and where to store the decode result. +// nbits: Nr. of data bits to expect. +// strict: Flag indicating if we should perform strict matching. +// Returns: +// boolean: True if it can decode it, false if it can't. +// +// Status: BETA Strict mode is ALPHA. +// +// Ref: +// https://github.com/z3t0/Arduino-IRremote/blob/master/ir_Whynter.cpp +bool IRrecv::decodeWhynter(decode_results *results, uint16_t nbits, + bool strict) { + if (results->rawlen < 2 * nbits + 2 * HEADER + FOOTER - 1) + return false; // We don't have enough entries to possibly match. + + // Compliance + if (strict && nbits != WHYNTER_BITS) + return false; // Incorrect nr. of bits per spec. + + uint16_t offset = OFFSET_START; + + // Header + // Sequence begins with a bit mark and a zero space. + // These are typically small, so we'll prefer to do the calibration + // on the much larger header mark & space that are next. + if (!matchMark(results->rawbuf[offset++], WHYNTER_BIT_MARK)) return false; + if (!matchSpace(results->rawbuf[offset++], WHYNTER_ZERO_SPACE)) return false; + // Main header mark and space + if (!matchMark(results->rawbuf[offset], WHYNTER_HDR_MARK)) return false; + // Calculate how long the common tick time is based on the header mark. + uint32_t m_tick = results->rawbuf[offset++] * RAWTICK / + WHYNTER_HDR_MARK_TICKS; + if (!matchSpace(results->rawbuf[offset], WHYNTER_HDR_SPACE)) return false; + // Calculate how long the common tick time is based on the header space. + uint32_t s_tick = results->rawbuf[offset++] * RAWTICK / + WHYNTER_HDR_SPACE_TICKS; + + // Data + uint64_t data = 0; + match_result_t data_result = matchData(&(results->rawbuf[offset]), nbits, + WHYNTER_BIT_MARK_TICKS * m_tick, + WHYNTER_ONE_SPACE_TICKS * s_tick, + WHYNTER_BIT_MARK_TICKS * m_tick, + WHYNTER_ZERO_SPACE_TICKS * s_tick); + if (data_result.success == false) return false; + data = data_result.data; + offset += data_result.used; + + // Footer + if (!matchMark(results->rawbuf[offset++], WHYNTER_BIT_MARK_TICKS * m_tick)) + return false; + if (offset < results->rawlen && + !matchAtLeast(results->rawbuf[offset], WHYNTER_MIN_GAP_TICKS * s_tick)) + return false; + + // Success + results->decode_type = WHYNTER; + results->bits = nbits; + results->value = data; + results->address = 0; + results->command = 0; + return true; +} +#endif diff --git a/PubSubClient.cpp b/PubSubClient.cpp new file mode 100755 index 0000000..5932bdb --- /dev/null +++ b/PubSubClient.cpp @@ -0,0 +1,588 @@ +/* + PubSubClient.cpp - A simple client for MQTT. + Nick O'Leary + http://knolleary.net +*/ + +#include "PubSubClient.h" +#include "Arduino.h" + +PubSubClient::PubSubClient() { + this->_state = MQTT_DISCONNECTED; + this->_client = NULL; + this->stream = NULL; + setCallback(NULL); +} + +PubSubClient::PubSubClient(Client& client) { + this->_state = MQTT_DISCONNECTED; + setClient(client); + this->stream = NULL; +} + +PubSubClient::PubSubClient(IPAddress addr, uint16_t port, Client& client) { + this->_state = MQTT_DISCONNECTED; + setServer(addr, port); + setClient(client); + this->stream = NULL; +} +PubSubClient::PubSubClient(IPAddress addr, uint16_t port, Client& client, Stream& stream) { + this->_state = MQTT_DISCONNECTED; + setServer(addr,port); + setClient(client); + setStream(stream); +} +PubSubClient::PubSubClient(IPAddress addr, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client) { + this->_state = MQTT_DISCONNECTED; + setServer(addr, port); + setCallback(callback); + setClient(client); + this->stream = NULL; +} +PubSubClient::PubSubClient(IPAddress addr, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client, Stream& stream) { + this->_state = MQTT_DISCONNECTED; + setServer(addr,port); + setCallback(callback); + setClient(client); + setStream(stream); +} + +PubSubClient::PubSubClient(uint8_t *ip, uint16_t port, Client& client) { + this->_state = MQTT_DISCONNECTED; + setServer(ip, port); + setClient(client); + this->stream = NULL; +} +PubSubClient::PubSubClient(uint8_t *ip, uint16_t port, Client& client, Stream& stream) { + this->_state = MQTT_DISCONNECTED; + setServer(ip,port); + setClient(client); + setStream(stream); +} +PubSubClient::PubSubClient(uint8_t *ip, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client) { + this->_state = MQTT_DISCONNECTED; + setServer(ip, port); + setCallback(callback); + setClient(client); + this->stream = NULL; +} +PubSubClient::PubSubClient(uint8_t *ip, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client, Stream& stream) { + this->_state = MQTT_DISCONNECTED; + setServer(ip,port); + setCallback(callback); + setClient(client); + setStream(stream); +} + +PubSubClient::PubSubClient(const char* domain, uint16_t port, Client& client) { + this->_state = MQTT_DISCONNECTED; + setServer(domain,port); + setClient(client); + this->stream = NULL; +} +PubSubClient::PubSubClient(const char* domain, uint16_t port, Client& client, Stream& stream) { + this->_state = MQTT_DISCONNECTED; + setServer(domain,port); + setClient(client); + setStream(stream); +} +PubSubClient::PubSubClient(const char* domain, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client) { + this->_state = MQTT_DISCONNECTED; + setServer(domain,port); + setCallback(callback); + setClient(client); + this->stream = NULL; +} +PubSubClient::PubSubClient(const char* domain, uint16_t port, MQTT_CALLBACK_SIGNATURE, Client& client, Stream& stream) { + this->_state = MQTT_DISCONNECTED; + setServer(domain,port); + setCallback(callback); + setClient(client); + setStream(stream); +} + +boolean PubSubClient::connect(const char *id) { + return connect(id,NULL,NULL,0,0,0,0); +} + +boolean PubSubClient::connect(const char *id, const char *user, const char *pass) { + return connect(id,user,pass,0,0,0,0); +} + +boolean PubSubClient::connect(const char *id, const char* willTopic, uint8_t willQos, boolean willRetain, const char* willMessage) { + return connect(id,NULL,NULL,willTopic,willQos,willRetain,willMessage); +} + +boolean PubSubClient::connect(const char *id, const char *user, const char *pass, const char* willTopic, uint8_t willQos, boolean willRetain, const char* willMessage) { + if (!connected()) { + int result = 0; + + if (domain != NULL) { + result = _client->connect(this->domain, this->port); + } else { + result = _client->connect(this->ip, this->port); + } + if (result == 1) { + nextMsgId = 1; + // Leave room in the buffer for header and variable length field + uint16_t length = 5; + unsigned int j; + +#if MQTT_VERSION == MQTT_VERSION_3_1 + uint8_t d[9] = {0x00,0x06,'M','Q','I','s','d','p', MQTT_VERSION}; +#define MQTT_HEADER_VERSION_LENGTH 9 +#elif MQTT_VERSION == MQTT_VERSION_3_1_1 + uint8_t d[7] = {0x00,0x04,'M','Q','T','T',MQTT_VERSION}; +#define MQTT_HEADER_VERSION_LENGTH 7 +#endif + for (j = 0;j>1); + } + } + + buffer[length++] = v; + + buffer[length++] = ((MQTT_KEEPALIVE) >> 8); + buffer[length++] = ((MQTT_KEEPALIVE) & 0xFF); + length = writeString(id,buffer,length); + if (willTopic) { + length = writeString(willTopic,buffer,length); + length = writeString(willMessage,buffer,length); + } + + if(user != NULL) { + length = writeString(user,buffer,length); + if(pass != NULL) { + length = writeString(pass,buffer,length); + } + } + + write(MQTTCONNECT,buffer,length-5); + + lastInActivity = lastOutActivity = millis(); + + while (!_client->available()) { + unsigned long t = millis(); + if (t-lastInActivity >= ((int32_t) MQTT_SOCKET_TIMEOUT*1000UL)) { + _state = MQTT_CONNECTION_TIMEOUT; + _client->stop(); + return false; + } + } + uint8_t llen; + uint16_t len = readPacket(&llen); + + if (len == 4) { + if (buffer[3] == 0) { + lastInActivity = millis(); + pingOutstanding = false; + _state = MQTT_CONNECTED; + return true; + } else { + _state = buffer[3]; + } + } + _client->stop(); + } else { + _state = MQTT_CONNECT_FAILED; + } + return false; + } + return true; +} + +// reads a byte into result +boolean PubSubClient::readByte(uint8_t * result) { + uint32_t previousMillis = millis(); + while(!_client->available()) { + uint32_t currentMillis = millis(); + if(currentMillis - previousMillis >= ((int32_t) MQTT_SOCKET_TIMEOUT * 1000)){ + return false; + } + } + *result = _client->read(); + return true; +} + +// reads a byte into result[*index] and increments index +boolean PubSubClient::readByte(uint8_t * result, uint16_t * index){ + uint16_t current_index = *index; + uint8_t * write_address = &(result[current_index]); + if(readByte(write_address)){ + *index = current_index + 1; + return true; + } + return false; +} + +uint16_t PubSubClient::readPacket(uint8_t* lengthLength) { + uint16_t len = 0; + if(!readByte(buffer, &len)) return 0; + bool isPublish = (buffer[0]&0xF0) == MQTTPUBLISH; + uint32_t multiplier = 1; + uint16_t length = 0; + uint8_t digit = 0; + uint16_t skip = 0; + uint8_t start = 0; + + do { + if(!readByte(&digit)) return 0; + buffer[len++] = digit; + length += (digit & 127) * multiplier; + multiplier *= 128; + } while ((digit & 128) != 0); + *lengthLength = len-1; + + if (isPublish) { + // Read in topic length to calculate bytes to skip over for Stream writing + if(!readByte(buffer, &len)) return 0; + if(!readByte(buffer, &len)) return 0; + skip = (buffer[*lengthLength+1]<<8)+buffer[*lengthLength+2]; + start = 2; + if (buffer[0]&MQTTQOS1) { + // skip message id + skip += 2; + } + } + + for (uint16_t i = start;istream) { + if (isPublish && len-*lengthLength-2>skip) { + this->stream->write(digit); + } + } + if (len < MQTT_MAX_PACKET_SIZE) { + buffer[len] = digit; + } + len++; + } + + if (!this->stream && len > MQTT_MAX_PACKET_SIZE) { + len = 0; // This will cause the packet to be ignored. + } + + return len; +} + +boolean PubSubClient::loop() { + if (connected()) { + unsigned long t = millis(); + if ((t - lastInActivity > MQTT_KEEPALIVE*1000UL) || (t - lastOutActivity > MQTT_KEEPALIVE*1000UL)) { + if (pingOutstanding) { + this->_state = MQTT_CONNECTION_TIMEOUT; + _client->stop(); + return false; + } else { + buffer[0] = MQTTPINGREQ; + buffer[1] = 0; + _client->write(buffer,2); + lastOutActivity = t; + lastInActivity = t; + pingOutstanding = true; + } + } + if (_client->available()) { + uint8_t llen; + uint16_t len = readPacket(&llen); + uint16_t msgId = 0; + uint8_t *payload; + if (len > 0) { + lastInActivity = t; + uint8_t type = buffer[0]&0xF0; + if (type == MQTTPUBLISH) { + if (callback) { + uint16_t tl = (buffer[llen+1]<<8)+buffer[llen+2]; /* topic length in bytes */ + memmove(buffer+llen+2,buffer+llen+3,tl); /* move topic inside buffer 1 byte to front */ + buffer[llen+2+tl] = 0; /* end the topic as a 'C' string with \x00 */ + char *topic = (char*) buffer+llen+2; + // msgId only present for QOS>0 + if ((buffer[0]&0x06) == MQTTQOS1) { + msgId = (buffer[llen+3+tl]<<8)+buffer[llen+3+tl+1]; + payload = buffer+llen+3+tl+2; + callback(topic,payload,len-llen-3-tl-2); + + buffer[0] = MQTTPUBACK; + buffer[1] = 2; + buffer[2] = (msgId >> 8); + buffer[3] = (msgId & 0xFF); + _client->write(buffer,4); + lastOutActivity = t; + + } else { + payload = buffer+llen+3+tl; + callback(topic,payload,len-llen-3-tl); + } + } + } else if (type == MQTTPINGREQ) { + buffer[0] = MQTTPINGRESP; + buffer[1] = 0; + _client->write(buffer,2); + } else if (type == MQTTPINGRESP) { + pingOutstanding = false; + } + } + } + return true; + } + return false; +} + +boolean PubSubClient::publish(const char* topic, const char* payload) { + return publish(topic,(const uint8_t*)payload,strlen(payload),false); +} + +boolean PubSubClient::publish(const char* topic, const char* payload, boolean retained) { + return publish(topic,(const uint8_t*)payload,strlen(payload),retained); +} + +boolean PubSubClient::publish(const char* topic, const uint8_t* payload, unsigned int plength) { + return publish(topic, payload, plength, false); +} + +boolean PubSubClient::publish(const char* topic, const uint8_t* payload, unsigned int plength, boolean retained) { + if (connected()) { + if (MQTT_MAX_PACKET_SIZE < 5 + 2+strlen(topic) + plength) { + // Too long + return false; + } + // Leave room in the buffer for header and variable length field + uint16_t length = 5; + length = writeString(topic,buffer,length); + uint16_t i; + for (i=0;i 0) { + digit |= 0x80; + } + buffer[pos++] = digit; + llen++; + } while(len>0); + + pos = writeString(topic,buffer,pos); + + rc += _client->write(buffer,pos); + + for (i=0;iwrite((char)pgm_read_byte_near(payload + i)); + } + + lastOutActivity = millis(); + + return rc == tlen + 4 + plength; +} + +boolean PubSubClient::write(uint8_t header, uint8_t* buf, uint16_t length) { + uint8_t lenBuf[4]; + uint8_t llen = 0; + uint8_t digit; + uint8_t pos = 0; + uint16_t rc; + uint16_t len = length; + do { + digit = len % 128; + len = len / 128; + if (len > 0) { + digit |= 0x80; + } + lenBuf[pos++] = digit; + llen++; + } while(len>0); + + buf[4-llen] = header; + for (int i=0;i 0) && result) { + bytesToWrite = (bytesRemaining > MQTT_MAX_TRANSFER_SIZE)?MQTT_MAX_TRANSFER_SIZE:bytesRemaining; + rc = _client->write(writeBuf,bytesToWrite); + result = (rc == bytesToWrite); + bytesRemaining -= rc; + writeBuf += rc; + } + return result; +#else + rc = _client->write(buf+(4-llen),length+1+llen); + lastOutActivity = millis(); + return (rc == 1+llen+length); +#endif +} + +boolean PubSubClient::subscribe(const char* topic) { + return subscribe(topic, 0); +} + +boolean PubSubClient::subscribe(const char* topic, uint8_t qos) { + if (qos < 0 || qos > 1) { + return false; + } + if (MQTT_MAX_PACKET_SIZE < 9 + strlen(topic)) { + // Too long + return false; + } + if (connected()) { + // Leave room in the buffer for header and variable length field + uint16_t length = 5; + nextMsgId++; + if (nextMsgId == 0) { + nextMsgId = 1; + } + buffer[length++] = (nextMsgId >> 8); + buffer[length++] = (nextMsgId & 0xFF); + length = writeString((char*)topic, buffer,length); + buffer[length++] = qos; + return write(MQTTSUBSCRIBE|MQTTQOS1,buffer,length-5); + } + return false; +} + +boolean PubSubClient::unsubscribe(const char* topic) { + if (MQTT_MAX_PACKET_SIZE < 9 + strlen(topic)) { + // Too long + return false; + } + if (connected()) { + uint16_t length = 5; + nextMsgId++; + if (nextMsgId == 0) { + nextMsgId = 1; + } + buffer[length++] = (nextMsgId >> 8); + buffer[length++] = (nextMsgId & 0xFF); + length = writeString(topic, buffer,length); + return write(MQTTUNSUBSCRIBE|MQTTQOS1,buffer,length-5); + } + return false; +} + +void PubSubClient::disconnect() { + buffer[0] = MQTTDISCONNECT; + buffer[1] = 0; + _client->write(buffer,2); + _state = MQTT_DISCONNECTED; + _client->stop(); + lastInActivity = lastOutActivity = millis(); +} + +uint16_t PubSubClient::writeString(const char* string, uint8_t* buf, uint16_t pos) { + const char* idp = string; + uint16_t i = 0; + pos += 2; + while (*idp) { + buf[pos++] = *idp++; + i++; + } + buf[pos-i-2] = (i >> 8); + buf[pos-i-1] = (i & 0xFF); + return pos; +} + + +boolean PubSubClient::connected() { + boolean rc; + if (_client == NULL ) { + rc = false; + } else { + rc = (int)_client->connected(); + if (!rc) { + if (this->_state == MQTT_CONNECTED) { + this->_state = MQTT_CONNECTION_LOST; + _client->flush(); + _client->stop(); + } + } + } + return rc; +} + +PubSubClient& PubSubClient::setServer(uint8_t * ip, uint16_t port) { + IPAddress addr(ip[0],ip[1],ip[2],ip[3]); + return setServer(addr,port); +} + +PubSubClient& PubSubClient::setServer(IPAddress ip, uint16_t port) { + this->ip = ip; + this->port = port; + this->domain = NULL; + return *this; +} + +PubSubClient& PubSubClient::setServer(const char * domain, uint16_t port) { + this->domain = domain; + this->port = port; + return *this; +} + +PubSubClient& PubSubClient::setCallback(MQTT_CALLBACK_SIGNATURE) { + this->callback = callback; + return *this; +} + +PubSubClient& PubSubClient::setClient(Client& client){ + this->_client = &client; + return *this; +} + +PubSubClient& PubSubClient::setStream(Stream& stream){ + this->stream = &stream; + return *this; +} + +int PubSubClient::state() { + return this->_state; +} diff --git a/PubSubClient.h b/PubSubClient.h new file mode 100755 index 0000000..257bc6b --- /dev/null +++ b/PubSubClient.h @@ -0,0 +1,144 @@ +/* + PubSubClient.h - A simple client for MQTT. + Nick O'Leary + http://knolleary.net +*/ + +#ifndef PubSubClient_h +#define PubSubClient_h + +#include +#include "IPAddress.h" +#include "Client.h" +#include "Stream.h" + +#define MQTT_VERSION_3_1 3 +#define MQTT_VERSION_3_1_1 4 + +// MQTT_VERSION : Pick the version +//#define MQTT_VERSION MQTT_VERSION_3_1 +#ifndef MQTT_VERSION +#define MQTT_VERSION MQTT_VERSION_3_1_1 +#endif + +// MQTT_MAX_PACKET_SIZE : Maximum packet size +#ifndef MQTT_MAX_PACKET_SIZE +#define MQTT_MAX_PACKET_SIZE 600 +#endif + +// MQTT_KEEPALIVE : keepAlive interval in Seconds +#ifndef MQTT_KEEPALIVE +#define MQTT_KEEPALIVE 15 +#endif + +// MQTT_SOCKET_TIMEOUT: socket timeout interval in Seconds +#ifndef MQTT_SOCKET_TIMEOUT +#define MQTT_SOCKET_TIMEOUT 15 +#endif + +// MQTT_MAX_TRANSFER_SIZE : limit how much data is passed to the network client +// in each write call. Needed for the Arduino Wifi Shield. Leave undefined to +// pass the entire MQTT packet in each write call. +//#define MQTT_MAX_TRANSFER_SIZE 80 + +// Possible values for client.state() +#define MQTT_CONNECTION_TIMEOUT -4 +#define MQTT_CONNECTION_LOST -3 +#define MQTT_CONNECT_FAILED -2 +#define MQTT_DISCONNECTED -1 +#define MQTT_CONNECTED 0 +#define MQTT_CONNECT_BAD_PROTOCOL 1 +#define MQTT_CONNECT_BAD_CLIENT_ID 2 +#define MQTT_CONNECT_UNAVAILABLE 3 +#define MQTT_CONNECT_BAD_CREDENTIALS 4 +#define MQTT_CONNECT_UNAUTHORIZED 5 + +#define MQTTCONNECT 1 << 4 // Client request to connect to Server +#define MQTTCONNACK 2 << 4 // Connect Acknowledgment +#define MQTTPUBLISH 3 << 4 // Publish message +#define MQTTPUBACK 4 << 4 // Publish Acknowledgment +#define MQTTPUBREC 5 << 4 // Publish Received (assured delivery part 1) +#define MQTTPUBREL 6 << 4 // Publish Release (assured delivery part 2) +#define MQTTPUBCOMP 7 << 4 // Publish Complete (assured delivery part 3) +#define MQTTSUBSCRIBE 8 << 4 // Client Subscribe request +#define MQTTSUBACK 9 << 4 // Subscribe Acknowledgment +#define MQTTUNSUBSCRIBE 10 << 4 // Client Unsubscribe request +#define MQTTUNSUBACK 11 << 4 // Unsubscribe Acknowledgment +#define MQTTPINGREQ 12 << 4 // PING Request +#define MQTTPINGRESP 13 << 4 // PING Response +#define MQTTDISCONNECT 14 << 4 // Client is Disconnecting +#define MQTTReserved 15 << 4 // Reserved + +#define MQTTQOS0 (0 << 1) +#define MQTTQOS1 (1 << 1) +#define MQTTQOS2 (2 << 1) + +#ifdef ESP8266 +#include +#define MQTT_CALLBACK_SIGNATURE std::function callback +#else +#define MQTT_CALLBACK_SIGNATURE void (*callback)(char*, uint8_t*, unsigned int) +#endif + +class PubSubClient { +private: + Client* _client; + uint8_t buffer[MQTT_MAX_PACKET_SIZE]; + uint16_t nextMsgId; + unsigned long lastOutActivity; + unsigned long lastInActivity; + bool pingOutstanding; + MQTT_CALLBACK_SIGNATURE; + uint16_t readPacket(uint8_t*); + boolean readByte(uint8_t * result); + boolean readByte(uint8_t * result, uint16_t * index); + boolean write(uint8_t header, uint8_t* buf, uint16_t length); + uint16_t writeString(const char* string, uint8_t* buf, uint16_t pos); + IPAddress ip; + const char* domain; + uint16_t port; + Stream* stream; + int _state; +public: + PubSubClient(); + PubSubClient(Client& client); + PubSubClient(IPAddress, uint16_t, Client& client); + PubSubClient(IPAddress, uint16_t, Client& client, Stream&); + PubSubClient(IPAddress, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client); + PubSubClient(IPAddress, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client, Stream&); + PubSubClient(uint8_t *, uint16_t, Client& client); + PubSubClient(uint8_t *, uint16_t, Client& client, Stream&); + PubSubClient(uint8_t *, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client); + PubSubClient(uint8_t *, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client, Stream&); + PubSubClient(const char*, uint16_t, Client& client); + PubSubClient(const char*, uint16_t, Client& client, Stream&); + PubSubClient(const char*, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client); + PubSubClient(const char*, uint16_t, MQTT_CALLBACK_SIGNATURE,Client& client, Stream&); + + PubSubClient& setServer(IPAddress ip, uint16_t port); + PubSubClient& setServer(uint8_t * ip, uint16_t port); + PubSubClient& setServer(const char * domain, uint16_t port); + PubSubClient& setCallback(MQTT_CALLBACK_SIGNATURE); + PubSubClient& setClient(Client& client); + PubSubClient& setStream(Stream& stream); + + boolean connect(const char* id); + boolean connect(const char* id, const char* user, const char* pass); + boolean connect(const char* id, const char* willTopic, uint8_t willQos, boolean willRetain, const char* willMessage); + boolean connect(const char* id, const char* user, const char* pass, const char* willTopic, uint8_t willQos, boolean willRetain, const char* willMessage); + void disconnect(); + boolean publish(const char* topic, const char* payload); + boolean publish(const char* topic, const char* payload, boolean retained); + boolean publish(const char* topic, const uint8_t * payload, unsigned int plength); + boolean publish(const char* topic, const uint8_t * payload, unsigned int plength, boolean retained); + boolean publish_P(const char* topic, const uint8_t * payload, unsigned int plength, boolean retained); + boolean subscribe(const char* topic); + boolean subscribe(const char* topic, uint8_t qos); + boolean unsubscribe(const char* topic); + boolean loop(); + boolean connected(); + int state(); +}; + + +#endif diff --git a/README.md b/README.md new file mode 100644 index 0000000..6a69265 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# MQTT to IR + +## Description + +This piece of garbage receives commands via mqtt and emits NEC decoded commands via IR diode. It also reads IR signals with some sensor (TSOP38xxx) and sends its NEC code via MQTT for easy recording of some ancient remote, you don't have any information about. + +## Hardware + + - Wemos D1 Mini + - IR Receiver Diode TSOP38238 + - Some IR Diode + +## Used Software + +Heavily based on https://github.com/markszabo/IRremoteESP8266 + diff --git a/case.scad b/case.scad new file mode 100644 index 0000000..3ef49b1 --- /dev/null +++ b/case.scad @@ -0,0 +1,33 @@ +$fn = 200; + +cube([40,30,2]); +difference(){ + translate([0,0,15]){ + cube([40,30,2]); + } + translate([25+5+2,5+2,15]){ + //cube([5,5,2]); + cylinder(h=2,r=3); + } + translate([25+2.5,20,15]){ + cube([7,5,2]); + //cylinder(h=2,r=2.5); + } +} + +cube([40,2,15]); +translate([0,28,0]){ + cube([40,2,15]); +} +difference(){ + cube([2,30,15]); + translate([0,7.5,4.5]){ + cube([4,15,6]); + } +} +translate([2,2, 22]){ + cube([2,26,13]); +} +translate([0,0, 20]){ + cube([2,30,17]); +} diff --git a/mqtt_ir.ino b/mqtt_ir.ino new file mode 100644 index 0000000..39a1eea --- /dev/null +++ b/mqtt_ir.ino @@ -0,0 +1,175 @@ + +#include +#include +#include +#include +#include +#include +#include +//#include +#define IRLED_PIN 4 +#define RECV_PIN 5 +#define TOPIC "foobar/aerie/lounge/hifi" +// Update these with values suitable for your network. + +const char* ssid = "foobar"; +const char* password = ""; +const char* mqtt_server = "10.42.0.244"; + +IRsend irsend(IRLED_PIN); +IRrecv irrecv(RECV_PIN); //1024, 15U, true); +WiFiClient espClient; +PubSubClient client(espClient); +long lastMsg = 0; +char msg[50]; +int value = 0; + +void setup_wifi() { + + delay(10); + // We start by connecting to a WiFi network + Serial.println(); + Serial.print("Connecting to "); + Serial.println(ssid); + + WiFi.begin(ssid, password); + + while (WiFi.status() != WL_CONNECTED) { + delay(500); + Serial.print("."); + } + + Serial.println("Connected!"); + + randomSeed(micros()); +/* + Serial.println(""); + Serial.println("WiFi connected"); + Serial.println("IP address: "); + Serial.println(WiFi.localIP()); + */ +} + +uint16_t input[100] = {0}; + +int check(char * buf, int length){ + char * a = buf; + for (;a-buf < length;a++){ + Serial.println(a); + if (*a >= 58 || *a <= 47) + return 0; + } + return 1; +} + +int checkHex(char * buf, int length){ + char * a = buf; + for (;a-buf < length;a++){ + //Serial.println(a); + if (!(*a < 58 && *a > 47 || *a > 64 && *a < 71 || *a > 96 && *a < 103)) + return 0; + } + return 1; +} + +void callback(char* topic, byte* p, unsigned int length) { + char *payload = (char *)p; + + if ( length >= 6 ){ + + if ( strncmp(payload, "beamer", 6) == 0){ + irsend.sendNEC(0x5ea1936cUL,32); + } + if ( strncmp(payload, "lauter", 6) == 0){ + irsend.sendNEC(0x5EA158A7UL,32); + } + if ( strncmp(payload, "leiser", 6) == 0){ + irsend.sendNEC(0x5EA1D827UL,32); + } + } + + if ( length >= 7 ){ + if ( strncmp(payload, "standby", 7) == 0){ + irsend.sendNEC(0x7E81FE01UL,32); + } + } + if ( length >= 5 ){ + if ( strncmp(payload, "power", 5) == 0){ + irsend.sendNEC(0x7e817e81UL,32); + } + } + if ( length >= 3 ){ + if ( strncmp(payload, "dvd", 3) == 0){ + irsend.sendNEC(0x5ea1837cUL,32); + } + if ( strncmp(payload, "mpd", 3) == 0){ + irsend.sendNEC(0x5ea1c837UL, 32); + } + if ( strncmp(payload, "dtv", 3) == 0){ + irsend.sendNEC(0x5ea12ad5UL,32); + } + } + + if ( length > 11 && strncmp(payload, "nec:", 4) == 0){ //custom:9999 FF + //Serial.println("Custom0"); + if ( checkHex(payload+4, 8)){ + char *start = payload + 4; + char *end = payload + 7 + 4; + *(end+1) = ' '; + unsigned int nec_code = strtoul (start, &end, 16); + irsend.sendNEC(nec_code, 32); + char buff[20]; + char * pos = buff; + Serial.println(nec_code); + pos += sprintf(pos, "%s","Sent NEC Code: "); + pos += sprintf(pos, "%X", nec_code); + Serial.println(buff); + client.publish(TOPIC, buff); + } + } +} + +void reconnect() { + while (!client.connected()) { + String clientId = "HIFI LOUNGE CTRL"; + clientId += String(random(0xffff), HEX); + if (client.connect(clientId.c_str())) { + client.publish(TOPIC, "HIFI Control Online"); + client.subscribe(TOPIC); + } else { + delay(5000); + } + } +} + +void setup() { + pinMode(IRLED_PIN, OUTPUT); + digitalWrite(IRLED_PIN, LOW); // Turn the LED on (Note that LOW is the voltage level// Initialize the BUILTIN_LED pin as an output + Serial.begin(115200); + setup_wifi(); + client.setServer(mqtt_server, 1883); + client.setCallback(callback); + irrecv.enableIRIn(); // Start the receiver +} + +decode_results results; +void loop() { + + if (!client.connected()) { + reconnect(); + } + client.loop(); + + if (irrecv.decode(&results)) { + Serial.println("entered irrecv decoding phase"); + if (results.overflow){ + client.publish(TOPIC, "Parsing failed!"); + } else { + char msg_buf[51] = "32bit Representation NEC Code:\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"; + itoa(results.value, (msg_buf+30), 16); + serialPrintUint64(results.value, HEX); + client.publish(TOPIC, msg_buf); + } + irrecv.resume(); + } +}