Skip to content

Commit

Permalink
re-prioritized arg order for relativeModeConfig()
Browse files Browse the repository at this point in the history
  • Loading branch information
2bndy5 committed Mar 29, 2020
1 parent 7159fff commit 6545b63
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions circuitpython_cirque_pinnacle/glidepoint.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 | (
Expand Down
4 changes: 2 additions & 2 deletions circuitpython_cirque_pinnacle/glidepoint_lite.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
12 changes: 6 additions & 6 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down

0 comments on commit 6545b63

Please sign in to comment.