BlePeripheralDevice

java.lang.Object
- ohos.bluetooth.ble.BlePeripheralDevice

```
public class BlePeripheralDevice
extends Object
```
Provides the types of Bluetooth Low Energy (BLE) peripheral devices and related operations.
Related operations include connecting to, disconnecting from, and disabling a BLE peripheral device.

从以下版本开始:

1

字段概要

字段
限定符和类型	字段	说明
`static int`	`CONNECTION_PRIORITY_HIGH`	Connection parameter update - Request a high priority, low latency connection.
`static int`	`CONNECTION_PRIORITY_LOW`	Connection parameter update - Request low power, reduced data rate connection parameters.
`static int`	`CONNECTION_PRIORITY_NORMAL`	Connection parameter update - Use the connection parameters recommended by the Bluetooth SIG.
`static int`	`OPERATION_SUCC`	Indicates that the operation succeeds.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`boolean`	`close()`	Disables a BLE peripheral device.
`boolean`	`connect(boolean isAutoConnect, BlePeripheralCallback callback)`	Connects to a BLE peripheral device.
`static BlePeripheralDevice`	`createInstance(String address)`	Creates a `BlePeripheralDevice` object with a specified MAC address.
`boolean`	`disconnect()`	Disconnects from or stops an ongoing connection to a BLE peripheral device.
`boolean`	`discoverServices()`	Starts discovering services.
`String`	`getDeviceAddr()`	Obtains the MAC address of this `BlePeripheralDevice` object.
`Optional<String>`	`getDeviceName()`	Obtains the name of this `BlePeripheralDevice` object.
`Optional<GattService>`	`getService(UUID uuid)`	Obtains a specified service of the current BLE peripheral device.
`List<GattService>`	`getServices()`	Obtains the list of services of a BLE peripheral device.
`boolean`	`readCharacteristic(GattCharacteristic characteristic)`	Reads the characteristic of a BLE peripheral device.
`boolean`	`readDescriptor(GattDescriptor descriptor)`	Reads the descriptor of a BLE peripheral device.
`boolean`	`readRemoteRssiValue()`	Reads the RSSI value of this BLE peripheral device.
`boolean`	`requestBleConnectionPriority(int connPriority)`	Requests the connection priority of this BLE peripheral device.
`boolean`	`requestBleMtuSize(int mtu)`	Request the mtu size of a BLE peripheral device.
`boolean`	`setNotifyCharacteristic(GattCharacteristic characteristic, boolean enable)`	Enables or disables notification of a characteristic.
`boolean`	`writeCharacteristic(GattCharacteristic characteristic)`	Writes the characteristic of a BLE peripheral device.
`boolean`	`writeDescriptor(GattDescriptor descriptor)`	Writes the descriptor of a BLE peripheral device.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - CONNECTION_PRIORITY_HIGH
```
public static final int CONNECTION_PRIORITY_HIGH
```
    Connection parameter update - Request a high priority, low latency connection. An application should only request high priority connection parameters to transfer large amounts of data over LE quickly. Once the transfer is complete, the application should request CONNECTION_PRIORITY_NORMAL connection parameters to reduce energy use.
    
    另请参阅:
    
    常量字段值
  - CONNECTION_PRIORITY_LOW
```
public static final int CONNECTION_PRIORITY_LOW
```
    Connection parameter update - Request low power, reduced data rate connection parameters.
    
    另请参阅:
    
    常量字段值
  - CONNECTION_PRIORITY_NORMAL
```
public static final int CONNECTION_PRIORITY_NORMAL
```
    Connection parameter update - Use the connection parameters recommended by the Bluetooth SIG. This is the default value if no connection parameter update is requested.
    
    另请参阅:
    
    常量字段值
  - OPERATION_SUCC
```
public static final int OPERATION_SUCC
```
    Indicates that the operation succeeds.
    This constant applies to all operations supported by BLE peripheral devices.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - createInstance
```
public static BlePeripheralDevice createInstance(String address)
```
    Creates a BlePeripheralDevice object with a specified MAC address.
    
    参数:
    
    address - Indicates the MAC address.
    
    返回:
    
    Returns the BlePeripheralDevice object, which can be used to connect to or disconnect from a BLE peripheral device.
    
    从以下版本开始:
    
    5
  - getDeviceAddr
```
public String getDeviceAddr()
```
    Obtains the MAC address of this BlePeripheralDevice object.
    
    返回:
    
    Returns the MAC address.
    
    从以下版本开始:
    
    5
  - connect
```
public boolean connect(boolean isAutoConnect,
                       BlePeripheralCallback callback)
```
    Connects to a BLE peripheral device.
    The BlePeripheralCallback#connectionStateChangeEvent(int) method is called to return the connection result.
    
    参数:
    
    isAutoConnect - Specifies whether to automatically connect to the device.
    
    callback - Indicates the BlePeripheralCallback.
    
    返回:
    
    Returns true if the connection is established; returns false otherwise.
    
    从以下版本开始:
    
    1
  - discoverServices
```
public boolean discoverServices()
```
    Starts discovering services.
    This method is asynchronous. The BlePeripheralCallback#servicesDiscoveredEvent(int) method is called to return the service discovery result.
    
    返回:
    
    Returns true if services are discovered; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getServices
