Skip to content

Commit

Permalink
Documentation update only: even betterer again.
Browse files Browse the repository at this point in the history
  • Loading branch information
RobMeades committed Jul 24, 2024
1 parent c56f86a commit 103616e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<br />NINA-B31 series<br />NINA-B1 series<br />ANNA-B1|NINA-W13|NINA-W15<br /><nobr>NORA-W36<sup>4</sup></nobr>|SARA-U2 series|LENA-R8 series|LEXI-R10 series/<br />LEXI-R4 series/<br />SARA-R4 series<br />LEXI-R5 series/<br />SARA-R5 series<br />LARA-R6 series<br />|SARA-R510M8S<br />SARA-R520M10S<br />SARA-R422M8S<br />SARA-R422M10S|M8/M9/M10 series|
|`ubxlib` peripherals |NINA-B41 series<br />NINA-B31 series<br />NINA-B1 series<br />ANNA-B1|NINA-W13|NINA-W15<br /><nobr>NORA-W36<sup>4</sup></nobr>|SARA-U2 series|LENA-R8 series|LEXI-R10 series<br />LEXI-R4 series<br />LEXI-R5 series<br />SARA-R4 series<br />SARA-R5 series<br />LARA-R6 series<br />|SARA-R510M8S<br />SARA-R520M10S<br />SARA-R422M8S<br />SARA-R422M10S|M8/M9/M10 series|
|-----------|-----------|--------------|-----|-----|-----|------|------|------|
|**APIs provided by host with peripheral attached**|[ble](/ble "ble API")<br />[device](/common/device "device API")<br />[network](/common/network "network API")|[wifi](/wifi)<br />[device](/common/device "device API")<br />[network](/common/network "network API")<br />[sock](/common/sock "sock API")<br />[TLS&nbsp;security](/common/security "security API")<br />[mqtt_client](/common/mqtt_client "MQTT client API")<br />[http_client](/common/http_client "HTTP client API")|[wifi](/wifi)<br />[ble](/ble "ble API")<br />[device](/common/device "device API")<br />[network](/common/network "network API")<br />[sock](/common/sock "sock API")<br />[TLS&nbsp;security](/common/security "security API")<br />[mqtt_client](/common/mqtt_client "MQTT client API")<br />[http_client](/common/http_client "HTTP client API")|[cell](/cell "cell API")<br />[device](/common/device "device API")<br />[network](/common/network "network API")<br />[sock](/common/sock "sock API")<br />[location<sup>3</sup>](/common/location "location API")<br />[TLS&nbsp;security](/common/security "security API")<br />[http_client](/common/http_client "HTTP client API")|[cell](/cell "cell API")<br />[device](/common/device "device API")<br />[network](/common/network "network API")<br />[sock](/common/sock "sock API")<br />[location<sup>3</sup>](/common/location "location API")<br />[TLS&nbsp;security](/common/security "security API")<br />[mqtt_client](/common/mqtt_client "MQTT client API")|[cell](/cell "cell API")<br />[device](/common/device "device API")<br />[network](/common/network "network API")<br />[sock](/common/sock "sock API")<br />[location<sup>3</sup>](/common/location "location API")<br />[security<sup>5</sup>](/common/security "security API")<br />[mqtt_client](/common/mqtt_client "MQTT client API")<br />[http_client](/common/http_client "HTTP client API")|All APIs of<br />SARA-R4,<br />SARA-R5 series&nbsp;+<br />[gnss](/gnss "GNSS API")<br />[location](/common/location "location API")|[gnss](/gnss "GNSS API")<br />[location](/common/location "location API")|


<sup>3: Through the u-blox [CellLocate](https://www.u-blox.com/en/product/celllocate) mobile network-based location service.</sup><br />
<sup>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.</sup><br />
<sup>5: Except SARA-R422 (non-S), which supports no form of security, and SARA-R52/LEXI-R5/LEXI-R4, which support only [TLS&nbsp;security](/common/security "security API").</sup><br />
<sup>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&nbsp;security](/common/security "security API").</sup><br />

# 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.
Expand Down

0 comments on commit 103616e

Please sign in to comment.