Skip to main content

gnss-session.assist.load(statusCallback, assistData)

Initialize the BG96’s gpsOneXTRA assistance data feature

Availability

Device (from impOS™ 43)
Only available on imps with cellular modems

Parameters

Name Type Description
statusCallback Function A handler to receive status information
assistData Blob The assistance data

Returns

Nothing

Description

This method is used to ready the BG96 modem’s gpsOneXTRA assistance function, which simplifies the application of GNSS assistance data, for use in future GNSS readings. You will need to call assist.enable() to begin making use of loaded assist data.

When called, this method enables the gpsOneXTRA facility, uploads the supplied assistance data to the modem’s file system, causes the data to be copied into the modem’s GNSS sub-system, and then deletes the uploaded file from the modem’s file system.

The data should be provided as a binary blob and passed into assistData.

The function supplied as the method’s status callback receives a table which will contain the keys status and restart.

The value of status will be zero if no error occurred, or an error code (see gnss-session for details). If the value is not zero, then the table will also include the key message. Its value is the AT command which caused the error.

The value of restart is an integer which will be zero unless impOS has to power-cycle the modem in order to enable GNSS.

Note The supplied status callback can only be cancelled by deleting the parent gnss-session object.