summaryrefslogtreecommitdiff
path: root/contrib/man/bt-adapter.pod
blob: d03e274c86e3ce4993b1095418a81eb23c1b33ec (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
94
95
96
97
98
99
100
101
102
103
104
=head1 NAME

bt-adapter - a bluetooth adapter manager

=head1 SYNOPSIS

bt-adapter [OPTION...]

Help Options:
  -h, --help

Application Options:
  -l, --list
  -a, --adapter=<name|mac>
  -i, --info
  -d, --discover
  --set <property> <value>

=head1 DESCRIPTION

This utility is used to manage Bluetooth adapters. You can list all available adapters,
show information about adapter, change adapter properties or discover remote devices.

=head1 OPTIONS

B<-h, --help>
    Show help

B<-l, --list>
    List all available adapters

B<-a, --adapter E<lt>name|macE<gt>>
    Specify adapter to use by his Name or MAC address
    (if this option does not defined - default adapter used)

B<-i, --info>
    Show information about adapter (returns all properties)

B<-d, --discover>
    Discover remote devices (with remote device name resolving)

B<--set E<lt>propertyE<gt> E<lt>valueE<gt>>
    Change adapter properties (see PROPERTIES section for list of
    available properties)

=head1 ADAPTER PROPERTIES

string  Address [ro]
        The Bluetooth adapter address (MAC).

string  Name [rw]
        The Bluetooth adapter friendly name.

uint32  Class [ro]
        The Bluetooth class of device.

boolean Powered [rw]
        Switch an adapter on or off. This will also set the
        appropiate connectable state.

boolean Discoverable [rw]
        Switch an adapter to discoverable or non-discoverable
        to either make it visible or hide it.

        If the DiscoverableTimeout is set to a non-zero
        value then the system will set this value back to
        false after the timer expired.

        In case the adapter is switched off, setting this
        value will fail.

boolean Pairable [rw]
        Switch an adapter to pairable or non-pairable.

        Note that this property only affects incoming pairing
        requests.

uint32  PaireableTimeout [rw]
        The pairable timeout in seconds. A value of zero
        means that the timeout is disabled and it will stay in
        pareable mode forever.

uint32  DiscoverableTimeout [rw]
        The discoverable timeout in seconds. A value of zero
        means that the timeout is disabled and it will stay in
        discoverable/limited mode forever.

        The default value for the discoverable timeout should
        be 180 seconds (3 minutes).

boolean Discovering [ro]
        Indicates that a device discovery procedure is active.

list    UUIDs [ro]
        List of 128-bit UUIDs that represents the available local
        services.

=head1 AUTHOR

Alexander Orlenko <zxteam@gmail.com>.

=head1 SEE ALSO

bt-agent(1) bt-device(1)