Skip to content

Commit 08d9d24

Browse files
author
Amanda Butler
authored
Merge branch 'development' into AnotherButler-patch-3
2 parents f018283 + 18e078a commit 08d9d24

File tree

363 files changed

+643
-748
lines changed

Some content is hidden

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

363 files changed

+643
-748
lines changed

docs.json

Lines changed: 46 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"branch": "master"
99
},
1010
{
11-
"title": "Introduction",
11+
"title": "Mbed OS 5",
1212
"description": "Introducing Mbed OS: the overview, architecture, features and licensing",
1313
"slug": "introduction",
1414
"type": "markdown",
@@ -46,7 +46,7 @@
4646
]
4747
},
4848
{
49-
"title": "Mbed OS quick start",
49+
"title": "Quick start",
5050
"description": "",
5151
"slug": "quick-start",
5252
"type": "markdown",
@@ -952,10 +952,30 @@
952952
},
953953
{
954954
"title": "Developing: Mbed Studio",
955-
"sources": [{
955+
"intro": {
956956
"type": "markdown",
957-
"url": "https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/tools/Studio/mbed-studio.md"
958-
}]
957+
"url": "https://github.com/ARMmbed/mbed-studio-docs/blob/master/Docs/Introduction.md"
958+
},
959+
"sources": [{
960+
"type": "markdown",
961+
"url": "https://github.com/ARMmbed/mbed-studio-docs/blob/master/Docs/Getting-started.md"
962+
},
963+
{
964+
"type": "markdown",
965+
"url": "https://github.com/ARMmbed/mbed-studio-docs/blob/master/Docs/Including-libraries.md"
966+
},
967+
{
968+
"type": "markdown",
969+
"url": "https://github.com/ARMmbed/mbed-studio-docs/blob/master/Docs/Working-with-source-control.md"
970+
},
971+
{
972+
"type": "markdown",
973+
"url": "https://github.com/ARMmbed/mbed-studio-docs/blob/master/Docs/Getting-your-program-on-an-Mbed-platform.md"
974+
},
975+
{
976+
"type": "markdown",
977+
"url": "https://github.com/ARMmbed/mbed-studio-docs/blob/master/Docs/Debugging.md"
978+
}]
959979
},
960980
{
961981
"title": "Developing: Mbed CLI",
@@ -1200,6 +1220,14 @@
12001220
}
12011221
]
12021222
},
1223+
{
1224+
"title": "Integrating with Arm Treasure Data",
1225+
"intro": {
1226+
"type": "markdown",
1227+
"url": "https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/tutorials/treasure_data.md"
1228+
},
1229+
"sources": []
1230+
},
12031231
{
12041232
"title": "Migrating to Mbed OS 5",
12051233
"intro": {
@@ -1417,11 +1445,14 @@
14171445
"type": "markdown",
14181446
"url": "https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/porting/target/Watchdog.md"
14191447
},
1420-
14211448
{
14221449
"type": "markdown",
14231450
"url": "https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/porting/target/itm.md"
14241451
},
1452+
{
1453+
"type": "markdown",
1454+
"url": "https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/porting/target/mpu.md"
1455+
},
14251456
{
14261457
"type": "markdown",
14271458
"url": "https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/porting/target/usb.md"
@@ -1540,6 +1571,15 @@
15401571
"source": "https://github.com/ARMmbed/mbed-os",
15411572
"branch": "feature-hal-spec-sai"
15421573
},
1574+
{
1575+
"title": "feature-hal-spec-spi doxygen",
1576+
"description": "The full mbed OS API documentation in doxygen format",
1577+
"slug": "feature-hal-spec-spi-doxy",
1578+
"hidden": true,
1579+
"type": "doxygen",
1580+
"source": "https://github.com/ARMmbed/mbed-os",
1581+
"branch": "feature-hal-spec-spi"
1582+
},
15431583
{
15441584
"title": "feature-hal-spec-watchdog doxygen",
15451585
"description": "The full mbed OS API documentation in doxygen format",

docs/api/bluetooth/SecurityManager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The SecurityManager communicates with your application through events. These tri
3838

3939
The most important process is pairing. You may trigger this manually by calling `requestPairing()`. Pairing may also result from the application requiring encryption by calling `setLinkEncryption()` or the application requiring MITM protection through `requestAuthentication()`.
4040

41-
You can call all of these implicitly by using `setLinkSecurity()` to set the required security for the link. The SecurityManager triggers the process required to achieve the set security level. You can only escalate the security level. Asking the SecurityManager for a lower security level than the existing one does not fail but results in a event informing the application through `linkEncryptionResult()` of the current level, (which remains unchanged).
41+
You can call all of these implicitly by using `setLinkSecurity()` to set the required security for the link. The SecurityManager triggers the process required to achieve the set security level. You can only escalate the security level; asking the SecurityManager for a lower security level than the existing one does not fail, but results in an event informing the application through `linkEncryptionResult()` of the current level (which remains unchanged).
4242

4343
The chosen pairing algorithms depend on the IO capabilities and OOB use settings. They produce appropriate events, which your EventHandler must handle. If your event handler doesn't support all the calls, you must not set IO capabilities or set OOB use in such a way that would trigger them, or else the pairing fails (usually by timing out).
4444

docs/api/drivers/Timer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Timer
22

3-
<span class="images">![](https://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_timer.png)<span>Timer class hierarchy</span></span>
3+
<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/classmbed_1_1_timer.png)<span>Timer class hierarchy</span></span>
44

55
Use the Timer interface to create, start, stop and read a timer for measuring precise times (better than millisecond precision).
66

docs/api/lorawan/lorawan.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
<h2 id="lorawan-api">LoRaWAN network interface</h2>
22

3-
<span class="images">![](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_lo_ra_w_a_n_interface.png)<span>LoRaWANInterface class hierarchy</span></span>
3+
<span class="images">![](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_lo_ra_w_a_n_interface.png)<span>
4+
LoRaWANInterface class hierarchy</span></span>
45

5-
The [LoRaWANInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_lo_ra_w_a_n_interface.html) provides a C++ API for connecting to the internet over a LoRa network. This subsection explains the `LoRaWAnInterface` API reference and then presents an example that you can directly import to the Arm Mbed Online Compiler.
6+
The [LoRaWANInterface](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_lo_ra_w_a_n_interface.html) provides a C++ API for connecting to the internet over a LoRa network. This subsection explains the `LoRaWANInterface` API reference and then presents an example that you can directly import to the Arm Mbed Online Compiler.
67

78
To configure this class, please see the [LoRa configuration documentation](../reference/lorawan-configuration.html).
89

docs/api/networkinterfaces/MeshInterface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ See the example application [mbed-os-example-mesh-minimal](https://github.com/AR
4343

4444
The application below demonstrates a simple light control application, where devices can control the LED status of all devices in the network. You can build the application for the unsecure 6LoWPAN-ND or Thread network.
4545

46-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-mesh-minimal)](https://github.com/ARMmbed/mbed-os-example-mesh-minimal/blob/mbed-os-5.10.0/main.cpp)
46+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-mesh-minimal)](https://github.com/ARMmbed/mbed-os-example-mesh-minimal/blob/mbed-os-5.10.0/mesh_led_control_example.cpp)
4747

4848
### Related content
4949

docs/api/networkinterfaces/WifiInterface.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
## Wi-Fi
22

3+
<span class="images">![](http://os.mbed.com/docs/development/mbed-os-api-doxy/class_wi_fi_interface.png)<span>WiFiInterface class hierarchy</span></span>
4+
35
The WifiInterface provides a simple C++ API for connecting to the internet over a Wi-Fi device.
46

57
### Wi-Fi class reference
68

7-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/_wi_fi_interface_8h_source.html)
9+
[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/class_wi_fi_interface.html)
810

911
### Usage
1012

@@ -54,11 +56,11 @@ Please note that settings should match the security mode from the access point.
5456

5557
### Wi-Fi example
5658

57-
Here is an example of an HTTP client program. The program brings up an ESP8266 as the underlying network interface, and uses it to perform an HTTP transaction over a TCPSocket. There are multiple [Wi-Fi components](https://os.mbed.com/components/cat/wifi/) that implement the WiFiInterface class. The example below uses the [ESP8266Interface](https://github.com/armmbed/esp8266-driver) and [OdinWiFiInterface](https://github.com/u-blox/ublox-odin-w2-drivers-docs-mbed-5).
59+
This program scans for Wi-Fi access points in the area. There are multiple [Wi-Fi components](https://os.mbed.com/components/cat/wifi/) that implement the WiFiInterface class. The example below uses the [ESP8266Interface](https://github.com/armmbed/esp8266-driver) and [OdinWiFiInterface](https://github.com/u-blox/ublox-odin-w2-drivers-docs-mbed-5).
5860

5961
The ESP8266Interface uses AT commands over serial interface to connect to an external Wi-Fi device. The OdinWiFiInterface provides an Ethernet-like driver to the Mbed OS network stack. The network stack uses the driver to connect to Wi-Fi:
6062

61-
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-wifi)](https://github.com/ARMmbed/mbed-os-example-wifi/blob/mbed-os-5.10.0/main.cpp)
63+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-wifi)](https://github.com/ARMmbed/mbed-os-example-wifi/blob/master/main.cpp)
6264

6365
### Related content
6466

docs/api/networksocket/DNS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Callback is called from thread context. If the callback takes more than 10ms to
3838

3939
### DNS resolver class reference
4040

41-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/_d_n_s_8h_source.html)
41+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_d_n_s.html)
4242

