Ticket Created
over 4 years ago

WERETECH-9123

Connect-IQ Ble advertising layer parsing bug, prevent many devices to function properly. (paired or not paired) Toybox::BluetoothLowEnergy::ScanResult:getRawData(), getServiceData , getServiceUuids are broken

Connect-IQ Ble advertising layer parsing bug, prevent many devices to function properly.
Reproduced on simulator, fenix 6x (9.0), fenix 6s.

Used bluetooth sniffer to confirm that the advertising bytes were correct, and different than what connect IQ returns.

When not paired :

Toybox::BluetoothLowEnergy::ScanResult:getRawData(), getServiceData , getServiceUuids
 are not receiving the proper data bytes from the network layer when **to be confirmed !!**the last advertising data type are :
 Complete List of 16-bit Service Class UUIDs

which is very common !
if the order is changed, and something else is set at the end, there is no problem at all.

In order to demonstrate this, I'm parsing the content of getRaw, using 2 stryd devices (ble indeed), one hardware v4 (last advertising data, is Shortened local name), which is working perfectly.

The parser, read all data, and decode them, now problem on this trace, it is complete, and perfectly good and valid.

devicename:Stryd kl
raw Adverting Data:[2, 1, 6, 7, 3, 24, 24, 20, 24, 10, 24, 9, 255, 170, 170, 210, 91, 0, 81, 82, 41, 9, 8, 83, 116, 114, 121, 100, 32, 107, 108]
--[AD Dump:
----[Record Dump:
    AD Len:2
    AD Type:Flags
    AD Type Integer:1
    AD Data Integer:[6]
    AD Data Hex:06
----[Record Dump:
    AD Len:7
    AD Type:Complete List of 16-bit Service Class UUIDs
    AD Type Integer:3
    AD Data Integer:[24, 24, 20, 24, 10, 24]
    AD Data Hex:181814180a18
    AD Data 16bits Service Class UUIDs:
        UUID: 0x1818
        UUID: 0x1418
        UUID: 0x0A18
----[Record Dump:
    AD Len:9
    AD Type:Manufacturer Specific Data
    AD Type Integer:255
    AD Data Integer:[170, 170, 210, 91, 0, 81, 82, 41]
    AD Data Hex:aaaad25b00515229
    AD Data String:ªªÒ[QR)
----[Record Dump:
    AD Len:9
    AD Type:Shortened Local Name
    AD Type Integer:8
    AD Data Integer:[83, 116, 114, 121, 100, 32, 107, 108]
    AD Data Hex:5374727964206b6c
    AD Data String:Stryd kl
--end of AD Dump]


Now, another generation of stryd (v3), where by lack of lack, advertising data last bytes are ...Complete List of 16-bit Service Class UUIDs

In this case, you can see that the raw data, is not correct, and stop before those advertising data.

If it was only the raw data, it won't be a problem, but getServiceUuids looks to use those bytes... so return none of those services.

devicename:Stryd
raw Adverting Data:[2, 1, 6, 9, 255, 170, 170, 115, 84, 0, 80, 82, 166, 6, 9, 83, 116, 114, 121, 100]
--[AD Dump:
----[Record Dump:
    AD Len:2
    AD Type:Flags
    AD Type Integer:1
    AD Data Integer:[6]
    AD Data Hex:06
----[Record Dump:
    AD Len:9
    AD Type:Manufacturer Specific Data
    AD Type Integer:255
    AD Data Integer:[170, 170, 115, 84, 0, 80, 82, 166]
    AD Data Hex:aaaa7354005052a6
    AD Data String:ªªsTPR¦
----[Record Dump:
    AD Len:6
    AD Type:Complete Local Name
    AD Type Integer:9
    AD Data Integer:[83, 116, 114, 121, 100]
    AD Data Hex:5374727964
    AD Data String:Stryd
--end of AD Dump]


When paired :

Class: Toybox::BluetoothLowEnergy::Device getService() and getServices()

are also affected !

This was confirmed with :
- nrf connect on android
- nrf connect desktop, with the nrf52 dongle I'm using for the simulator (confirmed into the simulator indeed)

Now, if it was only stryd, it would be okay, but my elliptical bike(FTMS profile), also adverstise services at the end... so they are not visible to the watch.

It is the same for many devices I checked, all that was availlable to me.

Is reporting to this forum enough to get it tracked by garmin ? anything else to do ?

Kind Regards.

Klick

Klick
  • over 4 years ago in reply to jim_m_58

    I actually register the profile in initialize() - the message printed is from the callback not the actual registration. It only happens once, when my BluetoothDelegate is created. 

    The service UUIDs are fetched directly from the ScanResult. In onScanResults I get the result, get some of the advertising data (mostly not necessary) and get the service UUIDs. Then I look at the services for what I want. If I find something that I'm interested in, I attempt to pair the device. Otherwise, I move on to the next available ScanResult and repeat.

    When I attempt to pair with the device (onConnectionStateChanged) that's when I fetch references to the services that I am going to be using.

  • over 4 years ago in reply to nilsbenson

    If I understand your log, you do things in a different order than I or the nordic sample does - register the ble profile before starting to scan.  If you do it on each connect, I think you'll run into issues.

    Also, there is a bug that you want to do getServiceUUIDS right after you get the scan result, as you could get an error if that's done later.

  • over 4 years ago in reply to Klick

    I totally agree it's a big problem. I just happened to "get lucky" and can access the service I need.

  • over 4 years ago

    I ran it again with Jim's advice to try and query the device name after a successful connection.

    Results -

    onConnectedStateChanged using the device parameter passed in - NULL

    onConnectedStateChanged using the service.getDevice().getName() - NULL

    onConnectedStateChanged using characteristic.getService().getDevice().getName() - NULL

    onCharacteristicWrite using char.getService().getDevice().getName() - "iBBQ" (SUCCESS)

    So I am able to access the device name after I have connected and successfully sent the auto-pairing key to it but never before I do that.

  • over 4 years ago in reply to nilsbenson

    Hi Nilsbenson,

    mixed answer, at least from what I tested :

    - if the uuid of the data you need, is visible from getRaw(), you'll be good. you can get the name and deal with the uuid returned.

    - if the uuid is NOT visible from getRaw(), you can't access them. It can be getName, that will return null or some uuid that will never be useable, in the profile or not.

    so it really depends on what the device advertise at the end !

    that's why I consider this bug to be critical, many devices can't be used at all, period.