--- a/src/eric7/Documentation/Source/eric7.MicroPython.BluetoothDialogs.BluetoothAdvertisement.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.BluetoothDialogs.BluetoothAdvertisement.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,28 +7,42 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.MicroPython.BluetoothDialogs.BluetoothAdvertisement</h1> - <p> Module implementing a class to parse and store the Bluetooth device advertisement data. </p> + <h3>Global Attributes</h3> - <table> -<tr><td>ADV_DIRECT_IND</td></tr><tr><td>ADV_IND</td></tr><tr><td>ADV_NONCONN_IND</td></tr><tr><td>ADV_SCAN_IND</td></tr><tr><td>ADV_TYPE_COMPLETE_NAME</td></tr><tr><td>ADV_TYPE_MANUFACTURER</td></tr><tr><td>ADV_TYPE_SHORT_NAME</td></tr><tr><td>ADV_TYPE_SVC_DATA</td></tr><tr><td>ADV_TYPE_TX_POWER_LEVEL</td></tr><tr><td>ADV_TYPE_UUID128_COMPLETE</td></tr><tr><td>ADV_TYPE_UUID128_INCOMPLETE</td></tr><tr><td>ADV_TYPE_UUID16_COMPLETE</td></tr><tr><td>ADV_TYPE_UUID16_INCOMPLETE</td></tr><tr><td>ADV_TYPE_UUID32_COMPLETE</td></tr><tr><td>ADV_TYPE_UUID32_INCOMPLETE</td></tr><tr><td>ManufacturerIDs</td></tr><tr><td>SCAN_RSP</td></tr><tr><td>ServiceIDs</td></tr> +<tr><td>ADV_DIRECT_IND</td></tr> +<tr><td>ADV_IND</td></tr> +<tr><td>ADV_NONCONN_IND</td></tr> +<tr><td>ADV_SCAN_IND</td></tr> +<tr><td>ADV_TYPE_COMPLETE_NAME</td></tr> +<tr><td>ADV_TYPE_MANUFACTURER</td></tr> +<tr><td>ADV_TYPE_SHORT_NAME</td></tr> +<tr><td>ADV_TYPE_SVC_DATA</td></tr> +<tr><td>ADV_TYPE_TX_POWER_LEVEL</td></tr> +<tr><td>ADV_TYPE_UUID128_COMPLETE</td></tr> +<tr><td>ADV_TYPE_UUID128_INCOMPLETE</td></tr> +<tr><td>ADV_TYPE_UUID16_COMPLETE</td></tr> +<tr><td>ADV_TYPE_UUID16_INCOMPLETE</td></tr> +<tr><td>ADV_TYPE_UUID32_COMPLETE</td></tr> +<tr><td>ADV_TYPE_UUID32_INCOMPLETE</td></tr> +<tr><td>ManufacturerIDs</td></tr> +<tr><td>SCAN_RSP</td></tr> +<tr><td>ServiceIDs</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#BluetoothAdvertisement">BluetoothAdvertisement</a></td> <td>Class to parse and store the Bluetooth device advertisement data.</td> </tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#_loadManufacturerIDs">_loadManufacturerIDs</a></td> <td>Function to load the manufacturer IDs.</td> @@ -38,30 +52,29 @@ <td>Function to load the service UUIDs.</td> </tr> </table> + <hr /> <hr /> <a NAME="BluetoothAdvertisement" ID="BluetoothAdvertisement"></a> <h2>BluetoothAdvertisement</h2> - <p> Class to parse and store the Bluetooth device advertisement data. </p> + <h3>Derived from</h3> None <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#BluetoothAdvertisement.__init__">BluetoothAdvertisement</a></td> <td>Constructor</td> @@ -115,19 +128,20 @@ <td>Public method to update the advertisement data.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="BluetoothAdvertisement.__init__" ID="BluetoothAdvertisement.__init__"></a> <h4>BluetoothAdvertisement (Constructor)</h4> <b>BluetoothAdvertisement</b>(<i>address</i>) - <p> Constructor </p> + <dl> <dt><i>address</i> (str)</dt> @@ -138,10 +152,10 @@ <a NAME="BluetoothAdvertisement.__decodeField" ID="BluetoothAdvertisement.__decodeField"></a> <h4>BluetoothAdvertisement.__decodeField</h4> <b>__decodeField</b>(<i>*advType</i>) - <p> Private method to get all fields of the specified types. </p> + <dl> <dt><i>*advType</i> (int)</dt> @@ -164,10 +178,10 @@ <a NAME="BluetoothAdvertisement.__splitBytes" ID="BluetoothAdvertisement.__splitBytes"></a> <h4>BluetoothAdvertisement.__splitBytes</h4> <b>__splitBytes</b>(<i>data, chunkSize</i>) - <p> Private method to split some data into chunks of given size. </p> + <dl> <dt><i>data</i> (bytes, bytearray, str)</dt> @@ -194,10 +208,10 @@ <a NAME="BluetoothAdvertisement.__str__" ID="BluetoothAdvertisement.__str__"></a> <h4>BluetoothAdvertisement.__str__</h4> <b>__str__</b>(<i></i>) - <p> Special method to generate a string representation. </p> + <dl> <dt>Return:</dt> <dd> @@ -213,10 +227,10 @@ <a NAME="BluetoothAdvertisement.address" ID="BluetoothAdvertisement.address"></a> <h4>BluetoothAdvertisement.address</h4> <b>address</b>(<i></i>) - <p> Public method to get the address string. </p> + <dl> <dt>Return:</dt> <dd> @@ -232,10 +246,10 @@ <a NAME="BluetoothAdvertisement.completeName" ID="BluetoothAdvertisement.completeName"></a> <h4>BluetoothAdvertisement.completeName</h4> <b>completeName</b>(<i></i>) - <p> Public method to get the complete advertised name, if available. </p> + <dl> <dt>Return:</dt> <dd> @@ -251,10 +265,10 @@ <a NAME="BluetoothAdvertisement.manufacturer" ID="BluetoothAdvertisement.manufacturer"></a> <h4>BluetoothAdvertisement.manufacturer</h4> <b>manufacturer</b>(<i>filterId=None, withName=False</i>) - <p> Public method to get the manufacturer data. </p> + <dl> <dt><i>filterId</i> (int (optional))</dt> @@ -283,10 +297,10 @@ <a NAME="BluetoothAdvertisement.name" ID="BluetoothAdvertisement.name"></a> <h4>BluetoothAdvertisement.name</h4> <b>name</b>(<i></i>) - <p> Public method to get the complete or shortened advertised name, if available. </p> + <dl> <dt>Return:</dt> <dd> @@ -302,10 +316,10 @@ <a NAME="BluetoothAdvertisement.rssi" ID="BluetoothAdvertisement.rssi"></a> <h4>BluetoothAdvertisement.rssi</h4> <b>rssi</b>(<i></i>) - <p> Public method to get the RSSI value. </p> + <dl> <dt>Return:</dt> <dd> @@ -321,10 +335,10 @@ <a NAME="BluetoothAdvertisement.services" ID="BluetoothAdvertisement.services"></a> <h4>BluetoothAdvertisement.services</h4> <b>services</b>(<i></i>) - <p> Public method to get the service IDs. </p> + <dl> <dt>Return:</dt> <dd> @@ -341,10 +355,10 @@ <a NAME="BluetoothAdvertisement.shortName" ID="BluetoothAdvertisement.shortName"></a> <h4>BluetoothAdvertisement.shortName</h4> <b>shortName</b>(<i></i>) - <p> Public method to get the shortened advertised name, if available. </p> + <dl> <dt>Return:</dt> <dd> @@ -360,10 +374,10 @@ <a NAME="BluetoothAdvertisement.txPower" ID="BluetoothAdvertisement.txPower"></a> <h4>BluetoothAdvertisement.txPower</h4> <b>txPower</b>(<i></i>) - <p> Public method to get the advertised power level in dBm. </p> + <dl> <dt>Return:</dt> <dd> @@ -379,10 +393,10 @@ <a NAME="BluetoothAdvertisement.update" ID="BluetoothAdvertisement.update"></a> <h4>BluetoothAdvertisement.update</h4> <b>update</b>(<i>advType, rssi, advData</i>) - <p> Public method to update the advertisement data. </p> + <dl> <dt><i>advType</i> (int)</dt> @@ -404,20 +418,20 @@ <a NAME="_loadManufacturerIDs" ID="_loadManufacturerIDs"></a> <h2>_loadManufacturerIDs</h2> <b>_loadManufacturerIDs</b>(<i></i>) - <p> Function to load the manufacturer IDs. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="_loadServiceUUIDs" ID="_loadServiceUUIDs"></a> <h2>_loadServiceUUIDs</h2> <b>_loadServiceUUIDs</b>(<i></i>) - <p> Function to load the service UUIDs. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>