4343
### DNS resolver example
4444

docs/api/networksocket/DTLSSocket.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@ To use secure DTLS connections, application use the `DTLSSocketWrapper` through
1010

1111
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_d_t_l_s_socket.html)
1212

13+
### DTLSSocket example
14+
15+
Please see the TLSSocket example:
16+
17+
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-tls-socket/blob/master/)](https://github.com/ARMmbed/mbed-os-example-tls-socket/blob/master/main.cpp)
18+
1319
### Related content
1420

15-
- [Secure Socket](../reference/secure-socket.html)
16-
- [TLSSocket](tlssocket.html)
21+
- [Secure Socket](../reference/secure-socket.html).
22+
- [TLSSocket](tlssocket.html).

docs/api/networksocket/SocketAddress.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Use the SocketAddress class to represent the IP address and port pair of a uniqu
44

55
### SocketAddress class reference
66

7-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/_socket_address_8h_source.html)
7+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/class_socket_address.html)
88

99
### SocketAddress example
1010

docs/api/platform/Error.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,17 @@ Mbed OS provides the necessary functions and macros for implementations to const
104104

105105
If you know the module reporting the error you can use the **MBED_MAKE_ERROR()** macro to construct an error status with the module information. For example, if you want to report an unsupported configuration error from the serial driver, you may construct the error status as follows to capture the module information along with a specific error code. The below example constructs an error status value with the error code set to `MBED_ERROR_CODE_CONFIG_UNSUPPORTED` from the serial driver, indicated by module information set to `MBED_MODULE_DRIVER_SERIAL`.
106106

