Skip to content

Commit 2769792

Browse files
committed
Added SPI module attribute docs
1 parent 191b214 commit 2769792

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

docs/index.rst

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,12 +184,40 @@ Example::
184184

185185
.. class:: SPI(bus, client)
186186

187-
:param bus: bus number
188-
:param client: client number
187+
:param bus: bus number.
188+
:param client: client number.
189189
:returns: a new SPI object, optionally connected to the specified SPI
190190
device interface.
191191
:rtype: :class:`SPI`
192192

193+
.. attribute:: bpw
194+
195+
Bits per word.
196+
197+
.. attribute:: cshigh
198+
199+
Chip Select (CS or Slave Select, SS) active high.
200+
201+
.. attribute:: loop
202+
203+
Loopback configuration.
204+
205+
.. attribute:: lsbfirst
206+
207+
Least Significant Bit (LSB) first.
208+
209+
.. attribute:: mode
210+
211+
SPI mode as two bit pattern of Clock Polarity and Phase [CPOL|CPHA]; min-- 0b00 = 0, max-- 0b11 = 3.
212+
213+
.. attribute:: msh
214+
215+
Maximum speed in Hz.
216+
217+
.. attribute:: threewire
218+
219+
SI/SO signals are shared.
220+
193221
.. method:: open(bus, device)
194222

195223
Connects the object to the specified SPI device. `open(X, Y)` will open

0 commit comments

Comments
 (0)