Index

A B C D E F G H I J L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractBluetoothObject - Class in com.github.hypfvieh.bluetooth.wrapper
Base class of all bluetooth wrapper object classes.
AbstractBluetoothObject(BluetoothDeviceType, DBusConnection, String) - Constructor for class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject
 
Acquire() - Method in interface org.bluez.HealthChannel1
From bluez documentation:

Returns the file descriptor for this data channel.
Acquire() - Method in interface org.bluez.MediaTransport1
From bluez documentation:

Acquire transport file descriptor and the MTU for read
and write respectively.

AcquireNotify(Map<String, Variant<?>>) - Method in interface org.bluez.GattCharacteristic1
From bluez documentation:

Acquire file descriptor and MTU for notify.
AcquireWrite(Map<String, Variant<?>>) - Method in interface org.bluez.GattCharacteristic1
From bluez documentation:

Acquire file descriptor and MTU for writing.
ADAPTER - Enum constant in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
 
Adapter1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: adapter-api.txt.

Service: org.bluez
Interface: org.bluez.Adapter1

Object path:
[variable prefix]/{hci0,hci1,...}

Supported properties:

string Address [readonly]

The Bluetooth device address.

string AddressType [readonly]

The Bluetooth Address Type.
AddAppKey(DBusPath, UInt16, UInt16, UInt16, boolean) - Method in interface org.bluez.mesh.Node1
From bluez documentation:

This method is used to send add or update network key originated
by the local configuration client to a remote configuration
server.

The element_path parameter is the object path of an element from
a collection of the application elements (see Mesh Application
Hierarchy section).

The destination parameter contains the destination address.
AddNetKey(DBusPath, UInt16, UInt16, UInt16, boolean) - Method in interface org.bluez.mesh.Node1
From bluez documentation:

This method is used to send add or update network key originated
by the local configuration client to a remote configuration
server.

The element_path parameter is the object path of an element from
a collection of the application elements (see Mesh Application
Hierarchy section).

The destination parameter contains the destination address.
AddNode(byte[], Map<String, Variant<?>>) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application that supports
org.bluez.mesh.Provisioner1 interface to add the
unprovisioned device specified by uuid, to the Network.

The uuid parameter is a 16-byte array that contains Device UUID
of the unprovisioned device to be added to the network.

The options parameter is a dictionary that may contain
additional configuration info (currently an empty placeholder
for forward compatibility).

AddNodeComplete(byte[], UInt16, byte) - Method in interface org.bluez.mesh.Provisioner1
From bluez documentation:

This method is called when the node provisioning initiated
by an AddNode() method call successfully completed.

The unicast parameter is the primary address that has been
assigned to the new node, and the address of it's config server.

The count parameter is the number of unicast addresses assigned
to the new node.

The new node may now be sent messages using the credentials
supplied by the RequestProvData method.

AddNodeFailed(byte[], String) - Method in interface org.bluez.mesh.Provisioner1
From bluez documentation:

This method is called when the node provisioning initiated by
AddNode() has failed.
AddtoNowPlaying() - Method in interface org.bluez.MediaItem1
From bluez documentation:

Add item to now playing list

AGENT - Enum constant in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
 
AGENT_MANAGER - Enum constant in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
 
Agent1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: agent-api.txt.

Service: unique name
Interface: org.bluez.Agent1

Object path:
freely definable

Agent1 - Interface in org.bluez.obex
File generated - 2023-02-20.
Based on bluez Documentation: obex-agent-api.txt.

Service: unique name
Interface: org.bluez.obex.Agent1

Object path:
freely definable

AgentChangeListener - Interface in com.github.hypfvieh.bluetooth.wrapper
 
AgentHandler - Class in com.github.hypfvieh.bluetooth.wrapper
 
AgentHandler(String, DBusConnection, AgentChangeListener) - Constructor for class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
AgentManager - Class in com.github.hypfvieh.bluetooth.wrapper
 
AgentManager(DBusConnection) - Constructor for class com.github.hypfvieh.bluetooth.wrapper.AgentManager
 
AgentManager1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: agent-api.txt.

Service: org.bluez
Interface: org.bluez.AgentManager1

Object path:
/org/bluez

AgentManager1 - Interface in org.bluez.obex
File generated - 2023-02-20.
Based on bluez Documentation: obex-agent-api.txt.

Service: org.bluez.obex
Interface: org.bluez.obex.AgentManager1

Object path:
/org/bluez/obex

Application1 - Interface in org.bluez.mesh
File generated - 2023-02-20.
Based on bluez Documentation: mesh-api.txt.

Service: unique name
Interface: org.bluez.mesh.Application1

Object path:
<app_root>

Supported properties:

:

A 16-bit Bluetooth-assigned Company Identifier of the vendor as
defined by Bluetooth SIG


A 16-bit vendor-assigned product identifier


A 16-bit vendor-assigned product version identifier


A 16-bit minimum number of replay protection list entries



applyXpathExpressionToDocument(String, Node) - Static method in class com.github.hypfvieh.XmlHelper
Use an Xpath expression on the given node or document.
Attach(DBusPath, UInt64) - Method in interface org.bluez.mesh.Network1
From bluez documentation:

This is the first method that an application must call to get
access to mesh node functionalities.

The app_root parameter is a D-Bus object root path of
the application that implements org.bluez.mesh.Application1
interface.
Attention1 - Interface in org.bluez.mesh
File generated - 2023-02-20.
Based on bluez Documentation: mesh-api.txt.

Service: unique name
Interface: org.bluez.mesh.Attention1

Object path:
freely definable

AuthorizePush(DBusPath) - Method in interface org.bluez.obex.Agent1
From bluez documentation:

This method gets called when the service daemon
needs to accept/reject a Bluetooth object push request.

Returns the full path (including the filename) where
the object shall be stored.
AuthorizeService(DBusPath, String) - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
AuthorizeService(DBusPath, String) - Method in interface org.bluez.Agent1
From bluez documentation:

This method gets called when the service daemon
needs to authorize a connection/service request.

AUTO - Enum constant in enum class com.github.hypfvieh.bluetooth.DiscoveryTransport
"auto" - interleaved scan, default value

B

BATTERY - Enum constant in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
 
Battery1 - Interface in org.bluez
File generated - 2020-06-18.
Based on bluez Documentation: battery-api.txt.

Service: org.bluez
Interface: org.bluez.Battery1

Object path:
[variable prefix]/{hci0,hci1,...}
BluetoothAdapter - Class in com.github.hypfvieh.bluetooth.wrapper
Wrapper class which represents an bluetooth adapter.
BluetoothAdapter(Adapter1, String, DBusConnection) - Constructor for class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
 
BluetoothBattery - Class in com.github.hypfvieh.bluetooth.wrapper
Wrapper class which represents the battery of a remote bluetooth device.
BluetoothBattery(Battery1, BluetoothDevice, String, DBusConnection) - Constructor for class com.github.hypfvieh.bluetooth.wrapper.BluetoothBattery
 
BluetoothDevice - Class in com.github.hypfvieh.bluetooth.wrapper
Wrapper class which represents a remote bluetooth device.
BluetoothDevice(Device1, BluetoothAdapter, String, DBusConnection) - Constructor for class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
 
BluetoothDeviceType - Enum Class in com.github.hypfvieh.bluetooth.wrapper
Bluetooth device ObjectType identifier.
BluetoothGattCharacteristic - Class in com.github.hypfvieh.bluetooth.wrapper
Wrapper class which represents a GATT characteristic on a remote device.
BluetoothGattCharacteristic(GattCharacteristic1, BluetoothGattService, String, DBusConnection) - Constructor for class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
 
BluetoothGattDescriptor - Class in com.github.hypfvieh.bluetooth.wrapper
Wrapper class which represents a GATT descriptor on a remote device.
BluetoothGattDescriptor(GattDescriptor1, BluetoothGattCharacteristic, String, DBusConnection) - Constructor for class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattDescriptor
 
BluetoothGattService - Class in com.github.hypfvieh.bluetooth.wrapper
Wrapper class which represents a GATT service provided by a remote device.
BluetoothGattService(GattService1, BluetoothDevice, String, DBusConnection) - Constructor for class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattService
 
BluezAlreadyConnectedException - Exception Class in org.bluez.exceptions
 
BluezAlreadyConnectedException(String) - Constructor for exception class org.bluez.exceptions.BluezAlreadyConnectedException
 
BluezAlreadyExistsException - Exception Class in org.bluez.exceptions
 
BluezAlreadyExistsException(String) - Constructor for exception class org.bluez.exceptions.BluezAlreadyExistsException
 
BluezAuthenticationCanceledException - Exception Class in org.bluez.exceptions
 
BluezAuthenticationCanceledException(String) - Constructor for exception class org.bluez.exceptions.BluezAuthenticationCanceledException
 
BluezAuthenticationFailedException - Exception Class in org.bluez.exceptions
 
BluezAuthenticationFailedException(String) - Constructor for exception class org.bluez.exceptions.BluezAuthenticationFailedException
 
BluezAuthenticationRejectedException - Exception Class in org.bluez.exceptions
 
BluezAuthenticationRejectedException(String) - Constructor for exception class org.bluez.exceptions.BluezAuthenticationRejectedException
 
BluezAuthenticationTimeoutException - Exception Class in org.bluez.exceptions
 
BluezAuthenticationTimeoutException(String) - Constructor for exception class org.bluez.exceptions.BluezAuthenticationTimeoutException
 
BluezCanceledException - Exception Class in org.bluez.exceptions
 
BluezCanceledException(String) - Constructor for exception class org.bluez.exceptions.BluezCanceledException
 
BluezConnectFailedException - Exception Class in org.bluez.exceptions
 
BluezConnectFailedException(String) - Constructor for exception class org.bluez.exceptions.BluezConnectFailedException
 
BluezConnectionAttemptFailedException - Exception Class in org.bluez.exceptions
 
BluezConnectionAttemptFailedException(String) - Constructor for exception class org.bluez.exceptions.BluezConnectionAttemptFailedException
 
BluezDoesNotExistException - Exception Class in org.bluez.exceptions
 
BluezDoesNotExistException(String) - Constructor for exception class org.bluez.exceptions.BluezDoesNotExistException
 
BluezFailedException - Exception Class in org.bluez.exceptions
 
BluezFailedException(String) - Constructor for exception class org.bluez.exceptions.BluezFailedException
 
BluezForbiddenException - Exception Class in org.bluez.exceptions
 
BluezForbiddenException(String) - Constructor for exception class org.bluez.exceptions.BluezForbiddenException
 
BluezHealthErrorException - Exception Class in org.bluez.exceptions
 
BluezHealthErrorException(String) - Constructor for exception class org.bluez.exceptions.BluezHealthErrorException
 
BluezInNotAllowedException - Exception Class in org.bluez.exceptions
 
BluezInNotAllowedException(String) - Constructor for exception class org.bluez.exceptions.BluezInNotAllowedException
 
BluezInProgressException - Exception Class in org.bluez.exceptions
 
BluezInProgressException(String) - Constructor for exception class org.bluez.exceptions.BluezInProgressException
 
