This is the same Keyboardio-MouseKeys that lived in core KeyboardioFirmware up until this point. It has been lifted out, the same GPL-2 license file added, along with a README, and the URL in library.properties has been updated. Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>pull/365/head
commit
675cbc6cb6
@ -0,0 +1,339 @@
|
|||||||
|
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.
|
@ -0,0 +1,5 @@
|
|||||||
|
# Keyboardio-MouseKeys
|
||||||
|
|
||||||
|
This is a plugin for [KeyboardioFirmware][fw], that adds support for mouse keys.
|
||||||
|
|
||||||
|
[fw]: https://github.com/keyboardio/KeyboardioFirmware
|
@ -0,0 +1,10 @@
|
|||||||
|
name=Keyboardio-MouseKeys
|
||||||
|
version=0.0.1
|
||||||
|
author=Jesse Vincent
|
||||||
|
maintainer=Jesse Vincent <jesse@keyboard.io>
|
||||||
|
sentence=Mouse keys for Keyboardio boards.
|
||||||
|
paragraph=...
|
||||||
|
category=Communication
|
||||||
|
url=https://github.com/keyboardio/Keyboardio-MouseKeys
|
||||||
|
architectures=avr
|
||||||
|
dot_a_linkage=true
|
@ -0,0 +1,68 @@
|
|||||||
|
#include <Arduino.h>
|
||||||
|
|
||||||
|
#include "Keyboardio-MouseKeys.h"
|
||||||
|
#include "MouseWrapper.h"
|
||||||
|
#include "KeyboardioFirmware.h"
|
||||||
|
|
||||||
|
static void handle_mouse_key_event(Key mappedKey, uint8_t keyState) {
|
||||||
|
if (key_toggled_off(keyState)) {
|
||||||
|
if (mappedKey.keyCode & KEY_MOUSE_UP || mappedKey.keyCode & KEY_MOUSE_DOWN) {
|
||||||
|
MouseWrapper.mouseActiveForCyclesY=0;
|
||||||
|
}
|
||||||
|
if (mappedKey.keyCode & KEY_MOUSE_LEFT || mappedKey.keyCode & KEY_MOUSE_RIGHT) {
|
||||||
|
MouseWrapper.mouseActiveForCyclesX=0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!key_is_pressed(keyState))
|
||||||
|
return;
|
||||||
|
|
||||||
|
if (mappedKey.keyCode & KEY_MOUSE_UP) {
|
||||||
|
MouseWrapper.move(0,-1);
|
||||||
|
} else if (mappedKey.keyCode & KEY_MOUSE_DOWN) {
|
||||||
|
MouseWrapper.move(0,1);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (mappedKey.keyCode & KEY_MOUSE_LEFT) {
|
||||||
|
MouseWrapper.move(-1,0);
|
||||||
|
} else if (mappedKey.keyCode & KEY_MOUSE_RIGHT) {
|
||||||
|
MouseWrapper.move(1,0);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
static Key handleMouseKeys(Key mappedKey, byte row, byte col, uint8_t keyState) {
|
||||||
|
if (mappedKey.flags != (SYNTHETIC | IS_MOUSE_KEY))
|
||||||
|
return mappedKey;
|
||||||
|
|
||||||
|
if (mappedKey.keyCode & KEY_MOUSE_BUTTON) {
|
||||||
|
uint8_t button = mappedKey.keyCode & ~KEY_MOUSE_BUTTON;
|
||||||
|
|
||||||
|
if (key_toggled_on(keyState)) {
|
||||||
|
MouseWrapper.press_button(button);
|
||||||
|
} else if (key_toggled_off(keyState)) {
|
||||||
|
MouseWrapper.release_button(button);
|
||||||
|
}
|
||||||
|
} else if (!(mappedKey.keyCode & KEY_MOUSE_WARP)) {
|
||||||
|
handle_mouse_key_event(mappedKey, keyState);
|
||||||
|
} else if (key_toggled_on(keyState)) {
|
||||||
|
if (mappedKey.keyCode & KEY_MOUSE_WARP && mappedKey.flags & IS_MOUSE_KEY) {
|
||||||
|
// we don't pass in the left and up values because those are the
|
||||||
|
// default, "no-op" conditionals
|
||||||
|
MouseWrapper.warp( ((mappedKey.keyCode & KEY_MOUSE_WARP_END) ? WARP_END : 0x00) |
|
||||||
|
((mappedKey.keyCode & KEY_MOUSE_DOWN) ? WARP_DOWN : 0x00) |
|
||||||
|
((mappedKey.keyCode & KEY_MOUSE_RIGHT) ? WARP_RIGHT : 0x00) );
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return Key_NoKey;
|
||||||
|
}
|
||||||
|
|
||||||
|
MouseKeys_::MouseKeys_(void) {
|
||||||
|
}
|
||||||
|
|
||||||
|
void
|
||||||
|
MouseKeys_::begin (void) {
|
||||||
|
event_handler_hook_add (handleMouseKeys);
|
||||||
|
}
|
||||||
|
|
||||||
|
MouseKeys_ MouseKeys;
|
@ -0,0 +1,13 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include "KeyboardioFirmware.h"
|
||||||
|
#include "MouseKeyDefs.h"
|
||||||
|
|
||||||
|
class MouseKeys_ : public KeyboardioPlugin {
|
||||||
|
public:
|
||||||
|
MouseKeys_ (void);
|
||||||
|
|
||||||
|
virtual void begin(void) final;
|
||||||
|
};
|
||||||
|
|
||||||
|
extern MouseKeys_ MouseKeys;
|
@ -0,0 +1,41 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#define IS_MOUSE_KEY B00010000
|
||||||
|
|
||||||
|
// Synthetic, not internal
|
||||||
|
#define KEY_MOUSE_BTN_L 0x01 // Synthetic key
|
||||||
|
#define KEY_MOUSE_BTN_M 0x02 // Synthetic key
|
||||||
|
#define KEY_MOUSE_BTN_R 0x03 // Synthetic key
|
||||||
|
|
||||||
|
|
||||||
|
#define KEY_MOUSE_UP B0000001
|
||||||
|
#define KEY_MOUSE_DOWN B0000010
|
||||||
|
#define KEY_MOUSE_LEFT B0000100
|
||||||
|
#define KEY_MOUSE_RIGHT B0001000
|
||||||
|
#define KEY_MOUSE_BUTTON B0010000
|
||||||
|
#define KEY_MOUSE_WARP B0100000
|
||||||
|
#define KEY_MOUSE_WARP_END B1000000
|
||||||
|
|
||||||
|
|
||||||
|
#define Key_mouseWarpNW (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_WARP| KEY_MOUSE_UP | KEY_MOUSE_LEFT }
|
||||||
|
#define Key_mouseWarpNE (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_WARP| KEY_MOUSE_UP | KEY_MOUSE_RIGHT }
|
||||||
|
#define Key_mouseWarpSW (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_WARP| KEY_MOUSE_DOWN | KEY_MOUSE_LEFT }
|
||||||
|
#define Key_mouseWarpSE (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_WARP| KEY_MOUSE_DOWN | KEY_MOUSE_RIGHT }
|
||||||
|
#define Key_mouseWarpEnd (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_WARP| KEY_MOUSE_WARP_END}
|
||||||
|
|
||||||
|
|
||||||
|
#define Key_mouseUpL (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_UP | KEY_MOUSE_LEFT }
|
||||||
|
#define Key_mouseUp (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_UP }
|
||||||
|
#define Key_mouseUpR (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_UP | KEY_MOUSE_RIGHT }
|
||||||
|
#define Key_mouseL (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_LEFT }
|
||||||
|
#define Key_mouseR (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_RIGHT }
|
||||||
|
#define Key_mouseDnL (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_DOWN | KEY_MOUSE_LEFT }
|
||||||
|
#define Key_mouseDn (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_DOWN }
|
||||||
|
#define Key_mouseDnR (Key){ KEY_FLAGS|SYNTHETIC|IS_MOUSE_KEY, KEY_MOUSE_DOWN | KEY_MOUSE_RIGHT }
|
||||||
|
#define Key_mouseScrollUp
|
||||||
|
#define Key_mouseScrollDn
|
||||||
|
#define Key_mouseScrollL
|
||||||
|
#define Key_mouseScrollR
|
||||||
|
#define Key_mouseBtnL (Key){ KEY_FLAGS | SYNTHETIC | IS_MOUSE_KEY, KEY_MOUSE_BUTTON | KEY_MOUSE_BTN_L }
|
||||||
|
#define Key_mouseBtnM (Key){ KEY_FLAGS | SYNTHETIC | IS_MOUSE_KEY, KEY_MOUSE_BUTTON | KEY_MOUSE_BTN_M }
|
||||||
|
#define Key_mouseBtnR (Key){ KEY_FLAGS | SYNTHETIC | IS_MOUSE_KEY, KEY_MOUSE_BUTTON | KEY_MOUSE_BTN_R }
|
@ -0,0 +1,120 @@
|
|||||||
|
|
||||||
|
// Mouse-related methods
|
||||||
|
//
|
||||||
|
//
|
||||||
|
#include "MouseWrapper.h"
|
||||||
|
|
||||||
|
|
||||||
|
MouseWrapper_::MouseWrapper_(void) {
|
||||||
|
Mouse.begin();
|
||||||
|
AbsoluteMouse.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
void MouseWrapper_::press_button(uint8_t button) {
|
||||||
|
Mouse.press(button);
|
||||||
|
end_warping();
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
void MouseWrapper_::release_button(uint8_t button) {
|
||||||
|
Mouse.release(button);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
void MouseWrapper_::warp_jump(uint16_t left, uint16_t top, uint16_t height, uint16_t width) {
|
||||||
|
uint16_t x_center = left + width/2;
|
||||||
|
uint16_t y_center = top + height/2;
|
||||||
|
AbsoluteMouse.moveTo(x_center,y_center);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
void MouseWrapper_::begin_warping() {
|
||||||
|
section_left = WARP_ABS_LEFT;
|
||||||
|
section_top = WARP_ABS_TOP;
|
||||||
|
next_width = MAX_WARP_WIDTH;
|
||||||
|
next_height = MAX_WARP_HEIGHT;
|
||||||
|
is_warping = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
void MouseWrapper_::end_warping() {
|
||||||
|
is_warping= false;
|
||||||
|
}
|
||||||
|
|
||||||
|
void MouseWrapper_::warp(uint8_t warp_cmd) {
|
||||||
|
if (is_warping == false) {
|
||||||
|
begin_warping();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
if ( warp_cmd & WARP_END) {
|
||||||
|
end_warping();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
next_width = next_width / 2;
|
||||||
|
next_height = next_height/2;
|
||||||
|
|
||||||
|
if (warp_cmd & WARP_UP) {
|
||||||
|
// Serial.print(" - up ");
|
||||||
|
} else if (warp_cmd & WARP_DOWN) {
|
||||||
|
// Serial.print(" - down ");
|
||||||
|
section_top = section_top + next_height;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (warp_cmd & WARP_LEFT) {
|
||||||
|
// Serial.print(" - left ");
|
||||||
|
} else if (warp_cmd & WARP_RIGHT) {
|
||||||
|
// Serial.print(" - right ");
|
||||||
|
section_left = section_left + next_width;
|
||||||
|
}
|
||||||
|
|
||||||
|
warp_jump(section_left, section_top, next_height,next_width);
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// cubic wave function based on code from FastLED
|
||||||
|
uint8_t MouseWrapper_::acceleration(uint8_t cycles) {
|
||||||
|
uint8_t i = cycles;
|
||||||
|
|
||||||
|
if( i & 0x80) {
|
||||||
|
i = 255 - i;
|
||||||
|
}
|
||||||
|
|
||||||
|
i = i << 1;
|
||||||
|
|
||||||
|
uint8_t ii = (i*i) >> 8;
|
||||||
|
uint8_t iii = (ii*i) >> 8;
|
||||||
|
|
||||||
|
i = (( (3 * (uint16_t)(ii)) - ( 2 * (uint16_t)(iii))) / 2) + ACCELERATION_FLOOR;
|
||||||
|
|
||||||
|
if ( i > ACCELERATION_CEIL) {
|
||||||
|
i = ACCELERATION_CEIL;
|
||||||
|
}
|
||||||
|
return i;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
void MouseWrapper_::move( int8_t x, int8_t y) {
|
||||||
|
int16_t moveX =0;
|
||||||
|
int16_t moveY = 0;
|
||||||
|
if (x != 0 ) {
|
||||||
|
if (mouseActiveForCyclesX < 255) { mouseActiveForCyclesX++;}
|
||||||
|
moveX = (x * acceleration(mouseActiveForCyclesX));
|
||||||
|
}
|
||||||
|
if (y != 0) {
|
||||||
|
if (mouseActiveForCyclesY < 255) { mouseActiveForCyclesY++;}
|
||||||
|
moveY = (y * acceleration(mouseActiveForCyclesY));
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
end_warping();
|
||||||
|
Mouse.move(moveX, moveY, 0);
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
MouseWrapper_ MouseWrapper;
|
@ -0,0 +1,56 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include "Arduino.h"
|
||||||
|
#include "KeyboardioHID.h"
|
||||||
|
|
||||||
|
// Warping commands
|
||||||
|
|
||||||
|
#define WARP_END 1
|
||||||
|
#define WARP_UP 2
|
||||||
|
#define WARP_DOWN 4
|
||||||
|
#define WARP_LEFT 8
|
||||||
|
#define WARP_RIGHT 16
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// apparently, the mac discards 15% of the value space for mouse movement.
|
||||||
|
// need to test this on other platforms
|
||||||
|
|
||||||
|
#define MAX_WARP_WIDTH 32767
|
||||||
|
#define MAX_WARP_HEIGHT 32767
|
||||||
|
|
||||||
|
#define WARP_ABS_TOP 0
|
||||||
|
#define WARP_ABS_LEFT 0
|
||||||
|
|
||||||
|
// Mouse acceleration
|
||||||
|
|
||||||
|
// we want the whole s curve, not just the bit
|
||||||
|
// that's usually above the x and y axes;
|
||||||
|
#define ACCELERATION_FLOOR 2
|
||||||
|
#define ACCELERATION_CEIL 50
|
||||||
|
|
||||||
|
|
||||||
|
class MouseWrapper_ {
|
||||||
|
public:
|
||||||
|
MouseWrapper_(void);
|
||||||
|
void move( int8_t x, int8_t y);
|
||||||
|
void warp(uint8_t warp_cmd);
|
||||||
|
void press_button(uint8_t button);
|
||||||
|
void release_button(uint8_t button);
|
||||||
|
uint8_t mouseActiveForCyclesX = 0;
|
||||||
|
uint8_t mouseActiveForCyclesY = 0;
|
||||||
|
|
||||||
|
private:
|
||||||
|
uint16_t next_width = 0;
|
||||||
|
uint16_t next_height = 0;
|
||||||
|
uint16_t section_top = 0;
|
||||||
|
uint16_t section_left = 0;
|
||||||
|
boolean is_warping = false;
|
||||||
|
|
||||||
|
uint8_t acceleration (uint8_t cycles);
|
||||||
|
void begin_warping();
|
||||||
|
void end_warping();
|
||||||
|
void warp_jump(uint16_t left, uint16_t top, uint16_t height, uint16_t width);
|
||||||
|
|
||||||
|
};
|
||||||
|
extern MouseWrapper_ MouseWrapper;
|
Loading…
Reference in new issue