fix submodule

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "XFTGenerator"]
+	path = XFTGenerator
+	url = git@git.kb28.ch:HEL/XFTGenerator.git

LICENSE

@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are 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.
+
+  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.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  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 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 work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero 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 Affero 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 Affero 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 Affero 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) 2023  remi
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  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 AGPL, see
+<https://www.gnu.org/licenses/>.

Makefile

@@ -1,113 +0,0 @@
-#
-#  There exist several targets which are by default empty and which can be 
-#  used for execution of your targets. These targets are usually executed 
-#  before and after some main targets. They are: 
-#
-#     .build-pre:              called before 'build' target
-#     .build-post:             called after 'build' target
-#     .clean-pre:              called before 'clean' target
-#     .clean-post:             called after 'clean' target
-#     .clobber-pre:            called before 'clobber' target
-#     .clobber-post:           called after 'clobber' target
-#     .all-pre:                called before 'all' target
-#     .all-post:               called after 'all' target
-#     .help-pre:               called before 'help' target
-#     .help-post:              called after 'help' target
-#
-#  Targets beginning with '.' are not intended to be called on their own.
-#
-#  Main targets can be executed directly, and they are:
-#  
-#     build                    build a specific configuration
-#     clean                    remove built files from a configuration
-#     clobber                  remove all built files
-#     all                      build all configurations
-#     help                     print help mesage
-#  
-#  Targets .build-impl, .clean-impl, .clobber-impl, .all-impl, and
-#  .help-impl are implemented in nbproject/makefile-impl.mk.
-#
-#  Available make variables:
-#
-#     CND_BASEDIR                base directory for relative paths
-#     CND_DISTDIR                default top distribution directory (build artifacts)
-#     CND_BUILDDIR               default top build directory (object files, ...)
-#     CONF                       name of current configuration
-#     CND_ARTIFACT_DIR_${CONF}   directory of build artifact (current configuration)
-#     CND_ARTIFACT_NAME_${CONF}  name of build artifact (current configuration)
-#     CND_ARTIFACT_PATH_${CONF}  path to build artifact (current configuration)
-#     CND_PACKAGE_DIR_${CONF}    directory of package (current configuration)
-#     CND_PACKAGE_NAME_${CONF}   name of package (current configuration)
-#     CND_PACKAGE_PATH_${CONF}   path to package (current configuration)
-#
-# NOCDDL
-
-
-# Environment 
-MKDIR=mkdir
-CP=cp
-CCADMIN=CCadmin
-RANLIB=ranlib
-
-
-# build
-build: .build-post
-
-.build-pre:
-# Add your pre 'build' code here...
-
-.build-post: .build-impl
-# Add your post 'build' code here...
-
-
-# clean
-clean: .clean-post
-
-.clean-pre:
-# Add your pre 'clean' code here...
-# WARNING: the IDE does not call this target since it takes a long time to
-# simply run make. Instead, the IDE removes the configuration directories
-# under build and dist directly without calling make.
-# This target is left here so people can do a clean when running a clean
-# outside the IDE.
-
-.clean-post: .clean-impl
-# Add your post 'clean' code here...
-
-
-# clobber
-clobber: .clobber-post
-
-.clobber-pre:
-# Add your pre 'clobber' code here...
-
-.clobber-post: .clobber-impl
-# Add your post 'clobber' code here...
-
-
-# all
-all: .all-post
-
-.all-pre:
-# Add your pre 'all' code here...
-
-.all-post: .all-impl
-# Add your post 'all' code here...
-
-
-# help
-help: .help-post
-
-.help-pre:
-# Add your pre 'help' code here...
-
-.help-post: .help-impl
-# Add your post 'help' code here...
-
-
-
-# include project implementation makefile
-include nbproject/Makefile-impl.mk
-
-# include project make variables
-include nbproject/Makefile-variables.mk

README.md

@@ -0,0 +1,57 @@
+# XFT
+eXecutive Framework Template (XFT) is a template for project with femto XF.
+
+Femto XF is an eXecutive Framework for embedded systems developed
+in the University of Applied Sciences Western Switzerland (HES-SO Valais/Wallis)
+by Pierre-André Mudry, Pascal Sartoretti and Medar Rieder.
+
+This template is specifically designed for a PIC18F board. It's template for work with state machines.
+It used the model of the 5 layers for the packaging and double switch pattern for the state machine.
+
+## Layers
+### App
+Here is the place for the application code.
+The application code is the code that is specific to the application and that is not reusable on another application.
+Here you can find the factory and obviously the main.
+
+### Board
+Here is the place for the board specific code.
+The board code is the code that is not reusable on another board.
+
+Here you can find in bonus a class for the LED and a class for the button for a PIC18F board.
+
+### MCC Generated Files
+Here is the files generated by the MPLAB Code Configurator (MCC).
+You maybe have to regenerate them if you change the configuration of the board.
+
+### Middleware
+Here is the place for the middleware code.
+The middleware code is the code that is not specific to the board and that is reusable on another board.
+Here you can find in bonus a class for a blinker and a class for a click handler.
+
+### XF
+Here is the femto XF framework. No modification is needed.
+
+## State machines
+### Generator
+You can generate a class for state machine with the following command:
+```bash
+python3 ./XFTGenerator/XFTGenerator.py
+```
+You can find the generated class in the folder `XFTGenerator/out/`.
+For more details about generator, see the README.md in the folder `XFTGenerator/`.
+
+### How it works
+The architecture is based around the method `processEvent()`.
+This method is called by the XF when an event is received.
+
+The method `processEvent()` is a switch on the current state.
+The first switch is switched on the actual state. The second switch is switched on event on exit and a third switch is switched on event on entry.
+
+For each entry on an event you have a callback method than you can define in the class with the FILENAME_onState() method.
+
+For each variables you have a setter.
+
+For each event you have an emitter method that you can call in the class with the FILENAME_emitEvent() method.
+
+Look the comments of .h file for more details.

nbproject/configurations.xml

