Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonUpdater.CircupFunctions.html
src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonUpdater.CircupFunctions.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 9756
- 9854647c8c5c
- child 10900
- 4139f17d07ad
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.MicroPython.Devices.CircuitPythonUpdater.CircupFunctions</h1> | 9 <h1>eric7.MicroPython.Devices.CircuitPythonUpdater.CircupFunctions</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing variants of some 'circup' functions suitable for 'eric-ide' | 11 Module implementing variants of some 'circup' functions suitable for 'eric-ide' |
| 13 integration. | 12 integration. |
| 14 </p> | 13 </p> |
| 14 | |
| 15 <h3>Global Attributes</h3> | 15 <h3>Global Attributes</h3> |
| 16 | |
| 17 <table> | 16 <table> |
| 18 <tr><td>None</td></tr> | 17 <tr><td>None</td></tr> |
| 19 </table> | 18 </table> |
| 19 | |
| 20 <h3>Classes</h3> | 20 <h3>Classes</h3> |
| 21 | |
| 22 <table> | 21 <table> |
| 23 <tr><td>None</td></tr> | 22 <tr><td>None</td></tr> |
| 24 </table> | 23 </table> |
| 24 | |
| 25 <h3>Functions</h3> | 25 <h3>Functions</h3> |
| 26 | |
| 27 <table> | 26 <table> |
| 28 | |
| 29 <tr> | 27 <tr> |
| 30 <td><a href="#ensure_latest_bundle">ensure_latest_bundle</a></td> | 28 <td><a href="#ensure_latest_bundle">ensure_latest_bundle</a></td> |
| 31 <td>Function to ensure that there's a copy of the latest library bundle available so circup can check the metadata contained therein.</td> | 29 <td>Function to ensure that there's a copy of the latest library bundle available so circup can check the metadata contained therein.</td> |
| 32 </tr> | 30 </tr> |
| 33 <tr> | 31 <tr> |
| 45 <tr> | 43 <tr> |
| 46 <td><a href="#patch_circup">patch_circup</a></td> | 44 <td><a href="#patch_circup">patch_circup</a></td> |
| 47 <td>Function to patch 'circup' to use our functions adapted to the use within the eric-ide.</td> | 45 <td>Function to patch 'circup' to use our functions adapted to the use within the eric-ide.</td> |
| 48 </tr> | 46 </tr> |
| 49 </table> | 47 </table> |
| 48 | |
| 50 <hr /> | 49 <hr /> |
| 51 <hr /> | 50 <hr /> |
| 52 <a NAME="ensure_latest_bundle" ID="ensure_latest_bundle"></a> | 51 <a NAME="ensure_latest_bundle" ID="ensure_latest_bundle"></a> |
| 53 <h2>ensure_latest_bundle</h2> | 52 <h2>ensure_latest_bundle</h2> |
| 54 <b>ensure_latest_bundle</b>(<i>bundle</i>) | 53 <b>ensure_latest_bundle</b>(<i>bundle</i>) |
| 55 | |
| 56 <p> | 54 <p> |
| 57 Function to ensure that there's a copy of the latest library bundle available so | 55 Function to ensure that there's a copy of the latest library bundle available so |
| 58 circup can check the metadata contained therein. | 56 circup can check the metadata contained therein. |
| 59 </p> | 57 </p> |
| 58 | |
| 60 <dl> | 59 <dl> |
| 61 | 60 |
| 62 <dt><i>bundle</i> (circup.Bundle)</dt> | 61 <dt><i>bundle</i> (circup.Bundle)</dt> |
| 63 <dd> | 62 <dd> |
| 64 reference to the target Bundle object. | 63 reference to the target Bundle object. |
| 68 <hr /> | 67 <hr /> |
| 69 <hr /> | 68 <hr /> |
| 70 <a NAME="find_modules" ID="find_modules"></a> | 69 <a NAME="find_modules" ID="find_modules"></a> |
| 71 <h2>find_modules</h2> | 70 <h2>find_modules</h2> |
| 72 <b>find_modules</b>(<i>device_path, bundles_list</i>) | 71 <b>find_modules</b>(<i>device_path, bundles_list</i>) |
| 73 | |
| 74 <p> | 72 <p> |
| 75 Function to extract metadata from the connected device and available bundles and | 73 Function to extract metadata from the connected device and available bundles and |
| 76 returns this as a list of Module instances representing the modules on the device. | 74 returns this as a list of Module instances representing the modules on the device. |
| 77 </p> | 75 </p> |
| 76 | |
| 78 <dl> | 77 <dl> |
| 79 | 78 |
| 80 <dt><i>device_path</i> (str)</dt> | 79 <dt><i>device_path</i> (str)</dt> |
| 81 <dd> | 80 <dd> |
| 82 path to the connected board | 81 path to the connected board |
| 103 <hr /> | 102 <hr /> |
| 104 <hr /> | 103 <hr /> |
| 105 <a NAME="get_circuitpython_version" ID="get_circuitpython_version"></a> | 104 <a NAME="get_circuitpython_version" ID="get_circuitpython_version"></a> |
| 106 <h2>get_circuitpython_version</h2> | 105 <h2>get_circuitpython_version</h2> |
| 107 <b>get_circuitpython_version</b>(<i>device_path</i>) | 106 <b>get_circuitpython_version</b>(<i>device_path</i>) |
| 108 | |
| 109 <p> | 107 <p> |
| 110 Function to return the version number of CircuitPython running on the board | 108 Function to return the version number of CircuitPython running on the board |
| 111 connected via ``device_path``, along with the board ID. | 109 connected via ``device_path``, along with the board ID. |
| 112 </p> | 110 </p> |
| 113 <p> | 111 <p> |
| 121 While the second line is: | 119 While the second line is: |
| 122 </p> | 120 </p> |
| 123 <p> | 121 <p> |
| 124 Board ID:raspberry_pi_pico | 122 Board ID:raspberry_pi_pico |
| 125 </p> | 123 </p> |
| 124 | |
| 126 <dl> | 125 <dl> |
| 127 | 126 |
| 128 <dt><i>device_path</i> (str)</dt> | 127 <dt><i>device_path</i> (str)</dt> |
| 129 <dd> | 128 <dd> |
| 130 path to the connected board. | 129 path to the connected board. |
| 146 <hr /> | 145 <hr /> |
| 147 <hr /> | 146 <hr /> |
| 148 <a NAME="install_module" ID="install_module"></a> | 147 <a NAME="install_module" ID="install_module"></a> |
| 149 <h2>install_module</h2> | 148 <h2>install_module</h2> |
| 150 <b>install_module</b>(<i>device_path, device_modules, name, py, mod_names</i>) | 149 <b>install_module</b>(<i>device_path, device_modules, name, py, mod_names</i>) |
| 151 | |
| 152 <p> | 150 <p> |
| 153 Function to find a connected device and install a given module name. | 151 Function to find a connected device and install a given module name. |
| 154 </p> | 152 </p> |
| 155 <p> | 153 <p> |
| 156 Installation is done if it is available in the current module bundle and is not | 154 Installation is done if it is available in the current module bundle and is not |
| 157 already installed on the device. | 155 already installed on the device. |
| 158 </p> | 156 </p> |
| 157 | |
| 159 <dl> | 158 <dl> |
| 160 | 159 |
| 161 <dt><i>device_path</i> (str)</dt> | 160 <dt><i>device_path</i> (str)</dt> |
| 162 <dd> | 161 <dd> |
| 163 path to the connected board | 162 path to the connected board |
| 197 <hr /> | 196 <hr /> |
| 198 <hr /> | 197 <hr /> |
| 199 <a NAME="patch_circup" ID="patch_circup"></a> | 198 <a NAME="patch_circup" ID="patch_circup"></a> |
| 200 <h2>patch_circup</h2> | 199 <h2>patch_circup</h2> |
| 201 <b>patch_circup</b>(<i></i>) | 200 <b>patch_circup</b>(<i></i>) |
| 202 | |
| 203 <p> | 201 <p> |
| 204 Function to patch 'circup' to use our functions adapted to the use within the | 202 Function to patch 'circup' to use our functions adapted to the use within the |
| 205 eric-ide. | 203 eric-ide. |
| 206 </p> | 204 </p> |
| 205 | |
| 207 <div align="right"><a href="#top">Up</a></div> | 206 <div align="right"><a href="#top">Up</a></div> |
| 208 <hr /> | 207 <hr /> |
| 209 </body></html> | 208 </body></html> |
