• Replies 5 replies
  • Subscribers 20 subscribers
  • Views 338 views
  • Users 0 members are here
Options
Related

"App Types" Overview inconsistent with API docs

9775633
2 months ago

https://developer.garmin.com/connect-iq/connect-iq-basics/app-types/

One example:
the app type overview shows that "Toybox.BluetoothLowEnergy" is available in "Watch Face" but not in "Data Field".
The API doc however states the exact opposite: https://developer.garmin.com/connect-iq/api-docs/Toybox/BluetoothLowEnergy.html

  • 2 months ago in reply to eau_de_vie

    The overview is incorrect/misleading for some things.  I don't remember the last time I even looked at it, to be honest.  The API guide is really the best reference.  One thing that's not really even mentioned in the overview is background Services.  For example, BluetoothLowEnergey can be used in a watch face, but only in a background service.  

    With Communications, that's something else that has been available in the background service for a data field for a long time, and the note about 5.0.0 might be a bit confusing.

    I can see where it could also be a bit confusing based on specific devices.  While Edge devices have the minimum API level for ActivityMonitor, Edge devices don't support ActivityMononitor at all.  In the API doc, for many things you can look at "Supported devices" to get that kind of detail.

    The overview should be corrected.  Do a bug report with everything you found 

  • 2 months ago

    I think you need to use local SDK docs. They are desinchronized with website docs. I didn't even know local SDK docs existed, because how bad UX of all of this is.

  • 2 months ago in reply to Dr House

    In this case, the over view doc is the same,  What you see on the web is the doc for the latest SDK.  What you see in Command Palette>View Documentation is that doc for the SDK you have set in the SDK Manager as your "Current SDK"

    There you'll also see a very interesting doc called README, which included the release notes for every version of the SDK up to and including including what you have set as your "Current SDK"

  • 2 months ago in reply to jim_m_58
    Dr House said:
    I think you need to use local SDK docs. They are desinchronized with website docs. I didn't even know local SDK docs existed, because how bad UX of all of this is.
    jim_m_58 said:
    There you'll also see a very interesting doc called README, which included the release notes for every version of the SDK up to and including including what you have set as your "Current SDK"