diff -r 5f2377b32716 -r f848aacf3447 src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html --- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html Thu Mar 09 11:13:35 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html Thu Mar 09 14:53:36 2023 +0100 @@ -104,6 +104,10 @@ <td>Protected method to get the device code to set the time.</td> </tr> <tr> +<td><a href="#MicrobitDevice.activateBluetoothInterface">activateBluetoothInterface</a></td> +<td>Public method to activate the Bluetooth interface.</td> +</tr> +<tr> <td><a href="#MicrobitDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> <td>Public method to add device specific entries to the given menu.</td> </tr> @@ -124,6 +128,10 @@ <td>Public method to determine, if a REPL can be started.</td> </tr> <tr> +<td><a href="#MicrobitDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> +<td>Public method to deactivate the Bluetooth interface.</td> +</tr> +<tr> <td><a href="#MicrobitDevice.deviceName">deviceName</a></td> <td>Public method to get the name of the device.</td> </tr> @@ -132,6 +140,14 @@ <td>Public method to determine the need for an interrupt when opening the serial connection.</td> </tr> <tr> +<td><a href="#MicrobitDevice.getBluetoothStatus">getBluetoothStatus</a></td> +<td>Public method to get Bluetooth status data of the connected board.</td> +</tr> +<tr> +<td><a href="#MicrobitDevice.getDeviceScan">getDeviceScan</a></td> +<td>Public method to perform a Bluetooth device scan.</td> +</tr> +<tr> <td><a href="#MicrobitDevice.getDocumentationUrl">getDocumentationUrl</a></td> <td>Public method to get the device documentation URL.</td> </tr> @@ -140,6 +156,10 @@ <td>Public method to retrieve the entries for the downloads menu.</td> </tr> <tr> +<td><a href="#MicrobitDevice.hasBluetooth">hasBluetooth</a></td> +<td>Public method to check the availability of Bluetooth.</td> +</tr> +<tr> <td><a href="#MicrobitDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> <td>Public method to check, if the device has its own flash menu entry.</td> </tr> @@ -343,6 +363,32 @@ str </dd> </dl> +<a NAME="MicrobitDevice.activateBluetoothInterface" ID="MicrobitDevice.activateBluetoothInterface"></a> +<h4>MicrobitDevice.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="MicrobitDevice.addDeviceMenuEntries" ID="MicrobitDevice.addDeviceMenuEntries"></a> <h4>MicrobitDevice.addDeviceMenuEntries</h4> <b>addDeviceMenuEntries</b>(<i>menu</i>) @@ -437,6 +483,32 @@ tuple of (bool, str) </dd> </dl> +<a NAME="MicrobitDevice.deactivateBluetoothInterface" ID="MicrobitDevice.deactivateBluetoothInterface"></a> +<h4>MicrobitDevice.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="MicrobitDevice.deviceName" ID="MicrobitDevice.deviceName"></a> <h4>MicrobitDevice.deviceName</h4> <b>deviceName</b>(<i></i>) @@ -476,6 +548,61 @@ bool </dd> </dl> +<a NAME="MicrobitDevice.getBluetoothStatus" ID="MicrobitDevice.getBluetoothStatus"></a> +<h4>MicrobitDevice.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="MicrobitDevice.getDeviceScan" ID="MicrobitDevice.getDeviceScan"></a> +<h4>MicrobitDevice.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="MicrobitDevice.getDocumentationUrl" ID="MicrobitDevice.getDocumentationUrl"></a> <h4>MicrobitDevice.getDocumentationUrl</h4> <b>getDocumentationUrl</b>(<i></i>) @@ -515,6 +642,32 @@ list of tuple of (str, str) </dd> </dl> +<a NAME="MicrobitDevice.hasBluetooth" ID="MicrobitDevice.hasBluetooth"></a> +<h4>MicrobitDevice.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="MicrobitDevice.hasFlashMenuEntry" ID="MicrobitDevice.hasFlashMenuEntry"></a> <h4>MicrobitDevice.hasFlashMenuEntry</h4> <b>hasFlashMenuEntry</b>(<i></i>)