mirror of
https://github.com/rad4day/Waybar.git
synced 2023-12-21 10:22:59 +01:00
a3904ff039
Fix the following whitespace formatting issues: - Indentation in scdoc source files should be done with tabs. - Lines where there (clearly) should be a line break, need to have '++' at the end, but several were missing them. - The scdoc manual (clearly) states that lines should be hard wrapped at 80 columns, but when line(s) are indented, that causes rendering issues. So lines where a line break was not clearly intended or clearly not intended, have been put onto 1 line to circumvent the rendering issue. Link: https://lists.sr.ht/~sircmpwn/public-inbox/%3C8251560.T7Z3S40VBb%40bagend%3E
203 lines
6.8 KiB
Markdown
203 lines
6.8 KiB
Markdown
waybar-bluetooth(5)
|
|
|
|
# NAME
|
|
|
|
waybar - bluetooth module
|
|
|
|
# DESCRIPTION
|
|
|
|
The *bluetooth* module displays information about a bluetooth controller and its connections.
|
|
|
|
# CONFIGURATION
|
|
|
|
Addressed by *bluetooth*
|
|
|
|
*controller*: ++
|
|
typeof: string ++
|
|
Use the controller with the defined alias. Otherwise a random controller is used. Recommended to define when there is more than 1 controller available to the system.
|
|
|
|
*format-device-preference*: ++
|
|
typeof: array ++
|
|
A ranking of bluetooth devices, addressed by their alias. The order is from *first displayed* to *last displayed*. ++
|
|
If this config option is not defined or none of the devices in the list are connected, it will fall back to showing the last connected device.
|
|
|
|
*format*: ++
|
|
typeof: string ++
|
|
default: * {status}* ++
|
|
The format, how information should be displayed. This format is used when other formats aren't specified.
|
|
|
|
*format-disabled*: ++
|
|
typeof: string ++
|
|
This format is used when the displayed controller is disabled.
|
|
|
|
*format-off*: ++
|
|
typeof: string ++
|
|
This format is used when the displayed controller is turned off.
|
|
|
|
*format-on*: ++
|
|
typeof: string ++
|
|
This format is used when the displayed controller is turned on with no devices connected.
|
|
|
|
*format-connected*: ++
|
|
typeof: string ++
|
|
This format is used when the displayed controller is connected to at least 1 device.
|
|
|
|
*format-icons*: ++
|
|
typeof: array/object ++
|
|
Based on the current battery percentage (see section *EXPERIMENTAL BATTERY PERCENTAGE FEATURE*), the corresponding icon gets selected. ++
|
|
The order is *low* to *high*. Will only show the current battery percentage icon in the *\*-connected-battery* config options. ++
|
|
Or by the state if it is an object. It will fall back to the enabled state if its derivatives are not defined (on, off, connected).
|
|
|
|
*rotate*: ++
|
|
typeof: integer ++
|
|
Positive value to rotate the text label.
|
|
|
|
*max-length*: ++
|
|
typeof: integer ++
|
|
The maximum length in character the module should display.
|
|
|
|
*min-length*: ++
|
|
typeof: integer ++
|
|
The minimum length in characters the module should take up.
|
|
|
|
*align*: ++
|
|
typeof: float ++
|
|
The alignment of the text, where 0 is left-aligned and 1 is right-aligned. If the module is rotated, it will follow the flow of the text.
|
|
|
|
*on-click*: ++
|
|
typeof: string ++
|
|
Command to execute when clicked on the module.
|
|
|
|
*on-click-middle*: ++
|
|
typeof: string ++
|
|
Command to execute when middle-clicked on the module using mousewheel.
|
|
|
|
*on-click-right*: ++
|
|
typeof: string ++
|
|
Command to execute when you right clicked on the module.
|
|
|
|
*on-scroll-up*: ++
|
|
typeof: string ++
|
|
Command to execute when scrolling up on the module.
|
|
|
|
*on-scroll-down*: ++
|
|
typeof: string ++
|
|
Command to execute when scrolling down on the module.
|
|
|
|
*smooth-scrolling-threshold*: ++
|
|
typeof: double ++
|
|
Threshold to be used when scrolling.
|
|
|
|
*tooltip*: ++
|
|
typeof: bool ++
|
|
default: *true* ++
|
|
Option to disable tooltip on hover.
|
|
|
|
*tooltip-format*: ++
|
|
typeof: string ++
|
|
The format, how information should be displayed in the tooltip. This format is used when other formats aren't specified.
|
|
|
|
*tooltip-format-disabled*: ++
|
|
typeof: string ++
|
|
This format is used when the displayed controller is disabled.
|
|
|
|
*tooltip-format-off*: ++
|
|
typeof: string ++
|
|
This format is used when the displayed controller is turned off.
|
|
|
|
*tooltip-format-on*: ++
|
|
typeof: string ++
|
|
This format is used when the displayed controller is turned on with no devices connected.
|
|
|
|
*tooltip-format-connected*: ++
|
|
typeof: string ++
|
|
This format is used when the displayed controller is connected to at least 1 device.
|
|
|
|
*tooltip-format-enumerate-connected*: ++
|
|
typeof: string ++
|
|
This format is used to define how each connected device should be displayed within the *device_enumerate* format replacement in the tooltip menu.
|
|
|
|
# FORMAT REPLACEMENTS
|
|
|
|
*{status}*: Status of the bluetooth device.
|
|
|
|
*{icon}*: Icon, as defined in *format-icons*.
|
|
|
|
*{num_connections}*: Number of connections the displayed controller has.
|
|
|
|
*{controller_address}*: Address of the displayed controller.
|
|
|
|
*{controller_address_type}*: Address type of the displayed controller.
|
|
|
|
*{controller_alias}*: Alias of the displayed controller.
|
|
|
|
*{device_address}*: Address of the displayed device.
|
|
|
|
*{device_address_type}*: Address type of the displayed device.
|
|
|
|
*{device_alias}*: Alias of the displayed device.
|
|
|
|
*{device_enumerate}*: Show a list of all connected devices, each on a separate line. Define the format of each device with the *tooltip-format-enumerate-connected* ++
|
|
and/or *tooltip-format-enumerate-connected-battery* config options. Can only be used in the tooltip related format options.
|
|
|
|
# EXPERIMENTAL BATTERY PERCENTAGE FEATURE
|
|
|
|
At the time of writing, the experimental features of BlueZ need to be turned on, for the battery percentage options listed below to work.
|
|
|
|
## FORMAT REPLACEMENT
|
|
|
|
*{device_battery_percentage}*: Battery percentage of the displayed device if available. Use only in the config options defined below.
|
|
|
|
## CONFIGURATION
|
|
|
|
*format-connected-battery*: ++
|
|
typeof: string ++
|
|
This format is used when the displayed device provides its battery percentage.
|
|
|
|
*tooltip-format-connected-battery*: ++
|
|
typeof: string ++
|
|
This format is used when the displayed device provides its battery percentage.
|
|
|
|
*tooltip-format-enumerate-connected-battery*: ++
|
|
typeof: string ++
|
|
This format is used to define how each connected device with a battery should be displayed within the *device_enumerate* format replacement option. ++
|
|
When this config option is not defined, it will fall back on the *tooltip-format-enumerate-connected* config option.
|
|
|
|
# EXAMPLES
|
|
|
|
```
|
|
"bluetooth": {
|
|
// "controller": "controller1", // specify the alias of the controller if there are more than 1 on the system
|
|
"format": " {status}",
|
|
"format-disabled": "", // an empty format will hide the module
|
|
"format-connected": " {num_connections} connected",
|
|
"tooltip-format": "{controller_alias}\\t{controller_address}",
|
|
"tooltip-format-connected": "{controller_alias}\\t{controller_address}\\n\\n{device_enumerate}",
|
|
"tooltip-format-enumerate-connected": "{device_alias}\\t{device_address}"
|
|
}
|
|
```
|
|
|
|
```
|
|
"bluetooth": {
|
|
"format": " {status}",
|
|
"format-connected": " {device_alias}",
|
|
"format-connected-battery": " {device_alias} {device_battery_percentage}%",
|
|
// "format-device-preference": [ "device1", "device2" ], // preference list deciding the displayed device
|
|
"tooltip-format": "{controller_alias}\\t{controller_address}\\n\\n{num_connections} connected",
|
|
"tooltip-format-connected": "{controller_alias}\\t{controller_address}\\n\\n{num_connections} connected\\n\\n{device_enumerate}",
|
|
"tooltip-format-enumerate-connected": "{device_alias}\\t{device_address}",
|
|
"tooltip-format-enumerate-connected-battery": "{device_alias}\\t{device_address}\\t{device_battery_percentage}%"
|
|
}
|
|
```
|
|
|
|
# STYLE
|
|
|
|
- *#bluetooth*
|
|
- *#bluetooth.disabled*
|
|
- *#bluetooth.off*
|
|
- *#bluetooth.on*
|
|
- *#bluetooth.connected*
|
|
- *#bluetooth.discoverable*
|
|
- *#bluetooth.discovering*
|
|
- *#bluetooth.pairable*
|