src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html

branch
eric7
changeset 10089
5fe9bfafbc7c
parent 10022
a95800b414b7
child 10144
45a9177c8e77
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html	Sun Jun 04 15:16:12 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html	Thu Jun 15 17:11:14 2023 +0200
@@ -96,6 +96,10 @@
 <td>Protected method to get the device code to set the time.</td>
 </tr>
 <tr>
+<td><a href="#RP2040Device.activateBluetoothInterface">activateBluetoothInterface</a></td>
+<td>Public method to activate the Bluetooth interface.</td>
+</tr>
+<tr>
 <td><a href="#RP2040Device.addDeviceMenuEntries">addDeviceMenuEntries</a></td>
 <td>Public method to add device specific entries to the given menu.</td>
 </tr>
@@ -136,6 +140,10 @@
 <td>Public method to connect a device to a WiFi network.</td>
 </tr>
 <tr>
+<td><a href="#RP2040Device.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td>
+<td>Public method to deactivate the Bluetooth interface.</td>
+</tr>
+<tr>
 <td><a href="#RP2040Device.deactivateEthernet">deactivateEthernet</a></td>
 <td>Public method to deactivate the Ethernet interface of the connected device.</td>
 </tr>
@@ -168,10 +176,18 @@
 <td>Public method to determine the need for an interrupt when opening the serial connection.</td>
 </tr>
 <tr>
+<td><a href="#RP2040Device.getBluetoothStatus">getBluetoothStatus</a></td>
+<td>Public method to get Bluetooth status data of the connected board.</td>
+</tr>
+<tr>
 <td><a href="#RP2040Device.getConnectedClients">getConnectedClients</a></td>
 <td>Public method to get a list of connected clients.</td>
 </tr>
 <tr>
+<td><a href="#RP2040Device.getDeviceScan">getDeviceScan</a></td>
+<td>Public method to perform a Bluetooth device scan.</td>
+</tr>
+<tr>
 <td><a href="#RP2040Device.getDocumentationUrl">getDocumentationUrl</a></td>
 <td>Public method to get the device documentation URL.</td>
 </tr>
@@ -188,6 +204,10 @@
 <td>Public method to get data related to the current WiFi status.</td>
 </tr>
 <tr>
+<td><a href="#RP2040Device.hasBluetooth">hasBluetooth</a></td>
+<td>Public method to check the availability of Bluetooth.</td>
+</tr>
+<tr>
 <td><a href="#RP2040Device.hasEthernet">hasEthernet</a></td>
 <td>Public method to check the availability of Ethernet.</td>
 </tr>
@@ -355,6 +375,32 @@
 str
 </dd>
 </dl>
+<a NAME="RP2040Device.activateBluetoothInterface" ID="RP2040Device.activateBluetoothInterface"></a>
+<h4>RP2040Device.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="RP2040Device.addDeviceMenuEntries" ID="RP2040Device.addDeviceMenuEntries"></a>
 <h4>RP2040Device.addDeviceMenuEntries</h4>
 <b>addDeviceMenuEntries</b>(<i>menu</i>)
@@ -558,6 +604,32 @@
 tuple of (bool, str)
 </dd>
 </dl>
+<a NAME="RP2040Device.deactivateBluetoothInterface" ID="RP2040Device.deactivateBluetoothInterface"></a>
+<h4>RP2040Device.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="RP2040Device.deactivateEthernet" ID="RP2040Device.deactivateEthernet"></a>
 <h4>RP2040Device.deactivateEthernet</h4>
 <b>deactivateEthernet</b>(<i></i>)
@@ -735,6 +807,33 @@
 bool
 </dd>
 </dl>
+<a NAME="RP2040Device.getBluetoothStatus" ID="RP2040Device.getBluetoothStatus"></a>
+<h4>RP2040Device.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="RP2040Device.getConnectedClients" ID="RP2040Device.getConnectedClients"></a>
 <h4>RP2040Device.getConnectedClients</h4>
 <b>getConnectedClients</b>(<i></i>)
@@ -755,6 +854,34 @@
 tuple of ([(bytes, int)], str)
 </dd>
 </dl>
+<a NAME="RP2040Device.getDeviceScan" ID="RP2040Device.getDeviceScan"></a>
+<h4>RP2040Device.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="RP2040Device.getDocumentationUrl" ID="RP2040Device.getDocumentationUrl"></a>
 <h4>RP2040Device.getDocumentationUrl</h4>
 <b>getDocumentationUrl</b>(<i></i>)
@@ -848,6 +975,32 @@
 raised to indicate an issue with the device
 </dd>
 </dl>
+<a NAME="RP2040Device.hasBluetooth" ID="RP2040Device.hasBluetooth"></a>
+<h4>RP2040Device.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="RP2040Device.hasEthernet" ID="RP2040Device.hasEthernet"></a>
 <h4>RP2040Device.hasEthernet</h4>
 <b>hasEthernet</b>(<i></i>)

eric ide

mercurial