summaryrefslogtreecommitdiffstats
path: root/input/input-api.txt
blob: f321ac2b58768f2d32abbf7a7ca416735e362f32 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
Bluetooth input service API description
******************************************

Copyright (C) 2006-2007  Marcel Holtmann <marcel@holtmann.org>

Error hierarchy
===============

Interface	org.bluez.Error

Errors		Failed

			An unknown error occured. The error messages is
			taken from the strerror(errno) function.

		UnknownDevice

			Error returned when the input device path is invalid

		UnknownMethod

			Error returned when the input device path doesn't
			implement the requested method.


Input Manager hierarchy
=================

Service		org.bluez.input
Interface	org.bluez.input.Manager
Object path	/org/bluez/input

Methods
		array{string} ListDevices()

			Returns an array of available input devices path.

		void CreateDevice(string address)

			Create an input device object: HID service record is 
			retrieved and bonding(if applied) is created.

		void RemoveDevice(string path)

			Remove the input device object for a given path.	


Input hierarchy
=================

Service		org.bluez.input
Interface	org.bluez.input
Object path	/org/bluez/input_*

Methods		string GetAddress()

			Returns the device address.

			Example: "00:11:22:33:44:55"

		string GetName()

			Returns the service name.

		string GetProductId()

			Returns the product id.

		string GetVendorId()

			Returns the vendor id.

		boolean IsConnected()

			Returns the connection status.

		void Connect()
			
			Connect to the input device.

		void Disconnect()

			Disconnect from the input device.

		void Unplug()

			Unplug the virtual cable device.

		void SetTimeout(uint32 timeout)

			Set the idle timeout.