Skip to content

Commit 5749518

Browse files
committed
Merge branch 'development' of https://github.com/ARMmbed/mbed-os-5-docs into development
2 parents 2762e2c + dfc08f2 commit 5749518

File tree

8 files changed

+31
-22
lines changed

8 files changed

+31
-22
lines changed

docs.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1553,6 +1553,15 @@
15531553
"source": "https://github.com/ARMmbed/mbed-os",
15541554
"branch": "feature-hal-spec-sai"
15551555
},
1556+
{
1557+
"title": "feature-hal-spec-spi doxygen",
1558+
"description": "The full mbed OS API documentation in doxygen format",
1559+
"slug": "feature-hal-spec-spi-doxy",
1560+
"hidden": true,
1561+
"type": "doxygen",
1562+
"source": "https://github.com/ARMmbed/mbed-os",
1563+
"branch": "feature-hal-spec-spi"
1564+
},
15561565
{
15571566
"title": "feature-hal-spec-watchdog doxygen",
15581567
"description": "The full mbed OS API documentation in doxygen format",

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/introduction/introduction.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,17 @@ This is the technical documentation for Mbed OS. We have three types of document
7676
Please see the following sections of our documentation for more information.
7777

7878
- [APIs](../apis/index.html).
79-
- [Reference](../reference/index.html), which contains architectural information about our code.
79+
- [Quick start](../quick-start/index.html), a guide to creating your first application.
80+
- [Reference](../reference/index.html), architectural information about our code.
8081
- [Tools](../tools/index.html), reference material about the tools Mbed OS uses.
8182
- [Tutorials](../tutorials/index.html).
83+
- [Going to production](../evaluation-production/index.html), the process of connecting Mbed OS devices to Pelion Device Management for large-scale production.
84+
- [Contributing](../contributing/index.html), guidelines about contributing to our open-source project.
8285
- [Porting guides](../porting/index.html), for Partners and developers interested in porting targets to Mbed OS.
8386

8487
### Recently updated documentation
8588

86-
* An updated [contributing guide](../contributing/index.html).
87-
* A revised [porting guide](../porting/index.html).
88-
* A [review of the full process of taking a project to production](./evaluation-production/index.html).
89-
* An updated [quick start](../quick-start/index.html) to demonstrate more Mbed OS capabilities.
89+
- An updated [contributing guide](../contributing/index.html).
90+
- A revised [porting guide](../porting/index.html).
91+
- A [review of the full process of taking a project to production](./evaluation-production/index.html).
92+
- An updated [quick start](../quick-start/index.html) to demonstrate more Mbed OS capabilities.

docs/porting/porting_full_process/demo_testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Then, test connectivity and firmware update:
9292
9393
- If your target uses WiFi, fill in the SSID and Password fields in `mbed_app.json`.
9494
95-
- Add NVStore descriptors (previously known as SOTP) for storage to `mbed-cloud-client-example/mbed_lib.json`. For example:
95+
- Add [NVStore descriptors (previously known as SOTP)](https://cloud.mbed.com/docs/porting/porting-a-new-target-for-mbed-os.html) for storage to `mbed-cloud-client-example/mbed_lib.json`. For example:
9696
9797
```
9898
...

docs/reference/technology/connectivity/NFC.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ NFC offers three modes:
1818

1919
Mbed OS supports the card emulation mode, either through the use of a controller or NFC EEPROM.
2020

21-
NFC support is available for the NXP PN512 transceiver. In terms of NFC EEPROMs, a driver for the ST M24SR EEPROM series is available - we also provide a [porting guide](https://os.mbed.com/contributing/connectivity/NFCEEPROMDriver.html) to add support for other NFC EEPROMs.
21+
NFC support is available for the NXP PN512 transceiver. In terms of NFC EEPROMs, a driver for the ST M24SR EEPROM series is available - we also provide a [porting guide](../porting/NFC-port.html) to add support for other NFC EEPROMs.
2222

2323
We also provide APIs to decode and encode NDEF messages. A NDEF message is a standardized encoding that most NFC devices, such as Android and iOS smartphones, can understand.
2424

@@ -40,7 +40,7 @@ NFC EEPROMs behave like NFC tags whose memory can either be addressed through a
4040

4141
### Getting started with NFC and example
4242

43-
NFC examples are available on [GitHub](https://github.com/ARMmbed/mbed-os-example-nfc) and demonstrate how to create NFC tags that you can be read from and write to using a phone.
43+
NFC examples are available on [GitHub](https://github.com/ARMmbed/mbed-os/tree/master/docs/design-documents/nfc) and demonstrate how to create NFC tags that you can be read from and write to using a phone.
4444

4545
<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/explorenfc_nucleo.jpg)<span>An Explore-NFC board attached to a Nucleo board</span></span>
4646

docs/reference/technology/mesh/thread_commissioning.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A model network setup could look like this:
1818

1919
#### Building the end node application
2020

21-
By default, the Mbed Thread applications/examples use the static network link configuration defined in the [mesh-api configuration file](https://github.com/ARMmbed/mbed-os/blob/master/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed_lib.json). If you want to use the Thread commissioning, add the following lines to your `.json` file. You can use the [mesh-minimal](https://github.com/ARMmbed/mbed-os-example-mesh-minimal) application as an example.
21+
By default, the Mbed Thread applications/examples use the static network link configuration defined in the [mesh-api configuration file](https://github.com/ARMmbed/mbed-os/blob/master/features/nanostack/mbed-mesh-api/mbed_lib.json). If you want to use the Thread commissioning, add the following lines to your `.json` file. You can use the [mesh minimal](../apis/mesh-api.html#mesh-example) application as an example.
2222

2323
- `"mbed-mesh-api.thread-use-static-link-config": false` under `"target_overrides":`
2424
- `"macros": ["MBEDTLS_USER_CONFIG_FILE=\"mbedtls_config.h\""]` in to the same level as `"config":` and `"target_overrides":`
@@ -35,14 +35,12 @@ Once the binary is generated, flash the binary to the end device, and run the ap
3535

3636
You can use [a free online tool](http://www.qr-code-generator.com/) to generate a QR code.
3737

38-
In the online tool, fill in the URL field. The following is an example: `v=1&eui=000b57fffe07a8be&cc=PV7TUCB0`. Fill in the correct values for your device, and ensure `v=1` is always present. The other required parameters are:
38+
In the online tool, fill in the URL field. The following is an example: `v=1&eui=000b57fffe07a8be&cc=ABCDEFGH`. Fill in the correct values for your device, and ensure `v=1` is always present. The other required parameters are:
3939

4040
- `cc` is the PSKd, which is configured in the `.json` file (see the mesh-api configuration). *PSKd must be uppercase characters (0-9, A-Y excluding I,O,Q and Z)*
41-
- `eui` is equal to the RF MAC address by default.
41+
- `eui` is equal to the EUI64 address.
4242

43-
To get the MAC address for your end device, connect the node to the Thread network with static configuration enabled. In other words, `"mbed-mesh-api.thread-use-static-link-config": true`, unless you have your own configuration for the MAC address.
44-
45-
For example, in the **mesh-minimal** application, place this `printf("MAC address = %s\n", mesh.get_mac_address());` after `printf("connected. IP = %s\n", mesh.get_ip_address());`
43+
You can get the EUI64 address for your end device by using the `device_eui64_get` method in your application. Please see the [mesh minimal example](../apis/mesh-api.html#mesh-example) for details.
4644

4745
There are four additional (optional) query parameters you can put into this field:
4846

docs/reference/technology/mesh/thread_faq.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,11 @@ Ad-hoc networks with devices from different manufacturers can be easily created
3232

3333
An example application is [downloadable from the Android store](https://play.google.com/store/apps/details?id=org.threadgroup.commissioner).
3434

35-
#### Are there any application examples? What are the Thread features supported/not supported by them?
35+
#### Are there any application examples?
3636

37-
- Application examples supporting SED and REED types:
38-
- [Mbed OS Client example](https://github.com/ARMmbed/mbed-os-example-client).
39-
- [Mesh minimal example](https://github.com/ARMmbed/mbed-os-example-mesh-minimal).
37+
- [Mesh minimal example](../apis/mesh-api.html#mesh-example).
4038
- [Thread border router](https://github.com/ARMmbed/nanostack-border-router).
39+
- [Device Management client example](https://github.com/ARMmbed/mbed-cloud-client-example).
4140

4241
#### How to debug and visualize the network?
4342

@@ -50,7 +49,7 @@ Link quality and errors are easiest to debug using Wireshark.
5049

5150
#### How to send/receive with UDP and TCP sockets. How to use multicast groups?
5251

53-
The mesh minimal uses socket communication and multicasting. See more details in the [mesh minimal example](https://github.com/ARMmbed/mbed-os-example-mesh-minimal).
52+
The mesh minimal uses socket communication and multicasting. See more details in the [mesh minimal example](../apis/mesh-api.html#mesh-example).
5453

5554
#### What if my ISP does not provide IPv6 service? Why do I need IPv6 internet service? Can I use a tunneling service?
5655

docs/reference/technology/mesh/thread_intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ The key elements of Mbed OS are:
3333

3434
Mbed Thread is implemented in the Nanostack library, which also supports the 6LoWPAN protocol. In Mbed OS, the Thread stack runs in its own RTOS thread using an internal event scheduler. Mbed OS provides the [Mesh C++ API](../apis/mesh-api.html) for building Thread applications.
3535

36-
- To connect to the Thread network, use the [Thread interface API](https://github.com/ARMmbed/mbed-os/blob/master/features/nanostack/FEATURE_NANOSTACK/mbed-mesh-api/mbed-mesh-api/ThreadInterface.h).
36+
- To connect to the Thread network, use the [Mbed Mesh API](../apis/mesh-api.html) or [Thread interface API](https://github.com/ARMmbed/mbed-os/blob/master/features/nanostack/mbed-mesh-api/mbed-mesh-api/ThreadInterface.h).
3737
- For the socket communication over the Thread network, use the [Mbed sockets API](../apis/network-socket.html).
3838

39-
Nanostack provides a set of C API headers with more functionalities. The [nanostack repository](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/FEATURE_NANOSTACK/sal-stack-nanostack/nanostack) has the following header files():
39+
Nanostack provides a set of C API headers with more functionalities. The [nanostack repository](https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/sal-stack-nanostack/nanostack) has the following header files:
4040

4141
- `thread_management_if.h` for initializing the stack and managing the network data.
4242
- `thread_commissioning_api.h` for implementing an on-mesh or a native Thread commissioner.

0 commit comments

Comments
 (0)