diff -r 829c1edbf253 -r d34667faa686 src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html --- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html Wed Mar 08 19:27:43 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html Wed Mar 08 19:28:56 2023 +0100 @@ -132,6 +132,10 @@ <td>Protected method to get the device code to set the time.</td> </tr> <tr> +<td><a href="#EspDevice.activateBluetoothInterface">activateBluetoothInterface</a></td> +<td>Public method to activate the Bluetooth interface.</td> +</tr> +<tr> <td><a href="#EspDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> <td>Public method to add device specific entries to the given menu.</td> </tr> @@ -160,6 +164,10 @@ <td>Public method to connect a device to a WiFi network.</td> </tr> <tr> +<td><a href="#EspDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> +<td>Public method to deactivate the Bluetooth interface.</td> +</tr> +<tr> <td><a href="#EspDevice.deactivateInterface">deactivateInterface</a></td> <td>Public method to deactivate a given WiFi interface of the connected device.</td> </tr> @@ -176,10 +184,18 @@ <td>Public method to determine the need for an interrupt when opening the serial connection.</td> </tr> <tr> +<td><a href="#EspDevice.getBluetoothStatus">getBluetoothStatus</a></td> +<td>Public method to get Bluetooth status data of the connected board.</td> +</tr> +<tr> <td><a href="#EspDevice.getConnectedClients">getConnectedClients</a></td> <td>Public method to get a list of connected clients.</td> </tr> <tr> +<td><a href="#EspDevice.getDeviceScan">getDeviceScan</a></td> +<td>Public method to perform a Bluetooth device scan.</td> +</tr> +<tr> <td><a href="#EspDevice.getDocumentationUrl">getDocumentationUrl</a></td> <td>Public method to get the device documentation URL.</td> </tr> @@ -192,6 +208,10 @@ <td>Public method to get data related to the current WiFi status.</td> </tr> <tr> +<td><a href="#EspDevice.hasBluetooth">hasBluetooth</a></td> +<td>Public method to check the availability of Bluetooth.</td> +</tr> +<tr> <td><a href="#EspDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> <td>Public method to check, if the device has its own flash menu entry.</td> </tr> @@ -378,6 +398,32 @@ str </dd> </dl> +<a NAME="EspDevice.activateBluetoothInterface" ID="EspDevice.activateBluetoothInterface"></a> +<h4>EspDevice.activateBluetoothInterface</h4> +<b>activateBluetoothInterface</b>(<i></i>) + +<p> + Public method to activate the Bluetooth interface. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating the new state of the Bluetooth interface +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<dl> + +<dt>Raises <b>OSError</b>:</dt> +<dd> +raised to indicate an issue with the device +</dd> +</dl> <a NAME="EspDevice.addDeviceMenuEntries" ID="EspDevice.addDeviceMenuEntries"></a> <h4>EspDevice.addDeviceMenuEntries</h4> <b>addDeviceMenuEntries</b>(<i>menu</i>) @@ -521,6 +567,32 @@ tuple of (bool, str) </dd> </dl> +<a NAME="EspDevice.deactivateBluetoothInterface" ID="EspDevice.deactivateBluetoothInterface"></a> +<h4>EspDevice.deactivateBluetoothInterface</h4> +<b>deactivateBluetoothInterface</b>(<i></i>) + +<p> + Public method to deactivate the Bluetooth interface. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating the new state of the Bluetooth interface +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<dl> + +<dt>Raises <b>OSError</b>:</dt> +<dd> +raised to indicate an issue with the device +</dd> +</dl> <a NAME="EspDevice.deactivateInterface" ID="EspDevice.deactivateInterface"></a> <h4>EspDevice.deactivateInterface</h4> <b>deactivateInterface</b>(<i>interface</i>) @@ -613,6 +685,33 @@ bool </dd> </dl> +<a NAME="EspDevice.getBluetoothStatus" ID="EspDevice.getBluetoothStatus"></a> +<h4>EspDevice.getBluetoothStatus</h4> +<b>getBluetoothStatus</b>(<i></i>) + +<p> + Public method to get Bluetooth status data of the connected board. +</p> +<dl> +<dt>Return:</dt> +<dd> +list of tuples containing the translated status data label and + the associated value +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of tuples of (str, str) +</dd> +</dl> +<dl> + +<dt>Raises <b>OSError</b>:</dt> +<dd> +raised to indicate an issue with the device +</dd> +</dl> <a NAME="EspDevice.getConnectedClients" ID="EspDevice.getConnectedClients"></a> <h4>EspDevice.getConnectedClients</h4> <b>getConnectedClients</b>(<i></i>) @@ -633,6 +732,34 @@ tuple of ([(bytes, int)], str) </dd> </dl> +<a NAME="EspDevice.getDeviceScan" ID="EspDevice.getDeviceScan"></a> +<h4>EspDevice.getDeviceScan</h4> +<b>getDeviceScan</b>(<i>timeout=10</i>) + +<p> + Public method to perform a Bluetooth device scan. +</p> +<dl> + +<dt><i>timeout</i> (int (optional))</dt> +<dd> +duration of the device scan in seconds (defaults + to 10) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a dictionary with the scan results and + an error string +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (dict, str) +</dd> +</dl> <a NAME="EspDevice.getDocumentationUrl" ID="EspDevice.getDocumentationUrl"></a> <h4>EspDevice.getDocumentationUrl</h4> <b>getDocumentationUrl</b>(<i></i>) @@ -698,6 +825,32 @@ raised to indicate an issue with the device </dd> </dl> +<a NAME="EspDevice.hasBluetooth" ID="EspDevice.hasBluetooth"></a> +<h4>EspDevice.hasBluetooth</h4> +<b>hasBluetooth</b>(<i></i>) + +<p> + Public method to check the availability of Bluetooth. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating the availability of Bluetooth +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<dl> + +<dt>Raises <b>OSError</b>:</dt> +<dd> +raised to indicate an issue with the device +</dd> +</dl> <a NAME="EspDevice.hasFlashMenuEntry" ID="EspDevice.hasFlashMenuEntry"></a> <h4>EspDevice.hasFlashMenuEntry</h4> <b>hasFlashMenuEntry</b>(<i></i>)