bss/gp2040ce-binary-tools
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 9 Wiki Activity

--usb flag to edit-config direct off the board

Browse Source
This commit is contained in:
Brian S. Stephan 2023-07-07 18:55:56 -05:00
parent 70d3ce8be0
commit 0378269a00
Signed by: bss
GPG Key ID: 3DE06D3180895FCB
2 changed files with 34 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -24,12 +24,17 @@ currently the expectation is that you can run it yourself before invoking these
% pip install -Ur requirements/requirements-dev.txt
```
## Tools
In all cases, online help can be retrieved by providing the `-h` or ``--help`` flags to the below programs.
## Config Editor
[![asciicast](https://asciinema.org/a/67hELtUNkKCit4dFwYeAUa2fo.svg)](https://asciinema.org/a/67hELtUNkKCit4dFwYeAUa2fo)
A terminal UI config editor, capable of viewing and editing existing configurations, can be launched via
**edit-config**. It supports navigation both via the keyboard or the mouse.
**edit-config**. It supports navigation both via the keyboard or the mouse, and can either view and edit a binary file
made via `picotool`, or view the configuration directly on the board in BOOTSEL mode over USB (editing coming soon).
Simple usage:
@ -46,10 +51,6 @@ Simple usage:
A quick demonstration of the editor is available [on asciinema.org](https://asciinema.org/a/67hELtUNkKCit4dFwYeAUa2fo).
## Tools
In all cases, online help can be retrieved by providing the `-h` or ``--help`` flags to the below programs.
### concatenate
**concatenate** combines a GP2040-CE firmware .bin file (such as from a fresh build) and a GP2040-CE board's storage

35
gp2040ce_bintools/gui.py
View File

@ -17,7 +17,8 @@ from textual.widgets.tree import TreeNode
from gp2040ce_bintools import core_parser, handler
from gp2040ce_bintools.builder import write_new_config_to_filename
from gp2040ce_bintools.storage import get_config_from_file
from gp2040ce_bintools.pico import get_bootsel_endpoints, read
from gp2040ce_bintools.storage import STORAGE_MEMORY_ADDRESS, STORAGE_SIZE, get_config, get_config_from_file
logger = logging.getLogger(__name__)
@ -130,8 +131,19 @@ class ConfigEditor(App):
def __init__(self, *args, **kwargs):
"""Initialize config."""
self.config_filename = kwargs.pop('config_filename')
self.config_filename = kwargs.pop('config_filename', None)
self.whole_board = kwargs.pop('whole_board', False)
usb = kwargs.pop('usb', False)
# load the config
if usb:
endpoint_out, endpoint_in = get_bootsel_endpoints()
storage = read(endpoint_out, endpoint_in, STORAGE_MEMORY_ADDRESS, STORAGE_SIZE)
self.config = get_config(bytes(storage))
self.source_name = (f"DEVICE ID {hex(endpoint_out.device.idVendor)}:{hex(endpoint_out.device.idProduct)} "
f"on bus {endpoint_out.device.bus} address {endpoint_out.device.address}")
else:
self.config = get_config_from_file(self.config_filename, whole_board=self.whole_board)
self.source_name = self.config_filename
super().__init__(*args, **kwargs)
# disable normal logging and enable console logging if we're not headless
@ -149,11 +161,10 @@ class ConfigEditor(App):
def on_mount(self) -> None:
"""Load the configuration object into the tree view."""
self.config = get_config_from_file(self.config_filename, whole_board=self.whole_board)
tree = self.query_one(Tree)
tree.root.data = (None, self.config.DESCRIPTOR, self.config)
tree.root.set_label(self.config_filename)
tree.root.set_label(self.source_name)
missing_fields = [f for f in self.config.DESCRIPTOR.fields
if f not in [fp for fp, vp in self.config.ListFields()]]
for field_descriptor, field_value in sorted(self.config.ListFields(), key=lambda f: f[0].name):
@ -200,6 +211,9 @@ class ConfigEditor(App):
def action_save(self) -> None:
"""Save the configuration."""
if not self.config_filename:
raise NotImplementedError("saving to USB is not yet implemented!")
write_new_config_to_filename(self.config, self.config_filename, inject=self.whole_board)
self.push_screen(MessageScreen(f"Configuration saved to {self.config_filename}."))
@ -339,9 +353,16 @@ def edit_config():
description="Utilize a GUI to view and alter the contents of a GP2040-CE configuration.",
parents=[core_parser],
)
group = parser.add_mutually_exclusive_group(required=True)
group.add_argument('--usb', action='store_true', help="retrieve the config from a Pico board connected over USB "
"and in BOOTSEL mode")
group.add_argument('--filename', help=".bin file of a GP2040-CE board's config + footer or entire storage section, "
"or of a GP2040-CE's whole board dump if --whole-board is specified")
parser.add_argument('--whole-board', action='store_true', help="indicate the binary file is a whole board dump")
parser.add_argument('filename', help=".bin file of a GP2040-CE board's config + footer or entire storage section, "
"or of a GP2040-CE's whole board dump if --whole-board is specified")
args, _ = parser.parse_known_args()
app = ConfigEditor(config_filename=args.filename, whole_board=args.whole_board)
if args.usb:
app = ConfigEditor(usb=True)
else:
app = ConfigEditor(config_filename=args.filename, whole_board=args.whole_board)
app.run()