Skip to content

Fix ToC resolution #1448

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
Apr 29, 2021
Merged

Fix ToC resolution #1448

Show file tree
Hide file tree
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
8 changes: 4 additions & 4 deletions docs/porting/standard_pin_names/pin_names_dev_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Standard Pin Names
# Standard Pin Names

In general, platform code should be portable across different Mbed supported boards with the same hardware capabilities or interfaces.

This document provides general developer guidelines on pin names that apply to all boards but it's not specific to any type of connector.

**_NOTE:_** there might be separate documents for pin names that apply to specific connectors.

### LEDs
## LEDs

Available onboard LEDs are defined as `LEDx` e.g. `LED1`, `LED2`, ...

Expand All @@ -30,7 +30,7 @@ It's possible to define new names of LEDs related to its properties, like color

However, these names do not apply to all boards and hence should not be used in official example applications.

### Buttons
## Buttons

Buttons that are available on a board will be defined as `BUTTONx` e.g. `BUTTON1`, `BUTTON2`, ...

Expand All @@ -53,7 +53,7 @@ It's possible to define new names of buttons related to its properties. It's rec

However, these names do not apply to all boards and hence should not be used in official example applications.

### UART
## UART

Every Mbed board includes a serial interface to the host PC, which allows the console to print useful information about the application.

Expand Down
2 changes: 1 addition & 1 deletion docs/porting/standard_pin_names/pin_names_dev_guide_arduino.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Arduino Uno Pin Names
# Arduino Uno Pin Names

The Arduino Uno connector is a standardised connector in Mbed, which has a set amount of exposed functionality. To achieve meaningful portability of application code across various Mbed boards that are Arduino Uno compliant, the pin names used for the connector pins are common across these boards.

Expand Down