Skip to content

Commit f068119

Browse files
committed
add list of supported api's for baremetal
1 parent e99bb4f commit f068119

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/baremetal_api.md

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

0 commit comments

Comments
 (0)