107-
```mbed_error_status_t error = MBED_MAKE_ERROR(MBED_MODULE_DRIVER_SERIAL, MBED_ERROR_CODE_CONFIG_UNSUPPORTED)```
107+
```
108+
mbed_error_status_t error = MBED_MAKE_ERROR(MBED_MODULE_DRIVER_SERIAL, MBED_ERROR_CODE_CONFIG_UNSUPPORTED)
109+
```
108110

109111
There may be scenarios in which the module might have called an API exported from other modules, such as protocol stacks, but has received an error status in return. In those cases, the calling module doesn't know which of the lower layers raised the error, but you may still want to report the error. In those cases, the module can use the predefined error status, such as `MBED_ERROR_CONFIG_UNSUPPORTED`, with the module value already set to `MBED_MODULE_UNKNOWN`.
110112

111113
This is equivalent to defining an error status with `MODULE_UNKNOWN`. However, using predefined values, such as `MBED_ERROR_CONFIG_UNSUPPORTED`, makes it more convenient and easier to read the implementation.
112114

113-
```mbed_error_status_t error = MBED_MAKE_ERROR(MBED_MODULE_UNKNOWN, MBED_ERROR_CODE_CONFIG_UNSUPPORTED)```
115+
```
116+
mbed_error_status_t error = MBED_MAKE_ERROR(MBED_MODULE_UNKNOWN, MBED_ERROR_CODE_CONFIG_UNSUPPORTED)
117+
```
114118

