diff --git a/check_tools/search_replace.json b/check_tools/search_replace.json index 196186aa9e..d8ca22190d 100644 --- a/check_tools/search_replace.json +++ b/check_tools/search_replace.json @@ -3,5 +3,5 @@ "replace": "https://github.com/ARMmbed/mbed-os-snippet-", "insert_start_tag": "https:\/\/github.com\/ARMmbed\/mbed-os-snippet-.*\/", "insert_end_tag": "\\)", - "insert_string": "tree/v6.7" + "insert_string": "tree/v6.14" } diff --git a/deprecated/UARTService.md b/deprecated/UARTService.md index f61302ca3a..c6fcef55cf 100644 --- a/deprecated/UARTService.md +++ b/deprecated/UARTService.md @@ -4,7 +4,7 @@ ## UARTService class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/_u_a_r_t_service_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/_u_a_r_t_service_8h_source.html) ## UARTService example diff --git a/deprecated/iBeacon.md b/deprecated/iBeacon.md index 4f7c4e6efc..5b612027d7 100644 --- a/deprecated/iBeacon.md +++ b/deprecated/iBeacon.md @@ -10,7 +10,7 @@ The iBeacon class builds an advertising payload mimicking an iBeacon and assigns ## iBeacon class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/i_beacon_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/i_beacon_8h_source.html) ## iBeacon example diff --git a/docs/api/connectivity/bluetooth/BLE.md b/docs/api/connectivity/bluetooth/BLE.md index 3d9bfd8a05..e6c7675b95 100644 --- a/docs/api/connectivity/bluetooth/BLE.md +++ b/docs/api/connectivity/bluetooth/BLE.md @@ -124,4 +124,4 @@ Development happens on the `development` branch. If you report an issue or open ## BLE class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classble_1_1_b_l_e.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classble_1_1_b_l_e.html) diff --git a/docs/api/connectivity/bluetooth/Gap.md b/docs/api/connectivity/bluetooth/Gap.md index a605610bb6..59284d69be 100644 --- a/docs/api/connectivity/bluetooth/Gap.md +++ b/docs/api/connectivity/bluetooth/Gap.md @@ -64,11 +64,11 @@ The default value of data length supported by all controllers is 23 octets. If b ## GAP class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classble_1_1_gap.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classble_1_1_gap.html) ## GAP example Here is an example demonstrating how to use the GAP API to advertise, scan, connect and disconnect and how parameters influence efficiency of these actions. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GAP/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GAP/source/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GAP/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GAP/source/main.cpp) diff --git a/docs/api/connectivity/bluetooth/GattClient.md b/docs/api/connectivity/bluetooth/GattClient.md index 7f2205e7c2..f984ce00fe 100644 --- a/docs/api/connectivity/bluetooth/GattClient.md +++ b/docs/api/connectivity/bluetooth/GattClient.md @@ -34,14 +34,14 @@ Clients register for these updates by setting the Client Characteristic Configur ## GattClient class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classble_1_1_gatt_client.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classble_1_1_gatt_client.html) ## GattClient examples ### Characteristic writes -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GattClient_CharacteristicWrite/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GattClient_CharacteristicWrite/source/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GattClient_CharacteristicWrite/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GattClient_CharacteristicWrite/source/main.cpp) ### Characteristic updates -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GattClient_CharacteristicUpdates/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GattClient_CharacteristicUpdates/source/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GattClient_CharacteristicUpdates/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GattClient_CharacteristicUpdates/source/main.cpp) diff --git a/docs/api/connectivity/bluetooth/GattServer.md b/docs/api/connectivity/bluetooth/GattServer.md index d95ca4098a..680e26cd49 100644 --- a/docs/api/connectivity/bluetooth/GattServer.md +++ b/docs/api/connectivity/bluetooth/GattServer.md @@ -37,18 +37,18 @@ The term characteristic value update represents Characteristic Value Notificatio ## GattServer class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classble_1_1_gatt_server.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classble_1_1_gatt_server.html) ## GattServer examples ### Add Service -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GattServer_AddService/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GattServer_AddService/source/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GattServer_AddService/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GattServer_AddService/source/main.cpp) ### Characteristic Writes -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GattServer_CharacteristicWrite/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GattServer_CharacteristicWrite/source/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GattServer_CharacteristicWrite/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GattServer_CharacteristicWrite/source/main.cpp) ### Characteristic Updates -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GattServer_CharacteristicUpdates/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_GattServer_CharacteristicUpdates/source/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GattServer_CharacteristicUpdates/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_GattServer_CharacteristicUpdates/source/main.cpp) diff --git a/docs/api/connectivity/bluetooth/SecurityManager.md b/docs/api/connectivity/bluetooth/SecurityManager.md index 83eb9cf6ca..0164e81063 100644 --- a/docs/api/connectivity/bluetooth/SecurityManager.md +++ b/docs/api/connectivity/bluetooth/SecurityManager.md @@ -46,10 +46,10 @@ The simplest example is a pairing of a device with no IO capabilities and no OOB ## SecurityManager class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classble_1_1_security_manager.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classble_1_1_security_manager.html) ## SecurityManager example The SecurityManager example demonstrates both a central and a peripheral connecting, performing basic pairing and setting up link security. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_SecurityAndPrivacy/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.7.0/BLE_SecurityAndPrivacy/source/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_SecurityAndPrivacy/source/)](https://github.com/ARMmbed/mbed-os-example-ble/blob/mbed-os-6.14.0/BLE_SecurityAndPrivacy/source/main.cpp) diff --git a/docs/api/connectivity/lorawan/loraradio.md b/docs/api/connectivity/lorawan/loraradio.md index 1dc7b0c329..9f5842ed2e 100644 --- a/docs/api/connectivity/lorawan/loraradio.md +++ b/docs/api/connectivity/lorawan/loraradio.md @@ -8,11 +8,11 @@ To configure this class, please see the [LoRa configuration documentation](../ap ## LoRaRadio class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_lo_ra_radio.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_lo_ra_radio.html) ## LoRaRadio example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-lorawan)](https://github.com/ARMmbed/mbed-os-example-lorawan/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-lorawan)](https://github.com/ARMmbed/mbed-os-example-lorawan/blob/mbed-os-6.14.0/main.cpp) ## Related content diff --git a/docs/api/connectivity/lorawan/lorawan.md b/docs/api/connectivity/lorawan/lorawan.md index ba2fd61402..e2095b0cd5 100644 --- a/docs/api/connectivity/lorawan/lorawan.md +++ b/docs/api/connectivity/lorawan/lorawan.md @@ -6,13 +6,13 @@ To configure this class, please see the [LoRa configuration documentation](../ap ## LoRaWANInterface class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_lo_ra_w_a_n_interface.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_lo_ra_w_a_n_interface.html) ## LoRaWAN example Please visit our Arm Mbed Online Compiler example, and follow the instructions in the `README.md`. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-lorawan)](https://github.com/ARMmbed/mbed-os-example-lorawan/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-lorawan)](https://github.com/ARMmbed/mbed-os-example-lorawan/blob/mbed-os-6.14.0/main.cpp) ## Related content diff --git a/docs/api/connectivity/networkinterfaces/CellularInterface.md b/docs/api/connectivity/networkinterfaces/CellularInterface.md index 3523c6d66f..07ea176f06 100644 --- a/docs/api/connectivity/networkinterfaces/CellularInterface.md +++ b/docs/api/connectivity/networkinterfaces/CellularInterface.md @@ -1,6 +1,6 @@

Cellular

-![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_cellular_interface.png)CellularInterface class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_cellular_interface.png)CellularInterface class hierarchy **Note:** Some functions, variables or types have been deprecated. Please see the class reference linked below for details. @@ -51,7 +51,7 @@ You can use and extend a cellular interface in various different ways. For examp ## CellularInterface class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_cellular_interface.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_cellular_interface.html) ## Usage @@ -65,7 +65,7 @@ To bring up the network interface: This example establishes connection with the cellular network using Mbed OS CellularInterface. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-cellular)](https://github.com/ARMmbed/mbed-os-example-cellular/blob/mbed-os-6.7.0/source/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-cellular)](https://github.com/ARMmbed/mbed-os-example-cellular/blob/mbed-os-6.14.0/source/main.cpp) ## Related content diff --git a/docs/api/connectivity/networkinterfaces/EthInterface.md b/docs/api/connectivity/networkinterfaces/EthInterface.md index 436a2a1501..a3ed38ed11 100644 --- a/docs/api/connectivity/networkinterfaces/EthInterface.md +++ b/docs/api/connectivity/networkinterfaces/EthInterface.md @@ -1,6 +1,6 @@ # Ethernet -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_eth_interface.png)EthInterface class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_eth_interface.png)EthInterface class hierarchy The `EthInterface` provides a C++ API for connecting to the internet over Ethernet. By default, this class does not require any configuration. It is able to pick up the default Ethernet driver for the target and select correct network stack. @@ -49,13 +49,13 @@ Network interface `connect` failure causes: ## EthInterface class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_eth_interface.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_eth_interface.html) ## EthInterface example Here is an example of an HTTP client program. The program brings up Ethernet as the underlying network interface and uses it to perform an HTTP transaction over a TCPSocket: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-TCPSocket/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-TCPSocket/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-TCPSocket/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-TCPSocket/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/connectivity/networkinterfaces/MeshInterface.md b/docs/api/connectivity/networkinterfaces/MeshInterface.md index 18b13ff8c7..74f7c6d12e 100644 --- a/docs/api/connectivity/networkinterfaces/MeshInterface.md +++ b/docs/api/connectivity/networkinterfaces/MeshInterface.md @@ -1,6 +1,6 @@

Mesh

