Skip to content

Add documentation for the particularities of this core #464

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
Closed
3 tasks
romainreignier opened this issue Mar 2, 2019 · 7 comments
Closed
3 tasks

Add documentation for the particularities of this core #464

romainreignier opened this issue Mar 2, 2019 · 7 comments
Labels
documentation 📚 Improvements or additions to documentation

Comments

@romainreignier
Copy link

romainreignier commented Mar 2, 2019 •
edited by fpistm
Loading

To follow the discussion started in #458, it would be nice to document the usage of this core for users coming for official Arduino core.

Even if a dedicated website would be nice, it requires some work to setup a template with some style, categories... So instead, I propose to leverage the existing wiki.

I have started by adding the HardwareSerial info reported in #458, see here:
https://github.com/stm32duino/wiki/wiki/API#hardwareserial

Do you think it is the right place? I am open to any suggestions.

@fpistm For the HardwareSerial case, using the first method (declaring a HardwareSerial in the sketch) will not enable the serialEvent() callback, right?
For what I understand here:

Arduino_Core_STM32/cores/arduino/WSerial.h

Lines 33 to 37 in 830bb00

#define ENABLE_HWSERIAL1
#if !defined(Serial)
#define Serial Serial1
#define serialEvent serialEvent1
#endif

Only passing -DENABLE_HWSERIAL1 will enable it. Am I right?

ToDo:

  • Core debug
  • Pin mapping vs Pin number
  • Digital(Read|Write)Fast(), digitalToggle() and digitalToggleFast()
    ...
@fpistm fpistm added help wanted 🙏 Extra attention is needed documentation 📚 Improvements or additions to documentation labels Mar 2, 2019
@fpistm
Copy link
Member

fpistm commented Mar 2, 2019 •
edited
Loading

Hi @romainreignier and thanks.
you're right for serialEvent.
Serial is the generic one map to the default serial instance defined in the variant if any.

@romainreignier
Copy link
Author

@fpistm Thank you, I have added a note.

So if you agree with the format, I will had the same kind of section for SPI and i2c.

@fpistm
Copy link
Member

fpistm commented Mar 2, 2019

Agreed of course 👍

@romainreignier
Copy link
Author

I have added i2c and SPI examples.

@fpistm
Copy link
Member

fpistm commented May 3, 2019 •
edited
Loading

Note for me: update upload method with #514 --> done
https://github.com/stm32duino/wiki/wiki/Upload-methods#stm32cubeprogrammer

@fpistm
Copy link
Member

fpistm commented Jul 23, 2019

Since a month I've added/updated several Wiki pages.
I've added a ToDo list in the OP to track what is missing.

@fpistm fpistm removed the help wanted 🙏 Extra attention is needed label Jan 31, 2020
@fpistm
Copy link
Member

fpistm commented Jan 31, 2020 •
edited
Loading

Wiki is updated regularly as requested by the OP.
I close this one as it is not used to track the Wiki which is updated in a dedicated repo.

@fpistm fpistm closed this as completed Jan 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation 📚 Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@romainreignier @fpistm