Skip to content

add list of supported api's for baremetal #963

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

Merged
merged 4 commits into from
Mar 1, 2019
Merged
Changes from all commits
Commits
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
46 changes: 46 additions & 0 deletions docs/baremetal_api.md
Original file line number Diff line number Diff line change
@@ -1 +1,47 @@
## Bare metal APIs

Mbed OS bare metal supports the following APIs:

<h3 id="analog-i-o">Analog I/O</h3>

- AnalogIn - Read the voltage applied to an analog input pin.
- AnalogOut - Set the voltage of an analog output pin.

<h3 id="digital-i-o">Digital I/O</h3>

- DigitalIn - Configure and control a digital input pin.
- DigitalOut - Configure and control a digital output pin.
- DigitalInOut - Bidirectional digital pins.

- BusIn - Flexible way to read multiple DigitalIn pins as one value.
- BusOut - Flexible way to write multiple DigitalOut pins as one value.
- BusInOut - Flexible way to read and write multiple DigitalInOut pins as one value.

- PortIn - Fast way to read multiple DigitalIn pins as one value.
- PortOut - Fast way to write multiple DigitalOut pins as one value.
- PortInOut - Fast way to read and write multiple DigitalInOut pins as one value.

- PwmOut - Pulse-width modulated output.

- InterruptIn - Trigger an event when a digital input pin changes.

<h3 id="timers">Timers</h3>

- Timer - Create, start, stop and read a timer.
- Timeout - Call a function after a specified delay.
- Ticker - Repeatedly call a function.

- Wait - Wait for a specified time.
- Time - Get and set the realtime clock.

<h3 id="digital-interfaces">Digital Interfaces</h3>

- Serial - Serial/UART bus.

- SPI - SPI bus master.
- SPISlave - SPI bus slave.

- I2C - I²C bus master.
- I2CSlave - I²C bus slave.

- CAN - Controller-area network bus.