@@ -1,212 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<configurationDescriptor version="65">
-  <logicalFolder name="root" displayName="root" projectFiles="true">
-    <logicalFolder name="HeaderFiles"
-                   displayName="Header Files"
-                   projectFiles="true">
-      <logicalFolder name="app" displayName="app" projectFiles="true">
-        <itemPath>src/app/factory.h</itemPath>
-      </logicalFolder>
-      <logicalFolder name="board" displayName="board" projectFiles="true">
-        <itemPath>src/board/led.h</itemPath>
-      </logicalFolder>
-      <logicalFolder name="mcc_generated_files"
-                     displayName="mcc_generated_files"
-                     projectFiles="true">
-        <itemPath>src/mcc_generated_files/tmr0.h</itemPath>
-        <itemPath>src/mcc_generated_files/pin_manager.h</itemPath>
-        <itemPath>src/mcc_generated_files/mcc.h</itemPath>
-        <itemPath>src/mcc_generated_files/interrupt_manager.h</itemPath>
-        <itemPath>src/mcc_generated_files/device_config.h</itemPath>
-      </logicalFolder>
-      <logicalFolder name="xf" displayName="xf" projectFiles="true">
-        <itemPath>src/xf/ireactive.h</itemPath>
-        <itemPath>src/xf/event.h</itemPath>
-        <itemPath>src/xf/xf.h</itemPath>
-      </logicalFolder>
-    </logicalFolder>
-    <logicalFolder name="LinkerScript"
-                   displayName="Linker Files"
-                   projectFiles="true">
-    </logicalFolder>
-    <logicalFolder name="SourceFiles"
-                   displayName="Source Files"
-                   projectFiles="true">
-      <logicalFolder name="app" displayName="app" projectFiles="true">
-        <itemPath>src/app/factory.c</itemPath>
-        <itemPath>src/app/main.c</itemPath>
-      </logicalFolder>
-      <logicalFolder name="board" displayName="board" projectFiles="true">
-        <itemPath>src/board/led.c</itemPath>
-      </logicalFolder>
-      <logicalFolder name="mcc_generated_files"
-                     displayName="mcc_generated_files"
-                     projectFiles="true">
-        <itemPath>src/mcc_generated_files/mcc.c</itemPath>
-        <itemPath>src/mcc_generated_files/interrupt_manager.c</itemPath>
-        <itemPath>src/mcc_generated_files/device_config.c</itemPath>
-        <itemPath>src/mcc_generated_files/pin_manager.c</itemPath>
-        <itemPath>src/mcc_generated_files/tmr0.c</itemPath>
-      </logicalFolder>
-      <logicalFolder name="xf" displayName="xf" projectFiles="true">
-        <itemPath>src/xf/xf.c</itemPath>
-        <itemPath>src/xf/event.c</itemPath>
-      </logicalFolder>
-    </logicalFolder>
-    <logicalFolder name="ExternalFiles"
-                   displayName="Important Files"
-                   projectFiles="false">
-      <itemPath>Makefile</itemPath>
-    </logicalFolder>
-  </logicalFolder>
-  <sourceRootList>
-    <Elem>src</Elem>
-  </sourceRootList>
-  <projectmakefile>Makefile</projectmakefile>
-  <confs>
-    <conf name="default" type="2">
-      <toolsSet>
-        <developmentServer>localhost</developmentServer>
-        <targetDevice>PIC18F87K22</targetDevice>
-        <targetHeader></targetHeader>
-        <targetPluginBoard></targetPluginBoard>
-        <platformTool>PICkit3PlatformTool</platformTool>
-        <languageToolchain>XC8</languageToolchain>
-        <languageToolchainVersion>2.41</languageToolchainVersion>
-        <platform>2</platform>
-      </toolsSet>
-      <packs>
-        <pack name="PIC18F-K_DFP" vendor="Microchip" version="1.7.134"/>
-      </packs>
-      <ScriptingSettings>
-      </ScriptingSettings>
-      <compileType>
-        <linkerTool>
-          <linkerLibItems>
-          </linkerLibItems>
-        </linkerTool>
-        <archiverTool>
-        </archiverTool>
-        <loading>
-          <useAlternateLoadableFile>false</useAlternateLoadableFile>
-          <parseOnProdLoad>false</parseOnProdLoad>
-          <alternateLoadableFile></alternateLoadableFile>
-        </loading>
-        <subordinates>
-        </subordinates>
-      </compileType>
-      <makeCustomizationType>
-        <makeCustomizationPreStepEnabled>false</makeCustomizationPreStepEnabled>
-        <makeUseCleanTarget>false</makeUseCleanTarget>
-        <makeCustomizationPreStep></makeCustomizationPreStep>
-        <makeCustomizationPostStepEnabled>false</makeCustomizationPostStepEnabled>
-        <makeCustomizationPostStep></makeCustomizationPostStep>
-        <makeCustomizationPutChecksumInUserID>false</makeCustomizationPutChecksumInUserID>
-        <makeCustomizationEnableLongLines>false</makeCustomizationEnableLongLines>
-        <makeCustomizationNormalizeHexFile>false</makeCustomizationNormalizeHexFile>
-      </makeCustomizationType>
-      <HI-TECH-COMP>
-        <property key="additional-warnings" value="true"/>
-        <property key="asmlist" value="true"/>
-        <property key="call-prologues" value="false"/>
-        <property key="default-bitfield-type" value="true"/>
-        <property key="default-char-type" value="true"/>
-        <property key="define-macros" value=""/>
-        <property key="disable-optimizations" value="true"/>
-        <property key="extra-include-directories" value=""/>
-        <property key="favor-optimization-for" value="-speed,+space"/>
-        <property key="garbage-collect-data" value="true"/>
-        <property key="garbage-collect-functions" value="true"/>
-        <property key="identifier-length" value="255"/>
-        <property key="local-generation" value="false"/>
-        <property key="operation-mode" value="free"/>
-        <property key="opt-xc8-compiler-strict_ansi" value="false"/>
-        <property key="optimization-assembler" value="true"/>
-        <property key="optimization-assembler-files" value="true"/>
-        <property key="optimization-debug" value="false"/>
-        <property key="optimization-invariant-enable" value="false"/>
-        <property key="optimization-invariant-value" value="16"/>
-        <property key="optimization-level" value="-O0"/>
-        <property key="optimization-speed" value="false"/>
-        <property key="optimization-stable-enable" value="false"/>
-        <property key="preprocess-assembler" value="true"/>
-        <property key="short-enums" value="true"/>
-        <property key="tentative-definitions" value="-fno-common"/>
-        <property key="undefine-macros" value=""/>
-        <property key="use-cci" value="false"/>
-        <property key="use-iar" value="false"/>
-        <property key="verbose" value="false"/>
-        <property key="warning-level" value="-3"/>
-        <property key="what-to-do" value="ignore"/>
-      </HI-TECH-COMP>
-      <HI-TECH-LINK>
-        <property key="additional-options-checksum" value=""/>
-        <property key="additional-options-code-offset" value=""/>
-        <property key="additional-options-command-line" value=""/>
-        <property key="additional-options-errata" value=""/>
-        <property key="additional-options-extend-address" value="false"/>
-        <property key="additional-options-trace-type" value=""/>
-        <property key="additional-options-use-response-files" value="false"/>
-        <property key="backup-reset-condition-flags" value="false"/>
-        <property key="calibrate-oscillator" value="false"/>
-        <property key="calibrate-oscillator-value" value="0x3400"/>
-        <property key="clear-bss" value="true"/>
-        <property key="code-model-external" value="wordwrite"/>
-        <property key="code-model-rom" value=""/>
-        <property key="create-html-files" value="false"/>
-        <property key="data-model-ram" value=""/>
-        <property key="data-model-size-of-double" value="32"/>
-        <property key="data-model-size-of-double-gcc" value="no-short-double"/>
-        <property key="data-model-size-of-float" value="32"/>
-        <property key="data-model-size-of-float-gcc" value="no-short-float"/>
-        <property key="display-class-usage" value="false"/>
-        <property key="display-hex-usage" value="false"/>
-        <property key="display-overall-usage" value="true"/>
-        <property key="display-psect-usage" value="false"/>
-        <property key="extra-lib-directories" value=""/>
-        <property key="fill-flash-options-addr" value=""/>
-        <property key="fill-flash-options-const" value=""/>
-        <property key="fill-flash-options-how" value="0"/>
-        <property key="fill-flash-options-inc-const" value="1"/>
-        <property key="fill-flash-options-increment" value=""/>
-        <property key="fill-flash-options-seq" value=""/>
-        <property key="fill-flash-options-what" value="0"/>
-        <property key="format-hex-file-for-download" value="false"/>
-        <property key="initialize-data" value="true"/>
-        <property key="input-libraries" value="libm"/>
-        <property key="keep-generated-startup.as" value="false"/>
-        <property key="link-in-c-library" value="true"/>
-        <property key="link-in-c-library-gcc" value=""/>
-        <property key="link-in-peripheral-library" value="false"/>
-        <property key="managed-stack" value="false"/>
-        <property key="opt-xc8-linker-file" value="false"/>
-        <property key="opt-xc8-linker-link_startup" value="false"/>
-        <property key="opt-xc8-linker-serial" value=""/>
-        <property key="program-the-device-with-default-config-words" value="true"/>
-        <property key="remove-unused-sections" value="true"/>
-      </HI-TECH-LINK>
-      <XC8-CO>
-        <property key="coverage-enable" value=""/>
-        <property key="stack-guidance" value="false"/>
-      </XC8-CO>
-      <XC8-config-global>
-        <property key="advanced-elf" value="true"/>
-        <property key="constdata-progmem" value="true"/>
-        <property key="gcc-opt-driver-new" value="true"/>
-        <property key="gcc-opt-std" value="-std=c99"/>
-        <property key="gcc-output-file-format" value="dwarf-3"/>
-        <property key="mapped-progmem" value="false"/>
-        <property key="omit-pack-options" value="false"/>
-        <property key="omit-pack-options-new" value="1"/>
-        <property key="output-file-format" value="-mcof,+elf"/>
-        <property key="smart-io-format" value=""/>
-        <property key="stack-size-high" value="auto"/>
-        <property key="stack-size-low" value="auto"/>
-        <property key="stack-size-main" value="auto"/>
-        <property key="stack-type" value="compiled"/>
-        <property key="user-pack-device-support" value=""/>
-        <property key="wpo-lto" value="false"/>
-      </XC8-config-global>
-    </conf>
-  </confs>
-</configurationDescriptor>

