Skip to content

Commit c4e99dd

Browse files
committed
Add Assist Data section
1 parent 38aa434 commit c4e99dd

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

Diff for: README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,17 @@ This method turns on GNSS with the specified options. This method will run async
6868

6969
The BG96 modem must be powered on to enable GNSS.
7070

71+
#### Assist Data ####
72+
73+
If you wish to load GNSS assist data — which we strongly recommend — pass this to the library as the value of the *options* key *assistData*. Provide the binary data as a blob. The BG96 uses Quectel’s gpsOneXTRA assist data format. The latest file is available from Quectel at either of the following URLs:
74+
75+
* [https://xtrapath4.izatcloud.net/xtra2.bin](https://xtrapath4.izatcloud.net/xtra2.bin)
76+
* [https://xtrapath4.izatcloud.net/xtra3grc.bin](https://xtrapath4.izatcloud.net/xtra3grc.bin)
77+
78+
The `xtra2.bin` data supports GPS and Glonass; the `xtra3grc.bin` data supports GPS, Glonass and BeiDou. Choose the data package that best meets your needs. Both are well under 50KB, so can be easily acquired by your agent and passed to the device for use in your *enableGNSS()* call. See [the Dev Center for sample code](https://developer.electricimp.com/reference/gnss-on-imp006#load-gnss-location-assist-data).
79+
80+
You can check the validity of assist data you have already loaded using [*isAssistDataValid()*](#isassistdatavalid).
81+
7182
#### Parameters ####
7283

7384
| Parameter | Type | Required? | Description |
@@ -87,8 +98,8 @@ The BG96 modem must be powered on to enable GNSS.
8798
| *locMode* | Integer | Latitude and longitude display formats. See [**Location Mode Values**](#location-mode-values), below, for more details. Default: 2 |
8899
| *onEvent* | Function | Callback to be triggered when GNSS has been enabled or some other event occurs. This function has one parameter, a table, that may contain the keys *error* or *event*. Default: no callback |
89100
| *onLocation* | Function | Callback to be triggered when GNSS location data is ready. This function has one parameter: a table that may contain the keys *error* or *fix*. Default: no callback |
90-
| *useAssist* | Boolean | Enable assist without loading new assist data. New in library version 0.1.0. Default: `false` |
91-
| *assistData* | Blob | GPS fix assist data. New in library version 0.1.0. Default: no data |
101+
| *useAssist* | Boolean | Enable assist without loading new assist data. Default: `false` |
102+
| *assistData* | Blob | GPS fix assist data. Default: no data |
92103

93104
#### Location Mode Values ####
94105

0 commit comments

Comments
 (0)