Human Interface Device（GATT）

Name: Human Interface Device

Type: org.bluetooth.service.human_interface_device 

Assigned Number: 0x1812

Abstract:

This service exposes the HID reports and other HID data intended for HID Hosts and HID Devices.

Summary:

The HID Service exposes characteristics required for a HID Device to transfer HID report descriptors and reports to a HID Host. This also exposes the characteristics for a HID Host to write to a Device. The Human Interface Device Service is instantiated as a Primary Service.

Service Dependencies

This service has no dependencies on other GATT-based services.

GATT Requirements

Sub-ProcedureServer RequirementRead Long Characteristic ValueMandatoryWrite Without ResponseMandatoryWrite Characteristic ValueMandatoryNotificationsMandatoryRead Characteristic DescriptorsMandatoryWrite Characteristic DescriptorsMandatory

Transport Dependencies

TransportSupportedClassicfalseLow EnergytrueHigh Speed 

Error Codes

This service does not define any application error codes that are used in Attribute Protocol.

Service Characteristics

OverviewPropertiesSecurityDescriptorsName:Protocol ModeDescription:The Protocol Mode characteristic is used to expose the current protocol mode of the HID Service with which it is associated, or to set the desired protocol mode of the HID Service

Only a single instance of this characteristic shall exist as part of the HID Service.

C4: Mandatory for HID Devices supporting Boot Protocol Mode, otherwise optional.

Type:org.bluetooth.characteristic.protocol_modeRequirement:C4PropertyRequirementReadMandatoryWriteExcludedWriteWithoutResponseMandatorySignedWriteExcludedNotifyExcludedIndicateExcludedWritableAuxiliariesExcludedBroadcastExcludedExtendedProperties NoneNoneName:ReportDescription:

The Report characteristic is used to exchange data between a HID Device and a HID Host.

Note: Mandatory to support at least one Report Type (Input Report, Output Report, or Feature Report) if the Report characteristic is supported.

Type:org.bluetooth.characteristic.reportRequirement:OptionalConditional Description:For Input Reports:PropertyRequirementReadMandatoryWriteOptionalWriteWithoutResponseExcludedSignedWriteExcludedNotifyMandatoryIndicateExcludedWritableAuxiliariesExcludedBroadcastExcludedExtendedProperties Conditional Description:For Output Reports:PropertyRequirementReadMandatoryWriteMandatoryWriteWithoutResponseMandatorySignedWriteExcludedNotifyExcludedIndicateExcludedWritableAuxiliariesExcludedBroadcastExcludedExtendedProperties Conditional Description:For Feature Reports:PropertyRequirementReadMandatoryWriteMandatoryWriteWithoutResponseExcludedSignedWriteExcludedNotifyExcludedIndicateExcludedWritableAuxiliariesExcludedBroadcastExcludedExtendedProperties NoneOverviewPermissionsName:Client Characteristic ConfigurationType:org.bluetooth.descriptor.gatt.client_characteristic_configurationRequirement:if_notify_or_indicate_supportedPermissionRequirementReadMandatoryWriteMandatoryName:Report ReferenceType:org.bluetooth.descriptor.report_referenceDescription:The Report Reference characteristic descriptor is used to provide the Report ID and Report Type for the Report characteristic value.Requirement:if_characteristic_supportedPermissionRequirementReadMandatoryWriteExcludedName:Report MapDescription:The Report Map characteristic value contains formatting and other information for Input Report, Output Report and Feature Report data transferred between a HID Device and HID Host.Type:org.bluetooth.characteristic.report_mapRequirement:MandatoryPropertyRequirementReadMandatoryWriteExcludedWriteWithoutResponseExcludedSignedWriteExcludedNotifyExcludedIndicateExcludedWritableAuxiliariesExcludedBroadcastExcludedExtendedProperties NoneOverviewPermissionsName:External Report ReferenceType:org.bluetooth.descriptor.external_report_referenceRequirement:OptionalPermissionRequirementReadMandatoryWriteExcludedName:Boot Keyboard Input ReportDescription:

The Boot Report Reference characteristic is used to provide HID Hosts operating in Boot Protocol Mode with a simplified method of discovering certain HID Service characteristics. Only a single instance of this characteristic exists as part of the HID Service.

C2: Mandatory for HID Devices operating as keyboards, else excluded.

Type:org.bluetooth.characteristic.boot_keyboard_input_reportRequirement:C2PropertyRequirementReadMandatoryWriteOptionalWriteWithoutResponseExcludedSignedWriteExcludedNotifyMandatoryIndicateExcludedWritableAuxiliariesExcludedBroadcastExcludedExtendedProperties NoneOverviewPermissionsName:Client Characteristic ConfigurationType:org.bluetooth.descriptor.gatt.client_characteristic_configurationRequirement:MandatoryPermissionRequirementReadMandatoryWriteMandatoryName:Boot Keyboard Output ReportDescription:

