diff -r cf50045a7c0f -r d2f28511065e eric6/Documentation/Source/eric6.MicroPython.PyBoardDevices.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/Documentation/Source/eric6.MicroPython.PyBoardDevices.html Sat Oct 12 15:09:03 2019 +0200
@@ -0,0 +1,403 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.MicroPython.PyBoardDevices</title>
+<meta charset="UTF-8">
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric6.MicroPython.PyBoardDevices</h1>
+
+<p>
+Module implementing the device interface class for PyBoard boards.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#PyBoardDevice">PyBoardDevice</a></td>
+<td>Class implementing the device for PyBoard boards.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="PyBoardDevice" ID="PyBoardDevice"></a>
+<h2>PyBoardDevice</h2>
+
+<p>
+ Class implementing the device for PyBoard boards.
+</p>
+<h3>Derived from</h3>
+MicroPythonDevice
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>DeviceVolumeName</td></tr><tr><td>FlashInstructionsURL</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#PyBoardDevice.__init__">PyBoardDevice</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.__deviceVolumeMounted">__deviceVolumeMounted</a></td>
+<td>Private method to check, if the device volume is mounted.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.__showInstallInstructions">__showInstallInstructions</a></td>
+<td>Private slot to open the URL containing instructions for installing MicroPython on the pyboard.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td>
+<td>Public method to add device specific entries to the given menu.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.canRunScript">canRunScript</a></td>
+<td>Public method to determine, if a script can be executed.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.canStartFileManager">canStartFileManager</a></td>
+<td>Public method to determine, if a File Manager can be started.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.canStartPlotter">canStartPlotter</a></td>
+<td>Public method to determine, if a Plotter can be started.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.canStartRepl">canStartRepl</a></td>
+<td>Public method to determine, if a REPL can be started.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.deviceName">deviceName</a></td>
+<td>Public method to get the name of the device.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.forceInterrupt">forceInterrupt</a></td>
+<td>Public method to determine the need for an interrupt when opening the serial connection.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.getDocumentationUrl">getDocumentationUrl</a></td>
+<td>Public method to get the device documentation URL.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.getWorkspace">getWorkspace</a></td>
+<td>Public method to get the workspace directory.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.runScript">runScript</a></td>
+<td>Public method to run the given Python script.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.setButtons">setButtons</a></td>
+<td>Public method to enable the supported action buttons.</td>
+</tr>
+<tr>
+<td><a href="#PyBoardDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td>
+<td>Public method to indicate file access via a local directory.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="PyBoardDevice.__init__" ID="PyBoardDevice.__init__"></a>
+<h4>PyBoardDevice (Constructor)</h4>
+<b>PyBoardDevice</b>(<i>microPythonWidget, parent=None</i>)
+
+<p>
+ Constructor
+</p>
+<dl>
+
+<dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
+<dd>
+reference to the main MicroPython widget
+</dd>
+<dt><i>parent</i> (QObject)</dt>
+<dd>
+reference to the parent object
+</dd>
+</dl>
+<a NAME="PyBoardDevice.__deviceVolumeMounted" ID="PyBoardDevice.__deviceVolumeMounted"></a>
+<h4>PyBoardDevice.__deviceVolumeMounted</h4>
+<b>__deviceVolumeMounted</b>(<i></i>)
+
+<p>
+ Private method to check, if the device volume is mounted.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+flag indicated a mounted device
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="PyBoardDevice.__showInstallInstructions" ID="PyBoardDevice.__showInstallInstructions"></a>
+<h4>PyBoardDevice.__showInstallInstructions</h4>
+<b>__showInstallInstructions</b>(<i></i>)
+
+<p>
+ Private slot to open the URL containing instructions for installing
+ MicroPython on the pyboard.
+</p>
+<a NAME="PyBoardDevice.addDeviceMenuEntries" ID="PyBoardDevice.addDeviceMenuEntries"></a>
+<h4>PyBoardDevice.addDeviceMenuEntries</h4>
+<b>addDeviceMenuEntries</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="PyBoardDevice.canRunScript" ID="PyBoardDevice.canRunScript"></a>
+<h4>PyBoardDevice.canRunScript</h4>
+<b>canRunScript</b>(<i></i>)
+
+<p>
+ Public method to determine, if a script can be executed.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing a flag indicating it is safe to start a
+ Plotter and a reason why it cannot.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
+<a NAME="PyBoardDevice.canStartFileManager" ID="PyBoardDevice.canStartFileManager"></a>
+<h4>PyBoardDevice.canStartFileManager</h4>
+<b>canStartFileManager</b>(<i></i>)
+
+<p>
+ Public method to determine, if a File Manager can be started.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing a flag indicating it is safe to start a
+ File Manager and a reason why it cannot.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
+<a NAME="PyBoardDevice.canStartPlotter" ID="PyBoardDevice.canStartPlotter"></a>
+<h4>PyBoardDevice.canStartPlotter</h4>
+<b>canStartPlotter</b>(<i></i>)
+
+<p>
+ Public method to determine, if a Plotter can be started.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing a flag indicating it is safe to start a
+ Plotter and a reason why it cannot.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
+<a NAME="PyBoardDevice.canStartRepl" ID="PyBoardDevice.canStartRepl"></a>
+<h4>PyBoardDevice.canStartRepl</h4>
+<b>canStartRepl</b>(<i></i>)
+
+<p>
+ Public method to determine, if a REPL can be started.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing a flag indicating it is safe to start a REPL
+ and a reason why it cannot.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
+<a NAME="PyBoardDevice.deviceName" ID="PyBoardDevice.deviceName"></a>
+<h4>PyBoardDevice.deviceName</h4>
+<b>deviceName</b>(<i></i>)
+
+<p>
+ Public method to get the name of the device.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+name of the device
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="PyBoardDevice.forceInterrupt" ID="PyBoardDevice.forceInterrupt"></a>
+<h4>PyBoardDevice.forceInterrupt</h4>
+<b>forceInterrupt</b>(<i></i>)
+
+<p>
+ Public method to determine the need for an interrupt when opening the
+ serial connection.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating an interrupt is needed
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="PyBoardDevice.getDocumentationUrl" ID="PyBoardDevice.getDocumentationUrl"></a>
+<h4>PyBoardDevice.getDocumentationUrl</h4>
+<b>getDocumentationUrl</b>(<i></i>)
+
+<p>
+ Public method to get the device documentation URL.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+documentation 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>)
+
+<p>
+ Public method to get the workspace directory.
+</p>
+<dl>
+
+<dt><i>silent</i> (bool)</dt>
+<dd>
+flag indicating silent operations
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+workspace directory used for saving files
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="PyBoardDevice.runScript" ID="PyBoardDevice.runScript"></a>
+<h4>PyBoardDevice.runScript</h4>
+<b>runScript</b>(<i>script</i>)
+
+<p>
+ Public method to run the given Python script.
+</p>
+<dl>
+
+<dt><i>script</i> (str)</dt>
+<dd>
+script to be executed
+</dd>
+</dl>
+<a NAME="PyBoardDevice.setButtons" ID="PyBoardDevice.setButtons"></a>
+<h4>PyBoardDevice.setButtons</h4>
+<b>setButtons</b>(<i></i>)
+
+<p>
+ Public method to enable the supported action buttons.
+</p>
+<a NAME="PyBoardDevice.supportsLocalFileAccess" ID="PyBoardDevice.supportsLocalFileAccess"></a>
+<h4>PyBoardDevice.supportsLocalFileAccess</h4>
+<b>supportsLocalFileAccess</b>(<i></i>)
+
+<p>
+ Public method to indicate file access via a local directory.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating file access via local directory
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
