A tool automating UART and ADB interaction
Project description
Quick Start
pyAutoPort is a BASH/ZSH toolset for communicating with a Device Under Test (DUT) connected via UART and/or ADB. Embedded system engineers can use this toolset for automating tests.
These commands can be executed directly from the terminal as system commands.
Installation
Install pyAutoPort-related commands using:
pip install pyAutoPort
Run this command INSIDE JUPYTER if you want to use this in a Jupyter notebook or Jupyter Lab.
Sending UART Commands
Send UART commands and receive replies with:
uart_send ${MESSAGE}
For example, you should be able to see "connected" in the output after running:
uart_send "echo connected"
To specify the UART port and baudrate, define them in environment variables like this:
- Linux/MacOS
export TESTER_UART_PORT="/dev/ttyACM0"
export TESTER_UART_BAUDRATE=1250000
- Windows
set TESTER_UART_PORT="/dev/ttyACM0"
set TESTER_UART_BAUDRATE=1250000
You don't need to send other commands to get output; uart_send
will return the output.
For additional information, refer to the Basic Mode section.
Interacting with ADB
While adb shell xxx
is widely used to run shell commands from scripts without user interaction, direct interaction via the command-line interface (CLI) is necessary sometimes, especially when running an interactive app behind ADB.
This package provides tools for keeping an ADB session open and interacting with it directly from a script without being trapped by adb shell
.
Open A Persistent ADB Session
adb_open&
Send Commands to ADB Session
adb_send some command
adb_send another command
Close ADB Sessions
adb_close
These commands simplify the process of sending and receiving data to and from your DUT using UART and ADB in various testing scenarios.
For additional information, refer to the Basic Mode section.
Basic Mode
Basic Mode provides commands integreated into Shell or Windows Command Propmt or PowerShell. Communication on UART and ADB are wrapped as command line commands.
Basic usage of Basic Mode can be found in Quick Start section. The following part focuses on additional information.
UART Communication
The uart_send
command facilitates interaction with UART. Its usage is as follows:
usage: uart_send [-h] [-t TIMEOUT] text [text ...]
positional arguments:
text Text to be sent via UART
options:
-h, --help Display this help message and exit
-t TIMEOUT, --timeout TIMEOUT
Time to wait before stopping reading
When using uart_send
, it will continuously print text received from UART until there is no new text within a 0.5-second interval. To extend the duration before stopping, specify a new timeout value using -t TIMEOUT
.
IMPORTANT: If UART continues to print text, especially in scenarios with enabled debugging logs, you may need to press Ctrl-C
to stop forcefully.
ADB Communication
Unlike UART, interacting with ADB involves a three-step process: opening an ADB session, interacting within the session, and finally closing the ADB session.
To initiate an ADB session, use the commands adb_open
or adb_reopen
. If a previous session was not closed safely, it's recommended to use adb_reopen
for recovery.
IMPORTANT: Run adb_open&
to open the session in the background. Otherwise, using adb_open
alone will block further command execution since it is a blocking command call.
For interaction with ADB, employ the adb_send
command with the following usage:
usage: adb_send [-h] [-t TIMEOUT] text [text ...]
positional arguments:
text Text to send via ADB
options:
-h, --help show this help message and exit
-t TIMEOUT, --timeout TIMEOUT
Time to wait before stopping reading
The adb_send
command will continuously print text received from ADB until no new text is received within a 1-second timeframe. To extend the timeout duration before stopping, use the -t TIMEOUT
option.
IMPORTANT: In situations where ADB keeps printing text, such as when running logcat, you may need to press Ctrl-C
to stop forcefully.
How to Contribute
See contributing guidelines for details. commit guidelines may also be helpful.
LICENSE
This project is under BSD-3 license.
Credits
We express our gratitude to all contributors for their valuable contributions to pyAutoPort!
Maintainers
- Yu GU Yu.Gu@sony.com (Basice Mode)
- Shuang LIANG Shuang.Liang@sony.com (TeraTerm Mode)
Contributors
Happy coding!
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyAutoPort-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f009489b808e222ae918071fb6d58679ff33239a8190217bf014bfd9e8f202d1 |
|
MD5 | 9c5e182f3e8b2b0c2651f9014a441693 |
|
BLAKE2b-256 | dd265a17e35f7082cdcc0aab29633abcd3968dc46c6e80ac97fe9c514bd079c6 |