summaryrefslogtreecommitdiff
path: root/contrib/man/bt-device.pod
blob: 2399e2099859f7499f18addc5335f426089ebc2c (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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
=head1 NAME

bt-device - a bluetooth device manager

=head1 SYNOPSIS

bt-device [OPTION...]

Help Options:
  -h, --help

Application Options:
  -a, --adapter=<name|mac>
  -l, --list
  -c, --connect=<mac>
  -d, --disconnect=<name|mac>
  -r, --remove=<name|mac>
  -i, --info=<name|mac>
  -s, --services <name|mac> [<pattern>]
  --set <name|mac> <property> <value>
  -v, --verbose

=head1 DESCRIPTION

This utility is used to manage Bluetooth devices. You can list added devices,
connect to a new device, disconnect device, remove added device, show info
about device, discover remote device services or change device properties.

=head1 OPTIONS

B<-h, --help>
    Show help

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<-l, --list>
    List added devices

B<-c, --connect E<lt>macE<gt>>
    Connect to the remote device by his MAC, retrieve all SDP
    records and then initiate the pairing

B<-d, --disconnect E<lt>name|macE<gt>>
    Disconnects a specific remote device by terminating the
    low-level ACL connection.

B<-r, --remove>
    Remove device (and also the pairing information)

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

B<-s, --services E<lt>name|macE<gt> [E<lt>patternE<gt>]>
    Starts the service discovery to retrieve remote service records,
    the `pattern` parameter can be used to specify specific UUIDs

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

B<-v, --verbose>
    Verbosely display remote service records (affect to service
    discovery mode)

=head1 DEVICE PROPERTIES

string  Address [ro]
        The Bluetooth device address (MAC) of the remote device.

string  Name [ro]
        The Bluetooth remote device name.

string  Icon [ro]
        Proposed icon name according to the freedesktop.org
        icon naming specification.

uint32  Class [ro]
        The Bluetooth class of device of the remote device.

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

boolean Paired [ro]
        Indicates if the remote device is paired.

boolean Connected [ro]
        Indicates if the remote device is currently connected.

boolean Trusted [rw]
        Indicates if the remote is seen as trusted.

boolean Blocked [rw]
        If set to true any incoming connections from the
        device will be immediately rejected.

string Alias [rw]
        The name alias for the remote device. The alias can
        be used to have a different friendly name for the
        remote device.

        In case no alias is set, it will return the remote
        device name. Setting an empty string as alias will
        convert it back to the remote device name.

boolean LegacyPairing [ro]
        Set to true if the device only supports the pre-2.1
        pairing mechanism.

=head1 AUTHOR

Alexander Orlenko <zxteam@gmail.com>.

=head1 SEE ALSO

bt-adapter(1) bt-agent(1) bt-audio(1) bt-input(1) bt-monitor(1) bt-network(1) bt-serial(1)