Position.enableLocations documentation has a bug in code example (causes device to crash)

(See: https://forums.garmin.com/developer/connect-iq/f/discussion/319709/enable-location-bug-after-24-10-update)

The documentation at the following URL has a bug which causes a crash:

[https://developer.garmin.com/connect-iq/api-docs/Toybox/Position.html#enableLocationEvents-instance_function]

Original code:

if (Position has :CONFIGURATION_GPS_GLONASS_GALILEO_BEIDOU_L1_L5) {
    options[:configuration] = :CONFIGURATION_GPS_GLONASS_GALILEO_BEIDOU_L1_L5;

Correct code:

if (Position has :CONFIGURATION_GPS_GLONASS_GALILEO_BEIDOU_L1_L5) {
    options[:configuration] = Position.CONFIGURATION_GPS_GLONASS_GALILEO_BEIDOU_L1_L5;

FlowState

Parents

FlowState over 1 year ago

Thanks for the reply and the explanation!

This post indicates a device crash, but I believe the original code would have given an UnexpectedTypeException (expected Number, got Symbol). If you applied the first fix to just update the reference to get the Number, you'd have got an InvalidValueException on some devices because the requested configuration is not supported. Correct?

Correct. I did post a more comprehensive fix in a subsequent comment:

https://forums.garmin.com/developer/connect-iq/i/bug-reports/position-enablelocations-documentation-has-a-bug-in-code-example-causes-device-to-crash?CommentId=8fafd15a-8946-4f75-9b51-039a8e157b8a

(Sorry for the disjointed nature of the comments)

Anyway, I was just reporting this on behalf of the person who posted this thread:

forums.garmin.com/.../enable-location-bug-after-24-10-update
- Cancel
- Up 0 Down
- More
- Cancel

Comment

FlowState over 1 year ago

Thanks for the reply and the explanation!

This post indicates a device crash, but I believe the original code would have given an UnexpectedTypeException (expected Number, got Symbol). If you applied the first fix to just update the reference to get the Number, you'd have got an InvalidValueException on some devices because the requested configuration is not supported. Correct?

Correct. I did post a more comprehensive fix in a subsequent comment:

https://forums.garmin.com/developer/connect-iq/i/bug-reports/position-enablelocations-documentation-has-a-bug-in-code-example-causes-device-to-crash?CommentId=8fafd15a-8946-4f75-9b51-039a8e157b8a

(Sorry for the disjointed nature of the comments)

Anyway, I was just reporting this on behalf of the person who posted this thread:

forums.garmin.com/.../enable-location-bug-after-24-10-update
- Cancel
- Up 0 Down
- More
- Cancel

Children

No Data