Approved_users, administrator
366
edits
| As of August 2020 the site you are on (wiki.newae.com) is deprecated, and content is now at rtfm.newae.com. |
Changes
CW5
,no edit summary
The release of ChipWhisperer v5.0 has brought major changes to the front end of the ChipWhisperer software as well as a switch to Python 3: the GUI and the wiki tutorials have been replaced with Jupyter Notebooks, which allow users to run interactive Python blocks in their browser. Most of the The API remains unchanged from v4 is being updated anddocumented, with the exception of Python 2a push towards a stable and consistent interface.7 specific code, most GUI-less Most GUIless scripts for v4 should run as isbe compatible with the final release of v5, though users will be warned via the logging library about deprecated parts of the code base. Additional features, such as ChipWhipserer Analyzer support, are now available outside of any GUI.
=== Running Tutorials ===
Starting with ChipWhisperer v5.0, tutorials have been moved from the wiki into Jupyter Notebooks. Use Jupyter's file browser to navigate to <code>software/Jupyter</code>, which contains all of the tutorial notebooks. If you'd like to see our suggested completion order, you can open [<code]>!!Suggested_Completion_Order!!.ipynb[</code]>. Once you've decided which tutorial to run, open the tutorial via Jupyter.
Once you've got a notebook open, you'll find a combination of rich text and Python (and few special blocks, like the [<code]>%%bash[</code] > blocks. Near the top of the page, you'll find a special Python block with <code>#Parameters</code> in it. This block is used to select which scope (via <code>SCOPETYPE</code>) as well as which target (via <code>PLATFORM</code>) you'll be using for the tutorial. Make sure to edit these parameters for which hardware you're using. A list of common SCOPETYPE and PLATFORM values can be found [http://www.example.com here (not yet available)].
Now that this setup is complete, you can start actually running through the tutorials. To run a block, click on the block and make sure it's highlighted (the block should have either a green or blue outline around it), then click the <code>>| Run</code> button on the toolbar at the top of the screen. This will run the code inside of the block and move to the next one. Run the rest of the code block in the tutorial (all tutorials are designed to be able to be run with minimal modifications to the Python code).
=== Editing Blocks ===
To edit code blocks, simple click on the text portion of the block and begin making your changes. You'll know if you're in edit mode for a block because it will be highlighted in green.
== Documentation ==
Documentation for ChipWhisperer's Python API can now be found on [http://chipwhisperer.readthedocs.io/ ReadTheDocs]!
== New Features ==
New features that are planned to be available in the final CW5 release include:
* Analyzer and project support via the Python API
* New tutorials, including one submitted by a user via Github
* Support for multiple ChipWhisperers via Python API
* Simplified and standardized API
* Improved capture speed
* API documentation generated by Sphinx, available via ReadTheDocs
* Automated tests for every tutorial
* Contribution guide
* Completed tutorials on Wiki
* Lite GUI for plotting traces