-![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_mesh_interface.png)MeshInterface class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_mesh_interface.png)MeshInterface class hierarchy The Arm Mbed Mesh API allows the application to use the IPv6 mesh network topologies through the [Nanostack](../apis/6LoWPAN-ND-tech.html) networking stack. @@ -16,13 +16,13 @@ You can configure the mesh interface by providing values in `mbed_app.json`, as ## Mesh class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_mesh_interface.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_mesh_interface.html) ## Mesh example The following code snippet illustrates how you can use the MeshInterface API: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Mesh_Ex1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Mesh_Ex1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Mesh_Ex1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Mesh_Ex1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/connectivity/networkinterfaces/NetworkStatus.md b/docs/api/connectivity/networkinterfaces/NetworkStatus.md index 7647f7f94e..4009886198 100644 --- a/docs/api/connectivity/networkinterfaces/NetworkStatus.md +++ b/docs/api/connectivity/networkinterfaces/NetworkStatus.md @@ -113,7 +113,7 @@ This optional and has a small RAM and ROM increase, so applications are not requ Registering a status callback that connection state changes trigger depends on whether the network interface provides this functionality. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-TCPSocket_ConnStateCb/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-TCPSocket_ConnStateCb/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-TCPSocket_ConnStateCb/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-TCPSocket_ConnStateCb/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/connectivity/networkinterfaces/WifiInterface.md b/docs/api/connectivity/networkinterfaces/WifiInterface.md index 19ccaa7fa9..57f1aa1091 100644 --- a/docs/api/connectivity/networkinterfaces/WifiInterface.md +++ b/docs/api/connectivity/networkinterfaces/WifiInterface.md @@ -1,12 +1,12 @@ # Wi-Fi -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/class_wi_fi_interface.png)WiFiInterface class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/class_wi_fi_interface.png)WiFiInterface class hierarchy The WifiInterface provides a simple C++ API for connecting to the internet over a Wi-Fi device. ## Wi-Fi class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/class_wi_fi_interface.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/class_wi_fi_interface.html) ## Usage @@ -60,7 +60,7 @@ This program scans for Wi-Fi access points in the area. There are multiple [Wi-F 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: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-TCPSocketWiFi/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-TCPSocketWiFi/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-TCPSocketWiFi/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-TCPSocketWiFi/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/connectivity/networksocket/CellularNonIPSocket.md b/docs/api/connectivity/networksocket/CellularNonIPSocket.md index 457376b9e9..077a86ee83 100644 --- a/docs/api/connectivity/networksocket/CellularNonIPSocket.md +++ b/docs/api/connectivity/networksocket/CellularNonIPSocket.md @@ -1,6 +1,6 @@ # Non-IP cellular socket -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_cellular_non_i_p_socket.png)CellularNonIPSocket class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_cellular_non_i_p_socket.png)CellularNonIPSocket class hierarchy The CellularNonIPSocket class provides, through standard socket `send` and `recv` member functions, the ability to send and receive 3GPP non-IP datagrams (NIDD) using our cellular IoT feature. This feature is implemented in the [`ControlPlane_netif`](../mbed-os-api-doxy/classmbed_1_1_control_plane__netif.html) class. @@ -28,10 +28,10 @@ You can request Control Plane optimization mode either with CellularDevice's [`c ## CellularNonIPSocket class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_cellular_non_i_p_socket.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_cellular_non_i_p_socket.html) ## CellularNonIPSocket example The following code demonstrates how to create and use a cellular non-IP socket: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CellularNonIPSocket/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-CellularNonIPSocket/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CellularNonIPSocket/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-CellularNonIPSocket/blob/v6.14/main.cpp) diff --git a/docs/api/connectivity/networksocket/DNS.md b/docs/api/connectivity/networksocket/DNS.md index 39f1714f9c..a45b97b2bd 100644 --- a/docs/api/connectivity/networksocket/DNS.md +++ b/docs/api/connectivity/networksocket/DNS.md @@ -1,6 +1,6 @@ # DNS Resolver -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_d_n_s.png)DNS class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_d_n_s.png)DNS class hierarchy The DNS resolver provides an interface to do DNS host name resolutions. You can use DNS host name resolution to convert resource names to IP addresses. You can make DNS host name resolution after connecting the interface. You can use the returned IP address to make the socket connection. @@ -38,13 +38,13 @@ Callback is called from thread context. If the callback takes more than 10ms to ## DNS resolver class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_d_n_s.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_d_n_s.html) ## DNS resolver example This DNS resolver example makes asynchronous DNS host name resolution. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DNS_GetHostbyNameAsync/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-DNS_GetHostbyNameAsync/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DNS_GetHostbyNameAsync/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-DNS_GetHostbyNameAsync/blob/v6.14/main.cpp) ## Troubleshooting information diff --git a/docs/api/connectivity/networksocket/SocketAddress.md b/docs/api/connectivity/networksocket/SocketAddress.md index c90e41ab25..8f51345173 100644 --- a/docs/api/connectivity/networksocket/SocketAddress.md +++ b/docs/api/connectivity/networksocket/SocketAddress.md @@ -4,13 +4,13 @@ Use the SocketAddress class to represent the IP address and port pair of a uniqu ## SocketAddress class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_socket_address.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_socket_address.html) ## SocketAddress example Here is an example to read current UTC time. This example uses the SocketAddress class to get the server IP address and port. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UDPSocket/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-UDPSocket/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UDPSocket/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-UDPSocket/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/connectivity/networksocket/SocketStats.md b/docs/api/connectivity/networksocket/SocketStats.md index 12d9438e82..0e4fdd4233 100644 --- a/docs/api/connectivity/networksocket/SocketStats.md +++ b/docs/api/connectivity/networksocket/SocketStats.md @@ -8,13 +8,13 @@ Socket statistics are stored in an internal data buffer and maintained for close ## SocketStats class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_socket_stats.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_socket_stats.html) ## SocketStats example Here is an example to collect socket statistics. -[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-socket-stats)](https://github.com/ARMmbed/mbed-os-example-socket-stats/blob/mbed-os-6.7.0/main.cpp) +[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-socket-stats)](https://github.com/ARMmbed/mbed-os-example-socket-stats/blob/mbed-os-6.14.0/main.cpp) ## Related content diff --git a/docs/api/connectivity/networksocket/TCPSocket.md b/docs/api/connectivity/networksocket/TCPSocket.md index ad052fcb91..e4c54e6d93 100644 --- a/docs/api/connectivity/networksocket/TCPSocket.md +++ b/docs/api/connectivity/networksocket/TCPSocket.md @@ -1,6 +1,6 @@ # TCPSocket -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_t_c_p_socket.png)TCPSocket class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_t_c_p_socket.png)TCPSocket class hierarchy The TCPSocket class provides the ability to send a stream of data over TCP. TCPSockets maintain a stateful connection that starts with the `connect` member function. After successfully connecting to a server, you can use the `send` and `recv` member functions to send and receive data (similar to writing or reading from a file). @@ -20,13 +20,13 @@ Accepting a connection leaves the original socket in listening mode. You can con ## TCPSocket class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_t_c_p_socket.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_t_c_p_socket.html) ## TCPSocket example Here is a client example of HTTP transaction over TCPSocket: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-TCPSocket/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-TCPSocket/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-TCPSocket/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-TCPSocket/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/connectivity/networksocket/UDPSocket.md b/docs/api/connectivity/networksocket/UDPSocket.md index 6fab944112..e3fb8ecf8b 100644 --- a/docs/api/connectivity/networksocket/UDPSocket.md +++ b/docs/api/connectivity/networksocket/UDPSocket.md @@ -1,6 +1,6 @@ # UDPSocket -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_d_p_socket.png)UDPSocket class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_d_p_socket.png)UDPSocket class hierarchy 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 [TCPSocket](../apis/tcpsocket.html) when you require guaranteed delivery. @@ -12,13 +12,13 @@ If you prefer to use `send()` and `recv()` functions and work only with one peer ## UDPSocket class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_d_p_socket.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_d_p_socket.html) ## UDPSocket example This UDP example reads the current UTC time by sending a request to the NIST Internet Time Service: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UDPSocket/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-UDPSocket/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UDPSocket/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-UDPSocket/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/connectivity/networksocket/socket.md b/docs/api/connectivity/networksocket/socket.md index c0eb773cdc..785fa10cc8 100644 --- a/docs/api/connectivity/networksocket/socket.md +++ b/docs/api/connectivity/networksocket/socket.md @@ -1,6 +1,6 @@ # Socket -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_socket.png)Socket class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_socket.png)Socket class hierarchy Socket is the abstract base class for all of the protocol-specific socket types. It defines all of the functions that comprise the Mbed OS Socket API. You cannot directly create a Socket object because it is abstract, but you can upcast any protocol-specific object to an abstract Socket object. @@ -26,13 +26,13 @@ Not all protocols implement every function from the Socket API. For example, UDP ## Socket class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_socket.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_socket.html) ## Socket example Here is a client example of HTTP transaction over TCPSocket or TLSSocket: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-sockets)](https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.7.0/source/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-sockets)](https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.14.0/source/main.cpp) ## Related content diff --git a/docs/api/connectivity/nfc/MessageBuilder.md b/docs/api/connectivity/nfc/MessageBuilder.md index 2dbe5a6750..2c9be96e1e 100644 --- a/docs/api/connectivity/nfc/MessageBuilder.md +++ b/docs/api/connectivity/nfc/MessageBuilder.md @@ -4,11 +4,11 @@ Mbed OS provides this API to construct NDEF messages, the common data format exc ## MessageBuilder class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1nfc_1_1ndef_1_1_message_builder.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1nfc_1_1ndef_1_1_message_builder.html) ## MessageBuilder example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-MessageBuilder/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-MessageBuilder/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-MessageBuilder/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-MessageBuilder/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/connectivity/nfc/MessageParser.md b/docs/api/connectivity/nfc/MessageParser.md index 603106f0aa..c51fe57043 100644 --- a/docs/api/connectivity/nfc/MessageParser.md +++ b/docs/api/connectivity/nfc/MessageParser.md @@ -4,7 +4,7 @@ The MessageParser class is an event-driven NDEF message parser. This class parse ## MessageParser class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1nfc_1_1ndef_1_1_message_parser.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1nfc_1_1ndef_1_1_message_parser.html) ## MessageParser example diff --git a/docs/api/connectivity/nfc/NFCController.md b/docs/api/connectivity/nfc/NFCController.md index 3b586f94b3..1cc5a2f4d7 100644 --- a/docs/api/connectivity/nfc/NFCController.md +++ b/docs/api/connectivity/nfc/NFCController.md @@ -1,6 +1,6 @@ # NFCController -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1nfc_1_1_n_f_c_controller.png)NFCController class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1nfc_1_1_n_f_c_controller.png)NFCController class hierarchy Using an NFC controller with Mbed OS allows you to emulate NFC tags that a smartphone can read, as well as generate NDEF messages on demand. @@ -8,11 +8,11 @@ To use an NFC controller, you must initiate the instance with a driver instance, ## NFCController class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1nfc_1_1_n_f_c_controller.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1nfc_1_1_n_f_c_controller.html) ## NFCController example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-NFCController/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-NFCController/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-NFCController/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-NFCController/blob/v6.14/main.cpp) A delegate mechanism handles events throughout the API. diff --git a/docs/api/connectivity/nfc/NFCEEPROM.md b/docs/api/connectivity/nfc/NFCEEPROM.md index 1ecb548712..5da01b0343 100644 --- a/docs/api/connectivity/nfc/NFCEEPROM.md +++ b/docs/api/connectivity/nfc/NFCEEPROM.md @@ -1,6 +1,6 @@ # NFC EEPROM -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1nfc_1_1_n_f_c_e_e_p_r_o_m.png)NFCEEPROM class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1nfc_1_1_n_f_c_e_e_p_r_o_m.png)NFCEEPROM class hierarchy An NFC EEPROM can store NDEF messages. You can use a smartphone access the message through the NFC interface the EEPROM exposes. @@ -8,11 +8,11 @@ To use an NFC EEPROM, you must initiate the instance with a driver instance, an ## NFCEEPROM class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1nfc_1_1_n_f_c_e_e_p_r_o_m.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1nfc_1_1_n_f_c_e_e_p_r_o_m.html) ## NFCEEPROM example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-NFC_EEPROM/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-NFC_EEPROM/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-NFC_EEPROM/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-NFC_EEPROM/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/connectivity/nfc/SimpleMessageParser.md b/docs/api/connectivity/nfc/SimpleMessageParser.md index 87615f17cf..a89be2f170 100644 --- a/docs/api/connectivity/nfc/SimpleMessageParser.md +++ b/docs/api/connectivity/nfc/SimpleMessageParser.md @@ -1,16 +1,16 @@ # SimpleMessageParser -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1nfc_1_1ndef_1_1common_1_1_simple_message_parser.png)SimpleMessageParser class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1nfc_1_1ndef_1_1common_1_1_simple_message_parser.png)SimpleMessageParser class hierarchy The SimpleMessageParser class is a more integrated parser than the MessageParser class. Like MessageParser, SimpleMessageParser parses data and sends parsing events to its delegate. However, SimpleMessageParser also includes subparsers for well-known NFC types records, such as Text, URI or Mime records, and produces usable objects out of the box. User defined parsers can be injected at runtime to extend the capabilities of the SimpleMessageParser. ## SimpleMessageParser class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1nfc_1_1ndef_1_1common_1_1_simple_message_parser.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1nfc_1_1ndef_1_1common_1_1_simple_message_parser.html) ## SimpleMessageParser example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SimpleMessageParser/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-SimpleMessageParser/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SimpleMessageParser/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-SimpleMessageParser/blob/v6.14/main.cpp) An application can extend capabilities of `SimpleMessageParser` by adding new record parsers (`mbed::nfc::ndef::RecordParser`) at runtime. diff --git a/docs/api/connectivity/secure-socket/DTLSSocket.md b/docs/api/connectivity/secure-socket/DTLSSocket.md index 553dd41b28..a08eb68fb7 100644 --- a/docs/api/connectivity/secure-socket/DTLSSocket.md +++ b/docs/api/connectivity/secure-socket/DTLSSocket.md @@ -1,6 +1,6 @@ # DTLSSocket -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_d_t_l_s_socket.png)DTLSSocket class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_d_t_l_s_socket.png)DTLSSocket class hierarchy `DTLSSocket` and `DTLSSocketWrapper` implement DTLS stream over the existing `Socket` transport. You can find design and implementation details in the [Secure Socket](../apis/secure-socket.html) page. @@ -10,13 +10,13 @@ To use secure DTLS connections, application use the `DTLSSocketWrapper` through ## DTLSSocket class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_d_t_l_s_socket.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_d_t_l_s_socket.html) ## DTLSSocket example Please see the sockets example which can be configured to use a TLSSocket: -[![View code](https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.7.0/source/main.cpp)](https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.7.0/source/main.cpp) +[![View code](https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.14.0/source/main.cpp)](https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.14.0/source/main.cpp) ## Related content diff --git a/docs/api/connectivity/secure-socket/TLSSocket.md b/docs/api/connectivity/secure-socket/TLSSocket.md index a063e38c9c..f9618051c1 100644 --- a/docs/api/connectivity/secure-socket/TLSSocket.md +++ b/docs/api/connectivity/secure-socket/TLSSocket.md @@ -1,6 +1,6 @@ # TLSSocket -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_t_l_s_socket.png)TLSSocket class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_t_l_s_socket.png)TLSSocket class hierarchy `TLSSocket` and `TLSSocketWrapper` implement TLS stream over the existing `Socket` transport. You can find design and implementation details in the [SecureSocket](../apis/secure-socket.html) page. @@ -8,7 +8,7 @@ To use secure TLS connections, the application uses the `TLSSocketWrapper` throu ## TLSSocket class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_t_l_s_socket.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_t_l_s_socket.html) ## TLSSocket example @@ -21,7 +21,7 @@ Please make sure to enable TLS by configuring: } ``` -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.7.0/source/main.cpp)](https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.7.0/source/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.14.0/source/main.cpp)](https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.14.0/source/main.cpp) ## Related content diff --git a/docs/api/connectivity/tutorials/light-control.md b/docs/api/connectivity/tutorials/light-control.md index aefe11f366..a096f41b1b 100644 --- a/docs/api/connectivity/tutorials/light-control.md +++ b/docs/api/connectivity/tutorials/light-control.md @@ -26,7 +26,7 @@ cd mbed-os-example-mesh-minimal If using the Mbed Online Compiler, click **Import into Mbed IDE** below: -[![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-6.7.0/mesh_led_control_example.cpp) +[![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-6.14.0/mesh_led_control_example.cpp) ## Change the channel settings (optional) diff --git a/docs/api/connectivity/tutorials/tls_tutorial.md b/docs/api/connectivity/tutorials/tls_tutorial.md index 96cb346451..74c9bdc15a 100644 --- a/docs/api/connectivity/tutorials/tls_tutorial.md +++ b/docs/api/connectivity/tutorials/tls_tutorial.md @@ -90,7 +90,7 @@ With everything in place, you can now set up a TLS socket connection. On the Mbe You set up a TLS socket in the same way as you set up a TCP socket, except you call `set_root_ca_cert` with the root CA string. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-TLS_Communication/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-TLS_Communication/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-TLS_Communication/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-TLS_Communication/blob/v6.14/main.cpp) This now makes the request and returns the content of the file. @@ -112,7 +112,7 @@ This now makes the request and returns the content of the file. [INFO][TLSW]: Certificate verification passed ``` -You can also look at the [complete example](https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.7.0/source/main.cpp) for more details. +You can also look at the [complete example](https://github.com/ARMmbed/mbed-os-example-sockets/blob/mbed-os-6.14.0/source/main.cpp) for more details. **Note:** If you come across a message saying the signature's algorithm is missing:
``` diff --git a/docs/api/drivers/CAN.md b/docs/api/drivers/CAN.md index bd37f80012..dca6d0939c 100644 --- a/docs/api/drivers/CAN.md +++ b/docs/api/drivers/CAN.md @@ -1,6 +1,6 @@ # CAN -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_c_a_n.png)CAN class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_c_a_n.png)CAN class hierarchy Controller-Area Network (CAN) is a bus standard that allows microcontrollers and devices to communicate with each other without going through a host computer. @@ -8,10 +8,10 @@ Controller-Area Network (CAN) is a bus standard that allows microcontrollers and ## CAN class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_c_a_n.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_c_a_n.html) ## CAN hello, world This example sends a counter from one CAN bus (can1) and listens for a packet on the other CAN bus (can2). Each bus controller should be connected to a CAN bus transceiver. These should be connected together at a CAN bus. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CAN_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-CAN_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CAN_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-CAN_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/FlashIAP.md b/docs/api/drivers/FlashIAP.md index dae90a6bae..0ce2032017 100644 --- a/docs/api/drivers/FlashIAP.md +++ b/docs/api/drivers/FlashIAP.md @@ -1,6 +1,6 @@ # Flash IAP -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_flash_i_a_p.png)FlashIAP class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_flash_i_a_p.png)FlashIAP class hierarchy The flash in application programming provides an interface for access to MCU internal flash memory. @@ -24,7 +24,7 @@ This class is thread-safe. View the full C++ API: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_flash_i_a_p.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_flash_i_a_p.html) ## Flash IAP example diff --git a/docs/api/drivers/I2C.md b/docs/api/drivers/I2C.md index a30e02ad83..96bb3ba220 100644 --- a/docs/api/drivers/I2C.md +++ b/docs/api/drivers/I2C.md @@ -1,6 +1,6 @@ # I2C -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_i2_c.png)I2C class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_i2_c.png)I2C class hierarchy The I2C interface provides I2C Master functionality. I2C is a two wire serial protocol that allows an I2C Master to exchange data with an I2C Slave. You can use it to communicate with I2C devices such as serial memories, sensors and other modules or integrated circuits. @@ -12,8 +12,8 @@ The I2C protocol supports up to 127 devices per bus, and its default clock frequ **Note:** The Arm Mbed API uses 8 bit addresses, so make sure to left-shift 7 bit addresses by 1 bit before passing them. -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_i2_c.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_i2_c.html) ## I2C hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-I2C_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-I2C_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-I2C_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-I2C_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/I2CSlave.md b/docs/api/drivers/I2CSlave.md index 3122fffa25..aad36e72a2 100644 --- a/docs/api/drivers/I2CSlave.md +++ b/docs/api/drivers/I2CSlave.md @@ -6,10 +6,10 @@ Synchronization level: not protected. ## I2CSlave class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_i2_c_slave.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_i2_c_slave.html) ## I2CSlave example Try this example to see how an I2C responder works. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-I2CSlave/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-I2CSlave/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-I2CSlave/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-I2CSlave/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/MbedCRC.md b/docs/api/drivers/MbedCRC.md index 8653b227a5..d7b4e48c0e 100644 --- a/docs/api/drivers/MbedCRC.md +++ b/docs/api/drivers/MbedCRC.md @@ -10,7 +10,7 @@ For boards that support hardware CRC, the MbedCRC API replaces the software impl ## MbedCRC class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/structcrc__mbed__config.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/structcrc__mbed__config.html) ## MbedCRC examples @@ -18,19 +18,19 @@ For boards that support hardware CRC, the MbedCRC API replaces the software impl Below is a CRC example to compute 32-bit CRC. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_1/blob/v6.14/main.cpp) ### Example 2 Below is a 32-bit CRC example using `compute_partial` APIs. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_2/blob/v6.14/main.cpp) ### Example 3 Below is a CRC example for the SD driver. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_3/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_3/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_3/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-CRC_ex_3/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/ResetReason.md b/docs/api/drivers/ResetReason.md index 75a777e0c8..559e1434ec 100644 --- a/docs/api/drivers/ResetReason.md +++ b/docs/api/drivers/ResetReason.md @@ -6,7 +6,7 @@ You can use the ResetReason interface to determine the cause of the last system ## ResetReason class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_reset_reason.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_reset_reason.html) ## ResetReason example diff --git a/docs/api/drivers/Watchdog.md b/docs/api/drivers/Watchdog.md index 2973b48612..6352080783 100644 --- a/docs/api/drivers/Watchdog.md +++ b/docs/api/drivers/Watchdog.md @@ -1,6 +1,6 @@ # Watchdog -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_watchdog.png)Watchdog class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_watchdog.png)Watchdog class hierarchy You can use the Watchdog interface to set up a hardware watchdog timer that resets the system in the case of system failures or malfunctions. @@ -12,11 +12,11 @@ If you fail to refresh the watchdog periodically, it resets the system after a s ## Watchdog class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_watchdog.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_watchdog.html) ## Watchdog example This example creates a watchdog timer that expires after five seconds and that you can refresh by pushing BUTTON1 on the target board: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Watchdog_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Watchdog_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Watchdog_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Watchdog_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/io/AnalogIn.md b/docs/api/drivers/io/AnalogIn.md index 5545d309c8..541e7e283c 100644 --- a/docs/api/drivers/io/AnalogIn.md +++ b/docs/api/drivers/io/AnalogIn.md @@ -12,11 +12,11 @@ The resolution for an ADC is the smallest distinguishable change in analog input ## AnalogIn class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_analog_in.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_analog_in.html) ## AnalogIn hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_3/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_3/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_3/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_3/blob/v6.14/main.cpp) ## AnalogIn examples @@ -24,10 +24,10 @@ The resolution for an ADC is the smallest distinguishable change in analog input Control an R/C servo with analog input. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_1/blob/v6.14/main.cpp) ### Example two This example shows AnalogIn reading 16-bit normalized samples. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-AnalogIn_ex_2/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/io/AnalogOut.md b/docs/api/drivers/io/AnalogOut.md index e8fba3b4f8..609c3e0336 100644 --- a/docs/api/drivers/io/AnalogOut.md +++ b/docs/api/drivers/io/AnalogOut.md @@ -6,14 +6,14 @@ Use the AnalogOut interface to set the output voltage of an analog output pin sp ## AnalogOut class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_analog_out.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_analog_out.html) ## AnalogOut hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-AnalogOut_ex_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-AnalogOut_ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-AnalogOut_ex_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-AnalogOut_ex_2/blob/v6.14/main.cpp) ## AnalogOut example Create a sine wave. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-AnalogOut_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-AnalogOut_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-AnalogOut_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-AnalogOut_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/io/BusIn.md b/docs/api/drivers/io/BusIn.md index 36d2a4c563..342af014c9 100644 --- a/docs/api/drivers/io/BusIn.md +++ b/docs/api/drivers/io/BusIn.md @@ -1,6 +1,6 @@ # BusIn -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_bus_in.png)BusIn class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_bus_in.png)BusIn class hierarchy With the BusIn API, you can combine a number of DigitalIn pins to read them at once. This abstraction is useful for checking multiple inputs together as single interface instead of individual pins. @@ -12,8 +12,8 @@ You can use any of the numbered Arm Mbed pins as a DigitalIn in the BusIn. ## BusIn class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_bus_in.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_bus_in.html) ## BusIn hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BusIn_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-BusIn_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BusIn_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-BusIn_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/io/BusInOut.md b/docs/api/drivers/io/BusInOut.md index 3106cb8603..5f00bf5df8 100644 --- a/docs/api/drivers/io/BusInOut.md +++ b/docs/api/drivers/io/BusInOut.md @@ -1,6 +1,6 @@ # BusInOut -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_bus_in_out.png)BusInOut class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_bus_in_out.png)BusInOut class hierarchy Use the BusInOut interface as a bidirectional bus that supports up to 16 [DigitalInOut](digitalinout.html) pins that you can read and write as one value. @@ -12,11 +12,11 @@ The order of pins in the constructor is the reverse order of the pins in the byt ## BusInOut class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_bus_in_out.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_bus_in_out.html) ## BusInOut hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BusInOut_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-BusInOut_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BusInOut_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-BusInOut_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/io/BusOut.md b/docs/api/drivers/io/BusOut.md index 503197885e..e328536654 100644 --- a/docs/api/drivers/io/BusOut.md +++ b/docs/api/drivers/io/BusOut.md @@ -1,6 +1,6 @@ # BusOut -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_bus_out.png)BusOut class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_bus_out.png)BusOut class hierarchy Use the BusOut interface to combine a number of [DigitalOut](digitalout.html) pins to write them at once. This API is useful for writing to multiple pins together as single interface instead of individual pins. @@ -13,11 +13,11 @@ You can use any of the numbered Arm Mbed pins as a DigitalOut in the BusOut. ## BusOut class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_bus_out.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_bus_out.html) ## BusOut hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BusOut_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-BusOut_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BusOut_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-BusOut_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/io/DigitalIn.md b/docs/api/drivers/io/DigitalIn.md index e90ac5b4aa..c61f9cfbeb 100644 --- a/docs/api/drivers/io/DigitalIn.md +++ b/docs/api/drivers/io/DigitalIn.md @@ -6,11 +6,11 @@ You can use any of the numbered Arm Mbed pins as a DigitalIn. ## DigitalIn class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_digital_in.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_digital_in.html) ## DigitalIn hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DigitalIn_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-DigitalIn_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DigitalIn_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-DigitalIn_ex_1/blob/v6.14/main.cpp) ## DigitalIn example @@ -18,7 +18,7 @@ To handle an interrupt, see [InterruptIn](interruptin.html). Examples of logical functions - boolean logic NOT, AND, OR, XOR: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DigitalIn_ex_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-DigitalIn_ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DigitalIn_ex_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-DigitalIn_ex_2/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/io/DigitalInOut.md b/docs/api/drivers/io/DigitalInOut.md index c2c5f119bd..402a9d3ddd 100644 --- a/docs/api/drivers/io/DigitalInOut.md +++ b/docs/api/drivers/io/DigitalInOut.md @@ -11,8 +11,8 @@ You can use any of the numbered Arm Mbed pins as a DigitalInOut. ## DigitalInOut class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_digital_in_out.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_digital_in_out.html) ## DigitalInOut hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DigitalInOut_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-DigitalInOut_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DigitalInOut_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-DigitalInOut_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/io/DigitalOut.md b/docs/api/drivers/io/DigitalOut.md index ffca690f34..26d39d969a 100644 --- a/docs/api/drivers/io/DigitalOut.md +++ b/docs/api/drivers/io/DigitalOut.md @@ -4,8 +4,8 @@ Use the DigitalOut interface to configure and control a digital output pin by se ## DigitalOut class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_digital_out.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_digital_out.html) ## DigitalOut hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DigitalOut_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-DigitalOut_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DigitalOut_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-DigitalOut_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/io/InterruptIn.md b/docs/api/drivers/io/InterruptIn.md index bbbe5b7d99..a10755e2b4 100644 --- a/docs/api/drivers/io/InterruptIn.md +++ b/docs/api/drivers/io/InterruptIn.md @@ -1,12 +1,12 @@ # InterruptIn -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_interrupt_in.png)InterruptIn class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_interrupt_in.png)InterruptIn class hierarchy Use the InterruptIn interface to trigger an event when a digital input pin changes. You can trigger interrupts on the rising edge (change from 0 to 1) or falling edge (change from 1 to 0) of signals. ## InterruptIn class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_interrupt_in.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_interrupt_in.html) **Warnings:** @@ -22,13 +22,13 @@ To read an input, see [DigitalIn](digitalin.html). ## InterruptIn hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-InterruptIn_ex_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-InterruptIn_ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-InterruptIn_ex_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-InterruptIn_ex_2/blob/v6.14/main.cpp) ## InterruptIn example Try the following example to count rising edges on a pin. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-InterruptIn_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-InterruptIn_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-InterruptIn_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-InterruptIn_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/io/PortIn.md b/docs/api/drivers/io/PortIn.md index f8df15a7c4..22b304a2e8 100644 --- a/docs/api/drivers/io/PortIn.md +++ b/docs/api/drivers/io/PortIn.md @@ -10,11 +10,11 @@ The device-specific `PinNames.h` and the respective datasheet or reference manua ## PortIn class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_port_in.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_port_in.html) ## PortIn hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PortIn_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-PortIn_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PortIn_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-PortIn_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/io/PortInOut.md b/docs/api/drivers/io/PortInOut.md index efba9cd407..3f2399be77 100644 --- a/docs/api/drivers/io/PortInOut.md +++ b/docs/api/drivers/io/PortInOut.md @@ -6,11 +6,11 @@ A mask can be supplied so you only use certain parts of a port, allowing other b ## PortInOut class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_port_in_out.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_port_in_out.html) ## PortInOut hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PortInOut_ex_1/main.cpp)](https://github.com/ARMmbed/mbed-os-snippet-PortInOut_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PortInOut_ex_1/main.cpp)](https://github.com/ARMmbed/mbed-os-snippet-PortInOut_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/io/PortOut.md b/docs/api/drivers/io/PortOut.md index a4313f4cb8..4ec8e48c59 100644 --- a/docs/api/drivers/io/PortOut.md +++ b/docs/api/drivers/io/PortOut.md @@ -10,11 +10,11 @@ The device-specific `PinNames.h` and the respective datasheet or reference manua ## PortOut class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_port_out.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_port_out.html) ## PortOut hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PortOut_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-PortOut_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PortOut_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-PortOut_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/io/PwmOut.md b/docs/api/drivers/io/PwmOut.md index bc96777de4..318c52ad5c 100644 --- a/docs/api/drivers/io/PwmOut.md +++ b/docs/api/drivers/io/PwmOut.md @@ -9,13 +9,13 @@ Use the PwmOut interface to control the frequency and duty cycle of a PWM signal ## PwmOut class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_pwm_out.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_pwm_out.html) ## PwmOut hello, world This code example uses the default period of 0.020s and ramps the duty cycle from 0% to 100% in increments of 10%. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_3/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_3/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_3/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_3/blob/v6.14/main.cpp) ## PwmOut code examples @@ -23,10 +23,10 @@ This code example uses the default period of 0.020s and ramps the duty cycle fro This code example sets the period in seconds and the duty cycle as a percentage of the period in floating point (range: 0 to 1). The effect of this code snippet will be to blink LED2 over a four-second cycle, 50% on, for a pattern of two seconds on, two seconds off. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_1/blob/v6.14/main.cpp) ### Example two The following example does the same thing, but instead of specifying the duty cycle as a relative percentage of the period, it specifies it as an absolute value in seconds. In this case we have a four-second period and a two-second duty cycle, meaning the LED will be on for two seconds and off for two seconds. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-PwmOut_ex_2/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/spi/QuadSPI.md b/docs/api/drivers/spi/QuadSPI.md index d8bbf92f17..ace5550e9b 100644 --- a/docs/api/drivers/spi/QuadSPI.md +++ b/docs/api/drivers/spi/QuadSPI.md @@ -2,7 +2,7 @@ ## QSPI class hierarchy -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_q_s_p_i.png)QSPI class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_q_s_p_i.png)QSPI class hierarchy The QSPI driver in Mbed OS provides functionality to configure and access QSPI devices connected over a QuadSPI interface. @@ -18,11 +18,11 @@ For more information, please review the related content. ## QuadSPI class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_q_s_p_i.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_q_s_p_i.html) ## QuadSPI example - [![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-QSPI/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-QSPI/blob/v6.7/main.cpp) + [![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-QSPI/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-QSPI/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/spi/SPI.md b/docs/api/drivers/spi/SPI.md index ce3a8b0c74..f2c3cedd13 100644 --- a/docs/api/drivers/spi/SPI.md +++ b/docs/api/drivers/spi/SPI.md @@ -1,6 +1,6 @@ # SPI -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_s_p_i.png)SPI class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_s_p_i.png)SPI class hierarchy The SPI Interface provides a Serial Peripheral Interface Master. @@ -25,10 +25,10 @@ The SPI master generates a clock to synchronously drive a serial bit stream slav ## SPI class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_s_p_i.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_s_p_i.html) ## SPI hello, world The following example uses the WHOAMI register. The WHOAMI register is an ID register of the slave device. In other words, it's just an example that you can write to a slave's register. In this example, Mbed OS acts as the SPI master, and DigitalOut acts as the slave chip select (cs). -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SPI_HelloWorld/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-SPI_HelloWorld/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SPI_HelloWorld/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-SPI_HelloWorld/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/spi/SPISlave.md b/docs/api/drivers/spi/SPISlave.md index 2918b0c71d..ef8087ba76 100644 --- a/docs/api/drivers/spi/SPISlave.md +++ b/docs/api/drivers/spi/SPISlave.md @@ -1,6 +1,6 @@ # SPISlave -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_s_p_i_slave.png)SPISlave class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_s_p_i_slave.png)SPISlave class hierarchy Use the SPISlave class to communicate with a SPI master device. @@ -8,8 +8,8 @@ The default format is set to 8 bits, mode 0 and a clock frequency of 1MHz. Synch ## SPISlave class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_s_p_i_slave.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_s_p_i_slave.html) ## SPISlave example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SPISlave/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-SPISlave/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SPISlave/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-SPISlave/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/tutorials/Mbed_USB_WAV_Audio_Player/Mbed_USB_WAV_Audio_Player.md b/docs/api/drivers/tutorials/Mbed_USB_WAV_Audio_Player/Mbed_USB_WAV_Audio_Player.md index 5ab34f4c01..e58a2885af 100644 --- a/docs/api/drivers/tutorials/Mbed_USB_WAV_Audio_Player/Mbed_USB_WAV_Audio_Player.md +++ b/docs/api/drivers/tutorials/Mbed_USB_WAV_Audio_Player/Mbed_USB_WAV_Audio_Player.md @@ -81,7 +81,7 @@ If USB properties of the Mbed USB WAV Audio Player are altered, such as the samp ## main.cpp -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBAudio_wav_audio_player/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBAudio_wav_audio_player/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBAudio_wav_audio_player/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBAudio_wav_audio_player/blob/v6.14/main.cpp) ## Example WAV file diff --git a/docs/api/drivers/tutorials/alarm-tutorial.md b/docs/api/drivers/tutorials/alarm-tutorial.md index 51947a2fb9..fe1a2873c8 100644 --- a/docs/api/drivers/tutorials/alarm-tutorial.md +++ b/docs/api/drivers/tutorials/alarm-tutorial.md @@ -17,7 +17,7 @@ cd mbed-os-example-alarm If using the Online Compiler, click the **Import into Mbed IDE** button below: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Alarm/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Alarm/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Alarm/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Alarm/blob/v6.14/main.cpp) ## Compile and flash to your board diff --git a/docs/api/drivers/uart/BufferedSerial.md b/docs/api/drivers/uart/BufferedSerial.md index 3b10bc7990..01f4059ec4 100644 --- a/docs/api/drivers/uart/BufferedSerial.md +++ b/docs/api/drivers/uart/BufferedSerial.md @@ -1,6 +1,6 @@ # BufferedSerial -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_buffered_serial.png)`BufferedSerial` class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_buffered_serial.png)`BufferedSerial` class hierarchy The `BufferedSerial` class provides UART functionality. We recommend you use this class for serial data transfers. You can use it to send and receive bytes of data in a sequence using separate transmit (TX) and receive pins (RX). A device can interface with another device (such as sensors, printers or another board) to exchange data or to send text to be displayed on a text-based computer interface. @@ -50,13 +50,13 @@ You can view more information about the configurable settings and functions in t ## BufferedSerial class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_buffered_serial.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_buffered_serial.html) ## BufferedSerial examples This example toggles an LED and echoes input to a terminal: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BufferedSerial_echo/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-BufferedSerial_echo/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BufferedSerial_echo/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-BufferedSerial_echo/blob/v6.14/main.cpp) ### Printing to the console @@ -66,6 +66,6 @@ You can configure the system I/O retarget code to be buffered or unbuffered, dep Alternatively, if you need more configuration of the serial interface, you can pass an instance of the `BufferedSerial` class to the system I/O retarget code at run time for printing to the console: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BufferedSerial_printf/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-BufferedSerial_printf/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BufferedSerial_printf/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-BufferedSerial_printf/blob/v6.14/main.cpp) We recommend you use the standard C I/O library directly to print to the console in Mbed OS. diff --git a/docs/api/drivers/uart/UnbufferedSerial.md b/docs/api/drivers/uart/UnbufferedSerial.md index d9e46550a0..cf6783e355 100644 --- a/docs/api/drivers/uart/UnbufferedSerial.md +++ b/docs/api/drivers/uart/UnbufferedSerial.md @@ -1,6 +1,6 @@ # UnbufferedSerial -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_unbuffered_serial.png)`UnbufferedSerial` class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_unbuffered_serial.png)`UnbufferedSerial` class hierarchy The UnbufferedSerial class provides UART functionality with an API similar to the [BufferedSerial](../apis/serial-uart-apis.html) class. The classes also share the same default configurations. @@ -12,11 +12,11 @@ You can view more information about the configurable settings and functions in t ## Class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_unbuffered_serial.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_unbuffered_serial.html) ## UnbufferedSerial Example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UnbufferedSerial/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-UnbufferedSerial/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UnbufferedSerial/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-UnbufferedSerial/blob/v6.14/main.cpp) ## Mbed OS use diff --git a/docs/api/drivers/usb/USBAudio.md b/docs/api/drivers/usb/USBAudio.md index 20050243f7..b32f59c8b7 100644 --- a/docs/api/drivers/usb/USBAudio.md +++ b/docs/api/drivers/usb/USBAudio.md @@ -1,27 +1,27 @@ # USBAudio -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_audio.png)USBAudio class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_audio.png)USBAudio class hierarchy You can use the USBAudio interface to send and receive audio data over USB. Once a USB program is loaded onto the Mbed board, you can send audio data to your PC by selecting **Mbed Audio** as your PC's microphone input. Your Mbed Enabled board can receive audio data from your PC if you select **Mbed Audio** as your PC's speaker output. ## USBAudio class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_audio.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_audio.html) ## USBAudio square wave example This example outputs an audio square wave over USB. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBAudio_square_wave/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBAudio_square_wave/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBAudio_square_wave/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBAudio_square_wave/blob/v6.14/main.cpp) ## USBAudio loopback example This example loops input audio to the Mbed board back to the host PC, so that you may record the audio or listen to it through headphones or speakers. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBAudio_loopback_example/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBAudio_loopback_example/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBAudio_loopback_example/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBAudio_loopback_example/blob/v6.14/main.cpp) ## USBAudio play sound data example This example loads raw audio data to your board's flash. That data then plays on the host PC over USB. We have tested this example with the NXP FRDM-K64F, which has 1 MB of flash memory. If you are using a board that has less than 1 MB of flash memory, delete data from the end of the `data` array, and set `NUM_ELEMENTS` accordingly until the program size is small enough to flash without exceeding storage. Follow the link below, and click Ctrl + s to save the raw code view for `main.cpp`. -### [main.cpp](https://github.com/ARMmbed/mbed-os-snippet-USBAudio_play_sound/blob/v6.7/main.cpp) +### [main.cpp](https://github.com/ARMmbed/mbed-os-snippet-USBAudio_play_sound/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/usb/USBCDC.md b/docs/api/drivers/usb/USBCDC.md index e9c385e948..0e64a6508e 100644 --- a/docs/api/drivers/usb/USBCDC.md +++ b/docs/api/drivers/usb/USBCDC.md @@ -1,16 +1,16 @@ # USBCDC -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_c_d_c.png)USBCDC class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_c_d_c.png)USBCDC class hierarchy The USBCDC class emulates a basic serial port over USB. You can use this serial port to send or receive data. If you want printf functionality, please see the [USBSerial](../apis/usbserial.html) class. ## USBCDC class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_c_d_c.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_c_d_c.html) ## USBCDC example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBCDC/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBCDC/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBCDC/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBCDC/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/usb/USBCDC_ECM.md b/docs/api/drivers/usb/USBCDC_ECM.md index f46303e9fd..719b2d9389 100644 --- a/docs/api/drivers/usb/USBCDC_ECM.md +++ b/docs/api/drivers/usb/USBCDC_ECM.md @@ -1,6 +1,6 @@ # USBCDC_ECM -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_c_d_c___e_c_m.png)USBCDC_ECM class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_c_d_c___e_c_m.png)USBCDC_ECM class hierarchy The USBCDC_ECM class emulates an Ethernet interface over USB. You can use the interface to send and receive Ethernet frames over USB. @@ -23,4 +23,4 @@ The example below sends an Ethernet frame that carries "Hello world" payload wit 5. Click captured packet from source address 12:34:56:78:9a:bc to see the "Hello world" payload. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBCDC_ECM/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBCDC_ECM/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBCDC_ECM/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBCDC_ECM/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/usb/USBHID.md b/docs/api/drivers/usb/USBHID.md index 75aa51bee3..a3f124c01a 100644 --- a/docs/api/drivers/usb/USBHID.md +++ b/docs/api/drivers/usb/USBHID.md @@ -1,24 +1,24 @@ # USBHID -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_h_i_d.png)USBHID class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_h_i_d.png)USBHID class hierarchy You can use the USBHID class to turn an Mbed board into an HID (Human Interface Device) that can send and receive messages over USB. For example, you can define your own protocol and communicate between your computer and Mbed with all capabilities of USB communication. To use USBHID, you need a script running on the host side (computer). For example, on a Windows machine, you can use [pywinusb](https://github.com/rene-aguirre/pywinusb). For convenience, there is a Python script attached below that uses pywinusb that can be run on the host computer to send and receive data from the Mbed board. ## USBHID class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_h_i_d.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_h_i_d.html) ## USBHID example ### main.cpp -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBHID/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBHID/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBHID/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBHID/blob/v6.14/main.cpp) ### USBHID.py To use this script, first flash the Mbed board with the code above. Connect the target's USB to the host computer. Then run this script. The script will send 8 bytes of data (1 2 3 4 5 6 7 8) to the Mbed board and will read and print the data sent to the host computer by the Mbed board. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBHID/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBHID/blob/v6.7/USBHID.py) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBHID/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBHID/blob/v6.14/USBHID.py) ## Related content diff --git a/docs/api/drivers/usb/USBKeyboard.md b/docs/api/drivers/usb/USBKeyboard.md index 02d18c8242..c9185b0e7f 100644 --- a/docs/api/drivers/usb/USBKeyboard.md +++ b/docs/api/drivers/usb/USBKeyboard.md @@ -1,16 +1,16 @@ # USBKeyboard -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_keyboard.png)USBKeyboard class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_keyboard.png)USBKeyboard class hierarchy The USBKeyboard class provides the functionality of a keyboard. You can send key presses, check the status of control keys and send a key press sequences though a stream interface. If you need mouse or keyboard and mouse functionality, please see the [USBMouse](../apis/usbmouse.html) and [USBMouseKeyboard](../apis/usbmousekeyboard.html) classes. ## USBKeyboard class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_keyboard.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_keyboard.html) ## USBKeyboard example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBKeyboard/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBKeyboard/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBKeyboard/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBKeyboard/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/usb/USBMIDI.md b/docs/api/drivers/usb/USBMIDI.md index 9784cf6e2b..04bc1d39d8 100644 --- a/docs/api/drivers/usb/USBMIDI.md +++ b/docs/api/drivers/usb/USBMIDI.md @@ -1,6 +1,6 @@ # USBMIDI -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_m_i_d_i.png)USBMIDI class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_m_i_d_i.png)USBMIDI class hierarchy You can use the USBMIDI interface to send and receive MIDI messages over USB using the standard USB-MIDI protocol. @@ -8,7 +8,7 @@ Examples of tasks you can perform using this library include sending MIDI messag ## USBMIDI class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_m_i_d_i.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_m_i_d_i.html) The two examples below use a program called "Anvil Studio 32-bit" to play MIDI notes from an Mbed board through the host PC. You can play back the MIDI notes through headphones or speakers by following the steps below: @@ -22,10 +22,10 @@ The two examples below use a program called "Anvil Studio 32-bit" to play MIDI n Below is an example to send a series of MIDI notes to the host PC: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMIDI/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBMIDI/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMIDI/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBMIDI/blob/v6.14/main.cpp) ## Play "Take Me Out to the Ball Game" example You can use USBMIDI to play an entire song, not just a series of notes. "Take Me Out to the Ball Game" is a popular song in the public domain. To play "Take Me Out to the Ball Game" (public domain) using MIDI over USB on the host PC: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMIDI_Take_Me_Out/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBMIDI_Take_Me_Out/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMIDI_Take_Me_Out/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBMIDI_Take_Me_Out/blob/v6.14/main.cpp) diff --git a/docs/api/drivers/usb/USBMSD.md b/docs/api/drivers/usb/USBMSD.md index 6bad0e6af5..e3515f5022 100644 --- a/docs/api/drivers/usb/USBMSD.md +++ b/docs/api/drivers/usb/USBMSD.md @@ -1,20 +1,20 @@ # USBMSD -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_m_s_d.png)USBMSD class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_m_s_d.png)USBMSD class hierarchy You can use the USBMSD interface to emulate a mass storage device over USB. You can use this class to store or load data to and from a storage chip, such as SDcard or Flash. This class implements the MSD protocol and takes in a [BlockDevice](blockdevice.html) to interact with a storage chip. ## USBMSD class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_m_s_d.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_m_s_d.html) ## USBMSD SDBlockDevice example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMSD_SDBlockDevice/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBMSD_SDBlockDevice/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMSD_SDBlockDevice/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBMSD_SDBlockDevice/blob/v6.14/main.cpp) ## USBMSD HeapBlockDevice example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMSD_HeapBlockDevice/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBMSD_HeapBlockDevice/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMSD_HeapBlockDevice/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBMSD_HeapBlockDevice/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/usb/USBMouse.md b/docs/api/drivers/usb/USBMouse.md index 57f51d7a27..1c782c8a76 100644 --- a/docs/api/drivers/usb/USBMouse.md +++ b/docs/api/drivers/usb/USBMouse.md @@ -1,26 +1,26 @@ # USBMouse -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_mouse.png)USBMouse class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_mouse.png)USBMouse class hierarchy You can use the USBMouse interface to emulate a mouse over the USB port. You can choose relative or absolute coordinates and send clicks, button state and scroll wheel movements. If you need keyboard or keyboard and mouse functionality, please see the [USBKeyboard](../apis/usbkeyboard.html) and [USBMouseKeyboard](../apis/usbmousekeyboard.html) classes. ## USBMouse class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_mouse.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_mouse.html) ## USBMouse example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMouse_relative_pos/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBMouse_relative_pos/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMouse_relative_pos/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBMouse_relative_pos/blob/v6.14/main.cpp) You can choose either a relative mouse or an absolute mouse. With a relative mouse, the USBMouse move function will move the mouse x, y pixels away from its previous position on the screen. For an absolute mouse, the USBMouse move function will move the mouse to coordinates x, y on the screen. By default, a USBMouse is a relative mouse. For example, you can use an absolute mouse to draw a circle: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMouse_absolute_pos/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBMouse_absolute_pos/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMouse_absolute_pos/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBMouse_absolute_pos/blob/v6.14/main.cpp) ## USBMouse Joystick example This example uses a Grove - Thumb Joystick to act as a mouse. Use the joystick to move the mouse around the screen and click the joystick down to do a mouse left click. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMouse_joystick/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBMouse_joystick/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMouse_joystick/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBMouse_joystick/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/usb/USBMouseKeyboard.md b/docs/api/drivers/usb/USBMouseKeyboard.md index bbb4ab5196..ab068d42fc 100644 --- a/docs/api/drivers/usb/USBMouseKeyboard.md +++ b/docs/api/drivers/usb/USBMouseKeyboard.md @@ -1,16 +1,16 @@ # USBMouseKeyboard -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_mouse_keyboard.png)USBMouseKeyboard class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_mouse_keyboard.png)USBMouseKeyboard class hierarchy You can use the USBMouseKeyboard interface to emulate a mouse and a keyboard at the same time over the USB port. You can send both key presses and mouse movements with this class. ## USBMouseKeyboard class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_mouse_keyboard.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_mouse_keyboard.html) ## USBMouseKeyboard example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMouseKeyboard/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBMouseKeyboard/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBMouseKeyboard/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBMouseKeyboard/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/drivers/usb/USBSerial.md b/docs/api/drivers/usb/USBSerial.md index 32a273a89d..50308a9edb 100644 --- a/docs/api/drivers/usb/USBSerial.md +++ b/docs/api/drivers/usb/USBSerial.md @@ -1,16 +1,16 @@ # USBSerial -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_serial.png)USBSerial class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_serial.png)USBSerial class hierarchy You can use the USBSerial interface to emulate a serial port over USB. You can use this serial port as an extra serial port or as a debug solution. ## USBSerial class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_u_s_b_serial.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_u_s_b_serial.html) ## USBSerial example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBSerial/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-USBSerial/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-USBSerial/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-USBSerial/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/ATCmdParser.md b/docs/api/platform/ATCmdParser.md index bc55832ab7..498cccb0ba 100644 --- a/docs/api/platform/ATCmdParser.md +++ b/docs/api/platform/ATCmdParser.md @@ -1,6 +1,6 @@ # ATCmdParser -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_a_t_cmd_parser.png)ATCmdParser class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_a_t_cmd_parser.png)ATCmdParser class hierarchy ATCmdParser is an Mbed OS AT command parser and serializer. AT commands are instructions used to communicate with a communication device such as a modem, phone or Wi-Fi module. Each command is a text string in ASCII format, and every command starts with "AT" characters followed by a command specifying the operation to be carried out. @@ -12,7 +12,7 @@ To use the ATCmdParser, the entity creating the ATCmdParser object passes a refe ## ATCmdParser class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_a_t_cmd_parser.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_a_t_cmd_parser.html) ## ATCmdParser Example diff --git a/docs/api/platform/Assert.md b/docs/api/platform/Assert.md index 2075aa348e..1fbac90680 100644 --- a/docs/api/platform/Assert.md +++ b/docs/api/platform/Assert.md @@ -4,7 +4,7 @@ Mbed OS provides a set of macros that evaluates an expression and prints an erro ## Assert macros reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/mbed__assert_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/mbed__assert_8h_source.html) ## Assert example diff --git a/docs/api/platform/Callback.md b/docs/api/platform/Callback.md index 3ea9ecd8be..9b3eaa9044 100644 --- a/docs/api/platform/Callback.md +++ b/docs/api/platform/Callback.md @@ -40,19 +40,19 @@ Two system configuration options permit trade-offs between image size and flexib ## Callback class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_callback.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_callback.html) ## Serial passthrough example with callbacks -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Callback_SerialPassthrough/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Callback_SerialPassthrough/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Callback_SerialPassthrough/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Callback_SerialPassthrough/blob/v6.14/main.cpp) ## Thread example with callbacks The Callback API provides a convenient way to pass arguments to spawned threads. This example uses a C function pointer in the Callback. - [![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Threading_with_callback/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Threading_with_callback/blob/v6.7/main.cpp) + [![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Threading_with_callback/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Threading_with_callback/blob/v6.14/main.cpp) ## Sonar example Here is an example that uses everything discussed in the [introduction to callbacks](../apis/platform-concepts.html#callbacks) document in the form of a minimal Sonar class. This example uses a C++ class and method in the Callback. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Sonar/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Sonar/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Sonar/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Sonar/blob/v6.14/main.cpp) diff --git a/docs/api/platform/CircularBuffer.md b/docs/api/platform/CircularBuffer.md index 1d38981c68..6733bcc8cf 100644 --- a/docs/api/platform/CircularBuffer.md +++ b/docs/api/platform/CircularBuffer.md @@ -20,8 +20,8 @@ CircularBuffer buf; ## CircularBuffer class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_circular_buffer.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_circular_buffer.html) ## CircularBuffer example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CircularBuffer_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-CircularBuffer_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CircularBuffer_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-CircularBuffer_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/platform/CriticalSectionLock.md b/docs/api/platform/CriticalSectionLock.md index 9103470199..3a8eb186bc 100644 --- a/docs/api/platform/CriticalSectionLock.md +++ b/docs/api/platform/CriticalSectionLock.md @@ -10,10 +10,10 @@ Mbed OS supports nesting of critical section, and the destructor enables interru ## CriticalSectionLock class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_critical_section_lock.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_critical_section_lock.html) ## CriticalSectionLock example Here is an example that demonstrates a race condition issue and how CriticalSectionLock helps resolves it. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CriticalSectionLock_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-CriticalSectionLock_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-CriticalSectionLock_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-CriticalSectionLock_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/platform/Debug.md b/docs/api/platform/Debug.md index f988c7a4f3..c426579b00 100644 --- a/docs/api/platform/Debug.md +++ b/docs/api/platform/Debug.md @@ -27,8 +27,8 @@ void *operator new(std::size_t count) { ## Debug functions reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/mbed__debug_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/mbed__debug_8h_source.html) ## Debug example -[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Utils_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Utils_ex_1/blob/v6.7/main.cpp) +[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Utils_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Utils_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/platform/Error.md b/docs/api/platform/Error.md index 4bc956d052..2a777a89eb 100644 --- a/docs/api/platform/Error.md +++ b/docs/api/platform/Error.md @@ -124,7 +124,7 @@ Error handling implementation in Mbed OS keeps track of previous errors in the s See the below link to learn more about the APIs related to error history: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/mbed__error_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/mbed__error_8h_source.html) ## Extending error codes @@ -179,7 +179,7 @@ Crash reporting feature also provides APIs to read and clear error context infor The below link provides the documentation for all the APIs that Mbed OS provides for error definitions and handling: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/mbed__error_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/mbed__error_8h_source.html) ## Error handling API examples @@ -434,13 +434,13 @@ void clear_reboot_count() { The example application below demonstrates usage of error handling APIs: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-error-handling)](https://github.com/ARMmbed/mbed-os-example-error-handling/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-error-handling)](https://github.com/ARMmbed/mbed-os-example-error-handling/blob/mbed-os-6.14.0/main.cpp) ## Crash reporting example The example application below demonstrates the crash reporting feature: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-crash-reporting)](https://github.com/ARMmbed/mbed-os-example-crash-reporting/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-crash-reporting)](https://github.com/ARMmbed/mbed-os-example-crash-reporting/blob/mbed-os-6.14.0/main.cpp) ## List of Mbed OS defined error codes and descriptions @@ -521,7 +521,7 @@ For each of the above mentioned error codes, a corresponding system error status See the below Doxygen file for additional information regarding error code definitions: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/mbed__error_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/mbed__error_8h_source.html) ## Related content diff --git a/docs/api/platform/FileHandle.md b/docs/api/platform/FileHandle.md index 715fbc061e..0eefac4bdd 100644 --- a/docs/api/platform/FileHandle.md +++ b/docs/api/platform/FileHandle.md @@ -1,6 +1,6 @@ # FileHandle -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_file_handle.png)FileHandle class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_file_handle.png)FileHandle class hierarchy For general information on [files](file.html) and [filing systems](filesystem.html) in persistent storage, see their documentation. This chapter covers the abstract API, with an emphasis on devices. @@ -181,15 +181,15 @@ As such, you can only use `Stream`-based devices for blocking I/O, such as throu ## FileHandle class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_file_handle.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_file_handle.html) ## FileHandle using C library example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-FileHandle/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-FileHandle/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-FileHandle/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-FileHandle/blob/v6.14/main.cpp) ## FileHandle sigio example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-FileHandle_sigio/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-FileHandle_sigio/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-FileHandle_sigio/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-FileHandle_sigio/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/FilePath.md b/docs/api/platform/FilePath.md index 16b8fb13dd..3b82441bb3 100644 --- a/docs/api/platform/FilePath.md +++ b/docs/api/platform/FilePath.md @@ -3,7 +3,7 @@ [Add description here.] ## FilePath class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_file_path.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_file_path.html) ## FilePath example diff --git a/docs/api/platform/NonCopyable.md b/docs/api/platform/NonCopyable.md index f823c9aa41..6fe8f62950 100644 --- a/docs/api/platform/NonCopyable.md +++ b/docs/api/platform/NonCopyable.md @@ -49,7 +49,7 @@ We recommend inheriting from the `NonCopyable` class whenever a class is a resou ## NonCopyable class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_non_copyable.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_non_copyable.html) ## NonCopyable example diff --git a/docs/api/platform/PlatformMutex.md b/docs/api/platform/PlatformMutex.md index c1b2706626..d542a97a03 100644 --- a/docs/api/platform/PlatformMutex.md +++ b/docs/api/platform/PlatformMutex.md @@ -1,6 +1,6 @@ # PlatformMutex -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_platform_mutex.png)PlatformMutex class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_platform_mutex.png)PlatformMutex class hierarchy You can use the PlatformMutex class to synchronize the execution of threads. @@ -10,11 +10,11 @@ The Mbed OS drivers use the PlatformMutex class instead of [Mutex](../apis/mutex ## PlatformMutex class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_platform_mutex.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_platform_mutex.html) ## PlatformMutex example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PlatformMutex_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-PlatformMutex_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PlatformMutex_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-PlatformMutex_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/Poll.md b/docs/api/platform/Poll.md index 131ce48c7f..bd1864d430 100644 --- a/docs/api/platform/Poll.md +++ b/docs/api/platform/Poll.md @@ -15,11 +15,11 @@ As per the POSIX specification, `poll` always indicates that ordinary files (as ## Poll reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__platform__poll.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__platform__poll.html) ## Poll example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Poll/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Poll/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Poll/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Poll/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/ScopedRamExecutionLock.md b/docs/api/platform/ScopedRamExecutionLock.md index 43edbe490a..055a3ddb48 100644 --- a/docs/api/platform/ScopedRamExecutionLock.md +++ b/docs/api/platform/ScopedRamExecutionLock.md @@ -1,18 +1,18 @@ # ScopedRamExecutionLock -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_scoped_ram_execution_lock.png)ScopedRamExecutionLock class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_scoped_ram_execution_lock.png)ScopedRamExecutionLock class hierarchy The `ScopedRamExecutionLock` class provides an RAII object for enabling execution from RAM. In other words, creating a ScopedRamExecutionLock object calls its constructor, which increments the RAM execution lock. The ScopedRamExecutionLock object automatically releases the RAM execution lock in its destructor when the object goes out of scope. Another way to look at this is when the ScopedRamExecutionLock object exists, it allows execution from RAM. ## ScopedRamExecutionLock class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_scoped_ram_execution_lock.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_scoped_ram_execution_lock.html) ## Example This example shows how you can enable execution from RAM from main: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ScopedRamExecutionLock/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-ScopedRamExecutionLock/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ScopedRamExecutionLock/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-ScopedRamExecutionLock/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/ScopedRomWriteLock.md b/docs/api/platform/ScopedRomWriteLock.md index 0c8dff8f30..cbe9c484b6 100644 --- a/docs/api/platform/ScopedRomWriteLock.md +++ b/docs/api/platform/ScopedRomWriteLock.md @@ -1,18 +1,18 @@ # ScopedRomWriteLock -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_scoped_rom_write_lock.png)ScopedRomWriteLock class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_scoped_rom_write_lock.png)ScopedRomWriteLock class hierarchy The `ScopedRomWriteLock` class provides an RAII object for enabling writing to ROM. In other words, creating a ScopedRomWriteLock object calls its constructor, which increments the ROM write lock. The ScopedRomWriteLock object automatically releases the ROM write lock in its destructor when the object goes out of scope. Another way to look at this is when the ScopedRomWriteLock object exists, it allows writing to ROM. ## ScopedRomWriteLock class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_scoped_rom_write_lock.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_scoped_rom_write_lock.html) ## Example This example shows how you can enable writes to ROM from main. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ScopedRomWriteLock/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-ScopedRomWriteLock/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ScopedRomWriteLock/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-ScopedRomWriteLock/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/SharedPtr.md b/docs/api/platform/SharedPtr.md index bc70aaf34f..23ed2ab7e1 100644 --- a/docs/api/platform/SharedPtr.md +++ b/docs/api/platform/SharedPtr.md @@ -11,8 +11,8 @@ When `ptr` is passed around by a value, the copy constructor and destructor mana ## SharedPtr class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_shared_ptr.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_shared_ptr.html) ## Shared pointer example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Shared_pointer/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Shared_pointer/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Shared_pointer/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Shared_pointer/blob/v6.14/main.cpp) diff --git a/docs/api/platform/Span.md b/docs/api/platform/Span.md index bcca32ae56..d38e093373 100644 --- a/docs/api/platform/Span.md +++ b/docs/api/platform/Span.md @@ -88,16 +88,16 @@ When you encode the size of the sequence viewed in the Span value, Span instance ## Span class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/structmbed_1_1_span.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/structmbed_1_1_span.html) ## Span example C++ code: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Span_cpp/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Span_cpp/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Span_cpp/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Span_cpp/blob/v6.14/main.cpp) C code: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Span_c/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Span_c/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Span_c/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Span_c/blob/v6.14/main.cpp) diff --git a/docs/api/platform/Stream.md b/docs/api/platform/Stream.md index 159f53e35d..705b9b8248 100644 --- a/docs/api/platform/Stream.md +++ b/docs/api/platform/Stream.md @@ -1,12 +1,12 @@ # Stream -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_stream.png)Stream class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_stream.png)Stream class hierarchy [Add description here.] ## Stream class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_stream.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_stream.html) ## Stream example diff --git a/docs/api/platform/flow_control.md b/docs/api/platform/flow_control.md index 465ba0b08f..16d7ffff01 100644 --- a/docs/api/platform/flow_control.md +++ b/docs/api/platform/flow_control.md @@ -19,7 +19,7 @@ The Wait API creates delays by actively blocking the execution for a period of t Here is an example that uses the API's `wait_us()` function to wait a number of microseconds: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Busy-Wait)](https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Busy-Wait/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Busy-Wait)](https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Busy-Wait/blob/v6.14/main.cpp) The processor is active for the entire duration, so the Wait API is suitable when you need short delays (nanoseconds to a few microseconds) without triggering [sleep modes](../apis/power-management-sleep.html), which have some wake-up latencies. It is also safe to use in interrupt contexts. However, we do not recommend busy waiting for longer delays: the system may not be able to switch to other tasks or save power by sleeping. @@ -31,7 +31,7 @@ For longer delays - millisecond to seconds - use one of the other techniques. Here is an example that uses a ticker object: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Ticker)](https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Ticker/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Ticker)](https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Ticker/blob/v6.14/main.cpp) **Warning:** A ticker/timeout's handlers are executed in interrupt contexts and thus, like any interrupt handlers, should return quickly and not use `printf` or APIs that are not intended for interrupts. @@ -41,7 +41,7 @@ If you don't need the precision of a high-frequency Ticker or Timeout, we recomm If your application is running in RTOS mode then [Threads](../apis/thread.html) are another efficient way to blink an LED. During the waiting period, Mbed OS automatically conserves power and deals with other tasks. This makes Threads the most efficient way to run tasks in Mbed OS. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Thread)](https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Thread/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Thread)](https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Thread/blob/v6.14/main.cpp) ### EventQueue @@ -60,7 +60,7 @@ Let’s use a DigitalIn pin from the button to control the application. There ar We can wait for digital input the same way we waited for time to pass - using a `while()` loop. In the example below the digital input is a button press, which causes the application to flash the LED and then wait for one second. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Active-Polling-Button)](https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Active-Polling-Button/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Active-Polling-Button)](https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Active-Polling-Button/blob/v6.14/main.cpp) We constantly poll the button to see whether it has a value that matches `BUTTON_PRESS`. If it matches, we toggle the LED and wait one second. @@ -70,7 +70,7 @@ We constantly poll the button to see whether it has a value that matches `BUTTON An alternative way to poll the button is to use an interrupt. Interrupts let you say `when that pin changes value, call this function`. In other words, we can tell the MCU to call a function when the button is pressed. In our case, that function toggles the LED: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Interrupt-Button)](https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Interrupt-Button/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Interrupt-Button)](https://github.com/ARMmbed/mbed-os-snippet-Flow-Control-Interrupt-Button/blob/v6.14/main.cpp) In the code above a heartbeat function runs on LED2, which lets you see that your code is running. Then we connect an InterruptIn object to the button and set it so that when the button rises from 0 to 1, the toggle function is called; the function toggles LED1. This way the application can turn the LED on and off as needed, without needing to “waste” time waiting or actively polling an inactive button. The MCU is free to move on to other things . diff --git a/docs/api/platform/memory/MbedStats.md b/docs/api/platform/memory/MbedStats.md index 256eb12bcc..84795379fe 100644 --- a/docs/api/platform/memory/MbedStats.md +++ b/docs/api/platform/memory/MbedStats.md @@ -75,23 +75,23 @@ You can use the `mbed_stats_cpu_get` function to get the uptime, idle time and s ## Mbed statistics function reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/mbed__stats_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/mbed__stats_8h_source.html) ## Memory statistics example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Utils_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Utils_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Utils_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Utils_ex_1/blob/v6.14/main.cpp) ## Thread statistics example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-thread-statistics)](https://github.com/ARMmbed/mbed-os-example-thread-statistics/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-thread-statistics)](https://github.com/ARMmbed/mbed-os-example-thread-statistics/blob/mbed-os-6.14.0/main.cpp) ## System information example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-sys-info)](https://github.com/ARMmbed/mbed-os-example-sys-info/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-sys-info)](https://github.com/ARMmbed/mbed-os-example-sys-info/blob/mbed-os-6.14.0/main.cpp) ## CPU statistics example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-cpu-stats)](https://github.com/ARMmbed/mbed-os-example-cpu-stats/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-cpu-stats)](https://github.com/ARMmbed/mbed-os-example-cpu-stats/blob/mbed-os-6.14.0/main.cpp) ## Related content diff --git a/docs/api/platform/memory/MemTrace.md b/docs/api/platform/memory/MemTrace.md index 74982ba9dc..d4064c7bb0 100644 --- a/docs/api/platform/memory/MemTrace.md +++ b/docs/api/platform/memory/MemTrace.md @@ -20,11 +20,11 @@ For a step-by-step guide about how to use optimize memory using runtime memory t ## Memory tracing functions reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/mbed__mem__trace_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/mbed__mem__trace_8h_source.html) ## Memory tracing example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Memory_tracing_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Memory_tracing_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Memory_tracing_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Memory_tracing_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/memory/MemoryPool.md b/docs/api/platform/memory/MemoryPool.md index 2263bd9ed0..a67642c316 100644 --- a/docs/api/platform/memory/MemoryPool.md +++ b/docs/api/platform/memory/MemoryPool.md @@ -1,12 +1,12 @@ # MemoryPool -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_memory_pool.png)MemoryPool class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_memory_pool.png)MemoryPool class hierarchy You can use the MemoryPool class to define and manage fixed-size memory pools. You can allocate memory blocks of fixed size from the pool using the `alloc` or `calloc` method, which returns a pointer to the block of memory or NULL if there is no space available in the pool. It's the user's responsibility to initialize the objects placed in blocks. The `calloc` function sets the block of memory to zeros before returning the pointer of the block to the caller. ## MemoryPool class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_memory_pool.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_memory_pool.html) ## MemoryPool example @@ -22,7 +22,7 @@ mpool.free(message); This example shows [Queue](queue.html) and MemoryPool managing measurements. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Queue/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Queue/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Queue/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Queue/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/memory/MpuManagement.md b/docs/api/platform/memory/MpuManagement.md index 6ff2e0b63d..c586554e21 100644 --- a/docs/api/platform/memory/MpuManagement.md +++ b/docs/api/platform/memory/MpuManagement.md @@ -27,7 +27,7 @@ After boot, writing to ROM is not allowed. Libraries requiring the ability to wr ## Function reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/group__platform__mpu__mgmt.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/group__platform__mpu__mgmt.html) ## Example diff --git a/docs/api/platform/memory/dynamic_mem_analysis.md b/docs/api/platform/memory/dynamic_mem_analysis.md index 941fa0bd58..82a2e0d4e9 100644 --- a/docs/api/platform/memory/dynamic_mem_analysis.md +++ b/docs/api/platform/memory/dynamic_mem_analysis.md @@ -1,3 +1,3 @@ # Dynamic memory analysis -[A document about dynamic memory analysis and potentially how to optimize it. This is related to this page: https://os.mbed.com/docs/mbed-os/development/tutorials/memory-optimization.html#runtime-memory-tracing.] +[A document about dynamic memory analysis and potentially how to optimize it. This is related to this page: https://os.mbed.com/docs/mbed-os/v6.14/tutorials/memory-optimization.html#runtime-memory-tracing.] diff --git a/docs/api/platform/memory/profiling.md b/docs/api/platform/memory/profiling.md index 5e598575f6..98134e24cb 100644 --- a/docs/api/platform/memory/profiling.md +++ b/docs/api/platform/memory/profiling.md @@ -1,3 +1,3 @@ # Profiling -[A document about profiling. It should include static memory analysis and how to optimize it. This is related to this page: https://os.mbed.com/docs/mbed-os/development/tutorials/memory-optimization.html#memap---static-memory-map-analysis.] +[A document about profiling. It should include static memory analysis and how to optimize it. This is related to this page: https://os.mbed.com/docs/mbed-os/v6.14/tutorials/memory-optimization.html#memap---static-memory-map-analysis.] diff --git a/docs/api/platform/platform.md b/docs/api/platform/platform.md index 055f43bd71..35d20cd1f2 100644 --- a/docs/api/platform/platform.md +++ b/docs/api/platform/platform.md @@ -37,7 +37,7 @@ A callback is a user provided function that a user may pass to an API. The callb For example, the following code allows a user to provide a customized response whenever the serial line receives data: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PlatfromOverview_Callbacks/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-PlatfromOverview_Callbacks/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-PlatfromOverview_Callbacks/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-PlatfromOverview_Callbacks/blob/v6.14/main.cpp) 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](platform.html#the-importance-of-state) section. diff --git a/docs/api/platform/power/DeepSleepLock.md b/docs/api/platform/power/DeepSleepLock.md index 1164158e11..1588e7eb58 100644 --- a/docs/api/platform/power/DeepSleepLock.md +++ b/docs/api/platform/power/DeepSleepLock.md @@ -6,13 +6,13 @@ The `DeepSleepLock` class provides an RAII object for disabling sleep. In other ## DeepSleepLock class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_deep_sleep_lock.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_deep_sleep_lock.html) ## Example This example shows how you can lock deep sleep to decrease interrupt latency at the expense of increased power consumption. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DeepSleepLock_Example_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-DeepSleepLock_Example_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DeepSleepLock_Example_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-DeepSleepLock_Example_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/power/LowPowerTicker.md b/docs/api/platform/power/LowPowerTicker.md index 139be499b6..da87404907 100644 --- a/docs/api/platform/power/LowPowerTicker.md +++ b/docs/api/platform/power/LowPowerTicker.md @@ -1,6 +1,6 @@ # LowPowerTicker -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_low_power_ticker.png)LowPowerTicker class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_low_power_ticker.png)LowPowerTicker class hierarchy The LowPowerTicker class has the same methods as the Ticker class but operates in deep sleep mode and has less resolution. Use the LowPowerTicker interface to set up a recurring interrupt when you only need millisecond accuracy; it calls a function repeatedly and at a specified rate. Because the LowPowerTicker class can operate in deep sleep mode, it does not block deep sleep when active. @@ -14,10 +14,10 @@ You can create any number of LowPowerTicker objects, allowing multiple outstandi ## LowPowerTicker class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_low_power_ticker.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_low_power_ticker.html) ## LowPowerTicker example Try this program to set up a LowPowerTicker to repeatedly invert an LED: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-lowpowerTicker_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-lowpowerTicker_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-lowpowerTicker_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-lowpowerTicker_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/platform/power/LowPowerTimeout.md b/docs/api/platform/power/LowPowerTimeout.md index a463c23744..50fed6f2c1 100644 --- a/docs/api/platform/power/LowPowerTimeout.md +++ b/docs/api/platform/power/LowPowerTimeout.md @@ -1,6 +1,6 @@ # LowPowerTimeout -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_low_power_timeout.png)LowPowerTimeout class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_low_power_timeout.png)LowPowerTimeout class hierarchy Use the LowPowerTimeout interface to set up an interrupt to call a function after a specified delay. You can create any number of LowPowerTimeout objects. This allows multiple outstanding interrupts at the same time. @@ -11,13 +11,13 @@ Use the LowPowerTimeout interface to set up an interrupt to call a function afte ## LowPowerTimeout class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_low_power_timeout.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_low_power_timeout.html) ## LowPowerTimeout example Set up a time out to invert an LED after a given time: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-lowpowerTimeout_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-lowpowerTimeout_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-lowpowerTimeout_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-lowpowerTimeout_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/power/LowPowerTimer.md b/docs/api/platform/power/LowPowerTimer.md index 1826d85e82..33b4d8d312 100644 --- a/docs/api/platform/power/LowPowerTimer.md +++ b/docs/api/platform/power/LowPowerTimer.md @@ -1,6 +1,6 @@ # LowPowerTimer -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_low_power_timer.png)LowPowerTimer class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_low_power_timer.png)LowPowerTimer class hierarchy LowPowerTimer inherits from the Timer Class. The timer in this case continues operating even in deep sleep mode. It relies on `lp_ticker`, which is the low power ticker. @@ -8,11 +8,11 @@ You can use the LowPowerTimer interface to create, start, stop and read a timer ## LowPowerTimer class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_low_power_timer.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_low_power_timer.html) ## LowPowerTimer example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-lowpowerTimer_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-lowpowerTimer_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-lowpowerTimer_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-lowpowerTimer_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/power/PowerManagement.md b/docs/api/platform/power/PowerManagement.md index 87b2814fb3..d918d05999 100644 --- a/docs/api/platform/power/PowerManagement.md +++ b/docs/api/platform/power/PowerManagement.md @@ -107,11 +107,11 @@ After the call the processor and most components will reset, but it will not aff ## Function reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__platform__power__mgmt.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__platform__power__mgmt.html) ## Example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SleepManager_Example_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-SleepManager_Example_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SleepManager_Example_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-SleepManager_Example_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/runtime_mem_trace.md b/docs/api/platform/runtime_mem_trace.md index e916dacf1d..689a0a9f26 100644 --- a/docs/api/platform/runtime_mem_trace.md +++ b/docs/api/platform/runtime_mem_trace.md @@ -44,7 +44,7 @@ Find the source of the default callback [here](https://github.com/ARMmbed/mbed-o A simple code example that uses the memory tracer on a K64F board: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Memory_tracing_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Memory_tracing_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Memory_tracing_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Memory_tracing_ex_1/blob/v6.14/main.cpp) It outputs the following trace: diff --git a/docs/api/platform/runtime_stats.md b/docs/api/platform/runtime_stats.md index f9a53cd17b..05a7155686 100644 --- a/docs/api/platform/runtime_stats.md +++ b/docs/api/platform/runtime_stats.md @@ -49,7 +49,7 @@ Heap statistics provide exact information about the number of bytes dynamically ### Example program using heap statistics -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Heap_Stats_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Heap_Stats_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Heap_Stats_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Heap_Stats_ex_1/blob/v6.14/main.cpp) ### Side effects of enabling heap statistics @@ -99,4 +99,4 @@ Both of these functions return a struct containing the following: ### Example program using stack statistics -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Stack_Stats_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Stack_Stats_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Stack_Stats_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Stack_Stats_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/platform/time/Rtc.md b/docs/api/platform/time/Rtc.md index 77c0b58976..a53e4248b9 100644 --- a/docs/api/platform/time/Rtc.md +++ b/docs/api/platform/time/Rtc.md @@ -2,7 +2,7 @@ The RTC (Real-Time Clock) provides mechanisms to set the current time of the hardware RTC with `set_time` API. The time is set as an offset measured in seconds from the time epoch (Unix Epoch - January 1, 1970). [Time](../apis/time.html) provides more information about C `date` and `time` standard library functions. -**Note:** If your MCU does not have an RTC nor an LPTICKER, you need to provide hooks to the external RTC you are using to the `attach_rtc` API. See the [platform RTC API](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__platform__rtc__time.html) for more details about that function. +**Note:** If your MCU does not have an RTC nor an LPTICKER, you need to provide hooks to the external RTC you are using to the `attach_rtc` API. See the [platform RTC API](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__platform__rtc__time.html) for more details about that function. RTC class APIs are thread safe. @@ -10,8 +10,8 @@ RTC can keep track of time even in a powered down state if the secondary source ## RTC function reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/mbed__rtc__time_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/mbed__rtc__time_8h_source.html) ## RTC Time example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-time_HelloWorld/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-time_HelloWorld/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-time_HelloWorld/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-time_HelloWorld/blob/v6.14/main.cpp) diff --git a/docs/api/platform/time/Ticker.md b/docs/api/platform/time/Ticker.md index 1c05d628db..b8c549eb31 100644 --- a/docs/api/platform/time/Ticker.md +++ b/docs/api/platform/time/Ticker.md @@ -1,6 +1,6 @@ # Ticker -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_ticker.png)Ticker class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_ticker.png)Ticker class hierarchy Use the Ticker interface to set up a recurring interrupt; it calls a function repeatedly and at a specified rate. @@ -16,19 +16,19 @@ You can create any number of Ticker objects, allowing multiple outstanding inter ## Ticker class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_ticker.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_ticker.html) ## Ticker hello, world Try this program to set up a Ticker to repeatedly invert an LED: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Ticker_HelloWorld/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Ticker_HelloWorld/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Ticker_HelloWorld/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Ticker_HelloWorld/blob/v6.14/main.cpp) ## Ticker examples Use this example to attach a member function to a ticker: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Ticker_Example/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Ticker_Example/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Ticker_Example/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Ticker_Example/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/platform/time/Time.md b/docs/api/platform/time/Time.md index c89cf4b52c..32830d1fe3 100644 --- a/docs/api/platform/time/Time.md +++ b/docs/api/platform/time/Time.md @@ -8,16 +8,16 @@ You cannot use `time`, `mktime` and `localtime` C standard library functions in **Note:** If your MCU does not have an RTC nor an LPTICKER, you need to provide hooks to the external RTC you are using to the `attach_rtc` API. See the [platform RTC -API](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__platform__rtc__time.html) +API](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__platform__rtc__time.html) for more details about that function. ## Time function reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/mbed__mktime_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/mbed__mktime_8h_source.html) ## Time example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-time_HelloWorld/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-time_HelloWorld/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-time_HelloWorld/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-time_HelloWorld/blob/v6.14/main.cpp) ## 2038 diff --git a/docs/api/platform/time/TimeOut.md b/docs/api/platform/time/TimeOut.md index e522269d77..6580419dd6 100644 --- a/docs/api/platform/time/TimeOut.md +++ b/docs/api/platform/time/TimeOut.md @@ -1,6 +1,6 @@ # Timeout -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_timeout.png)Timeout class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_timeout.png)Timeout class hierarchy Use the Timeout interface to set up an interrupt to call a function after a specified delay. @@ -16,16 +16,16 @@ You can create any number of Timeout objects, allowing multiple outstanding inte ## Timeout class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_timeout.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_timeout.html) ## Timeout hello, world Set up a Timeout to invert an LED after a given timeout: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Timeout_HelloWorld/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Timeout_HelloWorld/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Timeout_HelloWorld/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Timeout_HelloWorld/blob/v6.14/main.cpp) ## Timeout example Try this example to attach a member function: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Timeout_Example/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Timeout_Example/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Timeout_Example/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Timeout_Example/blob/v6.14/main.cpp) diff --git a/docs/api/platform/time/Timer.md b/docs/api/platform/time/Timer.md index 09bf06cdd6..9abbd754fb 100644 --- a/docs/api/platform/time/Timer.md +++ b/docs/api/platform/time/Timer.md @@ -13,8 +13,8 @@ You can independently create, start and stop any number of Timer objects. ## Timer class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/_timer_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/_timer_8h_source.html) ## Timer hello, world -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Timer_HelloWorld/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Timer_HelloWorld/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Timer_HelloWorld/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Timer_HelloWorld/blob/v6.14/main.cpp) diff --git a/docs/api/platform/time/Wait.md b/docs/api/platform/time/Wait.md index 84f89b38fb..e5469c9d7e 100644 --- a/docs/api/platform/time/Wait.md +++ b/docs/api/platform/time/Wait.md @@ -6,7 +6,7 @@ The wait_us and wait_ns functions provide precise wait capabilities. These funct ## Wait function reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/development/mbed-os-api-doxy/mbed__wait__api_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v6.14/mbed-os-api-doxy/mbed__wait__api_8h_source.html) ## Example diff --git a/docs/api/scheduling/ConditionVariable.md b/docs/api/scheduling/ConditionVariable.md index 824262b706..9f6f7b95b9 100644 --- a/docs/api/scheduling/ConditionVariable.md +++ b/docs/api/scheduling/ConditionVariable.md @@ -1,15 +1,15 @@ # ConditionVariable -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_condition_variable.png)ConditionVariable class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_condition_variable.png)ConditionVariable class hierarchy The ConditionVariable class provides a mechanism to safely wait for or signal state changes. A common scenario when writing multithreaded code is to protect shared resources with a mutex and then release that mutex to wait for a change of that data. If you do not do this carefully, this can lead to a race condition in the code. A condition variable provides a safe solution to this problem by handling the wait for a state change, along with releasing and acquiring the mutex automatically during this waiting period. Note that you cannot make wait or notify calls on a condition variable from ISR context. Unlike EventFlags, ConditionVariable does not let you wait on multiple events at the same time. ## ConditionVariable class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_condition_variable.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_condition_variable.html) ## ConditionVariable example Below is an example of ConditionVariable usage, where one thread is generating events every 1s, and the second thread is waiting for the events and executing an action. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ConditionVariable_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-ConditionVariable_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ConditionVariable_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-ConditionVariable_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/scheduling/Event.md b/docs/api/scheduling/Event.md index e174dba2c9..879eac5604 100644 --- a/docs/api/scheduling/Event.md +++ b/docs/api/scheduling/Event.md @@ -6,13 +6,13 @@ The Event class is thread safe. The `post` and `cancel` APIs are IRQ safe. ## Event class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classevents_1_1_event_3_01void_07_arg_ts_8_8_8_08_4.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classevents_1_1_event_3_01void_07_arg_ts_8_8_8_08_4.html) ## EventQueue example: posting events to the queue The code below demonstrates how you can instantiate, configure and post events. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Events_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Events_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Events_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Events_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/scheduling/EventFlags.md b/docs/api/scheduling/EventFlags.md index 2fac63c3cc..b3c1e137ac 100644 --- a/docs/api/scheduling/EventFlags.md +++ b/docs/api/scheduling/EventFlags.md @@ -1,13 +1,13 @@ # EventFlags -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_event_flags.png)EventFlags class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_event_flags.png)EventFlags class hierarchy The EventFlags class provides a mechanism for setting and waiting for specific conditions. It provides a generic way of notifying other threads about conditions or events. You can think of each instance of the EventFlags class as an event channel. There are 31 different flags available for each event. ## EventFlags class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_event_flags.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_event_flags.html) ## EventFlags example -[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventFlags/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-EventFlags/blob/v6.7/main.cpp) +[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventFlags/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-EventFlags/blob/v6.14/main.cpp) diff --git a/docs/api/scheduling/EventQueue.md b/docs/api/scheduling/EventQueue.md index 903ad03489..bc77ed4d68 100644 --- a/docs/api/scheduling/EventQueue.md +++ b/docs/api/scheduling/EventQueue.md @@ -1,6 +1,6 @@ # EventQueue -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classevents_1_1_event_queue.png)EventQueue class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classevents_1_1_event_queue.png)EventQueue class hierarchy The EventQueue class provides a flexible queue for scheduling events. You can use the EventQueue class for synchronization between multiple threads, or to move events out of interrupt context (deferred execution of time consuming or non-ISR safe operations). @@ -15,11 +15,11 @@ Mbed OS provides two shared queues software can use. This can avoid the need to ## EventQueue class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classevents_1_1_event_queue.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classevents_1_1_event_queue.html) ## Shared event queue reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/mbed__shared__queues_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/mbed__shared__queues_8h_source.html) ## EventQueue example: deferring from interrupt context @@ -28,7 +28,7 @@ The code executes two handler functions (`rise_handler` and `fall_handler`) in t 1. In interrupt context when a rising edge is detected on `SW2` (`rise_handler`). 2. In the context of the event loop's thread function when a falling edge is detected on `SW2` (`fall_handler`). You can use the `fall_handler` function as an argument to `queue.event()` to specify that `fall_handler` runs in user context instead of interrupt context. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_1/blob/v6.14/main.cpp) ## Shared event example: deferring from interrupt context @@ -36,19 +36,19 @@ Like the previous example, this defers from interrupt to an event queue thread. As the event queue is shared, you should limit the execution time of your event functions to avoid delaying other users’ events excessively. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Shared_Events_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Shared_Events_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Shared_Events_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Shared_Events_1/blob/v6.14/main.cpp) ## EventQueue example: posting events to the queue The code below demonstrates queueing functions to be called after a delay and queueing functions to be called periodically. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/blob/v6.14/main.cpp) ## EventQueue example: chaining events from more than one queue Event queues easily align with module boundaries, where event dispatch can implicitly synchronize internal state. Multiple modules can use independent event queues but still be composed through the `EventQueue::chain` function. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_3/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_3/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_3/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_3/blob/v6.14/main.cpp) ## Shared event example: running the shared queue from main @@ -56,13 +56,13 @@ To further save RAM, if you have no other work to do in your main function after To do this, set the `mbed_app.json` configuration option `events.shared-dispatch-from-application` to true, and add a dispatch call to main, as in this example. (The prints now show the same context for startup and `fall_handler`). -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Shared_Events_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Shared_Events_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Shared_Events_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Shared_Events_2/blob/v6.14/main.cpp) ## Static EventQueue example: posting user allocated events to the static queue Use static EventQueue to prevent your program from failing due to queue memory exhaustion or to prevent dynamic memory allocation: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/scheduling/IdleLoop.md b/docs/api/scheduling/IdleLoop.md index 1d8e465223..f6cc22df1c 100644 --- a/docs/api/scheduling/IdleLoop.md +++ b/docs/api/scheduling/IdleLoop.md @@ -16,11 +16,11 @@ void main() ## Function reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__rtos___idle.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__rtos___idle.html) ## Example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SleepManager_Example_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-SleepManager_Example_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SleepManager_Example_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-SleepManager_Example_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/scheduling/Kernel.md b/docs/api/scheduling/Kernel.md index 61cc183cf9..579e7e8298 100644 --- a/docs/api/scheduling/Kernel.md +++ b/docs/api/scheduling/Kernel.md @@ -4,17 +4,17 @@ The Kernel namespace implements interfaces to attach a function to some kernel e ## Kernel namespace reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/namespacertos_1_1_kernel.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/namespacertos_1_1_kernel.html) ## Kernel::Clock example The nested class `Clock` can be used to read the current RTOS kernel millisecond tick count as a C++11 Chrono time point. The below code snippet demonstrates use of `Kernel::Clock` to calculate the elapsed time: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Kernel_get_ms_count/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Kernel_get_ms_count/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Kernel_get_ms_count/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Kernel_get_ms_count/blob/v6.14/main.cpp) ## Kernel hooks example You can use the function `attach_idle_hook()` to attach a function to be called by the RTOS idle task. You can use the function `attach_thread_terminate_hook()` to attach a function to be called when a thread terminates. The below code snippet demostrates the usage of these hooks. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Kernel_hooks/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Kernel_hooks/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Kernel_hooks/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Kernel_hooks/blob/v6.14/main.cpp) diff --git a/docs/api/scheduling/Mail.md b/docs/api/scheduling/Mail.md index 153ab7edb0..850671b376 100644 --- a/docs/api/scheduling/Mail.md +++ b/docs/api/scheduling/Mail.md @@ -1,6 +1,6 @@ # Mail -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_mail.png)Mail class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_mail.png)Mail class hierarchy Mail works like a queue, with the added benefit of providing a memory pool for allocating messages (not only pointers). @@ -8,10 +8,10 @@ Mail works like a queue, with the added benefit of providing a memory pool for a ## Mail class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_mail.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_mail.html) ## Mail example This code uses `mail` to manage measurement. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Mail/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Mail/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Mail/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Mail/blob/v6.14/main.cpp) diff --git a/docs/api/scheduling/Mutex.md b/docs/api/scheduling/Mutex.md index a9688d7e13..4313a83d4a 100644 --- a/docs/api/scheduling/Mutex.md +++ b/docs/api/scheduling/Mutex.md @@ -1,6 +1,6 @@ # Mutex -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_mutex.png)Mutex class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_mutex.png)Mutex class hierarchy A Mutex is used to synchronize the execution of threads, for example to protect the access to a shared resource. @@ -25,13 +25,13 @@ If synchronization is required in ISR, consider using semaphores. ## Mutex class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_mutex.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_mutex.html) ## Mutex example Use Mutex to protect printf(). -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Mutex/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Mutex/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Mutex/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Mutex/blob/v6.14/main.cpp) **Note:** C standard library Mutexes
The Arm C standard library already has Mutexes in place to protect the access to `stdio`, so on the LPC1768 the above example is not necessary. On the other hand, the LPC11U24 does not provide default `stdio` Mutexes, making the above example a necessity.
diff --git a/docs/api/scheduling/Queue.md b/docs/api/scheduling/Queue.md index ce55ec4853..0b2c06b5a0 100644 --- a/docs/api/scheduling/Queue.md +++ b/docs/api/scheduling/Queue.md @@ -1,6 +1,6 @@ # Queue -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_queue.png)Queue class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_queue.png)Queue class hierarchy A Queue allows you to queue pointers to data from producer threads to consumer threads. @@ -8,7 +8,7 @@ A Queue allows you to queue pointers to data from producer threads to consumer t ## Queue class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_queue.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_queue.html) ## Queue example @@ -29,7 +29,7 @@ if (evt.status == osEventMessage) { This example shows `Queue` and [MemoryPool](memorypool.html) managing measurements. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Queue/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Queue/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Queue/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Queue/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/scheduling/Semaphore.md b/docs/api/scheduling/Semaphore.md index 6548110e50..98e0a77f9c 100644 --- a/docs/api/scheduling/Semaphore.md +++ b/docs/api/scheduling/Semaphore.md @@ -1,6 +1,6 @@ # Semaphore -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_semaphore.png)Semaphore class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_semaphore.png)Semaphore class hierarchy A semaphore manages thread access to a pool of shared resources of a certain type. @@ -8,10 +8,10 @@ A semaphore manages thread access to a pool of shared resources of a certain typ ## Semaphore class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_semaphore.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_semaphore.html) ## Semaphore example Use Semaphore to protect printf(). -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Semaphore/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Semaphore/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Semaphore/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Semaphore/blob/v6.14/main.cpp) diff --git a/docs/api/scheduling/ThisThread.md b/docs/api/scheduling/ThisThread.md index a72429e355..ace4d3992d 100644 --- a/docs/api/scheduling/ThisThread.md +++ b/docs/api/scheduling/ThisThread.md @@ -6,7 +6,7 @@ Unlike the [Thread](../apis/thread.html) API, which allows you to create, join a ## ThisThread class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/namespacertos_1_1_this_thread.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/namespacertos_1_1_this_thread.html) ## ThisThread example diff --git a/docs/api/scheduling/Thread.md b/docs/api/scheduling/Thread.md index d541844552..0733e7955b 100644 --- a/docs/api/scheduling/Thread.md +++ b/docs/api/scheduling/Thread.md @@ -1,6 +1,6 @@ # Thread -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_thread.png)Thread class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_thread.png)Thread class hierarchy The Thread class allows defining, creating and controlling parallel tasks. @@ -16,7 +16,7 @@ The default stack size is 4K. However, the application can override it by using ## Thread class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classrtos_1_1_thread.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classrtos_1_1_thread.html) ```C /// Priority values. @@ -81,13 +81,13 @@ typedef enum { The code below uses two separate threads to blink two LEDs. The first thread is automatically created and executes the `main` function; the second thread is created explicitly inside `main`. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Basic/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Basic/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Basic/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Basic/blob/v6.14/main.cpp) ## Thread example with callbacks The Callback API provides a convenient way to pass arguments to spawned threads. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Threading_with_callback/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Threading_with_callback/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Threading_with_callback/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Threading_with_callback/blob/v6.14/main.cpp) ## Debugging tips diff --git a/docs/api/scheduling/UserAllocatedEvent.md b/docs/api/scheduling/UserAllocatedEvent.md index 6c7d632baa..94ccf14313 100644 --- a/docs/api/scheduling/UserAllocatedEvent.md +++ b/docs/api/scheduling/UserAllocatedEvent.md @@ -15,13 +15,13 @@ The UserAllocatedEvent class is thread safe. The `call`, `try_call` and `cancel` ## UserAllocatedEvent class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classevents_1_1_user_allocated_event.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classevents_1_1_user_allocated_event.html) ## Static EventQueue example: posting user allocated events to the queue This example demonstrates how you can instantiate, configure and post events: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/scheduling/events_tutorial.md b/docs/api/scheduling/events_tutorial.md index 6b1f7844ce..1368718b61 100644 --- a/docs/api/scheduling/events_tutorial.md +++ b/docs/api/scheduling/events_tutorial.md @@ -34,7 +34,7 @@ Note that though this document assumes the presence of a single event loop in th Once you start the event loop, it can post events. Let's consider an example of a program that attaches two interrupt handlers for an InterruptIn object, using the InterruptIn `rise` and `fall` functions. The `rise` handler will run in interrupt context, and the `fall` handler will run in user context (more specifically, in the context of the event loop's thread). The full code for the example can be found below: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_1/blob/v6.14/main.cpp) The above code executes two handler functions (`rise_handler` and `fall_handler`) in two different contexts: @@ -166,4 +166,4 @@ This is only a small part of how event queues work in Mbed OS. The `EventQueue`, The EventQueue API provides a mechanism for creating a static queue, a queue that doesn't use any dynamic memory allocation and accepts only user-allocated events. After you create a static queue (by passing zero as `size` to its constructor), you can post `UserAllocatedEvent` to it. Using static EventQueue combined with UserAllocatedEvent ensures no dynamic memory allocation will take place during queue creation and events posting and dispatching. You can also declare queues and events as static objects (static in the C++ sense), and then memory for them will be reserved at compile time: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-UserAllocatedEvent_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/scheduling/rtos.md b/docs/api/scheduling/rtos.md index c1a446e64c..47f788fbd0 100644 --- a/docs/api/scheduling/rtos.md +++ b/docs/api/scheduling/rtos.md @@ -44,7 +44,7 @@ A `Thread` can be in the following states: Each `Thread` can wait for signals and be notified of events: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flags/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Flags/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Flags/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Flags/blob/v6.14/main.cpp) ## Status and error codes diff --git a/docs/api/security/Devicekey.md b/docs/api/security/Devicekey.md index 27779a10b9..09232cbd9c 100644 --- a/docs/api/security/Devicekey.md +++ b/docs/api/security/Devicekey.md @@ -1,6 +1,6 @@ # DeviceKey -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_device_key.png)DeviceKey class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_device_key.png)DeviceKey class hierarchy DeviceKey is a mechanism that implements key derivation from a root of trust key. The DeviceKey mechanism generates symmetric keys that security features need. You can use these keys for encryption, authentication and more. The DeviceKey API allows key derivation without exposing the actual root of trust, to reduce the possibility of accidental exposure of the root of trust outside the device. @@ -82,8 +82,8 @@ Run the DeviceKey functionality test with the `mbed`: ## DeviceKey API class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_device_key.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_device_key.html) ## DeviceKey example -[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DeviceKey/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-DeviceKey/blob/v6.7/main.cpp) +[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DeviceKey/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-DeviceKey/blob/v6.14/main.cpp) diff --git a/docs/api/security/TLS.md b/docs/api/security/TLS.md index 2af86900f2..db62fe76cb 100644 --- a/docs/api/security/TLS.md +++ b/docs/api/security/TLS.md @@ -22,7 +22,7 @@ Each of them comes with complete usage instructions as a readme file in the repo ## Configuring Mbed TLS features -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). +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/mbed-os/blob/master/connectivity/mbedtls/include/mbedtls/config.h). 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: diff --git a/docs/api/security/crypto.md b/docs/api/security/crypto.md index 336a2c1516..31f4cef89f 100644 --- a/docs/api/security/crypto.md +++ b/docs/api/security/crypto.md @@ -18,7 +18,7 @@ The Mbed TLS configuration system configures Mbed Crypto. Please refer to [Mbed This example covers some basic use of the PSA Crypto API, as well as factory entropy injection: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-mbed-crypto/)](https://github.com/ARMmbed/mbed-os-example-mbed-crypto/blob/mbed-os-6.7.0/getting-started/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-mbed-crypto/)](https://github.com/ARMmbed/mbed-os-example-mbed-crypto/blob/mbed-os-6.14.0/getting-started/main.cpp) For further information, please refer to the README file in [the example repository](https://github.com/ARMmbed/mbed-os-example-mbed-crypto). diff --git a/docs/api/security/psa_attestation.md b/docs/api/security/psa_attestation.md index d91eb6ddfe..2857043f5a 100644 --- a/docs/api/security/psa_attestation.md +++ b/docs/api/security/psa_attestation.md @@ -50,11 +50,11 @@ In the current implementation, a bootloader does not exist in single and dual V7 ## PSA initial attestation reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group___p_s_a-_attestation.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group___p_s_a-_attestation.html) ## PSA initial attestation example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-attestation/blob/attestation_example)](https://github.com/ARMmbed/mbed-os-example-attestation/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-attestation/blob/attestation_example)](https://github.com/ARMmbed/mbed-os-example-attestation/blob/mbed-os-6.14.0/main.cpp) ## Related content diff --git a/docs/api/security/psa_lifecycle.md b/docs/api/security/psa_lifecycle.md index e3fa08f1a3..508442430b 100644 --- a/docs/api/security/psa_lifecycle.md +++ b/docs/api/security/psa_lifecycle.md @@ -17,7 +17,7 @@ In Mbed OS, the PSA lifecycle is implemented as part of the platform service. ## PSA lifecycle reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/lifecycle_8h.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/lifecycle_8h.html) ## Related content diff --git a/docs/api/storage/BlockDevice.md b/docs/api/storage/BlockDevice.md index c903178b58..fbca031cbe 100644 --- a/docs/api/storage/BlockDevice.md +++ b/docs/api/storage/BlockDevice.md @@ -1,6 +1,6 @@ # BlockDevice -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_block_device.png)BlockDevice class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_block_device.png)BlockDevice class hierarchy The BlockDevice API provides an interface for access to block-based storage. You can use a block device to back a full [file system](../porting/porting-storage.html#contributing-filesystem) or write to it directly. @@ -38,11 +38,11 @@ For details regarding how to configure the default block device please refer to ## BlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_block_device.html) ## BlockDevice example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BlockDevice/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-BlockDevice/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BlockDevice/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-BlockDevice/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/BufferedBlockDevice.md b/docs/api/storage/BufferedBlockDevice.md index 3e2b893b8e..e9e33afb98 100644 --- a/docs/api/storage/BufferedBlockDevice.md +++ b/docs/api/storage/BufferedBlockDevice.md @@ -1,6 +1,6 @@ # BufferedBlockDevice -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_buffered_block_device.png)BufferedBlockDevice class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_buffered_block_device.png)BufferedBlockDevice class hierarchy The BufferedBlockDevice class is a block device adpator, whose purpose is to reduce the read and program sizes of the underlying block device to 1. Large read and/or program sizes may make life difficult for block device users, so BufferedBlockDevice reduces both sizes to the minimum, where reads and writes to the underlying BD use an internal buffer. Calling the `sync` API ensures writes are flushed to the underlying BD. @@ -12,13 +12,13 @@ To configure this class, please see our [BlockDevice configuration documentation ## BufferedBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_buffered_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_buffered_block_device.html) ## BufferedBlockDevice example This BufferedBlockDevice example takes a [HeapBlockDevice](heapblockdevice.html), whose read size is 256 bytes and program size is 512 bytes, and shows how one can read or program this block device with much smaller read/program sizes, using BufferedBlockDevice. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BufferedBlockDevice/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-BufferedBlockDevice/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-BufferedBlockDevice/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-BufferedBlockDevice/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/ChainingBlockDevice.md b/docs/api/storage/ChainingBlockDevice.md index b08994a7f4..22aa5301a0 100644 --- a/docs/api/storage/ChainingBlockDevice.md +++ b/docs/api/storage/ChainingBlockDevice.md @@ -1,6 +1,6 @@ # ChainingBlockDevice -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_chaining_block_device.png)ChainingBlockDevice class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_chaining_block_device.png)ChainingBlockDevice class hierarchy The ChainingBlockDevice class provides a way to chain together multiple block devices. You can then interact with the chained block devices as if they were a single block device of size equal to the sum of each substorage unit. The ChainingBlockDevice acts as an opposite of the [SlicingBlockDevice](slicingblockdevice.html). @@ -12,17 +12,17 @@ To configure this class, please see our [BlockDevice configuration documentation ## ChainingBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_chaining_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_chaining_block_device.html) ## ChainingBlockDevice example This ChainingBlockDevice example creates a FAT file system across multiple [HeapBlockDevices](heapblockdevice.html). -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ChainingBlockDevice_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-ChainingBlockDevice_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ChainingBlockDevice_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-ChainingBlockDevice_ex_1/blob/v6.14/main.cpp) This ChainingBlockDevice example shows how to program and read back data from a chained group of [HeapBlockDevices](heapblockdevice.html). -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ChainingBlockDevice_ex_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-ChainingBlockDevice_ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ChainingBlockDevice_ex_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-ChainingBlockDevice_ex_2/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/DataFlashBlockDevice.md b/docs/api/storage/DataFlashBlockDevice.md index f9884e5289..fa652fe07c 100644 --- a/docs/api/storage/DataFlashBlockDevice.md +++ b/docs/api/storage/DataFlashBlockDevice.md @@ -1,6 +1,6 @@ # DataFlashBlockDevice -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/class_data_flash_block_device.png)DataFlashBlockDevice class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/class_data_flash_block_device.png)DataFlashBlockDevice class hierarchy DataFlashBlockDevice is a block device driver for serial flash devices that support the Atmel DataFlash protocol, such as the Adesto AT45DB series of devices. @@ -14,11 +14,11 @@ To configure this class, please see our [BlockDevice configuration documentation ## DataFlashBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_data_flash_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_data_flash_block_device.html) ## DataFlashBlockDevice example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DataFlashBlockDevice/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-DataFlashBlockDevice/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-DataFlashBlockDevice/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-DataFlashBlockDevice/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/Dir.md b/docs/api/storage/Dir.md index a8dd9f7175..ffce4c134e 100644 --- a/docs/api/storage/Dir.md +++ b/docs/api/storage/Dir.md @@ -1,6 +1,6 @@ # Dir -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_dir.png)Dir class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_dir.png)Dir class hierarchy With a file system, the Dir class allows you to iterate over directories on the underlying storage. Directories, also called folders, are a way to group files. Each directory has a name that forms a part of the path to any files stored in that directory. Additionally, you can use `rename` operations at the file system level to change a directory's name and efficiently change the path to any files in that directory. To make a new directory, use the `mkdir` function in the [FileSystem](filesystem.html) class. @@ -10,11 +10,11 @@ The Dir class operates as an iterator or stream similarly to the File class, exc ## Dir class API -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_dir.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_dir.html) ## File system example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-filesystem/)](https://github.com/ARMmbed/mbed-os-example-filesystem/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-filesystem/)](https://github.com/ARMmbed/mbed-os-example-filesystem/blob/mbed-os-6.14.0/main.cpp) ## Related content diff --git a/docs/api/storage/FATFileSystem.md b/docs/api/storage/FATFileSystem.md index 5d903dffe2..18fc432b77 100644 --- a/docs/api/storage/FATFileSystem.md +++ b/docs/api/storage/FATFileSystem.md @@ -1,6 +1,6 @@ # FATFileSystem -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_f_a_t_file_system.png)FATFileSystem class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_f_a_t_file_system.png)FATFileSystem class hierarchy The FAT file system is an established disk-oriented file system that you can find on Mbed OS, Windows, Linux and macOS. Due to its age and popularity, the FAT file system has become the standard for portable storage, such as flash drivers and SD cards. @@ -34,11 +34,11 @@ To configure this class, please see the [FileSystem configuration documentation] ## FATFileSystem class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_f_a_t_file_system.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_f_a_t_file_system.html) ## FATFileSystem example -[![View code](https://www.mbed.com/embed/?url=https://github.com/armmbed/mbed-os-example-filesystem/)](https://github.com/ARMmbed/mbed-os-example-filesystem/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/armmbed/mbed-os-example-filesystem/)](https://github.com/ARMmbed/mbed-os-example-filesystem/blob/mbed-os-6.14.0/main.cpp) ## Related content diff --git a/docs/api/storage/File.md b/docs/api/storage/File.md index 78dede9365..64a3eb45cb 100644 --- a/docs/api/storage/File.md +++ b/docs/api/storage/File.md @@ -1,6 +1,6 @@ # File -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_file.png)File class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_file.png)File class hierarchy The File class provides access to the underlying storage of a file system in a generic manner. This acts as a buffer between the file system and any technical limitations of the physical storage medium. On the storage, each file is a blob of data referenced by a file name represented as a string. By providing a file name to the `open` function in the File class, you can access the blob of data stored on disk. @@ -14,11 +14,11 @@ Combining `read`, `write`, and `seek` on a File allows both streaming and random ## File class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_file.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_file.html) ## File system example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-filesystem/)](https://github.com/ARMmbed/mbed-os-example-filesystem/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-filesystem/)](https://github.com/ARMmbed/mbed-os-example-filesystem/blob/mbed-os-6.14.0/main.cpp) ## Related content diff --git a/docs/api/storage/FileSystem.md b/docs/api/storage/FileSystem.md index e481bc052c..d71b2dac71 100644 --- a/docs/api/storage/FileSystem.md +++ b/docs/api/storage/FileSystem.md @@ -1,6 +1,6 @@ # FileSystem -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_file_system.png)FileSystem class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_file_system.png)FileSystem class hierarchy The file system API provides a common interface for implementing a file system on a [block-based storage device](../porting/porting-storage.html#block-devices). The file system API is a class-based interface, but implementing the file system API provides the standard POSIX file API familiar to C users. @@ -16,11 +16,11 @@ For details regarding how to configure the default file system or override its i ## File system class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_file_system.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_file_system.html) ## File system example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-filesystem/)](https://github.com/ARMmbed/mbed-os-example-filesystem/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-filesystem/)](https://github.com/ARMmbed/mbed-os-example-filesystem/blob/mbed-os-6.14.0/main.cpp) ## Sector requirements diff --git a/docs/api/storage/FlashIAPBlockDevice.md b/docs/api/storage/FlashIAPBlockDevice.md index a8671ed83e..7fe8138c4a 100644 --- a/docs/api/storage/FlashIAPBlockDevice.md +++ b/docs/api/storage/FlashIAPBlockDevice.md @@ -1,6 +1,6 @@ # FlashIAPBlockDevice -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_flash_i_a_p_block_device.png)FlashIAPBlockDevice class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_flash_i_a_p_block_device.png)FlashIAPBlockDevice class hierarchy The flash IAP block device is a block device driver built on top of the FlashIAP API. This is enabled using the internal flash memory as a block device. The read size, write size and erase size may differ, depending on the flash chip. Use the FlashIAPBlockDevice `get` function to discover those sizes. @@ -13,11 +13,11 @@ To configure this class, please see our [BlockDevice configuration documentation ## FlashIAPBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_flash_i_a_p_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_flash_i_a_p_block_device.html) ## FlashIAPBlockDevice example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-FlashIAPBlockDevice/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-FlashIAPBlockDevice/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-FlashIAPBlockDevice/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-FlashIAPBlockDevice/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/FlashSimBlockDevice.md b/docs/api/storage/FlashSimBlockDevice.md index e2172d7743..c7f750d092 100644 --- a/docs/api/storage/FlashSimBlockDevice.md +++ b/docs/api/storage/FlashSimBlockDevice.md @@ -1,6 +1,6 @@ # FlashSimBlockDevice -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_flash_sim_block_device.png)FlashSimBlockDevice class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_flash_sim_block_device.png)FlashSimBlockDevice class hierarchy The FlashSimBlockDevice class is a block device adapator, whose purpose is to simulate the behavior of a flash component if the underlying block device doesn't support such a behavior. This includes the following: @@ -17,13 +17,13 @@ To configure this class, please see our [BlockDevice configuration documentation ## FlashSimBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_flash_sim_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_flash_sim_block_device.html) ## FlashSimBlockDevice example This FlashSimBlockDevice example takes a [HeapBlockDevice](heapblockdevice.html) and turns it into a simulated flash BD. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-FlashSimBlockDevice/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-FlashSimBlockDevice/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-FlashSimBlockDevice/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-FlashSimBlockDevice/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/HeapBlockDevice.md b/docs/api/storage/HeapBlockDevice.md index b8edb57d17..9b8522db76 100644 --- a/docs/api/storage/HeapBlockDevice.md +++ b/docs/api/storage/HeapBlockDevice.md @@ -1,6 +1,6 @@ # HeapBlockDevice -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_heap_block_device.png)BlockDevice class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_heap_block_device.png)BlockDevice class hierarchy The HeapBlockDevice class provides a way to simulate block devices for software development or testing. The created blocks are volatile; they do not persist across power cycles. @@ -24,17 +24,17 @@ You can view more information about the configurable settings and functions in t ## HeapBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_heap_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_heap_block_device.html) ## HeapBlockDevice example Create a HeapBlockDevice, program it, read the block back and clean up. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-HeapBlockDevice_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-HeapBlockDevice_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-HeapBlockDevice_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-HeapBlockDevice_ex_1/blob/v6.14/main.cpp) The HeapBlockDevice used with MBRBlockDevice showcases partitioning. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_1/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/KVStoreAPI.md b/docs/api/storage/KVStoreAPI.md index 3c6b93195a..bbe0587059 100644 --- a/docs/api/storage/KVStoreAPI.md +++ b/docs/api/storage/KVStoreAPI.md @@ -2,7 +2,7 @@ **Tip:** This API replaces the deprecated NVStore API. -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_k_v_store.png)KVStore class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_k_v_store.png)KVStore class hierarchy The KVStore API is a common get/set API implemented by several classes. It allows flexibility in the configuration of a storage solution that you can build by allocating several combinations of objects. For example, SecureStore can hold a TDBStore or a FileSystemStore, both implementing the KVStore API, without any change in functionality. @@ -26,11 +26,11 @@ Classes implementing KVStore API: ## KVStore class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_k_v_store.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_k_v_store.html) ## KVStore example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-kvstore)](https://github.com/ARMmbed/mbed-os-example-kvstore/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-kvstore)](https://github.com/ARMmbed/mbed-os-example-kvstore/blob/mbed-os-6.14.0/main.cpp) ## Related content diff --git a/docs/api/storage/KVStoreGlobalAPI.md b/docs/api/storage/KVStoreGlobalAPI.md index 69d67f729a..cf627ece71 100644 --- a/docs/api/storage/KVStoreGlobalAPI.md +++ b/docs/api/storage/KVStoreGlobalAPI.md @@ -36,11 +36,11 @@ This parameter is used in the iterator `kv_iterator_open` function to define the ## Static Global API class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/kvstore__global__api_8h_source.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/kvstore__global__api_8h_source.html) ## Static Global API example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-kvstore/)](https://github.com/ARMmbed/mbed-os-example-kvstore/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-kvstore/)](https://github.com/ARMmbed/mbed-os-example-kvstore/blob/mbed-os-6.14.0/main.cpp) ## Related content diff --git a/docs/api/storage/LittleFileSystem.md b/docs/api/storage/LittleFileSystem.md index d839cc69f1..dd37c1c033 100644 --- a/docs/api/storage/LittleFileSystem.md +++ b/docs/api/storage/LittleFileSystem.md @@ -1,6 +1,6 @@ # LittleFileSystem -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_little_file_system.png)LittleFileSystem class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_little_file_system.png)LittleFileSystem class hierarchy The little file system (LittleFS) is a fail-safe file system designed for embedded systems, specifically for microcontrollers that use external flash storage. @@ -41,11 +41,11 @@ To configure this class, please see the [FileSystem configuration documentation] ## LittleFileSystem class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_little_file_system.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_little_file_system.html) ## LittleFileSystem example -[![View code](https://www.mbed.com/embed/?url=https://github.com/armmbed/mbed-os-example-filesystem/)](https://github.com/ARMmbed/mbed-os-example-filesystem/blob/mbed-os-6.7.0/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/armmbed/mbed-os-example-filesystem/)](https://github.com/ARMmbed/mbed-os-example-filesystem/blob/mbed-os-6.14.0/main.cpp) ## Related content diff --git a/docs/api/storage/MBRBlockDevice.md b/docs/api/storage/MBRBlockDevice.md index 73255007bd..8d6888ba3b 100644 --- a/docs/api/storage/MBRBlockDevice.md +++ b/docs/api/storage/MBRBlockDevice.md @@ -1,6 +1,6 @@ # MBRBlockDevice -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_m_b_r_block_device.png)MBRBlockDevice class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_m_b_r_block_device.png)MBRBlockDevice class hierarchy The MBRBlockDevice class provides a way to manage a Master Boot Record (MBR) on a storage device, which allows you to partition the device. Without the MBR, you can still format a storage device with a file system, but including the MBR will allow for future partition modifications. @@ -13,17 +13,17 @@ You can view more information about the configurable settings and functions in t ## MBRBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_m_b_r_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_m_b_r_block_device.html) ## MBRBlockDevice example Partition a heap backed block device into two partitions. This example also uses the [HeapBlockDevice](heapblockdevice.html). -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_1/blob/v6.14/main.cpp) Partition an SD card, and format the new partition with a FAT filesystem. A PC will now be able to recognize the SD card. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-MBRBlockDevice_ex_2/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/ProfilingBlockDevice.md b/docs/api/storage/ProfilingBlockDevice.md index 1c2a8e48d9..6b0602fef0 100644 --- a/docs/api/storage/ProfilingBlockDevice.md +++ b/docs/api/storage/ProfilingBlockDevice.md @@ -1,6 +1,6 @@ # ProfilingBlockDevice -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_profiling_block_device.png)ProfilingBlockDevice class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_profiling_block_device.png)ProfilingBlockDevice class hierarchy The ProfilingBlockDevice class provides a decorator for an existing block device object to log reads, writes and erases. @@ -10,13 +10,13 @@ To configure this class, please see our [BlockDevice configuration documentation ## ProfilingBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_profiling_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_profiling_block_device.html) ## ProfilingBlockDevice example Create a ProfilingBlockDevice, perform storage operations and report back the read, write and erase counts. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ProfilingBlockDevice/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-ProfilingBlockDevice/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-ProfilingBlockDevice/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-ProfilingBlockDevice/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/QSPIFBlockDevice.md b/docs/api/storage/QSPIFBlockDevice.md index 3b7d89a9a5..4c14736af9 100644 --- a/docs/api/storage/QSPIFBlockDevice.md +++ b/docs/api/storage/QSPIFBlockDevice.md @@ -1,6 +1,6 @@ # QSPIFBlockDevice -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_q_s_p_i_f_block_device.png)QSPIFBlockDevice class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_q_s_p_i_f_block_device.png)QSPIFBlockDevice class hierarchy The QSPIFBlockDevice is a block device driver for NOR-based QSPI Flash devices that support the SFDP standard. NOR-based QSPI Flash supports up to 4 bits per cycle of instruction, address and data. SFDP-based QSPI Flash supports variable bus modes (single, dual and quad), several sector erase size types and multiple regions of sector size types. @@ -9,10 +9,10 @@ For more information about the SFDP JEDEC standard, please see [its documentatio ## QSPIFBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_q_s_p_i_f_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_q_s_p_i_f_block_device.html) ## QSPIFBlockDevice example This example creates a QSPIFBlockDevice, erases a sector, programs it, reads the block back and cleans up. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-QSPIFBlockDevice_ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-QSPIFBlockDevice_ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-QSPIFBlockDevice_ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-QSPIFBlockDevice_ex_1/blob/v6.14/main.cpp) diff --git a/docs/api/storage/SDBlockDevice.md b/docs/api/storage/SDBlockDevice.md index ab3e83e461..7b86c15ba0 100644 --- a/docs/api/storage/SDBlockDevice.md +++ b/docs/api/storage/SDBlockDevice.md @@ -1,6 +1,6 @@ # SDBlockDevice -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_s_d_block_device.png)SDBlockDevice class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_s_d_block_device.png)SDBlockDevice class hierarchy You can use the Mbed OS SD card block device, so applications can read and write data to flash storage cards using the standard POSIX File API programming interface. Applications use the FAT filesystem and SD block device components to persistently store data on SDCards. The SD block device uses the SD card SPI-mode of operation, which is a subset of possible SD card functionality. @@ -98,11 +98,11 @@ There is a difference between `erase` as usually defined for SD cards and the de ## SDBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_s_d_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_s_d_block_device.html) ## SDBlockDevice example application -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SDBlockDevice/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-SDBlockDevice/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SDBlockDevice/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-SDBlockDevice/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/SPIFBlockDevice.md b/docs/api/storage/SPIFBlockDevice.md index a987abe450..6d4b737d08 100644 --- a/docs/api/storage/SPIFBlockDevice.md +++ b/docs/api/storage/SPIFBlockDevice.md @@ -1,6 +1,6 @@ # SPI Flash block device -![](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_s_p_i_f_block_device.png)SPIFBlockDevice class hierarchy +![](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_s_p_i_f_block_device.png)SPIFBlockDevice class hierarchy This API is a block device for NOR-based SPI flash devices that support SFDP. @@ -12,11 +12,11 @@ To configure this class, please see our [BlockDevice configuration documentation ## SPIFBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_s_p_i_f_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_s_p_i_f_block_device.html) ## SPIFBlockDevice example -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SPIFBlockDevice/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-SPIFBlockDevice/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SPIFBlockDevice/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-SPIFBlockDevice/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/SlicingBlockDevice.md b/docs/api/storage/SlicingBlockDevice.md index 304e89d54a..6ed07ee17a 100644 --- a/docs/api/storage/SlicingBlockDevice.md +++ b/docs/api/storage/SlicingBlockDevice.md @@ -1,6 +1,6 @@ # SlicingBlockDevice -![](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_slicing_block_device.png)SlicingBlockDevice class hierarchy +![](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_slicing_block_device.png)SlicingBlockDevice class hierarchy The SlicingBlockDevice class provides a way to break up a block device into subunits without the need to manually track offsets. The SlicingBlockDevice acts as an opposite of the [ChainingBlockDevice](chainingblockdevice.html) class. @@ -14,13 +14,13 @@ To configure this class, please see our [BlockDevice configuration documentation ## SlicingBlockDevice class reference -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_slicing_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/classmbed_1_1_slicing_block_device.html) ## SlicingBlockDevice example This SlicingBlockDevice example partitions a [HeapBlockDevice](heapblockdevice.html) into three subunits and showcases programming and reading back data segments through both the underlying master block device and the sliced subunits. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SlicingBlockDevice/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-SlicingBlockDevice/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-SlicingBlockDevice/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-SlicingBlockDevice/blob/v6.14/main.cpp) ## Related content diff --git a/docs/api/storage/psa_internal_storage.md b/docs/api/storage/psa_internal_storage.md index febc3317d0..e04a80974d 100644 --- a/docs/api/storage/psa_internal_storage.md +++ b/docs/api/storage/psa_internal_storage.md @@ -9,7 +9,7 @@ The implementation of PSA internal storage varies depending on the target type: ## PSA internal storage class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/psa__prot__internal__storage_8h.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/psa__prot__internal__storage_8h.html) ## Related content diff --git a/docs/bare_metal/c_small_libs.md b/docs/bare_metal/c_small_libs.md index eaa27dfe05..4fe36d2a55 100644 --- a/docs/bare_metal/c_small_libs.md +++ b/docs/bare_metal/c_small_libs.md @@ -83,7 +83,7 @@ This is energy efficient compared to an empty `while (true) {}` loop, which keep If your application is based on an `EventQueue`, dispatching it at the end of `main()` works as well: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/blob/v6.7/)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/blob/v6.14/)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/blob/v6.14/main.cpp) The call to `queue.dispatch_forever()` never returns, as long as you don't break the dispatch anywhere. The `EventQueue` class puts the system to sleep to save energy between events. diff --git a/docs/bare_metal/using_bare_metal.md b/docs/bare_metal/using_bare_metal.md index fdc2e4cb3c..c2c8e65d99 100644 --- a/docs/bare_metal/using_bare_metal.md +++ b/docs/bare_metal/using_bare_metal.md @@ -7,7 +7,7 @@ This guide shows how to create a bare metal profile application, or move an exis Here is a code snippet that can work for both Mbed OS profiles; it prints text at regular intervals using the `EventQueue` class. You will create an application that uses this code, set it to use the bare metal profile, and add the non-default `EventQueue` class. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-EventQueue_ex_2/blob/v6.14/main.cpp) **Note:** To be compatible with Arm microlib, a bare metal application should not return from `main()`. In this example, the `queue.dispatch_forever()` call never returns. For more details, see [Non-returning main()](../bare-metal/using-small-c-libraries.html). diff --git a/docs/debugging-testing/testing/testing_greentea.md b/docs/debugging-testing/testing/testing_greentea.md index 7b25b3db35..68b57a2215 100644 --- a/docs/debugging-testing/testing/testing_greentea.md +++ b/docs/debugging-testing/testing/testing_greentea.md @@ -105,7 +105,7 @@ first-greentea-test/ In this folder, create a file `main.cpp`. You can use UNITY, utest and the Greentea client to write your test: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Greentea_Ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Greentea_Ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Greentea_Ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Greentea_Ex_1/blob/v6.14/main.cpp) ### Running the test @@ -192,7 +192,7 @@ This registers one function you can call from the device: `init`. The function c This example writes the embedded part of this test. Create a new file `main.cpp` under the `TESTS/integration/test_case` directory, and fill it with: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Greentea_Ex_2/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Greentea_Ex_2/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Greentea_Ex_2/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Greentea_Ex_2/blob/v6.14/main.cpp) You see the calls to and from the host through the `greentea_send_kv` and `greentea_parse_kv` functions. Note the `GREENTEA_SETUP` call. This specifies which host test to use, and the test is then automatically loaded when running (based on the Python name). diff --git a/docs/debugging-testing/testing/utest.md b/docs/debugging-testing/testing/utest.md index 52e263045a..276ea20112 100644 --- a/docs/debugging-testing/testing/utest.md +++ b/docs/debugging-testing/testing/utest.md @@ -23,7 +23,7 @@ The order of handler execution is: This example showcases functionality and proper integration with the [Greentea testing automation framework](greentea-for-testing-applications.html), while making use of the [unity test macros](https://github.com/ARMmbed/mbed-os/tree/master/features/frameworks/unity): -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Utest_Ex_1/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Utest_Ex_1/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Utest_Ex_1/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Utest_Ex_1/blob/v6.14/main.cpp) Running this test will output the following: diff --git a/docs/porting/connectivity/LoRaPortingGuide.md b/docs/porting/connectivity/LoRaPortingGuide.md index 3574b350f7..da7038e7af 100644 --- a/docs/porting/connectivity/LoRaPortingGuide.md +++ b/docs/porting/connectivity/LoRaPortingGuide.md @@ -22,7 +22,7 @@ For a reference implementation, please see the existing [LoRa RF drivers](https: For API use cases, details, explanation and meaning, please see the `LoRaRadio` class reference below. We carefully planned and designed the data structures provided in [LoRaRadio.h](../mbed-os-api-doxy/_lo_ra_radio_8h_source.html). They carry most of what you need to write your LoRa RF driver. -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/class_lo_ra_radio.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/class_lo_ra_radio.html) ## Device design guide for LoRaWAN stack diff --git a/docs/porting/porting_full_process/porting.md b/docs/porting/porting_full_process/porting.md index c16ad8c69b..4dc2afbb73 100644 --- a/docs/porting/porting_full_process/porting.md +++ b/docs/porting/porting_full_process/porting.md @@ -178,7 +178,7 @@ Detailed instructions for porting each module are given in the module-specific s The official `mbed-os-example-blinky` uses the RTOS, a DigitalOut object and timers. The bare metal version of the example doesn't rely on RTOS, GPIO and timers; LED toggling is done directly by accessing hardware registers. Modify the Blinky program you checked out earlier to not use the timer and DigitalOut object: -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Direct-Register-Blinky)](https://github.com/ARMmbed/mbed-os-snippet-Direct-Register-Blinky/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Direct-Register-Blinky)](https://github.com/ARMmbed/mbed-os-snippet-Direct-Register-Blinky/blob/v6.14/main.cpp) ## Bootstrap and entry point diff --git a/docs/porting/security/hw-accelerated-crypto.md b/docs/porting/security/hw-accelerated-crypto.md index 602b6b11ce..115da167eb 100644 --- a/docs/porting/security/hw-accelerated-crypto.md +++ b/docs/porting/security/hw-accelerated-crypto.md @@ -16,7 +16,7 @@ You may want to add hardware acceleration in the following cases: - Your platform has a dedicated crypto-module capable of executing cryptographic primitives, and possibly storing keys securely. -The Mbed TLS library was written in C and it has a small amount of hand-optimized assembly code, limited to arbitrary precision multiplication on some processors. You can find the list of supported platforms in the top comment in [bn_mul.h](https://github.com/ARMmbed/mbedtls/blob/development/include/mbedtls/bn_mul.h). +The Mbed TLS library was written in C and it has a small amount of hand-optimized assembly code, limited to arbitrary precision multiplication on some processors. You can find the list of supported platforms in the top comment in [bn_mul.h](https://github.com/ARMmbed/mbed-os/blob/master/connectivity/mbedtls/include/mbedtls/bn_mul.h). ### What parts can I accelerate? diff --git a/docs/porting/storage/BlockDevice.md b/docs/porting/storage/BlockDevice.md index 65e00282d8..9b6e332d51 100644 --- a/docs/porting/storage/BlockDevice.md +++ b/docs/porting/storage/BlockDevice.md @@ -26,7 +26,7 @@ Erase, program and read block sizes may not be the same; however, they must be m You can find the BlockDevice class on the master branch under the `features/storage/blockdevice` path in Mbed OS. -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_block_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_block_device.html) The primary functions to implement are: diff --git a/docs/porting/storage/FileSystem.md b/docs/porting/storage/FileSystem.md index 51e6ba2fdf..953d9e71bc 100644 --- a/docs/porting/storage/FileSystem.md +++ b/docs/porting/storage/FileSystem.md @@ -4,7 +4,7 @@ ## File system class reference -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_file_system.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_file_system.html) ## Assumptions diff --git a/docs/porting/storage/storage.md b/docs/porting/storage/storage.md index 3384b74ccb..316a4efc41 100644 --- a/docs/porting/storage/storage.md +++ b/docs/porting/storage/storage.md @@ -26,7 +26,7 @@ A minimal file system needs to provide the following functions: Here is the full API that a file system may implement: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_file_system.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_file_system.html) File systems must be backed by a block device in Mbed OS. If you are using supported hardware, then you can use the Mbed OS block device classes. Otherwise, view the [block device porting section](#block-device) earlier in this guide. diff --git a/docs/porting/target/QuadSPI.md b/docs/porting/target/QuadSPI.md index 732a53ffe6..f32cca28a7 100644 --- a/docs/porting/target/QuadSPI.md +++ b/docs/porting/target/QuadSPI.md @@ -23,7 +23,7 @@ QSPI peripheral You can implement your own QSPI by pulling in the following API header file: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_q_s_p_i.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/classmbed_1_1_q_s_p_i.html) The target needs to define the `qspi_s` structure - target specific QSPI object. diff --git a/docs/porting/target/Watchdog.md b/docs/porting/target/Watchdog.md index e3d2442986..4ff8bf1413 100644 --- a/docs/porting/target/Watchdog.md +++ b/docs/porting/target/Watchdog.md @@ -32,7 +32,7 @@ Hardware Independent Watchdog support. You can find the API and specification for the Watchdog API in its HAL API reference: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__watchdog.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__watchdog.html) To enable Watchdog support in Mbed OS, add the `WATCHDOG` label in the `device_has` option of the target's section in the `targets.json` file. @@ -46,4 +46,4 @@ mbed test -t -m -n "tests-mbed_hal-watchdog*" For more details, please see: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__watchdog__tests.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__watchdog__tests.html) diff --git a/docs/porting/target/crc.md b/docs/porting/target/crc.md index d30d732b18..7ef9748337 100644 --- a/docs/porting/target/crc.md +++ b/docs/porting/target/crc.md @@ -29,7 +29,7 @@ The hardware CRC module in the MCU that supports at least one of the following d You can find the API and specification for the hardware CRC API in the following header file: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__crc.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__crc.html) To enable hardware CRC support in Mbed OS, add the `CRC` label in the `device_has` option of the target's section in the `targets.json` file. @@ -43,4 +43,4 @@ mbed test -t -m -n "tests-mbed_hal-crc*" You can read more about the test cases in the Doxygen: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__crc__tests.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__crc__tests.html) diff --git a/docs/porting/target/i2c.md b/docs/porting/target/i2c.md index 8ca51a8aa1..76cc67491e 100644 --- a/docs/porting/target/i2c.md +++ b/docs/porting/target/i2c.md @@ -99,7 +99,7 @@ Hardware I2C capabilities. You can find the API and specification for the I2C API in the following class reference: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/feature-i2c-doxy/classmbed_1_1_i2_c.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/feature-i2c-doxy/classmbed_1_1_i2_c.html) To enable I2C support in Mbed OS, add the `I2C` label in the `device_has` option of the target's section in the `targets.json` file. @@ -116,4 +116,4 @@ mbed test -t -m -n "tests-mbed_hal_fpga_ci_test_shield-i2c" You can read more about the test cases: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/feature-i2c-doxy/group__hal__i2c__tests.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/feature-i2c-doxy/group__hal__i2c__tests.html) diff --git a/docs/porting/target/itm.md b/docs/porting/target/itm.md index 4c9e5a63ef..ab9d399c05 100644 --- a/docs/porting/target/itm.md +++ b/docs/porting/target/itm.md @@ -24,7 +24,7 @@ Some SWO viewers do not allow an arbitrary frequency to be set. Make sure that t ## Implementing the ITM API -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__itm__hal.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__itm__hal.html) - You must implement the function `itm_init`. When the function is called: - The function must initialize the debug clock for the ITM. diff --git a/docs/porting/target/lp_ticker.md b/docs/porting/target/lp_ticker.md index 9d003b084a..7616e5a915 100644 --- a/docs/porting/target/lp_ticker.md +++ b/docs/porting/target/lp_ticker.md @@ -48,7 +48,7 @@ Hardware low power ticker capabilities. You can find the API and specification for the low power ticker API in the following header file: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__lp__ticker.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__lp__ticker.html) To enable low power ticker support in Mbed OS, add the `LPTICKER` label in the `device_has` option of the target's section in the `targets.json` file. @@ -62,8 +62,8 @@ mbed test -t -m -n tests-mbed_hal-common_ticker*,tests-mbed You can read more about the test cases: - [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__lp__ticker.html) + [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__lp__ticker.html) - [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__ticker__tests.html) + [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__ticker__tests.html) - [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__lp__ticker__tests.html) + [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__lp__ticker__tests.html) diff --git a/docs/porting/target/mpu.md b/docs/porting/target/mpu.md index c95e17c7d4..f4a6a06d67 100644 --- a/docs/porting/target/mpu.md +++ b/docs/porting/target/mpu.md @@ -23,7 +23,7 @@ Hardware MPU capabilities. You can find the API and specification for the MPU API in the following header file: -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/group__hal__mpu.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/group__hal__mpu.html) To enable MPU support in Mbed OS, add the `MPU` label in the `device_has` option of the target's section in the `targets.json` file. @@ -41,4 +41,4 @@ mbed test -t -m -n "tests-mbed_hal-mpu*" You can read more about the test cases: - [![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/mbed-os-api-doxy/group__hal__mpu__tests.html) + [![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/mbed-os-api-doxy/group__hal__mpu__tests.html) diff --git a/docs/porting/target/rtc.md b/docs/porting/target/rtc.md index 4642010f21..2754ef9942 100644 --- a/docs/porting/target/rtc.md +++ b/docs/porting/target/rtc.md @@ -32,7 +32,7 @@ Hardware RTC capabilities. You can find the API and specification for the RTC API in the following header file: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__rtc.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__rtc.html) To enable RTC support in Mbed OS, add the `RTC` label in the `device_has` option of the target's section in the `targets.json` file. @@ -46,4 +46,4 @@ mbed test -t -m -n "tests-mbed_hal-rtc*" You can read more about the test cases: - [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__rtc__tests.html) + [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__rtc__tests.html) diff --git a/docs/porting/target/sai.md b/docs/porting/target/sai.md index 3120c06687..ff4e829378 100644 --- a/docs/porting/target/sai.md +++ b/docs/porting/target/sai.md @@ -76,7 +76,7 @@ Hardware SAI/I2S capabilities. You can find the API and specification for the SAI API in the following class reference: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/feature-hal-spec-sai-doxy/classmbed_1_1_s_a_i.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/feature-hal-spec-sai-doxy/classmbed_1_1_s_a_i.html) To enable SAI support in Mbed OS, add the `SAI` label in the `device_has` option of the target's section in the `targets.json` file. @@ -90,4 +90,4 @@ mbed test -t -m -n "tests-mbed_hal-sai*" You can read more about the test cases: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/feature-hal-spec-sai-doxy/group__hal__sai__tests.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/feature-hal-spec-sai-doxy/group__hal__sai__tests.html) diff --git a/docs/porting/target/sleep.md b/docs/porting/target/sleep.md index e3d23a1fba..ea25a51647 100644 --- a/docs/porting/target/sleep.md +++ b/docs/porting/target/sleep.md @@ -26,7 +26,7 @@ The core system clock is disabled. You can only enable the low-frequency clocks You can find the API and specification for the sleep API in the following header file: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__sleep.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__sleep.html) To enable sleep support in Mbed OS, you need to add the `SLEEP` label in the `device_has` option of the target's section in the `targets.json` file. @@ -44,4 +44,4 @@ mbed test -t -m -n "tests-mbed_hal-sleep*" You can read more about the test cases: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__sleep__tests.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__sleep__tests.html) diff --git a/docs/porting/target/spi.md b/docs/porting/target/spi.md index 2fa559f162..940b64dd1e 100644 --- a/docs/porting/target/spi.md +++ b/docs/porting/target/spi.md @@ -112,7 +112,7 @@ Hardware SPI capabilities. You can find the API and specification for the SPI API in the following class reference: -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/feature-hal-spec-spi-doxy/classmbed_1_1_s_p_i.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/feature-hal-spec-spi-doxy/classmbed_1_1_s_p_i.html) To enable SPI support in Mbed OS, add the `SPI` label in the `device_has` option of the target's section in the `targets.json` file. You can also add the `SPI_ASYNCH` label in the `device_has` option to enable the asynchronous API. @@ -127,7 +127,7 @@ mbed test -t -m -n "tests-mbed_hal-spi*" You can read more about the test cases: -[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/development/feature-hal-spec-spi-doxy/group__hal__spi__tests.html) +[![View code](https://www.mbed.com/embed/?type=library)](http://os.mbed.com/docs/v6.14/feature-hal-spec-spi-doxy/group__hal__spi__tests.html) To test SPI using the FPGA test shield: diff --git a/docs/porting/target/us_ticker.md b/docs/porting/target/us_ticker.md index 5579f42d53..c6c5cf6d7d 100644 --- a/docs/porting/target/us_ticker.md +++ b/docs/porting/target/us_ticker.md @@ -44,7 +44,7 @@ To implement this API, the device must have a hardware counter that has a count You can find the API and specification for the microsecond ticker API in the following header file: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__us__ticker.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__us__ticker.html) To enable microsecond ticker support in Mbed OS, add the `USTICKER` label in the `device_has` option of the target's section in the `targets.json` file. @@ -64,8 +64,8 @@ mbed test -t -m -n tests-mbed_hal-common_ticker*,tests-mbed You can read more about the test cases: - [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__us__ticker.html) + [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__us__ticker.html) - [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__ticker__tests.html) + [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__ticker__tests.html) - [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__hal__us__ticker__tests.html) + [![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__hal__us__ticker__tests.html) diff --git a/docs/porting/target/usb.md b/docs/porting/target/usb.md index 455d5c3dfa..63caafd215 100644 --- a/docs/porting/target/usb.md +++ b/docs/porting/target/usb.md @@ -38,7 +38,7 @@ The HAL USBPhy API provides physical access to the USB bus in the role of a USB You can find the HAL API and specification for USB in the following module: -[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/group__drivers___u_s_b_device.html) +[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/mbed-os/v6.14/mbed-os-api-doxy/group__drivers___u_s_b_device.html) To enable the HAL USBPhy API in Mbed OS, add the `USBDEVICE` label in the `device_has` option of the target's section in the `targets.json` file. diff --git a/docs/program-setup/concepts/Execution.md b/docs/program-setup/concepts/Execution.md index e11cd75a8b..6a783aa41d 100644 --- a/docs/program-setup/concepts/Execution.md +++ b/docs/program-setup/concepts/Execution.md @@ -39,4 +39,4 @@ All the ISR handlers execute in this mode. You can use the same RTOS API in ISR This example uses a message from the queue to trigger an interrupt. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Isr/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Isr/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Isr/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Isr/blob/v6.14/main.cpp) diff --git a/docs/program-setup/serial/serial_communication.md b/docs/program-setup/serial/serial_communication.md index 1510749d30..9f5e83eef9 100644 --- a/docs/program-setup/serial/serial_communication.md +++ b/docs/program-setup/serial/serial_communication.md @@ -14,7 +14,7 @@ This allows you to: This program prints a "Hello World!" message that you can view on a serial terminal. Mbed OS redirects any `printf()` statements to the board's debug USB serial. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_STDOUT/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Serial_STDOUT/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_STDOUT/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Serial_STDOUT/blob/v6.14/main.cpp) ## Viewing output in a serial terminal @@ -70,7 +70,7 @@ If you're not sure how to build these examples and run them on your board, pleas ### Echo back characters you type -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_EchoBack/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Serial_EchoBack/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_EchoBack/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Serial_EchoBack/blob/v6.14/main.cpp) ### Use the U and D keys to make LED1 brighter or dimmer @@ -78,14 +78,14 @@ If you're not sure how to build these examples and run them on your board, pleas ![](../../images/NUCLEOF401RE.png)The pin map of the NUCLEO-F401RE shows LED1 on the Pwm pin. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_LEDControl/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Serial_LEDControl/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_LEDControl/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Serial_LEDControl/blob/v6.14/main.cpp) ### Pass characters in both directions Tie pins together to see characters echoed back. -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_PassCharacters/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Serial_PassCharacters/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_PassCharacters/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Serial_PassCharacters/blob/v6.14/main.cpp) ### Read to a buffer -[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_ReadToBuffer/tree/v6.7)](https://github.com/ARMmbed/mbed-os-snippet-Serial_ReadToBuffer/blob/v6.7/main.cpp) +[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-snippet-Serial_ReadToBuffer/tree/v6.14)](https://github.com/ARMmbed/mbed-os-snippet-Serial_ReadToBuffer/blob/v6.14/main.cpp) diff --git a/docs/quick-start/quick-start-compiler.md b/docs/quick-start/quick-start-compiler.md index 07a7dabb22..1a45d1a4af 100644 --- a/docs/quick-start/quick-start-compiler.md +++ b/docs/quick-start/quick-start-compiler.md @@ -29,7 +29,7 @@ This page covers: Click the button below to automatically import the example into the Online Compiler. -[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-blinky)](https://github.com/ARMmbed/mbed-os-example-blinky/blob/mbed-os-6.7.0/main.cpp) +[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-blinky)](https://github.com/ARMmbed/mbed-os-example-blinky/blob/mbed-os-6.14.0/main.cpp) Alternatively, you may select the import button on the top left hand side of the Online Compiler screen and copy the [example link](https://github.com/ARMmbed/mbed-os-example-blinky) into the prompt. @@ -39,7 +39,7 @@ Alternatively, you may select the import button on the top left hand side of the Click the button below to automatically import the example into the Online Compiler. -[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-blinky-baremetal)](https://github.com/armmbed/mbed-os-example-blinky-baremetal/blob/mbed-os-6.7.0/main.cpp) +[![View Example](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-blinky-baremetal)](https://github.com/armmbed/mbed-os-example-blinky-baremetal/blob/mbed-os-6.14.0/main.cpp) Alternatively, you may select the import button on the top left hand side of the Online Compiler screen and copy the [example link](https://github.com/ARMmbed/mbed-os-example-blinky-baremetal) into the prompt. diff --git a/readme.md b/readme.md index 044099ebf1..9c04977dfd 100644 --- a/readme.md +++ b/readme.md @@ -7,6 +7,6 @@ If you want to contribute, please read our [contribution guide](https://os.mbed. Please open pull requests against either: - `development` - this is our development branch. -- `6.13` - this is the latest live version. +- `6.14` - this is the latest live version. Older version branches probably don't require fixes; please open an issue if you think we're wrong.