From 707f1ab729aef197ea5ea247e5f583c6c43c9b46 Mon Sep 17 00:00:00 2001 From: Ian Harvey Date: Sat, 9 Jan 2016 12:22:42 +0000 Subject: [PATCH] docs: add docs for public Peripheral properties, and getDevices() call --- docs/peripheral.rst | 15 +++++++++++++++ docs/scanentry.rst | 6 +++++- docs/scanner.rst | 4 ++++ 3 files changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/peripheral.rst b/docs/peripheral.rst index d7447fae..b36d852d 100644 --- a/docs/peripheral.rst +++ b/docs/peripheral.rst @@ -125,6 +125,21 @@ Instance Methods useful if you know the handle for the characteristic but do not have a suitable ``Characteristic`` object. +Properties +---------- +All the properties listed below are read-only. + +.. py:attribute:: addr + + Device MAC address (as a hex string separated by colons). +.. py:attribute:: addrType + + Device address type - one of *ADDR_TYPE_PUBLIC* or *ADDR_TYPE_RANDOM*; this will be a + printable string. + +.. py:attribute:: iface + + Bluetooth interface number (0 = ``/dev/hci0``) used for the connection. diff --git a/docs/scanentry.rst b/docs/scanentry.rst index f311c756..b5641f62 100644 --- a/docs/scanentry.rst +++ b/docs/scanentry.rst @@ -53,6 +53,10 @@ All the properties listed below are read-only. Device address type - one of *ADDR_TYPE_PUBLIC* or *ADDR_TYPE_RANDOM*. +.. py:attribute:: iface + + Bluetooth interface number (0 = ``/dev/hci0``) on which advertising information was seen. + .. py:attribute:: rssi Received Signal Strength Indication for the last received broadcast from the @@ -69,4 +73,4 @@ All the properties listed below are read-only. Integer count of the number of advertising packets received from the device so far (since *clear()* was called on the ``Scanner`` object which found it). - \ No newline at end of file + diff --git a/docs/scanner.rst b/docs/scanner.rst index 4bec2b78..bca2108a 100644 --- a/docs/scanner.rst +++ b/docs/scanner.rst @@ -61,6 +61,10 @@ Instance Methods Disables reception of advertising broadcasts. Should be called after *process()* has returned. +.. function:: getDevices() + + Returns a list (a *view* on Python 3.x) of ``ScanEntry`` objects for + all devices which have been discovered (since the last *clear()* call). Sample code -----------