115119
### Error history
116120

@@ -134,7 +138,9 @@ Some applications may want to do custom error handling when an error is reported
134138

135139
Whenever a fatal error happens in the system, the Mbed OS error handling system collects key information such as error code, error location, register context (in the case of fault exceptions) and so on. The error handing system stores that information in a reserved RAM region called Crash-data-RAM. The error information stored in Crash-data-RAM is in binary format and follows the `mbed_error_ctx` structure defined in `mbed_error.h`. The system then triggers a warm-reset without losing the RAM contents that store the error information. After the system reboots, during Mbed OS initialization, the Crash-data-RAM region is checked to find if there is valid error information captured. This is done by using a CRC value calculated over the stored error information and is appended as part of information stored in Crash-data-RAM. If the system detects that the reboot was triggered by a fatal error, it will invoke a callback function with a pointer to the error context structure stored in Crash-data-RAM. The default callback function is defined with the `WEAK` attribute, which the application can override. Below is the signature for the callback:
136140

137-
```void mbed_error_reboot_callback(mbed_error_ctx *error_context);```
141+
```
142+
void mbed_error_reboot_callback(mbed_error_ctx *error_context);
143+
```
138144

139145
<span class="notes">**Note:** This callback is invoked before the system starts executing the application `main()`. The implementation of callback should be aware any resource limitations or availability. Also, the callback is invoked only when there is a new error.</span>
140146

@@ -157,7 +163,7 @@ See `mbed_lib.json` in the platform directory to see which targets are currently
157163

158164
It's important that this region is marked with the appropriate attributes (based on the toolchain) to mark it as an uninitialized region. For example, you can mark the ARM Compiler Crash-data-RAM with the attribute *EMPTY*. The only requirement about the placement of this region is that no other entity can overwrite this region during reboot or at runtime. However, to avoid fragmentation, it's best if you place this region just after the vector table region, or if there is no vector table region, iat the bottom of RAM (lowest address).
159165

160-
See [memory model](memory.html) for more info on the placement of this region.
166+
See [memory model](../reference/memory.html) for more info on the placement of this region.
161167

162168
#### Configuring crash reporting and autoreboot
163169

docs/api/platform/platform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Mbed OS includes a few convenience classes that are tailored for embedded system
2727

2828
- [Callback](callback.html): An API that executes the user’s code in its own context. Many other Mbed OS APIs build on the Callback API by taking a callback to execute.
2929
- [Time](time.html): A group of functions in the standard library of the C programming language implementing date and time manipulation operations.
30-
- [Error](error-handling.html): A functions that generates a fatal runtime error.
30+
- [Error](../apis/error-handling.html): A functions that generates a fatal runtime error.
3131
- [NonCopyable](noncopyable.html): An API that tags a class as not supporting copy operations. It creates a compile-time error if you copy the object.
3232
- [Span](span.html): A nonowning view to a sequence of contiguous elements. It can replace the traditional pair of pointer and size arguments passed as array definitions in function calls.
3333

docs/api/rtos/rtos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ Each `Thread` can wait for signals and be notified of events:
5858

5959
##### Status and error codes
6060

61-
The Mbed OS error handling system assigns specific error codes for RTOS-related errors. See [the error handling documentation](error-handling.html) for more information on RTOS errors reported.
61+
The Mbed OS error handling system assigns specific error codes for RTOS-related errors. See [the error handling documentation](../apis/error-handling.html) for more information on RTOS errors reported.

0 commit comments

Comments
 (0)