2008-03-07 22:39:14 +08:00
|
|
|
BlueZ D-Bus Agent API description
|
|
|
|
|
**********************************
|
|
|
|
|
|
2010-01-02 09:08:17 +08:00
|
|
|
Copyright (C) 2004-2010 Marcel Holtmann <marcel@holtmann.org>
|
2008-03-07 22:39:14 +08:00
|
|
|
Copyright (C) 2005-2006 Johan Hedberg <johan.hedberg@nokia.com>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Agent hierarchy
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
Service unique name
|
|
|
|
|
Interface org.bluez.Agent
|
|
|
|
|
Object path freely definable
|
|
|
|
|
|
|
|
|
|
Methods void Release()
|
|
|
|
|
|
|
|
|
|
This method gets called when the service daemon
|
|
|
|
|
unregisters the agent. An agent can use it to do
|
|
|
|
|
cleanup tasks. There is no need to unregister the
|
|
|
|
|
agent, because when this method gets called it has
|
|
|
|
|
already been unregistered.
|
2008-03-11 05:18:56 +08:00
|
|
|
|
2008-06-03 22:00:03 +08:00
|
|
|
string RequestPinCode(object device)
|
2008-03-11 05:18:56 +08:00
|
|
|
|
|
|
|
|
This method gets called when the service daemon
|
2008-05-30 21:25:40 +08:00
|
|
|
needs to get the passkey for an authentication.
|
|
|
|
|
|
|
|
|
|
The return value should be a string of 1-16 characters
|
2011-05-06 03:17:20 +08:00
|
|
|
length. Longer strings are truncated to 16 characters.
|
|
|
|
|
The string can be alphanumeric.
|
|
|
|
|
|
|
|
|
|
Strings starting with '$' are parsed as hex-encoded
|
|
|
|
|
pins. That is, each two following hex characters form
|
|
|
|
|
a single byte of the resulting pin. The parser is
|
|
|
|
|
case-insensitive.
|
2008-05-30 21:25:40 +08:00
|
|
|
|
|
|
|
|
Possible errors: org.bluez.Error.Rejected
|
|
|
|
|
org.bluez.Error.Canceled
|
|
|
|
|
|
2008-06-03 22:00:03 +08:00
|
|
|
uint32 RequestPasskey(object device)
|
2008-05-30 21:25:40 +08:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
Possible errors: org.bluez.Error.Rejected
|
|
|
|
|
org.bluez.Error.Canceled
|
|
|
|
|
|
2008-06-16 09:51:04 +08:00
|
|
|
void DisplayPasskey(object device, uint32 passkey, uint8 entered)
|
2008-05-30 21:25:40 +08:00
|
|
|
|
|
|
|
|
This method gets called when the service daemon
|
|
|
|
|
needs to display a passkey for an authentication.
|
|
|
|
|
|
2008-06-16 09:51:04 +08:00
|
|
|
The entered parameter indicates the number of already
|
|
|
|
|
typed keys on the remote side.
|
|
|
|
|
|
2008-05-30 21:25:40 +08:00
|
|
|
An empty reply should be returned. When the passkey
|
|
|
|
|
needs no longer to be displayed, the Cancel method
|
|
|
|
|
of the agent will be called.
|
|
|
|
|
|
2008-06-16 09:51:04 +08:00
|
|
|
During the pairing process this method might be
|
|
|
|
|
called multiple times to update the entered value.
|
|
|
|
|
|
2008-05-30 21:25:40 +08:00
|
|
|
void RequestConfirmation(object device, uint32 passkey)
|
|
|
|
|
|
|
|
|
|
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.
|
2008-03-11 05:18:56 +08:00
|
|
|
|
|
|
|
|
Possible errors: org.bluez.Error.Rejected
|
|
|
|
|
org.bluez.Error.Canceled
|
|
|
|
|
|
2008-03-13 04:07:43 +08:00
|
|
|
void Authorize(object device, string uuid)
|
2008-03-11 05:18:56 +08:00
|
|
|
|
|
|
|
|
This method gets called when the service daemon
|
|
|
|
|
needs to authorize a connection/service request.
|
|
|
|
|
|
|
|
|
|
Possible errors: org.bluez.Error.Rejected
|
|
|
|
|
org.bluez.Error.Canceled
|
|
|
|
|
|
|
|
|
|
void ConfirmModeChange(string mode)
|
|
|
|
|
|
|
|
|
|
This method gets called if a mode change is requested
|
|
|
|
|
that needs to be confirmed by the user. An example
|
|
|
|
|
would be leaving flight mode.
|
|
|
|
|
|
|
|
|
|
Possible errors: org.bluez.Error.Rejected
|
|
|
|
|
org.bluez.Error.Canceled
|
|
|
|
|
|
|
|
|
|
void Cancel()
|
|
|
|
|
|
|
|
|
|
This method gets called to indicate that the agent
|
|
|
|
|
request failed before a reply was returned.
|
