Skip to content

Commit 0a54c2d

Browse files
author
Amanda Butler
authored
Merge pull request #963 from aashishc1988/baremetal_api
add list of supported api's for baremetal
2 parents 6bb5ef7 + c2aeefb commit 0a54c2d

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

docs/baremetal_api.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,47 @@
11
## Bare metal APIs
2+
3+
Mbed OS bare metal supports the following APIs:
4+
5+
<h3 id="analog-i-o">Analog I/O</h3>
6+
7+
- AnalogIn - Read the voltage applied to an analog input pin.
8+
- AnalogOut - Set the voltage of an analog output pin.
9+
10+
<h3 id="digital-i-o">Digital I/O</h3>
11+
12+
- DigitalIn - Configure and control a digital input pin.
13+
- DigitalOut - Configure and control a digital output pin.
14+
- DigitalInOut - Bidirectional digital pins.
15+
16+
- BusIn - Flexible way to read multiple DigitalIn pins as one value.
17+
- BusOut - Flexible way to write multiple DigitalOut pins as one value.
18+
- BusInOut - Flexible way to read and write multiple DigitalInOut pins as one value.
19+
20+
- PortIn - Fast way to read multiple DigitalIn pins as one value.
21+
- PortOut - Fast way to write multiple DigitalOut pins as one value.
22+
- PortInOut - Fast way to read and write multiple DigitalInOut pins as one value.
23+
24+
- PwmOut - Pulse-width modulated output.
25+
26+
- InterruptIn - Trigger an event when a digital input pin changes.
27+
28+
<h3 id="timers">Timers</h3>
29+
30+
- Timer - Create, start, stop and read a timer.
31+
- Timeout - Call a function after a specified delay.
32+
- Ticker - Repeatedly call a function.
33+
34+
- Wait - Wait for a specified time.
35+
- Time - Get and set the realtime clock.
36+
37+
<h3 id="digital-interfaces">Digital Interfaces</h3>
38+
39+
- Serial - Serial/UART bus.
40+
41+
- SPI - SPI bus master.
42+
- SPISlave - SPI bus slave.
43+
44+
- I2C - I²C bus master.
45+
- I2CSlave - I²C bus slave.
46+
47+
- CAN - Controller-area network bus.

0 commit comments

Comments
 (0)