Merge branch 'development' into unittests

Author: theotherjimmy

.circleci/config.yml

@@ -0,0 +1,24 @@
+version: 2
+
+jobs:
+  build:
+    docker:
+      - image: mbed/doc_builder:latest
+        auth:
+          username: $DOCKER_USER
+          password: $DOCKER_PASS
+
+    steps:
+      - checkout
+
+      - run:
+          name: Validate and build documentation
+          command: |
+            docbuilder build os-docs /tmp/artifacts --path ~/project/docs.json --github_token "$GITHUB_TOKEN"
+      - run:
+          name: Move images
+          command: |
+            cp -R ~/project/docs/images /tmp/artifacts/
+      - store_artifacts:
+          path: /tmp/artifacts
+          destination: docs

docs.json

@@ -39,14 +39,6 @@ A few micro:bit How To videos:
 - [Hashing](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-tls-hashing/): performs hashing of a buffer with SHA-256 using various APIs. It serves as a tutorial for the basic hashing APIs of Mbed TLS.
 - [TLS client](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-tls-tls-client/): downloads a file from an HTTPS server (os.mbed.com) and looks for a specific string in that file.
 
-##### Arm Mbed uVisor
-
-- [Threaded Blinky with uVisor](https://github.com/ARMmbed/mbed-os-example-uvisor-thread): an example threaded application with uVisor security.
-- [IRQ Blinky uVisor](https://github.com/ARMmbed/mbed-os-example-uvisor): an example threaded application with uVisor security and IRQ support.
-- [Threaded REPC with uVisor](https://github.com/ARMmbed/mbed-os-example-uvisor-number-store): using uVisor APIs to build a box that stores a number.
-
-These examples work on the K64F and the GNU Arm Embedded toolchain only.
-
 #### Core features
 
 ##### File system

docs/images/boot_sequence.png

@@ -1,7 +1,7 @@
-## API overview
+## Full API list
 
 
-### Platform
+### Platform APIs
 
 [Modules that provide consistent user experience.](platform.html)
 
@@ -11,30 +11,32 @@
 <td><a href="wait.html">Wait</a></td>
 <td><a href="criticalsectionlock.html">CriticalSectionLock</a></td>
 <td><a href="memory-tracing.html">Memory tracing</a></td>
-<td><a href="platformmutex.html">PlatformMutex</a></td>
+<td><a href="shared-pointer.html">Shared pointer</a></td>
+<td><a href="atcmdparser.html">ATCmdParser</a></td>
 </tr>
 <tr>
-<td><a href="callback.html">CallBack</a></td>
+<td><a href="callback.html">Callback</a></td>
 <td><a href="time.html">Time</a></td>
 <td><a href="error-handling.html">Error handling</a></td>
-<td><a href="circularbuffer.html">CircularBuffer</a></td>
+<td><a href="span.html">Span</a></td>
+<td><a href="mbed-statistics.html">Mbed statistics</a></td>
 </tr>
 <tr>
 <td><a href="deepsleeplock.html">DeepSleepLock</a></td>
 <td><a href="rtc.html">RTC</a></td>
 <td><a href="assert.html">Assert</a></td>
-<td><a href="atcmdparser.html">ATCmdParser</a></td>
+<td><a href="platformmutex.html">PlatformMutex</a></td>
 </tr>
 <tr>
 <td><a href="power-management.html">Power management</a></td>
 <td><a href="debug.html">Debug</a></td>
 <td><a href="noncopyable.html">NonCopyable</a></td>
-<td><a href="mbed-statistics.html">Mbed statistics</a></td>
+<td><a href="circularbuffer.html">CircularBuffer</a></td>
 </tr>
 </tbody>
 </table>
 
-### Drivers
+### Drivers APIs
 
 [Analog and digital input and outputs and digital interfaces.](drivers.html)
 
@@ -44,30 +46,31 @@
 <td><a href="analogin.html">AnalogIn</a></td>
 <td><a href="portin.html">PortIn</a></td>
 <td><a href="lowpowertimeout.html">LowPowerTimeout</a></td>
-<td><a href="i2cslave.html">I2CSlave</a></td>
+<td><a href="i2c.html">I2C</a></td>
 </tr>
 <tr>
 <td><a href="analogout.html">AnalogOut</a></td>
 <td><a href="portout.html">PortOut</a></td>
 <td><a href="lowpowertimer.html">LowPowerTimer</a></td>
-<td><a href="debug.html">CAN</a></td>
+<td><a href="i2cslave.html">I2CSlave</a></td>
 </tr>
 <tr>
 <td><a href="digitalin.html">DigitalIn</a></td>
 <td><a href="portinout.html">PortInOut</a></td>
 <td><a href="flash-iap.html">Flash IAP</a></td>
-<td><a href="mbedcrc.html">MbedCRC</a></td>
+<td><a href="debug.html">CAN</a></td>
 </tr>
 <tr>
 <td><a href="digitalout.html">DigitalOut</a></td>
 <td><a href="pwmout.html">PwmOut</a></td>
 <td><a href="rawserial.html">RawSerial</a></td>
-<td><a href="devicekey.html">DeviceKey</a></td>
+<td><a href="mbedcrc.html">MbedCRC</a></td>
 </tr>
 <tr>
 <td><a href="digitalinout.html">DigitalInOut</a></td>
 <td><a href="interruptin.html">InterruptIn</a></td>
 <td><a href="serial.html">Serial</a></td>
+<td><a href="devicekey.html">DeviceKey</a></td>
 </tr>
 <tr>
 <td><a href="busin.html">BusIn</a></td>
@@ -82,12 +85,12 @@
 <tr>
 <td><a href="businout.html">BusInOut</a></td>
 <td><a href="lowpowerticker.html">LowPowerTicker</a></td>
-<td><a href="i2c.html">I2C</a></td>
+<td><a href="quadspi-qspi.html">QuadSPI (QSPI)</a></td>
 </tr>
 </tbody>
 </table>
 
-### RTOS
+### RTOS APIs
 
 [Handling tasks and events in Mbed OS.](rtos.html)
 
@@ -113,3 +116,124 @@
 </tr>
 </tbody>
 </table>
+
+### Network socket APIs
+
+[Network socket API for TCP/IP.](network-socket.html)
+
+<table>
+<tbody>
+<tr>
+<td><a href="socket.html">Socket</a></td>
+<td><a href="socketaddress.html">SocketAddress</a></td>
+</tr>
+<tr>
+<td><a href="udpsocket.html">UDPSocket</a></td>
+<td><a href="dns-resolver.html">DNS Resolver</a></td>
+<tr>
+<td><a href="tcpsocket.html">TCPSocket</a></td>
+</tr>
+</tbody>
+</table>
+
+### Network interfaces APIs
+
+[Network interfaces, Ethernet, Wifi, Cellular & Mesh](network-interfaces.html)
+
+<table>
+<tbody>
+<tr>
+<td><a href="ethernet.html">Ethernet</a></td>
+<td><a href="mesh-api.html">6LoWPAN Mesh</a></td>
+</tr>
+<tr>
+<td><a href="wi-fi.html">Wi-Fi</a></td>
+<td><a href="network-status.html">Network status</a></td>
+<tr>
+<td><a href="cellular-api.html">Cellular</a></td>
+</tr>
+</tbody>
+</table>
+
+### Bluetooth Low Energy (BLE) APIs
+
+[Bluetooth Low Energy](bluetooth.html)
+
+<table>
+<tbody>
+<tr>
+<td><a href="ble.html">BLE</a></td>
+<td><a href="gattserver.html">GattServer</a></td>
+<td><a href="heartrateservice.html">HeartRateService</a></td>
+</tr>
+<tr>
+<td><a href="gap.html">GAP</a></td>
+<td><a href="secuirtymanager.html">SecurityManager</a></td>
+<td><a href="ibeacon.html">iBeacon</a></td>
+<tr>
+<td><a href="gattclient.html">GattClient</a></td>
+<td><a href="batteryservice.html">BatteryService</a></td>
+</tr>
+</tbody>
+</table>
+
+### LoRaWAN APIs
+
+[Low power wide area network.](lorawan.html)
+
+<table>
+<tbody>
+<tr>
+<td><a href="lorawan-api.html">LoRaWANInterface</a></td>
+</tr>
+<tr>
+<td><a href="loraradio-api.html">LoRaRadio</a></td>
+</tr>
+</tbody>
+</table>
+
+### Security APIs
+
+[Working with Arm Mbed uVisor and Arm Mbed TLS in the context of Mbed OS.](security.html)
+
+<table>
+<tbody>
+<tr>
+<td><a href="tls.html">TLS</a></td>
+</tr>
+<tr>
+<td><a href="uvisor.html">uVisor</a></td>
+</tr>
+</tbody>
+</table>
+
+### Storage APIs
+
+[Working with the file system.](storage.html)
+
+<table>
+<tbody>
+<tr>
+<td><a href="filesystem.html">FileSystem</a></td>
+<td><a href="fatfilesystem.html">FATFileSystem</a></td>
+<td><a href="chainingblockdevice.html">ChainingBlockDevice</a></td>
+<td><a href="flashsimblockdevice.html">FlashSimBlockDevice</a></td>
+</tr>
+<tr>
+<td><a href="dir.html">Dir</a></td>
+<td><a href="blockdevice.html">BlockDevice</a></td>
+<td><a href="slicingblockdevice.html">SlicingBlockDevice</a></td>
+<td><a href="nvstore.html">NVStore</a></td>
+</tr>
+<tr>
+<td><a href="file.html">File</a></td>
+<td><a href="heapblockdevice.html">HeapBlockDevice</a></td>
+<td><a href="profilingblockdevice.html">ProfilingBlockDevice</a></td>
+</tr>
+<tr>
+<td><a href="littlefilesystem.html">LittleFileSystem</a></td>
+<td><a href="mbrblockdevice.html">MBRBlockDevice</a></td>
+<td><a href="bufferedblockdevice.html">BufferedBlockDevice</a></td>
+</tr>
+</tbody>
+</table>

docs/images/fastmodel_cm3.png

@@ -26,20 +26,20 @@ Privacy is a feature that allows a device to avoid being tracked by other (untru
 
 You need to enable privacy by calling `enablePrivacy()` after initializing the SecurityManager because privacy requires SecurityManager to handle IRKs. Set the behavior of privacy enabled devices by using `setCentralPrivacyConfiguration()`, which specifies what the device should be with devices using random addresses, and `setPeripheralPrivacyConfiguration`. Random addresses that privacy enabled devices generate can be of two types: resolvable (by devices who have the IRK) and unresolvable. You can't use unresolvable addresses for connecting and connectable advertising; therefore, use a resolvable one for these, regardless of the privacy configuration.
 
-#### Modulation Schemes
+#### Modulation schemes
 
 When supported by the host and controller, you can select different modulation schemes:
 
-- LE 1M PHY.
-- LE 2M PHY.
-- LE coded PHY.
+ - LE 1M PHY.
+ - LE 2M PHY.
+ - LE coded PHY.
 
 These provide different compromises between bandwidth, power usage and error resiliency (see BLUETOOTH SPECIFICATION Version 5.0 Vol 1, Part A - 1.2).
- 
-You may set preferred PHYs (separately for RX and TX) using `setPreferredPhys()`. You may also set the currently used PHYs on a selected connection using `setPhy()`. Both of these settings are only advisory, and the controller is allowed to make its own decision on the best PHY to use based on your request, the peer's supported features and the connection's physical conditions.
- 
+
+You may set preferred PHYs (separately for RX and TX) using `setPreferredPhys()`. You may also set the currently used PHYs on a selected connection using `setPhy()`. Both of these settings are only advisory. The controller is allowed to make its own decision on the best PHY to use based on your request, the peer's supported features and the connection's physical conditions.
+
 You may query the currently used PHY using `readPhy()`, which returns the result through a call to the registered event handler. You may register the handler with `setEventHandler()`. The events inform about the currently used PHY and of any changes to PHYs, which the controller or the peer may trigger autonomously.
- 
+
 ### GAP class reference
 
 [![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_gap.html)

docs/images/quadspi.png

@@ -4,13 +4,85 @@ A socket requires a NetworkInterface instance when opened to indicate which Netw
 
 Network interface is also the controlling API for application to specify network configuration.
 
-Existing network interfaces:
+### Existing network interfaces:
 
 - [Ethernet](ethernet.html): API for connecting to the internet over an Ethernet connection.
 - [Wi-Fi](wi-fi.html): API for connecting to the internet with a Wi-Fi device.
 - [Cellular](cellular-api.html): API for connecting to the internet using a cellular device.
 - [Mesh networking interface](mesh-api.html): Mbed OS provides two kinds of IPv6-based mesh networks - 6LoWPAN_ND and Thread.
 
-Optional functionality:
+### Network status updates
+
+An application may choose to register a callback to monitoring status changes from network interfaces. The application can do this by using the following API:
 
 - [Network status](network-status.html): API for monitoring network status changes.
+
+### Default network interface
+
+In Mbed OS, targets that provide network connectivity also provide a default network interface. This can be Ethernet, Wi-Fi, mesh or cellular. Using a default interface allows you to port applications to different targets and connectivity options.
+
+The following example uses a default interface to connect to the network:
+
+```
+NetworkInterface *net = NetworkInterface::get_default_instance();
+
+if (!net) {
+    printf("Error! No network inteface found.\n");
+    return 0;
+}
+
+net->connect();
+```
+
+This example works on all IP-based connectivity options that Mbed OS supports. The Mbed OS configuration system provides configuration for the default interface at build time, so at run time, you can just call `connect()` without any parameters.
+
+For example, when providing Wi-Fi SSID and password, you may use the following `mbed_app.json`:
+
+```
+{
+    "target_overrides": {
+        "*": {
+            "nsapi.default-wifi-security": "WPA_WPA2",
+            "nsapi.default-wifi-ssid": "\"ssid\"",
+            "nsapi.default-wifi-password": "\"password\""
+        }
+    }
+}
+```
+
+Please see [Selecting the default network interface](configuration-connectivity.html#selecting-the-default-network-interface) for information about how to supply required configuration parameters on different connections.
+
+Targets with connectivity set the `target.network-default-interface-type` configuration variable appropriately, either to their only interface or the one most commonly used. For targets that provide more than one type of connectivity, you may choose the default by overriding the `target.network-default-interface-type` configuration variable.
+
+Applications may also ask for a specific type of connection, as the following table shows:
+
+|Method|What connectivity is returned| Requirements |
+|------|-----------------------------|--------------|
+|`*WiFiInterface::get_default_instance()`| Wi-Fi interface | Requires security parameters (mode, SSID, password) |
+|`*EthInterface::get_default_instance()` | Wired Ethernet interface, not Wi-Fi | none |
+|`*MeshInterface::get_default_instance()` | Returns either `LoWPANNDInterface` or `ThreadInterface`, depending on which is set to default | Target provides a driver or macro `DEVICE_802_15_4_PHY` is enabled |
+| `*CellularBase::get_default_instance()` | Return cellular connectivity | Requires network parameters (pin, APN, username, password) |
+| `*NetworkInterface::get_default_instance()` | One of the above, depending on `target.network-default-interface-type` |  |
+
+Note that the calls for a specific interface type do not preconfigure credentials such as SSID because an interface-type-specific application is expected to configure these in code. `NULL` is returned if no interface of that type is available.
+
+Calls for a NetworkInterface will request one of the interface types depending on `target.default-network-interface-type`, and preconfigure the credentials. If credentials can't be preconfigured (for example because `nsapi.default-wifi-ssid` isn't set), the call returns `NULL` rather than an unconfigured interface.
+
+An application may check the type of the interface returned by `NetworkInterface::get_default_instance()` by using the "dynamic downcast" methods:
+
+```
+// net set from NetworkInterface::get_default_instance() as above
+WiFiInterface *wifi = net->wifiInterface();
+if (wifi) {
+    printf("This is a Wi-Fi board.")
+    // call WiFi-specific methods
+}
+```
+
+### Related content
+
+- [Configuring the default network interface](configuration-connectivity.html#selecting-the-default-network-interface).
+- [Network connectivity](connectivity-tech.html).
+- [IP networking](ip-networking.html).
+- [Network status API](network-status.html).
+- [Network sockets](network-socket.html).