Skip to content
This repository has been archived by the owner on Nov 11, 2024. It is now read-only.

Commit

Permalink
Documentation change only: list module/chip/uConnectExpress versions.
Browse files Browse the repository at this point in the history
  • Loading branch information
RobMeades committed Nov 4, 2023
1 parent 7ba8eb1 commit 6123978
Show file tree
Hide file tree
Showing 9 changed files with 34 additions and 1 deletion.
2 changes: 2 additions & 0 deletions ble/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,7 @@ Communication with an external module uses the binary EDM protocol. The app can

It is not in the scope of this API to support the full range short range module (AT) API. However, using the BLE `cfg` API as a prototype it is easy to add additional commands to your application. Make sure your code locks the short range mutex.

The operation of `ubxlib` does not rely on a particular version of uConnectExpress; the versions that we test with are listed in the short-range [test](/common/short_range/test) directory.

# Usage
The [api](api) directory contains the files that define the BLE APIs, each API function documented in its header file. In the [src](src) directory you will find the implementation of the APIs and in the [test](test) directory the tests for the APIs that can be run on any platform.
2 changes: 2 additions & 0 deletions cell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ HOWEVER, this is the detailed API; if all you would like to do is bring up a bea

This API relies upon the [common/at_client](/common/at_client) component to send commands to and parse responses received from a cellular module.

The operation of `ubxlib` does not rely on a particular FW version of the cellular module; the module FW versions that we test with are listed in the [test](test) directory.

# Usage
The [api](api) directory contains the files that define the cellular APIs, each API function documented in its header file. In the [src](src) directory you will find the implementation of the APIs and in the [test](test) directory the tests for the APIs that can be run on any platform.

Expand Down
12 changes: 12 additions & 0 deletions cell/test/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Module FW Versions
The module FW versions that these tests are run on are as follows:

- SARA-U201: none - no automated testing is performed on SARA-U201.
- SARA-R410M-02B: M0.11.01,A.02.17.
- SARA-R410M-03B: none - no automated testing is performed on SARA-R410M-03B.
- SARA-R412M-02B: M0.11.01,A.02.17.
- SARA-R412M-03B: none - no automated testing is performed on SARA-R412M-03B.
- SARA-R5: 02.05,A00.01 and 03.15,A00.01.
- SARA-R422: 00.12,A00.00.
- LARA-R6: 00.13,A00.01.
- LENA-R8: 02.00,A01.40.
2 changes: 2 additions & 0 deletions common/short_range/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,7 @@ This directory contains the short-range APIs, covering both Wi-Fi and BLE contro

This API relies upon the [common/at_client](/common/at_client) component to send commands to and parse responses received from an external Wi-Fi/BLE module.

The operation of `ubxlib` does not rely on a particular version of uConnectExpress; the versions that we test with are listed in the [test](test) directory.

# Usage
The [api](api) directory contains the files that define the short range APIs, each API function documented in its header file. In the [src](src) directory you will find the implementation of the APIs and in the [test](test) directory the tests for the APIs that can be run on any platform.
4 changes: 4 additions & 0 deletions common/short_range/test/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# uConnectExpress Versions
The uConnectExpress versions that these tests are run on are as follows:

- NINA-W15: 5.2.2.
2 changes: 2 additions & 0 deletions gnss/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ The module types supported by this implementation are listed in [u_gnss_module_t

This API relies upon the [common/ubx_protocol](/common/ubx_protocol) component to encode commands for and decode responses from a u-blox GNSS module and the [common/at_client](/common/at_client) component when an intermediate AT (e.g. cellular) module is employed between this MCU and the GNSS module.

The operation of `ubxlib` does not rely on a particular FW version of the GNSS chip; the FW versions that we test with are listed in the [test](test) directory.

# Sub-module [geographiclib](https://github.com/geographiclib)
If you do not provide your own geodesic functions and intend to use fences with shapes greated than 1 km in size, where the non-spherical nature of the earth has an impact, [GeographicLib](https://github.com/geographiclib) should be used. To obtain this as a sub-module, make sure that you have done:

Expand Down
6 changes: 6 additions & 0 deletions gnss/test/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# FW Versions
The FW versions that these tests are run on are as follows:

- M8: SPG 3.01 (protocol version 18.0).
- M9: SPG 4.04 (protocol version 32.01), HPS 1.30 (protocol version 33.30), PMP 1.04 (protocol version 24.0) and HPG 1.32 (protocol version 27.31).
- M10: SPG 5.10 (protocol version 34.10).
3 changes: 2 additions & 1 deletion port/platform/common/automation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,4 +250,5 @@ If the commit text does *not* contain a line starting with `test:` (the usual ca
- If you add a new board to the test system, update [u_connection.py](./scripts/u_connection.py) to include it.
- If you add a new platform or test suite, add it to [DATABASE.md](DATABASE.md) and make sure that the result is parsed correctly by [u_data.py](./scripts/u_data.py) (e.g. by running `automation.<command>` PyInvoke tasks) from the command-line and checking that everything is correct).
- If you add a new item in the range 0 to 9 (i.e. a checker with no platform), update [automation.py](./tasks/automation.py) to include it.
- If you add a new directory OFF THE ROOT of `ubxlib`, i.e. something like `ubxlib/blah`, add it to the `ASTYLE_DIRS` variable of the [u_run_astyle.py](./scripts/u_run_astyle.py) script.
- If you add a new directory OFF THE ROOT of `ubxlib`, i.e. something like `ubxlib/blah`, add it to the `ASTYLE_DIRS` variable of the [u_run_astyle.py](./scripts/u_run_astyle.py) script.
- When the FW version of a cellular module, or GNSS chip, or uConnectExpress version in the test system is updated, update the `README.md` in the corresponding test directory with that version.
2 changes: 2 additions & 0 deletions wifi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ location client API.

The module types supported by this implementation are listed in [u_wifi_module_type.h](api/u_wifi_module_type.h).

The operation of `ubxlib` does not rely on a particular version of uConnectExpress; the versions that we test with are listed in the short-range [test](/common/short_range/test) directory.

# WiFi captive portal

Included in this directory is also functionality for starting a captive portal for wifi credentials provisioning at runtime instead of adding these in the source code at build time.
Expand Down

0 comments on commit 6123978

Please sign in to comment.