mirror of
https://github.com/arendst/Tasmota.git
synced 2026-07-27 20:05:46 +00:00
VID6608: add hardware RMT support for Automotive gauge driver (#24759)
* Replace old software-defined library arduino-vid6608 with hw-defined esp-32-vid6608 * VID6608: Rework integration to allow select RMT/SW method by using the `VID6608_RMT` option * VID6608: Tune library inclusion for RMT version * The RMT version is not supported on ESP32-C2, library excluded * Add more clear error message, if RMT is requested, but not supported
This commit is contained in:
@@ -0,0 +1,42 @@
|
|||||||
|
BasedOnStyle: Google
|
||||||
|
Language: Cpp
|
||||||
|
ColumnLimit: 120
|
||||||
|
IndentWidth: 4
|
||||||
|
TabWidth: 4
|
||||||
|
UseTab: Never
|
||||||
|
SortIncludes: Never
|
||||||
|
PPIndentWidth : 1
|
||||||
|
IndentPPDirectives: AfterHash
|
||||||
|
ReflowComments: true
|
||||||
|
SpacesBeforeTrailingComments: 1
|
||||||
|
AlignTrailingComments: true
|
||||||
|
AlignAfterOpenBracket: Align
|
||||||
|
AlignConsecutiveMacros:
|
||||||
|
Enabled: true
|
||||||
|
AcrossEmptyLines: true
|
||||||
|
AcrossComments: true
|
||||||
|
AlignConsecutiveAssignments:
|
||||||
|
Enabled: true
|
||||||
|
AcrossEmptyLines: false
|
||||||
|
AcrossComments: true
|
||||||
|
AlignCompound: true
|
||||||
|
PadOperators: true
|
||||||
|
AlignConsecutiveDeclarations:
|
||||||
|
Enabled: true
|
||||||
|
AcrossEmptyLines: false
|
||||||
|
AcrossComments: true
|
||||||
|
AlignEscapedNewlines: Left
|
||||||
|
AccessModifierOffset: -2
|
||||||
|
AlignArrayOfStructures: Right
|
||||||
|
AlignOperands: Align
|
||||||
|
AllowAllArgumentsOnNextLine: false
|
||||||
|
AllowShortFunctionsOnASingleLine: Inline
|
||||||
|
AllowShortBlocksOnASingleLine: Empty
|
||||||
|
BreakBeforeBinaryOperators: None
|
||||||
|
BinPackArguments: false
|
||||||
|
BinPackParameters: false
|
||||||
|
DerivePointerAlignment: false
|
||||||
|
PenaltyBreakAssignment: 4
|
||||||
|
PenaltyExcessCharacter: 4
|
||||||
|
PenaltyBreakBeforeFirstCallParameter: 1
|
||||||
|
PointerAlignment: Left
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
# top-most EditorConfig file
|
||||||
|
root = true
|
||||||
|
|
||||||
|
# Unix-style newlines with a newline ending every file
|
||||||
|
[*]
|
||||||
|
end_of_line = lf
|
||||||
|
insert_final_newline = true
|
||||||
|
charset = utf-8
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 4
|
||||||
|
|
||||||
|
[*.{yaml,yml}]
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
[*.json]
|
||||||
|
indent_size = 2
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
.pio
|
||||||
|
.vscode
|
||||||
|
.cache
|
||||||
|
managed_components
|
||||||
|
build
|
||||||
|
sdkconfig
|
||||||
|
dependencies.lock
|
||||||
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://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 <https://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
|
||||||
|
<https://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
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
# ESP-IDF library to drive Automotive gauge drivers using HW RMT driver
|
||||||
|
|
||||||
|
This library implements driver for native ESP-IDF framework
|
||||||
|
for following driver chips for analog automotive gauges (Switec X25.168, X27.168 and clones) with microstepping support:
|
||||||
|
|
||||||
|
* VID6606 (2 motors)
|
||||||
|
* VID6608 (4 motors)
|
||||||
|
* VT6608S
|
||||||
|
* AX1201728SG
|
||||||
|
* BY8920
|
||||||
|
* many others
|
||||||
|
|
||||||
|
Driver chips with microstepping is the recommended way to drive such motors,
|
||||||
|
they provide much more relailabe and smooth movement with reduced noise and
|
||||||
|
to avoid skipping steps.
|
||||||
|
|
||||||
|
This library is very similar to [Arduino-vid6608](https://github.com/petrows/arduino-vid6608),
|
||||||
|
but it implements hardware generator for driver steps sequence,
|
||||||
|
the [ESP-32 Remote Control Transceiver (RMT)](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/peripherals/rmt.html):
|
||||||
|
|
||||||
|
* No `delay()` call;
|
||||||
|
* Much better precision movement without interrupts and slow-downs for bi-axial instruments;
|
||||||
|
|
||||||
|
Only the ESP-32 is supported. All chips has minimum 2 RMT channels.
|
||||||
|
|
||||||
|
This library has following features:
|
||||||
|
|
||||||
|
* More precise Datasheet complaince
|
||||||
|
* Another smoothing method (requires less calculations)
|
||||||
|
* Optimized homing
|
||||||
|
* Extended API's
|
||||||
|
|
||||||
|
[](https://registry.platformio.org/libraries/petrows/esp-32-vid6608-rmt)
|
||||||
|
|
||||||
|
## Chip documentation
|
||||||
|
|
||||||
|
See [VID6606 Datasheet (English)](doc/VID6608.pdf).
|
||||||
|
|
||||||
|
## Wiring
|
||||||
|
|
||||||
|
This library requires that two pins (per drive) are connected to two outputs.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
* Step pin f(scx): impulse to drive motor to one microstep;
|
||||||
|
* Direction pin CW/CCW: defines direction ov movement;
|
||||||
|
* RESET pin: does not controlled by this library. Hold to VDD to enable function (see notes below);
|
||||||
|
|
||||||
|
## RESET pin
|
||||||
|
|
||||||
|
This library does not control RESET pin, please perform this inside your firmware.
|
||||||
|
|
||||||
|
I have problems with some IC's, as they lost function after RESET pin manipulation. [Datasheet](doc/VID6608.pdf) recommends to hold it LOW during boot, and set to HIGH to enable operation, but i recommend just to connect to VDD to be safe.
|
||||||
|
|
||||||
|
## Setting zero
|
||||||
|
|
||||||
|
Motor is set to zero by moving whole scale and kept bouncing on the one of
|
||||||
|
dead positions. This library provides optimized way to perform homing: it does
|
||||||
|
1/2 of scale forward, then full scale backward. This helps to reduce bouncing
|
||||||
|
like in the classical "full scale back" method.
|
||||||
|
|
||||||
|
## Function documentation
|
||||||
|
|
||||||
|
See inline documentation in source code: [vid6608.h](src/vid6608.h).
|
||||||
|
|
||||||
|
## Compile examples
|
||||||
|
|
||||||
|
To compile and flash examples, navigate to example dir and call idf:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd examples/gauge-cal
|
||||||
|
export IDF_TARGET=esp32c6
|
||||||
|
idf.py flash monitor
|
||||||
|
```
|
||||||
|
|
||||||
|
## Basic example
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#include "esp32_vid6608_rmt.h"
|
||||||
|
|
||||||
|
extern "C" void app_main(void)
|
||||||
|
{
|
||||||
|
vid6608::Config cfg {
|
||||||
|
.stepPin = GPIO_NUM_14,
|
||||||
|
.dirPin = GPIO_NUM_18,
|
||||||
|
.maxSteps = 12 * 320,
|
||||||
|
};
|
||||||
|
vid6608 driver = vid6608(cfg);
|
||||||
|
|
||||||
|
driver.zero();
|
||||||
|
vTaskDelay(pdMS_TO_TICKS(2000));
|
||||||
|
driver.setPos(12 * 180);
|
||||||
|
}
|
||||||
|
```
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
## IDF Component Manager Manifest File
|
||||||
|
description: "ESP32 library to drive automotive steppers like X27-168 via IC VID668 driver using HW RMT API"
|
||||||
|
url: "https://github.com/petrows/esp-32-vid6608-rmt"
|
||||||
|
repository: "https://github.com/petrows/esp-32-vid6608-rmt.git"
|
||||||
|
maintainers:
|
||||||
|
- Petr Golovachev <petro@petro.ws>
|
||||||
|
documentation: "https://github.com/petrows/esp-32-vid6608-rmt/blob/master/README.md"
|
||||||
|
tags:
|
||||||
|
- Stepper
|
||||||
|
- VID6608
|
||||||
|
dependencies:
|
||||||
|
idf:
|
||||||
|
version: ">=5.5.0"
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"name": "esp-32-vid6608-rmt",
|
||||||
|
"version": "1.2",
|
||||||
|
"keywords": "esp32, espressif, vid6608, x27-168, rmt, stepper",
|
||||||
|
"description": "ESP32 library to drive Automotive gauge drivers like x27-168 using HW RMT driver",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/petrows/esp-32-vid6608-rmt.git"
|
||||||
|
},
|
||||||
|
"authors": {
|
||||||
|
"name": "Petr Golovachev",
|
||||||
|
"email": "petro@petro.ws",
|
||||||
|
"url": "https://petro.ws/"
|
||||||
|
},
|
||||||
|
"frameworks": "espidf,arduino",
|
||||||
|
"platforms": "espressif32"
|
||||||
|
}
|
||||||
@@ -0,0 +1,291 @@
|
|||||||
|
/**
|
||||||
|
* @file esp32_vid6608_rmt.cpp
|
||||||
|
* @author Petr Golovachev (petro@petro.ws)
|
||||||
|
* @brief Main class of ESP-32 VID6608 RMT driver
|
||||||
|
*
|
||||||
|
* @copyright Copyright (c) 2026
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "esp32_vid6608_rmt.h"
|
||||||
|
|
||||||
|
#include "esp_log.h"
|
||||||
|
|
||||||
|
static constexpr uint32_t RMT_RES_HZ = 1'000'000; // 1 тик = 1 мкс
|
||||||
|
static const char *TAG = "VID6608";
|
||||||
|
|
||||||
|
std::array<uint16_t, esp32_vid6608_rmt::kAccelSteps> esp32_vid6608_rmt::buildAccelCurve() {
|
||||||
|
// Linear ramp from startHz up to cruiseHz over kAccelSteps pulses.
|
||||||
|
// Edit these two frequencies to retune the shipped profile.
|
||||||
|
constexpr float startHz = 250.0f;
|
||||||
|
constexpr float cruiseHz = 1000.0f;
|
||||||
|
std::array<uint16_t, kAccelSteps> out{};
|
||||||
|
for (size_t i = 0; i < kAccelSteps; ++i) {
|
||||||
|
float t = float(i + 1) / float(kAccelSteps);
|
||||||
|
float hz = startHz + (cruiseHz - startHz) * t;
|
||||||
|
out[i] = static_cast<uint16_t>(float(RMT_RES_HZ) / (hz * 2.0f));
|
||||||
|
}
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
const std::array<uint16_t, esp32_vid6608_rmt::kAccelSteps> esp32_vid6608_rmt::kAccelHalfPeriod =
|
||||||
|
esp32_vid6608_rmt::buildAccelCurve();
|
||||||
|
|
||||||
|
esp32_vid6608_rmt::esp32_vid6608_rmt(const Config &cfg) : config(cfg) {
|
||||||
|
gpio_config_t io = {
|
||||||
|
.pin_bit_mask = (1ULL << this->config.dirPin),
|
||||||
|
.mode = GPIO_MODE_OUTPUT,
|
||||||
|
.pull_up_en = GPIO_PULLUP_DISABLE,
|
||||||
|
.pull_down_en = GPIO_PULLDOWN_DISABLE,
|
||||||
|
.intr_type = GPIO_INTR_DISABLE,
|
||||||
|
};
|
||||||
|
ESP_ERROR_CHECK(gpio_config(&io));
|
||||||
|
gpio_set_level(cfg.dirPin, 0);
|
||||||
|
|
||||||
|
rmt_tx_channel_config_t tx_cfg = {};
|
||||||
|
tx_cfg.gpio_num = this->config.stepPin;
|
||||||
|
tx_cfg.clk_src = RMT_CLK_SRC_DEFAULT;
|
||||||
|
tx_cfg.resolution_hz = RMT_RES_HZ;
|
||||||
|
tx_cfg.mem_block_symbols = 48; // ESP32-C6: 48 = 1 HW-channel
|
||||||
|
tx_cfg.trans_queue_depth = 4;
|
||||||
|
ESP_ERROR_CHECK(rmt_new_tx_channel(&tx_cfg, &this->chan));
|
||||||
|
|
||||||
|
rmt_copy_encoder_config_t enc_cfg = {};
|
||||||
|
ESP_ERROR_CHECK(rmt_new_copy_encoder(&enc_cfg, &this->enc));
|
||||||
|
ESP_ERROR_CHECK(rmt_enable(chan));
|
||||||
|
|
||||||
|
this->infoMutex = xSemaphoreCreateMutex();
|
||||||
|
this->taskNotify = xSemaphoreCreateBinary();
|
||||||
|
|
||||||
|
this->running = true;
|
||||||
|
|
||||||
|
// Start task
|
||||||
|
xTaskCreate(
|
||||||
|
&esp32_vid6608_rmt::driverTaskStart, /* Function to implement the task */
|
||||||
|
"esp32_vid6608_rmt", /* Name of the task */
|
||||||
|
1024, /* Stack size in words */
|
||||||
|
this, /* Task input parameter */
|
||||||
|
0, /* Priority of the task, lowest */
|
||||||
|
&this->taskHandle /* Task handle. */
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
esp32_vid6608_rmt::~esp32_vid6608_rmt() {
|
||||||
|
this->running = false;
|
||||||
|
xSemaphoreGive(this->taskNotify);
|
||||||
|
vTaskDelete(this->taskHandle);
|
||||||
|
if (this->chan) {
|
||||||
|
rmt_disable(this->chan);
|
||||||
|
rmt_del_channel(this->chan);
|
||||||
|
}
|
||||||
|
if (this->enc) rmt_del_encoder(this->enc);
|
||||||
|
}
|
||||||
|
|
||||||
|
void esp32_vid6608_rmt::zero(int32_t initialPos) {
|
||||||
|
xSemaphoreTake(this->infoMutex, portMAX_DELAY);
|
||||||
|
this->targetPositionNext = 0;
|
||||||
|
this->targetPosition = 0;
|
||||||
|
int32_t maxSteps = this->config.maxSteps;
|
||||||
|
// Pre-defined modes: half-fw/full-back
|
||||||
|
if (ZERO_BACK_HALF == initialPos) {
|
||||||
|
initialPos = config.maxSteps / 2;
|
||||||
|
}
|
||||||
|
// Sanity check
|
||||||
|
if (initialPos < 0) { initialPos = 0; }
|
||||||
|
if (initialPos > maxSteps - 1) { initialPos = maxSteps - 1; }
|
||||||
|
// Move back the rest of gauge
|
||||||
|
int32_t stepsBack = (maxSteps - 1) - initialPos;
|
||||||
|
this->moveConst(stepsBack, 2000);
|
||||||
|
// Move forward the whole scale
|
||||||
|
this->moveRamp(-maxSteps);
|
||||||
|
// Gentle final strike against the mechanical stop — bypass the ramp so
|
||||||
|
// the impact is soft and predictable.
|
||||||
|
this->moveConst(-12, 100);
|
||||||
|
xSemaphoreGive(this->infoMutex);
|
||||||
|
}
|
||||||
|
|
||||||
|
void esp32_vid6608_rmt::wait(int32_t timeout_ms) {
|
||||||
|
/**
|
||||||
|
* @brief This function makes polling check, that the flag
|
||||||
|
* this->targetPending is unset
|
||||||
|
*
|
||||||
|
* We are NOT calling here functions like rmt_tx_wait_all_done(),
|
||||||
|
* as they are not thread safe!
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
constexpr TickType_t pollInterval = pdMS_TO_TICKS(5);
|
||||||
|
const bool waitForever = (timeout_ms < 0);
|
||||||
|
const TickType_t start = xTaskGetTickCount();
|
||||||
|
const TickType_t deadline = waitForever
|
||||||
|
? 0
|
||||||
|
: (start + pdMS_TO_TICKS(timeout_ms));
|
||||||
|
|
||||||
|
ESP_LOGD(TAG, "D %d, wait start (timeout_ms=%ld)", this->config.stepPin,
|
||||||
|
static_cast<long>(timeout_ms));
|
||||||
|
|
||||||
|
while (true) {
|
||||||
|
xSemaphoreTake(this->infoMutex, portMAX_DELAY);
|
||||||
|
bool pending = this->targetPending;
|
||||||
|
xSemaphoreGive(this->infoMutex);
|
||||||
|
|
||||||
|
if (!pending) {
|
||||||
|
ESP_LOGD(TAG, "D %d, wait done", this->config.stepPin);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!waitForever) {
|
||||||
|
TickType_t now = xTaskGetTickCount();
|
||||||
|
// Signed subtraction handles TickType_t wraparound correctly.
|
||||||
|
if (static_cast<int32_t>(deadline - now) <= 0) {
|
||||||
|
ESP_LOGW(TAG, "D %d, wait timeout after %ld ms",
|
||||||
|
this->config.stepPin, static_cast<long>(timeout_ms));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
vTaskDelay(pollInterval);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
bool esp32_vid6608_rmt::isMoving() {
|
||||||
|
bool pending;
|
||||||
|
xSemaphoreTake(this->infoMutex, portMAX_DELAY);
|
||||||
|
pending = this->targetPending;
|
||||||
|
xSemaphoreGive(this->infoMutex);
|
||||||
|
return pending;
|
||||||
|
}
|
||||||
|
|
||||||
|
void esp32_vid6608_rmt::setPos(int32_t steps) {
|
||||||
|
// Critical section
|
||||||
|
xSemaphoreTake(this->infoMutex, portMAX_DELAY);
|
||||||
|
this->targetPending = true;
|
||||||
|
this->targetPositionNext = steps;
|
||||||
|
xSemaphoreGive(this->infoMutex);
|
||||||
|
// Notify thread
|
||||||
|
xSemaphoreGive(this->taskNotify);
|
||||||
|
}
|
||||||
|
|
||||||
|
void esp32_vid6608_rmt::driverTask() {
|
||||||
|
do {
|
||||||
|
int32_t targetMove = 0; // Now much steps we need to move?
|
||||||
|
xSemaphoreTake(this->infoMutex, portMAX_DELAY);
|
||||||
|
// Sanity check
|
||||||
|
if (this->targetPositionNext < 0) {
|
||||||
|
this->targetPositionNext = 0;
|
||||||
|
}
|
||||||
|
if (this->targetPositionNext > this->config.maxSteps - 1) {
|
||||||
|
this->targetPositionNext = this->config.maxSteps - 1;
|
||||||
|
}
|
||||||
|
if (this->targetPositionNext != this->targetPosition) {
|
||||||
|
// We have scheduled as new, calculate new diff
|
||||||
|
targetMove = this->targetPositionNext - this->targetPosition;
|
||||||
|
this->targetPosition = this->targetPositionNext;
|
||||||
|
this->targetPending = true;
|
||||||
|
} else {
|
||||||
|
this->targetPending = false; // We dont need to move anymore
|
||||||
|
}
|
||||||
|
xSemaphoreGive(this->infoMutex);
|
||||||
|
// We need move?
|
||||||
|
if (targetMove) {
|
||||||
|
if (this->config.useAccel) {
|
||||||
|
this->moveRamp(targetMove);
|
||||||
|
} else {
|
||||||
|
this->moveConst(targetMove, 1000);
|
||||||
|
}
|
||||||
|
// No need to wait, as move is blocking
|
||||||
|
continue; // New loop
|
||||||
|
}
|
||||||
|
// Nothing to do: wait for info updates
|
||||||
|
xSemaphoreTake(this->taskNotify, portMAX_DELAY);
|
||||||
|
} while (this->running);
|
||||||
|
}
|
||||||
|
|
||||||
|
void esp32_vid6608_rmt::driverTaskStart(void *arg) {
|
||||||
|
static_cast<esp32_vid6608_rmt *>(arg)->driverTask();
|
||||||
|
}
|
||||||
|
|
||||||
|
void esp32_vid6608_rmt::movePrepare(int32_t steps) {
|
||||||
|
if (steps == 0) return;
|
||||||
|
uint8_t newTargetDir = steps > 0 ? 0 : 1;
|
||||||
|
if (newTargetDir != this->targetDir) {
|
||||||
|
// Direction changed -> add delay (as required by Datasheet)
|
||||||
|
this->targetDir = newTargetDir;
|
||||||
|
vTaskDelay(pdMS_TO_TICKS(1));
|
||||||
|
gpio_set_level(this->config.dirPin, steps > 0 ? 0 : 1);
|
||||||
|
vTaskDelay(pdMS_TO_TICKS(1));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void esp32_vid6608_rmt::moveRamp(int32_t steps) {
|
||||||
|
if (steps == 0) return;
|
||||||
|
|
||||||
|
uint32_t n = static_cast<uint32_t>(steps > 0 ? steps : -steps);
|
||||||
|
ESP_LOGD(TAG, "D %d, Ramp move: %d", this->config.stepPin, steps);
|
||||||
|
|
||||||
|
this->movePrepare(steps);
|
||||||
|
|
||||||
|
// Triangular fallback when the move is too short for a full ramp pair.
|
||||||
|
uint32_t rampSteps = static_cast<uint32_t>(kAccelSteps);
|
||||||
|
if (n < 2 * rampSteps) {
|
||||||
|
rampSteps = n / 2;
|
||||||
|
}
|
||||||
|
uint32_t cruiseSteps = n - 2 * rampSteps;
|
||||||
|
|
||||||
|
for (uint32_t i = 0; i < rampSteps; ++i) {
|
||||||
|
uint16_t h = kAccelHalfPeriod[i];
|
||||||
|
accelBuf[i].duration0 = h; accelBuf[i].level0 = 1;
|
||||||
|
accelBuf[i].duration1 = h; accelBuf[i].level1 = 0;
|
||||||
|
}
|
||||||
|
for (uint32_t i = 0; i < rampSteps; ++i) {
|
||||||
|
uint16_t h = kAccelHalfPeriod[rampSteps - 1 - i];
|
||||||
|
decelBuf[i].duration0 = h; decelBuf[i].level0 = 1;
|
||||||
|
decelBuf[i].duration1 = h; decelBuf[i].level1 = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
rmt_transmit_config_t tx = {};
|
||||||
|
|
||||||
|
if (rampSteps > 0) {
|
||||||
|
tx.loop_count = 0;
|
||||||
|
ESP_ERROR_CHECK(rmt_transmit(this->chan, this->enc, accelBuf,
|
||||||
|
rampSteps * sizeof(rmt_symbol_word_t), &tx));
|
||||||
|
}
|
||||||
|
if (cruiseSteps > 0) {
|
||||||
|
// For a partial (triangular) ramp the cruise speed is whatever peak
|
||||||
|
// the partial ramp reached, not the full top of the curve.
|
||||||
|
uint16_t h = rampSteps > 0 ? kAccelHalfPeriod[rampSteps - 1]
|
||||||
|
: kAccelHalfPeriod[0];
|
||||||
|
cruisePulse.duration0 = h; cruisePulse.level0 = 1;
|
||||||
|
cruisePulse.duration1 = h; cruisePulse.level1 = 0;
|
||||||
|
tx.loop_count = static_cast<int>(cruiseSteps) - 1;
|
||||||
|
ESP_ERROR_CHECK(rmt_transmit(this->chan, this->enc, &cruisePulse,
|
||||||
|
sizeof(cruisePulse), &tx));
|
||||||
|
}
|
||||||
|
if (rampSteps > 0) {
|
||||||
|
tx.loop_count = 0;
|
||||||
|
ESP_ERROR_CHECK(rmt_transmit(this->chan, this->enc, decelBuf,
|
||||||
|
rampSteps * sizeof(rmt_symbol_word_t), &tx));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wait for transmission is done
|
||||||
|
ESP_ERROR_CHECK(rmt_tx_wait_all_done(this->chan, 10000));
|
||||||
|
}
|
||||||
|
|
||||||
|
void esp32_vid6608_rmt::moveConst(int32_t steps, int32_t speed_hz) {
|
||||||
|
if (steps == 0) return;
|
||||||
|
|
||||||
|
uint32_t n = static_cast<uint32_t>(steps > 0 ? steps : -steps);
|
||||||
|
ESP_LOGD(TAG, "D %d, Const move: %d @ %d Hz", this->config.stepPin, steps, speed_hz);
|
||||||
|
|
||||||
|
this->movePrepare(steps);
|
||||||
|
|
||||||
|
uint16_t half = RMT_RES_HZ / (speed_hz * 2);
|
||||||
|
cruisePulse.duration0 = half; cruisePulse.level0 = 1;
|
||||||
|
cruisePulse.duration1 = half; cruisePulse.level1 = 0;
|
||||||
|
|
||||||
|
rmt_transmit_config_t tx = {};
|
||||||
|
tx.loop_count = static_cast<int>(n) - 1; // сам символ + (n-1) повторов = n импульсов
|
||||||
|
ESP_ERROR_CHECK(rmt_transmit(this->chan, this->enc, &cruisePulse, sizeof(cruisePulse), &tx));
|
||||||
|
|
||||||
|
// Wait for transmission is done
|
||||||
|
ESP_ERROR_CHECK(rmt_tx_wait_all_done(this->chan, 10000));
|
||||||
|
}
|
||||||
@@ -0,0 +1,209 @@
|
|||||||
|
/**
|
||||||
|
* @file esp32_vid6608_rmt.h
|
||||||
|
* @author Petr Golovachev (petro@petro.ws)
|
||||||
|
* @brief Main class of ESP-32 VID6608 RMT driver
|
||||||
|
*
|
||||||
|
* @copyright Copyright (c) 2026
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <array>
|
||||||
|
#include <cstddef>
|
||||||
|
#include <cstdint>
|
||||||
|
|
||||||
|
#include "driver/gpio.h"
|
||||||
|
#include "driver/rmt_tx.h"
|
||||||
|
#include "freertos/FreeRTOS.h"
|
||||||
|
#include "freertos/semphr.h"
|
||||||
|
#include "freertos/task.h"
|
||||||
|
|
||||||
|
#include "soc/soc_caps.h"
|
||||||
|
#if !SOC_RMT_SUPPORTED
|
||||||
|
#error "RMT is not supported on this platform"
|
||||||
|
#endif
|
||||||
|
|
||||||
|
class esp32_vid6608_rmt {
|
||||||
|
public:
|
||||||
|
/**
|
||||||
|
* @brief Configuration struct
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
struct Config {
|
||||||
|
gpio_num_t stepPin; ///< f(scx) pin
|
||||||
|
gpio_num_t dirPin; ///< CC/CCWA pin
|
||||||
|
uint16_t maxSteps; ///< Max steps er full rotation
|
||||||
|
bool useAccel = true; ///< Enable smoothness
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Construct a new esp32_vid6608_rmt object
|
||||||
|
*
|
||||||
|
* @param cfg Configuration struct
|
||||||
|
*/
|
||||||
|
explicit esp32_vid6608_rmt(const Config &cfg);
|
||||||
|
~esp32_vid6608_rmt();
|
||||||
|
|
||||||
|
esp32_vid6608_rmt(const esp32_vid6608_rmt &) = delete;
|
||||||
|
esp32_vid6608_rmt &operator=(const esp32_vid6608_rmt &) = delete;
|
||||||
|
|
||||||
|
enum MoveState {
|
||||||
|
ZERO_BACK_FULL = 0,
|
||||||
|
ZERO_BACK_HALF = -2,
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Resets zero position to actual 0 position
|
||||||
|
*
|
||||||
|
* Moves full rotation forward and backward
|
||||||
|
*
|
||||||
|
* @param initialPos initial position to assume zeroing, default is 0. If you know the "old" gauge position, you can provide it here to avoid end-stop bounce
|
||||||
|
*
|
||||||
|
* @warning this function is blocking, execution is delayed upon done
|
||||||
|
*/
|
||||||
|
void zero(int32_t initialPos = ZERO_BACK_HALF);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Wait for current move task to complete
|
||||||
|
*
|
||||||
|
* @param timeout_ms max time to wait, -1 for wait forever
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
void wait(int32_t timeout_ms = 10000);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Shedules movement to defined absolute position
|
||||||
|
*
|
||||||
|
* Input is checked for sanity: must be in range 0...maxSteps-1. Values bigger are threated as maxSteps-1.
|
||||||
|
* @warning this function is asynchronous, actual movement is done in another task.
|
||||||
|
* @warning next move will be scheduled after current move is done to avoid drive jittering.
|
||||||
|
*
|
||||||
|
* @param position absolute position in range 0...maxSteps-1
|
||||||
|
*/
|
||||||
|
void setPos(int32_t steps);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get the driving pin
|
||||||
|
*
|
||||||
|
* @return gpio_num_t driving pin number
|
||||||
|
*/
|
||||||
|
gpio_num_t getPinStep() { return this->config.stepPin; }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get the Max Steps object
|
||||||
|
*
|
||||||
|
* @return uint16_t max steps, defined for this drive
|
||||||
|
*/
|
||||||
|
uint16_t getMaxSteps() { return this->config.maxSteps; }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Get the Current Position object
|
||||||
|
*
|
||||||
|
* @return int32_t current position (sheduled at this moment, actual move may apply)
|
||||||
|
*/
|
||||||
|
int32_t getCurrentPosition() { return this->targetPosition; }
|
||||||
|
|
||||||
|
// -------------------------------------------------------------------------------------------
|
||||||
|
// Old Arduino-vid6608 compat layer
|
||||||
|
// -------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Shedules movement to defined absolute position
|
||||||
|
*
|
||||||
|
* Input is checked for sanity: must be in range 0...maxSteps-1. Values bigger are threated as maxSteps-1.
|
||||||
|
* @warning this function is asynchronous, actual movement is done in the loop() function.
|
||||||
|
* @warning next move will be scheduled after current move is done to avoid drive jittering.
|
||||||
|
*
|
||||||
|
* @param position absolute position in range 0...maxSteps-1
|
||||||
|
*/
|
||||||
|
void moveTo(uint16_t position) { setPos(position); }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Test if motor is moving
|
||||||
|
*
|
||||||
|
* Return true, if drive still have sheduled steps (that means that next loop() call will result impulse).
|
||||||
|
*
|
||||||
|
* @return true if drive is moveemnt
|
||||||
|
* @return false if drive is stopped
|
||||||
|
*/
|
||||||
|
bool isMoving();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Test if motor is stopped
|
||||||
|
*
|
||||||
|
* @return true if drive is stopped
|
||||||
|
* @return false if drive is moveemnt
|
||||||
|
*/
|
||||||
|
bool isStopped() { return !isMoving(); }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Returns current real absolute position
|
||||||
|
*
|
||||||
|
* @return uint16_t current real drive position in steps
|
||||||
|
*/
|
||||||
|
uint16_t getPosition() { return (uint16_t)this->targetPosition; }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Does nothing on RMT
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
void loop() {}
|
||||||
|
|
||||||
|
private:
|
||||||
|
/**
|
||||||
|
* @brief Length of the acceleration ramp, in step pulses.
|
||||||
|
*
|
||||||
|
* The acceleration profile is baked into the library and is not
|
||||||
|
* user-tunable. A move shorter than @c 2*kAccelSteps uses a triangular
|
||||||
|
* profile and never reaches the cruise rate.
|
||||||
|
*/
|
||||||
|
static constexpr size_t kAccelSteps = 32;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Build the per-step half-period table at startup.
|
||||||
|
*
|
||||||
|
* @return Array of half-periods in RMT ticks (1 µs each).
|
||||||
|
*/
|
||||||
|
static std::array<uint16_t, kAccelSteps> buildAccelCurve();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Per-step half-period for the acceleration ramp (RMT ticks).
|
||||||
|
*
|
||||||
|
* Index 0 is the slowest pulse (start of motion); the last index is the
|
||||||
|
* fastest pulse (cruise). Deceleration walks the table in reverse.
|
||||||
|
*/
|
||||||
|
static const std::array<uint16_t, kAccelSteps> kAccelHalfPeriod;
|
||||||
|
|
||||||
|
void movePrepare(int32_t steps);
|
||||||
|
void moveRamp(int32_t steps);
|
||||||
|
void moveConst(int32_t steps, int32_t speed_hz);
|
||||||
|
void driverTask();
|
||||||
|
static void driverTaskStart(void *arg);
|
||||||
|
|
||||||
|
bool running = false;
|
||||||
|
Config config;
|
||||||
|
rmt_channel_handle_t chan = nullptr;
|
||||||
|
rmt_encoder_handle_t enc = nullptr;
|
||||||
|
SemaphoreHandle_t infoMutex = nullptr;
|
||||||
|
SemaphoreHandle_t taskNotify = nullptr;
|
||||||
|
TaskHandle_t taskHandle = nullptr;
|
||||||
|
|
||||||
|
bool targetPending = false; ///< Do we have next move pending?
|
||||||
|
int32_t targetPosition = 0; ///< Target position in steps
|
||||||
|
int32_t targetPositionNext = 0; ///< Target position in steps (scheduled for next move)
|
||||||
|
uint8_t targetDir = 254; ///< Target direction to move
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Scratch RMT symbol buffers used by every move.
|
||||||
|
*
|
||||||
|
* The copy encoder pulls bytes from the source pointer asynchronously,
|
||||||
|
* so these buffers must outlive each transmission — every move is
|
||||||
|
* followed by @ref wait() before the next one reuses them.
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
rmt_symbol_word_t accelBuf[kAccelSteps]{};
|
||||||
|
rmt_symbol_word_t decelBuf[kAccelSteps]{};
|
||||||
|
rmt_symbol_word_t cruisePulse{};
|
||||||
|
/** @} */
|
||||||
|
};
|
||||||
@@ -90,6 +90,7 @@ lib_ignore = ${esp32_defaults.lib_ignore}
|
|||||||
re1.5
|
re1.5
|
||||||
DHT sensor library
|
DHT sensor library
|
||||||
ccronexpr
|
ccronexpr
|
||||||
|
esp-32-vid6608-rmt
|
||||||
custom_component_remove =
|
custom_component_remove =
|
||||||
espressif/network_provisioning
|
espressif/network_provisioning
|
||||||
espressif/esp_modem
|
espressif/esp_modem
|
||||||
|
|||||||
@@ -127,6 +127,7 @@ build_flags = ${env:tasmota32_base.build_flags}
|
|||||||
-DOTA_URL='"http://ota.tasmota.com/tasmota32/release/tasmota32c2.bin"'
|
-DOTA_URL='"http://ota.tasmota.com/tasmota32/release/tasmota32c2.bin"'
|
||||||
lib_ignore = ${env:tasmota32_base.lib_ignore}
|
lib_ignore = ${env:tasmota32_base.lib_ignore}
|
||||||
Micro-RTSP
|
Micro-RTSP
|
||||||
|
esp-32-vid6608-rmt
|
||||||
custom_sdkconfig =
|
custom_sdkconfig =
|
||||||
'# CONFIG_BT_ENABLED is not set'
|
'# CONFIG_BT_ENABLED is not set'
|
||||||
'# CONFIG_BT_NIMBLE_ENABLED is not set'
|
'# CONFIG_BT_NIMBLE_ENABLED is not set'
|
||||||
|
|||||||
@@ -334,6 +334,7 @@ lib_ignore = ${env:tasmota32_base.lib_ignore}
|
|||||||
esp-nimble-cpp
|
esp-nimble-cpp
|
||||||
Micro-RTSP
|
Micro-RTSP
|
||||||
epdiy
|
epdiy
|
||||||
|
esp-32-vid6608-rmt
|
||||||
|
|
||||||
[env:tasmota32c2]
|
[env:tasmota32c2]
|
||||||
extends = env:tasmota32_base
|
extends = env:tasmota32_base
|
||||||
@@ -343,6 +344,7 @@ build_flags = ${env:tasmota32_base.build_flags}
|
|||||||
-DOTA_URL='"http://ota.tasmota.com/tasmota32/release/tasmota32c2.bin"'
|
-DOTA_URL='"http://ota.tasmota.com/tasmota32/release/tasmota32c2.bin"'
|
||||||
lib_ignore = ${env:tasmota32_base.lib_ignore}
|
lib_ignore = ${env:tasmota32_base.lib_ignore}
|
||||||
Micro-RTSP
|
Micro-RTSP
|
||||||
|
esp-32-vid6608-rmt
|
||||||
|
|
||||||
[env:tasmota32c3]
|
[env:tasmota32c3]
|
||||||
extends = env:tasmota32_base
|
extends = env:tasmota32_base
|
||||||
|
|||||||
@@ -1145,7 +1145,8 @@
|
|||||||
//#define USE_HRE // Add support for Badger HR-E Water Meter (+1k4 code)
|
//#define USE_HRE // Add support for Badger HR-E Water Meter (+1k4 code)
|
||||||
//#define USE_A4988_STEPPER // Add support for A4988/DRV8825 stepper-motor-driver-circuit (+10k5 code)
|
//#define USE_A4988_STEPPER // Add support for A4988/DRV8825 stepper-motor-driver-circuit (+10k5 code)
|
||||||
//#define USE_VID6608 // Add support for VID6608 Automotive analog gauge driver (+0k7 code)
|
//#define USE_VID6608 // Add support for VID6608 Automotive analog gauge driver (+0k7 code)
|
||||||
// #define VID6608_RESET_ON_INIT true // Reset VID6608 on init (default: true), change if you control this manually
|
// #define VID6608_RESET_ON_INIT 1 // Reset VID6608 on init (default: true), change if you control this manually
|
||||||
|
// #define VID6608_RMT 0 // Use hardware RMT driver, ESP32 only. Warning: SoC have limited RMT count, amy conflict with others (WS2812b, IR and similar)
|
||||||
|
|
||||||
//#define USE_PROMETHEUS // Add support for https://prometheus.io/ metrics exporting over HTTP /metrics endpoint
|
//#define USE_PROMETHEUS // Add support for https://prometheus.io/ metrics exporting over HTTP /metrics endpoint
|
||||||
|
|
||||||
|
|||||||
@@ -64,15 +64,36 @@
|
|||||||
|
|
||||||
Version history:
|
Version history:
|
||||||
|
|
||||||
|
* 2026-05-17 - add support for ESP RMT driver
|
||||||
* 2025-11-23 - fixes related with ESP8266 performance
|
* 2025-11-23 - fixes related with ESP8266 performance
|
||||||
* 2025-11-22 - initial release
|
* 2025-11-22 - initial release
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Use HW RMT driver?
|
||||||
|
* Provides much better performance, but requires free RMT,
|
||||||
|
* some SoC (i.e. ESP32C6) have only 2 onboard, and some may be used by other drivers
|
||||||
|
* (like TasmotaLED and others).
|
||||||
|
*
|
||||||
|
* Default is disabled
|
||||||
|
*/
|
||||||
|
#if !defined(VID6608_RMT)
|
||||||
|
#define VID6608_RMT 0
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if VID6608_RMT
|
||||||
|
#include "soc/soc_caps.h"
|
||||||
|
#if !SOC_RMT_SUPPORTED
|
||||||
|
#error "VID6608 RMT is not supported on this platform"
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Driver impulse mode decision here
|
* @brief Driver impulse mode decision here
|
||||||
* ESP-32 has FreeRTOS, that allows us to perform precision inpulse control
|
* ESP-32 has FreeRTOS, that allows us to perform precision inpulse control
|
||||||
|
* Disabled in RMT mode
|
||||||
*/
|
*/
|
||||||
#ifdef ESP32
|
#if defined(ESP32) && !VID6608_RMT
|
||||||
#define VID6608_RTOS
|
#define VID6608_RTOS
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
@@ -82,8 +103,8 @@
|
|||||||
* Disable if you dont want to perform reset/homing operation on driver init,
|
* Disable if you dont want to perform reset/homing operation on driver init,
|
||||||
* usefull for cases, where you have advanced mode (i.e. use saved values from NVRAM to restore and manual reset).
|
* usefull for cases, where you have advanced mode (i.e. use saved values from NVRAM to restore and manual reset).
|
||||||
*/
|
*/
|
||||||
#ifndef VID6608_RESET_ON_INIT
|
#if !defined(VID6608_RESET_ON_INIT)
|
||||||
#define VID6608_RESET_ON_INIT true
|
#define VID6608_RESET_ON_INIT 1
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -98,27 +119,33 @@
|
|||||||
* Use defines VID6608_STEPS_X to configure steps range per-drive
|
* Use defines VID6608_STEPS_X to configure steps range per-drive
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef VID6608_STEPS_DEFAULT
|
#if !defined(VID6608_STEPS_DEFAULT)
|
||||||
#define VID6608_STEPS_DEFAULT 320 * 12
|
#define VID6608_STEPS_DEFAULT 320 * 12
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifndef VID6608_STEPS_1
|
#if !defined(VID6608_STEPS_1)
|
||||||
#define VID6608_STEPS_1 VID6608_STEPS_DEFAULT
|
#define VID6608_STEPS_1 VID6608_STEPS_DEFAULT
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifndef VID6608_STEPS_2
|
#if !defined(VID6608_STEPS_2)
|
||||||
#define VID6608_STEPS_2 VID6608_STEPS_DEFAULT
|
#define VID6608_STEPS_2 VID6608_STEPS_DEFAULT
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifndef VID6608_STEPS_3
|
#if !defined(VID6608_STEPS_3)
|
||||||
#define VID6608_STEPS_3 VID6608_STEPS_DEFAULT
|
#define VID6608_STEPS_3 VID6608_STEPS_DEFAULT
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifndef VID6608_STEPS_4
|
#if !defined(VID6608_STEPS_4)
|
||||||
#define VID6608_STEPS_4 VID6608_STEPS_DEFAULT
|
#define VID6608_STEPS_4 VID6608_STEPS_DEFAULT
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#include "vid6608.h"
|
#if VID6608_RMT
|
||||||
|
#include "esp32_vid6608_rmt.h"
|
||||||
|
#define VID6608_CLASS esp32_vid6608_rmt
|
||||||
|
#else
|
||||||
|
#include "vid6608.h"
|
||||||
|
#define VID6608_CLASS vid6608
|
||||||
|
#endif
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Command definition
|
* @brief Command definition
|
||||||
@@ -148,8 +175,9 @@ enum GaugeInternalCommand {
|
|||||||
* @brief Global vars
|
* @brief Global vars
|
||||||
*/
|
*/
|
||||||
bool vid6608Present = false;
|
bool vid6608Present = false;
|
||||||
vid6608 *vid6608Drives[VID6608_MAX_DRIVES];
|
VID6608_CLASS *vid6608Drives[VID6608_MAX_DRIVES];
|
||||||
#ifdef VID6608_RTOS
|
|
||||||
|
#if defined(VID6608_RTOS)
|
||||||
/**
|
/**
|
||||||
* @brief Mutex for RTOS precision timing
|
* @brief Mutex for RTOS precision timing
|
||||||
*
|
*
|
||||||
@@ -218,7 +246,7 @@ void CmndGaugeCommand(int32_t command, uint32_t index, int32_t payload) {
|
|||||||
bool isFirstItem = true;
|
bool isFirstItem = true;
|
||||||
for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) {
|
for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) {
|
||||||
if (index == 0 || index == (x+1)) {
|
if (index == 0 || index == (x+1)) {
|
||||||
vid6608 *driver = vid6608Drives[x];
|
VID6608_CLASS *driver = vid6608Drives[x];
|
||||||
if (driver) {
|
if (driver) {
|
||||||
if (!isFirstItem) {
|
if (!isFirstItem) {
|
||||||
ResponseAppend_P(PSTR(","));
|
ResponseAppend_P(PSTR(","));
|
||||||
@@ -259,7 +287,7 @@ void VID6608StatusJson() {
|
|||||||
bool isFirstItem = true;
|
bool isFirstItem = true;
|
||||||
VID6608_MUTEX_TAKE
|
VID6608_MUTEX_TAKE
|
||||||
for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) {
|
for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) {
|
||||||
vid6608 *driver = vid6608Drives[x];
|
VID6608_CLASS *driver = vid6608Drives[x];
|
||||||
if (driver) {
|
if (driver) {
|
||||||
if (!isFirstItem) {
|
if (!isFirstItem) {
|
||||||
ResponseAppend_P(PSTR(","));
|
ResponseAppend_P(PSTR(","));
|
||||||
@@ -281,7 +309,7 @@ void VID6608StatusWeb() {
|
|||||||
WSContentSend_PD(HTTP_TABLE100);
|
WSContentSend_PD(HTTP_TABLE100);
|
||||||
VID6608_MUTEX_TAKE
|
VID6608_MUTEX_TAKE
|
||||||
for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) {
|
for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) {
|
||||||
vid6608 *driver = vid6608Drives[x];
|
VID6608_CLASS *driver = vid6608Drives[x];
|
||||||
if (driver) {
|
if (driver) {
|
||||||
WSContentSend_PD(PSTR("<tr><th>Gauge %d</th><td>%d</td></tr>"), (int32_t)(x+1), (int32_t)driver->getPosition());
|
WSContentSend_PD(PSTR("<tr><th>Gauge %d</th><td>%d</td></tr>"), (int32_t)(x+1), (int32_t)driver->getPosition());
|
||||||
}
|
}
|
||||||
@@ -291,7 +319,7 @@ void VID6608StatusWeb() {
|
|||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef VID6608_RTOS
|
#if defined(VID6608_RTOS)
|
||||||
/**
|
/**
|
||||||
* @brief FreeRTOS background process function
|
* @brief FreeRTOS background process function
|
||||||
* This function is required to handle movement with precision timings.
|
* This function is required to handle movement with precision timings.
|
||||||
@@ -302,7 +330,7 @@ void VID6608XvTask(void *) {
|
|||||||
bool needToMove = false;
|
bool needToMove = false;
|
||||||
VID6608_MUTEX_TAKE
|
VID6608_MUTEX_TAKE
|
||||||
for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) {
|
for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) {
|
||||||
vid6608 *driver = vid6608Drives[x];
|
VID6608_CLASS *driver = vid6608Drives[x];
|
||||||
if (driver) {
|
if (driver) {
|
||||||
driver->loop();
|
driver->loop();
|
||||||
if (driver->isMoving()) {
|
if (driver->isMoving()) {
|
||||||
@@ -335,15 +363,25 @@ void VID6608Init() {
|
|||||||
uint32_t pinDir = Pin(GPIO_VID6608_CW, x);
|
uint32_t pinDir = Pin(GPIO_VID6608_CW, x);
|
||||||
uint16_t maxSteps = 0;
|
uint16_t maxSteps = 0;
|
||||||
memcpy_P(&maxSteps, &vid6608MaxSteps[x], 2);
|
memcpy_P(&maxSteps, &vid6608MaxSteps[x], 2);
|
||||||
AddLog(LOG_LEVEL_DEBUG, PSTR("VID: detected drive %d at pin %d, %d, steps %d"), x, pinStep, pinDir, (uint32_t)maxSteps);
|
AddLog(LOG_LEVEL_DEBUG, PSTR("VID: Detected drive %d at pin %d, %d, steps %d"), x, pinStep, pinDir, (uint32_t)maxSteps);
|
||||||
vid6608Drives[x] = new vid6608(pinStep, pinDir, maxSteps);
|
#if VID6608_RMT
|
||||||
|
AddLog(LOG_LEVEL_DEBUG, PSTR("VID: Using hardware RMT driver"));
|
||||||
|
esp32_vid6608_rmt::Config cfg;
|
||||||
|
cfg.stepPin = (gpio_num_t)pinStep;
|
||||||
|
cfg.dirPin = (gpio_num_t)pinDir;
|
||||||
|
cfg.maxSteps = maxSteps;
|
||||||
|
vid6608Drives[x] = new esp32_vid6608_rmt(cfg);
|
||||||
|
#else
|
||||||
|
AddLog(LOG_LEVEL_DEBUG, PSTR("VID: Using software driver"));
|
||||||
|
vid6608Drives[x] = new vid6608(pinStep, pinDir, maxSteps);
|
||||||
|
#endif
|
||||||
|
|
||||||
// Perform homing operation
|
// Perform homing operation
|
||||||
if (VID6608_RESET_ON_INIT) {
|
if (VID6608_RESET_ON_INIT) {
|
||||||
vid6608Drives[x]->zero();
|
vid6608Drives[x]->zero();
|
||||||
AddLog(LOG_LEVEL_DEBUG, PSTR("VID: zero %d done"), x);
|
AddLog(LOG_LEVEL_DEBUG, PSTR("VID: Zero %d done"), x);
|
||||||
} else {
|
} else {
|
||||||
AddLog(LOG_LEVEL_DEBUG, PSTR("VID: zero %d skipped"), x);
|
AddLog(LOG_LEVEL_DEBUG, PSTR("VID: Zero %d skipped"), x);
|
||||||
}
|
}
|
||||||
vid6608Present = true;
|
vid6608Present = true;
|
||||||
} else {
|
} else {
|
||||||
@@ -354,7 +392,8 @@ void VID6608Init() {
|
|||||||
if (!vid6608Present) {
|
if (!vid6608Present) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
#ifdef VID6608_RTOS
|
#if defined(VID6608_RTOS)
|
||||||
|
AddLog(LOG_LEVEL_DEBUG, PSTR("VID: Using FreeRTOS mode"));
|
||||||
// Create mutex for RTOS thread safety
|
// Create mutex for RTOS thread safety
|
||||||
vid6608Mutex = xSemaphoreCreateMutex();
|
vid6608Mutex = xSemaphoreCreateMutex();
|
||||||
// Start background RTOS thread -> required for precision timing
|
// Start background RTOS thread -> required for precision timing
|
||||||
@@ -370,14 +409,14 @@ void VID6608Init() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Classical loop implementation
|
// Classical loop implementation
|
||||||
#ifndef VID6608_RTOS
|
#if !defined(VID6608_RTOS) && !VID6608_RMT
|
||||||
/**
|
/**
|
||||||
* @brief Non-FreeRTOS background process function
|
* @brief Non-FreeRTOS background process function
|
||||||
* ESP8266 classical loop() thread function, used where is no FreeRTOS.
|
* ESP8266 classical loop() thread function, used where is no FreeRTOS.
|
||||||
*/
|
*/
|
||||||
bool VID6608Loop() {
|
bool VID6608Loop() {
|
||||||
for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) {
|
for (uint8_t x = 0; x < VID6608_MAX_DRIVES; x++) {
|
||||||
vid6608 *driver = vid6608Drives[x];
|
VID6608_CLASS *driver = vid6608Drives[x];
|
||||||
if (driver) {
|
if (driver) {
|
||||||
driver->loop();
|
driver->loop();
|
||||||
}
|
}
|
||||||
@@ -405,9 +444,10 @@ bool Xdrv92(uint32_t function) {
|
|||||||
|
|
||||||
switch (function) {
|
switch (function) {
|
||||||
case FUNC_LOOP:
|
case FUNC_LOOP:
|
||||||
#ifndef VID6608_RTOS
|
#if !defined(VID6608_RTOS) && !VID6608_RMT
|
||||||
// ESP32 uses FreeRTOS to manage moving tasks, as it requires precision timings
|
// 1. ESP32 uses FreeRTOS to manage moving tasks, as it requires precision timings
|
||||||
// Others should use regular loop -> slower, but still works
|
// Others should use regular loop -> slower, but still works
|
||||||
|
// 2. ESP32 RMT version does not need loop
|
||||||
result = VID6608Loop();
|
result = VID6608Loop();
|
||||||
#else
|
#else
|
||||||
result = true;
|
result = true;
|
||||||
|
|||||||
Reference in New Issue
Block a user