diff -r 702ad0ef6b3f -r fd5ff16632cb src/eric7/Documentation/Source/eric7.MicroPython.ConvertToUF2Dialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.ConvertToUF2Dialog.html Fri Mar 17 19:10:33 2023 +0100 @@ -0,0 +1,198 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.ConvertToUF2Dialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.ConvertToUF2Dialog</h1> + +<p> +Module implementing a dialog to convert a .hex or .bin firmware file to .uf2. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#ConvertToUF2Dialog">ConvertToUF2Dialog</a></td> +<td>Class implementing a dialog to convert a .hex or .bin firmware file to .uf2.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="ConvertToUF2Dialog" ID="ConvertToUF2Dialog"></a> +<h2>ConvertToUF2Dialog</h2> + +<p> + Class implementing a dialog to convert a .hex or .bin firmware file to .uf2. +</p> +<h3>Derived from</h3> +QDialog, Ui_ConvertToUF2Dialog +<h3>Class Attributes</h3> + +<table> +<tr><td>ConvertScript</td></tr><tr><td>FamiliesFile</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#ConvertToUF2Dialog.__init__">ConvertToUF2Dialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#ConvertToUF2Dialog.__conversionFinished">__conversionFinished</a></td> +<td>Private slot handling the end of the conversion process.</td> +</tr> +<tr> +<td><a href="#ConvertToUF2Dialog.__populateFamilyComboBox">__populateFamilyComboBox</a></td> +<td>Private method to populate the chip family combo box with values read from 'uf2families.json' file.</td> +</tr> +<tr> +<td><a href="#ConvertToUF2Dialog.__readError">__readError</a></td> +<td>Private slot to read the standard error channel of the conversion process.</td> +</tr> +<tr> +<td><a href="#ConvertToUF2Dialog.__readOutput">__readOutput</a></td> +<td>Private slot to read the standard output channel of the conversion process.</td> +</tr> +<tr> +<td><a href="#ConvertToUF2Dialog.__updateConvertButton">__updateConvertButton</a></td> +<td>Private method to set the enabled status of the 'Convert' button.</td> +</tr> +<tr> +<td><a href="#ConvertToUF2Dialog.on_convertButton_clicked">on_convertButton_clicked</a></td> +<td>Private slot activating the conversion process.</td> +</tr> +<tr> +<td><a href="#ConvertToUF2Dialog.on_familiesComboBox_currentTextChanged">on_familiesComboBox_currentTextChanged</a></td> +<td>Private slot handling the selection of a chip family.</td> +</tr> +<tr> +<td><a href="#ConvertToUF2Dialog.on_firmwarePicker_textChanged">on_firmwarePicker_textChanged</a></td> +<td>Private slot handling a change of the firmware file name.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="ConvertToUF2Dialog.__init__" ID="ConvertToUF2Dialog.__init__"></a> +<h4>ConvertToUF2Dialog (Constructor)</h4> +<b>ConvertToUF2Dialog</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="ConvertToUF2Dialog.__conversionFinished" ID="ConvertToUF2Dialog.__conversionFinished"></a> +<h4>ConvertToUF2Dialog.__conversionFinished</h4> +<b>__conversionFinished</b>(<i>exitCode, exitStatus</i>) + +<p> + Private slot handling the end of the conversion process. +</p> +<dl> + +<dt><i>exitCode</i> (int)</dt> +<dd> +exit code of the process +</dd> +<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> +<dd> +exit status of the process +</dd> +</dl> +<a NAME="ConvertToUF2Dialog.__populateFamilyComboBox" ID="ConvertToUF2Dialog.__populateFamilyComboBox"></a> +<h4>ConvertToUF2Dialog.__populateFamilyComboBox</h4> +<b>__populateFamilyComboBox</b>(<i></i>) + +<p> + Private method to populate the chip family combo box with values read from + 'uf2families.json' file. +</p> +<a NAME="ConvertToUF2Dialog.__readError" ID="ConvertToUF2Dialog.__readError"></a> +<h4>ConvertToUF2Dialog.__readError</h4> +<b>__readError</b>(<i></i>) + +<p> + Private slot to read the standard error channel of the conversion process. +</p> +<a NAME="ConvertToUF2Dialog.__readOutput" ID="ConvertToUF2Dialog.__readOutput"></a> +<h4>ConvertToUF2Dialog.__readOutput</h4> +<b>__readOutput</b>(<i></i>) + +<p> + Private slot to read the standard output channel of the conversion process. +</p> +<a NAME="ConvertToUF2Dialog.__updateConvertButton" ID="ConvertToUF2Dialog.__updateConvertButton"></a> +<h4>ConvertToUF2Dialog.__updateConvertButton</h4> +<b>__updateConvertButton</b>(<i></i>) + +<p> + Private method to set the enabled status of the 'Convert' button. +</p> +<a NAME="ConvertToUF2Dialog.on_convertButton_clicked" ID="ConvertToUF2Dialog.on_convertButton_clicked"></a> +<h4>ConvertToUF2Dialog.on_convertButton_clicked</h4> +<b>on_convertButton_clicked</b>(<i></i>) + +<p> + Private slot activating the conversion process. +</p> +<a NAME="ConvertToUF2Dialog.on_familiesComboBox_currentTextChanged" ID="ConvertToUF2Dialog.on_familiesComboBox_currentTextChanged"></a> +<h4>ConvertToUF2Dialog.on_familiesComboBox_currentTextChanged</h4> +<b>on_familiesComboBox_currentTextChanged</b>(<i>family</i>) + +<p> + Private slot handling the selection of a chip family. +</p> +<dl> + +<dt><i>family</i> (str)</dt> +<dd> +name of the selected chip family +</dd> +</dl> +<a NAME="ConvertToUF2Dialog.on_firmwarePicker_textChanged" ID="ConvertToUF2Dialog.on_firmwarePicker_textChanged"></a> +<h4>ConvertToUF2Dialog.on_firmwarePicker_textChanged</h4> +<b>on_firmwarePicker_textChanged</b>(<i>firmware</i>) + +<p> + Private slot handling a change of the firmware file name. +</p> +<dl> + +<dt><i>firmware</i> (str)</dt> +<dd> +name of the firmware file +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file