From patchwork Sat Nov 4 01:38:44 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Otto X-Patchwork-Id: 13445359 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id ADDBAC4332F for ; Sat, 4 Nov 2023 01:39:54 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231909AbjKDBjy (ORCPT ); Fri, 3 Nov 2023 21:39:54 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53116 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231749AbjKDBjx (ORCPT ); Fri, 3 Nov 2023 21:39:53 -0400 Received: from mail-qv1-xf31.google.com (mail-qv1-xf31.google.com [IPv6:2607:f8b0:4864:20::f31]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 63A7AD5F for ; Fri, 3 Nov 2023 18:39:50 -0700 (PDT) Received: by mail-qv1-xf31.google.com with SMTP id 6a1803df08f44-670237ba9b1so5713486d6.0 for ; Fri, 03 Nov 2023 18:39:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=vt-edu.20230601.gappssmtp.com; s=20230601; t=1699061989; x=1699666789; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=c3Yhy9Hf5+nnSUNmSBL33gHvI8iid5vFUHfOckgKkt8=; b=XYBGqBcdjqxWKxQhRzZdm7F/jWdSrupHEcne3YsUywa+B7XWXPTTSrr+oY/hBnbBjW 1Rf+gCG5W6SaLRqePWKxnEc8AyAeoIOPeQgCtsCMo1Vg26473xAG3lB1CSytyOr3aux5 fwEpyMHRiZgDjU+1cXq3LAtVXp7zO7iEb30YoYrDTZzdlwkdF0xl3zxYz0J/RiIfcO2y UXl6y3lKtdjJep50zjbPExyXywEkejazJugxJ3ZWO6ahIzJp1WioXgVv+Iuw5WA0+h83 c6FjsHUgdEmNaF976czqcCgTTLzPZ/THB3yIdrWHHhVtVnB/W1sx2EDKwKzHRnFJLA5i 0yMw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699061989; x=1699666789; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=c3Yhy9Hf5+nnSUNmSBL33gHvI8iid5vFUHfOckgKkt8=; b=KMgR2GYZ05JsDFxw++v1eBfOHr9H+t8n0/SiIG4gLzqOuI2+wEsPnH5qcvlPybSJv5 M6ri+MAgHbAax7ZZj3gbEvwsZpKPU+gX/AeYB/cQa+UNrlCL0O6wZ9xY/P9q8+zScAKH +/lcUiwyrXF7x+NP8NANNU4hxS3sPVTcNcfbbx2/712ByE/1iXNtDZeMKlk851/zJdRz jexdZ0Oy9GT3JuNDjiRPtvHcgwk7t4inTQ7IXRNSENwb+4q2DDo4SpG7YVNXal4IeATf FlutyMoL6EHGAnuzve++8i3BDOYC54Fose4I4QHn90wqBdRcuucA4ULT0YaVg5xB5sA5 zY4Q== X-Gm-Message-State: AOJu0Yx5W588Z+MafMXLN50Qcvv8B9yfnZyogZiDVu5Bu7hAYvJ1Iir9 r+jFc0XHkq4oZfbNRXOprKm3u2fJt+rwZdhwB8Kwar+BsqA7jcturm7of0XHVPWOTm0/4vJaKrr abgYX7Owkgg6DDjfzX7va9ki9E9RgeuBV3IvZ16d6Yz+syuxp0O5Wv5JwISM0jlZI40q6KZdxc4 Rq X-Google-Smtp-Source: AGHT+IF4EVlBDx/Btmv1it3nFf9FZgDV/8FIUsZCNXZeRGVIQ3fLesJ/A/d68HUn+KyNldvgG3njwg== X-Received: by 2002:a05:620a:24c3:b0:76f:27af:2797 with SMTP id m3-20020a05620a24c300b0076f27af2797mr26864388qkn.0.1699061988678; Fri, 03 Nov 2023 18:39:48 -0700 (PDT) Received: from debian.localdomain (c-73-177-243-39.hsd1.va.comcast.net. [73.177.243.39]) by smtp.gmail.com with ESMTPSA id l17-20020a05620a28d100b007770d47c621sm1216955qkp.66.2023.11.03.18.39.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Nov 2023 18:39:48 -0700 (PDT) From: Paul Otto To: linux-bluetooth@vger.kernel.org Cc: Paul Otto Subject: [PATCH BlueZ 1/7] update doc for bluetoothctl-admin.rst Date: Fri, 3 Nov 2023 21:38:44 -0400 Message-Id: <20231104013850.24182-2-potto@vt.edu> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20231104013850.24182-1-potto@vt.edu> References: <20231104013850.24182-1-potto@vt.edu> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Paul Otto --- client/bluetoothctl-admin.rst | 98 +++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 client/bluetoothctl-admin.rst diff --git a/client/bluetoothctl-admin.rst b/client/bluetoothctl-admin.rst new file mode 100644 index 000000000..7084bdad0 --- /dev/null +++ b/client/bluetoothctl-admin.rst @@ -0,0 +1,98 @@ +================== +bluetoothctl-admin +================== + +-------------------- +Admin Policy Submenu +-------------------- + +:Version: BlueZ +:Copyright: Free use of this software is granted under ther terms of the GNU + Lesser General Public Licenses (LGPL). +:Date: November 2022 +:Manual section: 1 +:Manual group: Linux System Administration + +SYNOPSIS +======== + +**bluetoothctl** [**-a** *capability*] [**-e**] [**-m**] [**-t** *seconds*] [**-v**] [**-h**] + +DESCRIPTION +=========== + +**bluetoothctl(1)** interactive bluetooth control tool. The tool works with Bluetooth Classic (BR/EDR) and Bluetooth Low Energy (LE) controllers. + +OPTIONS +======= + +-a capability, --agent capability Register agent handler: +-e, --endpoints Register Media endpoints +-m, --monitor Enable monitor output +-t seconds, --timeout seconds Timeout in seconds for non-interactive mode +-v, --version Display version +-h, --help Display help + +Admin Policy Commands +===================== + We divide bluetoothctl into main menu commands and submenu commands. The submenu commands control options + numbers for the commands can be hex (0x0F) or decimal (10) + +allow +----- + Allow service UUIDs and block rest of them + Syntax: allow [clear/uuid1 uuid2 ...] + Example: allow 0x1101 0x1102 0x1103 + Example: allow clear + +:Usage: **#allow [clear/uuid1 uuid2 ...]** + +back +---- + Return to main menu + +:Usage: **#back** + +version +------- + Display version + +:Usage: **#version** + +quit +---- + Quit program + +:Usage: **#quit** + +exit +---- + Quit program + +:Usage: **#exit** + +help +---- + Display help about this program + +:Usage: **#help** + +export +------ + Print environment variables + +:Usage: **#export** + +EXAMPLES +======== + + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org From patchwork Sat Nov 4 01:38:45 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Otto X-Patchwork-Id: 13445360 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 70798C4332F for ; Sat, 4 Nov 2023 01:39:59 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232017AbjKDBkA (ORCPT ); Fri, 3 Nov 2023 21:40:00 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48986 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232051AbjKDBj6 (ORCPT ); Fri, 3 Nov 2023 21:39:58 -0400 Received: from mail-qv1-xf31.google.com (mail-qv1-xf31.google.com [IPv6:2607:f8b0:4864:20::f31]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1FA1DD73 for ; Fri, 3 Nov 2023 18:39:54 -0700 (PDT) Received: by mail-qv1-xf31.google.com with SMTP id 6a1803df08f44-671188b2d44so5540516d6.0 for ; Fri, 03 Nov 2023 18:39:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=vt-edu.20230601.gappssmtp.com; s=20230601; t=1699061992; x=1699666792; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=2C1F2NzerxolOnMz0Xy0fZHAjq+p3zDVnV17MgfXTxc=; b=S+3JrlEZPrio8PJ9ZD8BJsK1kO1eFRxpSUV8oelkP3BdilAMQVcO0EkfN7+xz1E0ki IuCAvRq6iD00Bj2yjr7ElIKnpj4Qkxv4+FvaGo4wxvCssJ/zN9edQqIqPjsDq51wYpCD 8RWK3sYCggDHCdexTv947SBjcK6mkVG4NlU30nCsQHDiFqG3b0qC0xiJfjdeh9OcxQqf VsyhBbXgFgH+oWJr+hfqk2l6YtJzgPWYa3sBa14xKvZ1zdTX4Mh52pDQxv0t8Sr9nJg1 wxuZmZpXDgqngncMaom4pLK/cgG1pGCtt1mjLCwoZoCCOBc+oKmv1r7cIaSCu/ffe+aD iG1g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699061992; x=1699666792; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=2C1F2NzerxolOnMz0Xy0fZHAjq+p3zDVnV17MgfXTxc=; b=pz8JMIR6TcU0V8z6C+XRzdl8ANCQLVFjJgGCrM+OPOPWhVDcspCvPsE5A5O/1wuhQd OrlwxiX2+4JpRcijgeUyWQVlVP71XS9SjMy1M3sUjfeb2VlauNn1/DAS3oc3gzQ6GEXt sdkHjtJ1hQ1Mjglb7S2krnmF7ck06i9/N0MKe+aU0DT0USV2XZyXwlCbMqjbnhtBZ43W sx9qmeMgYhFAeIelejIxp3s2FtYROVjmDnHfKhxcZEcBdI9udKzfv3/B98GtPkUx32Ur v4wjCZ2l/dplBylRmZMf8zhTakNVhDoyHHlhoG0LY2OI0Cu/5MDD7OvKElLeNmP7vmh8 E2yw== X-Gm-Message-State: AOJu0Yy7+GgWBHu/GveBUIF1zBEsI3/snxy0Y6nNaQU3QpmyP3evg8lg ebusY+hSDSMrxR/uWZ5KxwO66rgplR1KqUOYmSsIXHj4nO6nYktNaFXTMdUy0GPVzZflXXzoxk3 VeiJde2AQlNC5M9JJPGszRscjVI4VS4nBtGQ6NjE9LXh4bjPMXhrnIBNme3OrN6GX4lroLUf4oJ 1E X-Google-Smtp-Source: AGHT+IGMABOswc9/eu8SYsAPCdh0fe8KUO6XNbZRLJkQ3BeH1o/wh8zo7MNCrKHs/j1wsHd8XyVl9Q== X-Received: by 2002:a05:620a:19a1:b0:778:8ae9:2247 with SMTP id bm33-20020a05620a19a100b007788ae92247mr28026804qkb.5.1699061992044; Fri, 03 Nov 2023 18:39:52 -0700 (PDT) Received: from debian.localdomain (c-73-177-243-39.hsd1.va.comcast.net. [73.177.243.39]) by smtp.gmail.com with ESMTPSA id l17-20020a05620a28d100b007770d47c621sm1216955qkp.66.2023.11.03.18.39.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Nov 2023 18:39:51 -0700 (PDT) From: Paul Otto To: linux-bluetooth@vger.kernel.org Cc: Paul Otto Subject: [PATCH BlueZ 2/7] update doc for bluetoothctl-advertise.rst Date: Fri, 3 Nov 2023 21:38:45 -0400 Message-Id: <20231104013850.24182-3-potto@vt.edu> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20231104013850.24182-1-potto@vt.edu> References: <20231104013850.24182-1-potto@vt.edu> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Paul Otto --- client/bluetoothctl-advertise.rst | 243 ++++++++++++++++++++++++++++++ 1 file changed, 243 insertions(+) create mode 100644 client/bluetoothctl-advertise.rst diff --git a/client/bluetoothctl-advertise.rst b/client/bluetoothctl-advertise.rst new file mode 100644 index 000000000..7b9911158 --- /dev/null +++ b/client/bluetoothctl-advertise.rst @@ -0,0 +1,243 @@ +============================== +bluetoothctl-advertise-options +============================== + +------------------------- +Advertise Options Submenu +------------------------- + +:Version: BlueZ +:Copyright: Free use of this software is granted under ther terms of the GNU + Lesser General Public Licenses (LGPL). +:Date: November 2022 +:Manual section: 1 +:Manual group: Linux System Administration + +SYNOPSIS +======== +bluetoothctl advertise options submenu can be accessed by the command `menu advertise` in bluetoothctl. If the error "Failed to register advertisement: org.bluez.Error.Failed" is received then check /var/log/syslog for the specific error such as "Advertising data too long or couldn't be generated.". Assuming bluetoothd has the -v option set. + +Advertise Options Commands +========================== + +Advertising packets are structured data which is broadcast on the LE Advertising +channels and available for all devices in range. Because of the limited space +available in LE Advertising packets (31 bytes), each packet's contents must be +carefully controlled. + +This is a long form description of the commands that includes examples. Values can either be hexadecimal (0x0C) +decimal (12) or octal if a leading zero (07). Footnotes are indicated by {x} and can be found at the bottom of the page. + + +uuids +----- +Set/Get advertise uuids + The assumed format of the uuid is hex. Therefore uuids 0x1234 identical to uuids 1234. + The valid uuids are: + - 16 bit uuids - ex: uuids 0x1234 + - 32 bit uuids - ex: uuids 0x12345678 + - 128 bit uuids - ex: uuids 90f95193-35de-4306-a6e9-699328f15059 + + .. note:: 128 bit uuids must be in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where x is a hexadecimal digit and the dashes are included. + +:Usage: **# uuids [all/uuid1 uuid2 ...]** + +service +------- +Set/Get advertise service data + +:Usage: **# service [uuid] [data=xx xx ...]** + +manufacturer +------------ +Set/Get advertise manufacturer data + updating is in real time while advertising. This is currently limited to 25 bytes and will return an error message of "Too much data" + if that maximum has been exceeded. However, this does not check if the advertising payload length maximum has been exceeded so you + may receive an error from bluetoothd that it "Failed to register advertisement" which means you need to reduce your manufacturer data length. + +:Usage: **# manufacturer [id] [data=xx xx ...]** + +data +---- +Set/Get advertise data + This allows you to advertise data with a given type. You cannot use a registered data type value {1} with + this command. For LE the advertising shows up in the primary advertisements + Example: Advertises a nonregistered data type of 0x0C with three octets of data (01 0x0F 13):: + + data 0x0C 01 0x0F 13 + + If you set only the type of the data without any data (data 0x0c) this will cause a parse error when turning advertise on. + You can only send a maximum of 8 bytes of data. data 0x0c 00 01 02 03 04 05 06 07 + You can modify the advertising data while it is advertising + To get the currently set data use the command data without any arguments + To delete the currently set data you need to... (clear does not appear to work) + +:Usage: **# data [type] [data=xx xx ...]** + +discoverable +------------ +Set/Get advertise discoverable + For LE discoverable on will set the LE General Discoverable Mode flag to true in the primary advertisement if on. + This feature can be changed during advertising, but will only trigger LE General Discoverable Mode even if you had previously selected + discoverable-timeout this will be ignored. + Entering the command by itself will show the status of the setting + +:Usage: **# discoverable [on/off]** + +discoverable-timeout +-------------------- +Set/Get advertise discoverable timeout + Using this feature in LE will cause the LE Limited Discoverable Mode flag to be set in the primary advertisement and + The LE General Discoverable Mode flag will not be set. The LE Limited Discoverable Mode flag will automatically turn off after [seconds] + discoverable [on] must be set to use this feature + Entering the command by itself will show the time value + +:Usage: **# discoverable-timeout [seconds]** + +tx-power +-------- +Show/Enable/Disable TX power to be advertised + This sets the TX Power Level field in the advertising packet. The value is in dBm and can be between -127 and 127. + Entering the command by itself will show the current value + When this feature is turned on the LE device will advertise its transmit power in the primary advertisement + This feature can be modified while advertising. + Entering the command by itself will show the status of the setting + +:Usage: **# tx-power [on/off] [power]** + +name +---- +Configure local name to be advertised + Local name to be used in the advertising report. If the string is too big to fit into the packet it will be truncated. + It will either advertise as a complete local name or if it has to be truncated then a shortened local name + advertise.name "0123456789abcdef0123456789abcdef" + Text: 0123456789abcdef0123456789abc + There does not appear to be a way to tell if it is advertising with a complete or shortened local name. + +:Usage: **# name [on/off/name]** + +appearance +---------- +Configure custom appearance to be advertised + +:Usage: **# appearance [on/off/value]** + +duration +-------- +Set/Get advertise duration + The Duration parameter configures the length of an Instance. The value is in seconds. + A value of 0 indicates a default value is chosen for the Duration. The default is 2 seconds. + If only one advertising Instance has been added, then the Duration value will be ignored. + If multiple advertising Instances have been added, then the Duration value will be used to determine the length of time + each Instance is advertised for. The Duration value is used to calculate the number of advertising events that will be + used to advertise each Instance. The number of advertising events is calculated by dividing the Duration value by the + advertising interval. The advertising interval is determined by the advertising parameters that are set for each + Instance. The advertising interval is the maximum of the advertising intervals set for each Instance. + The Duration value is used to calculate the number of advertising events that will be used to advertise each Instance. + The number of advertising events is calculated by dividing the Duration value by the advertising interval. The advertising + interval is determined by the advertising parameters that are set for each Instance. The advertising interval is the maximum + of the advertising intervals set for each Instance. + The Duration value is used to calculate the number of advertising events that will be used to advertise each Instance. + The number of advertising events is calculated by dividing the Duration value by the advertising interval. The advertising + interval is determined by the advertising parameters that are set for each Instance. The advertising interval is the maximum + of the advertising intervals set for each Instance. + The Duration value is used to calculate the number of advertising events that will be used to advertise each Instance. + The number of advertising events is calculated by dividing the Duration value by the advertising interval. The advertising + interval is determined by the advertising parameters that are set for each Instance. The advertising interval is the maximum + of the advertising intervals set for each Instance. + The Duration value is used to calculate the number of advertising events that will be used to advertise each Instance. + The number of advertising events is calculated by dividing the Duration value by the advertising interval. The advertising + interval is determined by the advertising parameters that are set for each Instance. The advertising interval is the maximum + of the advertising intervals set for each Instance. + The Duration value is used to calculate the number of advertising events that will be used to advertise each Instance. + The number of advertising events is + calculated by dividing the Duration value by the advertising interval. The advertising interval is determined by the + advertising parameters that are set for each Instance. The advertising interval is the maximum of the advertising intervals + set for each Instance. + +:Usage: **# duration [seconds]** + +timeout +------- + Set/Get advertise timeout + +:Usage: **# timeout [seconds]** + +secondary +--------- + Set/Get advertise secondary channel + The Secondary parameter configures the secondary channel used for advertising. + +:Usage: **# secondary [1M/2M/Coded]** + +interval +-------- +Set/Get advertise interval + The Interval parameter configures the advertising interval of an Instance. The value is in milliseconds. + A value of 0 indicates a default value is chosen for the Interval. The default is 100 milliseconds. + The Interval value is used to calculate the number of advertising events that will be used to advertise each Instance. + The number of advertising events is calculated by dividing the Duration value by the advertising interval. The advertising + interval is determined by the advertising parameters that are set for each Instance. The advertising interval is the maximum + of the advertising intervals set for each Instance. + +:Usage: **# interval [milliseconds]** + +clear +----- +Clear advertise config + Clear the advertise configuration. This will stop advertising if it is currently advertising. + If you want to change the advertise configuration while advertising you must first clear the advertise configuration + and then set the new advertise configuration. + +:Usage: **# clear [uuids/service/manufacturer/config-name...]** + +back +---- +Return to main menu + +:Usage: **# back** + +version +------- +Display version + +:Usage: **# version** + +quit +---- +Quit program + +:Usage: **# quit** + +exit +---- +Quit program + +:Usage: **# exit** + +help +---- +Display help about this program + +:Usage: **# help** + +export +------ +Print environment variables + +:Usage: **# export** + +NOTES +===== +A byte is defined as an octet +{1} `Generic Access Profile Assigned Numbers document ` + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org From patchwork Sat Nov 4 01:38:46 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Otto X-Patchwork-Id: 13445361 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id DD921C4167B for ; Sat, 4 Nov 2023 01:39:59 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232051AbjKDBkA (ORCPT ); Fri, 3 Nov 2023 21:40:00 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53220 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231749AbjKDBj7 (ORCPT ); Fri, 3 Nov 2023 21:39:59 -0400 Received: from mail-qt1-x836.google.com (mail-qt1-x836.google.com [IPv6:2607:f8b0:4864:20::836]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5DECBD5F for ; Fri, 3 Nov 2023 18:39:56 -0700 (PDT) Received: by mail-qt1-x836.google.com with SMTP id d75a77b69052e-41cda37f697so3524761cf.1 for ; Fri, 03 Nov 2023 18:39:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=vt-edu.20230601.gappssmtp.com; s=20230601; t=1699061994; x=1699666794; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=YEYc3C4e01vd8hxswTLpWySMc5vBXViucBe9zio26pk=; b=CVekjqyvc+007Eie2xLWox1SdUpU5073gap3BSJmO8mtQB8w9bAIs7Yf46L27HshFd N3dTKv2sW+lxmsoYN1uTZ0NuwcXEon8oHyx5eUDV7Gn8B+zhbdngBd7hEa2HmBlmjLec 117ZEDI87Fd8vc/bGjXHGacLJqLWEgJulNVYFfPROEWlh0nrbid2dXBmfZjPNA5k7i99 CZQtDmn4EzzGdRXNo+5WC+duafimQAoLkzehPQuzhWdQ1SoqrCITR0lD68ndR3TuCGM8 WKw9VIZ5gTqwxrmhK+dDFmcJ4VP/5WtZDRWems1mNM4sgBjz5w6h19dh1sVEI3v/gfsT qQAA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699061994; x=1699666794; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=YEYc3C4e01vd8hxswTLpWySMc5vBXViucBe9zio26pk=; b=hI11dADjj0pc6O4wrRF9T0zsh/R11veEqAzl0cRm/CZ95iMJzawS/SE2kbQlbjVgxF dHyHt5eHEbNuWPabQ0PaQtM6OAxFjrWGih1VcrRoN+Hd2PVp7lTYFpAxKJEzRP+yskYc pV4W2C/urHixUjzp8NxUg27uJF/Kqz8IkIhmupFl8DWv/wnBptS8GhAvyKnw7AEIciSP llnm03fiOwCsiwtE2PXqAE3fc0yynJNRsFShxhszM2rMyWbFoTnB/iEFFXP0MYPcnZOg aImm8kjMS9RN0x7hljBR+pmkgjEXisaXeREDZIwpDtxbN7l4ycSyS19JSd7eyQmwWSKv BZYw== X-Gm-Message-State: AOJu0YxbJ0UBfeqWeJScT2rcumh9Mb3qKkT1G5oMXXIEs9YEHtTufzEs osU+b9egfxPNgdRyu54wA+Txn4YBwspiwysbar62EVvc/atC5o0hP6qXdXQ4Y7ztuWpeCwRWn8F W1FfMjuWNapN1fZaK0ctWAy9ZrYZMRCotslp5CYd7OQExb1V35WhCRcOMNdNJXZRplarU100ayh Qy X-Google-Smtp-Source: AGHT+IHEoj+exOGbB5jh5Wv34Yx09vO8WekZMUFuCpwon3KOeuaxwLAEb3cl2uxHIVfRxlPoxPamKA== X-Received: by 2002:a05:620a:190d:b0:774:17d6:31dc with SMTP id bj13-20020a05620a190d00b0077417d631dcmr26507934qkb.4.1699061994554; Fri, 03 Nov 2023 18:39:54 -0700 (PDT) Received: from debian.localdomain (c-73-177-243-39.hsd1.va.comcast.net. [73.177.243.39]) by smtp.gmail.com with ESMTPSA id l17-20020a05620a28d100b007770d47c621sm1216955qkp.66.2023.11.03.18.39.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Nov 2023 18:39:54 -0700 (PDT) From: Paul Otto To: linux-bluetooth@vger.kernel.org Cc: Paul Otto Subject: [PATCH BlueZ 3/7] update doc for bluetoothctl-endpoint.rst Date: Fri, 3 Nov 2023 21:38:46 -0400 Message-Id: <20231104013850.24182-4-potto@vt.edu> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20231104013850.24182-1-potto@vt.edu> References: <20231104013850.24182-1-potto@vt.edu> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Paul Otto --- client/bluetoothctl-endpoint.rst | 121 +++++++++++++++++++++++++++++++ 1 file changed, 121 insertions(+) create mode 100644 client/bluetoothctl-endpoint.rst diff --git a/client/bluetoothctl-endpoint.rst b/client/bluetoothctl-endpoint.rst new file mode 100644 index 000000000..95f981326 --- /dev/null +++ b/client/bluetoothctl-endpoint.rst @@ -0,0 +1,121 @@ +============ +bluetoothctl +============ + +---------------- +Endpoint Submenu +---------------- + +:Version: BlueZ +:Copyright: Free use of this software is granted under ther terms of the GNU + Lesser General Public Licenses (LGPL). +:Date: November 2022 +:Manual section: 1 +:Manual group: Linux System Administration + +SYNOPSIS +======== + +**bluetoothctl** [**-a** *capability*] [**-e**] [**-m**] [**-t** *seconds*] [**-v**] [**-h**] + +DESCRIPTION +=========== + +**bluetoothctl(1)** interactive bluetooth control tool. The tool works with Bluetooth Classic (BR/EDR) and Bluetooth Low Energy (LE) controllers. + +OPTIONS +======= + +-a capability, --agent capability Register agent handler: +-e, --endpoints Register Media endpoints +-m, --monitor Enable monitor output +-t seconds, --timeout seconds Timeout in seconds for non-interactive mode +-v, --version Display version +-h, --help Display help + +Endpoint Commands +================= + We divide bluetoothctl into main menu commands and submenu commands. The submenu commands control options + numbers for the commands can be hex (0x0F) or decimal (10) + +list +---- +List available endpoints + +:Usage: **# list [local]** + +show +---- +Endpoint information + +:Usage: **# show ** + +register +-------- +Register Endpoint + +:Usage: **# register [capabilities...]** + +unregister +---------- +Register Endpoint + +:Usage: **# unregister ** + +config +------ +Configure Endpoint + +:Usage: **# config [preset]** + +presets +------- +List available presets + +:Usage: **# presets [default]** + +back +---- +Return to main menu + +:Usage: **# back** + +version +------- +Display version + +:Usage: **# version** + +quit +---- +Quit program + +:Usage: **# quit** + +exit +---- +Quit program + +:Usage: **# exit** + +help +---- +Display help about this program + +:Usage: **# help** + +export +------ +Print environment variables + +:Usage: **# export** + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org From patchwork Sat Nov 4 01:38:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Otto X-Patchwork-Id: 13445362 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 67B40C4167D for ; Sat, 4 Nov 2023 01:40:02 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232024AbjKDBkD (ORCPT ); Fri, 3 Nov 2023 21:40:03 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49126 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231961AbjKDBkC (ORCPT ); Fri, 3 Nov 2023 21:40:02 -0400 Received: from mail-qk1-x72c.google.com (mail-qk1-x72c.google.com [IPv6:2607:f8b0:4864:20::72c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B79BBD54 for ; Fri, 3 Nov 2023 18:39:59 -0700 (PDT) Received: by mail-qk1-x72c.google.com with SMTP id af79cd13be357-77891670417so44077885a.0 for ; Fri, 03 Nov 2023 18:39:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=vt-edu.20230601.gappssmtp.com; s=20230601; t=1699061998; x=1699666798; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=4+XmwslSHI6aiYhUgryxeACv4fY557OUpCRJYsq9njk=; b=jeS0w3II8o8DCiZyKieacvsUPXU6t6lcdCLAVeGgtyREWONCbh2wD6ZFHkkaku02Vm Chf9X9gKm0w0xne3Pkcjk6YQDn0KggTOM5UAsKkWhtTULJjXVgN/9CJKptL6cAdqRi3O y9IEl3Ui378vwgxiDxbDdFu14O01v+zyfmtbn2nADuqTaR1LGSTL5cVmAhakWs22K3Zs flvd5nRjPoVuMOK26dTje91VjdzYnIs77R5vmnPNw3kpTu2ohuJtqls6KTpD24ltKoDX dplR97Q4IqnO8atQzDadFLZ9XibXtgA8b30aeRn05BbkT7avw0nbqliLefoIK6LRwa0j wQ6Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699061998; x=1699666798; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=4+XmwslSHI6aiYhUgryxeACv4fY557OUpCRJYsq9njk=; b=Hveeo0KHNzAmj5A+KrZmJ45UNTN9tEHZfwUGRqrfiHbYqCHamBJt/e0fG4oUm5u/YR DraxfbXaYsc2WhiLy0IcTXVCeAGKN1P8cZc4HoWUzLhMqUjfRXLpdBmsP+vBPLvzve+4 JwyrmVGdgpn9bIhC7t2iKOsWN2Htx5rPxbHXRoMQnceD2iOEoaeHa1m6x0hGV+tc6TO0 +JkcZvd2l28D0jbKOt13hHYz2xKHZgKgBdbdNm5qprEoh6pV+qYyypOppJuYGLeW3VES bDzhuYteOl/C/ILEsaFhP1GlUUaJfvzIs4fXyr+XDh3WRMpv+o1J057+KXypq4lqvACH aRJw== X-Gm-Message-State: AOJu0YzB0N+H3WT+51XDe2HvivjZD8sAh77jc6M6eGpQpB3nLuhhmELT wmDxsk7gY14RVV8712p1C8+yADgmBi2xhAhQbLXEQhDX06vUlhE0ud2Z6LOCHpmgh4xOoqLGA8g wK+FiHm+nKGLDx5+Y05UwjjIq70GM1ik4VpkBr7LNe77J1z+A7u0437716+c9YnNcUkuTbP4BdZ gM X-Google-Smtp-Source: AGHT+IEZM4LabqFnBPLB6zwBu4WRWDSPGbdZjVOQh/eDvSYguFhne1a8uvZ2W3b1D33FV5S0FGIgEg== X-Received: by 2002:a05:620a:4052:b0:76e:f686:cacb with SMTP id i18-20020a05620a405200b0076ef686cacbmr26722275qko.3.1699061997960; Fri, 03 Nov 2023 18:39:57 -0700 (PDT) Received: from debian.localdomain (c-73-177-243-39.hsd1.va.comcast.net. [73.177.243.39]) by smtp.gmail.com with ESMTPSA id l17-20020a05620a28d100b007770d47c621sm1216955qkp.66.2023.11.03.18.39.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Nov 2023 18:39:57 -0700 (PDT) From: Paul Otto To: linux-bluetooth@vger.kernel.org Cc: Paul Otto Subject: [PATCH BlueZ 4/7] update doc for bluetoothctl-gatt.rst Date: Fri, 3 Nov 2023 21:38:47 -0400 Message-Id: <20231104013850.24182-5-potto@vt.edu> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20231104013850.24182-1-potto@vt.edu> References: <20231104013850.24182-1-potto@vt.edu> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Paul Otto --- client/bluetoothctl-gatt.rst | 212 +++++++++++++++++++++++++++++++++++ 1 file changed, 212 insertions(+) create mode 100644 client/bluetoothctl-gatt.rst diff --git a/client/bluetoothctl-gatt.rst b/client/bluetoothctl-gatt.rst new file mode 100644 index 000000000..346e7f388 --- /dev/null +++ b/client/bluetoothctl-gatt.rst @@ -0,0 +1,212 @@ +============ +bluetoothctl +============ + +------------------------- +Generic Attribute Submenu +------------------------- + +:Version: BlueZ +:Copyright: Free use of this software is granted under ther terms of the GNU + Lesser General Public Licenses (LGPL). +:Date: November 2022 +:Manual section: 1 +:Manual group: Linux System Administration + +SYNOPSIS +======== + +**bluetoothctl** [**-a** *capability*] [**-e**] [**-m**] [**-t** *seconds*] [**-v**] [**-h**] + +OPTIONS +======= + +-a capability, --agent capability Register agent handler: +-e, --endpoints Register Media endpoints +-m, --monitor Enable monitor output +-t seconds, --timeout seconds Timeout in seconds for non-interactive mode +-v, --version Display version +-h, --help Display help + +COMMANDS +======== + We divide bluetoothctl into main menu commands and submenu commands. The submenu commands control options + numbers for the commands can be hex (0x0F) or decimal (10) + + + +Generic Attribute Commands +========================== + +list-attributes +--------------- +List attributes + +:Usage: **# list-attributes ** + +select-attribute +---------------- +Select attribute + +:Usage: **# select-attribute ** + +attribute-info +-------------- +Select attribute + +:Usage: **# attribute-info [attribute/UUID]** + +read +---- +Read attribute value + +:Usage: **# read [offset]** + +write +----- +Write attribute value + +:Usage: **# write [offset] [type]** + +acquire-write +------------- +Acquire Write file descriptor + +:Usage: **# acquire-write** + +release-write +------------- +Release Write file descriptor + +:Usage: **# release-write** + +acquire-notify +-------------- +Acquire Notify file descriptor + +:Usage: **# acquire-notify** + +release-notify +-------------- +Release Notify file descriptor + +:Usage: **# release-notify** + +notify +------ +Notify attribute value + +:Usage: **# notify ** + +clone +----- +Clone a device or attribute + +:Usage: **# clone [dev/attribute/UUID]** + +register-application +-------------------- +Register profile to connect + +:Usage: **# register-application [UUID ...]** + +unregister-application +---------------------- +Unregister profile + +:Usage: **# unregister-application** + +register-service +---------------- +Register application service. + +:Usage: **# register-service [handle]** + +unregister-service +------------------ +Unregister application service + +:Usage: **# unregister-service ** + +register-includes +----------------- +Register as Included service in. + +:Usage: **#r egister-includes [handle]** + +unregister-includes +------------------- +Unregister Included service. + +:Usage: **# unregister-includes ** + +register-characteristic +----------------------- +Register application characteristic + +:Usage: **# register-characteristic [handle]** + +unregister-characteristic +------------------------- +Unregister application characteristic + +:Usage: **# unregister-characteristic ** + +register-descriptor +------------------- +Register application descriptor + +:Usage: **# register-descriptor [handle]** + +unregister-descriptor +--------------------- +Unregister application descriptor + +:Usage: **# unregister-descriptor ** + +back +---- +Return to main menu + +:Usage: **# back** + +version +------- +Display version + +:Usage: **# version** + +quit +---- +Quit program + +:Usage: **# quit** + +exit +---- +Quit program + +:Usage: **# exit** + +help +---- +Display help about this program + +:Usage: **# help** + +export +------ +Print environment variables + +:Usage: **# export** + + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org From patchwork Sat Nov 4 01:38:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Otto X-Patchwork-Id: 13445363 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 86FF9C4332F for ; Sat, 4 Nov 2023 01:40:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232012AbjKDBkG (ORCPT ); Fri, 3 Nov 2023 21:40:06 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49172 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231749AbjKDBkF (ORCPT ); Fri, 3 Nov 2023 21:40:05 -0400 Received: from mail-qk1-x733.google.com (mail-qk1-x733.google.com [IPv6:2607:f8b0:4864:20::733]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 00CD7D49 for ; Fri, 3 Nov 2023 18:40:01 -0700 (PDT) Received: by mail-qk1-x733.google.com with SMTP id af79cd13be357-779d0c05959so43960585a.1 for ; Fri, 03 Nov 2023 18:40:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=vt-edu.20230601.gappssmtp.com; s=20230601; t=1699062000; x=1699666800; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=/GdiVLQENCpXVQxF1p4p75FAn4IaNPjZJJ2eYyHdYOY=; b=Gu8XQmOugDa3lbSzZriO/sHXD9ID2L0UMcmAl/ig7hro7cR7PiWONMijWkhR2c8i69 cw/LNb75KYMMUJBtc3DXAtAnCMPS6uCqDJNnvHSgQ/+fK9YWho3rO6mDqW+ad0dL/U3l 964KDZH2ooIPS0vIHWIx+ajxMLtFNNxwBGulbPVbKwU6tulUGW1D8wloCotEVY8byJmj 65qkSw0StpBSXLqFONXrcHbfjPOSiG4BTXkuvkmrAeCaHD11wK617SDECWsXjD2BxGkB L3OKkDY/RZKS+ONNdCWs3guNbVbmFkKvRG6qX63kE4j1D5mPx26ngPmrrJwx1GmK1LVM DZrg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699062000; x=1699666800; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=/GdiVLQENCpXVQxF1p4p75FAn4IaNPjZJJ2eYyHdYOY=; b=FUl2TuaqpGzyRQLXKl1I1JrlLX27wp9fZn5Gccv8694h34KTmnaFQF3Ddzpr4UEErx uUQc53fJtZ65s+DnyjDHN5DZpkP6C2yFwHeBe6NjJxBCqRd/FO/yKcC60RIWV/ANSakA Lf1UWWrZsh8/24HEQNfP4+1fY2nwkXl1RU2Fr3S0AsH0hesiR5loBiT0OSN26DM5TYcY gMiJEM6eMt8Fe945/8CvQlrWCm09MIQVR0wdvEMnW2yWpT/qunoXEL3/LCV7/efPOthp fXa5K8l/sE/IOzz4vc3ChPWMK/+bLkWM/MW3j5woNyzGBShocvuGfoveaSG3XTiaE33P FPCQ== X-Gm-Message-State: AOJu0YxgRzxx3RuIZGmtc7ZF02c0NBKagGOe3vOkxWh8vY9FI0tewErA 76ENMl12NBYUYB3ZnBnJyz6vz/XprEpfw7YLR7udoQUWbGjjCSoLvfxF9Mvwvl1f6h5VDvu/jbF /RHOwmRgOMfuIHlVBlppDoHaAa9GSy2GvnPKKUHiEy1L8M5J5/exojib1EwJtDCu+BDhHwLvxSe zh X-Google-Smtp-Source: AGHT+IEwCI43seHP/Ve/jmoJn3PbJWF7o1UQflxR9Mzg5k8fmWFpPrk6oShNC2o14BFF6oW5CWxXmQ== X-Received: by 2002:a05:620a:9041:b0:77a:69a1:b6a3 with SMTP id rl1-20020a05620a904100b0077a69a1b6a3mr3487516qkn.1.1699062000251; Fri, 03 Nov 2023 18:40:00 -0700 (PDT) Received: from debian.localdomain (c-73-177-243-39.hsd1.va.comcast.net. [73.177.243.39]) by smtp.gmail.com with ESMTPSA id l17-20020a05620a28d100b007770d47c621sm1216955qkp.66.2023.11.03.18.39.59 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Nov 2023 18:39:59 -0700 (PDT) From: Paul Otto To: linux-bluetooth@vger.kernel.org Cc: Paul Otto Subject: [PATCH BlueZ 5/7] update doc for bluetoothctl-player.rst Date: Fri, 3 Nov 2023 21:38:48 -0400 Message-Id: <20231104013850.24182-6-potto@vt.edu> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20231104013850.24182-1-potto@vt.edu> References: <20231104013850.24182-1-potto@vt.edu> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Paul Otto --- client/bluetoothctl-player.rst | 200 +++++++++++++++++++++++++++++++++ 1 file changed, 200 insertions(+) create mode 100644 client/bluetoothctl-player.rst diff --git a/client/bluetoothctl-player.rst b/client/bluetoothctl-player.rst new file mode 100644 index 000000000..96960c45b --- /dev/null +++ b/client/bluetoothctl-player.rst @@ -0,0 +1,200 @@ +=================== +bluetoothctl-player +=================== + +-------------------- +Media Player Submenu +-------------------- + +:Version: BlueZ +:Copyright: Free use of this software is granted under ther terms of the GNU + Lesser General Public Licenses (LGPL). +:Date: November 2022 +:Manual section: 1 +:Manual group: Linux System Administration + +SYNOPSIS +======== + +**bluetoothctl** [**-a** *capability*] [**-e**] [**-m**] [**-t** *seconds*] [**-v**] [**-h**] + +DESCRIPTION +=========== + +**bluetoothctl(1)** interactive bluetooth control tool. The tool works with Bluetooth Classic (BR/EDR) and Bluetooth Low Energy (LE) controllers. + +OPTIONS +======= + +-a capability, --agent capability Register agent handler: +-e, --endpoints Register Media endpoints +-m, --monitor Enable monitor output +-t seconds, --timeout seconds Timeout in seconds for non-interactive mode +-v, --version Display version +-h, --help Display help + +Media Player Commands +===================== + We divide bluetoothctl into main menu commands and submenu commands. The submenu commands control options + numbers for the commands can be hex (0x0F) or decimal (10) + +list +---- +List available players + +:Usage: **# list** + +show +---- +Show player information + +:Usage: **# show [player]** + +select +------ +Select default player + +:Usage: **# select ** + +play +---- +Start playback + +:Usage: **# play [item]** + +pause +----- +Pause playback + +:Usage: **# pause** + +stop +---- +Stop playback + +:Usage: **# stop** + +next +---- +Jump to next item + +:Usage: **# next** + +previous +-------- +Jump to previous item + +:Usage: **# previous** + +fast-forward +------------ +Fast forward playback + +:Usage: **# fast-forward** + +rewind +------ +Rewind playback + +:Usage: **# rewind** + +equalizer +--------- +Enable/Disable equalizer + +:Usage: **# equalizer ** + +repeat +------ +Set repeat mode + +:Usage: **# repeat ** + +shuffle +------- +Set shuffle mode + +:Usage: **# shuffle ** + +scan +---- +Set scan mode + +:Usage: **# scan ** + +change-folder +------------- +Change current folder + +:Usage: **# change-folder ** + +list-items +---------- +List items of current folder + +:Usage: **# list-items [start] [end]** + +search +------ +Search items containing string + +:Usage: **# search ** + +queue +----- +Add item to playlist queue + +:Usage: **# queue ** + +show-item +--------- +Show item information + +:Usage: **# show-item ** + +back +---- +Return to main menu + +:Usage: **# back** + +version +------- +Display version + +:Usage: **# version** + +quit +---- +Quit program + +:Usage: **# quit** + +exit +---- +Quit program + +:Usage: **# exit** + +help +---- +Display help about this program + +:Usage: **# help** + +export +------ +Print environment variables + +:Usage: **# export** + + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org From patchwork Sat Nov 4 01:38:49 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Otto X-Patchwork-Id: 13445364 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id E3394C4167B for ; Sat, 4 Nov 2023 01:40:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231911AbjKDBkI (ORCPT ); Fri, 3 Nov 2023 21:40:08 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53120 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231749AbjKDBkH (ORCPT ); Fri, 3 Nov 2023 21:40:07 -0400 Received: from mail-qv1-xf33.google.com (mail-qv1-xf33.google.com [IPv6:2607:f8b0:4864:20::f33]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 62543D49 for ; Fri, 3 Nov 2023 18:40:04 -0700 (PDT) Received: by mail-qv1-xf33.google.com with SMTP id 6a1803df08f44-671188b2d44so5540976d6.0 for ; Fri, 03 Nov 2023 18:40:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=vt-edu.20230601.gappssmtp.com; s=20230601; t=1699062003; x=1699666803; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=0kItXK8IfAw5zGkCx/+0mLlASj+bZH+aDao3uOHR3q8=; b=V7a7/RW5lB7JH13TESlm4g01B/7+2eybWqhv/0R0ykj88qVYMOmQuIe34dmqaAOaJe l516gxyg27+LiwMMLYGAD/+QZD7gcztuo69Er59vGhAYZZ51ttGmdQxZ5WHknATVg6Ac V7IILQchqJvt7buv0bGRq2Anx6kjNIgQegGrK32Rf/KJSmV9Z+ydLLBevmJbVI+4fnRd 7+8c/85SSIr1JrYpwHcdKSXoSshr+k24X5JwLjcRo3I99G2qUEyFeSvxzT70ChsF4uKm NBraG0csh2F52eecHk84HxZoKnTfkeHDeZ4RwJQBjK5FhLyzJn/JZgZX7XRzdHb03v7P uLOA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699062003; x=1699666803; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=0kItXK8IfAw5zGkCx/+0mLlASj+bZH+aDao3uOHR3q8=; b=bcarWBCQVeCCgKTYZZgbD6+W/KzKetWW60s1Yiu13IPJMZpBTr7E4kkMDUiL9iUnFQ y7T3YgKawCRE/+g8xJgA7EBatSur/89OXvqpkFKPGqNsCxMvW54/fBSUC/J1B81KI0WD 1sJVDYDfs3SqWIwvmX6vYm4LpUlan47e6mPtf3Q2E8owcG1vee+/FC/gUqY7uqjTfjmV ZpJqprHKFT7Xc/mZcbbzY2z1ARuHS87N5jZjC+0Egs7NimchmwlZ78r0H34xU38C6qXc dNeu8GBcn8twubxWOep69iTbf+/G1DDjbHPA2XuP/JFlwUserwJJ4/2bJ2vSmaeBuLh1 X/vw== X-Gm-Message-State: AOJu0YxVRY0SPJT6JI/lpxmrZnkj8AY5LktmMaEIczETJY5ej7s7dvvj gzTCR1yqV9su6YwOEJjbpg4LJRjIT9fnR4m5jaV4zHqdxsn6IR/deLPewtAh8mkj7fHp8YPr15g ZdrDrtb1ivDFSNoJJkk0G6T+uDGlougucnmcKwTZoO5QNyyW1m8DP0SrriJJb406EAwb9yVMco8 wp X-Google-Smtp-Source: AGHT+IGmoAIGGXh1Fd9otrPi1kAh4K1vQm+1DWDENIgWsmaZJoUFqEMRrUwH/QXzgi0nS2poN8xsKg== X-Received: by 2002:a05:620a:470e:b0:775:82e2:dc19 with SMTP id bs14-20020a05620a470e00b0077582e2dc19mr26495730qkb.2.1699062002473; Fri, 03 Nov 2023 18:40:02 -0700 (PDT) Received: from debian.localdomain (c-73-177-243-39.hsd1.va.comcast.net. [73.177.243.39]) by smtp.gmail.com with ESMTPSA id l17-20020a05620a28d100b007770d47c621sm1216955qkp.66.2023.11.03.18.40.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Nov 2023 18:40:02 -0700 (PDT) From: Paul Otto To: linux-bluetooth@vger.kernel.org Cc: Paul Otto Subject: [PATCH BlueZ 6/7] update doc for bluetoothctl-scan.rst Date: Fri, 3 Nov 2023 21:38:49 -0400 Message-Id: <20231104013850.24182-7-potto@vt.edu> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20231104013850.24182-1-potto@vt.edu> References: <20231104013850.24182-1-potto@vt.edu> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Paul Otto --- client/bluetoothctl-scan.rst | 146 +++++++++++++++++++++++++++++++++++ 1 file changed, 146 insertions(+) create mode 100644 client/bluetoothctl-scan.rst diff --git a/client/bluetoothctl-scan.rst b/client/bluetoothctl-scan.rst new file mode 100644 index 000000000..4bd06595d --- /dev/null +++ b/client/bluetoothctl-scan.rst @@ -0,0 +1,146 @@ +================= +bluetoothctl-scan +================= + +------------ +Scan Submenu +------------ + +:Version: BlueZ +:Copyright: Free use of this software is granted under ther terms of the GNU + Lesser General Public Licenses (LGPL). +:Date: July 2023 +:Manual section: 1 +:Manual group: Linux System Administration + +SYNOPSIS +======== + +**bluetoothctl** [**-a** *capability*] [**-e**] [**-m**] [**-t** *seconds*] [**-v**] [**-h**] [scan.commands] + +OPTIONS +======= + +-a capability, --agent capability Register agent handler: +-e, --endpoints Register Media endpoints +-m, --monitor Enable monitor output +-t seconds, --timeout seconds Timeout in seconds for non-interactive mode +-v, --version Display version +-h, --help Display help + +Scan Commands +============= + The scan commands control options numbers for the commands can be hex (0x0F) or decimal (10) + +uuids +----- +Set/Get UUIDs filter + +:Usage: **# uuids [all/uuid1 uuid2 ...]** + +rssi +---- +Set/Get RSSI filter, and clears pathloss +This sets the minimum rssi value for reporting device advertisements. The value is in dBm. +Example: To only show devices with rssi values greater than or equal to -60 dBm, use `scan.rssi -60`. +If one or more discovery filters have been set, the RSSI delta-threshold imposed by starting discovery by default will not be applied. + +:Usage: **# rssi [rssi]** + +pathloss +-------- +Set/Get Pathloss filter, and clears RSSI +This sets the maximum pathloss value for reporting device advertisements. The value is in dB. +Example: To only show devices with pathloss values less than or equal to 4 dB, use `scan.pathloss 4`. +If one or more discovery filters have been set, the RSSI delta-threshold imposed by starting discovery by default will not be applied. + +:Usage: **# pathloss [pathloss]** + +transport +--------- +Set/Get transport filter +Transport parameter determines the type of scan. The default is auto. + +Possible values: + +- "auto": interleaved scan +- "bredr": BR/EDR inquiry +- "le": LE scan only + +If "le" or "bredr" Transport is requested and the controller doesn't support it, an org.bluez.Error.Failed error will be returned. If "auto" transport is requested, the scan will use LE, BREDR, or both, depending on what's currently enabled on the controller. + +duplicate-data +-------------- +Set/Get duplicate data filter +Disables duplicate detection of advertisement data. When enabled, PropertiesChanged signals will be generated for ManufacturerData and ServiceData every time they are discovered. + +:Usage: **# duplicate-data [on/off]** + +discoverable +------------ +Set/Get discoverable filter +Makes the adapter discoverable while discovering. If the adapter is already discoverable, setting this filter won't have any effect. + +:Usage: **# discoverable [on/off]** + +pattern +------- +Set/Get pattern filter +Discover devices where the pattern matches either the prefix of the address or the device name, which is a convenient way to limit the number of device objects created during a discovery. +When set, it disregards device discoverable flags. +Note: The pattern matching is ignored if there are other clients that don't set any pattern, as it works as a logical OR. Also, setting an empty string "" pattern will match any device found. + +:Usage: **# pattern [value]** + + +clear +----- +Clears discovery filter + +:Usage: **# clear [uuids/rssi/pathloss/transport/duplicate-data/discoverable/pattern]** + +back +---- +Return to the main menu + +:Usage: **# back** + +version +------- +Display version + +:Usage: **# version** + +quit +---- +Quit program + +:Usage: **# quit** + +exit +---- +Quit program + +:Usage: **# exit** + +help +---- +Display help about this program + +:Usage: **# help** + +export +------ +Print environment variables + +:Usage: **# export** + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org From patchwork Sat Nov 4 01:38:50 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Otto X-Patchwork-Id: 13445365 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id C022EC4167D for ; Sat, 4 Nov 2023 01:40:08 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232109AbjKDBkJ (ORCPT ); Fri, 3 Nov 2023 21:40:09 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53132 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232098AbjKDBkI (ORCPT ); Fri, 3 Nov 2023 21:40:08 -0400 Received: from mail-qk1-x72f.google.com (mail-qk1-x72f.google.com [IPv6:2607:f8b0:4864:20::72f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0E11AD42 for ; Fri, 3 Nov 2023 18:40:06 -0700 (PDT) Received: by mail-qk1-x72f.google.com with SMTP id af79cd13be357-77891670417so44081585a.0 for ; Fri, 03 Nov 2023 18:40:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=vt-edu.20230601.gappssmtp.com; s=20230601; t=1699062004; x=1699666804; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=9L/sMvot63NywAIROe67VDyVaO6P9By3Y5eBlsF9ET0=; b=dlfSBmhu9o1nufBwuqYgobw6yyQdcvL39MTiU183ssLz5mdNuWUFCMbFZtVMFSOdQW vBzcbsBj+mAfwvZtcJW4dYmGKCYcXuenjR+8IAkH3/JZoDjOc5iGczyl78y1FvA9gIm0 mR9mIs/6jOLP2y+cpUL4+mJKfSj5XA9ka8ZU6Dw7QadxnxXKBL3ONXcQC3vkgSJDv5MW 9bNsLRQGAJ7JLbj4Za37Q46P9k38WnPlCSi2Oi1UQUHQPP59lRoiwxQ37wJ6OhVmdUUg E8kNA8VonaWo/jmETX1nePJbrSjegSk2xn39lJvTGg/bNQV/xfva7KuMhX1Gxlub6lyI Yi5w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699062004; x=1699666804; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=9L/sMvot63NywAIROe67VDyVaO6P9By3Y5eBlsF9ET0=; b=GefvqA0x30JRzxO5t7yt2tro7+rcf5O07qpnO+yrty13bY5uWWEcVJbyAuIaOXWS/7 r2iogASuzj84IkHB7dYUeQ1aMj2QzKZJGxpth5ZP9LgQDQavjlYjTkFDOUTbCXE3yKt1 4qGm8m4FnKInj1Vbe8Oysupb95mMj/85zp4ISmGOJyf055LM3nXZPP6SwWzh1Fzfm/+2 X0pHy/v0AOkckQ6UOvZNfVaGrENnsLP/163UX+Mef8t1KUMlLp6pByu89bCCnHx6fKvR wOnI0dExMEn/YI6p+DwBghA4ZnFOcJqPAWJDk/GlTSql2lxgFHx13VmWK+leGFLDtVoX qV5g== X-Gm-Message-State: AOJu0YxNy6PllhMmH+38PXj4GoeUNFpWJh2ZyzTf1BuCIlKicHZkB0pU dOrmCdUtsHJnWiNkMArf9E+LqgpsxwByYC1M8aov7UteWBioQvitBzwzqiq7EA8TnXxASzwIjNO C4D+qyyVjhkMoat75caC1xvcUGkgiJyBcLgWcH3/n7OyDKN49K8RLqJXWadYkV+vkCMTXV9Fne+ Uu X-Google-Smtp-Source: AGHT+IHWKD0P3O8pkriBxEu4wKOI8k4ojdurGsa2XCZuSsLuXQ49nPlbWkHMpNZpfLZxqTYWA39UkQ== X-Received: by 2002:ad4:4e8f:0:b0:668:e31b:5576 with SMTP id dy15-20020ad44e8f000000b00668e31b5576mr23753782qvb.1.1699062004325; Fri, 03 Nov 2023 18:40:04 -0700 (PDT) Received: from debian.localdomain (c-73-177-243-39.hsd1.va.comcast.net. [73.177.243.39]) by smtp.gmail.com with ESMTPSA id l17-20020a05620a28d100b007770d47c621sm1216955qkp.66.2023.11.03.18.40.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 03 Nov 2023 18:40:04 -0700 (PDT) From: Paul Otto To: linux-bluetooth@vger.kernel.org Cc: Paul Otto Subject: [PATCH BlueZ 7/7] update doc for bluetoothctl-transport.rst Date: Fri, 3 Nov 2023 21:38:50 -0400 Message-Id: <20231104013850.24182-8-potto@vt.edu> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20231104013850.24182-1-potto@vt.edu> References: <20231104013850.24182-1-potto@vt.edu> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Paul Otto --- client/bluetoothctl-transport.rst | 128 ++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 client/bluetoothctl-transport.rst diff --git a/client/bluetoothctl-transport.rst b/client/bluetoothctl-transport.rst new file mode 100644 index 000000000..3dd4d4a75 --- /dev/null +++ b/client/bluetoothctl-transport.rst @@ -0,0 +1,128 @@ +============ +bluetoothctl +============ + +----------------------- +Media Transport Submenu +----------------------- + +:Version: BlueZ +:Copyright: Free use of this software is granted under ther terms of the GNU + Lesser General Public Licenses (LGPL). +:Date: November 2022 +:Manual section: 1 +:Manual group: Linux System Administration + +SYNOPSIS +======== + +**bluetoothctl** [**-a** *capability*] [**-e**] [**-m**] [**-t** *seconds*] [**-v**] [**-h**] + +DESCRIPTION +=========== + +**bluetoothctl(1)** interactive bluetooth control tool. The tool works with Bluetooth Classic (BR/EDR) and Bluetooth Low Energy (LE) controllers. + +OPTIONS +======= + +-a capability, --agent capability Register agent handler: +-e, --endpoints Register Media endpoints +-m, --monitor Enable monitor output +-t seconds, --timeout seconds Timeout in seconds for non-interactive mode +-v, --version Display version +-h, --help Display help + +Media Transport Commands +========================= + We divide bluetoothctl into main menu commands and submenu commands. The submenu commands control options + numbers for the commands can be hex (0x0F) or decimal (10) + +list +---- +List available transports + +:Usage: **# list** + +show +---- +Show transport information + +:Usage: **# show ** + +acquire +------- +Acquire transport + +:Usage: **# acquire [transport1...]** + +release +------- +Release transport + +:Usage: **# release [transport1...]** + +send +---- +Send contents of a file + +:Usage: **# send ** + +receive +------- +Get/Set file to receive + +:Usage: **# receive [filename]** + +volume +------ +Get/Set transport volume + +:Usage: **# volume [value]** + +back +---- +Return to main menu + +:Usage: **# back** + +version +------- +Display version + +:Usage: **# version** + +quit +---- +Quit program + +:Usage: **# quit** + +exit +---- +Quit program + +:Usage: **# exit** + +help +---- +Display help about this program + +:Usage: **# help** + +export +------ +Print environment variables + +:Usage: **# export** + + +RESOURCES +========= + +http://www.bluez.org + +REPORTING BUGS +============== + +linux-bluetooth@vger.kernel.org