• No results found

iAP2 Control Session Messages

Type ID

Name

This message has no parameters.

26.1.2 AuthenticationCertificate

ID Source

0xAA01 Accessory

Table 26-2 AuthenticationCertificatemessage parameters Notes

# Type ID

Name

Accessory's X.509 certificate 1

blob 0

AuthenticationCertificate

26.1.3 RequestAuthenticationChallengeResponse

ID Source

0xAA02 Device

26. iAP2 Control Session Messages

Table 26-3 RequestAuthenticationChallengeResponsemessage parameters

Table 26-4 AuthenticationResponsemessage parameters Notes

Table 26-5 AuthenticationFailedmessage parameters Notes

# Type ID

Name

This message has no parameters.

26.1.6 AuthenticationSucceeded

ID Source

0xAA05 Device

Table 26-6 AuthenticationResponseSucceededmessage parameters Notes

# Type ID

Name

26. iAP2 Control Session Messages 26.1 Accessory Authentication

26.2 Accessory Identification

For more information, see“5. Accessory Identification” (page 53).

26.2.1 StartIdentification

ID Source

0x1D00 Device

Table 26-7 StartIdentificationmessage parameters Notes

# Type ID

Name

This message has no parameters.

26.2.2 IdentificationInformation

ID Source

0x1D01 Accessory

Table 26-8 IdentificationInformationmessage parameters

Notes

# Type

ID Name

Must match the accessory's markings and packaging. A blank string is not allowed

1 utf8

0 Name

Must match the accesory's markings and packaging. A blank string is not allowed

1 utf8

1 ModelIdentifier

Must match the accessory's markings and packaging. A blank string is not allowed

1 utf8

2 Manufacturer

Must match the accessory's markings and packaging. A blank string is not allowed

1 utf8

3 SerialNumber

26. iAP2 Control Session Messages 26.2 Accessory Identification

Notes

# Type

ID Name

Must uniquely reflect the current revision of the accessory's firmware. A blank string is not allowed

1 utf8

4 FirmwareVersion

Must uniquely reflect the current revision of the accessory's hardware. A blank string is not allowed

1 utf8

5 HardwareVersion

The exhaustive set of messages that this accessory will send. This set is expressed as an array of uint16 message identifiers 1

blob 6

MessagesSentByAccessory

The exhaustive set of messages that this accessory expects to receive. This set is expressed as an array of uint16 message identifiers

Maximum current drawn by accessory from Accessory Power pin in mA (Table 26-10 (page 187)) 0+

group 10

SupportedExternalAccessoryProtocol

The bundle seed identifier of the preferred app.

0/1 utf8

11 PreferredAppBundleSeedIdentifier

The accessory's current active language setting. Must be one of the supported languages 1

utf8 12

CurrentLanguage

26. iAP2 Control Session Messages 26.2 Accessory Identification

Notes

# Type

ID Name

A language supported by the accessory. Use the ISO 639-1 designation unless it is not available, in which case use the ISO 639-2 designation. For a complete list of ISO 639-1 and ISO 639-2 codes, see

(Table 26-15 (page 188)) 0/1 (Table 26-12 (page 187))

0/1 (Table 26-14 (page 188)) 0/1 (Table 26-16 (page 189)) 0+ (Table 26-18 (page 189)) 0+

group 19

USBHostHIDComponent

Table 26-9 PowerSourceTypeenum Meaning

26. iAP2 Control Session Messages 26.2 Accessory Identification

Table 26-10 ExternalAccessoryProtocolparameter group identifiers must be unique 1

Must refer to the

TransportComponent-Identifierof a declared USBHostTransportComponent (Table 26-14 (page 188)) 0/1

uint16 3

NativeTransportComponentIdentifier

Table 26-11 MatchActionenum Meaning

Value

The device will not attempt to find a matching app, and there will not be a Find App For This Accessory button in Settings > General > About > 'Accessory Name'

0

The device will attempt to find a matching app, and there will be a Find App For This Accessory button in Settings > General > About > 'Accessory Name'

