Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonDevices.html	Sat Feb 11 19:52:53 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonDevices.html	Sat Feb 11 19:53:53 2023 +0100
@@ -96,6 +96,10 @@
 <td>Public method to determine, if a REPL can be started.</td>
 </tr>
 <tr>
+<td><a href="#MicroPythonDevice.checkDeviceData">checkDeviceData</a></td>
+<td>Public method to check the validity of the device data determined during connecting the device.</td>
+</tr>
+<tr>
 <td><a href="#MicroPythonDevice.deviceName">deviceName</a></td>
 <td>Public method to get the name of the device.</td>
 </tr>
@@ -108,6 +112,10 @@
 <td>Public method to determine the need for an interrupt when opening the serial connection.</td>
 </tr>
 <tr>
+<td><a href="#MicroPythonDevice.getDeviceData">getDeviceData</a></td>
+<td>Public method to get a copy of the determined device data.</td>
+</tr>
+<tr>
 <td><a href="#MicroPythonDevice.getDeviceType">getDeviceType</a></td>
 <td>Public method to get the device type.</td>
 </tr>
@@ -164,6 +172,10 @@
 <td>Public method to enable the supported action buttons.</td>
 </tr>
 <tr>
+<td><a href="#MicroPythonDevice.setConnected">setConnected</a></td>
+<td>Public method to set the connection state.</td>
+</tr>
+<tr>
 <td><a href="#MicroPythonDevice.setFileManager">setFileManager</a></td>
 <td>Public method to set the File Manager status and dependent status.</td>
 </tr>
@@ -302,6 +314,26 @@
 tuple of (bool, str)
 </dd>
 </dl>
+<a NAME="MicroPythonDevice.checkDeviceData" ID="MicroPythonDevice.checkDeviceData"></a>
+<h4>MicroPythonDevice.checkDeviceData</h4>
+<b>checkDeviceData</b>(<i></i>)
+
+<p>
+        Public method to check the validity of the device data determined during
+        connecting the device.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating valid device data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="MicroPythonDevice.deviceName" ID="MicroPythonDevice.deviceName"></a>
 <h4>MicroPythonDevice.deviceName</h4>
 <b>deviceName</b>(<i></i>)
@@ -348,6 +380,25 @@
 bool
 </dd>
 </dl>
+<a NAME="MicroPythonDevice.getDeviceData" ID="MicroPythonDevice.getDeviceData"></a>
+<h4>MicroPythonDevice.getDeviceData</h4>
+<b>getDeviceData</b>(<i></i>)
+
+<p>
+        Public method to get a copy of the determined device data.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the essential device data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <a NAME="MicroPythonDevice.getDeviceType" ID="MicroPythonDevice.getDeviceType"></a>
 <h4>MicroPythonDevice.getDeviceType</h4>
 <b>getDeviceType</b>(<i></i>)
@@ -594,6 +645,24 @@
 <p>
         Public method to enable the supported action buttons.
 </p>
+<a NAME="MicroPythonDevice.setConnected" ID="MicroPythonDevice.setConnected"></a>
+<h4>MicroPythonDevice.setConnected</h4>
+<b>setConnected</b>(<i>connected</i>)
+
+<p>
+        Public method to set the connection state.
+</p>
+<p>
+        Note: This method can be overwritten to perform actions upon connect
+        or disconnect of the device.
+</p>
+<dl>
+
+<dt><i>connected</i> (bool)</dt>
+<dd>
+connection state
+</dd>
+</dl>
 <a NAME="MicroPythonDevice.setFileManager" ID="MicroPythonDevice.setFileManager"></a>
 <h4>MicroPythonDevice.setFileManager</h4>
 <b>setFileManager</b>(<i>on</i>)
@@ -660,7 +729,7 @@
 <hr />
 <a NAME="getDevice" ID="getDevice"></a>
 <h2>getDevice</h2>
-<b>getDevice</b>(<i>deviceType, microPythonWidget, vid, pid, boardName=""</i>)
+<b>getDevice</b>(<i>deviceType, microPythonWidget, vid, pid, boardName="", serialNumber=""</i>)
 
 <p>
     Public method to instantiate a specific MicroPython device interface.
@@ -687,6 +756,10 @@
 <dd>
 name of the board (defaults to "")
 </dd>
+<dt><i>serialNumber</i> (str (optional))</dt>
+<dd>
+serial number of the board (defaults to "")
+</dd>
 </dl>
 <dl>
 <dt>Return:</dt>