eric6/Documentation/Source/eric6.MicroPython.PyBoardDevices.html

changeset 7336
0095e231ddaf
parent 7296
d2f28511065e
child 7989
a21d673a8f99
diff -r 07ed3d73bf58 -r 0095e231ddaf eric6/Documentation/Source/eric6.MicroPython.PyBoardDevices.html
--- a/eric6/Documentation/Source/eric6.MicroPython.PyBoardDevices.html	Tue Nov 19 18:53:58 2019 +0100
+++ b/eric6/Documentation/Source/eric6.MicroPython.PyBoardDevices.html	Tue Nov 19 18:54:14 2019 +0100
@@ -77,7 +77,27 @@
 <td>Private method to check, if the device volume is mounted.</td>
 </tr>
 <tr>
-<td><a href="#PyBoardDevice.__showInstallInstructions">__showInstallInstructions</a></td>
+<td><a href="#PyBoardDevice.__dfuUtilAvailable">__dfuUtilAvailable</a></td>
+<td>Private method to check the availability of dfu-util.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.__flashMicroPython">__flashMicroPython</a></td>
+<td>Private slot to flash a MicroPython firmware.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.__listDfuCapableDevices">__listDfuCapableDevices</a></td>
+<td>Private slot to list all DFU-capable devices.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.__showDfuDisableInstructions">__showDfuDisableInstructions</a></td>
+<td>Private method to show some instructions to disable the DFU mode.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.__showDfuEnableInstructions">__showDfuEnableInstructions</a></td>
+<td>Private method to show some instructions to enable the DFU mode.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.__showFlashInstructions">__showFlashInstructions</a></td>
 <td>Private slot to open the URL containing instructions for installing MicroPython on the pyboard.</td>
 </tr>
 <tr>
@@ -113,6 +133,10 @@
 <td>Public method to get the device documentation URL.</td>
 </tr>
 <tr>
+<td><a href="#PyBoardDevice.getFirmwareUrl">getFirmwareUrl</a></td>
+<td>Public method to get the device firmware download URL.</td>
+</tr>
+<tr>
 <td><a href="#PyBoardDevice.getWorkspace">getWorkspace</a></td>
 <td>Public method to get the workspace directory.</td>
 </tr>
@@ -172,9 +196,75 @@
 bool
 </dd>
 </dl>
-<a NAME="PyBoardDevice.__showInstallInstructions" ID="PyBoardDevice.__showInstallInstructions"></a>
-<h4>PyBoardDevice.__showInstallInstructions</h4>
-<b>__showInstallInstructions</b>(<i></i>)
+<a NAME="PyBoardDevice.__dfuUtilAvailable" ID="PyBoardDevice.__dfuUtilAvailable"></a>
+<h4>PyBoardDevice.__dfuUtilAvailable</h4>
+<b>__dfuUtilAvailable</b>(<i></i>)
+
+<p>
+        Private method to check the availability of dfu-util.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating the availability of dfu-util
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="PyBoardDevice.__flashMicroPython" ID="PyBoardDevice.__flashMicroPython"></a>
+<h4>PyBoardDevice.__flashMicroPython</h4>
+<b>__flashMicroPython</b>(<i></i>)
+
+<p>
+        Private slot to flash a MicroPython firmware.
+</p>
+<a NAME="PyBoardDevice.__listDfuCapableDevices" ID="PyBoardDevice.__listDfuCapableDevices"></a>
+<h4>PyBoardDevice.__listDfuCapableDevices</h4>
+<b>__listDfuCapableDevices</b>(<i></i>)
+
+<p>
+        Private slot to list all DFU-capable devices.
+</p>
+<a NAME="PyBoardDevice.__showDfuDisableInstructions" ID="PyBoardDevice.__showDfuDisableInstructions"></a>
+<h4>PyBoardDevice.__showDfuDisableInstructions</h4>
+<b>__showDfuDisableInstructions</b>(<i></i>)
+
+<p>
+        Private method to show some instructions to disable the DFU mode.
+</p>
+<a NAME="PyBoardDevice.__showDfuEnableInstructions" ID="PyBoardDevice.__showDfuEnableInstructions"></a>
+<h4>PyBoardDevice.__showDfuEnableInstructions</h4>
+<b>__showDfuEnableInstructions</b>(<i>flash=True</i>)
+
+<p>
+        Private method to show some instructions to enable the DFU mode.
+</p>
+<dl>
+
+<dt><i>flash</i> (bool)</dt>
+<dd>
+flag indicating to show a warning message for flashing
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating OK to continue or abort
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="PyBoardDevice.__showFlashInstructions" ID="PyBoardDevice.__showFlashInstructions"></a>
+<h4>PyBoardDevice.__showFlashInstructions</h4>
+<b>__showFlashInstructions</b>(<i></i>)
 
 <p>
         Private slot to open the URL containing instructions for installing
@@ -332,6 +422,25 @@
 str
 </dd>
 </dl>
+<a NAME="PyBoardDevice.getFirmwareUrl" ID="PyBoardDevice.getFirmwareUrl"></a>
+<h4>PyBoardDevice.getFirmwareUrl</h4>
+<b>getFirmwareUrl</b>(<i></i>)
+
+<p>
+        Public method to get the device firmware download URL.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+firmware download URL of the device
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="PyBoardDevice.getWorkspace" ID="PyBoardDevice.getWorkspace"></a>
 <h4>PyBoardDevice.getWorkspace</h4>
 <b>getWorkspace</b>(<i>silent=False</i>)

eric ide

mercurial