Merge remote-tracking branch 'upstream/master' into develop

converter/adb_usb/Makefile

@@ -79,13 +79,29 @@ ACTIONMAP_ENABLE ?= no          # Use 16bit actionmap instead of 8bit keymap
 KEYMAP_SECTION_ENABLE ?= yes	# fixed address keymap for keymap editor
 
 # ADB Mice need acceleration for todays much bigger screens. 
-ADB_MOUSE_MAXACC ?= 8
+ADB_MOUSE_MAXACC ?= 1
 OPT_DEFS += -DADB_MOUSE_MAXACC=$(ADB_MOUSE_MAXACC)
 
+# Enable scroll wheel functionality using the y-axis of the mouse
+# Hold the assigned button down to scroll using the mouse
+#
+# Example:
+#  Kensington Turbo Mouse 5
+#                      ________
+#     middle click -> |3  __  4| <- scroll toggle (browser back when disabled)
+#                     |  /  \  |
+#                     |  \__/  |
+#       left click -> |1      2| <- right click
+#                     |________|
+#
+ADB_MOUSE_SCROLL_BUTTON ?= 0	# Assign the button (1-8) (0 to disable)
+ADB_MOUSE_SCROLL_SPEED ?= 10	# 1 (fastest) to 127 (slowest)
 
 # Optimize size but this may cause error "relocation truncated to fit"
 #EXTRALDFLAGS = -Wl,--relax
 
+OPT_DEFS += -DADB_MOUSE_SCROLL_BUTTON=$(ADB_MOUSE_SCROLL_BUTTON)
+OPT_DEFS += -DADB_MOUSE_SCROLL_SPEED=$(ADB_MOUSE_SCROLL_SPEED)
 
 #
 # Keymap file

converter/adb_usb/README.md

@@ -1,29 +1,30 @@
 ADB to USB keyboard converter
 =============================
-This firmware converts Apple ADB keyboard/mouse protocol to USB, you can use it to plug old ADB keyboard/mouse into modern computer. It works on prebuilt TMK ADB-USB Converter or generic dev board with USB AVR MCU(ATMega32U4/2) like Teensy2.0.
+This firmware converts Apple ADB keyboard/mouse protocol to USB and you can use old ADB keyboard/mouse on modern computer. It works on TMK ADB-USB converter or AVR microcontroller(ATMega32U4/2).
 
-Discuss about this here: http://geekhack.org/showwiki.php?title=Island:14290
+Discussion and info: https://geekhack.org/index.php?topic=14290.0
 
-Prebuilt TMK ADB-USB converter is available here: https://geekhack.org/index.php?topic=72052.0
+TMK ADB-USB converter: https://geekhack.org/index.php?topic=72052.0
 
 
 
-README FIRST
-------------
-https://github.com/tmk/tmk_keyboard
-https://github.com/tmk/tmk_keyboard/tree/master/converter/adb_usb
+Infos
+-----
+Wiki: https://github.com/tmk/tmk_keyboard/wiki
 
-Also check these when you are in trouble.
+ADB protocol: https://github.com/tmk/tmk_keyboard/wiki/Apple-Desktop-Bus
+
+Issues: https://github.com/tmk/tmk_keyboard/issues?q=is%3Aissue+ADB
+
+Firmware Code: https://github.com/tmk/tmk_keyboard/tree/master/converter/adb_usb
 
-https://github.com/tmk/tmk_keyboard/wiki
-https://github.com/tmk/tmk_keyboard/issues
 
 
 Wiring
 ------
-If you build this yourself you have to solder some wires.
-Connect ADB pins to controller just by 3 lines(Vcc, GND, Data) at least. By default Data line uses port PD0.
-This is not needed but you can connect PSW to PD1 optionally.
+Connect DATA, VCC and GND to microcontroller. Use port **PD0** for DATA. PSW is not used.
+
+You can change the port with `ADB_PORT`, `ADB_PIN`, `ADB_DDR`, `ADB_DATA_BIT` in `config.h`.
 
 ADB female socket from the front:
 
@@ -33,10 +34,11 @@ ADB female socket from the front:
      -  ===  -      3: VCC
       `-___-'       4: GND
 
-This converter uses AVR's internal pull-up, but it seems to be too weak, in particular when you want to use a long or coiled cable. The external pull-up resistor(1K-10K Ohm) on Data is strongly recommended.(It is almost must!)
-https://github.com/tmk/tmk_keyboard/wiki/FAQ#pull-up-resistor
 
-Pull-up resister:
+### Pull-up resister:
+The external **1k Ohm** pull-up resistor on DATA is **required**.
+
+AVR microcontroller's internal pull-up is too weak for ADB in particular when you want to use a long coiled cable or daisy-chain devices. 
 
     Keyboard       AVR MCU
                    ,------.
@@ -48,18 +50,14 @@ Pull-up resister:
                    |      |
     GND------------|GND   |
                    `------'
