Initial import. master
authorNot Zed <notzed@gmail.com>
Mon, 8 Jul 2024 02:48:13 +0000 (12:18 +0930)
committerNot Zed <notzed@gmail.com>
Mon, 8 Jul 2024 02:48:13 +0000 (12:18 +0930)
CMakeLists.txt [new file with mode: 0644]
COPYING [new file with mode: 0644]
README [new file with mode: 0644]
esp-ld2410.c [new file with mode: 0644]
include/esp-ld2410.h [new file with mode: 0644]

diff --git a/CMakeLists.txt b/CMakeLists.txt
new file mode 100644 (file)
index 0000000..928d853
--- /dev/null
@@ -0,0 +1,3 @@
+idf_component_register(SRCS "esp-ld2410.c"
+                    INCLUDE_DIRS "include"
+                   REQUIRES esp_driver_gpio esp_driver_uart)
diff --git a/COPYING b/COPYING
new file mode 100644 (file)
index 0000000..94a9ed0
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, 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
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If 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 convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU 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
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..8ab6829
--- /dev/null
+++ b/README
@@ -0,0 +1,114 @@
+
+
+Copyright (C) 2024 Michael Zucchi
+
+See the section LICENSE for details.
+
+Introduction
+------------
+
+esp-ld2410 is a serial driver for the HiLink HLK-LD2410C human sensing
+radar module.
+
+Compile
+-------
+
+This is an esp-idf component which needs to be copied to the
+components directory of your project or otherwise referenced by the
+esp-idf build system for your project.
+
+Then add REQUIRES esp-ld2410 to idf_component_register() for the
+project.
+
+Usage
+-----
+
+The header file is relatively self explanatory but to get started:
+
+  #include <esp-ld2410.h>
+
+  // Initialise device on UART 1 using
+  //  Default factory baudrate (256000)
+  //  GPIO_NUM_1 for txd (connected to module rxd),
+  /   GPIO_NUM_0 for rxd (connected to module txd),
+  //  No digital signal
+  ld2410_driver_install(UART_NUM_1, LD2410_BAUDRATE_DEFAULT, GPIO_NUM_1, GPIO_NUM_0, GPIO_NUM_NC);
+
+  // enable full-data (engineering) mode
+  ld2410_set_full_mode(UART_NUM_1);
+
+  // Retrieve and print data.
+  // It may take a little while for data to be valid.
+  while (1) {
+    const struct ld2410_full_t *data = ld2410_get_full_data(UART_NUM_1);
+
+    printf(" detected: %s %s\n",
+      data->status & LD2410_STATUS_MOVE ? "moving" : "",
+      data->status & LD2410_STATUS_REST ? "resting" : "");
+    vTaskDelay(pdMS_TO_TICKS(1000));
+  }
+
+Internals
+---------
+
+A single task is used to monitor the serial port(s) and accept queries
+and commands from multiple tasks.  It is started and deleted as
+necessary.
+
+A couple of state machines track the protocol and command requests.
+Command mode is entered into and left automatically as required and
+isn't needed for every configuration command or query.
+
+The data frames are passively collected when not processing commands.
+
+Status
+------
+
+Only tested with the LD2410C module but it should presumably work with
+the others with firmware implementing the version 1 protocol.
+
+Only tested with an ESP32C3.
+
+Everything apart from the bluetooth related commands has been
+implemented.  Multiple devices are supported if your esp device has
+multiple available serial ports.  The digital signal pin can also
+be queried if it is connected.
+
+Startup and device restart should be handled gracefully but a baudrate
+change and restart should be proceeded by a device close and re-open.
+
+I made some minor changes to the naming used in the documentation -
+which was inconsistent and not particularly great.
+
+Links
+-----
+
+* esp-ld2410     <https://www.zedzone.au/software/esp-ld2410.html>
+  browse source  <https://code.zedzone.au/cvs?p=esp-ld2410&a=tree>
+  source code    <https://code.zedzone.au/git/esp-ld2410>
+
+* esp-idf        <https://github.com/espressif/esp-idf>
+
+* LD2410C module <https://www.hlktech.net/index.php?id=1095>
+
+LICENSE
+-------
+
+This code is licensed under GNU General Public License version
+3, see COPYING for the full details.
+
+    Copyright (C) 2024 Michael Zucchi
+
+    This program is free software: you can redistribute it and/or
+    modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation, either version 3 of the
+    License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see
+    <http://www.gnu.org/licenses/>.
diff --git a/esp-ld2410.c b/esp-ld2410.c
new file mode 100644 (file)
index 0000000..4c1e2ef
--- /dev/null
@@ -0,0 +1,675 @@
+/*
+ * Copyright (C) 2024 Michael Zucchi
+ *
+ * This file is part of esp-ld2410 <https://www.zedzone.au/software/esp-ld2410.html>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <stdio.h>
+#include <stdint.h>
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "esp_system.h"
+#include "esp_log.h"
+#include "driver/uart.h"
+#include "string.h"
+#include "driver/gpio.h"
+
+#include "esp-ld2410.h"
+
+/*
+  Summary of version 1 protocol for LD2410C.
+
+  Simple req/ack commands with no parameters
+
+    req: start length=0002 cmd=00xx end
+    ack: start length=0004 cmd=xx01 status=0000 end
+
+  end command mode             0x00fe
+  enter engineering mode       0x0062
+  leave engineering mode       0x0063
+  restore factory settings     0x00a2
+  restart                      0x00a3
+
+  others
+
+  enter command mode           0x00ff
+
+    req: start length=0004 cmd=00ff value=0001 end
+    ack: start length=0008 cmd=01ff status=0000 version=0001 buffer=0040 end
+
+    If the length is 0002 then it seems to initiate version 0 of the protocol which isn't documented.
+
+    version 0 req: start length=0002 cmd=00ff  end
+    version 0 ack: start length=0008 cmd=01ff status=0000 end
+
+  set parameters               0x0060
+  persistent
+
+    req: start length=0014 cmd=0060 move=0000 value=xxxxxxxx stat=0001 threshold=xxxxxxxx duration=0002 threshold=xxxxxxxx end
+    ack: standard
+
+  get parameters               0x0061
+
+    req: standard
+    ack: start length=001c cmd=0161 status=0000
+      head=aa
+      max_gate=08
+      max_move=08
+      max_stat=08
+      move_sensitivity[9]=xx xx xx xx xx xx xx xx xx
+      stat_sensitivity[9]=xx xx xx xx xx xx xx xx xx
+      idle_time=xxxx
+
+  configure threshold          0x0064
+  configure distance 'value' to move/stat sensitivity, 0xffff sets all
+
+    req: start length=0014 cmd=0064 dist=0000 value=xxxxxxxx move=0001 threshold=xxxxxxxx stat=0002 threshold=xxxxxxxx end
+    ack: standard
+
+  read firmware version                0x00a0
+
+    req: standard
+    ack: start length=000c status=0000 type=0001 maj=xxxx min=xxxxxxxx end
+
+    version 0 ack: start length=000c type=0100 maj=xxxx min=xxxxxxxx end
+
+  set baud rate                        0x00a1
+  rate:
+    0001         9600
+    0002        19200
+    0003        38400
+    0004        57600
+    0005       115200
+    0006       230400
+    0007       256000
+    0008       460800
+
+  persistent, takes effect after restart
+
+    req: start length=0004 cmd=00a1 rate=xxxx end
+    ack: standard
+
+  enable bluetooth             0x00a4
+  takes effect after restart
+
+    req: start length=0004 cmd=00a4 state=000x end
+    ack: standard
+
+  get bluetooth mac address    0x00a5
+
+    req: start length=0004 cmd=00a5 value=0001 end
+    ack: start length=000a cmd=01a5 status=0000 mac=xx:xx:xx:xx:xx:xx end
+
+  set bluetooth password       0x00a9
+
+    req: start length=0008 cmd=00a9 passwd=xxxx:xxxx:xxxx end
+    ack: standard
+
+  set distance resolution      0x00aa
+  persistant, takes effect after restart
+  resolution
+   0000        0.75m
+   0001 0.20m
+
+    req: start length=0004 cmd=00aa res=000x end
+    ack: standard (the manual is in error)
+
+  query distance resolution    0x00ab
+
+    req: standard
+    ack: start length=0006 cmd=01ab status=0000 res=000x end
+
+ */
+
+#include "esp-ld2410.h"
+
+const uint8_t cmd_pre[] = { 0xfd, 0xfc, 0xfb, 0xfa };
+const uint8_t cmd_pos[] = { 0x04, 0x03, 0x02, 0x01 };
+const uint8_t cmd_con[] = { 0x04, 0x00, 0xff, 0x00, 0x01, 0x00 };
+const uint8_t cmd_end[] = { 0x02, 0x00, 0xfe, 0x00 };
+
+union head {
+       struct {
+               uint32_t tag;
+               uint16_t size;
+       };
+       uint8_t raw[6];
+};
+
+union tail {
+       uint32_t tag;
+       uint8_t raw[4];
+};
+
+/* Internal state */
+
+/* State of protocol */
+enum protocol_state_t {
+       PROT_DISABLED = 0,
+       PROT_HEAD,
+       PROT_DATA,
+       PROT_TAIL
+};
+
+/* State of a command request */
+enum command_state_t {
+       CMD_RESTART = 0,
+       CMD_IDLE,
+       CMD_ENABLE,
+       CMD_REQUEST,
+       CMD_READY,
+       CMD_DISABLE
+};
+
+struct request {
+       TaskHandle_t task;
+       struct ld2410_ack_t *ack;
+       struct ld2410_req_t req;
+};
+
+/* This is only written to by driver_install and the daemon task */
+struct radar_state {
+       // uart_port_t port; // implied
+       int dig_pin;            // gpio pin if digital presense signal is connected
+
+       // Input processing
+       enum protocol_state_t state;
+       int pos;
+
+       union head head;
+       union tail tail;
+       union {
+               struct ld2410_ack_t ack;
+               struct ld2410_base_t base;
+               struct ld2410_full_t full;
+               uint8_t raw[64];
+       } msg;
+
+       // Commands
+       QueueHandle_t queue;
+       struct request *cmd;
+       enum command_state_t cmd_state;
+       int cmd_ticks;
+
+       // Last valid data message
+       union {
+               struct ld2410_base_t base;
+               struct ld2410_full_t full;
+       } info;
+};
+
+static struct radar_state radars[UART_NUM_MAX];
+static volatile uint32_t daemon_running = 0;
+
+static void ld2410_task(void *arg);
+
+static const char *TAG = "ld2410";
+
+static const int baudrates[] = {
+       9600,
+       19200,
+       38400,
+       57600,
+       115200,
+       230400,
+       256000,
+       460800
+};
+
+int ld2410_driver_install(uart_port_t port, enum ld2410_baudrate_t baudrate, gpio_num_t tx_pin, gpio_num_t rx_pin, gpio_num_t dig_pin) {
+       const uart_config_t uart_config = {
+               .baud_rate = baudrates[baudrate - 1],
+               .data_bits = UART_DATA_8_BITS,
+               .parity = UART_PARITY_DISABLE,
+               .stop_bits = UART_STOP_BITS_1,
+               .flow_ctrl = UART_HW_FLOWCTRL_DISABLE,
+               .source_clk = UART_SCLK_DEFAULT,
+       };
+
+       uart_driver_install(port, 256, 0, 0, NULL, 0);
+       uart_param_config(port, &uart_config);
+       uart_set_pin(port, tx_pin, rx_pin, UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE);
+
+       if (dig_pin != GPIO_NUM_NC) {
+               gpio_reset_pin(dig_pin);
+               gpio_set_direction(dig_pin, GPIO_MODE_INPUT);
+               gpio_set_pull_mode(dig_pin, GPIO_PULLUP_ONLY);
+       }
+
+       radars[port].dig_pin = dig_pin;
+       radars[port].queue = xQueueCreate(8, sizeof(struct request *));
+       radars[port].state = PROT_HEAD;
+       radars[port].cmd_state = CMD_RESTART;
+       if (esp_cpu_compare_and_set(&daemon_running, 0, 1)) {
+               esp_log_level_set(TAG, ESP_LOG_INFO);
+
+               if (xTaskCreate(ld2410_task, TAG, 2048, NULL, configMAX_PRIORITIES - 1, NULL) != pdPASS) {
+                       daemon_running = 0;
+                       ESP_LOGE(TAG, "Unable to start daemon");
+                       vQueueDelete(radars[port].queue);
+                       radars[port].queue = NULL;
+                       radars[port].state = PROT_DISABLED;
+                       return 1;
+               }
+       }
+
+       return 0;
+}
+
+void ld2410_driver_delete(uart_port_t port) {
+       struct request *req = NULL;
+
+       // send a NULL command
+       xQueueSendToBack(radars[port].queue, &req, portMAX_DELAY);
+}
+
+const struct ld2410_base_t *ld2410_get_base_data(uart_port_t port) {
+       return &radars[port].info.base;
+}
+
+const struct ld2410_full_t *ld2410_get_full_data(uart_port_t port) {
+       return &radars[port].info.full;
+}
+
+int ld2410_get_detected(uart_port_t port) {
+       if (radars[port].dig_pin != GPIO_NUM_NC)
+               return gpio_get_level(radars[port].dig_pin);
+       return 0;
+}
+
+static int command_send(uart_port_t port, struct request *req) {
+       req->task = xTaskGetCurrentTaskHandle();
+
+       ESP_LOGD(TAG, "send command %02x %p", req->req.cmd, req);
+       xQueueSendToBack(radars[port].queue, &req, portMAX_DELAY);
+       ulTaskNotifyTake(pdTRUE, portMAX_DELAY);
+       ESP_LOGD(TAG, "ack received: %02x", req->req.cmd);
+
+       return req->ack->status;
+}
+
+static int command_simple(uart_port_t port, uint16_t cmd, struct ld2410_ack_t *ack) {
+       struct request req = {
+               .req.cmd = cmd,
+               .req.size = 2,
+               .ack = ack,
+       };
+
+       return command_send(port, &req);
+}
+
+static int command_empty(uart_port_t port, uint16_t cmd) {
+       int res;
+       struct ld2410_ack_t ack;
+
+       res = command_simple(port, cmd,  &ack);
+
+       return res;
+}
+
+int ld2410_set_range(uart_port_t port, uint32_t move_max, uint32_t rest_max, uint32_t idle_time) {
+       struct ld2410_ack_t ack;
+       struct request req = {
+               .req.cmd = 0x60,
+               .req.size = sizeof(req.req.range) + 2,
+               .req.range.move_key = 0x0000,
+               .req.range.move_max = move_max,
+               .req.range.rest_key = 0x0001,
+               .req.range.rest_max = rest_max,
+               .req.range.idle_key = 0x0002,
+               .req.range.idle_time = idle_time,
+               .ack = &ack
+       };
+
+       return command_send(port, &req);
+}
+
+int ld2410_set_parameter(uart_port_t port, uint32_t dist, uint32_t move, uint32_t rest) {
+       struct ld2410_ack_t ack;
+       struct request req = {
+               .req.cmd = 0x64,
+               .req.size = sizeof(req.req.parameter) + 2,
+               .req.parameter.dist_key = 0x0000,
+               .req.parameter.dist = dist,
+               .req.parameter.move_key = 0x0001,
+               .req.parameter.move = move,
+               .req.parameter.rest_key = 0x0002,
+               .req.parameter.rest = rest,
+               .ack = &ack
+       };
+
+       return command_send(port, &req);
+}
+
+int ld2410_get_parameters(uart_port_t port, struct ld2410_parameters_t *params) {
+       int res;
+       struct ld2410_ack_t ack;
+
+       command_simple(port, 0x61,  &ack);
+       res = (ack.status != 0x0000);
+       if (res == 0)
+               *params = ack.params;
+
+       return res;
+}
+
+int ld2410_set_baudrate(uart_port_t port, enum ld2410_baudrate_t rate) {
+       struct ld2410_ack_t ack;
+       struct request req = {
+               .req.cmd = 0xa1,
+               .req.size = sizeof(req.req.baudrate) + 2,
+               .req.baudrate.rate = rate,
+               .ack = &ack
+       };
+
+       return command_send(port, &req);
+}
+
+int ld2410_get_version(uart_port_t port, struct ld2410_version_t *version) {
+       int res;
+       struct ld2410_ack_t ack;
+
+       command_simple(port, 0xa0,  &ack);
+       res = (ack.status != 0x0000);
+       if (res == 0)
+               *version = ack.version;
+
+       return res;
+}
+
+int ld2410_set_resolution(uart_port_t port, enum ld2410_resolution_t resolution) {
+       struct ld2410_ack_t ack;
+       struct request req = {
+               .req.cmd = 0xaa,
+               .req.size = 0x0004,
+               .req.resolution.value = resolution,
+               .ack = &ack
+       };
+
+       return command_send(port, &req);
+}
+
+int ld2410_get_resolution(uart_port_t port, enum ld2410_resolution_t *resolution) {
+       int res;
+       struct ld2410_ack_t ack;
+
+       command_simple(port, 0xab,  &ack);
+       res = (ack.status != 0x0000);
+       if (res == 0)
+               *resolution = ack.resolution.value;
+
+       return res;
+}
+
+int ld2410_set_full_mode(uart_port_t port) {
+       return command_empty(port, 0x62);
+}
+
+int ld2410_set_basic_mode(uart_port_t port) {
+       return command_empty(port, 0x63);
+}
+
+int ld2410_factory_reset(uart_port_t port) {
+       return command_empty(port, 0xa2);
+}
+
+int ld2410_restart(uart_port_t port) {
+       return command_empty(port, 0xa3);
+}
+
+/*
+  Command state machine
+
+  IDLE -> ENABLE                       command from queue, requst command mode
+    ENABLE -> REQUEST                  command mode on, send command request
+      REQUEST -> READY                 ack received, wait for more
+        READY -> REQUEST               command from queue, send command request
+        READY -> DISABLE               command queue timeout, request data mode
+    DISABLE -> IDLE                    command mode exit
+ */
+
+static int command_write(uart_port_t port, const void *data, int size) {
+       int res;
+
+       res = uart_write_bytes(port, cmd_pre, sizeof(cmd_pre));
+       res = uart_write_bytes(port, data, size);
+       res = uart_write_bytes(port, cmd_pos, sizeof(cmd_pos));
+
+       ESP_LOGD(TAG, "command write:");
+       ESP_LOG_BUFFER_HEXDUMP(TAG, cmd_pre, sizeof(cmd_pre), ESP_LOG_DEBUG);
+       ESP_LOG_BUFFER_HEXDUMP(TAG, data, size, ESP_LOG_DEBUG);
+       ESP_LOG_BUFFER_HEXDUMP(TAG, cmd_pos, sizeof(cmd_pos), ESP_LOG_DEBUG);
+
+       if (res < 0) {
+               ESP_LOGW(TAG, "command write failed: %d", res);
+       }
+
+       return res;
+}
+
+static void radar_poll(struct radar_state * restrict r, uart_port_t port) {
+       static uint8_t data[64];
+       int len;
+
+       ESP_LOGD(TAG, "%d: polling", port);
+       while ((len = uart_read_bytes(port, data, sizeof(data), 0)) > 0) {
+               for (uint8_t *p = data, *e = data + len; p < e; p++) {
+                       uint8_t c = *p;
+
+                       switch (r->state) {
+                       case PROT_DISABLED:
+                               break;
+                       case PROT_HEAD:
+                               if (r->pos > 0 && (c == 0xfd || c == 0xf4)) {
+                                       ESP_LOGW(TAG, "Header sync reset");
+                                       r->pos = 0;
+                               }
+                               r->head.raw[r->pos++] = c;
+                               if (r->pos == sizeof(r->head.raw)) {
+                                       r->pos = 0;
+                                       if (r->head.size <= 64
+                                               && (r->head.tag == 0xfafbfcfd || r->head.tag == 0xf1f2f3f4)) {
+                                               r->state = PROT_DATA;
+                                               ESP_LOGD(TAG, "msg: %08lx size %02x", r->head.tag, r->head.size);
+                                       } else {
+                                               ESP_LOGW(TAG, "msg: %08lx size %02x INVALID", r->head.tag, r->head.size);
+                                       }
+                               }
+                               break;
+                       case PROT_DATA:
+                               r->msg.raw[r->pos++] = c;
+                               if (r->pos == r->head.size) {
+                                       r->pos = 0;
+                                       r->state = PROT_TAIL;
+                               }
+                               break;
+                       case PROT_TAIL:
+                               r->tail.raw[r->pos++] = c;
+                               if (r->pos == sizeof(r->tail.raw)) {
+                                       ESP_LOGD(TAG, "msg end: %08lx", r->tail.tag);
+                                       r->pos = 0;
+                                       r->state = PROT_HEAD;
+
+                                       // We've had something resembling a valid packet, re-enable command processing
+                                       if (r->cmd_state == CMD_RESTART) {
+                                               r->cmd_state = CMD_IDLE;
+                                               ESP_LOGI(TAG, "it's running, allow commands");
+                                       }
+
+                                       if (r->head.tag == 0xfafbfcfd && r->tail.tag == 0x01020304) {
+                                               ESP_LOGD(TAG, "command ack:");
+                                               ESP_LOG_BUFFER_HEXDUMP(TAG, r->msg.raw, r->head.size, ESP_LOG_DEBUG);
+
+                                               switch (r->cmd_state) {
+                                               default:
+                                                       ESP_LOGW(TAG, "unexpected ack");
+                                                       break;
+                                               case CMD_ENABLE:
+                                                       if (r->msg.ack.cmd == 0x01ff
+                                                               && r->msg.ack.status == 0x0000) {
+                                                               ESP_LOGI(TAG, "command mode enter");
+                                                               r->cmd_state = CMD_REQUEST;
+                                                               command_write(port, &r->cmd->req, r->cmd->req.size + 2);
+                                                       } else {
+                                                               ESP_LOGW(TAG, "unexpected ack");
+                                                               r->cmd_state = CMD_READY;
+                                                               r->cmd->ack->status = 1;
+                                                               xTaskNotifyGive(r->cmd->task);
+                                                               r->cmd = NULL;
+                                                       }
+                                                       break;
+                                               case CMD_REQUEST:
+                                                       if (r->msg.ack.cmd == (0x0100 | r->cmd->req.cmd)) {
+                                                               *r->cmd->ack = r->msg.ack;
+                                                               xTaskNotifyGive(r->cmd->task);
+                                                               r->cmd = NULL;
+                                                       } else {
+                                                               // now what?
+                                                               ESP_LOGW(TAG, "unexpected ack");
+                                                       }
+
+                                                       if (r->msg.ack.cmd == 0x01a3) {
+                                                               // A3 is reboot, no more commands until it's running again
+                                                               ESP_LOGI(TAG, "waiting for restart");
+                                                               r->cmd_state = CMD_RESTART;
+                                                       } else {
+                                                               // We stay in ready state for a little bit to see if more
+                                                               // commands are forthcoming
+                                                               r->cmd_state = CMD_READY;
+                                                               r->cmd_ticks = 2;
+                                                       }
+                                                       break;
+                                               case CMD_DISABLE:
+                                                       if (r->msg.ack.cmd == 0x01fe
+                                                               && r->msg.ack.status == 0x0000) {
+                                                               ESP_LOGI(TAG, "command mode exit");
+                                                       } else {
+                                                               ESP_LOGW(TAG, "unexpected ack");
+                                                       }
+                                                       r->cmd_state = CMD_IDLE;
+                                                       break;
+                                               }
+                                       } else if (r->head.tag == 0xf1f2f3f4 && r->tail.tag == 0xf5f6f7f8) {
+                                               ESP_LOGD(TAG, "data fmt=%s head=%02x tail=%02x / %02x",
+                                                       r->msg.base.format == 2 ? "basic" : "full",
+                                                       r->msg.base.head,
+                                                       r->msg.base.tail,
+                                                       r->msg.full.tail);
+                                               if (r->msg.base.format == LD2410_FORMAT_BASE
+                                                       && r->msg.base.head == 0xaa
+                                                       && r->msg.base.tail == 0x55) {
+                                                       r->info.base = r->msg.base;
+                                               } else if (r->msg.full.format == LD2410_FORMAT_FULL
+                                                       && r->msg.full.head == 0xaa
+                                                       && r->msg.full.tail == 0x55) {
+                                                       r->info.full = r->msg.full;
+                                               } else {
+                                                       ESP_LOGW(TAG, "frame format error");
+                                                       ESP_LOG_BUFFER_HEXDUMP(TAG, data, len, ESP_LOG_WARN);
+                                               }
+                                       } else
+                                               ESP_LOGW(TAG, "Unknown message: %08x ... %08x", (unsigned)r->head.tag, (unsigned)r->tail.tag);
+                               }
+                       }
+               }
+       }
+}
+
+
+/*
+  Poll the queue.
+ */
+static void queue_poll(struct radar_state *r, uart_port_t port) {
+       struct request *cmd;
+
+       if (!r->queue)
+               return;
+
+       switch (r->cmd_state) {
+       case CMD_IDLE:
+               if (xQueueReceive(r->queue, &cmd, 0) == pdPASS) {
+                       if (cmd == NULL)
+                               goto close;
+                       ESP_LOGI(TAG, "command request: %d cmd=%02x", port, cmd->req.cmd);
+
+                       r->cmd_state = CMD_ENABLE;
+                       r->cmd = cmd;
+                       command_write(port, cmd_con, sizeof(cmd_con));
+               }
+               break;
+       case CMD_READY:
+               if (xQueueReceive(r->queue, &cmd, 0) == pdPASS) {
+                       if (cmd == NULL)
+                               goto close;
+                       ESP_LOGI(TAG, "command request: %d cmd=%02x", port, cmd->req.cmd);
+
+                       r->cmd_state = CMD_REQUEST;
+                       r->cmd = cmd;
+                       command_write(port, &cmd->req, cmd->req.size + 2);
+               } else if (r->cmd_ticks == 0) {
+                       r->cmd_state = CMD_DISABLE;
+                       command_write(port, cmd_end, sizeof(cmd_end));
+               } else {
+                       r->cmd_ticks -= 1;
+               }
+               break;
+       default:
+               break;
+       }
+
+       return;
+close:
+       ESP_LOGI(TAG, "command request: %d close", port);
+       vQueueDelete(r->queue);
+
+       if (r->cmd) {
+               r->cmd->ack->status = 1;
+               xTaskNotifyGive(r->cmd->task);
+               r->cmd = NULL;
+       }
+
+       r->cmd_state = CMD_RESTART;
+       r->state = PROT_DISABLED;
+       r->queue = NULL;
+}
+
+static void ld2410_task(void *arg) {
+       ESP_LOGI(TAG, "daemon start");
+
+       while (1) {
+               int active = 0;
+
+               // Check active devices
+               for (int i=0;i<UART_NUM_MAX;i++) {
+                       if (radars[i].state != PROT_DISABLED) {
+                               queue_poll(&radars[i], i);
+                               radar_poll(&radars[i], i);
+                               active += 1;
+                       }
+               }
+
+               // quit if we're idle
+               if (active == 0 && esp_cpu_compare_and_set(&daemon_running, 1, 0))
+                       break;
+
+               // Seems to send 10 per second so delay 100ms
+               vTaskDelay(pdMS_TO_TICKS(100));
+       }
+
+       ESP_LOGI(TAG, "daemon exit");
+       vTaskDelete(NULL);
+}
diff --git a/include/esp-ld2410.h b/include/esp-ld2410.h
new file mode 100644 (file)
index 0000000..f90db92
--- /dev/null
@@ -0,0 +1,187 @@
+/*
+ * Copyright (C) 2024 Michael Zucchi
+ *
+ * This file is part of esp-ld2410 <https://www.zedzone.au/software/esp-ld2410.html>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef ESP_LD2410_H
+#define ESP_LD2410_H
+
+enum ld2410_baudrate_t {
+       LD2410_BAUDRATE_9600 = 1,
+       LD2410_BAUDRATE_19200,
+       LD2410_BAUDRATE_38400,
+       LD2410_BAUDRATE_57600,
+       LD2410_BAUDRATE_115200,
+       LD2410_BAUDRATE_230400,
+       LD2410_BAUDRATE_256000,                 // factory reset baud rate
+       LD2410_BAUDRATE_460800,
+       LD2410_BAUDRATE_DEFAULT = LD2410_BAUDRATE_256000
+};
+
+enum ld2410_resolution_t {
+       LD2410_0_75M,
+       LD2410_0_20M,
+};
+
+enum ld2410_format_t {
+       LD2410_FORMAT_FULL = 1,
+       LD2410_FORMAT_BASE = 2,
+};
+
+// data.status
+enum ld2410_status_t {
+       LD2410_STATUS_NONE = 0,
+       LD2410_STATUS_MOVE = 1,
+       LD2410_STATUS_REST = 2,
+       LD2410_STATUS_BOTH = 3
+};
+
+/* command request format */
+struct __attribute__((packed)) ld2410_req_t {
+       uint16_t size;
+       uint16_t cmd;
+       union {
+               struct {
+                       uint16_t value;         // 0x0001
+               } config;       // 0x00ff
+               struct  __attribute__((packed)) {
+                       uint16_t move_key;      // 0x0000
+                       uint32_t move_max;      // 2-8
+                       uint16_t rest_key;      // 0x0001
+                       uint32_t rest_max;      // 2-8
+                       uint16_t idle_key;      // 0x0002
+                       uint32_t idle_time;     // 0x0000-0xffff seconds
+               } range;        // 0x0060
+               struct  __attribute__((packed)) {
+                       uint16_t dist_key;      // 0x0000
+                       uint32_t dist;          // distance number or 0xffff for all
+                       uint16_t move_key;      // 0x0001
+                       uint32_t move;          // sensitivity
+                       uint16_t rest_key;      // 0x0002
+                       uint32_t rest;          // sensitivity
+               } parameter;// 0x0064
+               struct {
+                       uint16_t rate;
+               } baudrate;// 0x00a1
+               struct {
+                       uint16_t enable;
+               } bluetooth;//0x00a4
+               struct {
+                       uint16_t value;         // 0x0001
+               } addr; // 0x00a5
+               struct {
+                       uint8_t passwd[6];
+               } passwd; // 0x00a9
+               struct {
+                       uint16_t value;
+               } resolution; // 0x00aa
+       };
+};
+
+struct __attribute__((packed)) ld2410_version_t {
+       uint16_t type;          // 0x0100
+       uint16_t major;
+       uint32_t minor;
+};
+
+struct  __attribute__((packed)) ld2410_parameters_t {
+       uint8_t head;           // aa
+       uint8_t gate_max;
+       uint8_t move_max;
+       uint8_t rest_max;
+       uint8_t move_sensitivity[9];
+       uint8_t rest_sensitivity[9];
+       uint16_t idle_time;
+};
+
+/* command acknowledge format */
+struct __attribute__((packed)) ld2410_ack_t {
+       uint16_t cmd;
+       uint16_t status;
+       union {
+               struct {
+                       uint16_t version;
+                       uint16_t bufsize;
+               } config; // 0x00ff
+               struct ld2410_parameters_t params; // 0x0061
+               struct ld2410_version_t version; // 0xa0
+               struct {
+                       uint16_t value;
+               } resolution; // 0x00ab
+       };
+};
+
+/* data frame format - basic data */
+struct __attribute__((packed)) ld2410_base_t {
+       uint8_t format;         // 02 basic mode
+       uint8_t head;           // aa
+       uint8_t status;
+       uint16_t move_dist;
+       uint8_t move_level;
+       uint16_t rest_dist;
+       uint8_t rest_level;
+       uint16_t dist;
+       uint8_t tail;           // 55
+       uint8_t calibration;    // 00
+};
+
+/* data frame format - 'engineering' data */
+struct __attribute__((packed)) ld2410_full_t {
+       uint8_t format;         // 01 engineering mode
+       uint8_t head;           // aa
+       uint8_t status;
+       uint16_t move_dist;
+       uint8_t move_level;
+       uint16_t rest_dist;
+       uint8_t rest_level;
+       uint16_t dist;
+
+       uint8_t move_max; /* index of highest valid value */
+       uint8_t rest_max;
+       uint8_t move_levels[9];
+       uint8_t rest_levels[9];
+       uint8_t light_level;
+       uint8_t what;           // always seems to be 01
+
+       uint8_t tail;           // 55
+       uint8_t calibration;    // 00
+};
+
+int ld2410_driver_install(uart_port_t port, enum ld2410_baudrate_t baud_rate,gpio_num_t tx_pin, gpio_num_t rx_pin, gpio_num_t dig_pin);
+void ld2410_driver_delete(uart_port_t port);
+
+const struct ld2410_base_t *ld2410_get_base_data(uart_port_t port);
+const struct ld2410_full_t *ld2410_get_full_data(uart_port_t port);
+int ld2410_get_detected(uart_port_t port);
+
+int ld2410_set_range(uart_port_t port, uint32_t move_max, uint32_t rest_max, uint32_t idle_time);
+int ld2410_set_parameter(uart_port_t port, uint32_t dist, uint32_t move, uint32_t rest);
+int ld2410_get_parameters(uart_port_t port, struct ld2410_parameters_t *params);
+
+int ld2410_set_baudrate(uart_port_t port, enum ld2410_baudrate_t rate);
+int ld2410_get_version(uart_port_t port, struct ld2410_version_t *version);
+int ld2410_set_resolution(uart_port_t port, enum ld2410_resolution_t resolution);
+int ld2410_get_resolution(uart_port_t port, enum ld2410_resolution_t *resolution);
+
+int ld2410_set_full_mode(uart_port_t port);
+int ld2410_set_basic_mode(uart_port_t port);
+
+int ld2410_factory_reset(uart_port_t port);
+int ld2410_restart(uart_port_t port);
+
+
+#endif