Skip to content

Commit b52867b

Browse files
author
Deepika
authored
Merge branch 'new_engine' into patch-1
2 parents 61809c8 + ddc9491 commit b52867b

File tree

188 files changed

+2420
-1539
lines changed

Some content is hidden

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

188 files changed

+2420
-1539
lines changed

docs.json

Lines changed: 849 additions & 331 deletions
Large diffs are not rendered by default.

docs/images/Thread_network_setup.PNG

37.7 KB
Loading

docs/introduction/introduction.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,53 +6,53 @@ Your application code is written in C and C++. It uses the *application programm
66

77
#### Where to start
88

9-
<span class="tips">If you're working on Windows, you might need to <a href="/docs/v5.6/tutorials/windows-serial-driver.html" target="_blank">install a serial driver</a>.</span>
9+
<span class="tips">If you're working on Windows, you might need to [install a serial driver](/docs/v5.7/tutorials/windows-serial-driver.html).
1010

11-
The easiest way to work with Mbed OS is using one of our development tools. We've set up an example, <a href="/docs/v5.6/tutorials/your-first-arm-mbed-application.html" target="_blank">Blinky</a>, that you can try on each of the tools. Blinky teaches you to build and run an application on your board.
11+
The easiest way to work with Mbed OS is using one of our development tools. We've set up an example, [Blinky](/docs/v5.7/tutorials/your-first-program.html), that you can try on each of the tools. Blinky teaches you to build and run an application on your board.
1212

13-
Once you know how to build an existing application, it's time to learn <a href="/docs/v5.6/reference/index.html" target="_blank">how to write your own applications</a>.
13+
Once you know how to build an existing application, it's time to learn [how to write your own applications](/docs/v5.7/reference/index.html).
1414

1515
##### Development tools
1616

17-
- Our offline development tool is <a href="/docs/v5.6/tools/mbed-cli.html" target="_blank">Arm Mbed CLI</a>, a command-line tool. This requires having a toolchain installed on your computer.
18-
- The <a href="/docs/v5.6/tools/arm-mbed-online-compiler.html" target="_blank">Arm Mbed Online Compiler</a> lets you write and build applications using a web browser.
19-
- If you're working with third party tools, look at <a href="/docs/v5.6/tools/exporting.html" target="_blank">exporting instructions for the most popular ones</a>.
17+
- Our offline development tool is [Arm Mbed CLI](/docs/v5.7/tools/arm-mbed-cli.html), a command-line tool. This requires having a toolchain installed on your computer.
18+
- The [Arm Mbed Online Compiler](/docs/v5.7/tools/arm-online-compiler.html) lets you write and build applications using a web browser.
19+
- If you're working with third party tools, look at [exporting instructions for the most popular ones](/docs/v5.7/tools/exporting.html).
2020

2121
##### Communicating with and monitoring your board
2222

23-
You can <a href="/docs/v5.6/tutorials/serial-communication-overview.html" target="_blank">monitor and control an Mbed board</a> to help you debug and test your applications.
23+
You can [monitor and control an Mbed board](/docs/v5.7/tutorials/serial-comm.html) to help you debug and test your applications.
2424

25-
<span class="tips">**Tip:** Learn more about debugging in the <a href="/docs/v5.6/tutorials/debugging-applications.html" target="_blank">debugging applications section</a>.</span>
25+
<span class="tips">**Tip:** Learn more about debugging in the [debugging applications section](/docs/v5.7/tutorials/debugging-applications.html).</span>
2626

2727
#### How to continue
2828

2929
When you've started writing applications using your selected development tool:
3030

