8000 Mistake in SPI documentation example · Issue #406 · eblot/pyftdi · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Mistake in SPI documentation example #406

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

Jump to bottom
Open
MattHowardCT opened this issue Mar 24, 2025 · 0 comments · May be fixed by #407
Open

Mistake in SPI documentation example #406

MattHowardCT opened this issue Mar 24, 2025 · 0 comments · May be fixed by #407

Comments

@MattHowardCT
Copy link

There is a small mistake in the SPI documentation in the example "Example: communication with a SPI device and an extra GPIO":

pyftdi/pyftdi/doc/api/spi.rst

Line 61 in 16398f3

# Get GPIO port to manage extra pins, use A*BUS4 as GPO, A*BUS4 as GPI

Should instead say:

# Get GPIO port to manage extra pins, use A*BUS4 as GPO, A*BUS5 as GPI

Also the example would be clearer if it used parameter names for the set_direction call:

pyftdi/pyftdi/doc/api/spi.rst

Line 63 in 16398f3

gpio.set_direction(0x30, 0x10)

Would become:

gpio.set_direction(pins=0b0011_0000, direction=0b0001_0000)
@MattHowardCT MattHowardCT linked a pull request Mar 24, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Correct mistake in SPI API documentation example MattHowardCT/pyftdi
1 participant
@MattHowardCT
0