From 103616ea372339d0a72258f051f56c2fb12a1832 Mon Sep 17 00:00:00 2001 From: RobMeades Date: Wed, 24 Jul 2024 22:43:51 +0100 Subject: [PATCH] Documentation update only: even betterer again. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6d7eb1d3..b70b1e07 100644 --- a/README.md +++ b/README.md @@ -71,14 +71,14 @@ If your MCU is not on the list: # Supported modules as `ubxlib` peripherals and APIs Peripherals are u-blox modules which accept commands (e.g. AT-commands) over a serial interface and have no open MCU environment. To run the APIs they need to be attached to a host which runs `ubxlib`. For example in the [test farm](/port/platform/common/automation/DATABASE.md) combinations of hosts and peripherals are listed. -|`ubxlib` peripherals |NINA-B41 series
NINA-B31 series
NINA-B1 series
ANNA-B1|NINA-W13|NINA-W15
NORA-W364|SARA-U2 series|LENA-R8 series|LEXI-R10 series/
LEXI-R4 series/
SARA-R4 series
LEXI-R5 series/
SARA-R5 series
LARA-R6 series
|SARA-R510M8S
SARA-R520M10S
SARA-R422M8S
SARA-R422M10S|M8/M9/M10 series| +|`ubxlib` peripherals |NINA-B41 series
NINA-B31 series
NINA-B1 series
ANNA-B1|NINA-W13|NINA-W15
NORA-W364|SARA-U2 series|LENA-R8 series|LEXI-R10 series
LEXI-R4 series
LEXI-R5 series
SARA-R4 series
SARA-R5 series
LARA-R6 series
|SARA-R510M8S
SARA-R520M10S
SARA-R422M8S
SARA-R422M10S|M8/M9/M10 series| |-----------|-----------|--------------|-----|-----|-----|------|------|------| |**APIs provided by host with peripheral attached**|[ble](/ble "ble API")
[device](/common/device "device API")
[network](/common/network "network API")|[wifi](/wifi)
[device](/common/device "device API")
[network](/common/network "network API")
[sock](/common/sock "sock API")
[TLS security](/common/security "security API")
[mqtt_client](/common/mqtt_client "MQTT client API")
[http_client](/common/http_client "HTTP client API")|[wifi](/wifi)
[ble](/ble "ble API")
[device](/common/device "device API")
[network](/common/network "network API")
[sock](/common/sock "sock API")
[TLS security](/common/security "security API")
[mqtt_client](/common/mqtt_client "MQTT client API")
[http_client](/common/http_client "HTTP client API")|[cell](/cell "cell API")
[device](/common/device "device API")
[network](/common/network "network API")
[sock](/common/sock "sock API")
[location3](/common/location "location API")
[TLS security](/common/security "security API")
[http_client](/common/http_client "HTTP client API")|[cell](/cell "cell API")
[device](/common/device "device API")
[network](/common/network "network API")
[sock](/common/sock "sock API")
[location3](/common/location "location API")
[TLS security](/common/security "security API")
[mqtt_client](/common/mqtt_client "MQTT client API")|[cell](/cell "cell API")
[device](/common/device "device API")
[network](/common/network "network API")
[sock](/common/sock "sock API")
[location3](/common/location "location API")
[security5](/common/security "security API")
[mqtt_client](/common/mqtt_client "MQTT client API")
[http_client](/common/http_client "HTTP client API")|All APIs of
SARA-R4,
SARA-R5 series +
[gnss](/gnss "GNSS API")
[location](/common/location "location API")|[gnss](/gnss "GNSS API")
[location](/common/location "location API")| 3: Through the u-blox [CellLocate](https://www.u-blox.com/en/product/celllocate) mobile network-based location service.
4: Beta support: please **add** `short_range_gen2` to the `UBXLIB_FEATURES` variable in your `make` or `CMake` file when building `ubxlib` for NORA-W36; NORA-W36 comes with a second generation u-connectExpress, please see the release notes for NORA-W36 for the supported features.
-5: Except SARA-R422 (non-S), which supports no form of security, and SARA-R52/LEXI-R5/LEXI-R4, which support only [TLS security](/common/security "security API").
+5: Except SARA-R422 (non-S), which supports no form of security, and LEXI-R5/LEXI-R4/LEXI-R10/SARA-R52, which support only [TLS security](/common/security "security API").
# Structure of `ubxlib` The APIs for each type of u-blox module can be found in the relevant directory (e.g. [cell](/cell) for cellular modules and [ble](/ble)/[wifi](/wifi) for BLE/Wi-Fi modules). The [common](/common) directory contains APIs and 'helper' modules that are shared by u-blox modules, most importantly the [device](/common/device) API, the [network](/common/network) API and the [sockets](/common/sockets) API. All APIs are documented in the API header files.