Skip to content

Commit 6b36a22

Browse files
author
Qinghao Shi
authored
Merge branch 'development' into update_examples
2 parents dae6042 + 4695453 commit 6b36a22

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+202
-308
lines changed

‎docs.json

Lines changed: 42 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -191,21 +191,21 @@
191191
"path": "docs/api/rtos/rtos.md"
192192
},
193193
"sub_chapters": [{
194-
"title": "Options and config",
194+
"title": "RTOS options and config",
195195
"intro": {
196196
"path": "docs/api/rtos/rtos-config.md"
197197
},
198198
"sources": []
199199
},
200200
{
201-
"title": "General information",
201+
"title": "RTOS general information",
202202
"intro": {
203203
"path": "docs/api/rtos/thread_safety.md"
204204
},
205205
"sources": []
206206
},
207207
{
208-
"title": "APIs",
208+
"title": "RTOS APIs",
209209
"sources": [{
210210
"path": "docs/api/rtos/Thread.md"
211211
},
@@ -245,7 +245,7 @@
245245
]
246246
},
247247
{
248-
"title": "Tutorials",
248+
"title": "RTOS tutorials",
249249
"intro": {
250250
"path": "docs/api/rtos/events_tutorial.md"
251251
},
@@ -259,17 +259,14 @@
259259
"path": "docs/api/io/drivers.md"
260260
},
261261
"sub_chapters": [{
262-
"title": "Options and config",
262+
"title": "I/O options and config",
263263
"intro": {
264264
"path": "docs/api/io/io-config.md"
265265
},
266266
"sources": []
267267
},
268268
{
269-
"title": "APIs",
270-
"intro": {
271-
"path": "docs/api/io/drivers.md"
272-
},
269+
"title": "I/O APIs",
273270
"sources": [{
274271
"path": "docs/api/io/AnalogIn.md"
275272
},
@@ -327,12 +324,6 @@
327324
{
328325
"path": "docs/api/io/FlashIAP.md"
329326
},
330-
{
331-
"path": "docs/api/io/RawSerial.md"
332-
},
333-
{
334-
"path": "docs/api/io/Serial.md"
335-
},
336327
{
337328
"path": "docs/api/io/BufferedSerial.md"
338329
},
@@ -363,7 +354,7 @@
363354
]
364355
},
365356
{
366-
"title": "Tutorials",
357+
"title": "I/O tutorials",
367358
"sources": [{
368359
"path": "docs/api/io/flow_control.md"
369360
},
@@ -380,17 +371,14 @@
380371
"path": "docs/api/storage/storage.md"
381372
},
382373
"sub_chapters": [{
383-
"title": "Concepts",
384-
"sources": [{
385-
"path": "docs/api/storage/storage-config.md"
386-
},
387-
{
388-
"path": "docs/api/storage/storage-arch.md"
389-
}
390-
]
391-
},
374+
"title": "Data options and config",
375+
"intro": {
376+
"path": "docs/api/storage/storage-config.md"
377+
},
378+
"sources": []
379+
},
392380
{
393-
"title": "APIs",
381+
"title": "Data APIs",
394382
"sources": [{
395383
"path": "docs/api/storage/KVStoreAPI.md"
396384
},
@@ -456,12 +444,16 @@
456444
},
457445
{
458446
"path": "docs/api/storage/psa_protected_storage.md"
459-
},
460-
{
461-
"path": "docs/api/storage/NVStore.md"
462447
}
463448
]
464-
}
449+
},
450+
{
451+
"title": "Data architecture",
452+
"intro": {
453+
"path": "docs/api/storage/storage-arch.md"
454+
},
455+
"sources": []
456+
}
465457
]
466458
},
467459
{
@@ -593,7 +585,7 @@
593585
"path": "docs/api/usb/usb_component.md"
594586
},
595587
"sub_chapters": [{
596-
"title": "APIs",
588+
"title": "USB APIs",
597589
"sources": [{
598590
"path": "docs/api/usb/USBSerial.md"
599591
},
@@ -627,14 +619,14 @@
627619
]
628620
},
629621
{
630-
"title": "Tutorials",
622+
"title": "USB tutorials",
631623
"intro": {
632624
"path": "docs/api/usb/Mbed_USB_WAV_Audio_Player/Mbed_USB_WAV_Audio_Player.md"
633625
},
634626
"sources": []
635627
},
636628
{
637-
"title": "Architecture",
629+
"title": "USB architecture",
638630
"intro": {
639631
"path": "docs/api/usb/usb-arch.md"
640632
},
@@ -648,14 +640,14 @@
648640
"path": "docs/api/bluetooth/bluetooth.md"
649641
},
650642
"sub_chapters": [{
651-
"title": "Options and config",
643+
"title": "BLE options and config",
652644
"intro": {
653645
"path": "docs/api/bluetooth/ble-config.md"
654646
},
655647
"sources": []
656648
},
657649
{
658-
"title": "APIs",
650+
"title": "BLE APIs",
659651
"sources": [{
660652
"path": "docs/api/bluetooth/BLE.md"
661653
},
@@ -683,7 +675,7 @@
683675
]
684676
},
685677
{
686-
"title": "Tutorials",
678+
"title": "BLE tutorials",
687679
"intro": {
688680
"path": "docs/api/bluetooth/ble_tutorial.md"
689681
},
@@ -697,14 +689,14 @@
697689
"path": "docs/api/lorawan/lorawanintro.md"
698690
},
699691
"sub_chapters": [{
700-
"title": "Options and config",
692+
"title": "LoRaWAN options and config",
701693
"intro": {
702694
"path": "docs/api/lorawan/lorawanconfig.md"
703695
},
704696
"sources": []
705697
},
706698
{
707-
"title": "APIs",
699+
"title": "LoRaWAN APIs",
708700
"sources": [{
709701
"path": "docs/api/lorawan/lorawan.md"
710702
},
@@ -714,14 +706,14 @@
714706
]
715707
},
716708
{
717-
"title": "Tutorials",
709+
"title": "LoRaWAN tutorials",
718710
"intro": {
719711
"path": "docs/api/lorawan/intro-to-lora.md"
720712
},
721713
"sources": []
722714
},
723715
{
724-
"title": "Architecture",
716+
"title": "LoRaWAN architecture",
725717
"intro": {
726718
"path": "docs/api/lorawan/lora-tech.md"
727719
},
@@ -735,7 +727,7 @@
735727
"path": "docs/api/nfc/NDEF.md"
736728
},
737729
"sub_chapters": [{
738-
"title": "APIs",
730+
"title": "NFC APIs",
739731
"sources": [{
740732
"path": "docs/api/nfc/NFCController.md"
741733
},
@@ -754,7 +746,7 @@
754746
]
755747
},
756748
{
757-
"title": "Architecture",
749+
"title": "NFC architecture",
758750
"intro": {
759751
"path": "docs/api/nfc/nfc-arch.md"
760752
},
@@ -778,7 +770,7 @@
778770
"path": "docs/api/security/security.md"
779771
},
780772
"sub_chapters": [{
781-
"title": "APIs",
773+
"title": "Security APIs",
782774
"sources": [{
783775
"path": "docs/api/security/psa_attestation.md"
784776
},
@@ -797,14 +789,14 @@
797789
]
798790
},
799791
{
800-
"title": "Tutorials",
792+
"title": "Security tutorials",
801793
"intro": {
802794
"path": "docs/api/security/tls_tutorial.md"
803795
},
804796
"sources": []
805797
},
806798
{
807-
"title": "Architecture",
799+
"title": "Security architecture",
808800
"intro": {
809801
"path": "docs/api/security/securesocket-arch.md"
810802
},
@@ -818,7 +810,7 @@
818810
"path": "docs/api/power/power_manage.md"
819811
},
820812
"sub_chapters": [{
821-
"title": "APIs",
813+
"title": "Power APIs",
822814
"sources": [{
823815
"path": "docs/api/power/PowerManagement.md"
824816
}, {
@@ -845,7 +837,7 @@
845837
"path": "docs/api/memory/memory_intro.md"
846838
},
847839
"sub_chapters": [{
848-
"title": "APIs",
840+
"title": "Memory APIs",
849841
"sources": [{
850842
"path": "docs/api/memory/runtime_mem_trace.md"
851843
},
@@ -873,7 +865,7 @@
873865
]
874866
},
875867
{
876-
"title": "Tutorials",
868+
"title": "Memory tutorials",
877869
"intro": {
878870
"path": "docs/program-setup/runtime/static_memory_optimization.md"
879871
},
@@ -887,18 +879,15 @@
887879
"path": "docs/api/platform/platform.md"
888880
},
889881
"sub_chapters": [{
890-
"title": "Options and config",
882+
"title": "Util options and config",
891883
"intro": {
892884
"path": "docs/api/platform/platform-config.md"
893885
},
894886
"sources": []
895887
},
896888
{
897-
"title": "APIs",
889+
"title": "Util APIs",
898890
"sources": [{
899-
"path": "docs/api/platform/Wait.md"
900-
},
901-
{
902891
"path": "docs/api/platform/Callback.md"
903892
},
904893
{

‎docs/api/api.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,6 @@
77
<table>
88
<tbody>
99
<tr>
10-
<td><a href="wait.html">Wait</a></td>
11-
<td><a href="time.html">Time</a></td>
12-
<td><a href="noncopyable.html">NonCopyable</a></td>
13-
<td><a href="circularbuffer.html">CircularBuffer</a></td>
14-
</tr>
15-
<tr>
1610
<td><a href="callback.html">Callback</a></td>
1711
<td><a href="rtc.html">RTC</a></td>
1812
<td><a href="shared-pointer.html">Shared pointer</a></td>
@@ -42,6 +36,11 @@
4236
<td><a href="platformmutex.html">PlatformMutex</a></td>
4337
<td><a href="scopedromwritelock.html">ScopedRomWriteLock</a></td>
4438
</tr>
39+
<tr>
40+
<td><a href="time.html">Time</a></td>
41+
<td><a href="noncopyable.html">NonCopyable</a></td>
42+
<td><a href="circularbuffer.html">CircularBuffer</a></td>
43+
</tr>
4544
</tbody>
4645
</table>
4746

@@ -62,14 +61,14 @@
6261
<td><a href="analogout.html">AnalogOut</a></td>
6362
<td><a href="portin.html">PortIn</a></td>
6463
<td><a href="timer.html">Timer</a></td>
65-
<td><a href="rawserial.html">RawSerial</a></td>
64+
<td><a href="bufferedserial.html">BufferedSerial</a></td>
6665
<td><a href="can.html">CAN</a></td>
6766
</tr>
6867
<tr>
6968
<td><a href="digitalin.html">DigitalIn</a></td>
7069
<td><a href="portout.html">PortOut</a></td>
7170
<td><a href="lowpowerticker.html">LowPowerTicker</a></td>
72-
<td><a href="serial.html">Serial</a></td>
71+
<td><a href="unbufferedserial.html">UnbufferedSerial</a></td>
7372
<td><a href="mbedcrc.html">MbedCRC</a></td>
7473
</tr>
7574
<tr>
@@ -272,21 +271,20 @@ The [storage APIs](storage.html) include file system APIs, for file system opera
272271
<td><a href="littlefilesystem.html">LittleFileSystem</a></td>
273272
<td><a href="chainingblockdevice.html">ChainingBlockDevice</a></td>
274273
<td><a href="../apis/dataflashblockdevice.html">DataFlashBlockDevice</a></td>
275-
<td><a href="nvstore.html">NVStore</a></td>
274+
<td><a href="../apis/psa-internal-storage.html">PSA internal storage</a></td>
276275
</tr>
277276
<tr>
278277
<td><a href="static-global-api.html">Static Global API</a></td>
279278
<td><a href="fatfilesystem.html">FATFileSystem</a></td>
280279
<td><a href="slicingblockdevice.html">SlicingBlockDevice</a></td>
281280
<td><a href="flashiapblockdevice.html">FlashIAPBlockDevice</a></td>
282-
<td><a href="../apis/psa-internal-storage.html">PSA internal storage</a></td>
281+
<td><a href="../apis/psa-protected-storage.html">PSA protected storage</a></td>
283282
</tr>
284283
<tr>
285284
<td><a href="filesystem.html">FileSystem</a></td>
286285
<td><a href="blockdevice.html">BlockDevice</a></td>
287286
<td><a href="profilingblockdevice.html">ProfilingBlockDevice</a></td>
288287
<td><a href="sdblockdevice.html">SDBlockDevice</a></td>
289-
<td><a href="../apis/psa-protected-storage.html">PSA protected storage</a></td>
290288
</tr>
291289
<tr>
292290
<td><a href="dir.html">Dir</a></td>

‎docs/api/bluetooth/BLE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,13 @@ The class's member functions can be divided by purpose:
6060

6161
Here is an example demonstrating how you can create a BLE beacon.
6262

63-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/master/BLE_Beacon/source)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-5.14/BLE_Beacon/source/main.cpp)
63+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/master/BLE_Beacon/source)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-5.15/BLE_Beacon/source/main.cpp)
6464

6565
## Example: BLE heart rate monitor
6666

6767
Here is an example demonstrating how to build a heart rate sensor that can be connected and monitored by a BLE client such as your phone.
6868

69-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/master/BLE_HeartRate/source)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-5.14/BLE_HeartRate/source/main.cpp)
69+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/master/BLE_HeartRate/source)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-5.15/BLE_HeartRate/source/main.cpp)
7070

7171
## Related content
7272

‎docs/api/bluetooth/BatteryService.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The BatteryService class implements the Bluetooth Battery Service as defined by
1212

1313
## BatteryService example
1414

15-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/master/BLE_BatteryLevel/source)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-5.14/BLE_BatteryLevel/source/main.cpp)
15+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/master/BLE_BatteryLevel/source)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-5.15/BLE_BatteryLevel/source/main.cpp)
1616

1717
## Related content
1818

‎docs/api/bluetooth/HeartRateService.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The HeartRateService class implements the Bluetooth Heart Rate service as define
1414

1515
## HeartRateService example
1616

17-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/master/BLE_HeartRate/source)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-5.14/BLE_HeartRate/source/main.cpp)
17+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/master/BLE_HeartRate/source)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-5.15/BLE_HeartRate/source/main.cpp)
1818

1919
## Related content
2020

0 commit comments

Comments
 (0)