1waybar-bluetooth(5) File Formats Manual waybar-bluetooth(5)
2
6 waybar - bluetooth module
7
9 The bluetooth module displays information about a bluetooth controller
10 and its connections.
11
13 Addressed by bluetooth
14 controller:
16 typeof: string
17 Use the controller with the defined alias. Otherwise a random con‐
18 troller is used. Recommended to define when there is more than 1 con‐
19 troller available to the system.
20 format-device-preference:
22 typeof: array
23 A ranking of bluetooth devices, addressed by their alias. The or‐
24 der is from first displayed to last displayed.
25 If this config option is not defined or none of the devices in the
26 list are connected, it will fall back to showing the last connected de‐
27 vice.
28 format:
30 typeof: string
31 default: {status}
32 The format, how information should be displayed. This format is
33 used when other formats aren't specified.
34 format-disabled:
36 typeof: string
37 This format is used when the displayed controller is disabled.
38 format-off:
40 typeof: string
41 This format is used when the displayed controller is turned off.
42 format-on:
44 typeof: string
45 This format is used when the displayed controller is turned on
46 with no devices connected.
47 format-connected:
49 typeof: string
50 This format is used when the displayed controller is connected to
51 at least 1 device.
52 rotate:
54 typeof: integer
55 Positive value to rotate the text label.
56 max-length:
58 typeof: integer
59 The maximum length in character the module should display.
60 min-length:
62 typeof: integer
63 The minimum length in characters the module should take up.
64 align:
66 typeof: float
67 The alignment of the text, where 0 is left-aligned and 1 is right-
68 aligned. If the module is rotated, it will follow the flow of the text.
69 on-click:
71 typeof: string
72 Command to execute when clicked on the module.
73 on-click-middle:
75 typeof: string
76 Command to execute when middle-clicked on the module using mouse‐
77 wheel.
78 on-click-right:
80 typeof: string
81 Command to execute when you right clicked on the module.
82 on-scroll-up:
84 typeof: string
85 Command to execute when scrolling up on the module.
86 on-scroll-down:
88 typeof: string
89 Command to execute when scrolling down on the module.
90 smooth-scrolling-threshold:
92 typeof: double
93 Threshold to be used when scrolling.
94 tooltip:
96 typeof: bool
97 default: true
98 Option to disable tooltip on hover.
99 tooltip-format:
101 typeof: string
102 The format, how information should be displayed in the tooltip.
103 This format is used when other formats aren't specified.
104 tooltip-format-disabled:
106 typeof: string
107 This format is used when the displayed controller is disabled.
108 tooltip-format-off:
110 typeof: string
111 This format is used when the displayed controller is turned off.
112 tooltip-format-on:
114 typeof: string
115 This format is used when the displayed controller is turned on
116 with no devices connected.
117 tooltip-format-connected:
119 typeof: string
120 This format is used when the displayed controller is connected to
121 at least 1 device.
122 tooltip-format-enumerate-connected:
124 typeof: string
125 This format is used to define how each connected device should be
126 displayed within the device_enumerate format replacement in the tooltip
127 menu.
128
130 {status}: Status of the bluetooth device.
131 {num_connections}: Number of connections the displayed controller has.
133 {controller_address}: Address of the displayed controller.
135 {controller_address_type}: Address type of the displayed controller.
137 {controller_alias}: Alias of the displayed controller.
139 {device_address}: Address of the displayed device.
141 {device_address_type}: Address type of the displayed device.
143 {device_alias}: Alias of the displayed device.
145 {device_enumerate}: Show a list of all connected devices, each on a
147 seperate line. Define the format of each device with the tooltip-for‐
148 mat-enumerate-connected
149 and/or tooltip-format-enumerate-connected-battery config options. Can
150 only be used in the tooltip related format options.
151
153 At the time of writing, the experimental features of BlueZ need to be
154 turned on, for the battery percentage options listed below to work.
155 FORMAT REPLACEMENT
157 {device_battery_percentage}: Battery percentage of the displayed device
158 if available. Use only in the config options defined below.
159 CONFIGURATION
161 format-connected-battery:
162 typeof: string
163 This format is used when the displayed device provides its battery
164 percentage.
165 tooltip-format-connected-battery:
167 typeof: string
168 This format is used when the displayed device provides its battery
169 percentage.
170 tooltip-format-enumerate-connected-battery:
172 typeof: string
173 This format is used to define how each connected device with a
174 battery should be displayed within the device_enumerate format replace‐
175 ment option.
176 When this config option is not defined, it will fall back on the
177 tooltip-format-enumerate-connected config option.
178
180 "bluetooth": {
181 // "controller": "controller1", // specify the alias of the controller if there are more than 1 on the system
182 "format": " {status}",
183 "format-disabled": "", // an empty format will hide the module
184 "format-connected": " {num_connections} connected",
185 "tooltip-format": "{controller_alias}\t{controller_address}",
186 "tooltip-format-connected": "{controller_alias}\t{controller_address}\n\n{device_enumerate}",
187 "tooltip-format-enumerate-connected": "{device_alias}\t{device_address}"
188 }
189 "bluetooth": {
191 "format": " {status}",
192 "format-connected": " {device_alias}",
193 "format-connected-battery": " {device_alias} {device_battery_percentage}%",
194 // "format-device-preference": [ "device1", "device2" ], // preference list deciding the displayed device
195 "tooltip-format": "{controller_alias}\t{controller_address}\n\n{num_connections} connected",
196 "tooltip-format-connected": "{controller_alias}\t{controller_address}\n\n{num_connections} connected\n\n{device_enumerate}",
197 "tooltip-format-enumerate-connected": "{device_alias}\t{device_address}",
198 "tooltip-format-enumerate-connected-battery": "{device_alias}\t{device_address}\t{device_battery_percentage}%"
199 }
200
202 • #bluetooth
203 • #bluetooth.disabled
204 • #bluetooth.off
205 • #bluetooth.on
206 • #bluetooth.connected
207 • #bluetooth.discoverable
208 • #bluetooth.discovering
209 • #bluetooth.pairable
210 2022-05-23 waybar-bluetooth(5)