nbproject/project.xml

@@ -1,25 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://www.netbeans.org/ns/project/1">
-    <type>com.microchip.mplab.nbide.embedded.makeproject</type>
-    <configuration>
-        <data xmlns="http://www.netbeans.org/ns/make-project/1">
-            <name>XFT</name>
-            <creation-uuid>9d10e4b8-91cc-4d86-8f12-a6fd880b26ed</creation-uuid>
-            <make-project-type>0</make-project-type>
-            <sourceEncoding>UTF-8</sourceEncoding>
-            <make-dep-projects/>
-            <sourceRootList>
-                <sourceRootElem>src</sourceRootElem>
-            </sourceRootList>
-            <confList>
-                <confElem>
-                    <name>default</name>
-                    <type>2</type>
-                </confElem>
-            </confList>
-            <formatting>
-                <project-formatting-style>false</project-formatting-style>
-            </formatting>
-        </data>
-    </configuration>
-</project>

src/app/factory.c

@@ -1,60 +1,124 @@
-/*$file${.::app::factory.c} vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv*/
-/*
-* Model: XFT.qm
-* File:  ${.::app::factory.c}
-*
-* This code has been generated by QM 5.2.5 <www.state-machine.com/qm>.
-* DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
-*
-* SPDX-License-Identifier: GPL-3.0-or-later
-*
-* This generated code is open source software: you can redistribute it under
-* the terms of the GNU General Public License as published by the Free
-* Software Foundation.
-*
-* This code 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.
-*
-* NOTE:
-* Alternatively, this generated code may be distributed under the terms
-* of Quantum Leaps commercial licenses, which expressly supersede the GNU
-* General Public License and are specifically designed for licensees
-* interested in retaining the proprietary status of their code.
-*
-* Contact information:
-* <www.state-machine.com/licensing>
-* <info@state-machine.com>
-*/
-/*$endhead${.::app::factory.c} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^*/
-/*
+/**
  * @author Rémi Heredero
+ * @version. 1.0.0
  * @date July 2023
- * @version 1.0.0
- * @see work of Medar Rieder & Pascal Sartoretti about femto XF
  */
-
 #include "factory.h"
-Factory Factory_theFactory;
 
