NordicSemiconductor / bluetooth-numbers-database

An up-to-date listing of all the various Bluetooth Specification-related elements that are defined by our industry (Company IDs, Service UUIDs, Characteristic UUIDs and Descriptor UUIDs), that you can use instead of rolling your own.
Other
345 stars 53 forks source link

Updated README to reflect addition of GATT Appearance(s) #108

Closed dinesharjani closed 10 months ago

dinesharjani commented 10 months ago

We added the .json to /v1 but we did not announce it or show it in the README, which is what we guess most people will see or have a chance to discover through.

eriklins commented 10 months ago

Totally didn't have the README in mind when opening the PR with just the JSON. Thanks for looking into this. The appearance values are mainly referred to as "GAP Appearance" not "GATT Appearance". However, as indicated the new README section appearance refers to both the GAP advert data type as well as the appearance characteristic within the GAP service of the GATT table. Might be better to change the wording from "GAP Appearance" to "GAP/GATT Appearance". But don't want to be picky, fine for me. And thanks again.

dinesharjani commented 10 months ago

That's a good one, I should update it. Also, need to add the schema and add that to the GitHub Action(s).

Also, the values, they don't need to be in hex. They can be human-readable so we can avoid the extra-processing on the side of the API consumer.

eriklins commented 10 months ago

They don't necessarily have to be hex, but they are hex in the original BT SiG document and the original BT SiG YAML file as well as all UUIDs in the other JSON files are hex. So I went for hex for the appearance JSON. Hex might also be slightly more convenient when it comes to composing a 16 bit value from the category and sub-category values by bit-shifting. Common tools like nRF Connect app show the appearance as hex as well.