Skip to content

Add documentation for the particularities of this core #464

Closed
@romainreignier

Description

@romainreignier

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:

#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()
    ...

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentation 📚Improvements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions