Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 67 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ Usage Example
=============


Single Ended
------------
MCP3008 Single Ended
---------------------

.. code-block:: python

import busio
import digitalio
import board
from adafruit_mcp3xxx.mcp3008 import MCP3008
import adafruit_mcp3xxx.mcp3008 as MCP
from adafruit_mcp3xxx.analog_in import AnalogIn

# create the spi bus
Expand All @@ -52,42 +52,95 @@ Single Ended
# create the cs (chip select)
cs = digitalio.DigitalInOut(board.D5)

# create the mcp object from MCP3008 class
mcp = MCP3008(spi, cs)
# create the mcp object
mcp = MCP.MCP3008(spi, cs)

# create an analog input channel on pin 0
chan = AnalogIn(mcp, MCP3008.pin_0)
chan = AnalogIn(mcp, MCP.P0)

print('Raw ADC Value: ', chan.value)
print('ADC Voltage: ' + str(chan.voltage) + 'V')


Differential
------------
MCP3008 Differential
--------------------

.. code-block:: python

import busio
import digitalio
import board
from adafruit_mcp3xxx.mcp3008 import MCP3008
from adafruit_mcp3xxx.differential_analog_in import DifferentialAnalogIn
import adafruit_mcp3xxx.mcp3008 as MCP
from adafruit_mcp3xxx.analog_in import AnalogIn

# create the spi bus
spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)

# create the cs (chip select)
cs = digitalio.DigitalInOut(board.D5)

# create the mcp object from MCP3008 class
mcp = MCP3008(spi, cs)
# create the mcp object
mcp = MCP.MCP3008(spi, cs)

# create a differential analog input channel with pin 0 and pin 1
chan = DifferentialAnalogIn(mcp, MCP3008.pin_0, MCP3008.pin_1)
# create a differential ADC channel between Pin 0 and Pin 1
chan = AnalogIn(mcp, MCP.P0, MCP.P1)

print('Differential ADC Value: ', chan.value)
print('Differential ADC Voltage: ' + str(chan.voltage) + 'V')

MCP3004 Single-Ended
---------------------

.. code-block:: python

import busio
import digitalio
import board
import adafruit_mcp3xxx.mcp3004 as MCP
from adafruit_mcp3xxx.analog_in import AnalogIn

# create the spi bus
spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)

# create the cs (chip select)
cs = digitalio.DigitalInOut(board.D5)

# create the mcp object
mcp = MCP.MCP3004(spi, cs)

# create an analog input channel on pin 0
chan = AnalogIn(mcp, MCP.P0, MCP.P1)

print('Raw ADC Value: ', chan.value)
print('ADC Voltage: ' + str(chan.voltage) + 'V')

MCP3004 Differential
--------------------

.. code-block:: python

import busio
import digitalio
import board
import adafruit_mcp3xxx.mcp3004 as MCP
from adafruit_mcp3xxx.analog_in import AnalogIn

# create the spi bus
spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)

# create the cs (chip select)
cs = digitalio.DigitalInOut(board.D5)

# create the mcp object
mcp = MCP.MCP3004(spi, cs)

# create a differential ADC channel between Pin 0 and Pin 1
chan = AnalogIn(mcp, MCP.P0, MCP.P1)

print('Differential ADC Value: ', chan.value)
print('Differential ADC Voltage: ' + str(chan.voltage) + 'V')



Contributing
============
Expand Down
2 changes: 1 addition & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ API
------------

.. automodule:: adafruit_mcp3xxx
:members:
:members:
12 changes: 12 additions & 0 deletions docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,15 @@ Ensure your device works with this simple test.
.. literalinclude:: ../examples/mcp3008_single_ended_simpletest.py
:caption: examples/mcp3008_single_ended_simpletest.py
:linenos:

.. literalinclude:: ../examples/mcp3004_single_ended_simpletest.py
:caption: examples/mcp3004_single_ended_simpletest.py
:linenos:

.. literalinclude:: ../examples/mcp3008_differential_simpletest.py
:caption: mcp3008_differential_simpletest.py
:linenos:

.. literalinclude:: ../examples/mcp3004_differential_simpletest.py
:caption: mcp3004_differential_simpletest.py
:linenos: