Skip to content

Commit 7d3cd32

Browse files
author
AnotherButler
committed
Update 5.6 to 5.7
Fix all links to say 5.7 instead of 5.6. Also, fix two typos that snuck in somehow.
1 parent c2ca609 commit 7d3cd32

Some content is hidden

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

91 files changed

+234
-234
lines changed

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 <a href="/docs/v5.7/introduction/glossary.html" target="_blank">APIs</a> 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+
- <a href="/docs/v5.7/reference/platform.html" target="_blank">Platform</a>: platform modules that provide consistent user experience.
6+
- <a href="/docs/v5.7/reference/drivers.html" target="_blank">Drivers</a>: analog and digital input and outputs and digital interfaces.
7+
- <a href="/docs/v5.7/reference/rtos.html" target="_blank">RTOS</a>: handling tasks and events in Mbed OS.
8+
- <a href="/docs/v5.7/reference/network-socket.html" target="_blank">Network Socket</a>: network sockets, Ethernet, Wi-Fi, cellular and mesh networking.
9+
- <a href="/docs/v5.7/reference/bluetooth.html" target="_blank">Bluetooth</a>: bluetooth low energy.
10+
- <a href="/docs/v5.7/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.7/reference/storage.htmll" target="_blank">Storage</a>: 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 <a href="/docs/v5.7/reference/contributing.html" target="_blank">contributing to Mbed OS</a>.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Arm Mbed BLE, also called `BLE_API`, is the Bluetooth Low Energy software soluti
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)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_b_l_e.html)
1010

1111
### Usage
1212

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### BatteryService class reference
66

7-
[![View code](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_battery_service.html)
7+
[![View code](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_battery_service.html)
88

99
### BatteryService example
1010

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### EnvironmentalService class reference
66

7-
[![View code](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_environmental_service.html)
7+
[![View code](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_environmental_service.html)
88

99
### EnvironmentalService example
1010

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### Gap class reference
66

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

99
### Gap example
1010

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### GattClient class reference
66

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

99
### GattClient example
1010

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### GattServer class reference
66

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

99
### GattServer example
1010

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

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

1111
### HeartRateService class reference
1212

13-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_heart_rate_service.html)
13+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_heart_rate_service.html)
1414

1515
### HeartRateService example
1616

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### UARTService class reference
66

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

99
### UARTService example
1010

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ Arm Mbed BLE, also called `BLE_API`, is the Bluetooth Low Energy software soluti
2727

2828
#### Going further
2929

30-
- The Mbed BLE <a href="/docs/v5.6/reference/ble.html" target="_blank">API reference</a> offers the full details of the API.
30+
- The Mbed BLE <a href="/docs/v5.7/reference/ble.html" target="_blank">API reference</a> offers the full details of the API.
3131

3232
- The Mbed BLE <a href="https://os.mbed.com/teams/Bluetooth-Low-Energy/community/" target="_blank">online community</a> is also a great place to ask questions and share your knowledge.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The iBeacon class builds an advertising payload mimicking an iBeacon and assigns
88

99
### iBeacon class reference
1010

11-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/classi_beacon.html)
11+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/classi_beacon.html)
1212

1313
### iBeacon example
1414

docs/reference/api/connectivity/networksocket/CellularInterface.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ Arm Mbed OS provides a <a href="https://github.com/ARMmbed/mbed-os/tree/master/f
66

77
### CellularBase 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_cellular_base.html)
9+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_cellular_base.html)
1010

1111
### Usage
1212

1313
To bring up the network interface:
1414

1515
1. Instantiate an implementation of the CellularBase class.
1616
1. Call the `connect(pincode, apn)` function with a PIN code for your SIM card and an APN for your network.
17-
1. Once connected, you can use Mbed OS <a href="/docs/v5.6/reference/network-socket.html" target="_blank">network sockets</a> as usual.
17+
1. Once connected, you can use Mbed OS <a href="/docs/v5.7/reference/network-socket.html" target="_blank">network sockets</a> as usual.
1818

1919
### Cellular example: connection establishment
2020

@@ -24,4 +24,4 @@ This example establishes connection with the cellular network using Mbed OS Cell
2424

2525
### Related content
2626