The Boot Report Reference characteristic is used to provide HID Hosts operating in Boot Protocol Mode with a simplified method of discovering certain HID Service characteristics. Only a single instance of this characteristic exists as part of the HID Service.

C2: Mandatory for HID Devices operating as keyboards, else excluded.

Type:org.bluetooth.characteristic.boot_keyboard_output_reportRequirement:C2PropertyRequirementReadMandatoryWriteMandatoryWriteWithoutResponseMandatorySignedWriteExcludedNotifyExcludedIndicateExcludedWritableAuxiliariesExcludedBroadcastExcludedExtendedProperties NoneNoneName:Boot Mouse Input ReportDescription:

The Boot Report Reference characteristic is used to provide HID Hosts operating in Boot Protocol Mode with a simplified method of discovering certain HID Service characteristics. Only a single instance of this characteristic exists as part of the HID Service.

C3:Mandatory for HID Devices operating as mice, else excluded.

Type:org.bluetooth.characteristic.boot_mouse_input_reportRequirement:C3PropertyRequirementReadMandatoryWriteOptionalWriteWithoutResponseExcludedSignedWriteExcludedNotifyMandatoryIndicateExcludedWritableAuxiliariesExcludedBroadcastExcludedExtendedProperties NoneOverviewPermissionsName:Client Characteristic ConfigurationType:org.bluetooth.descriptor.gatt.client_characteristic_configurationRequirement:MandatoryPermissionRequirementReadMandatoryWriteMandatoryName:HID InformationDescription:The HID Information characteristic is used to hold a set of values known as the HID Device’s HID AttributesType:org.bluetooth.characteristic.hid_informationRequirement:MandatoryPropertyRequirementReadMandatoryWriteExcludedWriteWithoutResponseExcludedSignedWriteExcludedNotifyExcludedIndicateExcludedWritableAuxiliariesExcludedBroadcastExcludedExtendedProperties NoneNoneName:HID Control PointDescription:The HID Control Point characteristic is a control-point attribute that defines the following HID Commands when written:

• Suspend ( Refer to Section 7.4.2, Bluetooth HID Profile Specification 1.0)

• Exit Suspend (Refer to Section 7.4.2, Bluetooth HID Profile Specification 1.0)

There are no response codes defined for the Suspend and Exit Suspend commands.Type:org.bluetooth.characteristic.hid_control_pointRequirement:MandatoryPropertyRequirementReadExcludedWriteExcludedWriteWithoutResponseMandatorySignedWriteExcludedNotifyExcludedIndicateExcludedWritableAuxiliariesExcludedBroadcastExcludedExtendedProperties NoneNone

Name: Protocol Mode

Type: org.bluetooth.characteristic.protocol_mode 

Assigned Number: 0x2A4E

Summary:

The Protocol Mode characteristic is used to expose the current protocol mode of the HID Service with which it is associated, or to set the desired protocol mode of the HID Service.

Value Fields

NamesField RequirementFormatMinimum ValueMaximum ValueAdditional InformationProtocol Mode ValueMandatory
uint8N/AN/AEnumerationsKeyValue0Boot Protocol Mode1Report Protocol Mode2 - 255Reserved for future use

Name: Report

Type: org.bluetooth.characteristic.report 

Assigned Number: 0x2A4D

Abstract:

The Report characteristic is used to exchange data between a HID Device and a HID Host.

Summary:

The Report characteristic value contains Input Report, Output Report or Feature Report data to be transferred between the HID Device and HID Host.

Value Fields

NamesField RequirementFormatMinimum ValueMaximum ValueAdditional InformationReport ValueMandatory
uint8N/AN/AThis field may be repeated.

Name: Report Map

Type: org.bluetooth.characteristic.report_map 

Assigned Number: 0x2A4B

Summary:

The Report Map characteristic is used to define formatting information for Input Report, Output Report, and Feature Report data transferred between a HID Device and HID Host, information on how this data can be used, and other information regarding physical aspects of the device (i.e. that the device functions as a keyboard, for example, or has multiple functions such as a keyboard and volume controls).

Only a single instance of this characteristic exists as part of a HID Service.

Value Fields

NamesField RequirementFormatMinimum ValueMaximum ValueAdditional InformationReport Map ValueMandatory
uint8N/AN/AThis field may be repeated.

Name: Boot Keyboard Input Report

Type: org.bluetooth.characteristic.boot_keyboard_input_report 

Assigned Number: 0x2A22

