All Classes and Interfaces

Class
Description
Base class of all bluetooth wrapper object classes.
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.
File generated - 2023-02-20.
Based on bluez Documentation: agent-api.txt.

Service: unique name
Interface: org.bluez.Agent1

Object path:
freely definable

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

 
 
 
File generated - 2023-02-20.
Based on bluez Documentation: agent-api.txt.

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

Object path:
/org/bluez

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

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



File generated - 2023-02-20.
Based on bluez Documentation: mesh-api.txt.

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

Object path:
freely definable

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,...}
Wrapper class which represents an bluetooth adapter.
Wrapper class which represents the battery of a remote bluetooth device.
Wrapper class which represents a remote bluetooth device.
Bluetooth device ObjectType identifier.
Wrapper class which represents a GATT characteristic on a remote device.
Wrapper class which represents a GATT descriptor on a remote device.
Wrapper class which represents a GATT service provided by a remote device.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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

Various DBUS related helper methods.
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,...}
The 'main' class to get access to all DBus/bluez related objects.
Supported discovery filter values.
Supported DiscoveryTransport values.
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.
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]

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,...}
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,...}
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.
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.



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,...}
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,...}
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,...}
This signal is launched when a new data channel is
created or when a known data channel is reconnected.
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.
File generated - 2023-02-20.
Based on bluez Documentation: health-api.txt.

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

Object path:
/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,...}
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.
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.
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()

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.


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,...}
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,...}
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,...}
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,...}
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,...}
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,...}
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

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]

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

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,...}
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,...}

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.
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]

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.


File generated - 2023-02-20.
Based on bluez Documentation: profile-api.txt.

Service: unique name
Interface: org.bluez.Profile1

Object path:
freely definable

 
 
 
File generated - 2023-02-20.
Based on bluez Documentation: profile-api.txt.

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

Object path:
/org/bluez

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.
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.
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



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.

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]

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,...}
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,...}

File generated - 2020-06-18.
Based on bluez Documentation: thermometer-api.txt.

Service: unique name
Interface: org.bluez.ThermometerWatcher1

Object path:
freely definable

Generic 3 value tuple.
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.
Generic 2 value tuple.
Utility for various XML operations.