BluezInvalidArgumentsException - Exception Class in org.bluez.exceptions
 
BluezInvalidArgumentsException(String) - Constructor for exception class org.bluez.exceptions.BluezInvalidArgumentsException
 
BluezInvalidLengthException - Exception Class in org.bluez.exceptions
 
BluezInvalidLengthException(String) - Constructor for exception class org.bluez.exceptions.BluezInvalidLengthException
 
BluezInvalidOffsetException - Exception Class in org.bluez.exceptions
 
BluezInvalidOffsetException(String) - Constructor for exception class org.bluez.exceptions.BluezInvalidOffsetException
 
BluezInvalidValueLengthException - Exception Class in org.bluez.exceptions
 
BluezInvalidValueLengthException(String) - Constructor for exception class org.bluez.exceptions.BluezInvalidValueLengthException
 
BluezMeshAbortException - Exception Class in org.bluez.exceptions.mesh
 
BluezMeshAbortException(String) - Constructor for exception class org.bluez.exceptions.mesh.BluezMeshAbortException
 
BluezMeshAlreadyExistsException - Exception Class in org.bluez.exceptions.mesh
 
BluezMeshAlreadyExistsException(String) - Constructor for exception class org.bluez.exceptions.mesh.BluezMeshAlreadyExistsException
 
BluezMeshBusyException - Exception Class in org.bluez.exceptions.mesh
 
BluezMeshBusyException(String) - Constructor for exception class org.bluez.exceptions.mesh.BluezMeshBusyException
 
BluezMeshDoesNotExistException - Exception Class in org.bluez.exceptions.mesh
 
BluezMeshDoesNotExistException(String) - Constructor for exception class org.bluez.exceptions.mesh.BluezMeshDoesNotExistException
 
BluezMeshFailedException - Exception Class in org.bluez.exceptions.mesh
 
BluezMeshFailedException(String) - Constructor for exception class org.bluez.exceptions.mesh.BluezMeshFailedException
 
BluezMeshInProgressException - Exception Class in org.bluez.exceptions.mesh
 
BluezMeshInProgressException(String) - Constructor for exception class org.bluez.exceptions.mesh.BluezMeshInProgressException
 
BluezMeshInvalidArgumentsException - Exception Class in org.bluez.exceptions.mesh
 
BluezMeshInvalidArgumentsException(String) - Constructor for exception class org.bluez.exceptions.mesh.BluezMeshInvalidArgumentsException
 
BluezMeshNotAuthorizedException - Exception Class in org.bluez.exceptions.mesh
 
BluezMeshNotAuthorizedException(String) - Constructor for exception class org.bluez.exceptions.mesh.BluezMeshNotAuthorizedException
 
BluezMeshNotFoundException - Exception Class in org.bluez.exceptions.mesh
 
BluezMeshNotFoundException(String) - Constructor for exception class org.bluez.exceptions.mesh.BluezMeshNotFoundException
 
BluezMeshNotSupportedException - Exception Class in org.bluez.exceptions.mesh
 
BluezMeshNotSupportedException(String) - Constructor for exception class org.bluez.exceptions.mesh.BluezMeshNotSupportedException
 
BluezNotAcquiredException - Exception Class in org.bluez.exceptions
 
BluezNotAcquiredException(String) - Constructor for exception class org.bluez.exceptions.BluezNotAcquiredException
 
BluezNotAllowedException - Exception Class in org.bluez.exceptions
 
BluezNotAllowedException(String) - Constructor for exception class org.bluez.exceptions.BluezNotAllowedException
 
BluezNotAuthorizedException - Exception Class in org.bluez.exceptions
 
BluezNotAuthorizedException(String) - Constructor for exception class org.bluez.exceptions.BluezNotAuthorizedException
 
BluezNotAvailableException - Exception Class in org.bluez.exceptions
 
BluezNotAvailableException(String) - Constructor for exception class org.bluez.exceptions.BluezNotAvailableException
 
BluezNotConnectedException - Exception Class in org.bluez.exceptions
 
BluezNotConnectedException(String) - Constructor for exception class org.bluez.exceptions.BluezNotConnectedException
 
BluezNotFoundException - Exception Class in org.bluez.exceptions
 
BluezNotFoundException(String) - Constructor for exception class org.bluez.exceptions.BluezNotFoundException
 
BluezNotImplementedException - Exception Class in org.bluez.exceptions
 
BluezNotImplementedException(String) - Constructor for exception class org.bluez.exceptions.BluezNotImplementedException
 
BluezNotInProgressException - Exception Class in org.bluez.exceptions
 
BluezNotInProgressException(String) - Constructor for exception class org.bluez.exceptions.BluezNotInProgressException
 
BluezNotPermittedException - Exception Class in org.bluez.exceptions
 
BluezNotPermittedException(String) - Constructor for exception class org.bluez.exceptions.BluezNotPermittedException
 
BluezNotReadyException - Exception Class in org.bluez.exceptions
 
BluezNotReadyException(String) - Constructor for exception class org.bluez.exceptions.BluezNotReadyException
 
BluezNotSupportedException - Exception Class in org.bluez.exceptions
 
BluezNotSupportedException(String) - Constructor for exception class org.bluez.exceptions.BluezNotSupportedException
 
BluezOutOfRangeException - Exception Class in org.bluez.exceptions
 
BluezOutOfRangeException(String) - Constructor for exception class org.bluez.exceptions.BluezOutOfRangeException
 
BluezRejectedException - Exception Class in org.bluez.exceptions
 
BluezRejectedException(String) - Constructor for exception class org.bluez.exceptions.BluezRejectedException
 
BREDR - Enum constant in enum class com.github.hypfvieh.bluetooth.DiscoveryTransport
"bredr" - BR/EDR inquiry
byteListToByteArray(List<?>) - Method in class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject
 

C

Cancel() - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
Cancel() - Method in interface org.bluez.Agent1
From bluez documentation:

This method gets called to indicate that the agent
request failed before a reply was returned.
Cancel() - Method in interface org.bluez.mesh.Network1
From bluez documentation:

Cancels an outstanding provisioning request initiated by Join()
method.

Cancel() - Method in interface org.bluez.mesh.ProvisionAgent1
From bluez documentation:

This method gets called by the daemon to cancel any existing
Agent Requests.
Cancel() - Method in interface org.bluez.obex.Agent1
From bluez documentation:

This method gets called to indicate that the agent
request failed before a reply was returned.
Cancel() - Method in interface org.bluez.obex.Transfer1
From bluez documentation:

Stops the current transference.

cancelPairing() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
CancelPairing() - Method in interface org.bluez.Device1
From bluez documentation:

This method can be used to cancel a pairing
operation initiated by the Pair method.

ChangeFolder(String) - Method in interface org.bluez.obex.FileTransfer
From bluez documentation:

Change the current folder of the remote device.

ChangeFolder(DBusPath) - Method in interface org.bluez.MediaFolder1
From bluez documentation:

Change current folder.

Note: By changing folder the items of previous folder
might be destroyed and have to be listed again, the
exception is NowPlaying folder which should be always
present while the player is active.

ChannelConnected(String, DBusPath) - Constructor for class org.bluez.HealthDevice1.ChannelConnected
 
ChannelDeleted(String, DBusPath) - Constructor for class org.bluez.HealthDevice1.ChannelDeleted
 
ClearConfiguration(DBusPath) - Method in interface org.bluez.MediaEndpoint1
From bluez documentation:

Clear transport configuration.

Client1 - Interface in org.bluez.obex
File generated - 2023-02-20.
Based on bluez Documentation: obex-api.txt.

Service: org.bluez.obex
Interface: org.bluez.obex.Client1

Object path:
/org/bluez/obex

closeConnection() - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Close current connection.
com.github.hypfvieh - package com.github.hypfvieh
 
com.github.hypfvieh.bluetooth - package com.github.hypfvieh.bluetooth
 
com.github.hypfvieh.bluetooth.wrapper - package com.github.hypfvieh.bluetooth.wrapper
 
Confirm() - Method in interface org.bluez.GattCharacteristic1
From bluez documentation:

This method doesn't expect a reply so it is just a
confirmation that value was received.

connect() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
Connect() - Method in interface org.bluez.Device1
From bluez documentation:

This is a generic method to connect any profiles
the remote device supports that can be connected
to and have been flagged as auto-connectable on
our side.
Connect(String) - Method in interface org.bluez.Network1
From bluez documentation:

Connect to the network device and return the network
interface name.
ConnectDevice(Map<String, Variant<?>>) - Method in interface org.bluez.Adapter1
From bluez documentation:

This method connects to device without need of
performing General Discovery.
connectProfile(String) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
ConnectProfile(String) - Method in interface org.bluez.Device1
From bluez documentation:

This method connects a specific profile of this
device.
CopyFile(String, String) - Method in interface org.bluez.obex.FileTransfer
From bluez documentation:

Copy a file within the remote device from source file
to target file.

CreateAppKey(UInt16, UInt16) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application to generate and add a new
application key.

The net_index parameter is a 12-bit value (0x000-0xFFF)
specifying which net key to bind the application key to.

The app_index parameter is a 12-bit value (0x000-0xFFF)
specifying which app key to add.

This call affects the local bluetooth-meshd key database only.

CreateApplication(Map<String, Variant<?>>) - Method in interface org.bluez.HealthManager1
From bluez documentation:

Returns the path of the new registered application.
Application will be closed by the call or implicitly
when the programs leaves the bus.

config:
uint16 DataType:

Mandatory

string Role:

Mandatory.
CreateChannel(DBusPath, String) - Method in interface org.bluez.HealthDevice1
From bluez documentation:

Creates a new data channel.
CreateFolder(String) - Method in interface org.bluez.obex.FileTransfer
From bluez documentation:

Create a new folder in the remote device.

