feat: initial commit
This commit is contained in:
commit
e8c33df23f
|
@ -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) <year> <name of author>
|
||||
|
||||
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/>.
|
|
@ -0,0 +1,4 @@
|
|||
GOTEST_ARGS ?= -v -count=1
|
||||
|
||||
test:
|
||||
go test $(GOTEST_ARGS) ./...
|
|
@ -0,0 +1,9 @@
|
|||
# `forge.cadoles.com/cadoles/go-emlid`
|
||||
|
||||
[![Go Reference](https://pkg.go.dev/badge/forge.cadoles.com/Cadoles/go-emlid.svg)](https://pkg.go.dev/forge.cadoles.com/Cadoles/go-emlid)
|
||||
|
||||
Librairie Golang d'interaction avec les produits [Emlid](https://emlid.com/).
|
||||
|
||||
## Licence
|
||||
|
||||
[AGPL-3.0](./LICENSE)
|
|
@ -0,0 +1,21 @@
|
|||
module forge.cadoles.com/cadoles/go-emlid
|
||||
|
||||
go 1.22.5
|
||||
|
||||
require (
|
||||
forge.cadoles.com/Pyxis/golang-socketio v0.0.0-20180919100209-bb857ced6b95
|
||||
github.com/Masterminds/semver/v3 v3.2.1
|
||||
github.com/davecgh/go-spew v1.1.1
|
||||
github.com/grandcat/zeroconf v1.0.0
|
||||
github.com/mitchellh/mapstructure v1.5.0
|
||||
github.com/pkg/errors v0.9.1
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/cenkalti/backoff v2.2.1+incompatible // indirect
|
||||
github.com/gorilla/websocket v1.5.3 // indirect
|
||||
github.com/miekg/dns v1.1.27 // indirect
|
||||
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550 // indirect
|
||||
golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa // indirect
|
||||
golang.org/x/sys v0.0.0-20190924154521-2837fb4f24fe // indirect
|
||||
)
|
|
@ -0,0 +1,36 @@
|
|||
forge.cadoles.com/Pyxis/golang-socketio v0.0.0-20180919100209-bb857ced6b95 h1:o3G5+9RjczCK1xAYFaRMknk1kY9Ule6PNfiW6N6hEpg=
|
||||
forge.cadoles.com/Pyxis/golang-socketio v0.0.0-20180919100209-bb857ced6b95/go.mod h1:I6kYOFWNkFlNeQLI7ZqfTRz4NdPHZxX0Bzizmzgchs0=
|
||||
github.com/Masterminds/semver/v3 v3.2.1 h1:RN9w6+7QoMeJVGyfmbcgs28Br8cvmnucEXnY0rYXWg0=
|
||||
github.com/Masterminds/semver/v3 v3.2.1/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ=
|
||||
github.com/cenkalti/backoff v2.2.1+incompatible h1:tNowT99t7UNflLxfYYSlKYsBpXdEet03Pg2g16Swow4=
|
||||
github.com/cenkalti/backoff v2.2.1+incompatible/go.mod h1:90ReRw6GdpyfrHakVjL/QHaoyV4aDUVVkXQJJJ3NXXM=
|
||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg=
|
||||
github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
|
||||
github.com/grandcat/zeroconf v1.0.0 h1:uHhahLBKqwWBV6WZUDAT71044vwOTL+McW0mBJvo6kE=
|
||||
github.com/grandcat/zeroconf v1.0.0/go.mod h1:lTKmG1zh86XyCoUeIHSA4FJMBwCJiQmGfcP2PdzytEs=
|
||||
github.com/miekg/dns v1.1.27 h1:aEH/kqUzUxGJ/UHcEKdJY+ugH6WEzsEBBSPa8zuy1aM=
|
||||
github.com/miekg/dns v1.1.27/go.mod h1:KNUDUusw/aVsxyTYZM1oqvCicbwhgbNgztCETuNZ7xM=
|
||||
github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
|
||||
github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
|
||||
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
|
||||
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
|
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550 h1:ObdrDkeb4kJdCP557AjRjq69pTHfNouLtWZG7j9rPN8=
|
||||
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
|
||||
golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
|
||||
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/net v0.0.0-20190923162816-aa69164e4478/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa h1:F+8P+gmewFQYRk6JoLQLwjBCTu3mcIURZfNkVweuRKA=
|
||||
golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58 h1:8gQV6CLnAEikrhgkHFbMAEhagSSnXWGV915qUMm9mrU=
|
||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20190924154521-2837fb4f24fe h1:6fAMxZRR6sl1Uq8U61gxU+kPTs2tR8uOySCbBP7BN/M=
|
||||
golang.org/x/sys v0.0.0-20190924154521-2837fb4f24fe/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
golang.org/x/tools v0.0.0-20191216052735-49a3e744a425/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
|
||||
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
|
@ -0,0 +1,96 @@
|
|||
package client
|
||||
|
||||
import (
|
||||
"context"
|
||||
"sync"
|
||||
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/protocol"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
type Client struct {
|
||||
addr string
|
||||
opts *Options
|
||||
|
||||
proto protocol.Identifier
|
||||
ops protocol.Operations
|
||||
|
||||
getProtocolOnce sync.Once
|
||||
getProtocolOnceErr error
|
||||
}
|
||||
|
||||
func (c *Client) Protocol(ctx context.Context) (protocol.Identifier, protocol.Operations, error) {
|
||||
id, ops, err := c.getProtocol(ctx)
|
||||
if err != nil {
|
||||
return "", nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return id, ops, nil
|
||||
}
|
||||
|
||||
func (c *Client) getProtocol(ctx context.Context) (protocol.Identifier, protocol.Operations, error) {
|
||||
c.getProtocolOnce.Do(func() {
|
||||
availables, err := c.opts.Protocols.Availables(ctx, c.addr)
|
||||
if err != nil {
|
||||
c.getProtocolOnceErr = errors.WithStack(err)
|
||||
return
|
||||
}
|
||||
|
||||
var preferred protocol.Protocol
|
||||
var fallback protocol.Protocol
|
||||
|
||||
for _, proto := range availables {
|
||||
if proto.Identifier() == c.opts.FallbackProtocol {
|
||||
fallback = proto
|
||||
}
|
||||
|
||||
if proto.Identifier() == c.opts.PreferredProtocol {
|
||||
preferred = proto
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if preferred != nil {
|
||||
c.proto = preferred.Identifier()
|
||||
c.ops = preferred.Operations(c.addr)
|
||||
return
|
||||
}
|
||||
|
||||
if fallback != nil {
|
||||
c.proto = fallback.Identifier()
|
||||
c.ops = fallback.Operations(c.addr)
|
||||
return
|
||||
}
|
||||
|
||||
for _, proto := range availables {
|
||||
if proto.Identifier() != c.opts.FallbackProtocol {
|
||||
continue
|
||||
}
|
||||
|
||||
fallback = proto
|
||||
break
|
||||
}
|
||||
|
||||
if fallback == nil {
|
||||
c.getProtocolOnceErr = errors.Errorf("neither preferred protocol '%v' or fallback '%v' are available", c.opts.PreferredProtocol, c.opts.FallbackProtocol)
|
||||
return
|
||||
}
|
||||
|
||||
c.proto = fallback.Identifier()
|
||||
c.ops = fallback.Operations(c.addr)
|
||||
})
|
||||
if c.getProtocolOnceErr != nil {
|
||||
return "", nil, errors.WithStack(c.getProtocolOnceErr)
|
||||
}
|
||||
|
||||
return c.proto, c.ops, nil
|
||||
}
|
||||
|
||||
func NewClient(addr string, funcs ...OptionFunc) *Client {
|
||||
opts := NewOptions(funcs...)
|
||||
client := &Client{
|
||||
addr: addr,
|
||||
opts: opts,
|
||||
}
|
||||
return client
|
||||
}
|
|
@ -0,0 +1,54 @@
|
|||
package client
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"github.com/mitchellh/mapstructure"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
func OnMessage[T any](ctx context.Context, client *Client, mType string) (chan T, error) {
|
||||
ch := make(chan T)
|
||||
|
||||
rawChan, err := client.On(ctx, mType)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
go func() {
|
||||
defer close(ch)
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return
|
||||
|
||||
case rawMsg := <-rawChan:
|
||||
var msg T
|
||||
if err := mapstructure.Decode(rawMsg, &msg); err != nil {
|
||||
panic(errors.WithStack(err))
|
||||
}
|
||||
|
||||
ch <- msg
|
||||
}
|
||||
}
|
||||
}()
|
||||
|
||||
return ch, nil
|
||||
}
|
||||
|
||||
// Broadcast is a broadcasted message containing module realtime informations.
|
||||
type Broadcast struct {
|
||||
Name string `mapstructure:"name"`
|
||||
Payload map[string]interface{} `mapstructure:"payload"`
|
||||
}
|
||||
|
||||
// OnBroadcast listens for ReachView "broadcast" messages
|
||||
func OnBroadcast(ctx context.Context, client *Client) (chan Broadcast, error) {
|
||||
ch, err := OnMessage[Broadcast](ctx, client, "broadcast")
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return ch, nil
|
||||
}
|
|
@ -0,0 +1,117 @@
|
|||
package client
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/protocol"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
// Emit implements protocol.Operations.
|
||||
func (c *Client) Emit(ctx context.Context, message any) error {
|
||||
panic("unimplemented")
|
||||
}
|
||||
|
||||
// Configuration implements protocol.Operations.
|
||||
func (c *Client) Configuration(ctx context.Context) (any, error) {
|
||||
_, ops, err := c.getProtocol(ctx)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
config, err := ops.Configuration(ctx)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return config, nil
|
||||
}
|
||||
|
||||
// Version implements protocol.Operations.
|
||||
func (c *Client) Version(ctx context.Context) (string, bool, error) {
|
||||
_, ops, err := c.getProtocol(ctx)
|
||||
if err != nil {
|
||||
return "", false, errors.WithStack(err)
|
||||
}
|
||||
|
||||
version, stable, err := ops.Version(ctx)
|
||||
if err != nil {
|
||||
return "", false, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return version, stable, nil
|
||||
}
|
||||
|
||||
// Close implements protocol.Operations.
|
||||
func (c *Client) Close(ctx context.Context) error {
|
||||
_, ops, err := c.getProtocol(ctx)
|
||||
if err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
if err := ops.Close(ctx); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Connect implements protocol.Operations.
|
||||
func (c *Client) Connect(ctx context.Context) error {
|
||||
_, ops, err := c.getProtocol(ctx)
|
||||
if err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
if err := ops.Connect(ctx); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Alive implements protocol.Operations.
|
||||
func (c *Client) Alive(ctx context.Context) (bool, error) {
|
||||
_, ops, err := c.getProtocol(ctx)
|
||||
if err != nil {
|
||||
return false, errors.WithStack(err)
|
||||
}
|
||||
|
||||
alive, err := ops.Alive(ctx)
|
||||
if err != nil {
|
||||
return false, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return alive, nil
|
||||
}
|
||||
|
||||
// On implements protocol.Operations.
|
||||
func (c *Client) On(ctx context.Context, messageType string) (chan any, error) {
|
||||
_, ops, err := c.getProtocol(ctx)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
ch, err := ops.On(ctx, messageType)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return ch, nil
|
||||
}
|
||||
|
||||
// SetBase implements protocol.Operations.
|
||||
func (c *Client) SetBase(ctx context.Context, funcs ...protocol.SetBaseOptionFunc) error {
|
||||
_, ops, err := c.getProtocol(ctx)
|
||||
if err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
if err := ops.SetBase(ctx, funcs...); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
var _ protocol.Operations = &Client{}
|
|
@ -0,0 +1,47 @@
|
|||
package client
|
||||
|
||||
import (
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/protocol"
|
||||
v1 "forge.cadoles.com/cadoles/go-emlid/reach/client/protocol/v1"
|
||||
v2 "forge.cadoles.com/cadoles/go-emlid/reach/client/protocol/v2"
|
||||
)
|
||||
|
||||
type Options struct {
|
||||
Protocols *protocol.Registry
|
||||
PreferredProtocol protocol.Identifier
|
||||
FallbackProtocol protocol.Identifier
|
||||
}
|
||||
|
||||
type OptionFunc func(opts *Options)
|
||||
|
||||
func NewOptions(funcs ...OptionFunc) *Options {
|
||||
opts := &Options{
|
||||
PreferredProtocol: v2.Identifier,
|
||||
FallbackProtocol: v1.Identifier,
|
||||
Protocols: protocol.DefaultRegistry(),
|
||||
}
|
||||
|
||||
for _, fn := range funcs {
|
||||
fn(opts)
|
||||
}
|
||||
|
||||
return opts
|
||||
}
|
||||
|
||||
func WithPreferredProtocol(identifier protocol.Identifier) OptionFunc {
|
||||
return func(opts *Options) {
|
||||
opts.PreferredProtocol = identifier
|
||||
}
|
||||
}
|
||||
|
||||
func WithFallbackProtocol(identifier protocol.Identifier) OptionFunc {
|
||||
return func(opts *Options) {
|
||||
opts.FallbackProtocol = identifier
|
||||
}
|
||||
}
|
||||
|
||||
func WithProtocols(protocols *protocol.Registry) OptionFunc {
|
||||
return func(opts *Options) {
|
||||
opts.Protocols = protocols
|
||||
}
|
||||
}
|
|
@ -0,0 +1,9 @@
|
|||
package protocol
|
||||
|
||||
import "errors"
|
||||
|
||||
var (
|
||||
ErrNotFound = errors.New("not found")
|
||||
ErrClosed = errors.New("closed")
|
||||
ErrUnimplemented = errors.New("unimplemented")
|
||||
)
|
|
@ -0,0 +1,31 @@
|
|||
package protocol
|
||||
|
||||
import "context"
|
||||
|
||||
type Operations interface {
|
||||
// Connect initiates a new connection to the ReachView service
|
||||
// It should be called before any other operation
|
||||
Connect(ctx context.Context) error
|
||||
|
||||
// Close closes the current connection to the ReachView service
|
||||
Close(ctx context.Context) error
|
||||
|
||||
// Alive returns true if the ReachView websocket connection is alive, false otherwise
|
||||
Alive(ctx context.Context) (bool, error)
|
||||
|
||||
// Version returns the current ReachView version,
|
||||
// true if the module uses the stable channel or an error
|
||||
Version(ctx context.Context) (string, bool, error)
|
||||
|
||||
// On listens for messages of the given type on ReachView websocket connection
|
||||
On(ctx context.Context, mType string) (chan any, error)
|
||||
|
||||
// Emit sends the given message on the ReachView websocket connection
|
||||
Emit(ctx context.Context, message any) error
|
||||
|
||||
// Configuration retrieves the module's configuration
|
||||
Configuration(ctx context.Context) (any, error)
|
||||
|
||||
// SetBase updates the base configuration
|
||||
SetBase(ctx context.Context, funcs ...SetBaseOptionFunc) error
|
||||
}
|
|
@ -0,0 +1,13 @@
|
|||
package protocol
|
||||
|
||||
import (
|
||||
"context"
|
||||
)
|
||||
|
||||
type Identifier string
|
||||
|
||||
type Protocol interface {
|
||||
Identifier() Identifier
|
||||
Available(ctx context.Context, addr string) (bool, error)
|
||||
Operations(addr string) Operations
|
||||
}
|
|
@ -0,0 +1,54 @@
|
|||
package protocol
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
type Registry struct {
|
||||
protocols map[Identifier]Protocol
|
||||
}
|
||||
|
||||
func (r *Registry) Register(protocol Protocol) {
|
||||
r.protocols[protocol.Identifier()] = protocol
|
||||
}
|
||||
|
||||
func (r *Registry) Availables(ctx context.Context, addr string) ([]Protocol, error) {
|
||||
availables := make([]Protocol, 0)
|
||||
|
||||
for _, proto := range r.protocols {
|
||||
available, err := proto.Available(ctx, addr)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
if !available {
|
||||
continue
|
||||
}
|
||||
|
||||
availables = append(availables, proto)
|
||||
}
|
||||
|
||||
return availables, nil
|
||||
}
|
||||
|
||||
func NewRegistry() *Registry {
|
||||
return &Registry{
|
||||
protocols: make(map[Identifier]Protocol),
|
||||
}
|
||||
}
|
||||
|
||||
var defaultRegistry = NewRegistry()
|
||||
|
||||
func DefaultRegistry() *Registry {
|
||||
return defaultRegistry
|
||||
}
|
||||
|
||||
func Register(protocol Protocol) {
|
||||
defaultRegistry.Register(protocol)
|
||||
}
|
||||
|
||||
func Availables(ctx context.Context, addr string) ([]Protocol, error) {
|
||||
return defaultRegistry.Availables(ctx, addr)
|
||||
}
|
|
@ -0,0 +1,49 @@
|
|||
package protocol
|
||||
|
||||
type SetBaseOptions struct {
|
||||
Mode *string
|
||||
AntennaOffset *float64
|
||||
Latitude *float64
|
||||
Longitude *float64
|
||||
Height *float64
|
||||
}
|
||||
|
||||
type SetBaseOptionFunc func(opts *SetBaseOptions)
|
||||
|
||||
func NewSetBaseOptions(funcs ...SetBaseOptionFunc) *SetBaseOptions {
|
||||
opts := &SetBaseOptions{}
|
||||
for _, fn := range funcs {
|
||||
fn(opts)
|
||||
}
|
||||
return opts
|
||||
}
|
||||
|
||||
func WithBaseMode(value string) SetBaseOptionFunc {
|
||||
return func(opts *SetBaseOptions) {
|
||||
opts.Mode = &value
|
||||
}
|
||||
}
|
||||
|
||||
func WithBaseAntennaOffset(value float64) SetBaseOptionFunc {
|
||||
return func(opts *SetBaseOptions) {
|
||||
opts.AntennaOffset = &value
|
||||
}
|
||||
}
|
||||
|
||||
func WithBaseLatitude(value float64) SetBaseOptionFunc {
|
||||
return func(opts *SetBaseOptions) {
|
||||
opts.Latitude = &value
|
||||
}
|
||||
}
|
||||
|
||||
func WithBaseLongitude(value float64) SetBaseOptionFunc {
|
||||
return func(opts *SetBaseOptions) {
|
||||
opts.Longitude = &value
|
||||
}
|
||||
}
|
||||
|
||||
func WithBaseHeight(value float64) SetBaseOptionFunc {
|
||||
return func(opts *SetBaseOptions) {
|
||||
opts.Height = &value
|
||||
}
|
||||
}
|
|
@ -0,0 +1,158 @@
|
|||
package testsuite
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach"
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/protocol"
|
||||
"github.com/davecgh/go-spew/spew"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
type OperationsFactoryFunc func(addr string) (protocol.Operations, error)
|
||||
|
||||
type operationTestCase struct {
|
||||
Name string
|
||||
Run func(t *testing.T, ops protocol.Operations)
|
||||
}
|
||||
|
||||
var testCases = []operationTestCase{
|
||||
{
|
||||
Name: "Connect to ReachView",
|
||||
Run: func(t *testing.T, ops protocol.Operations) {
|
||||
ctx := context.Background()
|
||||
|
||||
if err := ops.Connect(ctx); err != nil {
|
||||
t.Errorf("%+v", errors.WithStack(err))
|
||||
return
|
||||
}
|
||||
|
||||
defer func() {
|
||||
if err := ops.Close(ctx); err != nil {
|
||||
t.Errorf("%+v", errors.WithStack(err))
|
||||
}
|
||||
}()
|
||||
|
||||
alive, err := ops.Alive(ctx)
|
||||
if err != nil {
|
||||
t.Errorf("%+v", errors.WithStack(err))
|
||||
return
|
||||
}
|
||||
|
||||
if e, g := true, alive; e != g {
|
||||
t.Errorf("alive: expected '%v', got '%v'", e, g)
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
Name: "Retrieve ReachView version",
|
||||
Run: func(t *testing.T, ops protocol.Operations) {
|
||||
ctx := context.Background()
|
||||
|
||||
version, stable, err := ops.Version(ctx)
|
||||
if err != nil {
|
||||
t.Errorf("%+v", errors.WithStack(err))
|
||||
return
|
||||
}
|
||||
|
||||
t.Logf("ReachView version: %s", version)
|
||||
t.Logf("ReachView stable channel: %v", stable)
|
||||
},
|
||||
},
|
||||
{
|
||||
Name: "Listen to ReachView 'broadcast' messages",
|
||||
Run: func(t *testing.T, ops protocol.Operations) {
|
||||
ctx := context.Background()
|
||||
|
||||
if err := ops.Connect(ctx); err != nil {
|
||||
t.Errorf("%+v", errors.WithStack(err))
|
||||
return
|
||||
}
|
||||
|
||||
defer func() {
|
||||
if err := ops.Close(ctx); err != nil {
|
||||
t.Errorf("%+v", errors.WithStack(err))
|
||||
}
|
||||
}()
|
||||
|
||||
broadcastCtx, cancel := context.WithTimeout(ctx, 5*time.Second)
|
||||
defer cancel()
|
||||
|
||||
messages, err := ops.On(broadcastCtx, "broadcast")
|
||||
if err != nil {
|
||||
t.Errorf("%+v", errors.WithStack(err))
|
||||
return
|
||||
}
|
||||
|
||||
count := 0
|
||||
|
||||
for m := range messages {
|
||||
t.Logf("new message: %s", spew.Sdump(m))
|
||||
count++
|
||||
}
|
||||
|
||||
if e, g := 1, count; g < e {
|
||||
t.Errorf("expected total messages > %d, got %d", e, g)
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
Name: "Retrieve module configuration",
|
||||
Run: func(t *testing.T, ops protocol.Operations) {
|
||||
ctx := context.Background()
|
||||
|
||||
config, err := ops.Configuration(ctx)
|
||||
if err != nil {
|
||||
t.Errorf("%+v", errors.WithStack(err))
|
||||
return
|
||||
}
|
||||
|
||||
t.Logf("Module configuration: %s", spew.Sdump(config))
|
||||
},
|
||||
},
|
||||
{
|
||||
Name: "Set base",
|
||||
Run: func(t *testing.T, ops protocol.Operations) {
|
||||
ctx := context.Background()
|
||||
|
||||
opts := []protocol.SetBaseOptionFunc{
|
||||
protocol.WithBaseLatitude(47.72769),
|
||||
protocol.WithBaseLongitude(4.72783),
|
||||
protocol.WithBaseHeight(101),
|
||||
protocol.WithBaseMode("manual"),
|
||||
}
|
||||
|
||||
if err := ops.SetBase(ctx, opts...); err != nil {
|
||||
t.Errorf("%+v", errors.WithStack(err))
|
||||
return
|
||||
}
|
||||
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
func TestOperations(t *testing.T, opsFactory OperationsFactoryFunc) {
|
||||
reach.AssertIntegrationTests(t)
|
||||
|
||||
addr := os.Getenv("REACHRS_HOST")
|
||||
if addr == "" {
|
||||
addr = "192.168.42.1"
|
||||
t.Logf("Targeting '%s'. You can modify targeted host by specifying environment variable REACHRS_HOST", addr)
|
||||
} else {
|
||||
t.Logf("Targeting '%s'", addr)
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.Name, func(t *testing.T) {
|
||||
ops, err := opsFactory(addr)
|
||||
if err != nil {
|
||||
t.Fatalf("could not initialize protocol operations: %+v", errors.WithStack(err))
|
||||
}
|
||||
|
||||
tc.Run(t, ops)
|
||||
})
|
||||
}
|
||||
}
|
|
@ -0,0 +1,243 @@
|
|||
package model
|
||||
|
||||
var (
|
||||
// On -
|
||||
On = String("on")
|
||||
// Off -
|
||||
Off = String("off")
|
||||
// True -
|
||||
True = Bool(true)
|
||||
// False -
|
||||
False = Bool(false)
|
||||
// GPSARModeFixAndHold -
|
||||
GPSARModeFixAndHold = String("fix-and-hold")
|
||||
// GPSARModeContinuous -
|
||||
GPSARModeContinuous = String("continuous")
|
||||
// PositionningModeKinematic -
|
||||
PositionningModeKinematic = String("kinematic")
|
||||
// PositionningModeSingle -
|
||||
PositionningModeSingle = String("single")
|
||||
// PositionningModeStatic -
|
||||
PositionningModeStatic = String("static")
|
||||
// IOFormatRTCM3 -
|
||||
IOFormatRTCM3 = String("rtcm3")
|
||||
// IOTypeLoRa -
|
||||
IOTypeLoRa = String("lora")
|
||||
// BaseCoordinatesModeManual -
|
||||
BaseCoordinatesModeManual = String("manual")
|
||||
// BaseCoordinatesModeAverageFix -
|
||||
BaseCoordinatesModeAverageFix = String("fix-and-hold")
|
||||
// BaseCoordinatesModeAverageSingle -
|
||||
BaseCoordinatesModeAverageSingle = String("single-and-hold")
|
||||
// BaseCoordinatesModeAverageFloat -
|
||||
BaseCoordinatesModeAverageFloat = String("float-and-hold")
|
||||
// BaseCoordinatesFormatLLH -
|
||||
BaseCoordinatesFormatLLH = String("llh")
|
||||
// BaseCoordinatesFormatXYZ -
|
||||
BaseCoordinatesFormatXYZ = String("xyz")
|
||||
)
|
||||
|
||||
// String returns an string pointer
|
||||
// This is a helper to constructs partials configations objects
|
||||
// for the ApplyConfiguration() method
|
||||
func String(v string) *string {
|
||||
return &v
|
||||
}
|
||||
|
||||
// Int returns an int pointer
|
||||
// This is a helper to constructs partials configations objects
|
||||
// for the ApplyConfiguration() method
|
||||
func Int(v int) *int {
|
||||
return &v
|
||||
}
|
||||
|
||||
// Bool returns a bool pointer
|
||||
// This is a helper to constructs partials configations objects
|
||||
// for the ApplyConfiguration() method
|
||||
func Bool(v bool) *bool {
|
||||
return &v
|
||||
}
|
||||
|
||||
// Float returns a float64 pointer
|
||||
// This is a helper to constructs partials configations objects
|
||||
// for the ApplyConfiguration() method
|
||||
func Float(v float64) *float64 {
|
||||
return &v
|
||||
}
|
||||
|
||||
// Configuration -
|
||||
type Configuration struct {
|
||||
RTKSettings *RTKSettings `mapstructure:"rtk settings,omitempty" json:"rtk settings,omitempty"`
|
||||
CorrectionInput *CorrectionInput `mapstructure:"correction input,omitempty" json:"correction input,omitempty"`
|
||||
PositionOutput *PositionOutput `mapstructure:"position output,omitempty" json:"position output,omitempty"`
|
||||
BaseMode *BaseMode `mapstructure:"base mode,omitempty" json:"base mode,omitempty"`
|
||||
Logging *Logging `mapstructure:"logging,omitempty" json:"logging,omitempty"`
|
||||
Bluetooth *Bluetooth `mapstructure:"bluetooth,omitempty" json:"bluetooth,omitempty"`
|
||||
LoRa *LoRa `mapstructure:"lora,omitempty" json:"lora,omitempty"`
|
||||
Constraints *Constraints `mapstructure:"constraints,omitempty" json:"constraints,omitempty"`
|
||||
}
|
||||
|
||||
// RTKSettings -
|
||||
type RTKSettings struct {
|
||||
GLONASSARMode *string `mapstructure:"glonass ar mode,omitempty" json:"glonass ar mode,omitempty"`
|
||||
UpdateRate *float64 `mapstructure:"update rate,omitempty" json:"update rate,omitempty"`
|
||||
ElevationMaskAngle *string `mapstructure:"elevation mask angle,omitempty" json:"elevation mask angle,omitempty"`
|
||||
MaxHorizontalAcceleration *string `mapstructure:"max horizontal acceleration,omitempty" json:"max horizontal acceleration,omitempty"`
|
||||
SNRMask *string `mapstructure:"snr mask,omitempty" json:"snr mask,omitempty"`
|
||||
GPSARMode *string `mapstructure:"gps ar mode,omitempty" json:"gps ar mode,omitempty"`
|
||||
PositionningMode *string `mapstructure:"positioning mode,omitempty" json:"positioning mode,omitempty"`
|
||||
PositioningSystems *PositionningSystems `mapstructure:"positioning systems,omitempty" json:"positioning systems,omitempty"`
|
||||
MaxVerticalAcceleration *string `mapstructure:"max vertical acceleration,omitempty" json:"max vertical acceleration,omitempty"`
|
||||
}
|
||||
|
||||
// PositionningSystems -
|
||||
type PositionningSystems struct {
|
||||
GLONASS *bool `mapstructure:"glonass,omitempty" json:"glonass,omitempty"`
|
||||
SBAS *bool `mapstructure:"sbas,omitempty" json:"sbas,omitempty"`
|
||||
QZS *bool `mapstructure:"qzs,omitempty" json:"qzs,omitempty"`
|
||||
QZSS *bool `mapstructure:"qzss,omitempty" json:"qzss,omitempty"`
|
||||
Compass *bool `mapstructure:"compass,omitempty" json:"compass,omitempty"`
|
||||
Galileo *bool `mapstructure:"galileo,omitempty" json:"galileo,omitempty"`
|
||||
GPS *bool `mapstructure:"gps,omitempty" json:"gps,omitempty"`
|
||||
}
|
||||
|
||||
// CorrectionInput -
|
||||
type CorrectionInput struct {
|
||||
Input2 *Input2 `mapstructure:"input2,omitempty" json:"input2,omitempty"`
|
||||
Input3 *Input3 `mapstructure:"input3,omitempty" json:"input3,omitempty"`
|
||||
}
|
||||
|
||||
// Input -
|
||||
type Input struct {
|
||||
Path *string `mapstructure:"path,omitempty" json:"path,omitempty"`
|
||||
Type *string `mapstructure:"type,omitempty" json:"type,omitempty"`
|
||||
Enabled *bool `mapstructure:"enabled,omitempty" json:"enabled,omitempty"`
|
||||
Format *string `mapstructure:"format,omitempty" json:"format,omitempty"`
|
||||
}
|
||||
|
||||
// Input2 -
|
||||
type Input2 struct {
|
||||
Input `mapstructure:",squash"`
|
||||
SendPositionToBase *string `mapstructure:"send position to base,omitempty" json:"send position to base,omitempty"`
|
||||
}
|
||||
|
||||
// Input3 -
|
||||
type Input3 struct {
|
||||
Input `mapstructure:",squash"`
|
||||
}
|
||||
|
||||
// PositionOutput -
|
||||
type PositionOutput struct {
|
||||
Output1 *Output `mapstructure:"output1,omitempty" json:"output1,omitempty"`
|
||||
Output2 *Output `mapstructure:"output2,omitempty" json:"output2,omitempty"`
|
||||
Output3 *Output `mapstructure:"output3,omitempty" json:"output3,omitempty"`
|
||||
Output4 *Output `mapstructure:"output4,omitempty" json:"output4,omitempty"`
|
||||
}
|
||||
|
||||
// Output -
|
||||
type Output struct {
|
||||
Path *string `mapstructure:"path,omitempty" json:"path,omitempty"`
|
||||
Type *string `mapstructure:"type,omitempty" json:"type,omitempty"`
|
||||
Enabled *bool `mapstructure:"enabled,omitempty" json:"enabled,omitempty"`
|
||||
Format *string `mapstructure:"format,omitempty" json:"format,omitempty"`
|
||||
}
|
||||
|
||||
// BaseMode -
|
||||
type BaseMode struct {
|
||||
Output *Output `mapstructure:"output,omitempty" json:"output,omitempty"`
|
||||
BaseCoordinates *BaseCoordinates `mapstructure:"base coordinates,omitempty" json:"base coordinates,omitempty"`
|
||||
RTCM3Messages *RTCM3Messages `mapstructure:"rtcm3 messages,omitempty" json:"rtcm3 messages,omitempty"`
|
||||
}
|
||||
|
||||
// BaseCoordinates -
|
||||
type BaseCoordinates struct {
|
||||
Format *string `mapstructure:"format,omitempty" json:"format,omitempty"`
|
||||
AntennaOffset *AntennaOffset `mapstructure:"antenna offset,omitempty" json:"antenna offset,omitempty"`
|
||||
Accumulation *string `mapstructure:"accumulation,omitempty" json:"accumulation,omitempty"`
|
||||
Coordinates []*string `mapstructure:"coordinates,omitempty" json:"coordinates,omitempty"`
|
||||
Mode *string `mapstructure:"mode,omitempty" json:"mode,omitempty"`
|
||||
}
|
||||
|
||||
// AntennaOffset -
|
||||
type AntennaOffset struct {
|
||||
East *string `mapstructure:"east,omitempty" json:"east,omitempty"`
|
||||
North *string `mapstructure:"north,omitempty" json:"north,omitempty"`
|
||||
Up *string `mapstructure:"up,omitempty" json:"up,omitempty"`
|
||||
}
|
||||
|
||||
// RTCM3Messages -
|
||||
type RTCM3Messages struct {
|
||||
// GPS L1 code and phase and ambiguities and carrier-to-noise ratio
|
||||
Type1002 *RTCMMessageType `mapstructure:"1002,omitemtpy" json:"1002,omitemtpy"`
|
||||
// Station coordinates XYZ for antenna reference point and antenna height.
|
||||
Type1006 *RTCMMessageType `mapstructure:"1006,omitemtpy" json:"1006,omitemtpy"`
|
||||
// Antenna serial number.
|
||||
Type1008 *RTCMMessageType `mapstructure:"1008,omitemtpy" json:"1008,omitemtpy"`
|
||||
// GLONASS L1 code and phase and ambiguities and carrier-to-noise ratio.
|
||||
Type1010 *RTCMMessageType `mapstructure:"1010,omitemtpy" json:"1010,omitemtpy"`
|
||||
// GPS ephemeris.
|
||||
Type1019 *RTCMMessageType `mapstructure:"1019,omitemtpy" json:"1019,omitemtpy"`
|
||||
// GLONASS ephemeris.
|
||||
Type1020 *RTCMMessageType `mapstructure:"1020,omitemtpy" json:"1020,omitemtpy"`
|
||||
// The type 7 Multiple Signal Message format for Europe’s Galileo system
|
||||
Type1097 *RTCMMessageType `mapstructure:"1097,omitemtpy" json:"1097,omitemtpy"`
|
||||
// Full SBAS pseudo-ranges, carrier phases, Doppler and signal strength (high resolution)
|
||||
Type1107 *RTCMMessageType `mapstructure:"1107,omitemtpy" json:"1107,omitemtpy"`
|
||||
// Full QZSS pseudo-ranges, carrier phases, Doppler and signal strength (high resolution)
|
||||
Type1117 *RTCMMessageType `mapstructure:"1117,omitemtpy" json:"1117,omitemtpy"`
|
||||
// Full BeiDou pseudo-ranges, carrier phases, Doppler and signal strength (high resolution)
|
||||
Type1127 *RTCMMessageType `mapstructure:"1127,omitemtpy" json:"1127,omitemtpy"`
|
||||
}
|
||||
|
||||
// RTCMMessageType -
|
||||
type RTCMMessageType struct {
|
||||
Frequency *string `mapstructure:"frequency,omitempty" json:"frequency,omitempty"`
|
||||
Enabled *bool `mapstructure:"enabled,omitempty" json:"enabled,omitempty"`
|
||||
}
|
||||
|
||||
// Logging -
|
||||
type Logging struct {
|
||||
Correction *LoggingService `mapstructure:"correction,omitempty" json:"correction,omitempty"`
|
||||
Interval *int `mapstructure:"interval,omitempty" json:"interval,omitempty"`
|
||||
Solution *LoggingService `mapstructure:"solution,omitempty" json:"solution,omitempty"`
|
||||
Raw *LoggingService `mapstructure:"raw,omitempty" json:"raw,omitempty"`
|
||||
Base *LoggingService `mapstructure:"base,omitempty" json:"base,omitempty"`
|
||||
Overwrite *bool `mapstructure:"overwrite,omitempty" json:"overwrite,omitempty"`
|
||||
}
|
||||
|
||||
// LoggingService -
|
||||
type LoggingService struct {
|
||||
Started *bool `mapstructure:"started,omitempty" json:"started,omitempty"`
|
||||
Version *string `mapstructure:"version,omitempty" json:"version,omitempty"`
|
||||
Format *string `mapstructure:"format,omitempty" json:"format,omitempty"`
|
||||
}
|
||||
|
||||
// Bluetooth -
|
||||
type Bluetooth struct {
|
||||
Enabled *bool `mapstructure:"enabled,omitempty" json:"enabled,omitempty"`
|
||||
Discoverable *bool `mapstructure:"discoverable,omitempty" json:"discoverable,omitempty"`
|
||||
Pin *int `mapstructure:"pin,omitempty" json:"pin,omitempty"`
|
||||
}
|
||||
|
||||
// LoRa -
|
||||
type LoRa struct {
|
||||
AirRate *string `mapstructure:"air rate,omitempty" json:"air rate,omitempty"`
|
||||
Frequency *float64 `mapstructure:"frequency,omitempty" json:"frequency,omitempty"`
|
||||
OutputPower *string `mapstructure:"output power,omitempty" json:"output power,omitempty"`
|
||||
}
|
||||
|
||||
// Constraints -
|
||||
type Constraints struct {
|
||||
LoRa *LoRaConstraints `mapstructure:"lora,omitempty" json:"lora,omitempty"`
|
||||
}
|
||||
|
||||
// LoRaConstraints -
|
||||
type LoRaConstraints struct {
|
||||
Frequency [][]int `mapstructure:"frequency,omitempty" json:"frequency,omitempty"`
|
||||
}
|
||||
|
||||
// LoRaFrequencyRange -
|
||||
type LoRaFrequencyRange struct {
|
||||
Min *int `mapstructure:"min,omitempty" json:"min,omitempty"`
|
||||
Max *int `mapstructure:"max,omitempty" json:"max,omitempty"`
|
||||
}
|
|
@ -0,0 +1,29 @@
|
|||
package v1
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/protocol"
|
||||
)
|
||||
|
||||
const Identifier protocol.Identifier = "v1"
|
||||
|
||||
type Protocol struct {
|
||||
}
|
||||
|
||||
// Available implements protocol.Protocol.
|
||||
func (p *Protocol) Available(ctx context.Context, addr string) (bool, error) {
|
||||
panic("unimplemented")
|
||||
}
|
||||
|
||||
// Identifier implements protocol.Protocol.
|
||||
func (p *Protocol) Identifier() protocol.Identifier {
|
||||
return Identifier
|
||||
}
|
||||
|
||||
// Operations implements protocol.Protocol.
|
||||
func (p *Protocol) Operations(addr string) protocol.Operations {
|
||||
panic("unimplemented")
|
||||
}
|
||||
|
||||
var _ protocol.Protocol = &Protocol{}
|
|
@ -0,0 +1,127 @@
|
|||
package v2
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/protocol/v2/model"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
func (o *Operations) getURL(path string) string {
|
||||
return fmt.Sprintf("http://%s%s", o.addr, path)
|
||||
}
|
||||
|
||||
func (o *Operations) GetJSON(path string, dst any) error {
|
||||
var res *http.Response
|
||||
|
||||
url := o.getURL(path)
|
||||
res, err := http.Get(url)
|
||||
if err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
if res.StatusCode < http.StatusOK || res.StatusCode >= http.StatusBadRequest {
|
||||
return errors.Errorf("unexpected http status code %d (%s)", res.StatusCode, res.Status)
|
||||
}
|
||||
|
||||
defer func() {
|
||||
if err := res.Body.Close(); err != nil {
|
||||
errors.WithStack(err)
|
||||
}
|
||||
}()
|
||||
|
||||
var body []byte
|
||||
|
||||
body, err = io.ReadAll(res.Body)
|
||||
if err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
if err = json.Unmarshal(body, dst); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (o *Operations) PostJSON(path string, data any, dst any) error {
|
||||
var res *http.Response
|
||||
|
||||
var buf bytes.Buffer
|
||||
|
||||
encoder := json.NewEncoder(&buf)
|
||||
if err := encoder.Encode(data); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
url := o.getURL(path)
|
||||
res, err := http.Post(url, "application/json", &buf)
|
||||
if err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
if res.StatusCode < http.StatusOK || res.StatusCode >= http.StatusBadRequest {
|
||||
return errors.Errorf("unexpected http status code %d (%s)", res.StatusCode, res.Status)
|
||||
}
|
||||
|
||||
defer func() {
|
||||
if err := res.Body.Close(); err != nil {
|
||||
errors.WithStack(err)
|
||||
}
|
||||
}()
|
||||
|
||||
var body []byte
|
||||
|
||||
body, err = io.ReadAll(res.Body)
|
||||
if err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
if err = json.Unmarshal(body, dst); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (o *Operations) PostBaseCoordinates(ctx context.Context, base *model.Base) (*model.Base, error) {
|
||||
var updated model.Base
|
||||
|
||||
if err := o.PostJSON("/configuration/base_mode/base_coordinates", base, &updated); err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return &updated, nil
|
||||
}
|
||||
|
||||
func (o *Operations) GetUpdater(ctx context.Context) (*model.Updater, error) {
|
||||
updater := &model.Updater{}
|
||||
if err := o.GetJSON("/updater", updater); err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return updater, nil
|
||||
}
|
||||
|
||||
func (o *Operations) GetInfo(ctx context.Context) (*model.Info, error) {
|
||||
info := &model.Info{}
|
||||
if err := o.GetJSON("/info", info); err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return info, nil
|
||||
}
|
||||
|
||||
func (o *Operations) GetConfiguration(ctx context.Context) (*model.Configuration, error) {
|
||||
config := &model.Configuration{}
|
||||
if err := o.GetJSON("/configuration", config); err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return config, nil
|
||||
}
|
|
@ -0,0 +1,7 @@
|
|||
package v2
|
||||
|
||||
import "forge.cadoles.com/cadoles/go-emlid/reach/client/protocol"
|
||||
|
||||
func init() {
|
||||
protocol.Register(&Protocol{})
|
||||
}
|
|
@ -0,0 +1,14 @@
|
|||
package model
|
||||
|
||||
type Base struct {
|
||||
Accumulation int `json:"accumulation,omitempty"`
|
||||
AntennaOffset float64 `json:"antenna_offset,omitempty"`
|
||||
Coordinates BaseCoordinates `json:"coordinates,omitempty"`
|
||||
Mode string `json:"mode,omitempty"`
|
||||
}
|
||||
|
||||
type BaseCoordinates struct {
|
||||
Height float64 `json:"height,omitempty"`
|
||||
Latitude float64 `json:"latitude,omitempty"`
|
||||
Longitude float64 `json:"longitude,omitempty"`
|
||||
}
|
|
@ -0,0 +1,563 @@
|
|||
package model
|
||||
|
||||
type Configuration struct {
|
||||
BaseMode struct {
|
||||
BaseCoordinates struct {
|
||||
Accumulation int `json:"accumulation,omitempty"`
|
||||
AntennaOffset float64 `json:"antenna_offset,omitempty"`
|
||||
Coordinates struct {
|
||||
Height float64 `json:"height,omitempty"`
|
||||
Latitude float64 `json:"latitude,omitempty"`
|
||||
Longitude float64 `json:"longitude,omitempty"`
|
||||
} `json:"coordinates,omitempty"`
|
||||
Mode string `json:"mode,omitempty"`
|
||||
} `json:"base_coordinates,omitempty"`
|
||||
Output struct {
|
||||
IoType string `json:"io_type,omitempty"`
|
||||
Settings struct {
|
||||
Lora struct {
|
||||
AirRate float64 `json:"air_rate,omitempty"`
|
||||
Frequency int `json:"frequency,omitempty"`
|
||||
OutputPower int `json:"output_power,omitempty"`
|
||||
} `json:"lora,omitempty"`
|
||||
Ntripcaster struct {
|
||||
MountPoint string `json:"mount_point,omitempty"`
|
||||
Password string `json:"password,omitempty"`
|
||||
Port int `json:"port,omitempty"`
|
||||
Username string `json:"username,omitempty"`
|
||||
} `json:"ntripcaster,omitempty"`
|
||||
Ntripsvr struct {
|
||||
Address string `json:"address,omitempty"`
|
||||
MountPoint string `json:"mount_point,omitempty"`
|
||||
Password string `json:"password,omitempty"`
|
||||
Port int `json:"port,omitempty"`
|
||||
} `json:"ntripsvr,omitempty"`
|
||||
Serial struct {
|
||||
BaudRate int `json:"baud_rate,omitempty"`
|
||||
Device string `json:"device,omitempty"`
|
||||
} `json:"serial,omitempty"`
|
||||
Tcpcli struct {
|
||||
Address string `json:"address,omitempty"`
|
||||
Port int `json:"port,omitempty"`
|
||||
} `json:"tcpcli,omitempty"`
|
||||
Tcpsvr struct {
|
||||
Port int `json:"port,omitempty"`
|
||||
} `json:"tcpsvr,omitempty"`
|
||||
} `json:"settings,omitempty"`
|
||||
} `json:"output,omitempty"`
|
||||
Rtcm3Messages struct {
|
||||
Num1004 struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Frequency int `json:"frequency,omitempty"`
|
||||
} `json:"1004,omitempty"`
|
||||
Num1006 struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Frequency float64 `json:"frequency,omitempty"`
|
||||
} `json:"1006,omitempty"`
|
||||
Num1008 struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Frequency float64 `json:"frequency,omitempty"`
|
||||
} `json:"1008,omitempty"`
|
||||
Num1012 struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Frequency int `json:"frequency,omitempty"`
|
||||
} `json:"1012,omitempty"`
|
||||
Num1033 struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Frequency float64 `json:"frequency,omitempty"`
|
||||
} `json:"1033,omitempty"`
|
||||
Num1074 struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Frequency float64 `json:"frequency,omitempty"`
|
||||
} `json:"1074,omitempty"`
|
||||
Num1084 struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Frequency float64 `json:"frequency,omitempty"`
|
||||
} `json:"1084,omitempty"`
|
||||
Num1094 struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Frequency float64 `json:"frequency,omitempty"`
|
||||
} `json:"1094,omitempty"`
|
||||
Num1124 struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Frequency float64 `json:"frequency,omitempty"`
|
||||
} `json:"1124,omitempty"`
|
||||
Num1230 struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Frequency float64 `json:"frequency,omitempty"`
|
||||
} `json:"1230,omitempty"`
|
||||
} `json:"rtcm3_messages,omitempty"`
|
||||
} `json:"base_mode,omitempty"`
|
||||
Bluetooth struct {
|
||||
BleEnabled bool `json:"ble_enabled,omitempty"`
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Pairing struct {
|
||||
Discoverable bool `json:"discoverable,omitempty"`
|
||||
NoInputNoOutput bool `json:"no_input_no_output,omitempty"`
|
||||
Pin string `json:"pin,omitempty"`
|
||||
} `json:"pairing,omitempty"`
|
||||
} `json:"bluetooth,omitempty"`
|
||||
CorrectionInput struct {
|
||||
BaseCorrections struct {
|
||||
IoType string `json:"io_type,omitempty"`
|
||||
LastUsed struct {
|
||||
Ntrip string `json:"ntrip,omitempty"`
|
||||
Radio string `json:"radio,omitempty"`
|
||||
TCP string `json:"tcp,omitempty"`
|
||||
} `json:"last_used,omitempty"`
|
||||
Settings struct {
|
||||
Ble struct {
|
||||
Address string `json:"address,omitempty"`
|
||||
MountPoint string `json:"mount_point,omitempty"`
|
||||
Password string `json:"password,omitempty"`
|
||||
Port int `json:"port,omitempty"`
|
||||
SendPositionToBase bool `json:"send_position_to_base,omitempty"`
|
||||
Username string `json:"username,omitempty"`
|
||||
} `json:"ble,omitempty"`
|
||||
Bluetooth struct {
|
||||
SendPositionToBase bool `json:"send_position_to_base,omitempty"`
|
||||
} `json:"bluetooth,omitempty"`
|
||||
Lora struct {
|
||||
AirRate float64 `json:"air_rate,omitempty"`
|
||||
Frequency int `json:"frequency,omitempty"`
|
||||
OutputPower int `json:"output_power,omitempty"`
|
||||
SendPositionToBase bool `json:"send_position_to_base,omitempty"`
|
||||
} `json:"lora,omitempty"`
|
||||
Ntripcli struct {
|
||||
Address string `json:"address,omitempty"`
|
||||
MountPoint string `json:"mount_point,omitempty"`
|
||||
Password string `json:"password,omitempty"`
|
||||
Port int `json:"port,omitempty"`
|
||||
SendPositionToBase bool `json:"send_position_to_base,omitempty"`
|
||||
Username string `json:"username,omitempty"`
|
||||
} `json:"ntripcli,omitempty"`
|
||||
Serial struct {
|
||||
BaudRate int `json:"baud_rate,omitempty"`
|
||||
Device string `json:"device,omitempty"`
|
||||
SendPositionToBase bool `json:"send_position_to_base,omitempty"`
|
||||
} `json:"serial,omitempty"`
|
||||
Tcpcli struct {
|
||||
Address string `json:"address,omitempty"`
|
||||
Port int `json:"port,omitempty"`
|
||||
SendPositionToBase bool `json:"send_position_to_base,omitempty"`
|
||||
} `json:"tcpcli,omitempty"`
|
||||
Tcpsvr struct {
|
||||
Port int `json:"port,omitempty"`
|
||||
SendPositionToBase bool `json:"send_position_to_base,omitempty"`
|
||||
} `json:"tcpsvr,omitempty"`
|
||||
} `json:"settings,omitempty"`
|
||||
} `json:"base_corrections,omitempty"`
|
||||
} `json:"correction_input,omitempty"`
|
||||
Device struct {
|
||||
AntennaHeight float64 `json:"antenna_height,omitempty"`
|
||||
NightMode bool `json:"night_mode,omitempty"`
|
||||
OnboardingShown bool `json:"onboarding_shown,omitempty"`
|
||||
PowerOnBottomConnector bool `json:"power_on_bottom_connector,omitempty"`
|
||||
PrivacyPolicyAccepted bool `json:"privacy_policy_accepted,omitempty"`
|
||||
Role string `json:"role,omitempty"`
|
||||
UsageAnalysisAccepted bool `json:"usage_analysis_accepted,omitempty"`
|
||||
} `json:"device,omitempty"`
|
||||
Logging struct {
|
||||
Logs struct {
|
||||
Autostart bool `json:"autostart,omitempty"`
|
||||
Base struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Format string `json:"format,omitempty"`
|
||||
} `json:"base,omitempty"`
|
||||
Raw struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Format string `json:"format,omitempty"`
|
||||
RinexOptions struct {
|
||||
LoggingInterval int `json:"logging_interval,omitempty"`
|
||||
MarkerName any `json:"marker_name,omitempty"`
|
||||
Preset string `json:"preset,omitempty"`
|
||||
SatelliteSystems struct {
|
||||
Beidou bool `json:"beidou,omitempty"`
|
||||
Galileo bool `json:"galileo,omitempty"`
|
||||
Glonass bool `json:"glonass,omitempty"`
|
||||
Gps bool `json:"gps,omitempty"`
|
||||
Qzss bool `json:"qzss,omitempty"`
|
||||
Sbas bool `json:"sbas,omitempty"`
|
||||
} `json:"satellite_systems,omitempty"`
|
||||
TimeAdjustmentsEnabled bool `json:"time_adjustments_enabled,omitempty"`
|
||||
} `json:"rinex_options,omitempty"`
|
||||
Version string `json:"version,omitempty"`
|
||||
} `json:"raw,omitempty"`
|
||||
Solution struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
Format string `json:"format,omitempty"`
|
||||
} `json:"solution,omitempty"`
|
||||
Started bool `json:"started,omitempty"`
|
||||
} `json:"logs,omitempty"`
|
||||
Settings struct {
|
||||
ArchiveName any `json:"archive_name,omitempty"`
|
||||
Debug bool `json:"debug,omitempty"`
|
||||
Interval int `json:"interval,omitempty"`
|
||||
Overwrite bool `json:"overwrite,omitempty"`
|
||||
SimultaneousLogging bool `json:"simultaneous_logging,omitempty"`
|
||||
SplitAtMidnightUtc bool `json:"split_at_midnight_utc,omitempty"`
|
||||
} `json:"settings,omitempty"`
|
||||
} `json:"logging,omitempty"`
|
||||
Network struct {
|
||||
TCPOverModem bool `json:"tcp_over_modem,omitempty"`
|
||||
} `json:"network,omitempty"`
|
||||
PositionOutput struct {
|
||||
Output1 struct {
|
||||
IoType string `json:"io_type,omitempty"`
|
||||
LastUsed struct {
|
||||
TCP string `json:"tcp,omitempty"`
|
||||
} `json:"last_used,omitempty"`
|
||||
NmeaSettings struct {
|
||||
Bluetooth struct {
|
||||
Ebp struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"ebp,omitempty"`
|
||||
Gga struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gga,omitempty"`
|
||||
Gsa struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsa,omitempty"`
|
||||
Gst struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gst,omitempty"`
|
||||
Gsv struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsv,omitempty"`
|
||||
MainTalkerID string `json:"main_talker_id,omitempty"`
|
||||
Rmc struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"rmc,omitempty"`
|
||||
Vtg struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"vtg,omitempty"`
|
||||
Zda struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"zda,omitempty"`
|
||||
} `json:"bluetooth,omitempty"`
|
||||
Serial struct {
|
||||
Ebp struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"ebp,omitempty"`
|
||||
Gga struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gga,omitempty"`
|
||||
Gsa struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsa,omitempty"`
|
||||
Gst struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gst,omitempty"`
|
||||
Gsv struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsv,omitempty"`
|
||||
MainTalkerID string `json:"main_talker_id,omitempty"`
|
||||
Rmc struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"rmc,omitempty"`
|
||||
Vtg struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"vtg,omitempty"`
|
||||
Zda struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"zda,omitempty"`
|
||||
} `json:"serial,omitempty"`
|
||||
Tcpcli struct {
|
||||
Ebp struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"ebp,omitempty"`
|
||||
Gga struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gga,omitempty"`
|
||||
Gsa struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsa,omitempty"`
|
||||
Gst struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gst,omitempty"`
|
||||
Gsv struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsv,omitempty"`
|
||||
MainTalkerID string `json:"main_talker_id,omitempty"`
|
||||
Rmc struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"rmc,omitempty"`
|
||||
Vtg struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"vtg,omitempty"`
|
||||
Zda struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"zda,omitempty"`
|
||||
} `json:"tcpcli,omitempty"`
|
||||
Tcpsvr struct {
|
||||
Ebp struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"ebp,omitempty"`
|
||||
Gga struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gga,omitempty"`
|
||||
Gsa struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsa,omitempty"`
|
||||
Gst struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gst,omitempty"`
|
||||
Gsv struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsv,omitempty"`
|
||||
MainTalkerID string `json:"main_talker_id,omitempty"`
|
||||
Rmc struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"rmc,omitempty"`
|
||||
Vtg struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"vtg,omitempty"`
|
||||
Zda struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"zda,omitempty"`
|
||||
} `json:"tcpsvr,omitempty"`
|
||||
} `json:"nmea_settings,omitempty"`
|
||||
Settings struct {
|
||||
Bluetooth struct {
|
||||
Format string `json:"format,omitempty"`
|
||||
} `json:"bluetooth,omitempty"`
|
||||
Serial struct {
|
||||
BaudRate int `json:"baud_rate,omitempty"`
|
||||
Device string `json:"device,omitempty"`
|
||||
Format string `json:"format,omitempty"`
|
||||
} `json:"serial,omitempty"`
|
||||
Tcpcli struct {
|
||||
Address string `json:"address,omitempty"`
|
||||
Format string `json:"format,omitempty"`
|
||||
Port int `json:"port,omitempty"`
|
||||
} `json:"tcpcli,omitempty"`
|
||||
Tcpsvr struct {
|
||||
Format string `json:"format,omitempty"`
|
||||
Port int `json:"port,omitempty"`
|
||||
} `json:"tcpsvr,omitempty"`
|
||||
} `json:"settings,omitempty"`
|
||||
} `json:"output1,omitempty"`
|
||||
Output2 struct {
|
||||
IoType string `json:"io_type,omitempty"`
|
||||
LastUsed struct {
|
||||
TCP string `json:"tcp,omitempty"`
|
||||
} `json:"last_used,omitempty"`
|
||||
NmeaSettings struct {
|
||||
Bluetooth struct {
|
||||
Ebp struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"ebp,omitempty"`
|
||||
Gga struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gga,omitempty"`
|
||||
Gsa struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsa,omitempty"`
|
||||
Gst struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gst,omitempty"`
|
||||
Gsv struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsv,omitempty"`
|
||||
MainTalkerID string `json:"main_talker_id,omitempty"`
|
||||
Rmc struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"rmc,omitempty"`
|
||||
Vtg struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"vtg,omitempty"`
|
||||
Zda struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"zda,omitempty"`
|
||||
} `json:"bluetooth,omitempty"`
|
||||
Serial struct {
|
||||
Ebp struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"ebp,omitempty"`
|
||||
Gga struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gga,omitempty"`
|
||||
Gsa struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsa,omitempty"`
|
||||
Gst struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gst,omitempty"`
|
||||
Gsv struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsv,omitempty"`
|
||||
MainTalkerID string `json:"main_talker_id,omitempty"`
|
||||
Rmc struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"rmc,omitempty"`
|
||||
Vtg struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"vtg,omitempty"`
|
||||
Zda struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"zda,omitempty"`
|
||||
} `json:"serial,omitempty"`
|
||||
Tcpcli struct {
|
||||
Ebp struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"ebp,omitempty"`
|
||||
Gga struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gga,omitempty"`
|
||||
Gsa struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsa,omitempty"`
|
||||
Gst struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gst,omitempty"`
|
||||
Gsv struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsv,omitempty"`
|
||||
MainTalkerID string `json:"main_talker_id,omitempty"`
|
||||
Rmc struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"rmc,omitempty"`
|
||||
Vtg struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"vtg,omitempty"`
|
||||
Zda struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"zda,omitempty"`
|
||||
} `json:"tcpcli,omitempty"`
|
||||
Tcpsvr struct {
|
||||
Ebp struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"ebp,omitempty"`
|
||||
Gga struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gga,omitempty"`
|
||||
Gsa struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsa,omitempty"`
|
||||
Gst struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gst,omitempty"`
|
||||
Gsv struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gsv,omitempty"`
|
||||
MainTalkerID string `json:"main_talker_id,omitempty"`
|
||||
Rmc struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"rmc,omitempty"`
|
||||
Vtg struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"vtg,omitempty"`
|
||||
Zda struct {
|
||||
Enabled bool `json:"enabled,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"zda,omitempty"`
|
||||
} `json:"tcpsvr,omitempty"`
|
||||
} `json:"nmea_settings,omitempty"`
|
||||
Settings struct {
|
||||
Bluetooth struct {
|
||||
Format string `json:"format,omitempty"`
|
||||
} `json:"bluetooth,omitempty"`
|
||||
Serial struct {
|
||||
BaudRate int `json:"baud_rate,omitempty"`
|
||||
Device string `json:"device,omitempty"`
|
||||
Format string `json:"format,omitempty"`
|
||||
} `json:"serial,omitempty"`
|
||||
Tcpcli struct {
|
||||
Address string `json:"address,omitempty"`
|
||||
Format string `json:"format,omitempty"`
|
||||
Port int `json:"port,omitempty"`
|
||||
} `json:"tcpcli,omitempty"`
|
||||
Tcpsvr struct {
|
||||
Format string `json:"format,omitempty"`
|
||||
Port int `json:"port,omitempty"`
|
||||
} `json:"tcpsvr,omitempty"`
|
||||
} `json:"settings,omitempty"`
|
||||
} `json:"output2,omitempty"`
|
||||
} `json:"position_output,omitempty"`
|
||||
PositioningSettings struct {
|
||||
ElevationMaskAngle int `json:"elevation_mask_angle,omitempty"`
|
||||
GlonassArMode bool `json:"glonass_ar_mode,omitempty"`
|
||||
GnssSettings struct {
|
||||
PositioningSystems struct {
|
||||
Beidou bool `json:"beidou,omitempty"`
|
||||
Galileo bool `json:"galileo,omitempty"`
|
||||
Glonass bool `json:"glonass,omitempty"`
|
||||
Gps bool `json:"gps,omitempty"`
|
||||
Qzss bool `json:"qzss,omitempty"`
|
||||
} `json:"positioning_systems,omitempty"`
|
||||
UpdateRate int `json:"update_rate,omitempty"`
|
||||
} `json:"gnss_settings,omitempty"`
|
||||
GpsArMode string `json:"gps_ar_mode,omitempty"`
|
||||
MaxHorizontalAcceleration int `json:"max_horizontal_acceleration,omitempty"`
|
||||
MaxVerticalAcceleration int `json:"max_vertical_acceleration,omitempty"`
|
||||
PositioningMode string `json:"positioning_mode,omitempty"`
|
||||
SnrMask int `json:"snr_mask,omitempty"`
|
||||
} `json:"positioning_settings,omitempty"`
|
||||
Sound struct {
|
||||
Mute bool `json:"mute,omitempty"`
|
||||
Volume int `json:"volume,omitempty"`
|
||||
} `json:"sound,omitempty"`
|
||||
}
|
|
@ -0,0 +1,166 @@
|
|||
package model
|
||||
|
||||
// GET http://<addr>/info
|
||||
// {
|
||||
// "device": {
|
||||
// "cloud": {
|
||||
// "supported": true,
|
||||
// "usage_analysis_accepted": false
|
||||
// },
|
||||
// "country_code": "FR",
|
||||
// "critical_self_tests_passed": true,
|
||||
// "is_first_time_setup": false,
|
||||
// "local_address": "Reach.local",
|
||||
// "manufacturing_timestamp": "1693633066",
|
||||
// "name": "Reach",
|
||||
// "privacy_policy_accepted": true,
|
||||
// "public_key": "378A5081F445771316A0563CFCC168C813261C6EE9C5C50DF70CC4503C6D8839BED7AA40146A9D8D72BFC4DB85382EEE51B90D03B6CC6DF34E860E15EFEA7D38",
|
||||
// "self_tests": {
|
||||
// "antenna_board_detected": true,
|
||||
// "audio": true,
|
||||
// "bluetooth_detected": true,
|
||||
// "crypto-chip": true,
|
||||
// "image_and_device": true,
|
||||
// "lora": true,
|
||||
// "modem": true,
|
||||
// "mpu": true,
|
||||
// "stm32": true,
|
||||
// "u-blox": true,
|
||||
// "wifi_detected": true
|
||||
// },
|
||||
// "serial_number": "8243276564AEA32D",
|
||||
// "statistics": {
|
||||
// "first_usage_timestamp": 4294967295
|
||||
// },
|
||||
// "time_sync_passed": true,
|
||||
// "type": "ReachRS2+",
|
||||
// "uptime": "2:50:57"
|
||||
// },
|
||||
// "firmware": {
|
||||
// "api_version": "10.2",
|
||||
// "app_mode": "default",
|
||||
// "onboarding_shown": false,
|
||||
// "version": "32.0",
|
||||
// "version_full": "32.0-r0"
|
||||
// },
|
||||
// "gnss_receiver": {
|
||||
// "firmware_version": "HPG_1.13"
|
||||
// },
|
||||
// "lora": {
|
||||
// "firmware_version": "F-0LR-1F-1912161"
|
||||
// },
|
||||
// "modem": {
|
||||
// "firmware_version": "MPSS.JO.2.0.2.c1.1-00098-9607_GENNS_PACK-1.402457.1 1 [May 18 2021 19:00:00]",
|
||||
// "imei": "350588283544948",
|
||||
// "modem_model": "\r\n^SYSSTART\r\n"
|
||||
// },
|
||||
// "pmu": {
|
||||
// "balancer_version": "190602",
|
||||
// "git_hash": "0a241756",
|
||||
// "version": "3.35"
|
||||
// },
|
||||
// "reachview": {
|
||||
// "api_version": "10.2",
|
||||
// "app_mode": "default",
|
||||
// "onboarding_shown": false,
|
||||
// "version": "32.0",
|
||||
// "version_full": "32.0-r0"
|
||||
// },
|
||||
// "storage": {
|
||||
// "free": 11682,
|
||||
// "total": 12374
|
||||
// }
|
||||
// }
|
||||
|
||||
type Info struct {
|
||||
Device Device `json:"device,omitempty"`
|
||||
Firmware Firmware `json:"firmware,omitempty"`
|
||||
GnssReceiver GnssReceiver `json:"gnss_receiver,omitempty"`
|
||||
Lora Lora `json:"lora,omitempty"`
|
||||
Modem Modem `json:"modem,omitempty"`
|
||||
Pmu Pmu `json:"pmu,omitempty"`
|
||||
Reachview Reachview `json:"reachview,omitempty"`
|
||||
Storage Storage `json:"storage,omitempty"`
|
||||
}
|
||||
|
||||
type Cloud struct {
|
||||
Supported bool `json:"supported,omitempty"`
|
||||
UsageAnalysisAccepted bool `json:"usage_analysis_accepted,omitempty"`
|
||||
}
|
||||
|
||||
type SelfTests struct {
|
||||
AntennaBoardDetected bool `json:"antenna_board_detected,omitempty"`
|
||||
Audio bool `json:"audio,omitempty"`
|
||||
BluetoothDetected bool `json:"bluetooth_detected,omitempty"`
|
||||
CryptoChip bool `json:"crypto-chip,omitempty"`
|
||||
ImageAndDevice bool `json:"image_and_device,omitempty"`
|
||||
Lora bool `json:"lora,omitempty"`
|
||||
Modem bool `json:"modem,omitempty"`
|
||||
Mpu bool `json:"mpu,omitempty"`
|
||||
Stm32 bool `json:"stm32,omitempty"`
|
||||
UBlox bool `json:"u-blox,omitempty"`
|
||||
WifiDetected bool `json:"wifi_detected,omitempty"`
|
||||
}
|
||||
|
||||
type Statistics struct {
|
||||
FirstUsageTimestamp int64 `json:"first_usage_timestamp,omitempty"`
|
||||
}
|
||||
|
||||
type Device struct {
|
||||
Cloud Cloud `json:"cloud,omitempty"`
|
||||
CountryCode string `json:"country_code,omitempty"`
|
||||
CriticalSelfTestsPassed bool `json:"critical_self_tests_passed,omitempty"`
|
||||
IsFirstTimeSetup bool `json:"is_first_time_setup,omitempty"`
|
||||
LocalAddress string `json:"local_address,omitempty"`
|
||||
ManufacturingTimestamp string `json:"manufacturing_timestamp,omitempty"`
|
||||
Name string `json:"name,omitempty"`
|
||||
PrivacyPolicyAccepted bool `json:"privacy_policy_accepted,omitempty"`
|
||||
PublicKey string `json:"public_key,omitempty"`
|
||||
SelfTests SelfTests `json:"self_tests,omitempty"`
|
||||
SerialNumber string `json:"serial_number,omitempty"`
|
||||
Statistics Statistics `json:"statistics,omitempty"`
|
||||
TimeSyncPassed bool `json:"time_sync_passed,omitempty"`
|
||||
Type string `json:"type,omitempty"`
|
||||
Uptime string `json:"uptime,omitempty"`
|
||||
}
|
||||
|
||||
type Firmware struct {
|
||||
APIVersion string `json:"api_version,omitempty"`
|
||||
AppMode string `json:"app_mode,omitempty"`
|
||||
OnboardingShown bool `json:"onboarding_shown,omitempty"`
|
||||
Version string `json:"version,omitempty"`
|
||||
VersionFull string `json:"version_full,omitempty"`
|
||||
}
|
||||
|
||||
type GnssReceiver struct {
|
||||
FirmwareVersion string `json:"firmware_version,omitempty"`
|
||||
}
|
||||
|
||||
type Lora struct {
|
||||
FirmwareVersion string `json:"firmware_version,omitempty"`
|
||||
}
|
||||
|
||||
type Modem struct {
|
||||
FirmwareVersion string `json:"firmware_version,omitempty"`
|
||||
Imei string `json:"imei,omitempty"`
|
||||
ModemModel string `json:"modem_model,omitempty"`
|
||||
}
|
||||
|
||||
type Pmu struct {
|
||||
BalancerVersion string `json:"balancer_version,omitempty"`
|
||||
GitHash string `json:"git_hash,omitempty"`
|
||||
Version string `json:"version,omitempty"`
|
||||
}
|
||||
|
||||
type Reachview struct {
|
||||
APIVersion string `json:"api_version,omitempty"`
|
||||
AppMode string `json:"app_mode,omitempty"`
|
||||
OnboardingShown bool `json:"onboarding_shown,omitempty"`
|
||||
Version string `json:"version,omitempty"`
|
||||
VersionFull string `json:"version_full,omitempty"`
|
||||
}
|
||||
|
||||
type Storage struct {
|
||||
Free int `json:"free,omitempty"`
|
||||
Total int `json:"total,omitempty"`
|
||||
}
|
|
@ -0,0 +1,55 @@
|
|||
package model
|
||||
|
||||
// {
|
||||
// "allowance": {
|
||||
// "allowed": true,
|
||||
// "reason": null
|
||||
// },
|
||||
// "downgrade": {
|
||||
// "available": false,
|
||||
// "reason": "no_available_downgrades"
|
||||
// },
|
||||
// "release": {
|
||||
// "channel": "stable"
|
||||
// },
|
||||
// "update_server": {
|
||||
// "address": "https://update-provider.cloud.emlid.com/api/client/v1/firmware-available"
|
||||
// },
|
||||
// "upgrade": {
|
||||
// "available": false,
|
||||
// "reason": "up_to_date",
|
||||
// "required": false
|
||||
// }
|
||||
// }
|
||||
|
||||
type Updater struct {
|
||||
Allowance Allowance `json:"allowance,omitempty"`
|
||||
Downgrade Downgrade `json:"downgrade,omitempty"`
|
||||
Release Release `json:"release,omitempty"`
|
||||
UpdateServer UpdateServer `json:"update_server,omitempty"`
|
||||
Upgrade Upgrade `json:"upgrade,omitempty"`
|
||||
}
|
||||
|
||||
type Allowance struct {
|
||||
Allowed bool `json:"allowed,omitempty"`
|
||||
Reason any `json:"reason,omitempty"`
|
||||
}
|
||||
|
||||
type Downgrade struct {
|
||||
Available bool `json:"available,omitempty"`
|
||||
Reason string `json:"reason,omitempty"`
|
||||
}
|
||||
|
||||
type Release struct {
|
||||
Channel string `json:"channel,omitempty"`
|
||||
}
|
||||
|
||||
type UpdateServer struct {
|
||||
Address string `json:"address,omitempty"`
|
||||
}
|
||||
|
||||
type Upgrade struct {
|
||||
Available bool `json:"available,omitempty"`
|
||||
Reason string `json:"reason,omitempty"`
|
||||
Required bool `json:"required,omitempty"`
|
||||
}
|
|
@ -0,0 +1,221 @@
|
|||
package v2
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/protocol"
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/protocol/v2/model"
|
||||
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/socketio"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
type Operations struct {
|
||||
addr string
|
||||
client *socketio.Client
|
||||
mutex sync.RWMutex
|
||||
}
|
||||
|
||||
// SetBase implements protocol.Operations.
|
||||
func (o *Operations) SetBase(ctx context.Context, funcs ...protocol.SetBaseOptionFunc) error {
|
||||
config, err := o.GetConfiguration(ctx)
|
||||
if err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
opts := protocol.NewSetBaseOptions(funcs...)
|
||||
|
||||
base := &model.Base{
|
||||
Accumulation: config.BaseMode.BaseCoordinates.Accumulation,
|
||||
AntennaOffset: config.BaseMode.BaseCoordinates.AntennaOffset,
|
||||
Coordinates: model.BaseCoordinates{
|
||||
Height: config.BaseMode.BaseCoordinates.Coordinates.Height,
|
||||
Latitude: config.BaseMode.BaseCoordinates.Coordinates.Latitude,
|
||||
Longitude: config.BaseMode.BaseCoordinates.Coordinates.Longitude,
|
||||
},
|
||||
Mode: config.BaseMode.BaseCoordinates.Mode,
|
||||
}
|
||||
|
||||
if opts.Mode != nil {
|
||||
base.Mode = *opts.Mode
|
||||
}
|
||||
|
||||
if opts.Height != nil {
|
||||
base.Coordinates.Height = *opts.Height
|
||||
}
|
||||
|
||||
if opts.Latitude != nil {
|
||||
base.Coordinates.Latitude = *opts.Latitude
|
||||
}
|
||||
|
||||
if opts.Longitude != nil {
|
||||
base.Coordinates.Longitude = *opts.Longitude
|
||||
}
|
||||
|
||||
if opts.AntennaOffset != nil {
|
||||
base.AntennaOffset = *opts.AntennaOffset
|
||||
}
|
||||
|
||||
if _, err := o.PostBaseCoordinates(ctx, base); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Configuration implements protocol.Operations.
|
||||
func (o *Operations) Configuration(ctx context.Context) (any, error) {
|
||||
config, err := o.GetConfiguration(ctx)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return config, nil
|
||||
}
|
||||
|
||||
// Alive implements protocol.Operations.
|
||||
func (o *Operations) Alive(ctx context.Context) (bool, error) {
|
||||
o.mutex.RLock()
|
||||
defer o.mutex.RUnlock()
|
||||
|
||||
return o.client.Alive(), nil
|
||||
}
|
||||
|
||||
// Version implements protocol.Operations.
|
||||
func (o *Operations) Version(ctx context.Context) (string, bool, error) {
|
||||
info, err := o.GetInfo(ctx)
|
||||
if err != nil {
|
||||
return "", false, errors.WithStack(err)
|
||||
}
|
||||
|
||||
updater, err := o.GetUpdater(ctx)
|
||||
if err != nil {
|
||||
return "", false, errors.WithStack(err)
|
||||
}
|
||||
|
||||
version := info.Reachview.Version
|
||||
stable := updater.Release.Channel == "stable"
|
||||
|
||||
return version, stable, nil
|
||||
}
|
||||
|
||||
// Close implements protocol.Operations.
|
||||
func (o *Operations) Close(ctx context.Context) error {
|
||||
o.mutex.Lock()
|
||||
defer o.mutex.Unlock()
|
||||
|
||||
if o.client == nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
o.client.Close()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Connect implements protocol.Operations.
|
||||
func (o *Operations) Connect(ctx context.Context) error {
|
||||
o.mutex.Lock()
|
||||
defer o.mutex.Unlock()
|
||||
|
||||
if o.client != nil {
|
||||
o.client.Close()
|
||||
}
|
||||
|
||||
endpoint, err := o.getSocketIOEndpoint()
|
||||
if err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
client := socketio.NewClient(endpoint)
|
||||
|
||||
if err := client.Connect(); err != nil {
|
||||
return errors.WithStack(err)
|
||||
}
|
||||
|
||||
o.client = client
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (o *Operations) getSocketIOEndpoint() (string, error) {
|
||||
host, rawPort, err := net.SplitHostPort(o.addr)
|
||||
if err != nil {
|
||||
var addrErr *net.AddrError
|
||||
if !errors.As(err, &addrErr) || !strings.Contains(addrErr.Error(), "missing port in address") {
|
||||
return "", errors.WithStack(err)
|
||||
}
|
||||
|
||||
host = o.addr
|
||||
}
|
||||
|
||||
port := int64(80)
|
||||
if rawPort != "" {
|
||||
port, err = strconv.ParseInt(rawPort, 10, 32)
|
||||
if err != nil {
|
||||
return "", errors.WithStack(err)
|
||||
}
|
||||
}
|
||||
|
||||
endpoint := socketio.Endpoint(host, int(port), false)
|
||||
|
||||
return endpoint, nil
|
||||
}
|
||||
|
||||
// Emit implements protocol.Operations.
|
||||
func (o *Operations) Emit(ctx context.Context, message any) error {
|
||||
o.mutex.RLock()
|
||||
defer o.mutex.RUnlock()
|
||||
|
||||
if o.client == nil || !o.client.Alive() {
|
||||
return errors.WithStack(protocol.ErrClosed)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// On implements protocol.Operations.
|
||||
func (o *Operations) On(ctx context.Context, event string) (chan any, error) {
|
||||
o.mutex.RLock()
|
||||
defer o.mutex.RUnlock()
|
||||
|
||||
if o.client == nil || !o.client.Alive() {
|
||||
return nil, errors.WithStack(protocol.ErrClosed)
|
||||
}
|
||||
|
||||
out := make(chan any)
|
||||
closer := new(sync.Once)
|
||||
|
||||
handler := func(ch *socketio.Channel, data any) {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
closer.Do(func() {
|
||||
o.mutex.RLock()
|
||||
defer o.mutex.RUnlock()
|
||||
|
||||
ch.Close()
|
||||
close(out)
|
||||
|
||||
if o.client == nil {
|
||||
return
|
||||
}
|
||||
})
|
||||
|
||||
return
|
||||
default:
|
||||
out <- data
|
||||
}
|
||||
}
|
||||
|
||||
if err := o.client.On(event, handler); err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
return out, nil
|
||||
}
|
||||
|
||||
var _ protocol.Operations = &Operations{}
|
|
@ -0,0 +1,31 @@
|
|||
package v2
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/protocol"
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/protocol/testsuite"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
func TestProtocolV2Operations(t *testing.T) {
|
||||
proto := &Protocol{}
|
||||
|
||||
factory := func(addr string) (protocol.Operations, error) {
|
||||
ctx := context.Background()
|
||||
|
||||
available, err := proto.Available(ctx, addr)
|
||||
if err != nil {
|
||||
return nil, errors.WithStack(err)
|
||||
}
|
||||
|
||||
if !available {
|
||||
return nil, errors.New("protocol is not available")
|
||||
}
|
||||
|
||||
return proto.Operations(addr), nil
|
||||
}
|
||||
|
||||
testsuite.TestOperations(t, factory)
|
||||
}
|
|
@ -0,0 +1,54 @@
|
|||
package v2
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach/client/protocol"
|
||||
"github.com/Masterminds/semver/v3"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
const Identifier protocol.Identifier = "v2"
|
||||
|
||||
const compatibleVersionConstraint = ">= 32"
|
||||
|
||||
type Protocol struct {
|
||||
}
|
||||
|
||||
// Available implements protocol.Protocol.
|
||||
func (p *Protocol) Available(ctx context.Context, addr string) (bool, error) {
|
||||
ops := p.Operations(addr).(*Operations)
|
||||
|
||||
info, err := ops.GetInfo(ctx)
|
||||
if err != nil {
|
||||
return false, errors.WithStack(err)
|
||||
}
|
||||
|
||||
versionConstraint, err := semver.NewConstraint(compatibleVersionConstraint)
|
||||
if err != nil {
|
||||
return false, errors.WithStack(err)
|
||||
}
|
||||
|
||||
version, err := semver.NewVersion(info.Reachview.Version)
|
||||
if err != nil {
|
||||
return false, errors.WithStack(err)
|
||||
}
|
||||
|
||||
if !versionConstraint.Check(version) {
|
||||
return false, errors.Errorf("reachview version '%s' does not match constraint '%s'", info.Reachview.Version, compatibleVersionConstraint)
|
||||
}
|
||||
|
||||
return true, nil
|
||||
}
|
||||
|
||||
// Identifier implements protocol.Protocol.
|
||||
func (p *Protocol) Identifier() protocol.Identifier {
|
||||
return Identifier
|
||||
}
|
||||
|
||||
// Operations implements protocol.Protocol.
|
||||
func (p *Protocol) Operations(addr string) protocol.Operations {
|
||||
return &Operations{addr: addr}
|
||||
}
|
||||
|
||||
var _ protocol.Protocol = &Protocol{}
|
|
@ -0,0 +1,131 @@
|
|||
package socketio
|
||||
|
||||
import (
|
||||
"sync"
|
||||
|
||||
gosocketio "forge.cadoles.com/Pyxis/golang-socketio"
|
||||
"forge.cadoles.com/Pyxis/golang-socketio/transport"
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
type Channel = gosocketio.Channel
|
||||
|
||||
type Client struct {
|
||||
conn *gosocketio.Client
|
||||
mutex sync.RWMutex
|
||||
endpoint string
|
||||
opts *Options
|
||||
}
|
||||
|
||||
func (c *Client) Connect() error {
|
||||
c.mutex.Lock()
|
||||
defer c.mutex.Unlock()
|
||||
|
||||
var err error
|
||||
var wg sync.WaitGroup
|
||||
|
||||
wg.Add(1)
|
||||
|
||||
transport := &transport.WebsocketTransport{
|
||||
PingInterval: c.opts.PingInterval,
|
||||
PingTimeout: c.opts.PingTimeout,
|
||||
ReceiveTimeout: c.opts.ReceiveTimeout,
|
||||
SendTimeout: c.opts.SendTimeout,
|
||||
BufferSize: c.opts.BufferSize,
|
||||
}
|
||||
|
||||
conn, err := gosocketio.Dial(c.endpoint, transport)
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "error while connecting to endpoint")
|
||||
}
|
||||
|
||||
c.conn = nil
|
||||
|
||||
cleanup := func() {
|
||||
conn.Off(gosocketio.OnError)
|
||||
conn.Off(gosocketio.OnConnection)
|
||||
}
|
||||
|
||||
err = conn.On(gosocketio.OnConnection, func(h *Channel) {
|
||||
cleanup()
|
||||
wg.Done()
|
||||
})
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "error while attaching to connection event")
|
||||
}
|
||||
|
||||
err = conn.On(gosocketio.OnError, func(h *Channel) {
|
||||
cleanup()
|
||||
err = errors.Errorf("an unknown error occured")
|
||||
wg.Done()
|
||||
})
|
||||
if err != nil {
|
||||
return errors.Wrap(err, "error while attaching to error event")
|
||||
}
|
||||
|
||||
wg.Wait()
|
||||
|
||||
c.conn = conn
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
func (c *Client) Close() {
|
||||
c.mutex.Lock()
|
||||
defer c.mutex.Unlock()
|
||||
|
||||
if c.conn == nil {
|
||||
return
|
||||
}
|
||||
c.conn.Close()
|
||||
c.conn = nil
|
||||
}
|
||||
|
||||
func (c *Client) Alive() bool {
|
||||
c.mutex.RLock()
|
||||
defer c.mutex.RUnlock()
|
||||
|
||||
if c.conn == nil {
|
||||
return false
|
||||
}
|
||||
|
||||
return c.conn.IsAlive()
|
||||
}
|
||||
|
||||
// Emit a new event with the given data
|
||||
func (c *Client) Emit(event string, data any) error {
|
||||
c.mutex.RLock()
|
||||
defer c.mutex.RUnlock()
|
||||
|
||||
if err := c.conn.Emit(event, data); err != nil {
|
||||
return errors.Wrapf(err, "error while emitting '%s' event", event)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
type Handler func(ch *Channel, data any)
|
||||
|
||||
// On binds and event handler to the given event
|
||||
func (c *Client) On(event string, handler Handler) error {
|
||||
c.mutex.RLock()
|
||||
defer c.mutex.RUnlock()
|
||||
|
||||
return c.conn.On(event, handler)
|
||||
}
|
||||
|
||||
// Off remove the handler bound to the given event
|
||||
func (c *Client) Off(event string) {
|
||||
c.mutex.RLock()
|
||||
defer c.mutex.RUnlock()
|
||||
|
||||
c.conn.Off(event)
|
||||
}
|
||||
|
||||
func NewClient(endpoint string, funcs ...OptionFunc) *Client {
|
||||
opts := NewOptions(funcs...)
|
||||
client := &Client{
|
||||
endpoint: endpoint,
|
||||
opts: opts,
|
||||
}
|
||||
return client
|
||||
}
|
|
@ -0,0 +1,9 @@
|
|||
package socketio
|
||||
|
||||
import (
|
||||
gosocketio "forge.cadoles.com/Pyxis/golang-socketio"
|
||||
)
|
||||
|
||||
func Endpoint(host string, port int, secure bool) string {
|
||||
return gosocketio.GetUrl(host, port, false)
|
||||
}
|
|
@ -0,0 +1,62 @@
|
|||
package socketio
|
||||
|
||||
import "time"
|
||||
|
||||
type Options struct {
|
||||
PingInterval time.Duration
|
||||
PingTimeout time.Duration
|
||||
ReceiveTimeout time.Duration
|
||||
SendTimeout time.Duration
|
||||
BufferSize int
|
||||
}
|
||||
|
||||
type OptionFunc func(opts *Options)
|
||||
|
||||
func NewOptions(funcs ...OptionFunc) *Options {
|
||||
opts := &Options{
|
||||
PingInterval: 30 * time.Second,
|
||||
PingTimeout: 60 * time.Second,
|
||||
ReceiveTimeout: 60 * time.Second,
|
||||
SendTimeout: 60 * time.Second,
|
||||
BufferSize: 1024 * 32,
|
||||
}
|
||||
for _, fn := range funcs {
|
||||
fn(opts)
|
||||
}
|
||||
return opts
|
||||
}
|
||||
|
||||
// WithPingInterval configures the client to use the given ping interval
|
||||
func WithPingInterval(interval time.Duration) OptionFunc {
|
||||
return func(opts *Options) {
|
||||
opts.PingInterval = interval
|
||||
}
|
||||
}
|
||||
|
||||
// WithPingTimeout configures the client to use the given ping timeout
|
||||
func WithPingTimeout(timeout time.Duration) OptionFunc {
|
||||
return func(opts *Options) {
|
||||
opts.PingTimeout = timeout
|
||||
}
|
||||
}
|
||||
|
||||
// WithReceiveTimeout configures the client to use the given receive timeout
|
||||
func WithReceiveTimeout(timeout time.Duration) OptionFunc {
|
||||
return func(opts *Options) {
|
||||
opts.ReceiveTimeout = timeout
|
||||
}
|
||||
}
|
||||
|
||||
// WithSendTimeout configures the client to use the given send timeout
|
||||
func WithSendTimeout(timeout time.Duration) OptionFunc {
|
||||
return func(opts *Options) {
|
||||
opts.SendTimeout = timeout
|
||||
}
|
||||
}
|
||||
|
||||
// WithBufferSize configures the client to use the given buffer size
|
||||
func WithBufferSize(size int) OptionFunc {
|
||||
return func(opts *Options) {
|
||||
opts.BufferSize = size
|
||||
}
|
||||
}
|
|
@ -0,0 +1,56 @@
|
|||
package discovery
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net"
|
||||
"sync"
|
||||
|
||||
"github.com/grandcat/zeroconf"
|
||||
)
|
||||
|
||||
// Service is a ReachRS service discovered via MDNS-SD
|
||||
type Service struct {
|
||||
Name string
|
||||
AddrV4 *net.IP
|
||||
Port int
|
||||
}
|
||||
|
||||
// Discover tries to discover ReachRS services on the local network via mDNS-SD
|
||||
func Discover(ctx context.Context) ([]Service, error) {
|
||||
var wg sync.WaitGroup
|
||||
|
||||
wg.Add(1)
|
||||
|
||||
resolver, err := zeroconf.NewResolver()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
services := make([]Service, 0)
|
||||
entries := make(chan *zeroconf.ServiceEntry)
|
||||
|
||||
go func() {
|
||||
for e := range entries {
|
||||
var addr *net.IP
|
||||
if len(e.AddrIPv4) > 0 {
|
||||
addr = &e.AddrIPv4[0]
|
||||
}
|
||||
srv := Service{
|
||||
Name: e.Instance,
|
||||
AddrV4: addr,
|
||||
Port: e.Port,
|
||||
}
|
||||
services = append(services, srv)
|
||||
}
|
||||
wg.Done()
|
||||
}()
|
||||
|
||||
if err = resolver.Browse(ctx, "_reach._tcp", ".local", entries); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
wg.Wait()
|
||||
|
||||
return services, nil
|
||||
|
||||
}
|
|
@ -0,0 +1,53 @@
|
|||
package discovery
|
||||
|
||||
import (
|
||||
"context"
|
||||
"regexp"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"forge.cadoles.com/cadoles/go-emlid/reach"
|
||||
)
|
||||
|
||||
func TestDiscovery(t *testing.T) {
|
||||
reach.AssertIntegrationTests(t)
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||
defer cancel()
|
||||
|
||||
services, err := Discover(ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if g, e := len(services), 1; g < e {
|
||||
t.Fatalf("len(services): got '%d', expected > %d", g, e)
|
||||
}
|
||||
|
||||
t.Logf("Found %d services", len(services))
|
||||
|
||||
patterns := []string{"reach", "Reach", "^RS.*"}
|
||||
|
||||
for i, s := range services {
|
||||
t.Logf("Service #%d: %s - %s:%d", i, s.Name, s.AddrV4.String(), s.Port)
|
||||
|
||||
matched := false
|
||||
|
||||
for _, p := range patterns {
|
||||
re, err := regexp.Compile(p)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if re.Match([]byte(s.Name)) {
|
||||
matched = true
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if !matched {
|
||||
t.Errorf("services[%d].Name ('%s') to match on of '%v'", i, s.Name, patterns)
|
||||
}
|
||||
}
|
||||
|
||||
}
|
|
@ -0,0 +1,30 @@
|
|||
package reach
|
||||
|
||||
import (
|
||||
"os"
|
||||
"strconv"
|
||||
"testing"
|
||||
|
||||
"github.com/pkg/errors"
|
||||
)
|
||||
|
||||
const skipIntegrationTestsEnv = "SKIP_INTEGRATION_TESTS"
|
||||
|
||||
func AssertIntegrationTests(t *testing.T) {
|
||||
rawSkipIntegrationTests := os.Getenv(skipIntegrationTestsEnv)
|
||||
if rawSkipIntegrationTests == "" {
|
||||
rawSkipIntegrationTests = "false"
|
||||
}
|
||||
|
||||
skipIntegrationTests, err := strconv.ParseBool(rawSkipIntegrationTests)
|
||||
if err != nil {
|
||||
t.Logf("[WARN] could not parse environment variable '%s': %+v", skipIntegrationTestsEnv, errors.WithStack(err))
|
||||
skipIntegrationTests = false
|
||||
}
|
||||
|
||||
if !skipIntegrationTests {
|
||||
return
|
||||
}
|
||||
|
||||
t.Skipf("Integration tests skipped. To enable, set environment variable %s=false", skipIntegrationTestsEnv)
|
||||
}
|
Loading…
Reference in New Issue