Skip to content

[DOC] Inconsistencies in SPI Examples #3683

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.

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

Closed
q2dg opened this issue Aug 15, 2015 · 2 comments
Closed

[DOC] Inconsistencies in SPI Examples #3683

q2dg opened this issue Aug 15, 2015 · 2 comments
Assignees
Labels
Component: Documentation Related to Arduino's documentation content
Milestone

Comments

@q2dg
Copy link

q2dg commented Aug 15, 2015

1.- https://www.arduino.cc/en/Tutorial/SPIEEPROM is too low level...in fact, doesn't use SPI library but AVR registers. It could remains as it is but a note should be placed indicating this tutorial is only valid for AVR-based boards (and I don't know if for all of them).

2.-https://www.arduino.cc/en/Tutorial/BarometricPressureSensor talks about a retired product and moreover (but that's is a personal opinion) the code is too complicated. Anyway, the code should updated with new SPI API.

3.-https://www.arduino.cc/en/Tutorial/SPIDigitalPot 's code only needs to be updated with new SPI API

Finally, https://www.arduino.cc/en/Tutorial/SPITransaction seems fine, but, as it is said in #2654, something must be done with the management of repo docs in relation with web docs

@ffissore ffissore added the Component: Documentation Related to Arduino's documentation content label Aug 17, 2015
agdl added a commit to agdl/Arduino that referenced this issue Sep 2, 2015
According to arduino#3683 I modified the provided examples in order to use the new
SPI APIs.
@agdl
Copy link
Member

agdl commented Sep 2, 2015

@q2dg take a look at this. If they are ok for you I will make a PR
agdl@29c9fb4

For what concern point 1 you are right. What can be the best way to place this note?
Maybe something like:
This example shows a low level implementation of an SPI communication on an Arduino UNO. More user friendly examples can be found here (link to the others).

Let me know!

@q2dg
Copy link
Author

q2dg commented Sep 2, 2015

I like the note you suggest, and the changes seems ok. So I close the issue, ok?

Although I continue thinking BarometricPressureSensor is not the best example to start, but never mind.

@q2dg q2dg closed this as completed Sep 2, 2015
@ffissore ffissore modified the milestone: Release 1.6.6 Sep 7, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Related to Arduino's documentation content
Projects
None yet
Development

No branches or pull requests

3 participants