diff options
author | Martin Braun <martin.braun@ettus.com> | 2020-11-19 15:27:22 +0100 |
---|---|---|
committer | michael-west <michael.west@ettus.com> | 2020-12-04 12:06:14 -0800 |
commit | fc2fc14b1ad796c94532315bfc09a1e8d030f7c5 (patch) | |
tree | 4d77b21baa57edb34fcf572cca3f738271ccb36d /host/docs/mpm.dox | |
parent | 31c544650f6004e8968d65f50db804f1b6164e7d (diff) | |
download | uhd-fc2fc14b1ad796c94532315bfc09a1e8d030f7c5.tar.gz uhd-fc2fc14b1ad796c94532315bfc09a1e8d030f7c5.tar.bz2 uhd-fc2fc14b1ad796c94532315bfc09a1e8d030f7c5.zip |
python: multi_usrp: Add get_mpm_client() API call
This is a new API call, only available on Python, and only available for
MPM devices (it is added dynamically). It returns an object that allows
calling RPC calls in a Pythonic manner.
Example:
>>> rpcc = usrp.get_mpm_client()
>>> print(rpcc.get_device_info()) # Will print device info, as returned
# by uhd_find_devices
Diffstat (limited to 'host/docs/mpm.dox')
-rw-r--r-- | host/docs/mpm.dox | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/host/docs/mpm.dox b/host/docs/mpm.dox index d53025fb5..d5dcc4d31 100644 --- a/host/docs/mpm.dox +++ b/host/docs/mpm.dox @@ -59,6 +59,28 @@ typically, high-performance applications will always run in network mode). \section mpm_debug Debugging Tools +\subsection mpm_debug_python Python-based Debugging + +The Python API has additional methods for interacting with MPM. When creating a +multi_usrp object, it is possible to get a direct reference to an MPM client: + +~~~{.python} +import uhd +# Assume args contains valid device args: +usrp = uhd.MultiUSRP(args) +mpmc = usrp.get_mpm_client() +# Now load device info over RPC and print: +print(mpmc.get_device_info()) +~~~ + +The RPC API calls are directly mapped to Python. + +\b Note: When using the MPM client directly, it is possible to put UHD and the +device into unsynchronized states. It is an advanced API, only recommended for +unusual low-level access to the device, or debugging. + +\subsection mpm_debug_other MPM Tools + The `mpm/tools/` subdirectory provides a useful tool for debugging and interacting with MPM called `mpm_shell.py`. It is a command line tool to directly access MPM commands. Like MPM, it requires Python 3. It can be invoked |