Skip to content

Commit 850e263

Browse files
committed
docs: add info about sidewalk location
Added information about the integration of Sidewalk Location services Signed-off-by: Krzysztof Taborowski <[email protected]>
1 parent 6afd0eb commit 850e263

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed

doc/releases_and_migration/release_notes_addon_v110.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ This release introduces the latest Amazon Sidewalk SDK v1.19 libraries.
2222
* **DTS (Device Tree) changes** to accommodate LR1110 radio configuration.
2323
* **New radio architecture** with Zephyr shields for SubGHz radio configuration.
2424
* **Migration guide** for new radio architecture and shield system.
25+
* **Sidewalk Location** services integration.
2526

2627
* Updated:
2728

doc/samples/sid_end_device.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,15 @@ The following configuration arguments are available during the build process for
172172

173173
* To enable support for the downlink file transfer over Bluetooth LE, use the ``-DCONFIG_SIDEWALK_FILE_TRANSFER=y`` build flag.
174174

175+
Sidewalk Location services support
176+
===================================
177+
178+
The Sidewalk Location services support is enabled by default in Sidewalk libraries.
179+
To test the location services, you can use the Sidewalk Location CLI from DUT variant with ``CONFIG_SIDEWALK_LOCATION_SHELL=y``.
180+
The location services are available over Bluetooth LE, WiFi and GNSS (lr1110 radio is necessary for GNSS support). BLE only library supports only Bluetooth LE link mode.
181+
.. TBD: Add link to the Location Services API documentation.
182+
For more details, see the `Amazon Sidewalk Location Services API documentation`_.
183+
175184
Selecting a sample variant
176185
**************************
177186

doc/samples/variants/dut.rst

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,54 @@ Testing
2929
3030
#. To start testing the application, use the Sidewalk CLI (DUT).
3131
Type ``sid help`` and press enter to get the list of supported commands.
32+
33+
34+
Testing Location Services
35+
==========================
36+
37+
#. Initialize and start a Sidewalk stack (e.g. for BLE+FSK+LoRa support)
38+
39+
.. code-block:: console
40+
41+
sid init 7
42+
sid start
43+
44+
#. Initialize Location services
45+
46+
.. code-block:: console
47+
48+
location init
49+
50+
You should see log message with success status.
51+
52+
#. Send location. You can use the following levels:
53+
1 - BLE Uplink using Sidewalk Network location
54+
2 - (not supported)
55+
3 - WiFi (LR1110 radio is necessary for WiFi support)
56+
4 - GNSS (LR1110 radio is necessary for GNSS support)
57+
58+
For WiFi and GNSS, you can test only scanning location with ``location scan`` command.
59+
60+
.. code-block:: console
61+
62+
location send 1
63+
64+
Check MQTT topic used as Location Destination in AWS MQTT Console. You should see the location data in the following format:
65+
66+
.. code-block:: json
67+
68+
{
69+
"coordinates": [
70+
XX.XXXXXX,
71+
YY.YYYYYY,
72+
0
73+
],
74+
"WirelessDeviceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
75+
"type": "Point",
76+
"properties": {
77+
"verticalAccuracy": 0,
78+
"horizontalAccuracy": ZZ,
79+
"timestamp": "YYYY-MM-DDTHH:MM:SS.ZZZ"
80+
}
81+
}
82+

0 commit comments

Comments
 (0)