Skip to content

Commit

Permalink
found the HCO resistor; ammended docs
Browse files Browse the repository at this point in the history
  • Loading branch information
2bndy5 committed Mar 19, 2020
1 parent bef0a3c commit 0d8f335
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 18 deletions.
15 changes: 8 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,14 @@ 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. "30" means that the hardware is configured to disable
certain features despite what this library does. "00" means that the hardware is configured
to allow certain features to 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 the axis
data anyway).
.. [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
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
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
the axis data anyway).
.. [o] stands for the overlay type (0 = none, 1 = adhesive, 2 = flat, 3 = curved)
Dependencies
Expand Down
6 changes: 5 additions & 1 deletion circuitpython_cirque_pinnacle.py
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,11 @@ def data_mode(self, mode):
def hard_configured(self):
"""This `bool` attribute provides insight to applications about factory
customized hardware configuration. see note about product labeling in
`Model Labeling Scheme <index.html#model-labeling-scheme>`_. (read only)"""
`Model Labeling Scheme <index.html#cc>`_. (read only)
:Returns:
`True` if a 470K ohm resistor is populated at the junction labeled "R4"
"""
return self._hco

def relative_mode_config(self, rotate90=False, glide_extend=True,
Expand Down
Binary file modified docs/.doctrees/api.doctree
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
Binary file not shown.
6 changes: 5 additions & 1 deletion docs/_modules/circuitpython_cirque_pinnacle.html
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,11 @@ <h1>Source code for circuitpython_cirque_pinnacle</h1><div class="highlight"><pr
<span class="k">def</span> <span class="nf">hard_configured</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;This `bool` attribute provides insight to applications about factory</span>
<span class="sd"> customized hardware configuration. see note about product labeling in</span>
<span class="sd"> `Model Labeling Scheme &lt;index.html#model-labeling-scheme&gt;`_. (read only)&quot;&quot;&quot;</span>
<span class="sd"> `Model Labeling Scheme &lt;index.html#cc&gt;`_. (read only)</span>

<span class="sd"> :Returns:</span>
<span class="sd"> `True` if a 470K ohm resistor is populated at the junction labeled &quot;R4&quot;</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hco</span>

<div class="viewcode-block" id="PinnacleTouch.relative_mode_config"><a class="viewcode-back" href="../api.html#circuitpython_cirque_pinnacle.PinnacleTouch.relative_mode_config">[docs]</a> <span class="k">def</span> <span class="nf">relative_mode_config</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rotate90</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">glide_extend</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
Expand Down
7 changes: 6 additions & 1 deletion docs/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,12 @@ <h1>PinnacleTouch API<a class="headerlink" href="#pinnacletouch-api" title="Perm
<em class="property">property </em><code class="sig-name descname">hard_configured</code><a class="headerlink" href="#circuitpython_cirque_pinnacle.PinnacleTouch.hard_configured" title="Permalink to this definition"></a></dt>
<dd><p>This <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#bool" title="(in Python v3.7)"><code class="xref any docutils literal notranslate"><span class="pre">bool</span></code></a> attribute provides insight to applications about factory
customized hardware configuration. see note about product labeling in
<a class="reference external" href="index.html#model-labeling-scheme">Model Labeling Scheme</a>. (read only)</p>
<a class="reference external" href="index.html#cc">Model Labeling Scheme</a>. (read only)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3.7/library/constants.html#True" title="(in Python v3.7)"><code class="xref any docutils literal notranslate"><span class="pre">True</span></code></a> if a 470K ohm resistor is populated at the junction labeled “R4”</p>
</dd>
</dl>
</dd></dl>

<dl class="method">
Expand Down
15 changes: 8 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -316,13 +316,14 @@ <h2>Model Labeling Scheme<a class="headerlink" href="#model-labeling-scheme" tit
is configured for SPI, otherwise it is configured for I2C.</p>
</dd>
<dt class="label" id="cc"><span class="brackets"><a class="fn-backref" href="#id3">cc</a></span></dt>
<dd><p>stands for Custom Configuration. “30” means that the hardware is configured to disable
certain features despite what this library does. “00” means that the hardware is configured
to allow certain features to 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 the axis
data anyway).</p>
<dd><p>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
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
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
the axis data anyway).</p>
</dd>
<dt class="label" id="o"><span class="brackets"><a class="fn-backref" href="#id4">o</a></span></dt>
<dd><p>stands for the overlay type (0 = none, 1 = adhesive, 2 = flat, 3 = curved)</p>
Expand Down
Loading

0 comments on commit 0d8f335

Please sign in to comment.