diff --git a/README.md b/README.md index 98d9c81..cf2d53b 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,25 @@ We have based the data structure above on the official listing of GATT Specifica This structure is a mirror of the official Bluetooth Specification. It is added as a convenience so that each application does not need to download and transfrom the online listings at the Bluetooth official website. Note that registration of new Company Identifiers must go through official channels at Bluetooth SIG. The full JSON Schema for the Company ID Data Structure can be found [here](https://github.com/NordicSemiconductor/bluetooth-numbers-database/blob/master/v1/company_schema.json). +### GATT Appearance(s) + +This is a new addition prompted by user [eriklins](https://github.com/eriklins), as a solution to his own issue ticket in this project. The result of which was [this initial Pull Request](https://github.com/NordicSemiconductor/bluetooth-numbers-database/pull/107). As of now it's not perfect, but it is a good starting point. These are intended to mirror the Bluetooth SIG Assigned Numbers Document as defined and updated [here](https://www.bluetooth.com/wp-content/uploads/Files/Specification/Assigned_Numbers.pdf). + +#### Category + +| Field | Type | Description | Required | +| ------|------|----------| --- | +| category | `Int` | Decimal value identifying the category corresponding to reversed bits 15 to 6 | **Yes** | +| name | `String` | Name of the Category | **Yes** | +| subcategory | `[Sub-category]` | Optional Array of Sub-categories within an Appearance Category | **No** | + +#### Sub-category + +| Field | Type | Description | Required | +| ------|------|----------| --- | +| value | `Int` | Decimal value identifying the sub-category within a parent category corresponding to reversed remaining bits 5 to 0 | **Yes** | +| name | `String` | sss | **Yes** | + ## Rules and Contributions * The purpose of this project is to be an online shared directory of Bluetooth numbers, so all listings (Company IDs, Services, etc.) **can and are meant to** be extended by the community, as long as they're Bluetooth SIG-Compliant. (More on this below.)