Skip to content
Prev Previous commit
Next Next commit
double comment?! doc proofreading
  • Loading branch information
2bndy5 committed Oct 25, 2019
commit f8077b2990b5c2a29fd3cdde3f2d969c7355fa1d
2 changes: 1 addition & 1 deletion adafruit_mcp3xxx/mcp3002.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"""
from .mcp3xxx import MCP3xxx

# # MCP3002 Pin Mapping
# MCP3002 Pin Mapping
P0 = 0
P1 = 1

Expand Down
2 changes: 1 addition & 1 deletion adafruit_mcp3xxx/mcp3004.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

from .mcp3xxx import MCP3xxx

# # MCP3004 Pin Mapping
# MCP3004 Pin Mapping
P0 = 0
P1 = 1
P2 = 2
Expand Down
2 changes: 1 addition & 1 deletion adafruit_mcp3xxx/mcp3008.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

from .mcp3xxx import MCP3xxx

# # MCP3008 Pin Mapping
# MCP3008 Pin Mapping
P0 = 0
P1 = 1
P2 = 2
Expand Down
10 changes: 5 additions & 5 deletions adafruit_mcp3xxx/mcp3xxx.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,17 @@
https://github.com/adafruit/circuitpython/releases
* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice

.. note:: The ADC chips' input pins (AKA "channels" in the datasheets) are aliased in this library
.. note:: The ADC chips' input pins (AKA "channels") are aliased in this library
as integer variables whose names start with "P" (eg ``MCP3008.P0`` is channel 0 on the MCP3008
chip). Each module that contains a driver class for a particular ADC chip has these aliases
predefined accordingly. This is done for code readability and prevention of erroneous SPI
commands.

.. important::
The differential reads (comparisons done by the ADC chip) are limited to certain pairs of
channels. These predefined pairs are referenced in this documentation as differential mappings.
Please refer to the driver class of your ADC chip (`MCP3008`_, `MCP3004`_, `MCP3002`_) for a
list of available differential mappings.
channels. These predefined pairs are referenced in this documentation as differential
channel mappings. Please refer to the driver class of your ADC chip (`MCP3008`_,
`MCP3004`_, `MCP3002`_) for a list of available differential channel mappings.
"""

__version__ = "0.0.0-auto.0"
Expand Down Expand Up @@ -89,7 +89,7 @@ def read(self, pin, is_differential=False):
.. note:: This library offers a helper class called `AnalogIn`_ for both single-ended
and differential reads. If you opt to not implement `AnalogIn`_ during differential
reads, then the ``pin`` parameter should be the first of the two pins associated with
the desired differential mapping.
the desired differential channel mapping.
"""
self._out_buf[1] = ((not is_differential) << 7) | (pin << 4)
with self._spi_device as spi:
Expand Down