Summary:

The Boot Keyboard Input Report characteristic is used to transfer fixed format and length Input Report data between a HID Host operating in Boot Protocol Mode and a HID Service corresponding to a boot keyboard.

Value Fields

NamesField RequirementFormatMinimum ValueMaximum ValueAdditional InformationBoot Keyboard Input Report ValueMandatory
uint8N/AN/AThis field may be repeated.

Name: Boot Keyboard Output Report

Type: org.bluetooth.characteristic.boot_keyboard_output_report 

Assigned Number: 0x2A32

Summary:

The Boot Keyboard Output Report characteristic is used to transfer fixed format and length Output Report data between a HID Host operating in Boot Protocol Mode and a HID Service corresponding to a boot keyboard.

Value Fields

NamesField RequirementFormatMinimum ValueMaximum ValueAdditional InformationBoot Keyboard Output Report ValueMandatory
uint8N/AN/AThis field may be repeated.

Name: Boot Mouse Input Report

Type: org.bluetooth.characteristic.boot_mouse_input_report 

Assigned Number: 0x2A33

Summary:

The Boot Mouse Input Report characteristic is used to transfer fixed format and length Input Report data between a HID Host operating in Boot Protocol Mode and a HID Service corresponding to a boot mouse.

Value Fields

NamesField RequirementFormatMinimum ValueMaximum ValueAdditional InformationBoot Mouse Input Report ValueMandatory
uint8N/AN/AThis field may be repeated.

Name: HID Information

Type: org.bluetooth.characteristic.hid_information 

Assigned Number: 0x2A4A

Abstract:

The HID Information Characteristic returns the HID attributes when read.

Summary:

The HID Information Characteristic contains the HID attributes. The value of this Characteristic is static and can be cached for the lifetime of the bond between the HID device and the HID host.

Value Fields

NamesField RequirementFormatMinimum ValueMaximum ValueAdditional InformationbcdHIDInformation:16-bit unsigned integer representing version number of base USB HID Specification implemented by HID DeviceMandatory
uint16N/AN/ANonebCountryCodeInformation:Identifies which country the hardware is localized for. Most hardware is not localized and thus this value would be zero (0).Mandatory
8bitN/AN/ANoneFlagsMandatory
8bitN/AN/ABit FieldBitSizeNameDefinitionKeyValue01RemoteWake0The device is not designed to be capable of providing wake-up signal to a HID host1The device is designed to be capable of providing wake-up signal to a HID host11NormallyConnectable0The device is not normally connectable1The device is normally connectable26Reserved for future use

Note:

The fields in the above table are in the order of LSO to MSO. Where LSO = Least Significant Octet and MSO = Most Significant Octet.

Name: HID Control Point

Type: org.bluetooth.characteristic.hid_control_point 

Assigned Number: 0x2A4C

Summary:

The HID Control Point characteristic is a control-point attribute that defines the following HID Commands when written:

• Suspend ( Refer to Section 7.4.2, Bluetooth HID Profile Specification 1.0

• Exit Suspend (Refer to Section 7.4.2, Bluetooth HID Profile Specification 1.0

Value Fields

NamesField RequirementFormatMinimum ValueMaximum ValueAdditional InformationHID Control Point CommandInformation:There are no response codes defined for the Suspend and Exit Suspend commands.Mandatory
uint8N/AN/AEnumerationsKeyValue0Suspend1Exit Suspend2 - 255Reserved for future use

Name: HID OVER GATT

Type: org.bluetooth.profile.hid_over_gattDownload / View

Abstract:

This profile defines how a device with Bluetooth low energy wireless communications can support HID services over the Bluetooth low energy protocol stack using the Generic Attribute Profile.

Summary:

The HID over GATT profile defines the procedures and features to be used by Bluetooth low energy HID Devices using GATT and Bluetooth HID Hosts using GATT.

Role: HID Device

ServiceDeclarationRequirementAdditional Informationorg.bluetooth.service.human_interface_devicePrimaryMandatory  Noneorg.bluetooth.service.device_informationPrimarySingleInstanceMandatoryNoneorg.bluetooth.service.scan_parametersPrimarySingleInstanceOptionalNone

Role: Boot Host

ServiceRequirementorg.bluetooth.service.human_interface_deviceMandatoryorg.bluetooth.service.device_informationMandatoryorg.bluetooth.service.scan_parametersOptionalorg.bluetooth.service.battery_serviceMandatory

Role: Report Host

ServiceRequirementorg.bluetooth.service.human_interface_deviceMandatoryorg.bluetooth.service.device_informationMandatoryorg.bluetooth.service.scan_parametersOptionalorg.bluetooth.service.battery_serviceMandatory