pw_console#

Pigweed AI summary: The Pigweed Console is a Python REPL and log message viewer designed to replace IPython's embed() function. It provides interactive RPC sending and immediate feedback on device status, and is easily embeddable within a project's own custom console. The log viewer includes searching and filtering capabilities. All code submissions require running the Manual Test Procedure, and commit messages should include a Testing: line with the steps that were manually run. Guides are available for user, embedding, plugins, testing, and internals.

host Python stable

The Pigweed Console provides a Python repl (read eval print loop) using ptpython and a log message viewer in a single-window terminal based interface. It is designed to be a replacement for IPython’s embed() function.

Pigweed Console screenshot with serial debug log messages.

Features#

Pigweed AI summary: The "pw_console" software is designed to provide a complete solution for interacting with hardware devices using "pw_rpc" over a "pw_hdlc" transport. It includes an interactive Python repl and log viewer in a single terminal window, making it easy to send RPC commands and receive immediate feedback on device status. It can also be easily embedded within a project's own custom console, and includes a log viewer with searching and filtering capabilities.

pw_console aims to be a complete solution for interacting with hardware devices using pw_rpc over a pw_hdlc transport.

  • Interactive Python repl and log viewer in a single terminal window. This provides interactive RPC sending while the log viewer provides immediate feedback on device status.

    Pigweed Console screenshot showing RPC Python repl completions.

  • Easily embeddable within a project’s own custom console. This should allow users to define their own transport layer.

  • Log viewer with searching and filtering.

Contributing#

Pigweed AI summary: Contributing to pw_console requires running the Manual Test Procedure for all code submissions. Commit messages should include a Testing line with the steps that were manually run.

  • All code submissions to pw_console require running the Manual Test Procedure.

  • Commit messages should include a Testing: line with the steps that were manually run.

Guides#

Pigweed AI summary: This paragraph describes a section called "Guides" which contains a list of entries related to the pw_console package. The entries include user guides, embedding, plugins, testing, and internals. The paragraph also includes links to external resources such as ipython, prompt_toolkit, and ptpython.