Ticket Created
over 2 years ago

WERETECH-12673

Improve documentation: Add api levels and system levels to Device Reference

Please add information about the possible system level and api level each device can have to:

https://developer.garmin.com/connect-iq/reference-guides/devices-reference/

For example:

Fenix 6:

min system: 4

max system: 5

min api: 3.2.0

max api: 3.3.*

(maybe the max values should only be set when Garmin has decided that a certain device will not get further updates)

The use case is that it can help developers to decide which devices they support. When they decided it can help optimizing code by excluding code that is "too new" for a device. For example there's no need for the following code on system 1 devices with max api level < 2.4.0, because they can never have Properties:

function setConfig(key as Application.PropertyKeyType, val as Application.PropertyValueType) {
    if (App has :Properties) {
        App.Properties.setValue(key, val);
    } else {
        App.AppBase.setProperty(key, val);
    }
}

By knowing this we can save some precious bytes in the memory if we use:

(:system2)
function setConfig(key as Application.PropertyKeyType, val as Application.PropertyValueType) {
    App.AppBase.setProperty(key, val);
}
(:system3)
function setConfig(key as Application.PropertyKeyType, val as Application.PropertyValueType) {
    if (App has :Properties) {
        App.Properties.setValue(key, val);
    } else {
        App.AppBase.setProperty(key, val);
    }
}

Parents
  • Here's an example to demonstrate the limitations of the knowledge we currently can get. In this tool (https://forums.garmin.com/developer/connect-iq/f/showcase/298405/garmin-dev-tools) the scripts extract the data from compiler.json in the Devices folder. For example partNumbers[].connectIQVersion The problem with this is that today I updated many devices in the SDK Manager, and Montana 7xx was changed from 3.1.6 to 3.2.1 so when I generated the csv files now it "looks" as montana7xx devices only have CIQ 3.2.1 while in reality at least some of them are probably still using 3.1.6.

    I guess the only way to get the real minConnectIQVersion would be if Garmin provided it somehow...

    Garmin, can you maybe add a new field in compiler.json? For example in each partNumber add minimumConnectIQVersion next to connectIQVersion.

Comment
  • Here's an example to demonstrate the limitations of the knowledge we currently can get. In this tool (https://forums.garmin.com/developer/connect-iq/f/showcase/298405/garmin-dev-tools) the scripts extract the data from compiler.json in the Devices folder. For example partNumbers[].connectIQVersion The problem with this is that today I updated many devices in the SDK Manager, and Montana 7xx was changed from 3.1.6 to 3.2.1 so when I generated the csv files now it "looks" as montana7xx devices only have CIQ 3.2.1 while in reality at least some of them are probably still using 3.1.6.

    I guess the only way to get the real minConnectIQVersion would be if Garmin provided it somehow...

    Garmin, can you maybe add a new field in compiler.json? For example in each partNumber add minimumConnectIQVersion next to connectIQVersion.

Children
No Data