```
public List<GattService> getServices()
```
    Obtains the list of services of a BLE peripheral device.
    Before calling this method, you must call the discoverServices() method to start service discovery and ensure that the BlePeripheralCallback#servicesDiscoveredEvent(int) method is called.
    
    返回:
    
    Returns the list of services of the BLE peripheral device.
    
    从以下版本开始:
    
    1
  - getService
```
public Optional<GattService> getService(UUID uuid)
```
    Obtains a specified service of the current BLE peripheral device.
    
    参数:
    
    uuid - Indicates the UUID of the service.
    
    返回:
    
    Returns Optional if the device supports the service with the specified UUID; returns Optional#empty() otherwise.
    
    从以下版本开始:
    
    1
  - disconnect
```
public boolean disconnect()
```
    Disconnects from or stops an ongoing connection to a BLE peripheral device.
    
    返回:
    
    Returns true if the disconnection process starts; returns false otherwise.
    
    从以下版本开始:
    
    1
  - close
```
public boolean close()
```
    Disables a BLE peripheral device.
    This method deregisters the device and clears the registered callbacks and handles.
    
    返回:
    
    Returns true if the device is disabled; returns false otherwise.
    
    从以下版本开始:
    
    1
  - readCharacteristic
```
public boolean readCharacteristic(GattCharacteristic characteristic)
```
    Reads the characteristic of a BLE peripheral device.
    This method is asynchronous. The BlePeripheralCallback#characteristicReadEvent(GattCharacteristic, int) method is called to return the read result.
    
    参数:
    
    characteristic - Indicates the characteristic to read.
    
    返回:
    
    Returns true if the characteristic is read successfully; returns false otherwise.
    
    从以下版本开始:
    
    1
  - writeCharacteristic
```
public boolean writeCharacteristic(GattCharacteristic characteristic)
```
    Writes the characteristic of a BLE peripheral device.
    This method is asynchronous. The BlePeripheralCallback#characteristicWriteEvent(GattCharacteristic, int) method is called to return the write result.
    
    参数:
    
    characteristic - Indicates the characteristic to write.
    
    返回:
    
    Returns true if the characteristic is written successfully; returns false otherwise.
    
    从以下版本开始:
    
    1
  - setNotifyCharacteristic
```
public boolean setNotifyCharacteristic(GattCharacteristic characteristic,
                                       boolean enable)
```
    Enables or disables notification of a characteristic.
    
    参数:
    
    enable - Specifies whether to enable notification of the characteristic. The value true indicates that notification is enabled, and the value false indicates that notification is disabled.
    
    characteristic - Indicates the characteristic to notify.
    
    返回:
    
    Returns true if notification of the characteristic is enabled or disabled; returns false otherwise.
    
    从以下版本开始:
    
    1
  - readDescriptor
```
public boolean readDescriptor(GattDescriptor descriptor)
```
    Reads the descriptor of a BLE peripheral device.
    The BlePeripheralCallback#descriptorReadEvent(GattDescriptor, int) method is called to return the read result.
    
    参数:
    
    descriptor - Indicates the descriptor to read.
    
    返回:
    
    Returns true if the descriptor is read successfully; returns false otherwise.
    
    从以下版本开始:
    
    1
  - writeDescriptor
```
public boolean writeDescriptor(GattDescriptor descriptor)
```
    Writes the descriptor of a BLE peripheral device.
    The BlePeripheralCallback#descriptorWriteEvent(GattDescriptor, int) method is called to return the write result.
    
    参数:
    
    descriptor - Indicates the descriptor to write.
    
    返回:
    
    Returns true if the descriptor is written successfully; returns false otherwise.
    
    从以下版本开始:
    
    1
  - readRemoteRssiValue
```
public boolean readRemoteRssiValue()
```
    Reads the RSSI value of this BLE peripheral device.
    
    返回:
    
    Returns true if the RSSI value is read; returns false otherwise.
    
    从以下版本开始:
    
    3
  - requestBleConnectionPriority
```
public boolean requestBleConnectionPriority(int connPriority)
```
    Requests the connection priority of this BLE peripheral device.
    Three connection priorities are available: CONNECTION_PRIORITY_NORMAL, CONNECTION_PRIORITY_HIGH, and CONNECTION_PRIORITY_LOW.
    
    参数:
    
    connPriority - Indicates the connection priority to request.
    
    返回:
    
    Returns true if the request is successful; returns false otherwise.
    
    从以下版本开始:
    
    3
  - requestBleMtuSize
```
public boolean requestBleMtuSize(int mtu)
```
    Request the mtu size of a BLE peripheral device.
    
    参数:
    
    mtu - the max size.
    
    返回:
    
    Returns true if the request mtu is successfully; returns false otherwise.
    
    从以下版本开始:
    
    3
  - getDeviceName
```
public Optional<String> getDeviceName()
```
    Obtains the name of this BlePeripheralDevice object.
    
    返回:
    
    Returns a string representation of the name if obtained; returns Optional#empty() if the name fails to be obtained.
    
    从以下版本开始:
    
    5

类 BlePeripheralDevice

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

CONNECTION_PRIORITY_HIGH

CONNECTION_PRIORITY_LOW

CONNECTION_PRIORITY_NORMAL

OPERATION_SUCC

方法详细资料

createInstance

getDeviceAddr

connect

discoverServices

getServices

getService

disconnect

close

readCharacteristic

writeCharacteristic

setNotifyCharacteristic

readDescriptor

writeDescriptor

readRemoteRssiValue

requestBleConnectionPriority

requestBleMtuSize

getDeviceName