bluez-utils-3.24.tar.gz_bluez-libs_bluez-pin_bluez-utils-3.24.ta

D-Bus API description for BlueZ ******************************* Copyright (C) 2004-2007 Marcel Holtmann <marcel@holtmann.org> Copyright (C) 2005-2006 Johan Hedberg <johan.hedberg@nokia.com> Copyright (C) 2005-2006 Claudio Takahasi <claudio.takahasi@indt.org.br> Copyright (C) 2005-2006 Eduardo Rocha <eduardo.rocha@indt.org.br> Constant definitions ==================== The class of device definition from the Bluetooth specification divides into three different parts. It the major class, the minor class and the service classes. The D-Bus interface will always use string constants to identify any of these classes. Service classes positioning, networking, rendering, capturing, object transfer, audio, telephony, information Major classes miscellaneous, computer, phone, access point, audio/video, peripheral, imaging, wearable, toy, uncategorized Minor classes computer uncategorized, desktop, server, laptop, handheld, palm, wearable Minor classes phone uncategorized, cellular, cordless, smart phone, modem, isdn Minor classes access point fully, 1-17 percent, 17-33 percent, 33-50 percent, 50-67 percent, 67-83 percent, 83-99 percent, not available Minor classes audio video uncategorized, headset, handsfree,microphone, loudspeaker, headphones, portable audio, car audio, set-top box, hifi audio, vcr, video camera, camcorder, video monitor, video display and loudspeaker, video conferencing, gaming/toy, unknown Minor classes peripheral uncategorized, keyboard, pointing, combo Minor classes imaging display, camera, scanner, printer Minor classes wearable wrist watch, pager, jacket, helmet, glasses Minor classes toy robot, vehicle, doll, controller, game Error hierarchy =============== Interface org.bluez.Error Shared Errors (Can be thrown by hcid or any bluetooth service) DeviceUnreachable The remote device is either powered down or out of range. AlreadyConnected A connection request has been received on an already connected device. ConnectionAttemptFailed An unexpected error (other than DeviceUnreachable) error has occured while attempting a connection to a device. NotConnected The remote device is not connected, while the method call would expect it to be, or is not in the expected state to perform the action. InProgress Error returned if an operation is in progress. Since this is a generic error that can be used in various situations, the error message should be more clear about what is in progress. For example "Bonding in progress". InvalidArguments The DBUS request does not contain the right number of arguments with the right type, or the arguments are there but their value is wrong, or does not makes sense in the current context. OutOfMemory Error returned when a memory allocation via malloc() fails. This error is similar to ENOMEM. NotAvailable Error returned when a specified record is not available. NotSupported The remote device does not support the expected feature. AlreadyExists One of the requested elements already exists DoesNotExist One of the requested elements does not exist Canceled The operation was canceled. Failed This is a the most generic error. It is thrown when something unexpected happens. Hcid specific Errors (Can be thrown by hcid only) NotReady Error returned when the adapter is DOWN. UnknwownMethod This is an experimental method. NotAuthorized Error returned when the caller of a method is not authorized. This might happen if a caller tries to terminate a connection that it hasn't created. Rejected NoSuchAdapter Error returned when the requested adapter doesn't exists. This error is similar to ENODEV. NoSuchService RequestDeferred NotInProgress UnsupportedMajorClass AuthenticationCanceled AuthenticationFailed AuthenticationTimeout AuthenticationRejected RepeatedAttempts Manager hierarchy ================= Service org.bluez Interface org.bluez.Manager Object path /org/bluez Methods uint32 InterfaceVersion() Returns the current interface version. At the moment only version 0 is supported. Possible errors: org.bluez.Error.InvalidArguments string DefaultAdapter() Returns object path for the default adapter. Possible errors: org.bluez.Error.InvalidArguments org.bluez.Error.NoSuchAdapter string FindAdapter(string pattern) Returns object path for the specified adapter. Valid patterns are "hci0" or "00:11:22:33:44:55". Possible errors: org.bluez.Error.InvalidArguments org.bluez.Error.NoSuchAdapter array{string} ListAdapters() Returns list of adapter object paths under /org/bluez Possible errors: org.bluez.Error.InvalidArguments org.bluez.Error.Failed org.bluez.Error.OutOfMemory string FindService(string pattern) Returns object path for the specified service. Valid patterns are the unqiue identifier or a bus name. Possible errors: org.bluez.Error.InvalidArguments org.bluez.Error.NoSuchService array{string} ListServices() Returns list of object paths of current services. Possible errors: org.bluez.Error.InvalidArguments string ActivateService(string pattern) Returns the unqiue bus id of the specified service. Valid patterns are the same as for FindService(). If the service is not running it will be started. Signals void AdapterAdded(string path) Parameter is object path of added adapter. void AdapterRemoved(string path) Parameter is object path of removed adapter. void DefaultAdapterChanged(string path) Parameter is object path of the new default adapter. void ServiceAdded(string path) Parameter is object path of registered service agent. void ServiceRemoved(string path) Parameter is object path of unregistered service agent. Database hierarchy ================== Service org.bluez Interface org.bluez.Database Object path /org/bluez or /org/bluez/{hci0,hci1,...} Methods void RegisterService(string identifier, string name, string description) This method registers a new service specified by its unique identifier. This is only needed for services that are not started through the Bluetooth daemon. void UnregisterService(string identifier) This method unregisters a service specified by its unique identifier. uint32 AddServiceRecord(array{byte}) Adds a new service record and returns the assigned record handle. Possible errors: org.bluez.Error.InvalidArguments org.bluez.Error.Failed uint32 AddServiceRecordFromXML(string record) Adds a new service record and returns the assigned record handle. Possible errors: org.bluez.Error.InvalidArguments org.bluez.Error.Failed void UpdateServiceRecord(uint32 handle, array{byte}) Updates a given service record. Possible errors: org.bluez.Error.InvalidArguments org.bluez.Error.NotAvailable org.bluez.Error.Failed void UpdateServiceRecordFromXML(uint32 handle, string record) Updates a given service record provided in the XML format. Possible errors: org.bluez.Error.InvalidArguments org.bluez.Error.NotAvailable org.bluez.Error.Failed void RemoveServiceRecord(uint32 handle) Remove a service record identified by its handle. It is only possible to remove service records that where added by the current connection. Possible errors: org.bluez.Error.InvalidArguments org.bluez.Error.NotAuthorized org.bluez.Error.DoesNotExist org.bluez.Error.Failed void RequestAuthorization(string address, string uuid) This method gets called when a service wants to check if a remote device is authorized to perform some action. The authorization request is forwarded to an authorization agent. The address parameter is the Bluetooth address of the remote dev