mirror of
https://github.com/Indy970/QtHPConnect
synced 2024-12-25 21:59:15 +01:00
Clean up
This commit is contained in:
Indy970
parent
fad7201a6b
commit
1ec0a071e6
7 changed files with 12 additions and 672 deletions
7
AUTHORS
Normal file
7
AUTHORS
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
QtHpConnect
|
||||||
|
======
|
||||||
|
Ian Gebbie <igebbie970@gmail.com>
|
||||||
|
|
||||||
|
Code patterns and snippets borrowed from libhpcalcs:
|
||||||
|
Lionel Debroux <lionel_debroux@yahoo.fr>
|
||||||
|
|
||||||
|
|
@ -129,14 +129,13 @@ RESOURCES += \
|
||||||
qthpconnect.qrc
|
qthpconnect.qrc
|
||||||
|
|
||||||
DISTFILES += \
|
DISTFILES += \
|
||||||
libhpcalcs/NEWS \
|
|
||||||
libhpcalcs/AUTHORS \
|
|
||||||
libhpcalcs/ChangeLog \
|
|
||||||
libhpcalcs/COPYING \
|
|
||||||
libhpcalcs/README \
|
|
||||||
../build-QtHPConnect-Desktop-Debug/hpinterface.log \
|
../build-QtHPConnect-Desktop-Debug/hpinterface.log \
|
||||||
model.qmodel \
|
model.qmodel \
|
||||||
README.md
|
README.md \
|
||||||
|
LICENSE \
|
||||||
|
CHANGELOG.md \
|
||||||
|
NEWS \
|
||||||
|
AUTHORS
|
||||||
../hplp-master/libhpcalcs/tests/test_hpcalcs.c
|
../hplp-master/libhpcalcs/tests/test_hpcalcs.c
|
||||||
|
|
||||||
unix|win32: LIBS += -lhidapi-libusb
|
unix|win32: LIBS += -lhidapi-libusb
|
||||||
|
|
|
||||||
|
|
@ -1,8 +0,0 @@
|
||||||
hplibs
|
|
||||||
======
|
|
||||||
Lionel Debroux <lionel_debroux@yahoo.fr>
|
|
||||||
|
|
||||||
Code patterns and snippets borrowed from libti*/tilp:
|
|
||||||
Romain Liévin <roms@lievin.net>
|
|
||||||
Benjamin Moody <benjamin.moody@gmail.com>
|
|
||||||
... and other contributors listed in the AUTHORS files of libti* & tilp.
|
|
||||||
|
|
@ -1,340 +0,0 @@
|
||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 2, June 1991
|
|
||||||
|
|
||||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
|
||||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The licenses for most software are designed to take away your
|
|
||||||
freedom to share and change it. By contrast, the GNU General Public
|
|
||||||
License is intended to guarantee your freedom to share and change free
|
|
||||||
software--to make sure the software is free for all its users. This
|
|
||||||
General Public License applies to most of the Free Software
|
|
||||||
Foundation's software and to any other program whose authors commit to
|
|
||||||
using it. (Some other Free Software Foundation software is covered by
|
|
||||||
the GNU Lesser General Public License instead.) You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
this service if you wish), that you receive source code or can get it
|
|
||||||
if you want it, that you can change the software or use pieces of it
|
|
||||||
in new free programs; and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to make restrictions that forbid
|
|
||||||
anyone to deny you these rights or to ask you to surrender the rights.
|
|
||||||
These restrictions translate to certain responsibilities for you if you
|
|
||||||
distribute copies of the software, or if you modify it.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must give the recipients all the rights that
|
|
||||||
you have. You must make sure that they, too, receive or can get the
|
|
||||||
source code. And you must show them these terms so they know their
|
|
||||||
rights.
|
|
||||||
|
|
||||||
We protect your rights with two steps: (1) copyright the software, and
|
|
||||||
(2) offer you this license which gives you legal permission to copy,
|
|
||||||
distribute and/or modify the software.
|
|
||||||
|
|
||||||
Also, for each author's protection and ours, we want to make certain
|
|
||||||
that everyone understands that there is no warranty for this free
|
|
||||||
software. If the software is modified by someone else and passed on, we
|
|
||||||
want its recipients to know that what they have is not the original, so
|
|
||||||
that any problems introduced by others will not reflect on the original
|
|
||||||
authors' reputations.
|
|
||||||
|
|
||||||
Finally, any free program is threatened constantly by software
|
|
||||||
patents. We wish to avoid the danger that redistributors of a free
|
|
||||||
program will individually obtain patent licenses, in effect making the
|
|
||||||
program proprietary. To prevent this, we have made it clear that any
|
|
||||||
patent must be licensed for everyone's free use or not licensed at all.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
|
||||||
|
|
||||||
0. This License applies to any program or other work which contains
|
|
||||||
a notice placed by the copyright holder saying it may be distributed
|
|
||||||
under the terms of this General Public License. The "Program", below,
|
|
||||||
refers to any such program or work, and a "work based on the Program"
|
|
||||||
means either the Program or any derivative work under copyright law:
|
|
||||||
that is to say, a work containing the Program or a portion of it,
|
|
||||||
either verbatim or with modifications and/or translated into another
|
|
||||||
language. (Hereinafter, translation is included without limitation in
|
|
||||||
the term "modification".) Each licensee is addressed as "you".
|
|
||||||
|
|
||||||
Activities other than copying, distribution and modification are not
|
|
||||||
covered by this License; they are outside its scope. The act of
|
|
||||||
running the Program is not restricted, and the output from the Program
|
|
||||||
is covered only if its contents constitute a work based on the
|
|
||||||
Program (independent of having been made by running the Program).
|
|
||||||
Whether that is true depends on what the Program does.
|
|
||||||
|
|
||||||
1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the
|
|
||||||
notices that refer to this License and to the absence of any warranty;
|
|
||||||
and give any other recipients of the Program a copy of this License
|
|
||||||
along with the Program.
|
|
||||||
|
|
||||||
You may charge a fee for the physical act of transferring a copy, and
|
|
||||||
you may at your option offer warranty protection in exchange for a fee.
|
|
||||||
|
|
||||||
2. You may modify your copy or copies of the Program or any portion
|
|
||||||
of it, thus forming a work based on the Program, and copy and
|
|
||||||
distribute such modifications or work under the terms of Section 1
|
|
||||||
above, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) You must cause the modified files to carry prominent notices
|
|
||||||
stating that you changed the files and the date of any change.
|
|
||||||
|
|
||||||
b) You must cause any work that you distribute or publish, that in
|
|
||||||
whole or in part contains or is derived from the Program or any
|
|
||||||
part thereof, to be licensed as a whole at no charge to all third
|
|
||||||
parties under the terms of this License.
|
|
||||||
|
|
||||||
c) If the modified program normally reads commands interactively
|
|
||||||
when run, you must cause it, when started running for such
|
|
||||||
interactive use in the most ordinary way, to print or display an
|
|
||||||
announcement including an appropriate copyright notice and a
|
|
||||||
notice that there is no warranty (or else, saying that you provide
|
|
||||||
a warranty) and that users may redistribute the program under
|
|
||||||
these conditions, and telling the user how to view a copy of this
|
|
||||||
License. (Exception: if the Program itself is interactive but
|
|
||||||
does not normally print such an announcement, your work based on
|
|
||||||
the Program is not required to print an announcement.)
|
|
||||||
|
|
||||||
These requirements apply to the modified work as a whole. If
|
|
||||||
identifiable sections of that work are not derived from the Program,
|
|
||||||
and can be reasonably considered independent and separate works in
|
|
||||||
themselves, then this License, and its terms, do not apply to those
|
|
||||||
sections when you distribute them as separate works. But when you
|
|
||||||
distribute the same sections as part of a whole which is a work based
|
|
||||||
on the Program, the distribution of the whole must be on the terms of
|
|
||||||
this License, whose permissions for other licensees extend to the
|
|
||||||
entire whole, and thus to each and every part regardless of who wrote it.
|
|
||||||
|
|
||||||
Thus, it is not the intent of this section to claim rights or contest
|
|
||||||
your rights to work written entirely by you; rather, the intent is to
|
|
||||||
exercise the right to control the distribution of derivative or
|
|
||||||
collective works based on the Program.
|
|
||||||
|
|
||||||
In addition, mere aggregation of another work not based on the Program
|
|
||||||
with the Program (or with a work based on the Program) on a volume of
|
|
||||||
a storage or distribution medium does not bring the other work under
|
|
||||||
the scope of this License.
|
|
||||||
|
|
||||||
3. You may copy and distribute the Program (or a work based on it,
|
|
||||||
under Section 2) in object code or executable form under the terms of
|
|
||||||
Sections 1 and 2 above provided that you also do one of the following:
|
|
||||||
|
|
||||||
a) Accompany it with the complete corresponding machine-readable
|
|
||||||
source code, which must be distributed under the terms of Sections
|
|
||||||
1 and 2 above on a medium customarily used for software interchange; or,
|
|
||||||
|
|
||||||
b) Accompany it with a written offer, valid for at least three
|
|
||||||
years, to give any third party, for a charge no more than your
|
|
||||||
cost of physically performing source distribution, a complete
|
|
||||||
machine-readable copy of the corresponding source code, to be
|
|
||||||
distributed under the terms of Sections 1 and 2 above on a medium
|
|
||||||
customarily used for software interchange; or,
|
|
||||||
|
|
||||||
c) Accompany it with the information you received as to the offer
|
|
||||||
to distribute corresponding source code. (This alternative is
|
|
||||||
allowed only for noncommercial distribution and only if you
|
|
||||||
received the program in object code or executable form with such
|
|
||||||
an offer, in accord with Subsection b above.)
|
|
||||||
|
|
||||||
The source code for a work means the preferred form of the work for
|
|
||||||
making modifications to it. For an executable work, complete source
|
|
||||||
code means all the source code for all modules it contains, plus any
|
|
||||||
associated interface definition files, plus the scripts used to
|
|
||||||
control compilation and installation of the executable. However, as a
|
|
||||||
special exception, the source code distributed need not include
|
|
||||||
anything that is normally distributed (in either source or binary
|
|
||||||
form) with the major components (compiler, kernel, and so on) of the
|
|
||||||
operating system on which the executable runs, unless that component
|
|
||||||
itself accompanies the executable.
|
|
||||||
|
|
||||||
If distribution of executable or object code is made by offering
|
|
||||||
access to copy from a designated place, then offering equivalent
|
|
||||||
access to copy the source code from the same place counts as
|
|
||||||
distribution of the source code, even though third parties are not
|
|
||||||
compelled to copy the source along with the object code.
|
|
||||||
|
|
||||||
4. You may not copy, modify, sublicense, or distribute the Program
|
|
||||||
except as expressly provided under this License. Any attempt
|
|
||||||
otherwise to copy, modify, sublicense or distribute the Program is
|
|
||||||
void, and will automatically terminate your rights under this License.
|
|
||||||
However, parties who have received copies, or rights, from you under
|
|
||||||
this License will not have their licenses terminated so long as such
|
|
||||||
parties remain in full compliance.
|
|
||||||
|
|
||||||
5. You are not required to accept this License, since you have not
|
|
||||||
signed it. However, nothing else grants you permission to modify or
|
|
||||||
distribute the Program or its derivative works. These actions are
|
|
||||||
prohibited by law if you do not accept this License. Therefore, by
|
|
||||||
modifying or distributing the Program (or any work based on the
|
|
||||||
Program), you indicate your acceptance of this License to do so, and
|
|
||||||
all its terms and conditions for copying, distributing or modifying
|
|
||||||
the Program or works based on it.
|
|
||||||
|
|
||||||
6. Each time you redistribute the Program (or any work based on the
|
|
||||||
Program), the recipient automatically receives a license from the
|
|
||||||
original licensor to copy, distribute or modify the Program subject to
|
|
||||||
these terms and conditions. You may not impose any further
|
|
||||||
restrictions on the recipients' exercise of the rights granted herein.
|
|
||||||
You are not responsible for enforcing compliance by third parties to
|
|
||||||
this License.
|
|
||||||
|
|
||||||
7. If, as a consequence of a court judgment or allegation of patent
|
|
||||||
infringement or for any other reason (not limited to patent issues),
|
|
||||||
conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot
|
|
||||||
distribute so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you
|
|
||||||
may not distribute the Program at all. For example, if a patent
|
|
||||||
license would not permit royalty-free redistribution of the Program by
|
|
||||||
all those who receive copies directly or indirectly through you, then
|
|
||||||
the only way you could satisfy both it and this License would be to
|
|
||||||
refrain entirely from distribution of the Program.
|
|
||||||
|
|
||||||
If any portion of this section is held invalid or unenforceable under
|
|
||||||
any particular circumstance, the balance of the section is intended to
|
|
||||||
apply and the section as a whole is intended to apply in other
|
|
||||||
circumstances.
|
|
||||||
|
|
||||||
It is not the purpose of this section to induce you to infringe any
|
|
||||||
patents or other property right claims or to contest validity of any
|
|
||||||
such claims; this section has the sole purpose of protecting the
|
|
||||||
integrity of the free software distribution system, which is
|
|
||||||
implemented by public license practices. Many people have made
|
|
||||||
generous contributions to the wide range of software distributed
|
|
||||||
through that system in reliance on consistent application of that
|
|
||||||
system; it is up to the author/donor to decide if he or she is willing
|
|
||||||
to distribute software through any other system and a licensee cannot
|
|
||||||
impose that choice.
|
|
||||||
|
|
||||||
This section is intended to make thoroughly clear what is believed to
|
|
||||||
be a consequence of the rest of this License.
|
|
||||||
|
|
||||||
8. If the distribution and/or use of the Program is restricted in
|
|
||||||
certain countries either by patents or by copyrighted interfaces, the
|
|
||||||
original copyright holder who places the Program under this License
|
|
||||||
may add an explicit geographical distribution limitation excluding
|
|
||||||
those countries, so that distribution is permitted only in or among
|
|
||||||
countries not thus excluded. In such case, this License incorporates
|
|
||||||
the limitation as if written in the body of this License.
|
|
||||||
|
|
||||||
9. The Free Software Foundation may publish revised and/or new versions
|
|
||||||
of the 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 a version number of this License which applies to it and "any
|
|
||||||
later version", you have the option of following the terms and conditions
|
|
||||||
either of that version or of any later version published by the Free
|
|
||||||
Software Foundation. If the Program does not specify a version number of
|
|
||||||
this License, you may choose any version ever published by the Free Software
|
|
||||||
Foundation.
|
|
||||||
|
|
||||||
10. If you wish to incorporate parts of the Program into other free
|
|
||||||
programs whose distribution conditions are different, write to the author
|
|
||||||
to ask for permission. For software which is copyrighted by the Free
|
|
||||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
|
||||||
make exceptions for this. Our decision will be guided by the two goals
|
|
||||||
of preserving the free status of all derivatives of our free software and
|
|
||||||
of promoting the sharing and reuse of software generally.
|
|
||||||
|
|
||||||
NO WARRANTY
|
|
||||||
|
|
||||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
|
|
||||||
|
|
||||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
|
||||||
REDISTRIBUTE THE 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.
|
|
||||||
|
|
||||||
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
|
|
||||||
convey the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software; you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation; either version 2 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program; if not, write to the Free Software
|
|
||||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
||||||
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program is interactive, make it output a short notice like this
|
|
||||||
when it starts in an interactive mode:
|
|
||||||
|
|
||||||
Gnomovision version 69, Copyright (C) year name of author
|
|
||||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, the commands you use may
|
|
||||||
be called something other than `show w' and `show c'; they could even be
|
|
||||||
mouse-clicks or menu items--whatever suits your program.
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or your
|
|
||||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
|
||||||
necessary. Here is a sample; alter the names:
|
|
||||||
|
|
||||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
|
||||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
|
||||||
|
|
||||||
<signature of Ty Coon>, 1 April 1989
|
|
||||||
Ty Coon, President of Vice
|
|
||||||
|
|
||||||
This General Public License does not permit incorporating your program into
|
|
||||||
proprietary programs. If your program is a subroutine library, you may
|
|
||||||
consider it more useful to permit linking proprietary applications with the
|
|
||||||
library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License.
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
Log of changes (libhpcalcs):
|
|
||||||
|
|
||||||
- Initial version.
|
|
||||||
|
|
@ -1,315 +0,0 @@
|
||||||
hplp: code for communicating with recent HP calculators
|
|
||||||
=======================================================
|
|
||||||
|
|
||||||
hplp (still entirely in libhpcalcs for now) is the beginning of a toolkit for
|
|
||||||
two-way communications with HP Prime calculators.
|
|
||||||
|
|
||||||
See below for detailed build instructions. Note that
|
|
||||||
the install_hplp.sh script provided alongside this README
|
|
||||||
( https://raw.github.com/debrouxl/hplp/master/install_hplp.sh )
|
|
||||||
automates part of the build process.
|
|
||||||
|
|
||||||
|
|
||||||
Status (2014/06/03)
|
|
||||||
-------------------
|
|
||||||
The code base does:
|
|
||||||
* work on Windows, Linux and MacOS X;
|
|
||||||
* support communication with a single Prime calculator connected to the
|
|
||||||
computer. The communication is known to work with the following firmware
|
|
||||||
versions, but might not work with other older or newer versions, if HP
|
|
||||||
performs backwards-incompatible changes in the protocol (like TI does):
|
|
||||||
* "SDKV0.30" firmware version from mid-August 2013;
|
|
||||||
* "SDKV0.32" build 5447 firmware version from late November 2013;
|
|
||||||
* partial success with the V0.031.6030 / V0.032.6030 build 6030 firmware
|
|
||||||
versions published late May 2013.
|
|
||||||
* implement 10 operations (without _known_ bugs):
|
|
||||||
* ready check;
|
|
||||||
* get calculator information;
|
|
||||||
* set date and time;
|
|
||||||
* receive screenshot;
|
|
||||||
* send file (for now, the leading metadata of *.hpprgm, if any, needs to be
|
|
||||||
stripped manually);
|
|
||||||
* receive file;
|
|
||||||
* receive backup;
|
|
||||||
* send key(s) (remote control);
|
|
||||||
* send chat;
|
|
||||||
* receive chat;
|
|
||||||
* provide a terminal-based UI: the test program "test_hpcalcs".
|
|
||||||
|
|
||||||
The code base doesn't:
|
|
||||||
* perform color conversion on PNG screenshots (libhpcalcs should use libpng to
|
|
||||||
uncompress the files, mangle pixels, and recompress to PNG);
|
|
||||||
* provide a user-friendly GUI for the above, but a GUI can definitely build
|
|
||||||
upon the library easily enough;
|
|
||||||
* implement _proper_ conversion from UTF-16 LE to other charsets on its own:
|
|
||||||
that's a task for libicu, Qt or other libraries.
|
|
||||||
|
|
||||||
|
|
||||||
Goals
|
|
||||||
-----
|
|
||||||
Laying the groundwork for GUIs dealing with two-way communication with HP
|
|
||||||
Prime calculators, and possibly 39gII (Prime and 39gII are similar), using
|
|
||||||
USB HID class, and possibly later fake MSD for firmware upgrades.
|
|
||||||
|
|
||||||
|
|
||||||
Non-goals
|
|
||||||
---------
|
|
||||||
As far as I'm concerned, working _by myself_ on:
|
|
||||||
* duplicating / replacing code targeting older, non-USB HID-based HP
|
|
||||||
calculators;
|
|
||||||
* a GUI comparable to HP's Connectivity Kit. However, other people should
|
|
||||||
obviously do it, in order to make the software much more usable !
|
|
||||||
|
|
||||||
|
|
||||||
Build process summary
|
|
||||||
---------------------
|
|
||||||
As mentioned above, the repository contains an script for automating the
|
|
||||||
part of the build strictly related to libhpcalcs / hplp: install_hplp.sh .
|
|
||||||
|
|
||||||
The build process is that of pretty much any autotools-based piece of
|
|
||||||
software:
|
|
||||||
$ autoreconf -i -f
|
|
||||||
$ ./configure
|
|
||||||
$ ./make check
|
|
||||||
# make install
|
|
||||||
|
|
||||||
The terminal-based test program is in tests/test_hpcalcs.
|
|
||||||
|
|
||||||
For now, the main external dependency of libhpcalcs is HIDAPI:
|
|
||||||
https://github.com/signal11/hidapi.git
|
|
||||||
Unless your Linux distro packages it (few do), you need to compile and
|
|
||||||
install it yourself (it is also an autotools-based project: configure,
|
|
||||||
make, make install).
|
|
||||||
|
|
||||||
|
|
||||||
Detailed build & configuration process for Debian, Ubuntu, Mint and derivatives
|
|
||||||
(courtesy of Jonathan Cameron)
|
|
||||||
-------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
1. Install build dependencies (packages required for building libhpcalcs).
|
|
||||||
As root (with root shell, or sudo)
|
|
||||||
# (sudo) apt-get install build-essential git autoconf automake autopoint libtool gettext xdg-utils libpng-dev libudev-dev libusb-1.0-0-dev autotools-dev
|
|
||||||
|
|
||||||
2. Install hidapi:
|
|
||||||
|
|
||||||
$ mkdir -p $HOME/lpg # or anywhere else you see fit
|
|
||||||
$ cd $HOME/lpg
|
|
||||||
$ git clone https://github.com/signal11/hidapi.git hidapi
|
|
||||||
$ cd hidapi
|
|
||||||
|
|
||||||
Follow the directions from the README.txt file:
|
|
||||||
|
|
||||||
$ ./bootstrap
|
|
||||||
$ ./configure --prefix=/usr
|
|
||||||
$ make
|
|
||||||
|
|
||||||
As root (with root shell, or sudo):
|
|
||||||
# (sudo) make install <----- as root, or using sudo
|
|
||||||
|
|
||||||
3. Install libhpcalcs
|
|
||||||
|
|
||||||
Download
|
|
||||||
https://raw.github.com/debrouxl/hplp/master/install_hplp.sh
|
|
||||||
and copy it to, for instance, $HOME/hplp
|
|
||||||
|
|
||||||
$ cd $HOME/lpg
|
|
||||||
$ chmod +x install_hplp.sh
|
|
||||||
# (sudo) ./install_hplp.sh
|
|
||||||
|
|
||||||
4. Test hplp
|
|
||||||
|
|
||||||
As root, verify that you can run test_hpcalcs.
|
|
||||||
Plug in your HP Prime to the computer and turn it on.
|
|
||||||
Wait about 10 seconds and then run:
|
|
||||||
|
|
||||||
$ $HOME/lpg/hplp/libhpcalcs/tests/test_hpcalcs
|
|
||||||
|
|
||||||
You should see the menu of possible operations.
|
|
||||||
If you do, hplp is working and you are successfully communicating with your Prime.
|
|
||||||
|
|
||||||
5. Set up for normal users to access the Prime with the test software.
|
|
||||||
|
|
||||||
a. If you are on your own isolated computer (e.g, laptop),
|
|
||||||
then add the following udev rules to the new file
|
|
||||||
/etc/udev/rules.d/82-hp-prime.rules :
|
|
||||||
|
|
||||||
# HP Prime Calculator
|
|
||||||
SUBSYSTEM=="usb", ATTRS{idVendor}=="03f0", ATTRS{idProduct}=="0441", MODE="0666"
|
|
||||||
KERNEL=="hidraw*", ATTRS{idVendor}=="03f0", ATTRS{idProduct}=="0441", MODE="0666"
|
|
||||||
|
|
||||||
Note that anyone on your system will be able to access your Prime with
|
|
||||||
the hplp software.
|
|
||||||
|
|
||||||
If you are on a shared system and you want to avoid anyone accessing the
|
|
||||||
device but you, do this instead:
|
|
||||||
|
|
||||||
# HP Prime Calculator
|
|
||||||
SUBSYSTEM=="usb", ATTRS{idVendor}=="03f0", ATTRS{idProduct}=="0441", ACTION=="add", GROUP="dialout", MODE="0664"
|
|
||||||
KERNEL=="hidraw*", ATTRS{idVendor}=="03f0", ATTRS{idProduct}=="0441", ACTION=="add", GROUP="dialout", MODE="0664"
|
|
||||||
|
|
||||||
and add yourself to the 'dialout' group. You may need to switch to
|
|
||||||
the new group for this to work (eg: newgrp dialout).
|
|
||||||
|
|
||||||
To activate the new udev rule, turn off your HP Prime, turn it back on,
|
|
||||||
and wait for about 10 seconds. Then, check the permissions for the device
|
|
||||||
(in /dev/hidraw? and /dev/usb/hiddev?).
|
|
||||||
|
|
||||||
|
|
||||||
NOTES:
|
|
||||||
* technically, compilation doesn't require being root, only the 'make install'
|
|
||||||
commands for hidapi and libhpcalcs (embedded into install_hplp.sh) require
|
|
||||||
root (and even then, only if installing to /usr or some root-only location).
|
|
||||||
install_hplp.sh cannot use sudo on its own, as it's not necessarily
|
|
||||||
configured by default.
|
|
||||||
* in the above directions, the source location to be $HOME/lpg. You may prefer
|
|
||||||
some other location, just replace $HOME/lpg by your location.
|
|
||||||
* the install prefix is forced to /usr, so that you don't have to adjust the
|
|
||||||
LD_LIBRARY_PATH environment variable, or add a line in /etc/ld.so.conf, or
|
|
||||||
add a file in /etc/ld.so.conf.d.
|
|
||||||
The install prefix is controlled by using the --prefix option to configure,
|
|
||||||
for hidapi and within install_hplp.sh.
|
|
||||||
|
|
||||||
|
|
||||||
Technical notes
|
|
||||||
---------------
|
|
||||||
The code leverages HIDAPI, and it was strongly inspired by the time-proven
|
|
||||||
concepts and APIs of the libti* family, which I (Lionel Debroux) am the
|
|
||||||
current maintainer of.
|
|
||||||
The GPL'ed libti* family ( https://github.com/debrouxl/tilibs ) forms the
|
|
||||||
back-end for TILP, TIEmu, TilEm and titools (mainly), and contains the only
|
|
||||||
third-party portable FLOSS code with two-way communication support for all
|
|
||||||
three series of TI-Z80, TI-68k and TI-Nspire graphing calculators.
|
|
||||||
Putting together framework strongly inspired by libti* clearly took some work,
|
|
||||||
but having such a foundation saves time in the longer term. IOW, it's worth
|
|
||||||
the apparent complexity.
|
|
||||||
|
|
||||||
Obviously, until the calculator's protocol is better documented, the API
|
|
||||||
will change in backwards-incompatible manners (for instance, the output
|
|
||||||
parameters of check ready and get infos operations).
|
|
||||||
|
|
||||||
|
|
||||||
TODO list
|
|
||||||
---------
|
|
||||||
* ... hopefully attract _code_ contributors who have more free time than I do;
|
|
||||||
* a GUI, but I won't be the one doing it.
|
|
||||||
Nowadays, Qt is the main choice for a portable, good-looking, fast UI
|
|
||||||
toolkit (for native code programs). GTK+ used to be a better choice wrt.
|
|
||||||
portability, but that was years ago, and in 2013-2015, a number of
|
|
||||||
applications and desktop environments are switching from GTK+ to Qt.
|
|
||||||
UIs based on Web technologies are another option, Qt provides support for
|
|
||||||
those (QtWebkit / QtWebEngine) as well.
|
|
||||||
* strip out leading program metadata, if any, from .hpprgm files, like the
|
|
||||||
UTF-16LE BOM is already stripped.
|
|
||||||
Implementation notes:
|
|
||||||
* in a loop, attempt to read 4 bytes containing size, and seek forward of
|
|
||||||
that many bytes. If this leads the offset beyond EOF, break out.
|
|
||||||
* add some form of packet parsing + validation API, which can be used for
|
|
||||||
both internal sanity checking and packet dissection;
|
|
||||||
* add 39gII support, probably, as the Prime is similar to the 39gII. That's
|
|
||||||
where the usefulness of the cables / calcs separation and cables generic
|
|
||||||
API will become most obvious.
|
|
||||||
Implementation notes:
|
|
||||||
* move the upper layer from prime_cmd into a new file called by both
|
|
||||||
prime_cmd and the new file (like e.g. dusb_cmd in libticalcs).
|
|
||||||
* the 39gII has 00 00 CRC.
|
|
||||||
* modify the way recv_backup works for more reliability.
|
|
||||||
Implementation notes:
|
|
||||||
* recv_backup should attempt to receive as much data as the calculator sends,
|
|
||||||
and then split the received data. The main heuristic would be to assume
|
|
||||||
that some packets were lost, and traverse backwards the contents of the
|
|
||||||
current file to find a (00) F7 01 xx xx xx xx packet ? While this could
|
|
||||||
fail in some circumstances, it should usually salvage more data.
|
|
||||||
* recv_file shall probably be refactored as well;
|
|
||||||
* Marcus Von Cube reported that when receiving a backup fails, the test
|
|
||||||
program crashes:
|
|
||||||
"
|
|
||||||
hpcalcs INFO: prime_send_data: send remaining failed
|
|
||||||
hpcalcs ERROR: calc_prime_recv_backup: s_recv_backup failed
|
|
||||||
hpcalcs ERROR: hpcalcs_calc_recv_backup: recv_backup failed
|
|
||||||
hpfiles INFO: Displaying var entry 83EC8B55
|
|
||||||
hpfiles INFO: Name:
|
|
||||||
"
|
|
||||||
* implement screenshot color conversion, with libpng;
|
|
||||||
* add progress feedback functionality, improved from libti*: the libti*
|
|
||||||
implementation is too complex.
|
|
||||||
Implementation notes:
|
|
||||||
* can information for current chunk of the transfer + information for the
|
|
||||||
transfer as a whole be passed through arguments of a single callback.
|
|
||||||
* add port number functionality, known from libticables, in the API. That
|
|
||||||
will enable passthrough mode for communication between real and/or
|
|
||||||
emulated calculators;
|
|
||||||
* fill in torture test;
|
|
||||||
* add two APIs for dynamically building NULL-terminated const char * arrays
|
|
||||||
from the two first columns of typesprime.c::PRIME_CONST.
|
|
||||||
* somehow gain better knowledge of the protocol, so as to be able to...
|
|
||||||
* ... add more operations and data structures.
|
|
||||||
* add dissectors and session logs, improved from libticables.
|
|
||||||
Design goals:
|
|
||||||
* make it possible to trace packet flow direction;
|
|
||||||
* make it possible to validate (sanity check) packets , to begin with...
|
|
||||||
Implementation notes:
|
|
||||||
* new APIs for registering and unregistering (multiple) callbacks;
|
|
||||||
* call the registered callbacks upon packet send and packet receive;
|
|
||||||
* leverage the packet parsing / validation code.
|
|
||||||
* add support for Prime in fake MSD mode, for firmware upgrades ? I've
|
|
||||||
already partially analyzed the protocol and published my notes at
|
|
||||||
http://tiplanet.org/hpwiki/index.php?title=HP_Prime/Linking_Protocol
|
|
||||||
but I'm not really confident about it ;)
|
|
||||||
Need to find a library for MSD. libusb does not recommend using it
|
|
||||||
in MSD mode.
|
|
||||||
* certainly more... at least, if users and programmers think the software
|
|
||||||
fits a purpose :-)
|
|
||||||
|
|
||||||
|
|
||||||
License
|
|
||||||
-------
|
|
||||||
Copyright (C) 2013-2015 Lionel Debroux
|
|
||||||
|
|
||||||
This program is free software; you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation; either version 2 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program; if not, write to the Free Software Foundation,
|
|
||||||
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
|
|
||||||
|
|
||||||
Changelog
|
|
||||||
---------
|
|
||||||
2013/11/03 - 2013/12/30: improve logging, create install_hplp.sh, improve
|
|
||||||
error passing, fix bugs reported by more beta-testers, add more operations.
|
|
||||||
2013/10/22 - 2013/11/03: Created autotools-based project and test client;
|
|
||||||
vastly expand the code, to the point it becomes releasable (if not really
|
|
||||||
usable). First public announcement (limited scope).
|
|
||||||
2013/10/21: Split into multiple files, but still piggybacking hidtest.cpp.
|
|
||||||
2013/10/20: First public PoC.
|
|
||||||
2013/10/19: Project started.
|
|
||||||
|
|
||||||
|
|
||||||
Credits (demoscene style)
|
|
||||||
-------------------------
|
|
||||||
* _many_ thanks to Xavier "critor" Andréani for testing many program versions
|
|
||||||
on his real Prime and providing many USB packet dumps (which I analyzed
|
|
||||||
with Wireshark) and terminal output sessions;
|
|
||||||
* many thanks to Marcus Von Cube for providing USB packet dumps for the 39gII,
|
|
||||||
which show that it's quite similar to the Prime;
|
|
||||||
* thanks to Jonathan Cameron for writing a more detailed build procedure for
|
|
||||||
Debian and derivatives;
|
|
||||||
* thanks to other beta-testers who reported bugs on TI-Planet and MoHPC:
|
|
||||||
* with the Prime: persalteas (Linux), wawachief (Linux & MacOS X), DJ
|
|
||||||
Omnimaga (Windows), Adriweb (MacOS X & Windows), Jonathan Cameron (Linux),
|
|
||||||
Cristian Arezzini (Linux), LarsF (MacOS X), Egan Ford (MacOS X);
|
|
||||||
* with the 39gII: Marcus Von Cube;
|
|
||||||
* greetings to the other TI-Planet ( http://tiplanet.org/ ) admins;
|
|
||||||
* greetings to the HP Prime developer team at HP: some of its members spend
|
|
||||||
time attending user message boards and interacting with users and programmers,
|
|
||||||
even in communities traditionally interested in TI calcs (Omnimaga, Cemetech,
|
|
||||||
TI-Planet), which is a win-win move for both HP and its users;
|
|
||||||
* fuck TI EdTech management imposing a closed-minded, lose-lose stance on the
|
|
||||||
Nspire platform, despite repeated community input since 2007.
|
|
||||||
Loading…
Reference in a new issue