-/*${app::Factory::init} ....................................................*/
-void Factory_init(void) {
-    LED_init(Factory_l1(), 1);
-    LED_initHW(Factory_l1());
+
+//the factory object containing all objects of our system
+static Factory theFactory;
+
+
+//all the getters
+LED* l1() {
+    return &theFactory.l1_;
+}
+LED* l2()  {
+    return &theFactory.l2_;
+}
+LED* l3()  {
+    return &theFactory.l3_;
+}
+LED* l4()  {
+    return &theFactory.l4_;
+}
+LED* l5()  {
+    return &theFactory.l5_;
+}
+LED* l6()  {
+    return &theFactory.l6_;
+}
+LED* l7()  {
+    return &theFactory.l7_;
+}
+LED* l8()  {
+    return &theFactory.l8_;
+}
+LED* l9()  {
+    return &theFactory.l9_;
+}
+LED* l10()  {
+    return &theFactory.l10_;
 }
 
+BUTTON* b1() {
+    return &theFactory.b1_;
+}
+BUTTON* b2() {
+    return &theFactory.b2_;
+}
+BUTTON* b3() {
+    return &theFactory.b3_;
+}
+
+CLICK_HANDLER* ch1() {
+    return &theFactory.ch1_;
+}
+CLICK_HANDLER* ch2() {
+    return &theFactory.ch2_;
+}
+CLICK_HANDLER* ch3() {
+    return &theFactory.ch3_;
+}
+
+//initialize all objects
+void Factory_init() {
+    LED_init(l1(), 1);
+    LED_init(l2(), 2);
+    LED_init(l3(), 3);
+    LED_init(l4(), 4);
+    LED_init(l5(), 5);
+    LED_init(l6(), 6);
+    LED_init(l7(), 7);
+    LED_init(l8(), 8);
+    LED_init(l9(), 9);
+    LED_init(l10(), 10);
+    
+    LED_initHW(l1());
+    LED_initHW(l2());
+    LED_initHW(l3());
+    LED_initHW(l4());
+    LED_initHW(l5());
+    LED_initHW(l6());
+    LED_initHW(l7());
+    LED_initHW(l8());
+    LED_initHW(l9());
+    LED_initHW(l10());
+
+    BUTTON_init(b1(), 1);
+    BUTTON_init(b2(), 2);
+    BUTTON_init(b3(), 3);
+    
+    BUTTON_initHW(b1());
+    BUTTON_initHW(b2());
+    BUTTON_initHW(b3());
+    
+    CLICK_HANDLER_init(ch1());
+    CLICK_HANDLER_init(ch2());
+    CLICK_HANDLER_init(ch3());
+
+}
+
+//connect objects if required
 void Factory_build() {
     
+    BUTTON_onPressed(b1(), &CLICK_HANDLER_emitPbpress, ch1());
+    BUTTON_onPressed(b2(), &CLICK_HANDLER_emitPbpress, ch2());
+    BUTTON_onPressed(b3(), &CLICK_HANDLER_emitPbpress, ch3());
+    
+    BUTTON_onReleased(b1(), &CLICK_HANDLER_emitPbrelease, ch1());
+    BUTTON_onReleased(b2(), &CLICK_HANDLER_emitPbrelease, ch2());
+    BUTTON_onReleased(b3(), &CLICK_HANDLER_emitPbrelease, ch3());
+
 }
 
-/*${app::Factory::start} ...................................................*/
-void Factory_start(void) {
-    LED_on(Factory_l1());
+//start all state machines
+void Factory_start() {
+    BUTTON_startBehaviour(b1());
+    BUTTON_startBehaviour(b2());
+    BUTTON_startBehaviour(b3());
+    CLICK_HANDLER_startBehaviour(ch1());
+    CLICK_HANDLER_startBehaviour(ch2());
+    CLICK_HANDLER_startBehaviour(ch3());
 }
-
-/*${app::Factory::l1} ......................................................*/
-LED* Factory_l1(void) {
-    return &Factory_theFactory.l1_;
-}
-/*$enddef${app::Factory} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^*/

src/app/factory.h

@@ -1,38 +1,7 @@
-/*$file${.::app::factory.h} vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv*/
-/*
-* Model: XFT.qm
-* File:  ${.::app::factory.h}
-*
-* This code has been generated by QM 5.2.5 <www.state-machine.com/qm>.
-* DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
-*
-* SPDX-License-Identifier: GPL-3.0-or-later
-*
-* This generated code is open source software: you can redistribute it under
-* the terms of the GNU General Public License as published by the Free
-* Software Foundation.
-*
-* This code 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.
-*
-* NOTE:
-* Alternatively, this generated code may be distributed under the terms
-* of Quantum Leaps commercial licenses, which expressly supersede the GNU
-* General Public License and are specifically designed for licensees
-* interested in retaining the proprietary status of their code.
-*
-* Contact information:
-* <www.state-machine.com/licensing>
-* <info@state-machine.com>
-*/
-/*$endhead${.::app::factory.h} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^*/
-/*
+/**
  * @author Rémi Heredero
+ * @version. 1.0.0
  * @date July 2023
- * @version 1.0.0
- * @see work of Medar Rieder & Pascal Sartoretti about femto XF
  */
 
 #ifndef FACTORY_H
@@ -42,21 +11,52 @@
 #include <stdbool.h>
 
 #include "../board/led.h"
+#include "../board/button.h"
+#include "../middleware/click_handler.h"
+#include "../middleware/blinker.h"
 
-/*$declare${app::Factory} vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv*/
-
-/*${app::Factory} ..........................................................*/
-typedef struct Factory {
-/* public: */
+typedef struct {
     LED l1_;
+    LED l2_;
+    LED l3_;
+    LED l4_;
+    LED l5_;
+    LED l6_;
+    LED l7_;
+    LED l8_;
+    LED l9_;
+    LED l10_;
+    BUTTON b1_;
+    BUTTON b2_;
+    BUTTON b3_;
+    CLICK_HANDLER ch1_;
+    CLICK_HANDLER ch2_;
+    CLICK_HANDLER ch3_;
 } Factory;
 
-/* public: */
-void Factory_init(void);
-void Factory_build(void);
-void Factory_start(void);
-LED* Factory_l1(void);
-extern Factory Factory_theFactory;
-/*$enddecl${app::Factory} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^*/
+
+void Factory_init();
+void Factory_build();
+void Factory_start();
+
+//these are global getters for our objects
+LED* l1();
+LED* l2();
+LED* l3();
+LED* l4();
+LED* l5();
+LED* l6();
+LED* l7();
+LED* l8();
+LED* l9();
+LED* l10();
+
+BUTTON* b1();
+BUTTON* b2();
+BUTTON* b3();
+
+CLICK_HANDLER* ch1();
+CLICK_HANDLER* ch2();
+CLICK_HANDLER* ch3();
 
 #endif

src/app/main.c

@@ -1,37 +1,12 @@
 
-/*
-* Model: XFT.qm
-* File:  ${.::app::main.c}
-*
-* This code has been generated by QM 5.2.5 <www.state-machine.com/qm>.
-* DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
-*
-* SPDX-License-Identifier: GPL-3.0-or-later
-*
-* This generated code is open source software: you can redistribute it under
-* the terms of the GNU General Public License as published by the Free
-* Software Foundation.
-*
-* This code 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.
-*
-* NOTE:
-* Alternatively, this generated code may be distributed under the terms
-* of Quantum Leaps commercial licenses, which expressly supersede the GNU
-* General Public License and are specifically designed for licensees
-* interested in retaining the proprietary status of their code.
-*
-* Contact information:
-* <www.state-machine.com/licensing>
-* <info@state-machine.com>
-*/
 #include "../mcc_generated_files/mcc.h"
 #include "../app/factory.h"
 #include "../xf/xf.h"
 
-void main(void) {
+
+
+void main(void)
+{
     // Initialize the device
     SYSTEM_Initialize();
     
@@ -52,6 +27,5 @@ void main(void) {
     
     while (1) {
         XF_executeOnce();
-
     }
 }

src/board/button.c

@@ -1,62 +1,158 @@
-/*$file${.::board::button.c} vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv*/
-/*
-* Model: XFT.qm
-* File:  ${.::board::button.c}
-*
-* This code has been generated by QM 5.2.5 <www.state-machine.com/qm>.
-* DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
-*
-* SPDX-License-Identifier: GPL-3.0-or-later
-*
-* This generated code is open source software: you can redistribute it under
-* the terms of the GNU General Public License as published by the Free
-* Software Foundation.
-*
-* This code 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.
-*
-* NOTE:
-* Alternatively, this generated code may be distributed under the terms
-* of Quantum Leaps commercial licenses, which expressly supersede the GNU
-* General Public License and are specifically designed for licensees
-* interested in retaining the proprietary status of their code.
-*
-* Contact information:
-* <www.state-machine.com/licensing>
-* <info@state-machine.com>
+/**
+ * @author Rémi Heredero
+ * @version 1.0.0
+ * @date July 2023
+ * @file button.c
  */
-/*$endhead${.::board::button.c} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^*/
+
 #include "button.h"
-#include "../mcc_generated_files/pin_manager.h"
 
-/*$skip${QP_VERSION} vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv*/
-/* Check for the minimum required QP version */
-#if (QP_VERSION < 700U) || (QP_VERSION != ((QP_RELEASE^4294967295U) % 0x3E8U))
-#error qpc version 7.0.0 or higher required
-#endif
-/*$endskip${QP_VERSION} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^*/
-
-/*$define${board::Button} vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv*/
-
-/*${board::Button} .........................................................*/
-
-/*${board::Button::SM} .....................................................*/
-QState Button_initial(Button * const me, void const * const par) {
-    /*${board::Button::SM::initial} */
-    return Q_TRAN(&Button_INIT);
+void BUTTON_init(BUTTON* me, uint8_t id){
+    me->id = id;
+    me->state = STPB_INIT;
+    me->pollTime = 20;
+    me->released.f = NULL;
+    me->pressed.f = NULL;
 }
 
-/*${board::Button::SM::INIT} ...............................................*/
-QState Button_INIT(Button * const me, QEvt const * const e) {
-    QState status_;
-    switch (e->sig) {
-        default: {
-            status_ = Q_SUPER(&QHsm_top);
+void BUTTON_initHW(BUTTON* me) {
+    switch (me->id) {
+        case 1:
+            INPUT1_SetDigitalInput();
+            break;
+        case 2:
+            INPUT2_SetDigitalInput();
+            break;
+        case 3:
+            INPUT3_SetDigitalInput();
+            break;
+        default:
             break;
     }
 }
-    return status_;
+
+bool BUTTON_isPressed(BUTTON* me) {
+    switch (me->id) {
+        case 1:
+            return INPUT1_GetValue();
+            break;
+        case 2:
+            return INPUT2_GetValue();
+            break;
+        case 3:
+            return INPUT3_GetValue();
+            break;
+        default:
+            return false;
+            break;
+    }
+}
+
+void BUTTON_startBehaviour(BUTTON* me){
+    POST(me, &BUTTON_processEvent, evPBinit, 0, 0);
+}
+
+bool BUTTON_processEvent(Event* ev) {
+    bool processed = false;
+    BUTTON* me = (BUTTON*)Event_getTarget(ev);
+    BUTTON_STATES oldState = me->state;
+    evIDT evid = Event_getId(ev);
+    
+    switch (me->state) {        // onState
+        case STPB_INIT:
+            if (ev->id == evPBinit) {
+                BUTTON_emitPoll(me, me->pollTime);
+                if (BUTTON_isPressed(me)) {
+                    me->state = STPB_PRESSED;
+                } else {
+                    me->state = STPB_RELEASED;
+                }
+            }
+            break;
+        
+        case STPB_RELEASED:
+            if (ev->id == evPBpoll) {
+                BUTTON_emitPoll(me, me->pollTime);
+                if (BUTTON_isPressed(me)) {
+                    me->state = STPB_PRESSED;
+                }
+            }
+            break;
+        
+        case STPB_PRESSED:
+            if (ev->id == evPBpoll) {
+                BUTTON_emitPoll(me, me->pollTime);
+                if (!BUTTON_isPressed(me)) {
+                    me->state = STPB_RELEASED;
+                }
+            }
+            break;
+    }
+
+    if(oldState != me->state){
+        switch (oldState) {     // onExit
+            case STPB_INIT:
+                break;
+            
+            case STPB_RELEASED:
+                break;
+            
+            case STPB_PRESSED:
+                break;
+        }
+
+        switch (me->state) {    // onEntry
+            case STPB_INIT:
+                break;
+            
+            case STPB_RELEASED:
+                if (me->released.f != NULL) {
+                    me->released.f(me->released.p);
+                }
+                break;
+            
+            case STPB_PRESSED:
+                if (me->pressed.f != NULL) {
+                    me->pressed.f(me->pressed.p);
+                }
+                break;
+        }
+
+        processed = true;
+    }
+    return processed;
+}
+
+/*************
+ * Callbacks *
+ *************/
+
+void BUTTON_onReleased(BUTTON* me, BUTTON_CALLBACK_FUNCTION f, void* p) {
+    me->released.f = f;
+    me->released.p = p;
+}
+
+void BUTTON_onPressed(BUTTON* me, BUTTON_CALLBACK_FUNCTION f, void* p) {
+    me->pressed.f = f;
+    me->pressed.p = p;
+}
+
+/************
+ * EMITTERS *
+ ************/
+
+void BUTTON_emitPoll(BUTTON* me, uint16_t t) {
+    POST(me, &BUTTON_processEvent, evPBpoll, t, 0);
+}
+
+/***********
+ * SETTERS *
+ ***********/
+
+void BUTTON_setId(BUTTON* me, uint8_t v) {
+    me->id = v;
+}
+
+void BUTTON_setPollTime(BUTTON* me, uint8_t v) {
+    me->pollTime = v;
 }
-/*$enddef${board::Button} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^*/

src/board/button.h

@@ -1,53 +1,121 @@
-/*$file${.::board::button.h} vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv*/
-/*
-* Model: XFT.qm
-* File:  ${.::board::button.h}
-*
-* This code has been generated by QM 5.2.5 <www.state-machine.com/qm>.
-* DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
-*
-* SPDX-License-Identifier: GPL-3.0-or-later
-*
-* This generated code is open source software: you can redistribute it under
-* the terms of the GNU General Public License as published by the Free
-* Software Foundation.
-*
-* This code 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.
-*
-* NOTE:
-* Alternatively, this generated code may be distributed under the terms
-* of Quantum Leaps commercial licenses, which expressly supersede the GNU
-* General Public License and are specifically designed for licensees
-* interested in retaining the proprietary status of their code.
-*
-* Contact information:
-* <www.state-machine.com/licensing>
-* <info@state-machine.com>
+/**
+ * @author Rémi Heredero
+ * @version 1.0.0
+ * @date July 2023
+ * @file button.h
  */
-/*$endhead${.::board::button.h} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^*/
 #ifndef BUTTON_H
 #define BUTTON_H
 
-#include <stdint.h>
+#include "../xf/xf.h"
 
-/*$declare${board::Button} vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv*/
+typedef enum {
+    STPB_INIT,
+    STPB_RELEASED,
+    STPB_PRESSED
+} BUTTON_STATES;
 
-/*${board::Button} .........................................................*/
+typedef enum {
+    evPBinit = 50,
+    evPBpoll
+} BUTTON_EVENTS;
+
+typedef void (*BUTTON_CALLBACK_FUNCTION)(void*);
 typedef struct {
-/* protected: */
-    QActive super;
+    BUTTON_CALLBACK_FUNCTION f; // function
+    void* p; // param(s)
+} BUTTON_CALLBACK;
 
-/* public: */
-    uint8_t id;
+typedef struct {
     BUTTON_STATES state;
-} Button;
+    uint8_t id;
+    uint8_t pollTime;
+    BUTTON_CALLBACK released;
+    BUTTON_CALLBACK pressed;
+} BUTTON;
 
-/* protected: */
-QState Button_initial(Button * const me, void const * const par);
-QState Button_INIT(Button * const me, QEvt const * const e);
-/*$enddecl${board::Button} ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^*/
+/**
+ * Initialize the BUTTON
+ * @param me the BUTTON itself
+ * @param id the id of the BUTTON
+ */
+void BUTTON_init(BUTTON* me, uint8_t id);
+
+/**
+ * Initialize the hardware of the BUTTON
+ * @param me the BUTTON itself
+ */
+void BUTTON_initHW(BUTTON* me);
+
+/**
+ * @brief Check if the button is pressed
+ * The function returns true if the button is pressed, false otherwise
+ *
+ * @param me button itself
+ * @return true if the button is pressed
+ * @return false if the button is not pressed
+ */
+bool BUTTON_isPressed(BUTTON* me);
+
+/**
+ * Start the BUTTON state machine
+ * @param me the BUTTON itself
+ */
+void BUTTON_startBehaviour(BUTTON* me);
+
+/**
+ * Process the event
+ * @param ev the event to process
+ * @return true if the event is processed
+ */
+bool BUTTON_processEvent(Event* ev);
+
+/*************
+ * Callbacks *
+ *************/
+
+/**
+ * Set the callback function to call when the BUTTON is entering state released
+ * @param me the BUTTON itself
+ * @param f the function to call
+ * @param p the param(s) to pass to the function
+ */
+void BUTTON_onReleased(BUTTON* me, BUTTON_CALLBACK_FUNCTION f, void* p);
+
+/**
+ * Set the callback function to call when the BUTTON is entering state pressed
+ * @param me the BUTTON itself
+ * @param f the function to call
+ * @param p the param(s) to pass to the function
+ */
+void BUTTON_onPressed(BUTTON* me, BUTTON_CALLBACK_FUNCTION f, void* p);
+
+/************
+ * EMITTERS *
+ ************/
+
+/**
+ * Emit the poll event
+ * @param me the BUTTON itself
+ * @param t time to wait in ms before triggering event
+ */void BUTTON_emitPoll(BUTTON* me, uint16_t t);
+
+/***********
+ * SETTERS *
+ ***********/
+
+/**
+ * Set the id of the BUTTON
+ * @param me the BUTTON itself
+ * @param v the id to set
+ */
+void BUTTON_setId(BUTTON* me, uint8_t v);
+
+/**
+ * Set the poll time of the BUTTON
+ * @param me the BUTTON itself
+ * @param v the poll time to set
+ */
+void BUTTON_setPollTime(BUTTON* me, uint8_t v);
 
 #endif

src/board/led.c

@@ -1,44 +1,25 @@
-
-/*
-* Model: XFT.qm
-* File:  ${.::board::led.c}
-*
-* This code has been generated by QM 5.2.5 <www.state-machine.com/qm>.
-* DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
-*
-* SPDX-License-Identifier: GPL-3.0-or-later
-*
-* This generated code is open source software: you can redistribute it under
-* the terms of the GNU General Public License as published by the Free
-* Software Foundation.
-*
-* This code 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.
-*
-* NOTE:
-* Alternatively, this generated code may be distributed under the terms
-* of Quantum Leaps commercial licenses, which expressly supersede the GNU
-* General Public License and are specifically designed for licensees
-* interested in retaining the proprietary status of their code.
-*
-* Contact information:
-* <www.state-machine.com/licensing>
-* <info@state-machine.com>
+/**
+ * @author Rémi Heredero
+ * @version. 1.0.0
+ * @date 2023-06-15
  */
+
 #include "led.h"
 #include "../mcc_generated_files/pin_manager.h"
 
-void LED_init(LED * const me,
-    uint8_t id)
-{
+void LED_init(LED* me, uint8_t id) {
     me->id = id;
 }
-void LED_initHW(LED * const me) {
+
+/**
+ * @brief Initialize the Driver
+ * 
+ */
+void LED_initHW(LED* me) {
     LED_off(me);
 }
-void LED_on(LED * const me) {
+
+void LED_on(void* me) {
     LED* l = (LED*) me;
     switch (l->id) {
         case 1:
@@ -72,8 +53,10 @@ void LED_on(LED * const me) {
             OUTPUT10_SetHigh();
         break;    
     }
+      
 }
-void LED_off(LED * const me) {
+
+void LED_off(void* me) {
     LED* l = (LED*) me;
     switch (l->id) {
         case 1:
@@ -108,3 +91,4 @@ void LED_off(LED * const me) {
         break;    
     }            
 }
+

src/board/led.h

@@ -1,73 +1,43 @@
-
-/*
-* Model: XFT.qm
-* File:  ${.::board::led.h}
-*
-* This code has been generated by QM 5.2.5 <www.state-machine.com/qm>.
-* DO NOT EDIT THIS FILE MANUALLY. All your changes will be lost.
-*
-* SPDX-License-Identifier: GPL-3.0-or-later
-*
-* This generated code is open source software: you can redistribute it under
-* the terms of the GNU General Public License as published by the Free
-* Software Foundation.
-*
-* This code 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.
-*
-* NOTE:
-* Alternatively, this generated code may be distributed under the terms
-* of Quantum Leaps commercial licenses, which expressly supersede the GNU
-* General Public License and are specifically designed for licensees
-* interested in retaining the proprietary status of their code.
-*
-* Contact information:
-* <www.state-machine.com/licensing>
-* <info@state-machine.com>
+/**
+ * @author Rémi Heredero
+ * @version. 1.0.0
+ * @date 2023-06-15
  */
+
 #ifndef LED_H
 #define LED_H
 
 #include <stdint.h>
-/*
- * @author Rémi Heredero
- * @date July 2023
- * @version 1.0.0
- * @see work of Medar Rieder & Pascal Sartoretti about femto XF
- */
-typedef struct {
-/* public: */
-    uint8_t id;
-} LED;
 
-/* public: */
+// LED struct
+typedef struct {
+    uint8_t id; // The id of the LED
+}LED;
 
 /**
  * Initialize the led
  * @param me the led itself
  * @param id the id of the led
  */
-void LED_init(LED * const me,
-    uint8_t id);
+void LED_init(LED* me, uint8_t id);
 
 /**
  * Initializing the led
  * @param me the led itself
  */
-void LED_initHW(LED * const me);
+void LED_initHW(LED* me);
 
 /**
  * Turn On the led 
  * @param me the led itself
  */
-void LED_on(LED * const me);
+void LED_on(void* me);
 
 /**
  * Turn Off the led 
  * @param me the led itself
  */
-void LED_off(LED * const me);
+void LED_off(void* me);
+
+#endif	/* LED_H */
 
-#endif

src/middleware/blinker.c

@@ -0,0 +1,189 @@
+/**
+ * @author Rémi Heredero
+ * @version 1.0.0
+ * @date July 2023
+ * @file blinker.c
+ */
+
+#include "blinker.h"
+
+void BLINKER_init(BLINKER* me){
+    me->state = STBL_INIT;
+    me->timeOn = 500;
+    me->timeOff = 500;
+    me->numberOfBlink = 3;
+    me->nBlinkIsOn = false;
+    me->remainBlinks = 3;
+    me->wait.f = NULL;
+    me->on.f = NULL;
+    me->off.f = NULL;
+    me->finished.f = NULL;
+}
+
+void BLINKER_startBehaviour(BLINKER* me) {
+    POST(me, &BLINKER_processEvent, evBLinit, 0, 0);
+}
+
+bool BLINKER_processEvent(Event* ev) {
+    bool processed = false;
+    BLINKER* me = (BLINKER*)Event_getTarget(ev);
+    BLINKER_STATES oldState = me->state;
+    evIDT evid = Event_getId(ev);
+    
+    switch (me->state) {        // onState
+        case STBL_INIT:
+            if (ev->id == evBLinit) {
+                me->state = STBL_WAIT;
+            }
+            break;
+        
+        case STBL_WAIT:
+            me->remainBlinks = me->numberOfBlink;
+            if(evid == evBLblinkN) {
+                me->state = STBL_ON;
+                me->nBlinkIsOn = true;
+                BLINKER_emitTimer(me, me->timeOn);
+            }
+            if(evid == evBLblink) {
+                me->state = STBL_ON;
+                me->nBlinkIsOn = false;
+                BLINKER_emitTimer(me, me->timeOn);
+            }
+            break;
+        
+        case STBL_ON:
+            if (me->nBlinkIsOn) {
+                me->remainBlinks--;
+            }
+            if (evid == evBLtimer) {
+                me->state = STBL_OFF;
+                BLINKER_emitTimer(me, me->timeOff);
+            }
+            break;
+        
+        case STBL_OFF:
+            if (evid == evBLtimer) {
+                if (me->remainBlinks == 0) {
+                    me->state = STBL_WAIT;
+                    if (me->finished.f != NULL) {
+                        me->finished.f(me->finished.p);
+                    }
+                } else {
+                    me->state = STBL_ON;
+                    BLINKER_emitTimer(me, me->timeOn);
+                }
+            }
+            break;
+    }
+
+    if(oldState != me->state){
+        switch (oldState) {     // onExit
+            case STBL_INIT:
+                break;
+            
+            case STBL_WAIT:
+                break;
+            
+            case STBL_ON:
+                break;
+            
+            case STBL_OFF:
+                break;
+        }
+
+        switch (me->state) {    // onEntry
+            case STBL_INIT:
+                break;
+            
+            case STBL_WAIT:
+                if (me->wait.f != NULL) {
+                    me->wait.f(me->wait.p);
+                }
+                break;
+            
+            case STBL_ON:
+                if (me->on.f != NULL) {
+                    me->on.f(me->on.p);
+                }
+                break;
+            
+            case STBL_OFF:
+                if (me->off.f != NULL) {
+                    me->off.f(me->off.p);
+                }
+                break;
+        }
+
+        processed = true;
+    }
+    return processed;
+}
+
+/*************
+ * Callbacks *
+ *************/
+
+void BLINKER_onWait(BLINKER* me, BLINKER_CALLBACK_FUNCTION f, void* p) {
+    me->wait.f = f;
+    me->wait.p = p;
+}
+
+void BLINKER_onOn(BLINKER* me, BLINKER_CALLBACK_FUNCTION f, void* p) {
+    me->on.f = f;
+    me->on.p = p;
+}
+
+void BLINKER_onOff(BLINKER* me, BLINKER_CALLBACK_FUNCTION f, void* p) {
+    me->off.f = f;
+    me->off.p = p;
+}
+
+void BLINKER_onFinished(BLINKER* me, BLINKER_CALLBACK_FUNCTION f, void* p) {
+    me->finished.f = f;
+    me->finished.p = p;
+}
+
+/************
+ * EMITTERS *
+ ************/
+
+void BLINKER_emitBlink(BLINKER* me, uint16_t t) {
+    POST(me, &BLINKER_processEvent, evBLblink, t, 0);
+}
+
+void BLINKER_emitBlinkN(BLINKER* me, uint16_t t) {
+    POST(me, &BLINKER_processEvent, evBLblinkN, t, 0);
+}
+
+void BLINKER_emitTimer(BLINKER* me, uint16_t t) {
+    POST(me, &BLINKER_processEvent, evBLtimer, t, 0);
+}
+
+/***********
+ * SETTERS *
+ ***********/
+
+void BLINKER_setTimeOn(BLINKER* me, uint16_t v) {
+    me->timeOn = v;
+}
+
+void BLINKER_setTimeOff(BLINKER* me, uint16_t v) {
+    me->timeOff = v;
+}
+
+void BLINKER_setNumberOfBlink(BLINKER* me, uint8_t v) {
+    me->numberOfBlink = v;
+}
+
+void BLINKER_setNBlinkIsOn(BLINKER* me, bool v) {
+    me->nBlinkIsOn = v;
+}
+
+void BLINKER_setRemainBlinks(BLINKER* me, uint8_t v) {
+    me->remainBlinks = v;
+}
+
+
+void BLINKER_endBlink(BLINKER* me) {
+    me->remainBlinks = 0;
+}

src/middleware/blinker.h

@@ -0,0 +1,167 @@
+/**
+ * @author Rémi Heredero
+ * @version 1.0.0
+ * @date July 2023
+ * @file blinker.h
+ */
+#ifndef BLINKER_H
+#define BLINKER_H
+
+#include "../xf/xf.h"
+
+typedef enum {
+    STBL_INIT,
+    STBL_WAIT,
+    STBL_ON,
+    STBL_OFF
+} BLINKER_STATES;
+
+typedef enum {
+    evBLinit = 200,
+    evBLblink,
+    evBLblinkN,
+    evBLtimer
+} BLINKER_EVENTS;
+
+typedef void (*BLINKER_CALLBACK_FUNCTION)(void*);
+typedef struct {
+    BLINKER_CALLBACK_FUNCTION f; // function
+    void* p; // param(s)
+} BLINKER_CALLBACK;
+
+typedef struct {
+    BLINKER_STATES state; //Actual state
+    uint16_t timeOn; // Time on
+    uint16_t timeOff; // Time off
+    uint8_t numberOfBlink; // Number of blink for this blinker when start with blinkN
+    bool nBlinkIsOn; // If the nBlink way is enable
+    uint8_t remainBlinks; // Actual remain blink
+    BLINKER_CALLBACK wait;
+    BLINKER_CALLBACK on;
+    BLINKER_CALLBACK off;
+    BLINKER_CALLBACK finished;
+} BLINKER;
+
+/**
+ * Initialize the BLINKER
+ * @param me the BLINKER itself
+ */
+void BLINKER_init(BLINKER* me);
+
+/**
+ * Start the BLINKER state machine
+ * @param me the BLINKER itself
+ */
+void BLINKER_startBehaviour(BLINKER* me);
+
+/**
+ * Process the event
+ * @param ev the event to process
+ * @return true if the event is processed
+ */
+bool BLINKER_processEvent(Event* ev);
+
+/*************
+ * Callbacks *
+ *************/
+
+/**
+ * Set the callback function to call when the BLINKER is entering state wait
+ * @param me the BLINKER itself
+ * @param f the function to call
+ * @param p the param(s) to pass to the function
+ */
+void BLINKER_onWait(BLINKER* me, BLINKER_CALLBACK_FUNCTION f, void* p);
+
+/**
+ * Set the callback function to call when the BLINKER is entering state on
+ * @param me the BLINKER itself
+ * @param f the function to call
+ * @param p the param(s) to pass to the function
+ */
+void BLINKER_onOn(BLINKER* me, BLINKER_CALLBACK_FUNCTION f, void* p);
+
+/**
+ * Set the callback function to call when the BLINKER is entering state off
+ * @param me the BLINKER itself
+ * @param f the function to call
+ * @param p the param(s) to pass to the function
+ */
+void BLINKER_onOff(BLINKER* me, BLINKER_CALLBACK_FUNCTION f, void* p);
+
+/**
+ * Set the callabck function to call when the BLINKER is entering state finished
+ * @param me the BLINKER itself
+ * @param f the function to call
+ * @param t the param(s) to pass to the function
+ */
+void BLINKER_onFinished(BLINKER* me, BLINKER_CALLBACK_FUNCTION f, void* p);
+
+/************
+ * EMITTERS *
+ ************/
+
+/**
+ * Emit the blink event
+ * @param me the BLINKER itself
+ * @param t time to wait in ms before triggering event
+ */void BLINKER_emitBlink(BLINKER* me, uint16_t t);
+
+/**
+ * Emit the blinkn event
+ * @param me the BLINKER itself
+ * @param t time to wait in ms before triggering event
+ */void BLINKER_emitBlinkN(BLINKER* me, uint16_t t);
+
+/**
+ * Emit the timer event
+ * @param me the BLINKER itself
+ * @param t time to wait in ms before triggering event
+ */void BLINKER_emitTimer(BLINKER* me, uint16_t t);
+
+/***********
+ * SETTERS *
+ ***********/
+
+/**
+ * Set the time on
+ * @param me the BLINKER itself
+ * @param v the value to set
+ */
+void BLINKER_setTimeOn(BLINKER* me, uint16_t v);
+
+/**
+ * Set the time off
+ * @param me the BLINKER itself
+ * @param v the value to set
+ */
+void BLINKER_setTimeOff(BLINKER* me, uint16_t v);
+
+/**
+ * Set the number of blink
+ * @param me the BLINKER itself
+ * @param v the value to set
+ */
+void BLINKER_setNumberOfBlink(BLINKER* me, uint8_t v);
+
+/**
+ * Set the nBlinkIsOn
+ * @param me the BLINKER itself
+ * @param v the value to set
+ */
+void BLINKER_setNBlinkIsOn(BLINKER* me, bool v);
+
+/**
+ * Set the remain blink(s)
+ * @param me the BLINKER itself
+ * @param v the value to set
+ */
+void BLINKER_setRemainBlinks(BLINKER* me, uint8_t v);
+
+/**
+ * Stop to blink if it was indefinitely blinking
+ * @param me the blinker itself
+ */
+void BLINKER_endBlink(BLINKER* me);
+
+#endif

src/middleware/click_handler.c

@@ -0,0 +1,177 @@
+/**
+ * @author Rémi Heredero
+ * @version 1.0.0
+ * @date July 2023
+ * @file click_handler.c
+ */
+
+#include "click_handler.h"
+
+void CLICK_HANDLER_init(CLICK_HANDLER* me){
+    me->state = STCH_INIT;
+    me->clickTimer = 250;
+    me->wait.f = NULL;
+    me->long_click.f = NULL;
+    me->single_click.f = NULL;
+    me->double_click.f = NULL;
+}
+
+void CLICK_HANDLER_startBehaviour(CLICK_HANDLER* me){
+    POST(me, &CLICK_HANDLER_processEvent, evCHinit, 0, 0);
+}
+
+bool CLICK_HANDLER_processEvent(Event* ev) {
+    bool processed = false;
+    CLICK_HANDLER* me = (CLICK_HANDLER*)Event_getTarget(ev);
+    CLICK_HANDLER_STATES oldState = me->state;
+    evIDT evid = Event_getId(ev);
+    
+    switch (me->state) {        // onState
+        case STCH_INIT:
+            if (ev->id == evCHinit) {
+                me->state = STCH_WAIT;
+            }
+            break;
+        
+        case STCH_WAIT:
+            if(evid == evCHpbpress) {
+                me->state = STCH_LONG_CLICK;
+                CLICK_HANDLER_emitTimer(me, me->clickTimer);
+            }
+            break;
+        
+        case STCH_LONG_CLICK:
+            if(evid == evCHpbrelease) {
+                me->state = STCH_SINGLE_CLICK;
+            }
+            if(evid == evCHtimer) {
+                me->state = STCH_WAIT;
+            }
+            break;
+        
+        case STCH_SINGLE_CLICK:
+            if(evid == evCHpbpress) {
+                me->state = STCH_DOUBLE_CLICK;
+            }
+            if(evid == evCHtimer) {
+                me->state = STCH_WAIT;
+            }
+            break;
+        
+        case STCH_DOUBLE_CLICK:
+            if(evid == evCHpbrelease) {
+                me->state = STCH_WAIT;
+            }
+            if(evid == evCHtimer) {
+                me->state = STCH_WAIT;
+            }
+            break;
+    }
+
+    if(oldState != me->state){
+        switch (oldState) {     // onExit
+            case STCH_INIT:
+                break;
+            
+            case STCH_WAIT:
+                break;
+            
+            case STCH_LONG_CLICK:
+                if(evid == evCHtimer) {
+                    if (me->long_click.f != NULL) {
+                        me->long_click.f(me->long_click.p);
+                    }
+                }
+                break;
+            
+            case STCH_SINGLE_CLICK:
+                if(evid == evCHtimer) {
+                    if (me->single_click.f != NULL) {
+                        me->single_click.f(me->single_click.p);
+                    }
+                }
+                break;
+            
+            case STCH_DOUBLE_CLICK:
+                if(evid == evCHtimer) {
+                    if(me->double_click.f != NULL) {
+                        me->double_click.f(me->double_click.p);
+                    }
+                }
+                if(evid == evCHpbrelease) {
+                    if(me->double_click.f != NULL) {
+                        me->double_click.f(me->double_click.p);
+                    }
+                }
+                break;
+        }
+
+        switch (me->state) {    // onEntry
+            case STCH_INIT:
+                break;
+            
+            case STCH_WAIT:
+                break;
+            
+            case STCH_LONG_CLICK:
+                break;
+            
+            case STCH_SINGLE_CLICK:
+                break;
+            
+            case STCH_DOUBLE_CLICK:
+                break;
+        }
+
+        processed = true;
+    }
+    return processed;
+}
+
+/*************
+ * Callbacks *
+ *************/
+
+void CLICK_HANDLER_onWait(CLICK_HANDLER* me, CLICK_HANDLER_CALLBACK_FUNCTION f, void* p) {
+    me->wait.f = f;
+    me->wait.p = p;
+}
+
+void CLICK_HANDLER_onLong_click(CLICK_HANDLER* me, CLICK_HANDLER_CALLBACK_FUNCTION f, void* p) {
+    me->long_click.f = f;
+    me->long_click.p = p;
+}
+
+void CLICK_HANDLER_onSingle_click(CLICK_HANDLER* me, CLICK_HANDLER_CALLBACK_FUNCTION f, void* p) {
+    me->single_click.f = f;
+    me->single_click.p = p;
+}
+
+void CLICK_HANDLER_onDouble_click(CLICK_HANDLER* me, CLICK_HANDLER_CALLBACK_FUNCTION f, void* p) {
+    me->double_click.f = f;
+    me->double_click.p = p;
+}
+
+/************
+ * EMITTERS *
+ ************/
+
+void CLICK_HANDLER_emitTimer(CLICK_HANDLER* me, uint16_t t) {
+    POST(me, &CLICK_HANDLER_processEvent, evCHtimer, t, 0);
+}
+
+void CLICK_HANDLER_emitPbpress(CLICK_HANDLER* me, uint16_t t) {
+    POST(me, &CLICK_HANDLER_processEvent, evCHpbpress, t, 0);
+}
+
+void CLICK_HANDLER_emitPbrelease(CLICK_HANDLER* me, uint16_t t) {
+    POST(me, &CLICK_HANDLER_processEvent, evCHpbrelease, t, 0);
+}
+
+/***********
+ * SETTERS *
+ ***********/
+
+void CLICK_HANDLER_setClickTimer(CLICK_HANDLER* me, uint16_t v) {
+    me->clickTimer = v;
+}

src/middleware/click_handler.h

@@ -0,0 +1,125 @@
+/**
+ * @author Rémi Heredero
+ * @version 1.0.0
+ * @date July 2023
+ * @file click_handler.h
+ */
+#ifndef CLICK_HANDLER_H
+#define CLICK_HANDLER_H
+
+#include "../xf/xf.h"
+
+typedef enum {
+    STCH_INIT,
+    STCH_WAIT,
+    STCH_LONG_CLICK,
+    STCH_SINGLE_CLICK,
+    STCH_DOUBLE_CLICK
+} CLICK_HANDLER_STATES;
+
+typedef enum {
+    evCHinit = 100,
+    evCHtimer,
+    evCHpbpress,
+    evCHpbrelease
+} CLICK_HANDLER_EVENTS;
+
+typedef void (*CLICK_HANDLER_CALLBACK_FUNCTION)(void*);
+typedef struct {
+    CLICK_HANDLER_CALLBACK_FUNCTION f; // function
+    void* p; // param(s)
+} CLICK_HANDLER_CALLBACK;
+
+typedef struct {
+    CLICK_HANDLER_STATES state;
+    uint16_t clickTimer;
+    CLICK_HANDLER_CALLBACK wait;
+    CLICK_HANDLER_CALLBACK long_click;
+    CLICK_HANDLER_CALLBACK single_click;
+    CLICK_HANDLER_CALLBACK double_click;
+} CLICK_HANDLER;
+
+/**
+ * Initialize the CLICK_HANDLER
+ * @param me the CLICK_HANDLER itself
+ */
+void CLICK_HANDLER_init(CLICK_HANDLER* me);
+
+/**
+ * Start the CLICK_HANDLER state machine
+ * @param me the CLICK_HANDLER itself
+ */
+void CLICK_HANDLER_startBehaviour(CLICK_HANDLER* me);
+
+/**
+ * Process the event
+ * @param ev the event to process
+ * @return true if the event is processed
+ */
+bool CLICK_HANDLER_processEvent(Event* ev);
+
+/*************
+ * Callbacks *
+ *************/
+
+/**
+ * Set the callback function to call when the CLICK_HANDLER is entering state wait
+ * @param me the CLICK_HANDLER itself
+ * @param f the function to call
+ * @param p the param(s) to pass to the function
+ */
+void CLICK_HANDLER_onWait(CLICK_HANDLER* me, CLICK_HANDLER_CALLBACK_FUNCTION f, void* p);
+
+/**
+ * Set the callback function to call when the CLICK_HANDLER is entering state long_click
+ * @param me the CLICK_HANDLER itself
+ * @param f the function to call
+ * @param p the param(s) to pass to the function
+ */
+void CLICK_HANDLER_onLong_click(CLICK_HANDLER* me, CLICK_HANDLER_CALLBACK_FUNCTION f, void* p);
+
+/**
+ * Set the callback function to call when the CLICK_HANDLER is entering state single_click
+ * @param me the CLICK_HANDLER itself
+ * @param f the function to call
+ * @param p the param(s) to pass to the function
+ */
+void CLICK_HANDLER_onSingle_click(CLICK_HANDLER* me, CLICK_HANDLER_CALLBACK_FUNCTION f, void* p);
+
+/**
+ * Set the callback function to call when the CLICK_HANDLER is entering state double_click
+ * @param me the CLICK_HANDLER itself
+ * @param f the function to call
+ * @param p the param(s) to pass to the function
+ */
+void CLICK_HANDLER_onDouble_click(CLICK_HANDLER* me, CLICK_HANDLER_CALLBACK_FUNCTION f, void* p);
+
+/************
+ * EMITTERS *
+ ************/
+
+/**
+ * Emit the timer event
+ * @param me the CLICK_HANDLER itself
+ * @param t time to wait in ms before triggering event
+ */void CLICK_HANDLER_emitTimer(CLICK_HANDLER* me, uint16_t t);
+
+/**
+ * Emit the pbpress event
+ * @param me the CLICK_HANDLER itself
+ * @param t time to wait in ms before triggering event
+ */void CLICK_HANDLER_emitPbpress(CLICK_HANDLER* me, uint16_t t);
+
+/**
+ * Emit the pbrelease event
+ * @param me the CLICK_HANDLER itself
+ * @param t time to wait in ms before triggering event
+ */void CLICK_HANDLER_emitPbrelease(CLICK_HANDLER* me, uint16_t t);
+
+/***********
+ * SETTERS *
+ ***********/
+
+void CLICK_HANDLER_setClickTimer(CLICK_HANDLER* me, uint16_t v);
+
+#endif

src/template.c

@@ -1,52 +0,0 @@
-/**
- * @author Rémi Heredero
- * @version 1.0.0
- * @date July 2023
- * @file ${FILENAME}.c
- */
-
-#include "${FILENAME}.h"
-
-void ${FILENAME}_init(${FILENAME}* me){
-    me->state = ST${FN}_INIT;
-}
-
-void ${FILENAME}_startBehaviour(${FILENAME}* me){
-    POST(me, &${FILENAME}_processEvent, ev${FN}init, 0, 0);
-}
-
-bool ${FILENAME}_processEvent(Event* ev) {
-    bool processed = false;
-    ${FILENAME}* me = (${FILENAME}*)Event_getTarget(ev);
-    switch (me->state) {        // onState
-        case ST${FN}_INIT:
-            if (ev->id == ev${FN}init) {}
-            break;
-        {STATES}
-    }
-
-    if(oldState != me->state){
-        switch (oldState) {     // onExit
-            case ST${FN}_INIT:
-                break;
-            {STATES}
-        }
-
-        switch (me->state) {    // onEntry
-            case ST${FN}_INIT:
-                break;
-            {STATES}
-        }
-
-        processed = true;
-    }
-    return processed;
-}
-
-void ${FILENAME}_set{VAR}(${FILENAME}*me, uint16_t t) {
-    me->tON = t;
-}
-
-void ${FILENAME}_emit${EVENT}(${FILENAME}*me, uint16_t t) {
-    POST(me, &${FILENAME}_processEvent, ev${FN}${EVENT}, t, 0);
-}

src/template.h

@@ -1,55 +0,0 @@
-/**
- * @author Rémi Heredero
- * @version 1.0.0
- * @date July 2023
- * @file ${FILENAME}.h
- */
-#ifndef ${FILENAME}_H
-#define ${FILENAME}_H
-
-#include "../xf/xf.h"
-
-typedef enum{
-    ST${FN}_INIT,
-    {STATES}
-} ${FILENAME}_STATES;
-
-typedef enum{
-    ev${FN}init = 100, // TODO change this number
-    {EVENTS}
-} ${FILENAME}_EVENTS;
-
-typedef struct{
-    ${FILENAME}_STATES state;
-} ${FILENAME};
-
-/**
- * Initialize the ${FILENAME}
- * @param me the ${FILENAME} itself
- */
-void ${FILENAME}_init(${FILENAME}* me);
-
-/**
- * Start the ${FILENAME} state machine
- * @param me the ${FILENAME} itself
- */
-void ${FILENAME}_startBehaviour(${FILENAME}* me);
-
-/**
- * Process the event
- * @param ev the event to process
- * @return true if the event is processed
- */
-bool ${FILENAME}_processEvent(Event* ev);
-
-void ${FILENAME}_set{TIMEON}(${FILENAME}*me, uint16_t t);
-
-/**
- * Emit the ${EVENT} event
- * @param me the ${FILENAME} itself
- * @param t Time to wait before trig the event
- */
-void ${FILENAME}_emit${EVENT}(${FILENAME}*me, uint16_t t);
-
-
-#endif