createInstance(boolean) - Static method in class com.github.hypfvieh.bluetooth.DeviceManager
Create a new DeviceManager using the UnixDomainSockets and use either the global SYSTEM interface or create a new interface just for this session (if _sessionConnection = true).
createInstance(String) - Static method in class com.github.hypfvieh.bluetooth.DeviceManager
Create a new DeviceManager instance using the given DBus address (e.g. tcp://127.0.0.1:13245)
CreateNetwork(DBusPath, byte[]) - Method in interface org.bluez.mesh.Network1
From bluez documentation:

This is the first method that an application calls to become
a Provisioner node, and a Configuration Client on a newly
created Mesh Network.

The app_root parameter is a D-Bus object root path of the
application that implements org.bluez.mesh.Application1
interface, and a org.bluez.mesh.Provisioner1 interface.
CreateSession(String, Map<String, Variant<?>>) - Method in interface org.bluez.obex.Client1
From bluez documentation:

Create a new OBEX session for the given remote address.

The last parameter is a dictionary to hold optional or
type-specific parameters.
CreateSubnet(UInt16) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application to generate and add a new
network subnet key.

The net_index parameter is a 12-bit value (0x001-0xFFF)
specifying which net key to add.

This call affects the local bluetooth-meshd key database only.

D

DbusHelper - Class in com.github.hypfvieh
Various DBUS related helper methods.
Delete(String) - Method in interface org.bluez.obex.FileTransfer
From bluez documentation:

Deletes the specified file/folder.

DeleteAppKey(UInt16) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application to delete an application
key.

The app_index parameter is a 12-bit value (0x000-0xFFF)
specifying which app key to delete.

This call affects the local bluetooth-meshd key database only.

DeleteRemoteNode(UInt16, byte) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application to delete a remote node
from the local device key database.

The primary parameter specifies the unicast address of the
the node being deleted.

The count parameter specifies the number of elements that were
assigned to the remote node.

This call affects the local bluetooth-meshd key database only.

It is an error to call this with address range overlapping
with local element addresses.

DeleteSubnet(UInt16) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application that to delete a subnet.

The net_index parameter is a 12-bit value (0x001-0xFFF)
specifying which net key to delete.
DestroyApplication(DBusPath) - Method in interface org.bluez.HealthManager1
From bluez documentation:

Closes the HDP application identified by the object
path.
DestroyChannel(DBusPath) - Method in interface org.bluez.HealthDevice1
From bluez documentation:

Destroys the data channel object.
DEVICE - Enum constant in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
 
Device1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: device-api.txt.

Service: org.bluez
Interface: org.bluez.Device1

Object path:
[variable prefix]/{hci0,hci1,...}
DeviceManager - Class in com.github.hypfvieh.bluetooth
The 'main' class to get access to all DBus/bluez related objects.
DevKeyMessageReceived(UInt16, boolean, UInt16, byte[]) - Method in interface org.bluez.mesh.Element1
From bluez documentation:

This method is called by meshd daemon when a message arrives
addressed to the application, which was sent with the remote
node's device key.

The source parameter is unicast address of the remote
node-element that sent the message.

The remote parameter if true indicates that the device key
used to decrypt the message was from the sender.
DevKeySend(DBusPath, UInt16, boolean, UInt16, Map<String, Variant<?>>, byte[]) - Method in interface org.bluez.mesh.Node1
From bluez documentation:

This method is used to send a message originated by a local
model encoded with the device key of the remote node.

The element_path parameter is the object path of an element from
a collection of the application elements (see Mesh Application
Hierarchy section).

The destination parameter contains the destination address.
DisableIntermediateMeasurement(DBusPath) - Method in interface org.bluez.ThermometerManager1
From bluez documentation:

Disables intermediate measurement notifications
for this agent.
disconnect() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
Disconnect() - Method in interface org.bluez.Device1
From bluez documentation:

This method gracefully disconnects all connected
profiles and then terminates low-level ACL connection.

ACL connection will be terminated even if some profiles
were not disconnected properly e.g. due to misbehaving
device.

This method can be also used to cancel a preceding
Connect call before a reply to it has been received.

For non-trusted devices connected over LE bearer calling
this method will disable incoming connections until
Connect method is called again.

Disconnect() - Method in interface org.bluez.Network1
From bluez documentation:

Disconnect from the network device.

To abort a connection attempt in case of errors or
timeouts in the client it is fine to call this method.

Disconnect() - Method in interface org.bluez.SimAccess1
From bluez documentation:

Disconnects SAP client from the server.

disconnectProfile(String) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
DisconnectProfile(String) - Method in interface org.bluez.Device1
From bluez documentation:

This method disconnects a specific profile of
this device.
DiscoveryFilter - Enum Class in com.github.hypfvieh.bluetooth
Supported discovery filter values.
DiscoveryTransport - Enum Class in com.github.hypfvieh.bluetooth
Supported DiscoveryTransport values.
DisplayNumeric(String, UInt32) - Method in interface org.bluez.mesh.ProvisionAgent1
From bluez documentation:

This method is called when the Daemon has something important
for the Agent to Display, but does not require any additional
input locally.
DisplayPasskey(DBusPath, UInt32, UInt16) - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
DisplayPasskey(DBusPath, UInt32, UInt16) - Method in interface org.bluez.Agent1
From bluez documentation:

This method gets called when the service daemon
needs to display a passkey for an authentication.

The entered parameter indicates the number of already
typed keys on the remote side.

An empty reply should be returned.
DisplayPinCode(DBusPath, String) - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
DisplayPinCode(DBusPath, String) - Method in interface org.bluez.Agent1
From bluez documentation:

This method gets called when the service daemon
needs to display a pincode for an authentication.

An empty reply should be returned.
DisplayString(String) - Method in interface org.bluez.mesh.ProvisionAgent1
/** From bluez documentation:

This method is called when the Daemon has something important
for the Agent to Display, but does not require any additional
input locally.
DuplicateData - Enum constant in enum class com.github.hypfvieh.bluetooth.DiscoveryFilter
 

E

Echo() - Method in interface org.bluez.HealthDevice1
From bluez documentation:

Sends an echo petition to the remote service.
Element1 - Interface in org.bluez.mesh
File generated - 2023-02-20.
Based on bluez Documentation: mesh-api.txt.

Service: unique name
Interface: org.bluez.mesh.Element1

Object path:
<app_defined_element_path>

Supported properties:

:

Element index.
EnableIntermediateMeasurement(DBusPath) - Method in interface org.bluez.ThermometerManager1
From bluez documentation:

Enables intermediate measurement notifications
for this agent.
ExchangeBusinessCards(String, String) - Method in interface org.bluez.obex.ObjectPush1
From bluez documentation:

Push the client's business card to the remote device
and then retrieve the remote business card and store
it in a local file.

If an empty target file is given, a name will be
automatically calculated for the temporary file.

The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.

The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.

ExportKeys() - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application to export information
about network keys, application keys and device keys present
in the local key database.

dict
A dictionary that contains information for the keys
stored in the keyring with the following keys defined:

NetKeys:
array{struct} net_keys:

uint16 index
Subnet index

array{byte}[16] key

dict:
A dictionary that contains optional
key info with the following keys
defined:

uint8 Phase
Key Refresh phase of the subnet

array{byte}[16] OldKey

array{struct} AppKeys:

uint16 index

Application key index

array{byte}[16] key

dict:
A dictionary of optional
key info with the
following keys defined:

array{byte}[16] OldKey

DevKeys:
array{struct} dev_keys:

Device Key information for known remote
nodes in the configured Mesh network

uint16 unicast

Unicast address of the node's primary
element

array{byte}[16] key

F

FastForward() - Method in interface org.bluez.MediaControl1
Deprecated.
FastForward() - Method in interface org.bluez.MediaPlayer1
From bluez documentation:

Fast forward playback, this action is only stopped
when another method in this interface is called.

FileTransfer - Interface in org.bluez.obex
File generated - 2023-02-20.
Based on bluez Documentation: obex-api.txt.

Service: org.bluez.obex
Interface: org.bluez.obex.FileTransfer

Object path:
[Session object path]

findBtDevicesByIntrospection(BluetoothAdapter) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Gets all devices found by the given adapter and published by bluez using DBus Introspection API.
findNodes(DBusConnection, String) - Static method in class com.github.hypfvieh.DbusHelper
Find all <node>-Elements in DBUS Introspection XML and extracts the value of the 'name' attribute.

G

GATT_CHARACTERISTIC - Enum constant in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
 
GATT_DESCRIPTOR - Enum constant in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
 
GATT_SERVICE - Enum constant in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
 
GattCharacteristic1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: gatt-api.txt.

Service: org.bluez
Interface: org.bluez.GattCharacteristic1

Object path:
[variable prefix]/{hci0,hci1,...}
GattDescriptor1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: gatt-api.txt.

Service: org.bluez
Interface: org.bluez.GattDescriptor1

Object path:
[variable prefix]/{hci0,hci1,...}
GattManager1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: gatt-api.txt.

Service: org.bluez
Interface: org.bluez.GattManager1

Object path:
[variable prefix]/{hci0,hci1,...}

GATT Manager hierarchy
======================

GATT Manager allows external applications to register GATT services and
profiles.

Registering a profile allows applications to subscribe to *remote* services.
These must implement the GattProfile1 interface defined above.

Registering a service allows applications to publish a *local* GATT service,
which then becomes available to remote devices.
GattProfile1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: gatt-api.txt.

Service: <application dependent>
Interface: org.bluez.GattProfile1

Object path:
<application dependent>

Supported properties:

array{string} UUIDs [read-only]

128-bit GATT service UUIDs to auto connect.



GattService1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: gatt-api.txt.

Service: org.bluez
Interface: org.bluez.GattService1

Object path:
[variable prefix]/{hci0,hci1,...}
Get(String, boolean) - Method in interface org.bluez.obex.Message1
From bluez documentation:

Download message and store it in the target file.

If an empty target file is given, a temporary file
will be automatically generated.

The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.

The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.

getAdapter() - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Get the current adapter in use.
getAdapter() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
Get BluetoothAdapter object where this BluetoothDevice object belongs to.
getAdapter(String) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Find an adapter by the given identifier (either MAC or device name).
getAdapters() - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Returns all found bluetooth adapters.
getAddress() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Returns the bluetooth device (MAC) address.
getAddress() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
Returns the remote devices bluetooth (MAC) address.
getAdvertisingFlags() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
The Advertising Data Flags of the remote device.
EXPERIMENTAL
getAlias() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
The changeable bluetooth friendly name.
getAlias() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
The current name alias for the remote device.
getAppearance() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
getBluetoothClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
getBluetoothType() - Method in class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject
 
GetCapabilities() - Method in interface org.bluez.obex.Session1
From bluez documentation:

Get remote device capabilities.

getChannel() - Method in class org.bluez.HealthDevice1.ChannelConnected
 
getChannel() - Method in class org.bluez.HealthDevice1.ChannelDeleted
 
getCharacteristic() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattDescriptor
Get the BluetoothGattCharacteristic instance behind this BluetoothGattDescriptor object.
getDbusConnection() - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Get the DBusConnection provided in constructor.
getDbusConnection() - Method in class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject
 
getDbusPath() - Method in class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject
 
getDevice() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothBattery
Get BluetoothDevice object where this BluetoothBattery object belongs to.
getDevice() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattService
Get the BluetoothDevice instance which is providing this BluetoothGattService.
getDeviceClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
From bluez Documentation:
getDeviceName() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Get the deviceName used in DBus (e.g. hci0).
getDevices() - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Get all bluetooth devices connected to the defaultAdapter.
getDevices(boolean) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Get all bluetooth devices connected to the defaultAdapter.
getDevices(String) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Get all bluetooth devices connected to the adapter with the given MAC address.
getDevices(String, boolean) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Get all bluetooth devices connected to the adapter with the given MAC address.
getDiscoverableTimeout() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
The current timeout (in seconds) configured before disabling discoverbility.
If 0 discoverbility will never be disabled automatically.
GetDiscoveryFilters() - Method in interface org.bluez.Adapter1
From bluez documentation:

Return available filters that can be given to
SetDiscoveryFilter.

GetFile(String, String) - Method in interface org.bluez.obex.FileTransfer
From bluez documentation:

Copy the source file (from remote device) to the
target file (on local filesystem).

If an empty target file is given, a name will be
automatically calculated for the temporary file.

The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.

The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.

getFirstValue() - Method in class org.bluez.datatypes.ThreeTuple
 
getFirstValue() - Method in class org.bluez.datatypes.TwoTuple
 
getFlags() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
From bluez Documentation:
getFlags() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattDescriptor
From bluez Documentation:
getGattCharacteristicByUuid(String) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattService
Return the BluetoothGattCharacteristic object for the given UUID.
getGattCharacteristics() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattService
Get the currently available GATT characteristics.
Will issue a query if BluetoothGattService.refreshGattCharacteristics() wasn't called before.
getGattDescriptorByUuid(String) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
Return the BluetoothGattDescriptor object for the given UUID.
getGattDescriptors() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
Get the currently available GATT descriptors.
Will issue a query if BluetoothGattCharacteristic.refreshGattDescriptors() wasn't called before.
getGattServiceByUuid(String) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
Get the given BluetoothGattService instance by UUID.
getGattServices() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
Return the list of available BluetoothGattServices.
Will start a query if no list was gathered before.
To re-scan for services use BluetoothDevice.refreshGattServices().
getIcon() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
getIncludes() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattService
From bluez Documentation:
getInstance() - Static method in class com.github.hypfvieh.bluetooth.DeviceManager
Get the created instance.
getInterfaceClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject
DBus-Interface class used in this wrapper object.
getInterfaceClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
getInterfaceClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentManager
 
getInterfaceClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
DBus-Interface class used in this wrapper object.
getInterfaceClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothBattery
DBus-Interface class used in this wrapper object.
getInterfaceClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
DBus-Interface class used in this wrapper object.
getInterfaceClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
DBus-Interface class used in this wrapper object.
getInterfaceClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattDescriptor
DBus-Interface class used in this wrapper object.
getInterfaceClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattService
DBus-Interface class used in this wrapper object.
getInterfaceClass() - Method in class com.github.hypfvieh.bluetooth.wrapper.ProfileManager
 
getManufacturerData() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
getModAlias() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
From bluez Documentation:
getModAlias() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
getName() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
From bluez Documentation:
getName() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
Get the bluetooth device name.
This may fail if you not connected to the device, or if the device does not support this operation.
If no name could be retrieved, the alias will be used.

From bluez Documentation:
getObjectPath() - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
getObjectPath() - Method in class com.github.hypfvieh.bluetooth.wrapper.ProfileHandler
 
getPairableTimeout() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Current configured timeout (in seconds) before the pairable mode is disabled.
If 0, timeout is disabled and pairability will never be disabled.
getPercentage() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothBattery
From bluez Documentation:
GetPhonebook(String) - Method in interface org.bluez.obex.Synchronization1
From bluez documentation:

Retrieve an entire Phonebook Object store from remote
device, and stores it in a local file.

If an empty target file is given, a name will be
automatically calculated for the temporary file.

The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.

The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.

getRawAdapter() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Get the raw Adapter1 object wrapped by this BluetoothAdapter object.
getRawBattery() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothBattery
Get the raw Battery1 object wrapped by this BluetoothBattery object.
getRawCharacteric() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattDescriptor
Get the raw GattDescriptor1 object behind this wrapper.
getRawDevice() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
Get the raw Device1 object wrapped by this BluetoothDevice object.
getRawGattCharacteristic() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
Get the raw GattCharacteristic1 object behind this wrapper.
getRemoteObject(DBusConnection, String, Class<T>) - Static method in class com.github.hypfvieh.DbusHelper
Creates an java object from a bluez dbus response.
getRemoteObjects(Set<String>, String, Class<T>) - Method in class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject
Helper to get remote objects from DBus.
getRssi() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
getSecondValue() - Method in class org.bluez.datatypes.ThreeTuple
 
getSecondValue() - Method in class org.bluez.datatypes.TwoTuple
 
getService() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
Returns the BluetoothGattService object which provides this BluetoothGattCharacteristic.
getService() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattService
Get the raw GattService1 object.
getServiceData() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
GetSize() - Method in interface org.bluez.obex.PhonebookAccess1
From bluez documentation:

Return the number of entries in the selected phonebook
object that are actually used (i.e. indexes that
correspond to non-NULL entries).

getThirdValue() - Method in class org.bluez.datatypes.ThreeTuple
 
GetTimer(UInt16) - Method in interface org.bluez.mesh.Attention1
From bluez documentation:

The element parameter is the unicast address within the node
where the health server model is hosted.

Returns the number of seconds for how long the attention action
remains staying on.
getTxPower() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
getTyped(String, Class<T>) - Method in class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject
Helper to get a value of a DBus property.
getUuid() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
From bluez Documentation:
getUuid() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattDescriptor
From bluez Documentation:
getUuid() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattService
From bluez Documentation:
getUuids() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
From bluez Documentation:
getUuids() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
getValue() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
From bluez Documentation:
getValue() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattDescriptor
From bluez Documentation:
getValueClass() - Method in enum class com.github.hypfvieh.bluetooth.DiscoveryFilter
 

H

HealthChannel1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: health-api.txt.

Service: org.bluez
Interface: org.bluez.HealthChannel1

Object path:
[variable prefix]/{hci0,hci1,...}
HealthDevice1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: health-api.txt.

Service: org.bluez
Interface: org.bluez.HealthDevice1

Object path:
[variable prefix]/{hci0,hci1,...}
HealthDevice1.ChannelConnected - Class in org.bluez
This signal is launched when a new data channel is
created or when a known data channel is reconnected.
HealthDevice1.ChannelDeleted - Class in org.bluez
This signal is launched when a data channel is deleted.
After this signal the data channel path will not be
valid and its path can be reused for future data
channels.
HealthManager1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: health-api.txt.

Service: org.bluez
Interface: org.bluez.HealthManager1

Object path:
/org/bluez/

Hold(byte) - Method in interface org.bluez.MediaPlayer1
From bluez documentation:

Press and hold a specific key to send as passthrough
command.

I

Import(DBusPath, byte[], byte[], byte[], UInt16, Map<String, Variant<?>>, UInt32, UInt16) - Method in interface org.bluez.mesh.Network1
From bluez documentation:

This method creates a local mesh node based on node configuration that has been generated outside bluetooth-meshd.
ImportAppKey(UInt16, UInt16, byte[]) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application to add an application
key, that was originally generated by a remote Config Client.

The net_index parameter is a 12-bit value (0x000-0xFFF)
specifying which net key to bind the application key to.

The app_index parameter is a 12-bit value (0x000-0xFFF)
specifying which app key to import.

The app_key parameter is the 16-byte value of the key being
imported.

This call affects the local bluetooth-meshd key database only.

ImportRemoteNode(UInt16, byte, byte[]) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application to import a remote node
that has been provisioned by an external process.

The primary parameter specifies the unicast address of the
the node being imported.

The count parameter specifies the number of elements that are
assigned to this remote node.

The device_key parameter is the access layer key that will be
will used to decrypt privledged messages from this remote node.

This call affects the local bluetooth-meshd key database only.

It is an error to call this with address range overlapping
with local element addresses.

ImportSubnet(UInt16, byte[]) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application to add a network subnet
key, that was originally generated by a remote Config Client.

The net_index parameter is a 12-bit value (0x000-0xFFF)
specifying which net key to add.

The net_key parameter is the 16-byte value of the net key being
imported.

This call affects the local bluetooth-meshd key database only.

Input1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: input-api.txt.

Service: org.bluez
Interface: org.bluez.Input1

Object path:
[variable prefix]/{hci0,hci1,...}
isBlocked() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
True if incoming connections are rejected, false otherwise.
isConnected() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
True if device is connected, false otherwise.
isDiscoverable() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
True if device is discoverable (= visible for others), false otherwise.
isDiscovering() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
True if discovery procedure is active, false otherwise.
isLegacyPairing() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
isNotifying() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
From bluez Documentation:
True, if notifications or indications on this characteristic are currently enabled.
isPairable() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
True if pairing with this adapter is allowed for others.
isPaired() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
True if the device is currently paired with another device.
isPowered() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Returns if the adapter is powered on (true) or powered off (false).
isPrimary() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattService
From bluez Documentation:
isRemote() - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
isRemote() - Method in class com.github.hypfvieh.bluetooth.wrapper.ProfileHandler
 
isServicesResolved() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
isTrusted() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
True if the remote device is trusted, false otherwise.

J

Join(DBusPath, byte[]) - Method in interface org.bluez.mesh.Network1
From bluez documentation:

This is the first method that an application has to call to
become a provisioned node on a mesh network.
JoinComplete(UInt64) - Method in interface org.bluez.mesh.Application1
From bluez documentation:

This method is called when the node provisioning initiated
by a Join() method call successfully completed.

The token parameter serves as a unique identifier of the
particular node.
JoinFailed(String) - Method in interface org.bluez.mesh.Application1
From bluez documentation:

This method is called when the node provisioning initiated by
Join() has failed.

The reason parameter identifies the reason for provisioning
failure.

L

LE - Enum constant in enum class com.github.hypfvieh.bluetooth.DiscoveryTransport
"le" - LE scan only
LEAdvertisement1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: advertising-api.txt.

Service: org.bluez
Interface: org.bluez.LEAdvertisement1

Object path:
freely definable

Supported properties:

string Type

Determines the type of advertising packet requested.

Possible values: "broadcast" or "peripheral"

array{string} ServiceUUIDs

List of UUIDs to include in the "Service UUID" field of
the Advertising Data.

dict ManufacturerData

Manufactuer Data fields to include in
the Advertising Data.
LEAdvertisingManager1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: advertising-api.txt.

Service: org.bluez
Interface: org.bluez.LEAdvertisingManager1

Object path:
/org/bluez/{hci0,hci1,...}

Supported properties:

byte ActiveInstances

Number of active advertising instances.

byte SupportedInstances

Number of available advertising instances.

array{string} SupportedIncludes

List of supported system includes.

Possible values: "tx-power"
"appearance"
"local-name"

array{string} SupportedSecondaryChannels [Experimental]

List of supported Secondary channels.
Leave(UInt64) - Method in interface org.bluez.mesh.Network1
From bluez documentation:

This removes the configuration information about the mesh node
identified by the 64-bit token parameter.
List(Map<String, Variant<?>>) - Method in interface org.bluez.obex.PhonebookAccess1
From bluez documentation:

Return an array of vcard-listing data where every entry
consists of a pair of strings containing the vcard
handle and the contact name.
ListFilterFields() - Method in interface org.bluez.obex.MessageAccess1
From bluez documentation:

Return all available fields that can be used in Fields
filter.

ListFilterFields() - Method in interface org.bluez.obex.PhonebookAccess1
From bluez documentation:

Return All Available fields that can be used in Fields
filter.

ListFolder() - Method in interface org.bluez.obex.FileTransfer
From bluez documentation:

Returns a dictionary containing information about
the current folder content.

The following keys are defined:

string Name : Object name in UTF-8 format
string Type : Either "folder" or "file"
uint64 Size : Object size or number of items in
folder
string Permission : Group, owner and other
permission
uint64 Modified : Last change
uint64 Accessed : Last access
uint64 Created : Creation date

ListFolders(Map<String, Variant<?>>) - Method in interface org.bluez.obex.MessageAccess1
From bluez documentation:

Returns a dictionary containing information about
the current folder content.

The following keys are defined:

string Name : Folder name

Possible filters: Offset and MaxCount

ListItems(Map<String, Variant<?>>) - Method in interface org.bluez.MediaFolder1
From bluez documentation:

Return a list of items found

ListMessages(String, Map<String, Variant<?>>) - Method in interface org.bluez.obex.MessageAccess1
From bluez documentation:

Returns an array containing the messages found in the
given subfolder of the current folder, or in the
current folder if folder is empty.

Possible Filters: Offset, MaxCount, SubjectLength, Fields,
Type, PeriodStart, PeriodEnd, Status, Recipient, Sender,
Priority

Each message is represented by an object path followed
by a dictionary of the properties.

Properties:

string Subject:

Message subject

string Timestamp:

Message timestamp

string Sender:

Message sender name

string SenderAddress:

Message sender address

string ReplyTo:

Message Reply-To address

string Recipient:

Message recipient name

string RecipientAddress:

Message recipient address

string Type:

Message type

Possible values: "email", "sms-gsm",
"sms-cdma" and "mms"

uint64 Size:

Message size in bytes

boolean Text:

Message text flag

Specifies whether message has textual
content or is binary only

string Status:

Message status

Possible values for received messages:
"complete", "fractioned", "notification"

Possible values for sent messages:
"delivery-success", "sending-success",
"delivery-failure", "sending-failure"

uint64 AttachmentSize:

Message overall attachment size in bytes

boolean Priority:

Message priority flag

boolean Read:

Message read flag

boolean Sent:

Message sent flag

boolean Protected:

Message protected flag

M

Management1 - Interface in org.bluez.mesh
File generated - 2023-02-20.
Based on bluez Documentation: mesh-api.txt.

Service: org.bluez.mesh
Interface: org.bluez.mesh.Management1

Object path:
/org/bluez/mesh/node<uuid>
where <uuid> is the Device UUID passed to Join(),
CreateNetwork() or Import()

MeasurementReceived(Map<String, Variant<?>>) - Method in interface org.bluez.ThermometerWatcher1
From bluez documentation:

This callback gets called when a measurement has been
scanned in the thermometer.

Measurement:

int16 Exponent:
int32 Mantissa:

Exponent and Mantissa values as
extracted from float value defined by
IEEE-11073-20601.

Measurement value is calculated as
(Mantissa) * (10^Exponent)

For special cases Exponent is
set to 0 and Mantissa is set to
one of following values:

+(2^23 - 1) NaN (invalid or
missing data)
-(2^23) NRes
+(2^23 - 2) +Infinity
-(2^23 - 2) -Infinity

string Unit:

Possible values: "celsius" or
"fahrenheit"

uint64 Time (optional):

Time of measurement, if
supported by device.
Expressed in seconds since epoch.

string Type (optional):

Only present if measurement type
is known.

Possible values: "armpit", "body",
"ear", "finger", "intestines",
"mouth", "rectum", "toe",
"tympanum"

string Measurement:

Possible values: "final" or
"intermediate"
Media1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: media-api.txt.

Service: org.bluez
Interface: org.bluez.Media1

Object path:
[variable prefix]/{hci0,hci1,...}

Supported properties:

array{string} SupportedUUIDs [readonly]:

List of 128-bit UUIDs that represents the supported
Endpoint registration.


MediaControl1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: media-api.txt.

Service: org.bluez
Interface: org.bluez.MediaControl1

Object path:
[variable prefix]/{hci0,hci1,...}
MediaEndpoint1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: media-api.txt.

Service: unique name (Server role)
Interface: org.bluez.MediaEndpoint1

Object path:
freely definable (Server role)
[variable prefix]/{hci0,hci1,...}
MediaFolder1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: media-api.txt.

Service: unique name (Target role)
Interface: org.bluez.MediaFolder1

Object path:
freely definable (Target role)
[variable prefix]/{hci0,hci1,...}
MediaItem1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: media-api.txt.

Service: unique name (Target role)
Interface: org.bluez.MediaItem1

Object path:
freely definable (Target role)
[variable prefix]/{hci0,hci1,...}
MediaPlayer1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: media-api.txt.

Service: org.bluez (Controller role)
Interface: org.bluez.MediaPlayer1

Object path:
[variable prefix]/{hci0,hci1,...}
MediaTransport1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: media-api.txt.

Service: org.bluez
Interface: org.bluez.MediaTransport1

Object path:
[variable prefix]/{hci0,hci1,...}
Message1 - Interface in org.bluez.obex
File generated - 2023-02-20.
Based on bluez Documentation: obex-api.txt.

Service: org.bluez.obex
Interface: org.bluez.obex.Message1

Object path:
[Session object path]/{message0,...}

Supported properties:

string Folder [readonly]

Folder which the message belongs to

string Subject [readonly]

Message subject

string Timestamp [readonly]

Message timestamp

string Sender [readonly]

Message sender name

string SenderAddress [readonly]

Message sender address

string ReplyTo [readonly]

Message Reply-To address

string Recipient [readonly]

Message recipient name

string RecipientAddress [readonly]

Message recipient address

string Type [readonly]

Message type

Possible values: "email", "sms-gsm",
"sms-cdma" and "mms"

uint64 Size [readonly]

Message size in bytes

string Status [readonly]

Message reception status

Possible values: "complete",
"fractioned" and "notification"

boolean Priority [readonly]

Message priority flag

boolean Read [read/write]

Message read flag

boolean Deleted [writeonly]

Message deleted flag

boolean Sent [readonly]

Message sent flag

boolean Protected [readonly]

Message protected flag

MessageAccess1 - Interface in org.bluez.obex
File generated - 2023-02-20.
Based on bluez Documentation: obex-api.txt.

Service: org.bluez.obex
Interface: org.bluez.obex.MessageAccess1

Object path:
[Session object path]

MessageReceived(UInt16, UInt16, Variant<?>, byte[]) - Method in interface org.bluez.mesh.Element1
From bluez documentation:

This method is called by bluetooth-meshd daemon when a message
arrives addressed to the application.

The source parameter is unicast address of the remote
node-element that sent the message.

The key_index parameter indicates which application key has been
used to decode the incoming message.
MoveFile(String, String) - Method in interface org.bluez.obex.FileTransfer
From bluez documentation:

Move a file within the remote device from source file
to the target file.

N

Network1 - Interface in org.bluez.mesh
File generated - 2023-02-20.
Based on bluez Documentation: mesh-api.txt.

Service: org.bluez.mesh
Interface: org.bluez.mesh.Network1

Object path:
/org/bluez/mesh

Network1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: network-api.txt.

Service: org.bluez
Interface: org.bluez.Network1

Object path:
[variable prefix]/{hci0,hci1,...}
NetworkServer1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: network-api.txt.

Service: org.bluez
Interface: org.bluez.NetworkServer1

Object path:
/org/bluez/{hci0,hci1,...}

NewConnection(DBusPath, FileDescriptor, Map<String, Variant<?>>) - Method in class com.github.hypfvieh.bluetooth.wrapper.ProfileHandler
 
NewConnection(DBusPath, FileDescriptor, Map<String, Variant<?>>) - Method in interface org.bluez.Profile1
From bluez documentation:

This method gets called when a new service level
connection has been made and authorized.

Common fd_properties:

uint16 Version Profile version (optional)
uint16 Features Profile features (optional)

Next() - Method in interface org.bluez.MediaControl1
Deprecated.
Next() - Method in interface org.bluez.MediaPlayer1
From bluez documentation:

Next item.

Node1 - Interface in org.bluez.mesh
File generated - 2023-02-20.
Based on bluez Documentation: mesh-api.txt.

Service: org.bluez.mesh
Interface: org.bluez.mesh.Node1

Object path:
/org/bluez/mesh/node<uuid>
where <uuid6gt; is the Device UUID passed to Join(),
CreateNetwork() or Import()

Supported properties:
dict Features [read-only]

The dictionary that contains information about feature support.
The following keys are defined:

boolean Friend

Indicates the ability to establish a friendship with a
Low Power node

boolean LowPower

Indicates support for operating in Low Power node mode

boolean Proxy

Indicates support for GATT proxy

boolean Relay
Indicates support for relaying messages

If a key is absent from the dictionary, the feature is not supported.
Otherwise, true means that the feature is enabled and false means that
the feature is disabled.

boolean Beacon [read-only]

This property indicates whether the periodic beaconing is
enabled (true) or disabled (false).

boolean IvUpdate [read-only]

When true, indicates that the network is in the middle of IV
Index Update procedure.
NONE - Enum constant in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
 

O

ObjectPush1 - Interface in org.bluez.obex
File generated - 2023-02-20.
Based on bluez Documentation: obex-api.txt.

Service: org.bluez.obex
Interface: org.bluez.obex.ObjectPush1

Object path:
[Session object path]

onAgentAuthorizeService(String, String) - Method in interface com.github.hypfvieh.bluetooth.wrapper.AgentChangeListener
 
onAgentCancel() - Method in interface com.github.hypfvieh.bluetooth.wrapper.AgentChangeListener
 
onAgentDisplayPassKey(String, long, int) - Method in interface com.github.hypfvieh.bluetooth.wrapper.AgentChangeListener
 
onAgentDisplayPinCode(String, String) - Method in interface com.github.hypfvieh.bluetooth.wrapper.AgentChangeListener
 
onAgentRelease() - Method in interface com.github.hypfvieh.bluetooth.wrapper.AgentChangeListener
 
onAgentRequestAuthorization(String) - Method in interface com.github.hypfvieh.bluetooth.wrapper.AgentChangeListener
 
onAgentRequestConfirmation(String, long) - Method in interface com.github.hypfvieh.bluetooth.wrapper.AgentChangeListener
 
onAgentRequestPassKey(String) - Method in interface com.github.hypfvieh.bluetooth.wrapper.AgentChangeListener
 
onAgentRequestPinCode(String) - Method in interface com.github.hypfvieh.bluetooth.wrapper.AgentChangeListener
 
onProfileConnection(String, FileDescriptor, Map<String, Variant<?>>) - Method in interface com.github.hypfvieh.bluetooth.wrapper.ProfileChangeListener
 
onProfileDisconnectRequest(String) - Method in interface com.github.hypfvieh.bluetooth.wrapper.ProfileChangeListener
 
onProfileRelease() - Method in interface com.github.hypfvieh.bluetooth.wrapper.ProfileChangeListener
 
optionsToVariantMap(Map<String, Object>) - Method in class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject
Convert options for read/write commands to the correct Map-type.
DBus library uses a custom object class names 'variant' which is some sort of wrapper
for any object.
org.bluez - package org.bluez
 
org.bluez.datatypes - package org.bluez.datatypes
 
org.bluez.exceptions - package org.bluez.exceptions
 
org.bluez.exceptions.mesh - package org.bluez.exceptions.mesh
 
org.bluez.mesh - package org.bluez.mesh
 
org.bluez.obex - package org.bluez.obex
 

P

pair() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
Pair() - Method in interface org.bluez.Device1
From bluez documentation:

This method will connect to the remote device,
initiate pairing and then retrieve all SDP records
(or GATT primary services).

If the application has registered its own agent,
then that specific agent will be used.
parseXmlString(String) - Static method in class com.github.hypfvieh.XmlHelper
Create a new Document instance from the given string, disabling validation.
Pathloss - Enum constant in enum class com.github.hypfvieh.bluetooth.DiscoveryFilter
 
Pause() - Method in interface org.bluez.MediaControl1
Deprecated.
Pause() - Method in interface org.bluez.MediaPlayer1
From bluez documentation:

Pause playback.

PhonebookAccess1 - Interface in org.bluez.obex
File generated - 2023-02-20.
Based on bluez Documentation: obex-api.txt.

Service: org.bluez.obex
Interface: org.bluez.obex.PhonebookAccess1

Object path:
[Session object path]

Supported properties:

string Folder [readonly]

Current folder.

string DatabaseIdentifier [readonly, optional]

128 bits persistent database identifier.

Possible values: 32-character hexadecimal such
as A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6

string PrimaryCounter [readonly, optional]

128 bits primary version counter.

Possible values: 32-character hexadecimal such
as A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6

string SecondaryCounter [readonly, optional]

128 bits secondary version counter.

Possible values: 32-character hexadecimal such
as A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6

bool FixedImageSize [readonly, optional]

Indicate support for fixed image size.

Possible values: True if image is JPEG 300x300 pixels
otherwise False.


Play() - Method in interface org.bluez.MediaControl1
Deprecated.
Play() - Method in interface org.bluez.MediaItem1
From bluez documentation:

Play item

Play() - Method in interface org.bluez.MediaPlayer1
From bluez documentation:

Resume playback.

Press(byte) - Method in interface org.bluez.MediaPlayer1
From bluez documentation:

Press a specific key to send as passthrough command.
The key will be released automatically.
Previous() - Method in interface org.bluez.MediaControl1
Deprecated.
Previous() - Method in interface org.bluez.MediaPlayer1
From bluez documentation:

Previous item.

PrivateKey() - Method in interface org.bluez.mesh.ProvisionAgent1
From bluez documentation:

This method is called during provisioning if the Provisioner
has requested Out-Of-Band ECC key exchange.
PROFILE - Enum constant in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
 
PROFILE_MANAGER - Enum constant in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
 
Profile1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: profile-api.txt.

Service: unique name
Interface: org.bluez.Profile1

Object path:
freely definable

ProfileChangeListener - Interface in com.github.hypfvieh.bluetooth.wrapper
 
ProfileHandler - Class in com.github.hypfvieh.bluetooth.wrapper
 
ProfileHandler(String, ProfileChangeListener) - Constructor for class com.github.hypfvieh.bluetooth.wrapper.ProfileHandler
 
ProfileManager - Class in com.github.hypfvieh.bluetooth.wrapper
 
ProfileManager(DBusConnection) - Constructor for class com.github.hypfvieh.bluetooth.wrapper.ProfileManager
 
ProfileManager1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: profile-api.txt.

Service: org.bluez
Interface: org.bluez.ProfileManager1

Object path:
/org/bluez

PromptNumeric(String) - Method in interface org.bluez.mesh.ProvisionAgent1
From bluez documentation:

This method is called when the Daemon requests the user to
enter a decimal value between 1-99999999.

The type parameter indicates the input method.
PromptStatic(String) - Method in interface org.bluez.mesh.ProvisionAgent1
From bluez documentation:

This method is called when the Daemon requires a 16 octet byte
array, as an Out-of-Band authentication.

The type parameter indicates the input method.
ProvisionAgent1 - Interface in org.bluez.mesh
File generated - 2023-02-20.
Based on bluez Documentation: mesh-api.txt.

Service: unique name
Interface: org.bluez.mesh.ProvisionAgent1

Object path:
freely definable

Supported properties:

:

An array of strings with the following allowed values:
"blink"
"beep"
"vibrate"
"out-numeric"
"out-alpha"
"push"
"twist"
"in-numeric"
"in-alpha"
"static-oob"
"public-oob"


Indicates availability of OOB data.
Provisioner1 - Interface in org.bluez.mesh
File generated - 2023-02-20.
Based on bluez Documentation: mesh-api.txt.

Service: unique name
Interface: org.bluez.mesh.Provisioner1

Object path:
freely definable

Supported properties:

An array of strings with the following allowed values:
"blink"
"beep"
"vibrate"
"out-numeric"
"out-alpha"
"push"
"twist"
"in-numeric"
"in-alpha"
"static-oob"
"public-oob"


Indicates availability of OOB data.
PublicKey() - Method in interface org.bluez.mesh.ProvisionAgent1
From bluez documentation:

This method is called during provisioning if the local device is
the Provisioner, and is requestng Out-Of-Band ECC key exchange.
The Public key is returned to the Daemon that is the matched
pair of the Private key of the remote device.
Publish(DBusPath, UInt16, Map<String, Variant<?>>, byte[]) - Method in interface org.bluez.mesh.Node1
From bluez documentation:

This method is used to send a publication originated by a local
model.
Pull(String, String, Map<String, Variant<?>>) - Method in interface org.bluez.obex.PhonebookAccess1
From bluez documentation:

Given a vcard handle, retrieve the vcard in the current
phonebook object and store it in a local file.

If an empty target file is given, a name will be
automatically calculated for the temporary file.

The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.

The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.

Possbile filters: Format and Fields

PullAll(String, Map<String, Variant<?>>) - Method in interface org.bluez.obex.PhonebookAccess1
From bluez documentation:

Return the entire phonebook object from the PSE server
in plain string with vcard format, and store it in
a local file.

If an empty target file is given, a name will be
automatically calculated for the temporary file.

The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.

The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.

Possible filters: Format, Order, Offset, MaxCount and
Fields

PullBusinessCard(String) - Method in interface org.bluez.obex.ObjectPush1
From bluez documentation:

Request the business card from a remote device and
store it in the local file.

If an empty target file is given, a name will be
automatically calculated for the temporary file.

The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.

The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.

PushMessage(String, String, Map<String, Variant<?>>) - Method in interface org.bluez.obex.MessageAccess1
From bluez documentation:

Transfer a message (in bMessage format) to the
remote device.

The message is transferred either to the given
subfolder of the current folder, or to the current
folder if folder is empty.

Possible args: Transparent, Retry, Charset

The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.

The properties of this transfer are also returned along
with the object path, to avoid a call to GetAll.

PutFile(String, String) - Method in interface org.bluez.obex.FileTransfer
From bluez documentation:

Copy the source file (from local filesystem) to the
target file (on remote device).

The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.

The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.

PutPhonebook(String) - Method in interface org.bluez.obex.Synchronization1
From bluez documentation:

Send an entire Phonebook Object store to remote device.

The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.

The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.

R

readValue(Map<String, Object>) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
Read a value from the GATT characteristics register.
Supported options:
readValue(Map<String, Object>) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattDescriptor
Read a value from the GATT descriptor register.
Supported options:
ReadValue(Map<String, Variant<?>>) - Method in interface org.bluez.GattCharacteristic1
From bluez documentation:

Issues a request to read the value of the
characteristic and returns the value if the
operation was successful.

Possible options: "offset": uint16 offset
"mtu": Exchanged MTU (Server only)
"device": Object Device (Server only)

ReadValue(Map<String, Variant<?>>) - Method in interface org.bluez.GattDescriptor1
From bluez documentation:

Issues a request to read the value of the
characteristic and returns the value if the
operation was successful.

Possible options: "offset": Start offset
"device": Device path (Server only)
"link": Link type (Server only)

refreshGattCharacteristics() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattService
Re-queries the GattCharacteristics from the device.
refreshGattDescriptors() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
Re-queries the GattCharacteristics from the device.
refreshGattServices() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
Re-queries the list of available BluetoothGattService's on this device.
Register(String, String) - Method in interface org.bluez.NetworkServer1
From bluez documentation:

Register server for the provided UUID.
RegisterAdvertisement(DBusPath, Map<String, Variant<?>>) - Method in interface org.bluez.LEAdvertisingManager1
From bluez documentation:

Registers an advertisement object to be sent over the LE
Advertising channel.
registerAgent(String, String) - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentManager
 
RegisterAgent(DBusPath) - Method in interface org.bluez.obex.AgentManager1
From bluez documentation:

Register an agent to request authorization of
the user to accept/reject objects.
RegisterAgent(DBusPath, String) - Method in interface org.bluez.AgentManager1
From bluez documentation:

This registers an agent handler.

The object path defines the path of the agent
that will be called when user input is needed.

Every application can register its own agent and
for all actions triggered by that application its
agent is used.

It is not required by an application to register
an agent.
RegisterApplication(DBusPath, Map<String, Variant<?>>) - Method in interface org.bluez.GattManager1
From bluez documentation:

Registers a local GATT services hierarchy as described
above (GATT Server) and/or GATT profiles (GATT Client).

The application object path together with the D-Bus
system bus connection ID define the identification of
the application registering a GATT based
service or profile.

RegisterApplication(DBusPath, Map<String, Variant<?>>) - Method in interface org.bluez.Media1
From bluez documentation:

Register endpoints an player objects within root
object which must implement ObjectManager.

The application object path together with the D-Bus
system bus connection ID define the identification of
the application.

RegisterEndpoint(DBusPath, Map<String, Variant<?>>) - Method in interface org.bluez.Media1
From bluez documentation:

Register a local end point to sender, the sender can
register as many end points as it likes.

Note: If the sender disconnects the end points are
automatically unregistered.

possible properties:

string UUID:

UUID of the profile which the endpoint
is for.

UUID must be in the list of
SupportedUUIDS.

byte Codec:

Assigned number of codec that the
endpoint implements.
RegisterPlayer(DBusPath, Map<String, Variant<?>>) - Method in interface org.bluez.Media1
From bluez documentation:

Register a media player object to sender, the sender
can register as many objects as it likes.

Object must implement at least
org.mpris.MediaPlayer2.Player as defined in MPRIS 2.2
spec:

http://specifications.freedesktop.org/mpris-spec/latest/

Note: If the sender disconnects its objects are
automatically unregistered.

registerProfile(String, String, Map<String, Object>) - Method in class com.github.hypfvieh.bluetooth.wrapper.ProfileManager
 
RegisterProfile(DBusPath, String, Map<String, Variant<?>>) - Method in interface org.bluez.ProfileManager1
From bluez documentation:

This registers a profile implementation.

If an application disconnects from the bus all
its registered profiles will be removed.

Some predefined services:

HFP AG UUID: 0000111f-0000-1000-8000-00805f9b34fb

Default profile Version is 1.7, profile Features
is 0b001001 and RFCOMM channel is 13.
Authentication is required.

HFP HS UUID: 0000111e-0000-1000-8000-00805f9b34fb

Default profile Version is 1.7, profile Features
is 0b000000 and RFCOMM channel is 7.
Authentication is required.

HSP AG UUID: 00001112-0000-1000-8000-00805f9b34fb

Default profile Version is 1.2, RFCOMM channel
is 12 and Authentication is required.
registerPropertyHandler(AbstractPropertiesChangedHandler) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Register a PropertiesChanged callback handler on the DBusConnection.
registerSignalHandler(AbstractSignalHandlerBase<T>) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Register a signal handler callback on the connection.
RegisterWatcher(DBusPath) - Method in interface org.bluez.ThermometerManager1
From bluez documentation:

Registers a watcher to monitor scanned measurements.
This agent will be notified about final temperature
measurements.

Release() - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
Release() - Method in class com.github.hypfvieh.bluetooth.wrapper.ProfileHandler
 
Release() - Method in interface org.bluez.Agent1
From bluez documentation:

This method gets called when the service daemon
unregisters the agent.
Release() - Method in interface org.bluez.GattProfile1
From bluez documentation:

This method gets called when the service daemon
unregisters the profile.
Release() - Method in interface org.bluez.HealthChannel1
From bluez documentation:

Releases the fd.
Release() - Method in interface org.bluez.LEAdvertisement1
From bluez documentation:

This method gets called when the service daemon
removes the Advertisement.
Release() - Method in interface org.bluez.MediaEndpoint1
From bluez documentation:

This method gets called when the service daemon
unregisters the endpoint.
Release() - Method in interface org.bluez.MediaPlayer1
From bluez documentation:

Release the previously held key invoked using Hold().

Release() - Method in interface org.bluez.MediaTransport1
From bluez documentation:

Releases file descriptor.

Release() - Method in interface org.bluez.obex.Agent1
From bluez documentation:

This method gets called when the service daemon
unregisters the agent.
Release() - Method in interface org.bluez.Profile1
From bluez documentation:

This method gets called when the service daemon
unregisters the profile.
removeDevice(Device1) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Remove a device and it's pairing information.
RemoveDevice(DBusPath) - Method in interface org.bluez.Adapter1
From bluez documentation:

This removes the remote device object at the given
path.
RemoveSession(DBusPath) - Method in interface org.bluez.obex.Client1
From bluez documentation:

Unregister session and abort pending transfers.

RequestAuthorization(DBusPath) - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
RequestAuthorization(DBusPath) - Method in interface org.bluez.Agent1
From bluez documentation:

This method gets called to request the user to
authorize an incoming pairing attempt which
would in other circumstances trigger the just-works
model, or when the user plugged in a device that
implements cable pairing.
RequestConfirmation(DBusPath, UInt32) - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
RequestConfirmation(DBusPath, UInt32) - Method in interface org.bluez.Agent1
From bluez documentation:

This method gets called when the service daemon
needs to confirm a passkey for an authentication.

To confirm the value it should return an empty reply
or an error in case the passkey is invalid.

Note that the passkey will always be a 6-digit number,
so the display should be zero-padded at the start if
the value contains less than 6 digits.

requestDefaultAgent(String) - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentManager
 
RequestDefaultAgent(DBusPath) - Method in interface org.bluez.AgentManager1
From bluez documentation:

This requests is to make the application agent
the default agent.
RequestDisconnection(DBusPath) - Method in class com.github.hypfvieh.bluetooth.wrapper.ProfileHandler
 
RequestDisconnection(DBusPath) - Method in interface org.bluez.Profile1
From bluez documentation:

This method gets called when a profile gets
disconnected.

The file descriptor is no longer owned by the service
daemon and the profile implementation needs to take
care of cleaning up all connections.

If multiple file descriptors are indicated via
NewConnection, it is expected that all of them
are disconnected before returning from this
method call.

RequestPasskey(DBusPath) - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
RequestPasskey(DBusPath) - Method in interface org.bluez.Agent1
From bluez documentation:

This method gets called when the service daemon
needs to get the passkey for an authentication.

The return value should be a numeric value
between 0-999999.

RequestPinCode(DBusPath) - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentHandler
 
RequestPinCode(DBusPath) - Method in interface org.bluez.Agent1
From bluez documentation:

This method gets called when the service daemon
needs to get the passkey for an authentication.

The return value should be a string of 1-16 characters
length.
RequestProvData(byte) - Method in interface org.bluez.mesh.Provisioner1
From bluez documentation:

This method is implemented by a Provisioner capable application
and is called when the remote device has been fully
authenticated and confirmed.

The count parameter is the number of consecutive unicast
addresses the remote device is requesting.

Return Parameters are from the Mesh Profile Spec:
net_index - Subnet index of the net_key
unicast - Primary Unicast address of the new node

Resume() - Method in interface org.bluez.obex.Transfer1
From bluez documentation:

Resume transference.

Rewind() - Method in interface org.bluez.MediaControl1
Deprecated.
Rewind() - Method in interface org.bluez.MediaPlayer1
From bluez documentation:

Rewind playback, this action is only stopped
when another method in this interface is called.

RSSI - Enum constant in enum class com.github.hypfvieh.bluetooth.DiscoveryFilter
 

S

scanForBluetoothAdapters() - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Search for all bluetooth adapters connected to this machine.
scanForBluetoothDevices(int) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Scan for bluetooth devices using the default adapter.
scanForBluetoothDevices(String, int) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Scan for Bluetooth devices for on the given adapter.
ScanResult(int, byte[], Map<String, Variant<?>>) - Method in interface org.bluez.mesh.Provisioner1
From bluez documentation:

The method is called from the bluetooth-meshd daemon when a
unique UUID has been seen during UnprovisionedScan() for
unprovsioned devices.

The rssi parameter is a signed, normalized measurement of the
signal strength of the recieved unprovisioned beacon.

The data parameter is a variable length byte array, that may
have 1, 2 or 3 distinct fields contained in it including the 16
byte remote device UUID (always), a 16 bit mask of OOB
authentication flags (optional), and a 32 bit URI hash (if URI
bit set in OOB mask).
Search(String, String, Map<String, Variant<?>>) - Method in interface org.bluez.obex.PhonebookAccess1
From bluez documentation:

Search for entries matching the given condition and
return an array of vcard-listing data where every entry
consists of a pair of strings containing the vcard
handle and the contact name.

vcard : name paired string match the search condition.

field : the field in the vcard to search with
{ "name" (default) | "number" | "sound" }
value : the string value to search for


Possible filters: Order, Offset and MaxCount

Search(String, Map<String, Variant<?>>) - Method in interface org.bluez.MediaFolder1
From bluez documentation:

Return a folder object containing the search result.

To list the items found use the folder object returned
and pass to ChangeFolder.

Select(String, String) - Method in interface org.bluez.obex.PhonebookAccess1
From bluez documentation:

Select the phonebook object for other operations.
SelectConfiguration(byte[]) - Method in interface org.bluez.MediaEndpoint1
From bluez documentation:

Select preferable configuration from the supported
capabilities.

Returns a configuration which can be used to setup
a transport.

Note: There is no need to cache the selected
configuration since on success the configuration is
send back as parameter of SetConfiguration.

SelectProperties(Map<String, Variant<?>>) - Method in interface org.bluez.MediaEndpoint1
From bluez documentation:

Select preferable properties from the supported
properties:
object Endpoint [ISO only]
Refer to SetConfiguration for the list of
other possible properties.

Returns propeties which can be used to setup
a transport.

Note: There is no need to cache the selected
properties since on success the configuration is
send back as parameter of SetConfiguration.

Send(DBusPath, UInt16, UInt16, Map<String, Variant<?>>, byte[]) - Method in interface org.bluez.mesh.Node1
From bluez documentation:

This method is used to send a message originated by a local
model.

The element_path parameter is the object path of an element from
a collection of the application elements (see Mesh Application
Hierarchy section).

The destination parameter contains the destination address.
SendFile(String) - Method in interface org.bluez.obex.ObjectPush1
From bluez documentation:

Send one local file to the remote device.

The returned path represents the newly created transfer,
which should be used to find out if the content has been
successfully transferred or if the operation fails.

The properties of this transfer are also returned along
with the object path, to avoid a call to GetProperties.

Session1 - Interface in org.bluez.obex
File generated - 2023-02-20.
Based on bluez Documentation: obex-api.txt.

Service: org.bluez.obex
Interface: org.bluez.obex.Session1

Object path:
/org/bluez/obex/server/session{0, 1, 2, ...} or
/org/bluez/obex/client/session{0, 1, 2, ...}

Supported properties:

string Source [readonly]

Bluetooth adapter address

string Destination [readonly]

Bluetooth device address

byte Channel [readonly]

Bluetooth channel

string Target [readonly]

Target UUID

string Root [readonly]

Root path



setAlias(String) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Change the current bluetooth friendly name.
setAlias(String) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
setBlocked(Boolean) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
From bluez Documentation:
SetConfiguration(DBusPath, Map<String, Variant<?>>) - Method in interface org.bluez.MediaEndpoint1
From bluez documentation:

Set configuration for the transport.

For client role transport must be set with a server
endpoint oject which will be configured and the
properties must contain the following properties:

array{byte} Capabilities [Mandatory]
array{byte} Metadata [ISO only]
byte CIG [ISO only]
byte CIS [ISO only]
uint32 Interval [ISO only]
bool Framing [ISO only]
string PHY [ISO only]
uint16 SDU [ISO only]
byte Retransmissions [ISO only]
uint16 Latency [ISO only]
uint32 Delay [ISO only]
uint8 TargetLatency [ISO Latency]

setDefaultAdapter(BluetoothAdapter) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Setup the default bluetooth adapter to use by giving an adapter object.
setDefaultAdapter(String) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Setup the default bluetooth adapter to use by giving the adapters MAC address.
setDiscoverable(boolean) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Set to true to enable device visibility for other bluetooth devices nearby.
setDiscoverableTimeout(Integer) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Timeout (in seconds) to set before the device visibility for others will be disabled.
If set to 0, device will stay visible forever.
setDiscoveryFilter(Map<String, Variant<?>>) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Use this to set a discovery filter.
This will cause the bluez library to only add device objects which are matching the given criterias.

Support values for the Map:
SetDiscoveryFilter(Map<String, Variant<?>>) - Method in interface org.bluez.Adapter1
From bluez documentation:

This method sets the device discovery filter for the
caller.
setFirstValue(A) - Method in class org.bluez.datatypes.ThreeTuple
 
setFirstValue(A) - Method in class org.bluez.datatypes.TwoTuple
 
SetFolder(String) - Method in interface org.bluez.obex.MessageAccess1
From bluez documentation:

Set working directory for current session, *name* may
be the directory name or '..
SetKeyPhase(UInt16, byte) - Method in interface org.bluez.mesh.Management1
From bluez documentation:
This method is used to set the flooding key update phase of the
given subnet.
SetLocation(String) - Method in interface org.bluez.obex.Synchronization1
From bluez documentation:

Set the phonebook object store location for other
operations.
setPairable(boolean) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Set to true to allow pairing of other devices with this adapter.
This is a global setting and effects all applications using this adapter.
setPairableTimeout(Integer) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Set the timeout (in seconds) before the pairable mode is disabled.
Setting this to 0 disables the timeout.
setPowered(boolean) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Turn adapter on (true) or off (false).
setScanFilter(Map<DiscoveryFilter, Object>) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Setup bluetooth scan/discovery filter.
setSecondValue(B) - Method in class org.bluez.datatypes.ThreeTuple
 
setSecondValue(B) - Method in class org.bluez.datatypes.TwoTuple
 
setThirdValue(C) - Method in class org.bluez.datatypes.ThreeTuple
 
SetTimer(byte, UInt16) - Method in interface org.bluez.mesh.Attention1
From bluez documentation:

The element_index parameter is the element's index within the
node where the health server model is hosted.

The time parameter indicates how many seconds the attention
state shall be on.
setTrusted(boolean) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
Set to true to trust the connected device, or to false if you don't.
Default is false.
setTyped(String, Object) - Method in class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject
Helper to set a value on a DBus property.
SimAccess1 - Interface in org.bluez
File generated - 2023-02-20.
Based on bluez Documentation: sap-api.txt.

Service: org.bluez
Interface: org.bluez.SimAccess1

Object path:
[variable prefix]/{hci0,hci1,...}

Supported properties:

boolean Connected [readonly]

Indicates if SAP client is connected to the server.

startDiscovery() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Start a new discovery operation to find any devices nearby.
StartDiscovery() - Method in interface org.bluez.Adapter1
From bluez documentation:

This method starts the device discovery session.
startNotify() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
From bluez Documentation:
StartNotify() - Method in interface org.bluez.GattCharacteristic1
From bluez documentation:

Starts a notification session from this characteristic
if it supports value notifications or indications.

Stop() - Method in interface org.bluez.MediaControl1
Deprecated.
Stop() - Method in interface org.bluez.MediaPlayer1
From bluez documentation:

Stop playback.

stopDiscovery() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
Stops the current discovery operation.
StopDiscovery() - Method in interface org.bluez.Adapter1
From bluez documentation:

This method will cancel any previous StartDiscovery
transaction.

Note that a discovery procedure is shared between all
discovery sessions thus calling StopDiscovery will only
release a single session and discovery will stop when
all sessions from all clients have finished.

stopNotify() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
From bluez Documentation:
StopNotify() - Method in interface org.bluez.GattCharacteristic1
From bluez documentation:

This method will cancel any previous StartNotify
transaction.
Suspend() - Method in interface org.bluez.obex.Transfer1
From bluez documentation:

Suspend transference.

Synchronization1 - Interface in org.bluez.obex
File generated - 2023-02-20.
Based on bluez Documentation: obex-api.txt.

Service: org.bluez.obex
Interface: org.bluez.obex.Synchronization1

Object path:
[Session object path]

T

Thermometer1 - Interface in org.bluez
File generated - 2020-06-18.
Based on bluez Documentation: thermometer-api.txt.

Service: org.bluez
Interface: org.bluez.Thermometer1

Object path:
[variable prefix]/{hci0,hci1,...}
ThermometerManager1 - Interface in org.bluez
File generated - 2020-06-18.
Based on bluez Documentation: thermometer-api.txt.

Service: org.bluez
Interface: org.bluez.ThermometerManager1

Object path:
[variable prefix]/{hci0,hci1,...}

ThermometerWatcher1 - Interface in org.bluez
File generated - 2020-06-18.
Based on bluez Documentation: thermometer-api.txt.

Service: unique name
Interface: org.bluez.ThermometerWatcher1

Object path:
freely definable

ThreeTuple<A,B,C> - Class in org.bluez.datatypes
Generic 3 value tuple.
ThreeTuple(A, B, C) - Constructor for class org.bluez.datatypes.ThreeTuple
 
toPrimitives(Byte[]) - Method in class com.github.hypfvieh.bluetooth.wrapper.AbstractBluetoothObject
Convert Byte[] to byte[] array.
toString() - Method in enum class com.github.hypfvieh.bluetooth.DiscoveryTransport
 
toString() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothAdapter
 
toString() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothBattery
 
toString() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothDevice
 
toString() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
 
toString() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattDescriptor
 
toString() - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattService
 
Transfer1 - Interface in org.bluez.obex
File generated - 2023-02-20.
Based on bluez Documentation: obex-api.txt.

Service: org.bluez.obex
Interface: org.bluez.obex.Transfer1

Object path:
[Session object path]/transfer{0, 1, 2, ...}

Supported properties:

string Status [readonly]

Inform the current status of the transfer.

Possible values: "queued", "active", "suspended",
"complete" or "error"

object Session [readonly]

The object path of the session the transfer belongs
to.

string Name [readonly]

Name of the transferred object.
Transport - Enum constant in enum class com.github.hypfvieh.bluetooth.DiscoveryFilter
 
TryAcquire() - Method in interface org.bluez.MediaTransport1
From bluez documentation:

Acquire transport file descriptor only if the transport
is in "pending" state at the time the message is
received by BlueZ.
TwoTuple<A,B> - Class in org.bluez.datatypes
Generic 2 value tuple.
TwoTuple(A, B) - Constructor for class org.bluez.datatypes.TwoTuple
 

U

UnprovisionedScan(Map<String, Variant<?>>) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application that supports
org.bluez.mesh.Provisioner1 interface to start listening
(scanning) for unprovisioned devices in the area.

The options parameter is a dictionary with the following keys
defined:

uint16 Seconds
Specifies number of seconds for scanning to be active.
If set to 0 or if this key is not present, then the
scanning will continue until UnprovisionedScanCancel()
or AddNode() methods are called.

Each time a unique unprovisioned beacon is heard, the
ScanResult() method on the app will be called with the result.

UnprovisionedScanCancel() - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application that supports
org.bluez.mesh.Provisioner1 interface to stop listening
(scanning) for unprovisioned devices in the area.

Unregister(String) - Method in interface org.bluez.NetworkServer1
From bluez documentation:

Unregister the server for provided UUID.

All servers will be automatically unregistered when
the calling application terminates.
UnregisterAdvertisement(DBusPath) - Method in interface org.bluez.LEAdvertisingManager1
From bluez documentation:

This unregisters an advertisement that has been
previously registered.
unregisterAgent(String) - Method in class com.github.hypfvieh.bluetooth.wrapper.AgentManager
 
UnregisterAgent(DBusPath) - Method in interface org.bluez.AgentManager1
From bluez documentation:

This unregisters the agent that has been previously
registered.
UnregisterAgent(DBusPath) - Method in interface org.bluez.obex.AgentManager1
From bluez documentation:

This unregisters the agent that has been previously
registered.
UnregisterApplication(DBusPath) - Method in interface org.bluez.GattManager1
From bluez documentation:

This unregisters the services that has been
previously registered.
UnregisterApplication(DBusPath) - Method in interface org.bluez.Media1
From bluez documentation:

This unregisters the services that has been
previously registered.
UnregisterEndpoint(DBusPath) - Method in interface org.bluez.Media1
From bluez documentation:

Unregister sender end point.

UnregisterPlayer(DBusPath) - Method in interface org.bluez.Media1
From bluez documentation:

Unregister sender media player.

unregisterProfile(UUID, String) - Method in class com.github.hypfvieh.bluetooth.wrapper.ProfileManager
 
UnregisterProfile(DBusPath) - Method in interface org.bluez.ProfileManager1
From bluez documentation:

This unregisters the profile that has been previously
registered.
unRegisterPropertyHandler(AbstractPropertiesChangedHandler) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Unregister a PropertiesChanged callback handler on the DBusConnection.
unRegisterSignalHandler(AbstractSignalHandlerBase<T>) - Method in class com.github.hypfvieh.bluetooth.DeviceManager
Unregister a signal handler callback on the connection.
UnregisterWatcher(DBusPath) - Method in interface org.bluez.ThermometerManager1
From bluez documentation:

Unregisters a watcher.

UpdateAppKey(UInt16) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application to generate a new
application key.

The app_index parameter is a 12-bit value (0x000-0xFFF)
specifying which app key to update.
UpdateInbox() - Method in interface org.bluez.obex.MessageAccess1
From bluez documentation:

Request remote to update its inbox.

UpdateModelConfiguration(UInt16, Map<String, Variant<?>>) - Method in interface org.bluez.mesh.Element1
From bluez documentation:

This method is called by bluetooth-meshd daemon when a model's
configuration is updated.

The model_id parameter contains BT SIG Model Identifier or, if
Vendor key is present in config dictionary, a 16-bit
vendor-assigned Model Identifier.

The config parameter is a dictionary with the following keys
defined:

array{uint16} Bindings

Indices of application keys bound to the model

uint32 PublicationPeriod

Model publication period in milliseconds

uint16 Vendor

A 16-bit Bluetooth-assigned Company Identifier of the
vendor as defined by Bluetooth SIG

array{variant} Subscriptions

Addresses the model is subscribed to.

Each address is provided either as uint16 for group
addresses, or as array{byte} for virtual labels.

UpdateSubnet(UInt16) - Method in interface org.bluez.mesh.Management1
From bluez documentation:

This method is used by the application to generate a new network
subnet key, and set it's key refresh state to Phase 1.

The net_index parameter is a 12-bit value (0x000-0xFFF)
specifying which net key to update.
UpdateVersion() - Method in interface org.bluez.obex.PhonebookAccess1
From bluez documentation:

Attempt to update PrimaryCounter and SecondaryCounter.

UUIDs - Enum constant in enum class com.github.hypfvieh.bluetooth.DiscoveryFilter
 

V

valueOf(String) - Static method in enum class com.github.hypfvieh.bluetooth.DiscoveryFilter
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.hypfvieh.bluetooth.DiscoveryTransport
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.github.hypfvieh.bluetooth.DiscoveryFilter
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.hypfvieh.bluetooth.DiscoveryTransport
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.hypfvieh.bluetooth.wrapper.BluetoothDeviceType
Returns an array containing the constants of this enum class, in the order they are declared.
VolumeDown() - Method in interface org.bluez.MediaControl1
Deprecated.
VolumeUp() - Method in interface org.bluez.MediaControl1
Deprecated.

W

writeValue(byte[], Map<String, Object>) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattCharacteristic
Write value to the GATT characteristic register.
Supported options:
writeValue(byte[], Map<String, Object>) - Method in class com.github.hypfvieh.bluetooth.wrapper.BluetoothGattDescriptor
Write value to the GATT descriptor register.
Supported options:
WriteValue(byte[], Map<String, Variant<?>>) - Method in interface org.bluez.GattCharacteristic1
From bluez documentation:

Issues a request to write the value of the
characteristic.

Possible options: "offset": Start offset
"type": string
Possible values:
"command": Write without
response
"request": Write with response
"reliable": Reliable Write
"mtu": Exchanged MTU (Server only)
"device": Device path (Server only)
"link": Link type (Server only)
"prepare-authorize": True if prepare
authorization
request

WriteValue(byte[], Map<String, Variant<?>>) - Method in interface org.bluez.GattDescriptor1
From bluez documentation:

Issues a request to write the value of the
characteristic.

Possible options: "offset": Start offset
"device": Device path (Server only)
"link": Link type (Server only)
"prepare-authorize": boolean Is prepare
authorization
request

X

XmlHelper - Class in com.github.hypfvieh
Utility for various XML operations.
A B C D E F G H I J L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Serialized Form