Skip to content

Commit

Permalink
Documentation change only: uLocationGetContinuousStart() advice.
Browse files Browse the repository at this point in the history
Add advice to the description of uLocationGetContinuousStart() suggesting that uLocationGet() might be a better function to use when just getting things working as it will print out more debug.
  • Loading branch information
RobMeades committed Nov 4, 2023
1 parent 0b98b73 commit 7ba8eb1
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions common/location/api/u_location.h
Original file line number Diff line number Diff line change
Expand Up @@ -499,6 +499,14 @@ int32_t uLocationGetStart(uDeviceHandle_t devHandle, uLocationType_t type,
* the cellular device handle (as once it is "claimed" by Cell Locate it
* won't be available for GNSS calls until the module is power cycled).
*
* Note: if you are just getting a GNSS device working you probably want
* to use uLocationGet() instead of this function: since this function is
* expected to be called continuously it won't print out a lot of debug,
* while, for a GNSS-type location, uLocationGet() _will_ print out the
* whole UBX-NAV-PVT message contents (which you can look up in the
* interface manual for your GNSS chip) while it is waiting for a
* position fix.
*
* Note: where the GNSS chip is inside or connected via a SARA-R5 module,
* there is a known issue where, if a GNSS multiplexer channel (required for
* streamed position) is opened, closed, and then re-opened the GNSS chip will
Expand Down

0 comments on commit 7ba8eb1

Please sign in to comment.