1

The device will not attempt to find a matching app, but there will be a Find App For This Accessory button in Settings > General > About > 'Accessory Name'

2

Table 26-12 USBDeviceTransportComponentparameter group

Notes

26. iAP2 Control Session Messages 26.2 Accessory Identification

Table 26-13 USBDeviceModeAudioSampleRateenum

Table 26-14 USBHostTransportComponentparameter group

Notes

Table 26-15 SerialTransportComponentparameter group

Notes

26. iAP2 Control Session Messages 26.2 Accessory Identification

Table 26-16 BluetoothTransportComponentparameter group

A valid 6-byte IEEE EUI-48 identifier 1

blob 3

BluetoothTransportMediaAccessControlAddress

Table 26-17 IAP2HIDComponentparameter group

Notes

See HIDComponentFunction (Table 26-19 (page 190))

1 enum 2

HIDComponentFunction

Table 26-18 USBHostHIDComponentparameter group

Notes (Table 26-19 (page 190)) 1

enum 2

HIDComponentFunction

Must refer to a

USBHostTransportComponent (Table 26-14 (page 188)) 1

uint16 3

USBHostTransportComponentIdentifier

Must match the accessory's corresponding USB device interface descriptor. If more than one USBHostHIDComponent is present, the accessory must present multiple USB HID 1

uint8 4

USBHostTransportInterfaceNumber

26. iAP2 Control Session Messages 26.2 Accessory Identification

Table 26-19 HIDComponentFunctionenum

Table 26-20 IdentificationAcceptedmessage parameters Notes

# Type ID

Name

This message has no parameters.

26.2.4 IdentificationRejected

ID Source

0x1D03 Device

Table 26-21 IdentificationRejectedmessage parameters

Notes

26. iAP2 Control Session Messages 26.2 Accessory Identification

Notes

# Type ID

Name

The set of unsupported messages sent by the accessory. This set is expressed as an array of uint16 message identifiers

0/1 blob

6 MessagesSentByAccessory

The set of unsupported messages received from the device. This set is expressed as an array of uint16 message identifiers

One or more of the External Accessory Protocols is not supported by the device 0/1

One or more of the identified languages is not supported by the device

One or more of the identified Bluetooth Transport components is not supported by the device 0/1

none 17

BluetoothTransportComponent

One or more of the identified HID components is not supported by the device

0+

none 18

iAP2HIDComponent

One or more of the identified HID components is not supported by the device

0+

none 19

USBHostHIDComponent

26. iAP2 Control Session Messages 26.2 Accessory Identification

26.2.5 CancelIdentification

ID Source

0x1D05 Accessory

Table 26-22 CancelIdentificationmessage parameters Notes

# Type ID

Name

This message has no parameters.

26.2.6 IdentificationInformationUpdate

ID Source

0x1D06 Accessory

Table 26-23 IdentificationInformationUpdatemessage parameters Notes

For more information, see“6. App Launch” (page 58).

26. iAP2 Control Session Messages 26.3 App Launch

26.3.1 RequestAppLaunch

ID Source

0xEA02 Accessory

Table 26-24 RequestAppLaunchmessage parameters Notes

# Type ID

Name

uniform type identifer (UTI) in reverse-DNS format, e.g.

com.Ajax.hello

For more information, see“7. AssistiveTouch” (page 60).

26.4.1 StartAssistiveTouch

ID Source

0x5400 Accessory

Table 26-25 StartAssistiveTouchmessage parameters Notes

# Type ID

Name

This message has no parameters.

26.4.2 StopAssistiveTouch

ID Source

0x5401 Accessory

Table 26-26 StopAssistiveTouchmessage parameters Notes

# Type ID

Name

26. iAP2 Control Session Messages 26.4 AssistiveTouch

26.4.3 StartAssistiveTouchInformation

ID Source

0x5402 Accessory

Table 26-27 StartAssistiveTouchInformationmessage parameters Notes

