ORG.BLUEZ.AGENT(5) | Linux System Administration? | ORG.BLUEZ.AGENT(5) |
NAME¶
org.bluez.Agent - BlueZ D-Bus Agent API documentation
INTERFACE¶
- Service
- unique name
- Interface
- org.bluez.Agent1
- Object path
- freely definable
Methods¶
void Release()¶
string RequestPinCode(object device)¶
The return value should be a string of 1-16 characters length. The string can be alphanumeric.
Possible errors:
void DisplayPinCode(object device, string pincode)¶
An empty reply should be returned. When the pincode needs no longer to be displayed, the Cancel method of the agent will be called.
This is used during the pairing process of keyboards that don't support Bluetooth 2.1 Secure Simple Pairing, in contrast to DisplayPasskey which is used for those that do.
This method will only ever be called once since older keyboards do not support typing notification.
Note that the PIN will always be a 6-digit number, zero-padded to 6 digits. This is for harmony with the later specification.
Possible errors:
uint32 RequestPasskey(object device)¶
The return value should be a numeric value between 0-999999.
Possible errors:
void DisplayPasskey(object device, uint32 passkey, uint16 entered)¶
The entered parameter indicates the number of already typed keys on the remote side.
An empty reply should be returned. When the passkey needs no longer to be displayed, the Cancel method of the agent will be called.
During the pairing process this method might be called multiple times to update the entered value.
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.
void RequestConfirmation(object device, uint32 passkey)¶
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.
Possible errors:
void RequestAuthorization(object device)¶
Possible errors:
void AuthorizeService(object device, string uuid)¶
Possible errors:
void Cancel()¶
October 2023 | BlueZ |