--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html Wed Mar 08 19:27:43 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html Wed Mar 08 19:28:56 2023 +0100 @@ -127,6 +127,10 @@ <td>Private slot to start the 'Teensy Loader' application.</td> </tr> <tr> +<td><a href="#CircuitPythonDevice.activateBluetoothInterface">activateBluetoothInterface</a></td> +<td>Public method to activate the Bluetooth interface.</td> +</tr> +<tr> <td><a href="#CircuitPythonDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> <td>Public method to add device specific entries to the given menu.</td> </tr> @@ -155,6 +159,10 @@ <td>Public method to connect a device to a WiFi network.</td> </tr> <tr> +<td><a href="#CircuitPythonDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> +<td>Public method to deactivate the Bluetooth interface.</td> +</tr> +<tr> <td><a href="#CircuitPythonDevice.deactivateInterface">deactivateInterface</a></td> <td>Public method to deactivate a given WiFi interface of the connected device.</td> </tr> @@ -171,10 +179,18 @@ <td>Public method to determine the need for an interrupt when opening the serial connection.</td> </tr> <tr> +<td><a href="#CircuitPythonDevice.getBluetoothStatus">getBluetoothStatus</a></td> +<td>Public method to get Bluetooth status data of the connected board.</td> +</tr> +<tr> <td><a href="#CircuitPythonDevice.getConnectedClients">getConnectedClients</a></td> <td>Public method to get a list of connected clients.</td> </tr> <tr> +<td><a href="#CircuitPythonDevice.getDeviceScan">getDeviceScan</a></td> +<td>Public method to perform a Bluetooth device scan.</td> +</tr> +<tr> <td><a href="#CircuitPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td> <td>Public method to get the device documentation URL.</td> </tr> @@ -191,6 +207,10 @@ <td>Public method to get the workspace directory.</td> </tr> <tr> +<td><a href="#CircuitPythonDevice.hasBluetooth">hasBluetooth</a></td> +<td>Public method to check the availability of Bluetooth.</td> +</tr> +<tr> <td><a href="#CircuitPythonDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> <td>Public method to check, if the device has its own flash menu entry.</td> </tr> @@ -463,6 +483,32 @@ <p> Note: The application must be accessible via the application search path. </p> +<a NAME="CircuitPythonDevice.activateBluetoothInterface" ID="CircuitPythonDevice.activateBluetoothInterface"></a> +<h4>CircuitPythonDevice.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="CircuitPythonDevice.addDeviceMenuEntries" ID="CircuitPythonDevice.addDeviceMenuEntries"></a> <h4>CircuitPythonDevice.addDeviceMenuEntries</h4> <b>addDeviceMenuEntries</b>(<i>menu</i>) @@ -606,6 +652,32 @@ tuple of (bool, str) </dd> </dl> +<a NAME="CircuitPythonDevice.deactivateBluetoothInterface" ID="CircuitPythonDevice.deactivateBluetoothInterface"></a> +<h4>CircuitPythonDevice.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="CircuitPythonDevice.deactivateInterface" ID="CircuitPythonDevice.deactivateInterface"></a> <h4>CircuitPythonDevice.deactivateInterface</h4> <b>deactivateInterface</b>(<i>interface</i>) @@ -702,6 +774,33 @@ bool </dd> </dl> +<a NAME="CircuitPythonDevice.getBluetoothStatus" ID="CircuitPythonDevice.getBluetoothStatus"></a> +<h4>CircuitPythonDevice.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="CircuitPythonDevice.getConnectedClients" ID="CircuitPythonDevice.getConnectedClients"></a> <h4>CircuitPythonDevice.getConnectedClients</h4> <b>getConnectedClients</b>(<i></i>) @@ -722,6 +821,34 @@ tuple of ([(bytes, int)], str) </dd> </dl> +<a NAME="CircuitPythonDevice.getDeviceScan" ID="CircuitPythonDevice.getDeviceScan"></a> +<h4>CircuitPythonDevice.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="CircuitPythonDevice.getDocumentationUrl" ID="CircuitPythonDevice.getDocumentationUrl"></a> <h4>CircuitPythonDevice.getDocumentationUrl</h4> <b>getDocumentationUrl</b>(<i></i>) @@ -814,6 +941,32 @@ str </dd> </dl> +<a NAME="CircuitPythonDevice.hasBluetooth" ID="CircuitPythonDevice.hasBluetooth"></a> +<h4>CircuitPythonDevice.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="CircuitPythonDevice.hasFlashMenuEntry" ID="CircuitPythonDevice.hasFlashMenuEntry"></a> <h4>CircuitPythonDevice.hasFlashMenuEntry</h4> <b>hasFlashMenuEntry</b>(<i></i>)