Skip to content

Commit 32392ae

Browse files
committed
fine-tuning of changes
1 parent e3f7505 commit 32392ae

File tree

6 files changed

+27
-17
lines changed

6 files changed

+27
-17
lines changed

serial_plugin/serial_base.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@
1111

1212
class SerialBase:
1313
"""
14-
Manages a MicroPython serial connection and REPL modes.
14+
Manages a MicroPython serial connection and offers REPL communication modes.
1515
"""
1616

1717
def __init__(self, port: str, baudrate: int = SERIAL_RATE, timeout: int = 2):
1818
"""
19-
Initializes a serial connection with the provided port settings.
19+
Initializes a serial connection with the provided usb device port settings.
2020
21-
:param port: The serial port to connect to.
21+
:param port: The serial device port to connect to.
2222
:type port: str
2323
:param baudrate: The baud rate for the connection, which determines data transmission speed.
2424
:type baudrate: int, optional

serial_plugin/serial_get_file_structure.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@
88

99
class FileStructure(SerialBase):
1010
"""
11-
Represents a utility for interacting with a MicroPython device to fetch and manage
12-
a tree structure of the file system over a serial connection.
11+
Represents a utility for interacting with a device to fetch and manage
12+
the file structure of MicroPython firmware flashed device over a
13+
serial connection.
1314
14-
:ivar _TREE_CODE: The Python code to generate the tree structure.
15+
:ivar _TREE_CODE: The MicroPython REPL code to generate the tree structure.
1516
"""
1617
_TREE_CODE = (
1718
"import os\n"

serial_plugin/serial_get_version.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@
77

88
class Version(SerialBase):
99
"""
10-
Represents a utility for interacting with a MicroPython device to fetch the
11-
current Micropython version information over a serial connection.
10+
Represents a utility for interacting with a device to fetch the
11+
current Micropython version of MicroPython firmware flashed device
12+
over a serial connection.
1213
"""
1314

1415
@staticmethod

ui/__init__.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
from .firmware_studio import CommandRunner
21
from .base_ui import BaseUI
3-
from .frame_search_device import FrameSearchDevice
2+
from .firmware_studio import CommandRunner
3+
from .frame_console import FrameConsole
44
from .frame_device_information import FrameDeviceInformation
55
from .frame_erase_device import FrameEraseDevice
66
from .frame_firmware_flash import FrameFirmwareFlash
7-
from .frame_console import FrameConsole
7+
from .frame_search_device import FrameSearchDevice
8+
89

9-
__all__ = ["CommandRunner",
10-
"BaseUI",
10+
__all__ = ["BaseUI",
11+
"CommandRunner",
12+
"FrameConsole",
1113
"FrameSearchDevice",
1214
"FrameDeviceInformation",
1315
"FrameEraseDevice",
14-
"FrameFirmwareFlash",
15-
"FrameConsole"]
16+
"FrameFirmwareFlash"
17+
]

ui/base_ui.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
class BaseUI(CTk):
1313
"""
1414
BaseUI is responsible for the overall layout and initialization of the graphical
15-
user interface (GUI). It manages the creation of UI frames.
15+
user interface (GUI). It manages the creation and configuration OS detection,
16+
Default Window settings and grid layout.
1617
"""
1718

1819
def __init__(self):

ui/firmware_studio.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,12 @@
2424

2525
class MicroPythonFirmwareStudio(BaseUI):
2626
"""
27-
A class representing the MicroPython Firmware Studio GUI via CTkinter.
27+
A GUI class to manage ESP device configuration and firmware flashing.
28+
29+
Provides an interface to connect, configure, and flash firmware for ESP devices.
30+
Includes options to toggle expert mode and interact with device-specific details.
31+
32+
The class integrates multiple frames, to guide users through ESP device communication.
2833
"""
2934

3035
def __init__(self):

0 commit comments

Comments
 (0)