diff -r 829c1edbf253 -r d34667faa686 src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html --- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html Wed Mar 08 19:27:43 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html Wed Mar 08 19:28:56 2023 +0100 @@ -93,6 +93,14 @@ <li>getConnectedClients: get a list of connected WiFi clients</li> </ul> </p> +<p> + Supported Bluetooth commands are: + <ul> + <li>hasBluetooth: check, if the board has Bluetooth functionality</li> + <li>getBluetoothStatus: get Bluetooth status data</li> + <li>deactivateBluetoothInterface: deactivate a Bluetooth interface</li> + </ul> +</p> <h3>Derived from</h3> QObject <h3>Class Attributes</h3> @@ -126,6 +134,14 @@ <td>Protected method to create a shortened error message.</td> </tr> <tr> +<td><a href="#BaseDevice.activateBluetoothInterface">activateBluetoothInterface</a></td> +<td>Public method to activate the Bluetooth interface.</td> +</tr> +<tr> +<td><a href="#BaseDevice.addDeviceBluetoothEntries">addDeviceBluetoothEntries</a></td> +<td>Public method to add device specific entries to the given menu.</td> +</tr> +<tr> <td><a href="#BaseDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> <td>Public method to add device specific entries to the given menu.</td> </tr> @@ -134,6 +150,10 @@ <td>Public method to add device specific entries to the given menu.</td> </tr> <tr> +<td><a href="#BaseDevice.bool2str">bool2str</a></td> +<td>Public method to generate a yes/no string given a truth value.</td> +</tr> +<tr> <td><a href="#BaseDevice.canRunScript">canRunScript</a></td> <td>Public method to determine, if a script can be executed.</td> </tr> @@ -166,6 +186,10 @@ <td>Public method to connect a device to a WiFi network.</td> </tr> <tr> +<td><a href="#BaseDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> +<td>Public method to deactivate the Bluetooth interface.</td> +</tr> +<tr> <td><a href="#BaseDevice.deactivateInterface">deactivateInterface</a></td> <td>Public method to deactivate a given WiFi interface of the connected device.</td> </tr> @@ -198,6 +222,10 @@ <td>Public method to copy a file from the connected device.</td> </tr> <tr> +<td><a href="#BaseDevice.getBluetoothStatus">getBluetoothStatus</a></td> +<td>Public method to get Bluetooth status data of the connected board.</td> +</tr> +<tr> <td><a href="#BaseDevice.getBoardInformation">getBoardInformation</a></td> <td>Public method to get some information data of the connected board.</td> </tr> @@ -214,6 +242,10 @@ <td>Public method to get a copy of the determined device data.</td> </tr> <tr> +<td><a href="#BaseDevice.getDeviceScan">getDeviceScan</a></td> +<td>Public method to perform a Bluetooth device scan.</td> +</tr> +<tr> <td><a href="#BaseDevice.getDeviceType">getDeviceType</a></td> <td>Public method to get the device type.</td> </tr> @@ -493,6 +525,39 @@ str </dd> </dl> +<a NAME="BaseDevice.activateBluetoothInterface" ID="BaseDevice.activateBluetoothInterface"></a> +<h4>BaseDevice.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> +<a NAME="BaseDevice.addDeviceBluetoothEntries" ID="BaseDevice.addDeviceBluetoothEntries"></a> +<h4>BaseDevice.addDeviceBluetoothEntries</h4> +<b>addDeviceBluetoothEntries</b>(<i>menu</i>) + +<p> + Public method to add device specific entries to the given menu. +</p> +<dl> + +<dt><i>menu</i> (QMenu)</dt> +<dd> +reference to the context menu +</dd> +</dl> <a NAME="BaseDevice.addDeviceMenuEntries" ID="BaseDevice.addDeviceMenuEntries"></a> <h4>BaseDevice.addDeviceMenuEntries</h4> <b>addDeviceMenuEntries</b>(<i>menu</i>) @@ -521,6 +586,36 @@ reference to the context menu </dd> </dl> +<a NAME="BaseDevice.bool2str" ID="BaseDevice.bool2str"></a> +<h4>BaseDevice.bool2str</h4> +<b>bool2str</b>(<i>val, capitalized=True</i>) + +<p> + Public method to generate a yes/no string given a truth value. +</p> +<dl> + +<dt><i>val</i> (bool)</dt> +<dd> +truth value to be converted +</dd> +<dt><i>capitalized</i> (bool)</dt> +<dd> +flag indicating a capitalized variant +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +string with 'yes' or 'no' +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="BaseDevice.canRunScript" ID="BaseDevice.canRunScript"></a> <h4>BaseDevice.canRunScript</h4> <b>canRunScript</b>(<i></i>) @@ -699,6 +794,25 @@ tuple of (bool, str) </dd> </dl> +<a NAME="BaseDevice.deactivateBluetoothInterface" ID="BaseDevice.deactivateBluetoothInterface"></a> +<h4>BaseDevice.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> <a NAME="BaseDevice.deactivateInterface" ID="BaseDevice.deactivateInterface"></a> <h4>BaseDevice.deactivateInterface</h4> <b>deactivateInterface</b>(<i>interface</i>) @@ -889,6 +1003,26 @@ raised to indicate an issue with the device </dd> </dl> +<a NAME="BaseDevice.getBluetoothStatus" ID="BaseDevice.getBluetoothStatus"></a> +<h4>BaseDevice.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> <a NAME="BaseDevice.getBoardInformation" ID="BaseDevice.getBoardInformation"></a> <h4>BaseDevice.getBoardInformation</h4> <b>getBoardInformation</b>(<i></i>) @@ -994,6 +1128,34 @@ dict </dd> </dl> +<a NAME="BaseDevice.getDeviceScan" ID="BaseDevice.getDeviceScan"></a> +<h4>BaseDevice.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="BaseDevice.getDeviceType" ID="BaseDevice.getDeviceType"></a> <h4>BaseDevice.getDeviceType</h4> <b>getDeviceType</b>(<i></i>)