Mercurial Repositories > eric / file diff

--- a/eric6/Documentation/Source/eric6.MicroPython.MicrobitDevices.html	Sun Jan 17 13:53:08 2021 +0100
+++ b/eric6/Documentation/Source/eric6.MicroPython.MicrobitDevices.html	Mon Feb 01 10:38:16 2021 +0100
@@ -75,7 +75,7 @@
 </tr>
 <tr>
 <td><a href="#MicrobitDevice.__flashMicroPython">__flashMicroPython</a></td>
-<td>Private slot to flash the default MicroPython firmware to the device.</td>
+<td>Private slot to flash MicroPython or the DAPLink firmware to the device.</td>
 </tr>
 <tr>
 <td><a href="#MicrobitDevice.__resetDevice">__resetDevice</a></td>
@@ -114,6 +114,10 @@
 <td>Public method to get the name of the device.</td>
 </tr>
 <tr>
+<td><a href="#MicrobitDevice.downloadFirmware">downloadFirmware</a></td>
+<td>Public method to download the device firmware.</td>
+</tr>
+<tr>
 <td><a href="#MicrobitDevice.forceInterrupt">forceInterrupt</a></td>
 <td>Public method to determine the need for an interrupt when opening the serial connection.</td>
 </tr>
@@ -172,11 +176,19 @@
 </dl>
 <a NAME="MicrobitDevice.__flashMicroPython" ID="MicrobitDevice.__flashMicroPython"></a>
 <h4>MicrobitDevice.__flashMicroPython</h4>
-<b>__flashMicroPython</b>(<i></i>)
+<b>__flashMicroPython</b>(<i>firmware=False</i>)
 
 <p>
-        Private slot to flash the default MicroPython firmware to the device.
+        Private slot to flash MicroPython or the DAPLink firmware to the
+        device.
 </p>
+<dl>
+
+<dt><i>firmware</i> (bool)</dt>
+<dd>
+flag indicating to flash the DAPLink firmware
+</dd>
+</dl>
 <a NAME="MicrobitDevice.__resetDevice" ID="MicrobitDevice.__resetDevice"></a>
 <h4>MicrobitDevice.__resetDevice</h4>
 <b>__resetDevice</b>(<i></i>)
@@ -229,7 +241,7 @@
         Public method to determine, if a script can be executed.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple containing a flag indicating it is safe to start a
             Plotter and a reason why it cannot.
@@ -249,7 +261,7 @@
         Public method to determine, if a File Manager can be started.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple containing a flag indicating it is safe to start a
             File Manager and a reason why it cannot.
@@ -269,7 +281,7 @@
         Public method to determine, if a Plotter can be started.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple containing a flag indicating it is safe to start a
             Plotter and a reason why it cannot.
@@ -289,7 +301,7 @@
         Public method to determine, if a REPL can be started.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 tuple containing a flag indicating it is safe to start a REPL
             and a reason why it cannot.
@@ -309,7 +321,7 @@
         Public method to get the name of the device.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 name of the device
 </dd>
@@ -320,6 +332,13 @@
 str
 </dd>
 </dl>
+<a NAME="MicrobitDevice.downloadFirmware" ID="MicrobitDevice.downloadFirmware"></a>
+<h4>MicrobitDevice.downloadFirmware</h4>
+<b>downloadFirmware</b>(<i></i>)
+
+<p>
+        Public method to download the device firmware.
+</p>
 <a NAME="MicrobitDevice.forceInterrupt" ID="MicrobitDevice.forceInterrupt"></a>
 <h4>MicrobitDevice.forceInterrupt</h4>
 <b>forceInterrupt</b>(<i></i>)
@@ -329,7 +348,7 @@
         serial connection.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating an interrupt is needed
 </dd>
@@ -348,7 +367,7 @@
         Public method to get the device documentation URL.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 documentation URL of the device
 </dd>
@@ -361,13 +380,21 @@
 </dl>
 <a NAME="MicrobitDevice.getFirmwareUrl" ID="MicrobitDevice.getFirmwareUrl"></a>
 <h4>MicrobitDevice.getFirmwareUrl</h4>
-<b>getFirmwareUrl</b>(<i></i>)
+<b>getFirmwareUrl</b>(<i>fwtype="mpy"</i>)
 
 <p>
         Public method to get the device firmware download URL.
 </p>
 <dl>
-<dt>Returns:</dt>
+
+<dt><i>fwtype</i> (str (optional))</dt>
+<dd>
+type of firmware to download
+            (valid values are "mpy" and "dap"; defaults to "mpy")
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
 <dd>
 firmware download URL of the device
 </dd>
@@ -386,7 +413,7 @@
         Public method to get the workspace directory.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 workspace directory used for saving files
 </dd>
@@ -408,7 +435,7 @@
         The default returns True.
 </p>
 <dl>
-<dt>Returns:</dt>
+<dt>Return:</dt>
 <dd>
 flag indicating support for time commands
 </dd>