.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "waybar-bluetooth" "5" "2024-09-15"
.PP
.SH NAME
.PP
waybar - bluetooth module
.PP
.SH DESCRIPTION
.PP
The \fBbluetooth\fR module displays information about a bluetooth controller and its connections.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBbluetooth\fR
.PP
\fBcontroller\fR: 
.br
	typeof: string 
.br
	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.\&
.PP
\fBformat-device-preference\fR: 
.br
	typeof: array 
.br
	A ranking of bluetooth devices, addressed by their alias.\& The order is from \fBfirst displayed\fR to \fBlast displayed\fR.\& 
.br
	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.\&
.PP
\fBformat\fR: 
.br
	typeof: string  
.br
	default: \fB {status}\fR 
.br
	The format, how information should be displayed.\& This format is used when other formats aren'\&t specified.\&
.PP
\fBformat-disabled\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed controller is disabled.\&
.PP
\fBformat-off\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed controller is turned off.\&
.PP
\fBformat-on\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed controller is turned on with no devices connected.\&
.PP
\fBformat-connected\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed controller is connected to at least 1 device.\&
.PP
\fBformat-no-controller\fR: 
.br
	typeof: string 
.br
	This format is used when no bluetooth controller can be found
.PP
\fBformat-icons\fR: 
.br
	typeof: array/object 
.br
	Based on the current battery percentage (see section \fBEXPERIMENTAL BATTERY PERCENTAGE FEATURE\fR), the corresponding icon gets selected.\& 
.br
	The order is \fBlow\fR to \fBhigh\fR.\& Will only show the current battery percentage icon in the \fB*-connected-battery\fR config options.\& 
.br
	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).\&
.PP
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.PP
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.\&
.PP
\fBmin-length\fR: 
.br
	typeof: integer 
.br
	The minimum length in characters the module should accept.\&
.PP
\fBalign\fR: 
.br
	typeof: float 
.br
	The alignment of the label within the module, where 0 is left-aligned and 1 is right-aligned.\& If the module is rotated, it will follow the flow of the text.\&
.PP
\fBjustify\fR: 
.br
	typeof: string 
.br
	The alignment of the text within the module'\&s label, allowing options '\&left'\&, '\&right'\&, or '\&center'\& to define the positioning.\&
.PP
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.\&
.PP
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	Command to execute when middle-clicked on the module using mousewheel.\&
.PP
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	Command to execute when you right-click on the module.\&
.PP
\fBon-scroll-up\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling up on the module.\&
.PP
\fBon-scroll-down\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling down on the module.\&
.PP
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.\&
.PP
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: \fBtrue\fR 
.br
	Option to disable tooltip on hover.\&
.PP
\fBtooltip-format\fR: 
.br
	typeof: string 
.br
	The format, how information should be displayed in the tooltip.\& This format is used when other formats aren'\&t specified.\&
.PP
\fBtooltip-format-disabled\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed controller is disabled.\&
.PP
\fBtooltip-format-off\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed controller is turned off.\&
.PP
\fBtooltip-format-on\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed controller is turned on with no devices connected.\&
.PP
\fBtooltip-format-connected\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed controller is connected to at least 1 device.\&
.PP
\fBtooltip-format-no-controller\fR: 
.br
	typeof: string 
.br
	This format is used when no bluetooth controller can be found
.PP
\fBtooltip-format-enumerate-connected\fR: 
.br
	typeof: string 
.br
	This format is used to define how each connected device should be displayed within the \fBdevice_enumerate\fR format replacement in the tooltip menu.\&
.PP
\fBmenu\fR: 
.br
	typeof: string 
.br
	Action that popups the menu.\&
.PP
\fBmenu-file\fR: 
.br
	typeof: string 
.br
	Location of the menu descriptor file.\& There need to be an element of type
.RS 4
GtkMenu with id \fBmenu\fR
.PP
.RE
\fBmenu-actions\fR: 
.br
	typeof: array 
.br
	The actions corresponding to the buttons of the menu.\&
.PP
.SH FORMAT REPLACEMENTS
.PP
\fB{status}\fR: Status of the bluetooth device.\&
.PP
\fB{icon}\fR: Icon, as defined in \fBformat-icons\fR.\&
.PP
\fB{num_connections}\fR: Number of connections the displayed controller has.\&
.PP
\fB{controller_address}\fR: Address of the displayed controller.\&
.PP
\fB{controller_address_type}\fR: Address type of the displayed controller.\&
.PP
\fB{controller_alias}\fR: Alias of the displayed controller.\&
.PP
\fB{device_address}\fR: Address of the displayed device.\&
.PP
\fB{device_address_type}\fR: Address type of the displayed device.\&
.PP
\fB{device_alias}\fR: Alias of the displayed device.\&
.PP
\fB{device_enumerate}\fR: Show a list of all connected devices, each on a separate line.\& Define the format of each device with the \fBtooltip-format-enumerate-connected\fR 
.br
and/or \fBtooltip-format-enumerate-connected-battery\fR config options.\& Can only be used in the tooltip-related format options.\&
.PP
.SH EXPERIMENTAL BATTERY PERCENTAGE FEATURE
.PP
At the time of writing, the experimental features of BlueZ need to be turned on, for the battery percentage options listed below to work.\&
.PP
.SS FORMAT REPLACEMENT
.PP
\fB{device_battery_percentage}\fR: Battery percentage of the displayed device if available.\& Use only in the config options defined below.\&
.PP
.SS CONFIGURATION
.PP
\fBformat-connected-battery\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed device provides its battery percentage.\&
.PP
\fBtooltip-format-connected-battery\fR: 
.br
	typeof: string 
.br
	This format is used when the displayed device provides its battery percentage.\&
.PP
\fBtooltip-format-enumerate-connected-battery\fR: 
.br
	typeof: string 
.br
	This format is used to define how each connected device with a battery should be displayed within the \fBdevice_enumerate\fR format replacement option.\& 
.br
	When this config option is not defined, it will fall back on the \fBtooltip-format-enumerate-connected\fR config option.\&
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"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}"
}
.fi
.RE
.PP
.nf
.RS 4
"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}%"
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#bluetooth\fR
.IP \(bu 4
\fB#bluetooth.\&disabled\fR
.IP \(bu 4
\fB#bluetooth.\&off\fR
.IP \(bu 4
\fB#bluetooth.\&on\fR
.IP \(bu 4
\fB#bluetooth.\&connected\fR
.IP \(bu 4
\fB#bluetooth.\&discoverable\fR
.IP \(bu 4
\fB#bluetooth.\&discovering\fR
.IP \(bu 4
\fB#bluetooth.\&pairable\fR