Message-ID: <83f20e7c05e16d62c6f88eeffeb5306853fd2adb.camel@iki.fi>
Subject: Re: [RFC 3/9] doc: Add set-api
From:   Pauli Virtanen <pav@iki.fi>
To:     Luiz Augusto von Dentz <luiz.dentz@gmail.com>,
        linux-bluetooth@vger.kernel.org
Date:   Sun, 05 Mar 2023 00:19:49 +0200
In-Reply-To: <20230303012742.1386291-3-luiz.dentz@gmail.com>
References: <20230303012742.1386291-1-luiz.dentz@gmail.com>
         <20230303012742.1386291-3-luiz.dentz@gmail.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
User-Agent: Evolution 3.46.4 (3.46.4-1.fc37) 
MIME-Version: 1.0
Precedence: bulk

Hi Luiz,

to, 2023-03-02 kello 17:27 -0800, Luiz Augusto von Dentz kirjoitti:
> > From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
> >=20
> > This adds set-api.rst which documents DeviceSet interface.
> > ---
> >  doc/set-api.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 53 insertions(+)
> >  create mode 100644 doc/set-api.rst
> >=20
> > diff --git a/doc/set-api.rst b/doc/set-api.rst
> > new file mode 100644
> > index 000000000000..17c5f93b6b86
> > --- /dev/null
> > +++ b/doc/set-api.rst
> > @@ -0,0 +1,53 @@
> > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> > +BlueZ D-Bus DeviceSet API description
> > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> > +
> > +
> > +DeviceSet interface
> > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> > +
> > +Service		org.bluez
> > +Interface	org.bluez.DeviceSet1
> > +Object path	[variable prefix]/{hci0,hci1,...}/set_{sirk}
> > +
> > +Methods
> > +=3D=3D=3D=3D=3D=3D=3D
> > +
> > +**void Connect() [experimental]**
> > +
> > +	Connects all **devices** members of the set, each member is
> > +	connected in sequence as they were added/loaded following the
> > +	same proceedure as described in **Device1.Connect**.
> > +
> > +	Possible errors: org.bluez.Error.NotReady
> > +			 org.bluez.Error.Failed
> > +			 org.bluez.Error.InProgress
> > +			 org.bluez.Error.AlreadyConnected
> > +
> > +**void Disconnect() [experimental]**
> > +
> > +	Disconnects all **devices** members of the set, each member is
> > +	disconnected in sequence as they were connected following the
> > +	same proceedure as described in **Device1.Disconnect**.
> > +
> > +	Possible errors: org.bluez.Error.NotConnected
> > +
> > +Properties
> > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> > +
> > +**bool AutoConnect [read-write, experimental]**
> > +
> > +	Indicates if the **devices** members of the set shall be automaticall=
y
> > +	connected once any of its members is connected.
> > +
> > +**array(object) Devices [ready-only, experimental]**
> > +
> > +	List of devices objects that are members of the set.
> > +
> > +**byte Size [read-only, experimental]**
> > +
> > +	Set members size.
> > +
> > +**byte Rank [read-only, experimental]**
> > +
> > +	Set members rank.

It looks like rank is supposed to be a property of each set member
device, not a constant property of the set like size.

See CSIS 5.4: "The value of the Set Member Rank characteristic exposed
by servers that are part of the same Coordinated Set shall be
contiguous integers starting from 0x01 to the size of the Coordinated
Set."

So maybe should be something like

**array(byte) Ranks [read-only, experimental]**

	Set member ranks.

--=20
Pauli Virtanen