blob: 5d4a28d97879e302e610c14554555ee8f590afcd [file] [log] [blame] [view]
<link rel="stylesheet" href="../style.css" />
[TOC]
# fuchsia.bluetooth
<div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div>
## **STRUCTS**
### Address {#Address data-text="Address"}
*Defined in [fuchsia.bluetooth/address.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/address.fidl;l=15)*
<p>Represents a 48-bit Bluetooth Device Address.</p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Address.type">
<td><code>type</code></td>
<td>
<code><a class='link' href='#AddressType'>AddressType</a></code>
</td>
<td><p>Type of the device address.</p>
</td>
<td>No default</td>
</tr>
<tr id="Address.bytes">
<td><code>bytes</code></td>
<td>
<code>uint8[6]</code>
</td>
<td><p>The device address bytes in little-endian order.</p>
</td>
<td>No default</td>
</tr>
</table>
### Bool {#Bool data-text="Bool"}
*Defined in [fuchsia.bluetooth/deprecated.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/deprecated.fidl;l=10)*
<p><b>DEPRECATED </b></p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Bool.value">
<td><code>value</code></td>
<td>
<code>bool</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### DeviceClass {#DeviceClass data-text="DeviceClass"}
*Defined in [fuchsia.bluetooth/device_class.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=13)*
<p>The &quot;Class of Device/Service&quot; is a variable-format field that defines the category of a
Bluetooth device. The bitfield is divided into segments called &quot;major service class&quot;,
&quot;major device class&quot;, and &quot;minor device class&quot;.</p>
<p>No assumptions about the specific functionality or characteristics of any application should be
based solely on its inclusion within a Major or Minor device class. For more information, see
https://www.bluetooth.com/specifications/assigned-numbers/baseband.</p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="DeviceClass.value">
<td><code>value</code></td>
<td>
<code>uint32</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Error {#Error data-text="Error"}
*Defined in [fuchsia.bluetooth/deprecated.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/deprecated.fidl;l=42)*
<p><b>DEPRECATED </b>- Use protocol specific error enums instead</p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Error.error_code">
<td><code>error_code</code></td>
<td>
<code><a class='link' href='#ErrorCode'>ErrorCode</a></code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="Error.protocol_error_code">
<td><code>protocol_error_code</code></td>
<td>
<code>uint32</code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="Error.description">
<td><code>description</code></td>
<td>
<code>string?</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### HostId {#HostId data-text="HostId"}
*Defined in [fuchsia.bluetooth/id.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/id.fidl;l=7)*
<p>64-bit unique value used by the system to identify host adapters.</p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="HostId.value">
<td><code>value</code></td>
<td>
<code>uint64</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Int8 {#Int8 data-text="Int8"}
*Defined in [fuchsia.bluetooth/deprecated.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/deprecated.fidl;l=15)*
<p><b>DEPRECATED </b></p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Int8.value">
<td><code>value</code></td>
<td>
<code>int8</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### PeerId {#PeerId data-text="PeerId"}
*Defined in [fuchsia.bluetooth/id.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/id.fidl;l=12)*
<p>64-bit unique value used by the system to identify peer devices.</p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="PeerId.value">
<td><code>value</code></td>
<td>
<code>uint64</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Status {#Status data-text="Status"}
*Defined in [fuchsia.bluetooth/deprecated.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/deprecated.fidl;l=60)*
<p><b>DEPRECATED </b>- Use protocol specific error enums and the &#x27;error&#x27; syntax instead</p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Status.error">
<td><code>error</code></td>
<td>
<code><a class='link' href='#Error'>Error</a>?</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### UInt16 {#UInt16 data-text="UInt16"}
*Defined in [fuchsia.bluetooth/deprecated.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/deprecated.fidl;l=20)*
<p><b>DEPRECATED </b></p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="UInt16.value">
<td><code>value</code></td>
<td>
<code>uint16</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### Uuid {#Uuid data-text="Uuid"}
*Defined in [fuchsia.bluetooth/uuid.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/uuid.fidl;l=9)*
<p>Represents a Bluetooth UUID in its 128-bit canonical form. While the Bluetooth standard supports
16- and 32-bit short form UUIDs over the wire, the Fuchsia FIDL libraries require all UUIDs to
be represented in their canonical 128-bit form.</p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Uuid.value">
<td><code>value</code></td>
<td>
<code>uint8[16]</code>
</td>
<td><p>The UUID bytes in little-endian order.</p>
</td>
<td>No default</td>
</tr>
</table>
## **ENUMS**
### AddressType [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#AddressType data-text="AddressType"}
Type: <code>uint8</code>
*Defined in [fuchsia.bluetooth/address.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/address.fidl;l=6)*
<table>
<tr><th>Name</th><th>Value</th><th>Description</th></tr>
<tr id="AddressType.PUBLIC">
<td><h3 id="AddressType.PUBLIC" class="add-link hide-from-toc">PUBLIC</h3></td>
<td><code>1</code></td>
<td><p>LE public device address or <code>BR/EDR</code> <code>BD_ADDR</code>.</p>
</td>
</tr>
<tr id="AddressType.RANDOM">
<td><h3 id="AddressType.RANDOM" class="add-link hide-from-toc">RANDOM</h3></td>
<td><code>2</code></td>
<td><p>LE private or static random device address.</p>
</td>
</tr>
</table>
### Appearance [flexible](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#Appearance data-text="Appearance"}
Type: <code>uint16</code>
*Defined in [fuchsia.bluetooth/appearance.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/appearance.fidl;l=12)*
<p>Possible values for the LE Appearance property which describes the external
appearance of a peer at a high level.
(See the Bluetooth assigned-numbers document:
https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml)
This enum is flexible as newer devices may use new appearance values and in the future the
assigned numbers document may have additional entries.</p>
<table>
<tr><th>Name</th><th>Value</th><th>Description</th></tr>
<tr id="Appearance.UNKNOWN">
<td><h3 id="Appearance.UNKNOWN" class="add-link hide-from-toc">UNKNOWN</h3></td>
<td><code>0</code></td>
<td></td>
</tr>
<tr id="Appearance.PHONE">
<td><h3 id="Appearance.PHONE" class="add-link hide-from-toc">PHONE</h3></td>
<td><code>64</code></td>
<td></td>
</tr>
<tr id="Appearance.COMPUTER">
<td><h3 id="Appearance.COMPUTER" class="add-link hide-from-toc">COMPUTER</h3></td>
<td><code>128</code></td>
<td></td>
</tr>
<tr id="Appearance.WATCH">
<td><h3 id="Appearance.WATCH" class="add-link hide-from-toc">WATCH</h3></td>
<td><code>192</code></td>
<td></td>
</tr>
<tr id="Appearance.WATCH_SPORTS">
<td><h3 id="Appearance.WATCH_SPORTS" class="add-link hide-from-toc">WATCH_SPORTS</h3></td>
<td><code>193</code></td>
<td></td>
</tr>
<tr id="Appearance.CLOCK">
<td><h3 id="Appearance.CLOCK" class="add-link hide-from-toc">CLOCK</h3></td>
<td><code>256</code></td>
<td></td>
</tr>
<tr id="Appearance.DISPLAY">
<td><h3 id="Appearance.DISPLAY" class="add-link hide-from-toc">DISPLAY</h3></td>
<td><code>320</code></td>
<td></td>
</tr>
<tr id="Appearance.REMOTE_CONTROL">
<td><h3 id="Appearance.REMOTE_CONTROL" class="add-link hide-from-toc">REMOTE_CONTROL</h3></td>
<td><code>384</code></td>
<td></td>
</tr>
<tr id="Appearance.EYE_GLASSES">
<td><h3 id="Appearance.EYE_GLASSES" class="add-link hide-from-toc">EYE_GLASSES</h3></td>
<td><code>448</code></td>
<td></td>
</tr>
<tr id="Appearance.TAG">
<td><h3 id="Appearance.TAG" class="add-link hide-from-toc">TAG</h3></td>
<td><code>512</code></td>
<td></td>
</tr>
<tr id="Appearance.KEYRING">
<td><h3 id="Appearance.KEYRING" class="add-link hide-from-toc">KEYRING</h3></td>
<td><code>576</code></td>
<td></td>
</tr>
<tr id="Appearance.MEDIA_PLAYER">
<td><h3 id="Appearance.MEDIA_PLAYER" class="add-link hide-from-toc">MEDIA_PLAYER</h3></td>
<td><code>640</code></td>
<td></td>
</tr>
<tr id="Appearance.BARCODE_SCANNER">
<td><h3 id="Appearance.BARCODE_SCANNER" class="add-link hide-from-toc">BARCODE_SCANNER</h3></td>
<td><code>704</code></td>
<td></td>
</tr>
<tr id="Appearance.THERMOMETER">
<td><h3 id="Appearance.THERMOMETER" class="add-link hide-from-toc">THERMOMETER</h3></td>
<td><code>768</code></td>
<td></td>
</tr>
<tr id="Appearance.THERMOMETER_EAR">
<td><h3 id="Appearance.THERMOMETER_EAR" class="add-link hide-from-toc">THERMOMETER_EAR</h3></td>
<td><code>769</code></td>
<td></td>
</tr>
<tr id="Appearance.HEART_RATE_SENSOR">
<td><h3 id="Appearance.HEART_RATE_SENSOR" class="add-link hide-from-toc">HEART_RATE_SENSOR</h3></td>
<td><code>832</code></td>
<td></td>
</tr>
<tr id="Appearance.HEART_RATE_SENSOR_BELT">
<td><h3 id="Appearance.HEART_RATE_SENSOR_BELT" class="add-link hide-from-toc">HEART_RATE_SENSOR_BELT</h3></td>
<td><code>833</code></td>
<td></td>
</tr>
<tr id="Appearance.BLOOD_PRESSURE">
<td><h3 id="Appearance.BLOOD_PRESSURE" class="add-link hide-from-toc">BLOOD_PRESSURE</h3></td>
<td><code>896</code></td>
<td></td>
</tr>
<tr id="Appearance.BLOOD_PRESSURE_ARM">
<td><h3 id="Appearance.BLOOD_PRESSURE_ARM" class="add-link hide-from-toc">BLOOD_PRESSURE_ARM</h3></td>
<td><code>897</code></td>
<td></td>
</tr>
<tr id="Appearance.BLOOD_PRESSURE_WRIST">
<td><h3 id="Appearance.BLOOD_PRESSURE_WRIST" class="add-link hide-from-toc">BLOOD_PRESSURE_WRIST</h3></td>
<td><code>898</code></td>
<td></td>
</tr>
<tr id="Appearance.HID">
<td><h3 id="Appearance.HID" class="add-link hide-from-toc">HID</h3></td>
<td><code>960</code></td>
<td></td>
</tr>
<tr id="Appearance.HID_KEYBOARD">
<td><h3 id="Appearance.HID_KEYBOARD" class="add-link hide-from-toc">HID_KEYBOARD</h3></td>
<td><code>961</code></td>
<td></td>
</tr>
<tr id="Appearance.HID_MOUSE">
<td><h3 id="Appearance.HID_MOUSE" class="add-link hide-from-toc">HID_MOUSE</h3></td>
<td><code>962</code></td>
<td></td>
</tr>
<tr id="Appearance.HID_JOYSTICK">
<td><h3 id="Appearance.HID_JOYSTICK" class="add-link hide-from-toc">HID_JOYSTICK</h3></td>
<td><code>963</code></td>
<td></td>
</tr>
<tr id="Appearance.HID_GAMEPAD">
<td><h3 id="Appearance.HID_GAMEPAD" class="add-link hide-from-toc">HID_GAMEPAD</h3></td>
<td><code>964</code></td>
<td></td>
</tr>
<tr id="Appearance.HID_DIGITIZER_TABLET">
<td><h3 id="Appearance.HID_DIGITIZER_TABLET" class="add-link hide-from-toc">HID_DIGITIZER_TABLET</h3></td>
<td><code>965</code></td>
<td></td>
</tr>
<tr id="Appearance.HID_CARD_READER">
<td><h3 id="Appearance.HID_CARD_READER" class="add-link hide-from-toc">HID_CARD_READER</h3></td>
<td><code>966</code></td>
<td></td>
</tr>
<tr id="Appearance.HID_DIGITAL_PEN">
<td><h3 id="Appearance.HID_DIGITAL_PEN" class="add-link hide-from-toc">HID_DIGITAL_PEN</h3></td>
<td><code>967</code></td>
<td></td>
</tr>
<tr id="Appearance.HID_BARCODE_SCANNER">
<td><h3 id="Appearance.HID_BARCODE_SCANNER" class="add-link hide-from-toc">HID_BARCODE_SCANNER</h3></td>
<td><code>968</code></td>
<td></td>
</tr>
<tr id="Appearance.GLUCOSE_METER">
<td><h3 id="Appearance.GLUCOSE_METER" class="add-link hide-from-toc">GLUCOSE_METER</h3></td>
<td><code>1024</code></td>
<td></td>
</tr>
<tr id="Appearance.RUNNING_WALKING_SENSOR">
<td><h3 id="Appearance.RUNNING_WALKING_SENSOR" class="add-link hide-from-toc">RUNNING_WALKING_SENSOR</h3></td>
<td><code>1088</code></td>
<td></td>
</tr>
<tr id="Appearance.RUNNING_WALKING_SENSOR_IN_SHOE">
<td><h3 id="Appearance.RUNNING_WALKING_SENSOR_IN_SHOE" class="add-link hide-from-toc">RUNNING_WALKING_SENSOR_IN_SHOE</h3></td>
<td><code>1089</code></td>
<td></td>
</tr>
<tr id="Appearance.RUNNING_WALKING_SENSOR_ON_SHOE">
<td><h3 id="Appearance.RUNNING_WALKING_SENSOR_ON_SHOE" class="add-link hide-from-toc">RUNNING_WALKING_SENSOR_ON_SHOE</h3></td>
<td><code>1090</code></td>
<td></td>
</tr>
<tr id="Appearance.RUNNING_WALKING_SENSOR_ON_HIP">
<td><h3 id="Appearance.RUNNING_WALKING_SENSOR_ON_HIP" class="add-link hide-from-toc">RUNNING_WALKING_SENSOR_ON_HIP</h3></td>
<td><code>1091</code></td>
<td></td>
</tr>
<tr id="Appearance.CYCLING">
<td><h3 id="Appearance.CYCLING" class="add-link hide-from-toc">CYCLING</h3></td>
<td><code>1152</code></td>
<td></td>
</tr>
<tr id="Appearance.CYCLING_COMPUTER">
<td><h3 id="Appearance.CYCLING_COMPUTER" class="add-link hide-from-toc">CYCLING_COMPUTER</h3></td>
<td><code>1153</code></td>
<td></td>
</tr>
<tr id="Appearance.CYCLING_SPEED_SENSOR">
<td><h3 id="Appearance.CYCLING_SPEED_SENSOR" class="add-link hide-from-toc">CYCLING_SPEED_SENSOR</h3></td>
<td><code>1154</code></td>
<td></td>
</tr>
<tr id="Appearance.CYCLING_CADENCE_SENSOR">
<td><h3 id="Appearance.CYCLING_CADENCE_SENSOR" class="add-link hide-from-toc">CYCLING_CADENCE_SENSOR</h3></td>
<td><code>1155</code></td>
<td></td>
</tr>
<tr id="Appearance.CYCLING_POWER_SENSOR">
<td><h3 id="Appearance.CYCLING_POWER_SENSOR" class="add-link hide-from-toc">CYCLING_POWER_SENSOR</h3></td>
<td><code>1156</code></td>
<td></td>
</tr>
<tr id="Appearance.CYCLING_SPEED_AND_CADENCE_SENSOR">
<td><h3 id="Appearance.CYCLING_SPEED_AND_CADENCE_SENSOR" class="add-link hide-from-toc">CYCLING_SPEED_AND_CADENCE_SENSOR</h3></td>
<td><code>1157</code></td>
<td></td>
</tr>
<tr id="Appearance.PULSE_OXIMETER">
<td><h3 id="Appearance.PULSE_OXIMETER" class="add-link hide-from-toc">PULSE_OXIMETER</h3></td>
<td><code>3136</code></td>
<td></td>
</tr>
<tr id="Appearance.PULSE_OXIMETER_FINGERTIP">
<td><h3 id="Appearance.PULSE_OXIMETER_FINGERTIP" class="add-link hide-from-toc">PULSE_OXIMETER_FINGERTIP</h3></td>
<td><code>3137</code></td>
<td></td>
</tr>
<tr id="Appearance.PULSE_OXIMETER_WRIST">
<td><h3 id="Appearance.PULSE_OXIMETER_WRIST" class="add-link hide-from-toc">PULSE_OXIMETER_WRIST</h3></td>
<td><code>3138</code></td>
<td></td>
</tr>
<tr id="Appearance.WEIGHT_SCALE">
<td><h3 id="Appearance.WEIGHT_SCALE" class="add-link hide-from-toc">WEIGHT_SCALE</h3></td>
<td><code>3200</code></td>
<td></td>
</tr>
<tr id="Appearance.PERSONAL_MOBILITY">
<td><h3 id="Appearance.PERSONAL_MOBILITY" class="add-link hide-from-toc">PERSONAL_MOBILITY</h3></td>
<td><code>3264</code></td>
<td></td>
</tr>
<tr id="Appearance.PERSONAL_MOBILITY_WHEELCHAIR">
<td><h3 id="Appearance.PERSONAL_MOBILITY_WHEELCHAIR" class="add-link hide-from-toc">PERSONAL_MOBILITY_WHEELCHAIR</h3></td>
<td><code>3265</code></td>
<td></td>
</tr>
<tr id="Appearance.PERSONAL_MOBILITY_SCOOTER">
<td><h3 id="Appearance.PERSONAL_MOBILITY_SCOOTER" class="add-link hide-from-toc">PERSONAL_MOBILITY_SCOOTER</h3></td>
<td><code>3266</code></td>
<td></td>
</tr>
<tr id="Appearance.GLUCOSE_MONITOR">
<td><h3 id="Appearance.GLUCOSE_MONITOR" class="add-link hide-from-toc">GLUCOSE_MONITOR</h3></td>
<td><code>3328</code></td>
<td></td>
</tr>
<tr id="Appearance.SPORTS_ACTIVITY">
<td><h3 id="Appearance.SPORTS_ACTIVITY" class="add-link hide-from-toc">SPORTS_ACTIVITY</h3></td>
<td><code>5184</code></td>
<td></td>
</tr>
<tr id="Appearance.SPORTS_ACTIVITY_LOCATION_DISPLAY">
<td><h3 id="Appearance.SPORTS_ACTIVITY_LOCATION_DISPLAY" class="add-link hide-from-toc">SPORTS_ACTIVITY_LOCATION_DISPLAY</h3></td>
<td><code>5185</code></td>
<td></td>
</tr>
<tr id="Appearance.SPORTS_ACTIVITY_LOCATION_AND_NAV_DISPLAY">
<td><h3 id="Appearance.SPORTS_ACTIVITY_LOCATION_AND_NAV_DISPLAY" class="add-link hide-from-toc">SPORTS_ACTIVITY_LOCATION_AND_NAV_DISPLAY</h3></td>
<td><code>5186</code></td>
<td></td>
</tr>
<tr id="Appearance.SPORTS_ACTIVITY_LOCATION_POD">
<td><h3 id="Appearance.SPORTS_ACTIVITY_LOCATION_POD" class="add-link hide-from-toc">SPORTS_ACTIVITY_LOCATION_POD</h3></td>
<td><code>5187</code></td>
<td></td>
</tr>
<tr id="Appearance.SPORTS_ACTIVITY_LOCATION_AND_NAV_POD">
<td><h3 id="Appearance.SPORTS_ACTIVITY_LOCATION_AND_NAV_POD" class="add-link hide-from-toc">SPORTS_ACTIVITY_LOCATION_AND_NAV_POD</h3></td>
<td><code>5188</code></td>
<td></td>
</tr>
</table>
### ConnectionRole [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#ConnectionRole data-text="ConnectionRole"}
Type: <code>uint32</code>
*Defined in [fuchsia.bluetooth/connection_role.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/connection_role.fidl;l=9)*
<p>Refers to the role of a Bluetooth device (local or peer) in a physical channel piconet. See
<a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:src/connectivity/bluetooth/docs/vocabulary.md">Bluetooth Vocabulary Guide</a>
for more information.</p>
<table>
<tr><th>Name</th><th>Value</th><th>Description</th></tr>
<tr id="ConnectionRole.LEADER">
<td><h3 id="ConnectionRole.LEADER" class="add-link hide-from-toc">LEADER</h3></td>
<td><code>1</code></td>
<td><p>The role of the device that defines the piconet physical channel in BR/EDR or the
&quot;initiating&quot; device in LE.</p>
</td>
</tr>
<tr id="ConnectionRole.FOLLOWER">
<td><h3 id="ConnectionRole.FOLLOWER" class="add-link hide-from-toc">FOLLOWER</h3></td>
<td><code>2</code></td>
<td><p>The role of a device that synchronizes to the piconet physical channel in BR/EDR or the
&quot;advertising&quot; device in LE.</p>
</td>
</tr>
</table>
### ErrorCode [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#ErrorCode data-text="ErrorCode"}
Type: <code>uint32</code>
*Defined in [fuchsia.bluetooth/deprecated.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/deprecated.fidl;l=25)*
<p><b>DEPRECATED </b>- Use protocol specific error enums and zx.status instead</p>
<table>
<tr><th>Name</th><th>Value</th><th>Description</th></tr>
<tr id="ErrorCode.UNKNOWN">
<td><h3 id="ErrorCode.UNKNOWN" class="add-link hide-from-toc">UNKNOWN</h3></td>
<td><code>0</code></td>
<td></td>
</tr>
<tr id="ErrorCode.FAILED">
<td><h3 id="ErrorCode.FAILED" class="add-link hide-from-toc">FAILED</h3></td>
<td><code>1</code></td>
<td></td>
</tr>
<tr id="ErrorCode.CANCELED">
<td><h3 id="ErrorCode.CANCELED" class="add-link hide-from-toc">CANCELED</h3></td>
<td><code>2</code></td>
<td></td>
</tr>
<tr id="ErrorCode.IN_PROGRESS">
<td><h3 id="ErrorCode.IN_PROGRESS" class="add-link hide-from-toc">IN_PROGRESS</h3></td>
<td><code>3</code></td>
<td></td>
</tr>
<tr id="ErrorCode.TIMED_OUT">
<td><h3 id="ErrorCode.TIMED_OUT" class="add-link hide-from-toc">TIMED_OUT</h3></td>
<td><code>4</code></td>
<td></td>
</tr>
<tr id="ErrorCode.NOT_FOUND">
<td><h3 id="ErrorCode.NOT_FOUND" class="add-link hide-from-toc">NOT_FOUND</h3></td>
<td><code>5</code></td>
<td></td>
</tr>
<tr id="ErrorCode.NOT_SUPPORTED">
<td><h3 id="ErrorCode.NOT_SUPPORTED" class="add-link hide-from-toc">NOT_SUPPORTED</h3></td>
<td><code>6</code></td>
<td></td>
</tr>
<tr id="ErrorCode.BLUETOOTH_NOT_AVAILABLE">
<td><h3 id="ErrorCode.BLUETOOTH_NOT_AVAILABLE" class="add-link hide-from-toc">BLUETOOTH_NOT_AVAILABLE</h3></td>
<td><code>7</code></td>
<td></td>
</tr>
<tr id="ErrorCode.BAD_STATE">
<td><h3 id="ErrorCode.BAD_STATE" class="add-link hide-from-toc">BAD_STATE</h3></td>
<td><code>8</code></td>
<td></td>
</tr>
<tr id="ErrorCode.INVALID_ARGUMENTS">
<td><h3 id="ErrorCode.INVALID_ARGUMENTS" class="add-link hide-from-toc">INVALID_ARGUMENTS</h3></td>
<td><code>9</code></td>
<td></td>
</tr>
<tr id="ErrorCode.ALREADY">
<td><h3 id="ErrorCode.ALREADY" class="add-link hide-from-toc">ALREADY</h3></td>
<td><code>10</code></td>
<td></td>
</tr>
<tr id="ErrorCode.PROTOCOL_ERROR">
<td><h3 id="ErrorCode.PROTOCOL_ERROR" class="add-link hide-from-toc">PROTOCOL_ERROR</h3></td>
<td><code>11</code></td>
<td></td>
</tr>
</table>
## **CONSTANTS**
<table>
<tr><th>Name</th><th>Value</th><th>Type</th><th>Description</th></tr>
<tr id="MAJOR_DEVICE_CLASS_AUDIO_VIDEO">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=24">MAJOR_DEVICE_CLASS_AUDIO_VIDEO</a></td>
<td>
<code>1024</code>
</td>
<td><code>uint32</code></td>
<td></td>
</tr>
<tr id="MAJOR_DEVICE_CLASS_COMPUTER">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=21">MAJOR_DEVICE_CLASS_COMPUTER</a></td>
<td>
<code>256</code>
</td>
<td><code>uint32</code></td>
<td></td>
</tr>
<tr id="MAJOR_DEVICE_CLASS_HEALTH">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=29">MAJOR_DEVICE_CLASS_HEALTH</a></td>
<td>
<code>2304</code>
</td>
<td><code>uint32</code></td>
<td></td>
</tr>
<tr id="MAJOR_DEVICE_CLASS_IMAGING">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=26">MAJOR_DEVICE_CLASS_IMAGING</a></td>
<td>
<code>1536</code>
</td>
<td><code>uint32</code></td>
<td></td>
</tr>
<tr id="MAJOR_DEVICE_CLASS_LAN">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=23">MAJOR_DEVICE_CLASS_LAN</a></td>
<td>
<code>768</code>
</td>
<td><code>uint32</code></td>
<td></td>
</tr>
<tr id="MAJOR_DEVICE_CLASS_MASK">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=18">MAJOR_DEVICE_CLASS_MASK</a></td>
<td>
<code>7936</code>
</td>
<td><code>uint32</code></td>
<td><p>Constants for the major device class field. The major device class is defined by bits 12-8.</p>
</td>
</tr>
<tr id="MAJOR_DEVICE_CLASS_MISCELLANEOUS">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=20">MAJOR_DEVICE_CLASS_MISCELLANEOUS</a></td>
<td>
<code>0</code>
</td>
<td><code>uint32</code></td>
<td></td>
</tr>
<tr id="MAJOR_DEVICE_CLASS_PERIPHERAL">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=25">MAJOR_DEVICE_CLASS_PERIPHERAL</a></td>
<td>
<code>1280</code>
</td>
<td><code>uint32</code></td>
<td></td>
</tr>
<tr id="MAJOR_DEVICE_CLASS_PHONE">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=22">MAJOR_DEVICE_CLASS_PHONE</a></td>
<td>
<code>512</code>
</td>
<td><code>uint32</code></td>
<td></td>
</tr>
<tr id="MAJOR_DEVICE_CLASS_TOY">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=28">MAJOR_DEVICE_CLASS_TOY</a></td>
<td>
<code>2048</code>
</td>
<td><code>uint32</code></td>
<td></td>
</tr>
<tr id="MAJOR_DEVICE_CLASS_UNCATEGORIZED">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=30">MAJOR_DEVICE_CLASS_UNCATEGORIZED</a></td>
<td>
<code>7936</code>
</td>
<td><code>uint32</code></td>
<td></td>
</tr>
<tr id="MAJOR_DEVICE_CLASS_WEARABLE">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_class.fidl;l=27">MAJOR_DEVICE_CLASS_WEARABLE</a></td>
<td>
<code>1792</code>
</td>
<td><code>uint32</code></td>
<td></td>
</tr>
<tr id="MAX_DEVICE_NAME_LENGTH">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_name.fidl;l=8">MAX_DEVICE_NAME_LENGTH</a></td>
<td>
<code>248</code>
</td>
<td><code>uint8</code></td>
<td><p>The maximum length of a device name. This value was selected based on the HCI and GAP
specifications (v5.2, Vol 4, Part E, 7.3.11 and Vol 3, Part C, 12.1).</p>
</td>
</tr>
<tr id="UUID_STRING_REPRESENTATION_LENGTH">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/deprecated.fidl;l=67">UUID_STRING_REPRESENTATION_LENGTH</a></td>
<td>
<code>36</code>
</td>
<td><code>uint8</code></td>
<td><p>The size of the standard string representation for a UUID. This value is based on the canonical
36-character 8-4-4-4-12 format defined in IETF RFC4122 Section 3.</p>
</td>
</tr>
</table>
## **ALIASES**
<table>
<tr><th>Name</th><th>Value</th><th>Description</th></tr>
<tr id="DeviceName">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/device_name.fidl;l=11">DeviceName</a></td>
<td>
<code>string</code>[<code><a class='link' href='#MAX_DEVICE_NAME_LENGTH'>MAX_DEVICE_NAME_LENGTH</a></code>]</td>
<td><p>Alias for a Bluetooth device name.</p>
</td>
</tr>
<tr id="PeerIdString">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/deprecated.fidl;l=73">PeerIdString</a></td>
<td>
<code>string</code>[<code>16</code>]</td>
<td><p><b>DEPRECATED </b>- Use fuchsia.bluetooth/PeerId instead</p></td>
</tr>
<tr id="UuidString">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.bluetooth/deprecated.fidl;l=70">UuidString</a></td>
<td>
<code>string</code>[<code><a class='link' href='#UUID_STRING_REPRESENTATION_LENGTH'>UUID_STRING_REPRESENTATION_LENGTH</a></code>]</td>
<td><p><b>DEPRECATED </b>- Use fuchsia.bluetooth/Uuid instead</p></td>
</tr>
</table>