27-
- <a href="/docs/v5.6/reference/network-socket.html" target="_blank">Network socket</a> API reference overview.
27+
- <a href="/docs/v5.7/reference/network-socket.html" target="_blank">Network socket</a> API reference overview.

docs/reference/api/connectivity/networksocket/EthInterface.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The EthInterface provides a C++ API for connecting to the internet over Ethernet
44

55
### EthInterface class reference
66

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

99
### Usage
1010

@@ -13,7 +13,7 @@ To bring up the network interface:
1313
1. Instantiate the `EthInterface` class.
1414
1. Call the `connect` function.
1515
1. Once you connect the EthInterface, you can use it as a
16-
target for opening <a href="/docs/v5.6/reference/network-socket.html" target="_blank">network sockets</a>.
16+
target for opening <a href="/docs/v5.7/reference/network-socket.html" target="_blank">network sockets</a>.
1717

1818
### EthInterface example
1919

@@ -23,4 +23,4 @@ Here is an example of an HTTP client program. The program brings up Ethernet as
2323

2424
### Related content
2525

26-
- <a href="/docs/v5.6/reference/network-socket.html" target="_blank">Network socket</a> API reference overview.
26+
- <a href="/docs/v5.7/reference/network-socket.html" target="_blank">Network socket</a> API reference overview.

docs/reference/api/connectivity/networksocket/MeshInterface.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Mesh
22

3-
The Arm Mbed mesh API allows the application to use the IPv6 mesh network topologies through the <a href="/docs/v5.6/tutorials/mesh.html#nanostack" target="_blank">nanostack</a> networking stack.
3+
The Arm Mbed mesh API allows the application to use the IPv6 mesh network topologies through the <a href="/docs/v5.7/tutorials/mesh.html#nanostack" target="_blank">nanostack</a> networking stack.
44

55
**Tips:**
66
* The mesh API supports 6LoWPAN-ND (neighbor discovery) and Thread bootstrap modes.
@@ -11,15 +11,15 @@ The Arm Mbed mesh API allows the application to use the IPv6 mesh network topolo
1111

1212
**LoWPANNDInterface**
1313

14-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_lo_w_p_a_n_n_d_interface.html)
14+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_lo_w_p_a_n_n_d_interface.html)
1515

1616
**ThreadInterface**
1717

18-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_thread_interface.html)
18+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_thread_interface.html)
1919

2020
**NanostackEthernetInterface**
2121

22-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_nanostack_ethernet_interface.html)
22+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_nanostack_ethernet_interface.html)
2323

2424
### Usage
2525

@@ -35,4 +35,4 @@ The application below demonstrates a simple light control application, where dev
3535

3636
### Related content
3737

38-
- <a href="/docs/v5.6/tutorials/mesh.html#nanostack" target="_blank">Nanostack</a> tutorial.
38+
- <a href="/docs/v5.7/tutorials/mesh.html#nanostack" target="_blank">Nanostack</a> tutorial.

docs/reference/api/connectivity/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/v5.6/mbed-os-api-doxy/class_socket_address.html)
7+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_socket_address.html)
88

99
### SocketAddress Example
1010

docs/reference/api/connectivity/networksocket/TCPServer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ The TCPServer class provides the ability to accept incoming TCP connections. The
44

55
The constructor takes in the NetworkStack pointer to open the socket on the specified NetworkInterface. If you do not pass the NetworkStack pointer in the constructor, then you must call open to initialize the socket.
66

7-
Refer to <a href="/docs/v5.6/reference/tcpsocket.html" target="_blank">TCPSocket</a> class for TCP `connect`, `send` and `recv` APIs.
7+
Refer to <a href="/docs/v5.7/reference/tcpsocket.html" target="_blank">TCPSocket</a> class for TCP `connect`, `send` and `recv` APIs.
88

99
### TCPServer class reference
1010

11-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_t_c_p_server.html)
11+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_t_c_p_server.html)
1212

1313
### TCPServer example
1414

@@ -18,4 +18,4 @@ Here is a TCP server example. It accepts single telnet client connection and sen
1818

1919
### Related content
2020