31-
- Learn about <a href="/docs/v5.6/tools/collab-online-comp.html" target="_blank">collaborative work and version control</a>.
32-
- Try one of the <a href="/docs/v5.6/tutorials/index.html" target="_blank">tutorials</a>, which cover concepts such as debugging and memory tracing.
33-
- Ask questions and give advice on the <a href="https://os.mbed.com/forum/" target="_blank">forum</a>.
31+
- Learn about [collaborative work and version control](/docs/v5.7/tools/collab-online-comp.html).
32+
- Try one of the [tutorials](/docs/v5.7/tutorials/index.html), which cover concepts such as debugging and memory tracing.
33+
- Ask questions and give advice on the [forum](https://os.mbed.com/forum/).
3434

3535
#### Contributing to Mbed OS
3636

37-
If you want to contribute to the `mbed-os` codebase, please see <a href="/docs/v5.6/reference/contributing-overview.html" target="_blank">the contribution section</a>.
37+
If you want to contribute to the `mbed-os` codebase, please see [the contribution section](/docs/v5.7/reference/contributing.html).
3838

39-
You can find past releases and the current release on <a href="https://github.com/ARMmbed/mbed-os/releases/" target="_blank">GitHub</a>.
39+
You can find past releases and the current release on [GitHub](https://github.com/ARMmbed/mbed-os/releases/).
4040

4141
#### Porting to Mbed OS
4242

4343
Our full contributing guide is still being written. For now, we have:
4444

45-
- A guide to <a href="/docs/v5.6/reference/contributing-target.html" target="_blank">contributing targets</a>.
46-
- Information about the <a href="/docs/v5.6/reference/contributing-tools.html" target="_blank">tools you need to contribute targets</a>.
47-
- APIs about <a href="/docs/v5.6/reference/contributing-storage.html" target="_blank">storage</a> and <a href="/docs/v5.6/reference/contributing-connectivity.html" target="_blank">connectivity</a> in relation to porting.
45+
- A guide to [contributing targets](/docs/v5.7/reference/contributing-target.html).
46+
- Information about the [tools you need to contribute targets](/docs/v5.7/reference/contributing-tools.html).
47+
- APIs about [storage](/docs/v5.7/reference/contributing-storage.html) and [connectivity](/docs/v5.7/reference/contributing-connectivity.html) in relation to porting.
4848

4949
## How Mbed works
5050

5151
The Arm Mbed hardware architecture is designed to make sure you have all the tools and utilities to be productive. Most boards have an integrated debug circuit that assists development by programming the device, logging program execution and giving access to the debug access port. Here is how it works.
5252

5353
#### Architecture diagram
5454

55-
This is the basic architecture of an <a href="/docs/v5.6/introduction/how-mbed-works.html" target="_blank">Mbed board</a>:
55+
This is the basic architecture of an Mbed board:
5656

5757
<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/mbed_internal.png)<span>A sketch of a typical Mbed board's hardware architecture</span></span>
5858

@@ -73,7 +73,7 @@ The `.bin` files the Mbed microcontroller accepts are standard raw binaries. Use
7373

7474
#### The Arm Mbed interface
7575

76-
You can find more information about the Mbed interface and the circuits on which it runs in the <a href="/docs/v5.6/reference/contributing-tools.html#arm-mbed-hdk" target="_blank">HDK reference manual</a> or on the <a href="https://github.com/ARMmbed/DAPLink/blob/master/README.md" target="_blank">DAPLink GitHub page</a>. The HDK includes reference circuits you can use to create your own boards, and DAPLink is the firmware that runs on these circuits.
76+
You can find more information about the Mbed interface and the circuits on which it runs in the [HDK reference manual](/docs/v5.7/reference/contributing-tools.html#arm-mbed-hdk) or on the [DAPLink page](/docs/v5.7/tools/daplink.html). The HDK includes reference circuits you can use to create your own boards, and DAPLink is the firmware that runs on these circuits.
7777

7878
#### Connectivity
7979

docs/introduction/terms.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,49 +2,49 @@
22

33
### A
44

5-
**API** - [Application programming interface](/docs/v5.6/reference/api-overview.html).
5+
**API** - [Application programming interface](/docs/v5.7/reference/apis.html).
66

77
**Application** - An executable module built out of libraries that acts as a final product.
88

9-
**Arm Mbed CLI** - The name of the Arm Mbed [command-line tool](/docs/v5.6/tools/mbed-cli.html), packaged as `mbed-cli`.
9+
**Arm Mbed CLI** - The name of the Arm Mbed [command-line tool](/docs/v5.7/tools/arm-mbed-cli.html), packaged as `mbed-cli`.
1010

11-
**Arm Mbed interface** - The extra chip that sits on all [Mbed Enabled development boards](/docs/v5.6/introduction/how-mbed-works.html#architecture-diagram). It's what makes the target chip (for example, K64F) look like a USB drive. It usually runs a separate piece of software that generally doesn't change. That software is usually `DAPLink`, `CMSIS-DAP` or `STLink`.
11+
**Arm Mbed interface** - The extra chip that sits on all [Mbed Enabled development boards](/docs/v5.7/introduction/index.html). It's what makes the target chip (for example, K64F) look like a USB drive. It usually runs a separate piece of software that generally doesn't change. That software is usually `DAPLink`, `CMSIS-DAP` or `STLink`.
1212

13-
**Arm Mbed Online Compiler** - [Arm’s online tool](/docs/v5.6/tools/arm-mbed-online-compiler.html), which you can use to create and compile your code.
13+
**Arm Mbed Online Compiler** - [Arm’s online tool](/docs/v5.7/tools/arm-online-compiler.html), which you can use to create and compile your code.
1414

1515
**Arm Mbed OS** - Arm's [platform operating system](https://os.mbed.com/docs) for the Internet of Things.
1616

17-
**Arm Mbed TLS** - A [comprehensive SSL/TLS solution](/docs/v5.6/reference/tls.html) that makes it easy for developers to include cryptographic and SSL/TLS capabilities in their software and embedded products. As an SSL library, it provides an intuitive API, readable source code and a minimal and highly configurable code footprint.
17+
**Arm Mbed TLS** - A [comprehensive SSL/TLS solution](/docs/v5.7/reference/tls.html) that makes it easy for developers to include cryptographic and SSL/TLS capabilities in their software and embedded products. As an SSL library, it provides an intuitive API, readable source code and a minimal and highly configurable code footprint.
1818

19-
**Arm Mbed uVisor** - A self-contained [software hypervisor](/docs/v5.6/reference/tls.html#uVisor) that creates independent secure domains on ARM Cortex-M3 and M4 micro-controllers.
19+
**Arm Mbed uVisor** - A self-contained [software hypervisor](/docs/v5.7/reference/tls.html#uVisor) that creates independent secure domains on ARM Cortex-M3 and M4 micro-controllers.
2020

2121
### B
2222

2323
**Bit** - A basic unit of digital information that can be one of two values: `0` (`false`) or `1` (`true`).
2424

25-
**BLE** - [Bluetooth Low Energy](/docs/v5.6/reference/ble.html).
25+
**BLE** - [Bluetooth Low Energy](/docs/v5.7/reference/ble.html).
2626

27-
**Blinky** - An [example application](/docs/v5.6/tutorials/your-first-arm-mbed-application.html) that you can use to get to know Arm Mbed OS and the development tools. It’s one of the simplest examples of Mbed OS.
27+
**Blinky** - An [example application](/docs/v5.7/tutorials/your-first-program.html) that you can use to get to know Arm Mbed OS and the development tools. It’s one of the simplest examples of Mbed OS.
2828

29-
**Block Device** - A [file](/docs/v5.6/reference/contributing-storage.html#block-devices) that represents a device, with data that can be read or written to it in blocks.
29+
**Block Device** - A [file](/docs/v5.7/reference/contributing-storage.html#block-devices) that represents a device, with data that can be read or written to it in blocks.
3030

3131
**Board** - An Mbed Enabled development board. You can see a [complete list](https://os.mbed.com/platforms/) of Mbed Enabled boards.
3232

3333
**Boolean** - A binary variable, having two possible values called `true` and `false`.
3434

35-
**Bootloader** - [The program](/docs/v5.6/tutorials/creating-and-using-a-bootloader.html) that loads Mbed OS when a board is turned on.
35+
**Bootloader** - [The program](/docs/v5.7/tutorials/bootloader.html) that loads Mbed OS when a board is turned on.
3636

37-
**Build Profile** - Mbed OS 5 supports three primary [build profiles](/docs/v5.6/tools/mbed-cli.html#build-profiles): develop, debug and release.
37+
**Build Profile** - Mbed OS 5 supports three primary [build profiles](/docs/v5.7/tools/build-profiles.html): develop, debug and release.
3838

3939
**Build Script** - A build automation and generation utility.
4040

4141
**Byte** - A unit of digital information that consists of 8 bits (see `Bit`).
4242

4343
### C
4444

45-
**Callback** - Any [executable code](/docs/v5.6/reference/callback.html) that is passed as an argument to other code, which is expected to call back (execute) the argument at a given time.
45+
**Callback** - Any [executable code](/docs/v5.7/reference/callback.html) that is passed as an argument to other code, which is expected to call back (execute) the argument at a given time.
4646

47-
**CAN** - [Controller-area network](/docs/v5.6/reference/can.html).
47+
**CAN** - [Controller-area network](/docs/v5.7/reference/can.html).
4848

4949
**Class** - An extensible program-code-template for creating objects, providing initial values for state and implementations of behavior.
5050

@@ -58,29 +58,29 @@
5858

5959
**DAPLink** - An Arm maintained [project](https://github.com/mbedmicro/DAPLink) that is under active development.
6060

61-
**Debugging** - The [process](/docs/v5.6/tools/debugging.html) of finding and solving problems in code.
61+
**Debugging** - The [process](/docs/v5.7/tools/debugging.html) of finding and solving problems in code.
6262

6363
**Deprecation** - Marking a piece of code as out of date. You should not write new code that depends on deprecated APIs. We will remove deprecated APIs when our code no longer depends on them.
6464

6565
### E
6666

67-
**Exporter** - Use the Arm Mbed [exporters](/docs/v5.6/tools/exporting.html#about-the-exporters) to export your code to various third party tools and IDEs.
67+
**Exporter** - Use the Arm Mbed [exporters](/docs/v5.7/tools/exporting.html#about-the-exporters) to export your code to various third party tools and IDEs.
6868

6969
### G
7070

7171
**GitHub** - A web-based [Git development platform](https://github.com/armmbed/mbed-os) for version-controlled repositories.
7272

7373
**GPIO** - General-purpose input/output, a generic pin that is controllable by the user at run-time.
7474

75-
**Greentea** - **G**eneric **re**gression **en**vironment for **te**st **a**utomation. [Greentea](/docs/v5.6/tools/tools-testing.html#greentea) is the automated testing tool for Arm Mbed OS development.
75+
**Greentea** - **G**eneric **re**gression **en**vironment for **te**st **a**utomation. [Greentea](/docs/v5.7/tools/greentea.html) is the automated testing tool for Arm Mbed OS development.
7676

7777
### H
7878

7979
**htrun** - An Mbed OS command used to drive test binary flashing, device reset and test execution.
8080

8181
### I
8282

83-
**I2C** - [Interintegrated Circuit](/docs/v5.6/reference/i2c.html) (short-distance, intraboard communication).
83+
**I2C** - [Interintegrated Circuit](/docs/v5.7/reference/i2c.html) (short-distance, intraboard communication).
8484

8585
**IDE** - Integrated Development Environment.
8686

@@ -118,13 +118,13 @@
118118

119119
**REST** - Representational State Transfer (API).
120120

121-
**RTOS** - [Real-Time Operating System](/docs/v5.6/reference/rtos-api.html).
121+
**RTOS** - [Real-Time Operating System](/docs/v5.7/reference/rtos.html).
122122

123123
### S
124124

125-
**Serial** - A [protocol](/docs/v5.6/reference/serial.html) used in data transmission for the transfer of individual bits of information.
125+
**Serial** - A [protocol](/docs/v5.7/reference/serial.html) used in data transmission for the transfer of individual bits of information.
126126

127-
**SPI** - [Serial Peripheral Interface](/docs/v5.6/reference/spi.html).
127+
**SPI** - [Serial Peripheral Interface](/docs/v5.7/reference/spi.html).
128128

129129
**Static Memory** - The allocation of memory at compile time, before the program is executed.
130130

@@ -134,16 +134,16 @@
134134

135135
### T
136136

137-
**Target** - See [`board`](/docs/v5.6/introduction/glossary.html#board).
137+
**Target** - See [`board`](/docs/v5.7/introduction/glossary.html#board).
138138

139-
**Terminal Application** - [Applications](/docs/v5.6/tutorials/serial-comm.html#using-terminal-applications) that run on your host PC that provide a window where your Mbed board can print and where you can type characters back to your board.
139+
**Terminal Application** - [Applications](/docs/v5.7/tutorials/serial-comm.html#using-terminal-applications) that run on your host PC that provide a window where your Mbed board can print and where you can type characters back to your board.
140140

141141
**TLS** - Transport Layer Security.
142142

143-
**Toolchain** - A [group of programming tools](/docs/v5.6/tools/exporting.html#setting-up-a-local-debug-toolchain).
143+
**Toolchain** - A [group of programming tools](/docs/v5.7/tools/exporting.html#setting-up-a-local-debug-toolchain).
144144

145145
**Travis CI** - a continuous integration service used to build and test software projects hosted at GitHub (see `GitHub`).
146146

147147
### U
148148

149-
**utest** - A [test harness](/docs/v5.6/tools/tools-testing.html#utest-asynchronous-c-test-harness) you can use to execute a specified series of (asynchronous) C++ test cases.
149+
**utest** - A [test harness](/docs/v5.7/tools/utest-asynchronous-c-test-harness.html) you can use to execute a specified series of (asynchronous) C++ test cases.

docs/reference/api/api.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## API overview
22

3-
The <a href="/docs/v5.6/introduction/glossary.html" target="_blank">APIs</a> in this document are organized by the feature, or group of features, they enable.
3+
The [APIs](/docs/v5.7/introduction/glossary.html) in this document are organized by the feature, or group of features, they enable.
44

5-
- <a href="/docs/v5.6/reference/platform.html" target="_blank">Platform</a>: platform modules that provide consistent user experience.
6-
- <a href="/docs/v5.6/reference/drivers.html" target="_blank">Drivers</a>: analog and digital input and outputs and digital interfaces.
7-
- <a href="/docs/v5.6/reference/rtos.html" target="_blank">RTOS</a>: handling tasks and events in Mbed OS.
8-
- <a href="/docs/v5.6/reference/network-socket.html" target="_blank">Network Socket</a>: network sockets, Ethernet, Wi-Fi, cellular and mesh networking.
9-
- <a href="/docs/v5.6/reference/bluetooth.html" target="_blank">Bluetooth</a>: bluetooth low energy.
10-
- <a href="/docs/v5.6/reference/security.html" target="_blank">Security</a>: working with Arm Mbed uVisor and Arm Mbed TLS in the context of Mbed OS.
11-
- <a href="/docs/v5.6/reference/storage.htmll" target="_blank">Storage</a>: working with the file system.
5+
- [Platform](/docs/v5.7/reference/platform.html): platform modules that provide consistent user experience.
6+
- [Drivers](/docs/v5.7/reference/drivers.html): analog and digital input and outputs and digital interfaces.
7+
- [RTOS](/docs/v5.7/reference/rtos.html): handling tasks and events in Mbed OS.
8+
- [Network Socket](/docs/v5.7/reference/network-socket.html): network sockets, Ethernet, Wi-Fi, cellular and mesh networking.
9+
- [Bluetooth](/docs/v5.7/reference/bluetooth.html): bluetooth low energy.
10+
- [Security](/docs/v5.7/reference/security.html): working with Arm Mbed uVisor and Arm Mbed TLS in the context of Mbed OS.
11+
- [Storage](/docs/v5.7/reference/storage.html): working with the file system.
1212

13-
We also provide guidelines for <a href="/docs/v5.6/reference/contributing.html" target="_blank">contributing to Mbed OS</a>.
13+
We also provide guidelines for [contributing to Mbed OS](/docs/v5.7/reference/contributing.html).

docs/reference/api/connectivity/bluetooth/BLE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
Bluetooth low energy (BLE) is a low power wireless technology standard for building personal area networks. Typical applications of BLE are health care, fitness trackers, beacons, smart home, security, entertainment, proximity sensors, industrial and automotive.
44

5-
Arm Mbed BLE, also called `BLE_API`, is the Bluetooth Low Energy software solution for Mbed. Many Mbed <a href="https://os.mbed.com/platforms/?mbed-enabled=15&connectivity=3" target="_blank">targets and components</a> support Mbed BLE. Developers can use it to create new BLE enabled applications.
5+
Arm Mbed BLE, also called `BLE_API`, is the Bluetooth Low Energy software solution for Mbed. Many Mbed [targets and components](https://os.mbed.com/platforms/?mbed-enabled=15&connectivity=3) support Mbed BLE. Developers can use it to create new BLE enabled applications.
66

77
### BLE class reference
88

9-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_b_l_e.html)
9+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/class_b_l_e.html)
1010

1111
### Usage
1212

@@ -30,4 +30,4 @@ Here is an example demonstrating how to build a heart rate sensor that can be co
3030

3131
### Related content
3232

33-
- Mbed Enabled <a href="https://os.mbed.com/platforms/?mbed-enabled=15&connectivity=3" target="_blank">targets and components</a> that support BLE.
33+
- Mbed Enabled [targets and components](https://os.mbed.com/platforms/?mbed-enabled=15&connectivity=3) that support BLE.

0 commit comments

Comments
 (0)