You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/api/connectivity/networksocket/WifiInterface.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
The WifiInterface provides a simple C++ API for connecting to the internet over a Wi-Fi device.
4
4
5
-
There are multiple <ahref="https://os.mbed.com/components/cat/wifi/"target="_blank">Wi-Fi components</a> that implement the WiFiInterface class. The example below uses the <ahref="https://github.com/armmbed/esp8266-driver"target="_blank">ESP8266Interface</a>.
5
+
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).
6
6
7
7
### Wi-Fi class reference
8
8
@@ -14,7 +14,7 @@ To bring up the network interface:
14
14
15
15
1. Instantiate an implementation of the WiFiInterface class (for example, the ESP8266Interface).
16
16
1. Call the `connect` function with an SSID and password for the Wi-Fi network.
17
-
1. Once connected, the WiFiInterface can be used as a target for opening <ahref="/docs/v5.7/reference/network-socket.html"target="_blank">network sockets</a>.
17
+
1. Once connected, the WiFiInterface can be used as a target for opening [network sockets](/docs/v5.7/reference/network-socket.html).
18
18
19
19
### Wi-Fi example
20
20
@@ -24,5 +24,5 @@ Here is an example of an HTTP client program. The program brings up an ESP8266 a
<spanclass="notes">**Note**: On a Windows machine, you need to install a USB serial driver. See <ahref="/docs/v5.7/tutorials/serial-communication.html#windows-serial-driver"target="_blank">Windows serial configuration</a>.</span>
23
+
<spanclass="notes">**Note**: On a Windows machine, you need to install a USB serial driver. See [Windows serial configuration](/docs/v5.7/tutorials/serial-communication.html#windows-serial-driver).</span>
24
24
25
25
### RawSerial hello, world
26
26
@@ -36,4 +36,4 @@ Write a message to a device at a baud rate of 19200.
36
36
37
37
#### Mbed OS example
38
38
39
-
Common use cases for RawSerial are IRQ heavy UART operations, such as the <ahref="https://github.com/ARMmbed/ATParser/blob/3209400df676cbf0183a5894f648c71727602d30/BufferedSerial/BufferedSerial.cpp#L29"target="_blank">ATParser</a> in the ESP8266 driver. This driver uses UART on user supplied pins to communicate with the offchip ESP8266 module.
39
+
Common use cases for RawSerial are IRQ heavy UART operations, such as the [ATParser](https://github.com/ARMmbed/ATParser/blob/3209400df676cbf0183a5894f648c71727602d30/BufferedSerial/BufferedSerial.cpp#L29) in the ESP8266 driver. This driver uses UART on user supplied pins to communicate with the offchip ESP8266 module.
Copy file name to clipboardExpand all lines: docs/reference/api/platform/Callback.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -19,11 +19,11 @@ The Callback API provides a convenient way to pass arguments to spawned threads.
19
19
20
20
### Sonar example
21
21
22
-
Here is an example that uses everything discussed in the <ahref="/docs/v5.7/reference/platform.html#callbacks"target="_blank">introduction to callbacks</a> document in the form of a minimal Sonar class.
22
+
Here is an example that uses everything discussed in the [introduction to callbacks](/docs/v5.7/reference/platform.html#callbacks) document in the form of a minimal Sonar class.
Copy file name to clipboardExpand all lines: docs/reference/api/platform/platform.md
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -2,16 +2,16 @@
2
2
3
3
The role of the platform modules is to provide a consistent user experience on top of different standard libraries and toolchains. This section consists of the `Callback`, `Wait` and `Time` APIs. This page contains reference material about these subjects. You can also jump straight to the APIs:
4
4
5
-
-<ahref="/docs/v5.7/reference/wait.html"target="_blank">Wait</a>: An API that provides simple wait capabilities.
6
-
-<ahref="/docs/v5.7/reference/callback.html"target="_blank">Callback</a>: An API that executes the user’s code in its own context.
7
-
-<ahref="/docs/v5.7/reference/deepsleeplock.html"target="_blank">DeepSleepLock</a>: The sleep function for Mbed OS.
8
-
-<ahref="/docs/v5.7/reference/sleep-manager.html"target="_blank">SleepManager</a>: The function that provides an API to control sleep modes.
9
-
-<ahref="/docs/v5.7/reference/criticalsectionlock.html"target="_blank">CriticalSectionLock</a>: An object that establishes the beginning of a critical section and uses RAII to disable and restore interrupt state when the current scope exits.
10
-
-<ahref="/docs/v5.7/reference/time.html"target="_blank">Time</a>: A group of functions in the standard library of the C programming language implementing date and time manipulation operations.
11
-
-<ahref="/docs/v5.7/reference/error.html"target="_blank">Error</a>: A functions that generates a fatal runtime error.
12
-
-<ahref="/docs/v5.7/reference/noncopyable.html"target="_blank">NonCopyable</a>: An API that tags a class as not supporting copy operations. It creates a compile-time error if you copy the object.
13
-
-<ahref="/docs/v5.7/reference/circularbuffer.html"target="_blank">CircularBuffer</a>: The class that provides APIs to push and pop data from a buffer
14
-
-<ahref="/docs/v5.7/reference/atcmdparser.html"target="_blank">ATCmdParser</a>: An Mbed OS compatible AT command parser.
5
+
-[Wait](/docs/v5.7/reference/wait.html): An API that provides simple wait capabilities.
6
+
-[Callback](/docs/v5.7/reference/callback.html): An API that executes the user’s code in its own context.
7
+
-[DeepSleepLock](/docs/v5.7/reference/deepsleeplock.html): The sleep function for Mbed OS.
8
+
-[SleepManager](/docs/v5.7/reference/sleep-manager.html): The function that provides an API to control sleep modes.
9
+
-[CriticalSectionLock](/docs/v5.7/reference/criticalsectionlock.html): An object that establishes the beginning of a critical section and uses RAII to disable and restore interrupt state when the current scope exits.
10
+
-[Time](/docs/v5.7/reference/time.html): A group of functions in the standard library of the C programming language implementing date and time manipulation operations.
11
+
-[Error](/docs/v5.7/reference/error.html): A functions that generates a fatal runtime error.
12
+
-[NonCopyable](/docs/v5.7/reference/noncopyable.html): An API that tags a class as not supporting copy operations. It creates a compile-time error if you copy the object.
13
+
-[CircularBuffer](/docs/v5.7/reference/circularbuffer.html): The class that provides APIs to push and pop data from a buffer
14
+
-[ATCmdParser](/docs/v5.7/reference/atcmdparser.html): An Mbed OS compatible AT command parser.
15
15
16
16
<h4id="callbacks">Callbacks</h4>
17
17
@@ -36,7 +36,7 @@ Serial serial(USBTX, USBRX);
36
36
}
37
37
```
38
38
39
-
The Callback class manages C/C++ function pointers so you don't have to. If you are asking yourself why you should use the Callback class, you should read the <a href="/docs/v5.7/reference/platform.html#the-importance-of-state" target="_blank">Importance of State</a> section.
39
+
The Callback class manages C/C++ function pointers so you don't have to. If you are asking yourself why you should use the Callback class, you should read the [Importance of State](/docs/v5.7/reference/platform.html#the-importance-of-state) section.
40
40
41
41
#### Why should you use Callbacks?
42
42
@@ -209,7 +209,7 @@ public:
209
209
210
210
<h4id="the-importance-of-state">The importance of state</h4>
211
211
212
-
A callback is a user provided function that a user may pass to an API. The callback allows the API to execute the user’s code in its own context. You can find more information on how to use callbacks in the <ahref="/docs/v5.7/reference/callback.html"target="_blank">technical callback documentation</a>.
212
+
A callback is a user provided function that a user may pass to an API. The callback allows the API to execute the user’s code in its own context. You can find more information on how to use callbacks in the [technical callback documentation](/docs/v5.7/reference/callback.html).
Copy file name to clipboardExpand all lines: docs/reference/api/rtos/rtos.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -8,21 +8,21 @@ The code of the Mbed RTOS can be found in the <a href="https://github.com/ARMmbe
8
8
9
9
System tick timer (SysTick) is a standard timer available on most Cortex-M cores. Its main purpose is to raise an interrupt with set frequency (usually 1ms). You can use it to perform any task in the system, but for platforms using RTOS, including Mbed OS, it provides an interval for the OS for counting the time and scheduling tasks.
10
10
11
-
Mbed OS uses default SysTick source for most targets, but you can override that using the <ahref="http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__TickAPI.html"target="_blank">Tick API</a> that CMSIS-RTOS2 provides. In which case you'll need to provide your own source of the interrupts.
11
+
Mbed OS uses default SysTick source for most targets, but you can override that using the [Tick API](http://arm-software.github.io/CMSIS_5/RTOS2/html/group__CMSIS__RTOS__TickAPI.html) that CMSIS-RTOS2 provides. In which case you'll need to provide your own source of the interrupts.
12
12
13
13
#### RTOS APIs
14
14
15
15
The RTOS APIs handle creation and destruction of threads in Arm Mbed OS 5, as well as mechanisms for safe interthread communication. Threads are a core component of Mbed OS 5 (even your `main` function starts in a thread of its own), so understanding how to work with them is an important part of developing applications for Mbed OS 5.
16
16
17
-
-<ahref="/docs/v5.7/reference/thread.html"target="_blank">Thread</a>: The class that allows defining, creating and controlling parallel tasks.
18
-
-<ahref="/docs/v5.7/reference/mutex.html"target="_blank">Mutex</a>: The class used to synchronize the execution of threads.
19
-
-<ahref="/docs/v5.7/reference/semaphore.html"target="_blank">Semaphore</a>: The class that manages thread access to a pool of shared resources of a certain type.
20
-
-<ahref="/docs/v5.7/reference/queue.html"target="_blank">Queue</a>: The class that allows you to queue pointers to data from producer threads to consumer threads.
21
-
-<ahref="/docs/v5.7/reference/memorypool.html"target="_blank">MemoryPool</a>: This class that you can use to define and manage fixed-size memory pools
22
-
-<ahref="/docs/v5.7/reference/mail.html"target="_blank">Mail</a>: The API that provides a queue combined with a memory pool for allocating messages.
23
-
-<ahref="/docs/v5.7/reference/rtostimer.html"target="_blank">RtosTimer</a>: A deprecated class used to control timer functions in the system.
24
-
-<ahref="/docs/v5.7/reference/eventflags.html"target="_blank">EventFlags</a>: An event channel that provides a generic way of notifying other threads about conditions or events.
25
-
-<ahref="/docs/v5.7/reference/event.html"target="_blank">Event</a>: The queue to store events, extract them and excute them later.
17
+
-[Thread](/docs/v5.7/reference/thread.html): The class that allows defining, creating and controlling parallel tasks.
18
+
-[Mutex](/docs/v5.7/reference/mutex.html): The class used to synchronize the execution of threads.
19
+
-[Semaphore](/docs/v5.7/reference/semaphore.html): The class that manages thread access to a pool of shared resources of a certain type.
20
+
-[Queue](/docs/v5.7/reference/queue.html): The class that allows you to queue pointers to data from producer threads to consumer threads.
21
+
-[MemoryPool](/docs/v5.7/reference/memorypool.html): This class that you can use to define and manage fixed-size memory pools
22
+
-[Mail](/docs/v5.7/reference/mail.html): The API that provides a queue combined with a memory pool for allocating messages.
23
+
-[RtosTimer](/docs/v5.7/reference/rtostimer.html): A deprecated class used to control timer functions in the system.
24
+
-[EventFlags](/docs/v5.7/reference/eventflags.html): An event channel that provides a generic way of notifying other threads about conditions or events.
25
+
-[Event](/docs/v5.7/reference/event.html): The queue to store events, extract them and excute them later.
Copy file name to clipboardExpand all lines: docs/reference/api/security/TLS.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -2,25 +2,25 @@
2
2
3
3
Arm Mbed TLS provides a comprehensive SSL/TLS solution and 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.
4
4
5
-
<spanclass="notes">**Note:** Mbed TLS needs a secure source of random numbers; make sure that your target board has one and that it is fully ported to Arm Mbed OS. You can read more about this in our <ahref="/docs/v5.7/reference/contributing.html"target="_blank">porting guide</a>.</span>
5
+
<spanclass="notes">**Note:** Mbed TLS needs a secure source of random numbers; make sure that your target board has one and that it is fully ported to Arm Mbed OS. You can read more about this in our [porting guide](/docs/v5.7/reference/contributing.html).</span>
6
6
7
7
### Mbed TLS examples
8
8
9
9
You can try the following examples:
10
10
11
-
1.<ahref="https://github.com/ARMmbed/mbed-os-example-tls/tree/master/tls-client"target="_blank">TLS client</a>: Downloads a file from an HTTPS server (os.mbed.com) and looks for a specific string in that file.
11
+
1.[TLS client](https://github.com/ARMmbed/mbed-os-example-tls/tree/master/tls-client): Downloads a file from an HTTPS server (os.mbed.com) and looks for a specific string in that file.
12
12
13
-
1.<ahref="https://github.com/ARMmbed/mbed-os-example-tls/tree/master/benchmark"target="_blank">Benchmark</a>: Measures the time taken to perform basic cryptographic functions used in the library.
13
+
1.[Benchmark](https://github.com/ARMmbed/mbed-os-example-tls/tree/master/benchmark): Measures the time taken to perform basic cryptographic functions used in the library.
14
14
15
-
1.<ahref="https://github.com/ARMmbed/mbed-os-example-tls/tree/master/hashing"target="_blank">Hashing</a>: Demonstrates the various APIs for computing hashes of data (also known as message digests) with SHA-256.
15
+
1.[Hashing](https://github.com/ARMmbed/mbed-os-example-tls/tree/master/hashing): Demonstrates the various APIs for computing hashes of data (also known as message digests) with SHA-256.
16
16
17
-
1.<ahref="https://github.com/ARMmbed/mbed-os-example-tls/tree/master/authcrypt"target="_blank">Authenticated encryption</a>: Demonstrates using the Cipher API for encrypting and authenticating data with AES-CCM.
17
+
1.[Authenticated encryption](https://github.com/ARMmbed/mbed-os-example-tls/tree/master/authcrypt): Demonstrates using the Cipher API for encrypting and authenticating data with AES-CCM.
18
18
19
19
Each of them comes with complete usage instructions as a readme file in the repository.
20
20
21
21
### Configuring Mbed TLS features
22
22
23
-
Mbed TLS simplifies enabling and disabling features to meet the needs of a particular project, through compilation options. The list of compilation flags is available in the fully documented configuration file, <ahref="https://github.com/ARMmbed/mbedtls/blob/development/include/mbedtls/config.h"target="_blank">config.h</a>.
23
+
Mbed TLS simplifies enabling and disabling features to meet the needs of a particular project, through compilation options. The list of compilation flags is available in the fully documented configuration file, [config.h](https://github.com/ARMmbed/mbedtls/blob/development/include/mbedtls/config.h).
24
24
25
25
For example, in an application called `myapp`, if you want to enable the EC J-PAKE key exchange and disable the CBC cipher mode, you can create a file named `mbedtls-config-changes.h` in the `myapp` directory containing the following lines:
0 commit comments