21-
- <a href="/docs/v5.6/reference/tcpsocket.html" target="_blank">TCPSocket</a> API reference.
21+
- <a href="/docs/v5.7/reference/tcpsocket.html" target="_blank">TCPSocket</a> API reference.

docs/reference/api/connectivity/networksocket/TCPSocket.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ The TCPSocket class provides the ability to send a stream of data over TCP. TCPS
44

55
The constructor takes in the NetworkStack pointer to open the socket on the specified NetworkInterface. If you do not pass in the constructor, then you must call `open` to initialize the socket.
66

7-
Refer to <a href="/docs/v5.6/reference/tcpserver.html" target="_blank">TCPServer</a> class for TCP server functionality.
7+
Refer to <a href="/docs/v5.7/reference/tcpserver.html" target="_blank">TCPServer</a> class for TCP server functionality.
88

99
### TCPSocket class reference
1010

11-
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_t_c_p_socket.html)
11+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_t_c_p_socket.html)
1212

1313
### TCPSocket Example
1414

@@ -22,4 +22,4 @@ Here is a TCP client example of HTTP transaction over Ethernet interface.
2222

2323
### Related content
2424

25-
- <a href="/docs/v5.6/reference/tcpserver.html" target="_blank">TCPServer</a> API reference.
25+
- <a href="/docs/v5.7/reference/tcpserver.html" target="_blank">TCPServer</a> API reference.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
## UDPSocket
22

3-
The UDPSocket class provides the ability to send packets of data over UDP, using the `sendto` and `recvfrom` member functions. Packets can be lost or arrive out of order, so we suggest using a <a href="/docs/v5.6/reference/tcpsocket.html" target="_blank">TCPSocket</a> when you require guaranteed delivery.
3+
The UDPSocket class provides the ability to send packets of data over UDP, using the `sendto` and `recvfrom` member functions. Packets can be lost or arrive out of order, so we suggest using a <a href="/docs/v5.7/reference/tcpsocket.html" target="_blank">TCPSocket</a> when you require guaranteed delivery.
44

55
The constructor takes in the NetworkStack pointer to open the socket on the specified NetworkInterface. If you do not pass in the constructor, then you must call `open` to initialize the socket.
66

77
### UDPSocket 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_u_d_p_socket.html)
9+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_u_d_p_socket.html)
1010

1111
### UDPSocket Example
1212

13-
Here is a UDP example to read the current UTC time by sending a request to the NIST Internet Time Service.
13+
Here is a UDP example to read the current UTC time by sending a request to the NIST Internet Time Service.
1414

1515
[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/mbed-os-example-udp-sockets)](https://os.mbed.com/teams/mbed_example/code/mbed-os-example-udp-sockets/file/cf516d904427/main.cpp)
1616

1717
### Related content
1818

19-
- <a href="/docs/v5.6/reference/tcpsocket.html" target="_blank">TCPSocket</a> API reference.
19+
- <a href="/docs/v5.7/reference/tcpsocket.html" target="_blank">TCPSocket</a> API reference.

docs/reference/api/connectivity/networksocket/WifiInterface.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ There are multiple <a href="https://os.mbed.com/components/cat/wifi/" target="_b
66

77
### Wi-Fi 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_wi_fi_interface.html)
9+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/class_wi_fi_interface.html)
1010

1111
### Usage
1212

1313
To bring up the network interface:
1414

1515
1. Instantiate an implementation of the WiFiInterface class (for example, the ESP8266Interface).
1616
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 <a href="/docs/v5.6/reference/network-socket.html" target="_blank">network sockets</a>.
17+
1. Once connected, the WiFiInterface can be used as a target for opening <a href="/docs/v5.7/reference/network-socket.html" target="_blank">network sockets</a>.
1818

1919
### Wi-Fi example
2020

@@ -25,4 +25,4 @@ Here is an example of an HTTP client program. The program brings up an ESP8266 a
2525
### Related content
2626

2727
- <a href="https://os.mbed.com/components/cat/wifi/" target="_blank">Wi-Fi components</a>.
28-
- <a href="/docs/v5.6/reference/network-socket.html" target="_blank">Network socket</a> API overview.
28+
- <a href="/docs/v5.7/reference/network-socket.html" target="_blank">Network socket</a> API overview.

0 commit comments

Comments
 (0)