From 6545b633d4f6e31e08c8ac7b8e9391cd3504c80d Mon Sep 17 00:00:00 2001 From: Brendan <2bndy5@gmail.com> Date: Sun, 29 Mar 2020 14:50:34 -0700 Subject: [PATCH] re-prioritized arg order for relativeModeConfig() --- README.rst | 6 +++--- circuitpython_cirque_pinnacle/glidepoint.py | 4 ++-- circuitpython_cirque_pinnacle/glidepoint_lite.py | 4 ++-- docs/api.rst | 12 ++++++------ 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index 37d37ef..a841912 100644 --- a/README.rst +++ b/README.rst @@ -98,10 +98,10 @@ Model Labeling Scheme .. [i] stands for the hardwired interface protocol (3 = I2C, 4 = SPI). Notice, if there is a resistor populated at the R1 (470K ohm) junction (located just above the Pinnacle ASIC), it is configured for SPI, otherwise it is configured for I2C. - .. [cc] stands for Custom Configuration (if a 470K ohm resistor is populated at junction R4). - "30" (with a resistor at R4) means that the hardware is configured to disable + .. [cc] stands for Custom Configuration which describes if a 470K ohm resistor is populated at + junction R4. "30" (resistor at R4 exists) means that the hardware is configured to disable certain features despite what this library does. "00" (no resistor at R4) means that the - hardware is configured to allow certain features to manipulated by this library. These + hardware is configured to allow certain features to be manipulated by this library. These features include "secondary tap" (thought of as "right mouse button" in relative data mode), Intellimouse scrolling (Microsoft patented scroll wheel behavior -- a throw back to when scroll wheels were first introduced), and 180 degree orientation (your application can invert diff --git a/circuitpython_cirque_pinnacle/glidepoint.py b/circuitpython_cirque_pinnacle/glidepoint.py index a6f7553..3b3cd2c 100644 --- a/circuitpython_cirque_pinnacle/glidepoint.py +++ b/circuitpython_cirque_pinnacle/glidepoint.py @@ -99,8 +99,8 @@ def hard_configured(self): customized hardware configuration.""" return bool(self._rap_read(0x1f)) - def relative_mode_config(self, rotate90=False, glide_extend=True, - secondary_tap=True, taps=False, intellimouse=False): + def relative_mode_config(self, rotate90=False, taps=False, secondary_tap=True, + glide_extend=True, intellimouse=False): """Configure settings specific to Relative mode (AKA Mouse mode) data reporting.""" if self.data_mode == RELATIVE: config2 = rotate90 << 7 | (not glide_extend) << 4 | ( diff --git a/circuitpython_cirque_pinnacle/glidepoint_lite.py b/circuitpython_cirque_pinnacle/glidepoint_lite.py index 0393c9f..ec1406f 100644 --- a/circuitpython_cirque_pinnacle/glidepoint_lite.py +++ b/circuitpython_cirque_pinnacle/glidepoint_lite.py @@ -50,8 +50,8 @@ def data_mode(self, mode): def hard_configured(self): return bool(self._rap_read(0x1f)) - def relative_mode_config(self, rotate90=False, glide_extend=True, - secondary_tap=True, taps=False, intellimouse=False): + def relative_mode_config(self, rotate90=False, taps=False, secondary_tap=True, + glide_extend=True, intellimouse=False): config2 = rotate90 << 7 | (not glide_extend) << 4 | ( not secondary_tap) << 2 | (not taps) << 1 | intellimouse self._rap_write(5, config2) diff --git a/docs/api.rst b/docs/api.rst index 7738d60..c5d4615 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -223,15 +223,15 @@ relative_mode_config() :param bool rotate90: Specifies if the axis data is altered for 90 degree rotation before reporting it (essentially swaps the axis data). Default is `False`. - :param bool glide_extend: A patended feature that allows the user to glide their finger off - the edge of the sensor and continue gesture with the touch event. Default is `True`. - This feature is only available if `hard_configured` is `False`. - :param bool secondary_tap: Specifies if tapping in the top-left corner (depending on - orientation) triggers the secondary button data. Defaults to `True`. This feature is - only available if `hard_configured` is `False`. :param bool taps: Specifies if all taps should be reported (`True`) or not (`False`). Default is `True`. This affects ``secondary_tap`` option as well. The primary button (left mouse button) is emulated with a tap. + :param bool secondary_tap: Specifies if tapping in the top-left corner (depending on + orientation) triggers the secondary button data. Defaults to `True`. This feature is + only available if `hard_configured` is `False`. + :param bool glide_extend: A patended feature that allows the user to glide their finger off + the edge of the sensor and continue gesture with the touch event. Default is `True`. + This feature is only available if `hard_configured` is `False`. :param bool intellimouse: Specifies if the data reported includes a byte about scroll data. Default is `False`. Because this flag is specific to scroll data, this feature is only available if `hard_configured` is `False`.