# Type ID

Name

This message has no parameters.

26.4.4 AssistiveTouchInformation

ID Source

0x5403 Device

Table 26-28 AssistiveTouchInformationmessage parameters Notes

Table 26-29 StopAssistiveTouchInformationmessage parameters Notes

# Type ID

Name

This message has no parameters.

26.5 Bluetooth Pairing and Connection Status

For more information, see“8. Bluetooth Pairing and Connection Status” (page 62).

26. iAP2 Control Session Messages

26.5 Bluetooth Pairing and Connection Status

26.5.1 BluetoothComponentInformation

ID Source

0x4E01 Accessory

Table 26-30 BluetoothComponentInformationmessage parameters Notes

Table 26-31 BluetoothComponentStatusparameter group Notes

trueif the Bluetooth component is ready for connections to the Apple device

1

Table 26-32 StartBluetoothConnectionUpdatesmessage parameters Notes (Table 26-16 (page 189)) 1+

26. iAP2 Control Session Messages

26.5 Bluetooth Pairing and Connection Status

Table 26-33 BluetoothConnectionUpdatemessage parameters (Table 26-16 (page 189)) 1 (Table 26-34 (page 196)) 0/1

group 1

ConnectedBluetoothProfiles

Table 26-34 BluetoothComponentProfilesparameter group

Notes

Apple device is in the Access Point role

Apple device is in the Client role

26. iAP2 Control Session Messages

26.5 Bluetooth Pairing and Connection Status

Table 26-35 StopBluetoothConnectionUpdatesmessage parameters

This message has no parameters.

26.6 Device Authentication

For more information, see“9. Device Authentication” (page 64).

26.6.1 RequestDeviceAuthenticationCertificate

ID Source

0xAA10 Accessory

Table 26-36 RequestDeviceAuthenticationCertificatemessage parameters Notes

# Type ID

Name

This message has no parameters.

26.6.2 DeviceAuthenticationCertificate

ID Source

0xAA11 Device

Table 26-37 DeviceAuthenticationCertificatemessage parameters Notes

26. iAP2 Control Session Messages 26.6 Device Authentication

Table 26-38 RequestDeviceAuthenticationChallengeResponsemessage parameters

Table 26-39 DeviceAuthenticationResponsemessage parameters Notes

Table 26-40 DeviceAuthenticationFailedmessage parameters Notes

# Type ID

Name

This message has no parameters.

26.6.6 DeviceAuthenticationSucceeded

ID Source

0xAA15 Accessory

Table 26-41 DeviceAuthenticationResponseSucceededmessage parameters Notes

# Type ID

Name

This message has no parameters.

26. iAP2 Control Session Messages 26.6 Device Authentication

26.7 External Accessory Protocol

For more information, see“11. External Accessory Protocol” (page 69).

26.7.1 StartExternalAccessoryProtocolSession

ID Source

0xEA00 Device

Table 26-42 StartExternalAccessoryProtocolSessionmessage parameters Notes (Table 26-10 (page 187)) 1

Table 26-43 StopExternalAccessoryProtocolSessionmessage parameters Notes

26.8 Human Interface Device

For more information, see“14. Human Interface Device (HID)” (page 96).

26.8.1 StartHID

26. iAP2 Control Session Messages 26.7 External Accessory Protocol

Table 26-44 StartHIDmessage parameters

Must refer to an identified iAP2HIDComponent (Table

Must be assigned and registered by the USB-IF for the accessory

manufacturer.

1 uint16 1

VendorIdentifier

Must be unique for each accessory made by the accessory manufacturer.

1 uint16 2

ProductIdentifier

Only required if the HID component is a localized (non-ANSI) keyboard.

Must be drawn from the TBD list of assigned country codes.

Table 26-45 DeviceHIDReportmessage parameters

Notes

# Type

ID Name

Must refer to an identified iAP2HIDComponent (Table 26-17 (page 189))

1

26. iAP2 Control Session Messages 26.8 Human Interface Device