mirror of
https://github.com/KevinMidboe/python-gpiozero.git
synced 2025-10-29 17:50:37 +00:00
576fced6c4
Added notes on how the abstracts are represented, ensured all the class hierarchies were up to date, and changed the orientation so the classes are actually readable in the big chart.
144 lines
4.5 KiB
ReStructuredText
144 lines
4.5 KiB
ReStructuredText
===========
|
|
SPI Devices
|
|
===========
|
|
|
|
.. currentmodule:: gpiozero
|
|
|
|
SPI stands for `Serial Peripheral Interface`_ and is a mechanism allowing
|
|
compatible devices to communicate with the Pi. SPI is a four-wire protocol
|
|
meaning it usually requires four pins to operate:
|
|
|
|
* A "clock" pin which provides timing information.
|
|
|
|
* A "MOSI" pin (Master Out, Slave In) which the Pi uses to send information
|
|
to the device.
|
|
|
|
* A "MISO" pin (Master In, Slave Out) which the Pi uses to receive information
|
|
from the device.
|
|
|
|
* A "select" pin which the Pi uses to indicate which device it's talking to.
|
|
This last pin is necessary because multiple devices can share the clock,
|
|
MOSI, and MISO pins, but only one device can be connected to each select
|
|
pin.
|
|
|
|
The gpiozero library provides two SPI implementations:
|
|
|
|
* A software based implementation. This is always available, can use any four
|
|
GPIO pins for SPI communication, but is rather slow and won't work with all
|
|
devices.
|
|
|
|
* A hardware based implementation. This is only available when the SPI kernel
|
|
module is loaded, and the Python spidev library is available. It can only use
|
|
specific pins for SPI communication (GPIO11=clock, GPIO10=MOSI, GPIO9=MISO,
|
|
while GPIO8 is select for device 0 and GPIO7 is select for device 1).
|
|
However, it is extremely fast and works with all devices.
|
|
|
|
.. _Serial Peripheral Interface: https://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus
|
|
|
|
|
|
.. _spi_args:
|
|
|
|
SPI keyword args
|
|
================
|
|
|
|
When constructing an SPI device there are two schemes for specifying which pins
|
|
it is connected to:
|
|
|
|
* You can specify *port* and *device* keyword arguments. The *port* parameter
|
|
must be 0 (there is only one user-accessible hardware SPI interface on the Pi
|
|
using GPIO11 as the clock pin, GPIO10 as the MOSI pin, and GPIO9 as the MISO
|
|
pin), while the *device* parameter must be 0 or 1. If *device* is 0, the
|
|
select pin will be GPIO8. If *device* is 1, the select pin will be GPIO7.
|
|
|
|
* Alternatively you can specify *clock_pin*, *mosi_pin*, *miso_pin*, and
|
|
*select_pin* keyword arguments. In this case the pins can be any 4 GPIO pins
|
|
(remember that SPI devices can share clock, MOSI, and MISO pins, but not
|
|
select pins - the gpiozero library will enforce this restriction).
|
|
|
|
You cannot mix these two schemes, i.e. attempting to specify *port* and
|
|
*clock_pin* will result in :exc:`SPIBadArgs` being raised. However, you can
|
|
omit any arguments from either scheme. The defaults are:
|
|
|
|
* *port* and *device* both default to 0.
|
|
|
|
* *clock_pin* defaults to 11, *mosi_pin* defaults to 10, *miso_pin* defaults
|
|
to 9, and *select_pin* defaults to 8.
|
|
|
|
Hence the following constructors are all equiavlent::
|
|
|
|
from gpiozero import MCP3008
|
|
|
|
MCP3008(channel=0)
|
|
MCP3008(channel=0, device=0)
|
|
MCP3008(channel=0, port=0, device=0)
|
|
MCP3008(channel=0, select_pin=8)
|
|
MCP3008(channel=0, clock_pin=11, mosi_pin=10, miso_pin=9, select_pin=8)
|
|
|
|
Note that the defaults describe equivalent sets of pins and that these pins are
|
|
compatible with the hardware implementation. Regardless of which scheme you
|
|
use, gpiozero will attempt to use the hardware implementation if it is
|
|
available and if the selected pins are compatible, falling back to the software
|
|
implementation if not.
|
|
|
|
Analog to Digital Converters (ADC)
|
|
==================================
|
|
|
|
.. autoclass:: MCP3001
|
|
:members: value
|
|
|
|
.. autoclass:: MCP3002
|
|
:members: channel, value, differential
|
|
|
|
.. autoclass:: MCP3004
|
|
:members: channel, value, differential
|
|
|
|
.. autoclass:: MCP3008
|
|
:members: channel, value, differential
|
|
|
|
.. autoclass:: MCP3201
|
|
:members: value
|
|
|
|
.. autoclass:: MCP3202
|
|
:members: channel, value, differential
|
|
|
|
.. autoclass:: MCP3204
|
|
:members: channel, value, differential
|
|
|
|
.. autoclass:: MCP3208
|
|
:members: channel, value, differential
|
|
|
|
.. autoclass:: MCP3301
|
|
:members: value
|
|
|
|
.. autoclass:: MCP3302
|
|
:members: channel, value, differential
|
|
|
|
.. autoclass:: MCP3304
|
|
:members: channel, value, differential
|
|
|
|
Base Classes
|
|
============
|
|
|
|
The classes in the sections above are derived from a series of base classes,
|
|
some of which are effectively abstract. The classes form the (partial)
|
|
hierarchy displayed in the graph below (abstract classes are shaded lighter
|
|
than concrete classes):
|
|
|
|
.. image:: images/spi_device_hierarchy.*
|
|
|
|
The following sections document these base classes for advanced users that wish
|
|
to construct classes for their own devices.
|
|
|
|
AnalogInputDevice
|
|
=================
|
|
|
|
.. autoclass:: AnalogInputDevice
|
|
:members:
|
|
|
|
SPIDevice
|
|
=========
|
|
|
|
.. autoclass:: SPIDevice
|
|
:members:
|
|
|