Skip to content

Improve baud rate, polarity, and phase parameter descriptions #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 20, 2023
Merged

Improve baud rate, polarity, and phase parameter descriptions #93

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions adafruit_bus_device/spi_device.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,13 @@ class SPIDevice:
:param ~busio.SPI spi: The SPI bus the device is on
:param ~digitalio.DigitalInOut chip_select: The chip select pin object that implements the
DigitalInOut API.
:param bool cs_active_value: Set to true if your device requires CS to be active high.
Defaults to false.
:param int baudrate: The SPI baudrate
:param int polarity: The SPI polarity
:param int phase: The SPI phase
:param bool cs_active_value: Set to True if your device requires CS to be active high.
Defaults to False.
:param int baudrate: The desired SCK clock rate in Hertz. The actual clock rate may be
higher or lower due to the granularity of available clock settings (MCU dependent).
:param int polarity: The base state of the SCK clock pin (0 or 1).
:param int phase: The edge of the clock that data is captured. First (0) or second (1).
Rising or falling depends on SCK clock polarity.
:param int extra_clocks: The minimum number of clock cycles to cycle the bus after CS is high.
(Used for SD cards.)

Expand Down