xref: /aosp_15_r20/external/pigweed/pw_system/cli.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1*61c4878aSAndroid Build Coastguard Worker.. _module-pw_system-cli:
2*61c4878aSAndroid Build Coastguard Worker
3*61c4878aSAndroid Build Coastguard Worker===============================
4*61c4878aSAndroid Build Coastguard Workerpw_system console CLI reference
5*61c4878aSAndroid Build Coastguard Worker===============================
6*61c4878aSAndroid Build Coastguard WorkerThese are the standard pw_system console command line arguments.
7*61c4878aSAndroid Build Coastguard Worker
8*61c4878aSAndroid Build Coastguard Worker.. argparse::
9*61c4878aSAndroid Build Coastguard Worker   :module: pw_system.console
10*61c4878aSAndroid Build Coastguard Worker   :func: get_parser
11*61c4878aSAndroid Build Coastguard Worker   :prog: pw system console
12*61c4878aSAndroid Build Coastguard Worker   :nodefaultconst:
13*61c4878aSAndroid Build Coastguard Worker   :nodescription:
14*61c4878aSAndroid Build Coastguard Worker   :noepilog:
15*61c4878aSAndroid Build Coastguard Worker
16*61c4878aSAndroid Build Coastguard Worker===================
17*61c4878aSAndroid Build Coastguard WorkerPython Console APIs
18*61c4878aSAndroid Build Coastguard Worker===================
19*61c4878aSAndroid Build Coastguard WorkerFunctions for establishing a connection to pw_system powered devices using Python.
20*61c4878aSAndroid Build Coastguard Worker
21*61c4878aSAndroid Build Coastguard Worker-------------------
22*61c4878aSAndroid Build Coastguard WorkerConsole startup API
23*61c4878aSAndroid Build Coastguard Worker-------------------
24*61c4878aSAndroid Build Coastguard Worker.. autofunction:: pw_system.console.main
25*61c4878aSAndroid Build Coastguard Worker
26*61c4878aSAndroid Build Coastguard Worker---------------------
27*61c4878aSAndroid Build Coastguard WorkerDevice connection API
28*61c4878aSAndroid Build Coastguard Worker---------------------
29*61c4878aSAndroid Build Coastguard WorkerDevice connections can be established in the same way as the pw_system console
30*61c4878aSAndroid Build Coastguard Workerbut through the Python function :py:func:`create_device_serial_or_socket_connection`.
31*61c4878aSAndroid Build Coastguard Worker
32*61c4878aSAndroid Build Coastguard Worker.. autofunction:: pw_system.device_connection.create_device_serial_or_socket_connection
33