-    R: 1K Ohm resistor
-
+    R: 1k Ohm resistor
 
-Define following macros for ADB connection in config.h if you use other than port PD0.
+https://github.com/tmk/tmk_keyboard/wiki/Apple-Desktop-Bus#pull-up-resistor
 
-    ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT
 
 
 Build firmware and Program microcontroller
 ------------------------------------------
-See [doc/build.md](../../tmk_core/doc/build.md).
-
 To build firmware and program TMK ADB-USB Converter run these commands:
 
     $ make -f Makefile clean
@@ -70,50 +68,50 @@ You can select keymap name with optional `KEYMAP=` ('plain' is default name). Pu
 
 Use **Makefile.rev1** for old TMK Converter rev.1 and Teensy2.0 instead of **Makefile**.
 
+https://github.com/tmk/tmk_keyboard/wiki#build-firmware
 
 
-Keymap
-------
-You can change keymap by editing code of unimap_plain.c directly, or copy it to your own keymap file like unimap_yourname.c and edit the file.
-How to define the keymap is probably obvious. You can find key symbols in common/keycode.h. And see [doc/keymap.md](../../tmk_core/doc/keymap.md) for more detail.
-
 
-Magic command
--------------
-To get help message in hid_listen press `h` holding Magic key. Magic key is `Power key`.
+Debug
+-----
+Use hid_listen command line tool to see debug outputs.
 
 https://github.com/tmk/tmk_keyboard/wiki#debug
 
 
-Locking CapsLock
-----------------
-Many of old ADB keyboards have mechanical push-lock switch for Capslock key and this converter supports the locking Capslock key by default. Use keycode `LCAP` instead of `CAPS` in your keymap in short. See README in top directory for more detail.
-https://github.com/tmk/tmk_keyboard/blob/master/README.md#mechanical-locking-support
-
-If you want to remap Capslock key you will have to remove locking pin or just replace with normal momentary switch. Some keyboards like Apple Adujstable keyboard use firmware-base locking with momentary switch for Capslock and remapping it won't be useful in most cases.
-
 
 Notes for keyboard
 ------------------
-Not-extended ADB keyboards have no discrimination between right modifier and left one,
-you will always see left control even if you press right control key.
-Apple Extended Keyboard and Apple Extended Keyboard II can discriminate both side
-modifiers except for GUI key(Windows/Command).
+Apple Standard keyboard(M0116) can't discriminate between right and left modifiers
+while Apple Extended keyboard(M0115/M3501) can discriminate them except for Command key.
 
-And most of ADB keyboards have no diodes in its matrix so they are not NKRO unfortunately,
-though ADB protocol itself supports it. See tmk_core/protocol/adb.c for more info.
 
 
 Notes for mouse
 ---------------
-ADB mouse support was added by @mek-apelsin on Apr,2015.
-https://github.com/tmk/tmk_keyboard/pull/207
+All one-button mouses should be supported and others will work as one-button mouse even if not supported.
+
+Mouse protocols(handler ID) below are curretnly supported.
+
+- Apple Classic Mouse protocol (1, 2)
+- Apple Extended Mouse protocol (4)
+- Kensington Turbo Mouse 5 #64210 and Thinking Mouse (0x32)
+- Macally 2-button Mouse (0x42)
+- Logitech MouseMan/TrackMan Proprietary protocol (0x4C*)
+- Logitech MouseMan/TrackMan Extended protocol (0x4D*)
+- Micrspeed MacTrac (0x2F, 0x5F) - Not confirmed
+- Contour Design Countour Mouse (0x66) - Not confirmed
+- Mouse Systems A3 Mouse/Trackball (0x03) - Not confirmed
+- CH Products Tracball Pro/DT225 (0x42) - Not confirmed
 
-All one-button mouses should be supported.
+https://github.com/tmk/tmk_keyboard/wiki/Apple-Desktop-Bus#mouse
 
-As of 2019 June, the converter can handle multi-button mice and trackball up to eight buttons if the pointing device supports Apple Extended Mouse protocol. But some devices use their own specific protocol unfortunately and they will work as one-button mouse unless device specific code is added.
 
-Kensington Turbo Mouse 5(#64210) is supported now.
-https://github.com/tmk/tmk_keyboard/issues/274#issuecomment-504726633
 
-EOF
+Locking CapsLock
+----------------
+Many of old ADB keyboards have mechanical push-lock switch for Capslock and some like Apple Adujstable keyboard use firmware-base locking with momentary switch for Capslock.
+
+The converter supports the locking Capslock key. Use keycode `LCAP` instead of `CAPS` in your keymap.
+
+https://github.com/tmk/tmk_keyboard/wiki/FAQ-Keymap#mechanical-lock-switch-support