Skip to content

Commit

Permalink
some docs tweaks from porting to arduino
Browse files Browse the repository at this point in the history
  • Loading branch information
2bndy5 committed Mar 29, 2020
1 parent 1405251 commit 7159fff
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
7 changes: 4 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,16 @@ Supported Features
Pinnacle (1CA027), thus this is a rather experimental mode.
* Hardware input buttons' states included in data reports. There are 3 button input lines on
the Cirque circle trackpads -- see `Pinout`_ section.
* Ability to identify finger & stylus or only stylus or only finger touch events. The Cirque circle
trackpads are natively capable of measuring only 1 touch point per event.
* Configure measurements for finger or stylus (or automatically detirmine either) touch
events. The Cirque circle trackpads are natively capable of measuring only 1 touch
point per event.
* Download/upload the underlying compensation matrix for ADC measurements.
* Adjust the ADC matrix gain (sensitivity).

.. tip:: The SPI protocol is the preferred method for interfacing with more than 1 Cirque circle
trackpad from the same MCU (microcontroller). The Cirque Pinnacle does not allow
changing the I2C slave device address (via software); this means only 1 Cirque circle trackpad
can be accessed over the I2C bus at a time.
can be accessed over the I2C bus in the lifecycle of an application.

Unsupported Features
--------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ About the lite version
----------------------

This library includes a "lite" version of the module ``glidepoint.py`` titled ``glidepoint_lite.py``.
The lite version is limited to only Relative and Absolute data modes. It has been developed to
The lite version is limited to only Relative and Absolute data modes. It has been developed to
save space on microcontrollers with limited amount of RAM and/or storage (like boards using the
ATSAMD21 M0). The following functionality has been removed from the lite version:

Expand Down Expand Up @@ -514,7 +514,7 @@ anymeas_mode_config()

.. tip:: Be aware that allowing the Pinnacle to enter sleep mode after taking
measurements will slow consecutive calls to `measure_adc()` as the Pinnacle
requires about 100 milliseconds to wake up.
requires about 300 milliseconds to wake up.

measure_adc()
^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 7159fff

Please sign in to comment.