Port IMAGE - DEFAULT 🛈¶
Standard-Port für die Interaktion mit Android Geräten.
Stimulation¶
Dieser Port besitzt keine Stimulus-Fähigkeiten.
Eigenschaften 🛈¶
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
Device |
[<auto>, <manual>, <online query>] |
string |
Gerät, mit dem sich der Tool Server verbinden soll. |
||
Geräte-Id oder Netzwerkadresse |
Device: ‚<manual>‘ |
string |
Geräte-Id oder IP/Hostname und Port des Geräts z.B. emulator-5554 oder 192.168.100.10:37775. Ist kein Port angegeben, wird der Standardport 5555 verwendet. |
||
Display Id |
‚<auto>‘ |
string |
Der IMAGE Port interagiert mit dem angegebenen Display, wenn Bilder gelesen werden. Sie können die verfügbaren Display-Ids mit dem adb-Befehl „adb shell dumpsys SurfaceFlinger –display-id“ auflisten. Mit der Option „<auto>“ wird das Standard-Display verwendet. |
||
Display Id ❲HWC❳ |
‚<auto>‘ |
string |
Die Hardware Composer (HWC) Id des gewünschten Displays. Diese wird benötigt, um Toucheingaben auf einem bestimmten Display auszuführen. Sie können die verfügbaren Display-Ids mit dem adb-Befehl „adb shell dumpsys SurfaceFlinger –display-id“ auflisten. Mit der Option „<auto>“ wird das Standard-Display verwendet. |
Jobs 🛈¶
ClearAndroidPackageData¶
Löscht die Benutzerdaten für das angegebene Package.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
packageName |
string |
Packagename der installierten App, z.B. „com.google.android.youtube“. |
ExecuteShellCommand¶
Führt einen Shell-Befehl auf dem Gerät aus und gibt das Ergebnis zurück. Die Shell und alle Kindprozesse werden danach beendet.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
cmd |
string |
Shell Kommando z.B. „input tap 0 0“. |
|||
timeout |
0 |
int |
Timeout in Sekunden. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Rückgabewert des Befehls. |
GetCurrentActivity¶
Gibt das derzeit aktive Package mit Activity zurück.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Das derzeit aktive Package bzw. Activity. |
GetCurrentApp¶
Gibt den Namen der derzeit aktiven App zurück, z.B. „Chrome“.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Die derzeit aktive App. |
GetInstalledApps¶
Gibt alle auf dem Gerät installierten Apps zurück.
Parametrierung
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Liste aller installierter Apps. |
InputText¶
Gibt den angegebenen Text ein und drückt ggf. die Entertaste zur Bestätigung.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
pressReturn |
☐ |
bool |
Falls True, wird nach der Texteingabe Enter gedrückt. |
||
text |
string |
Text, der eingegeben werden soll. |
PullFile¶
Lädt eine Datei oder ein Verzeichnis vom Android-Gerät herunter.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
localFilePath |
string |
Lokaler Datei- oder Verzeichnispfad auf dem Testrechner. Wenn leer, wird die Ressource ins Reportverzeichnis gespeichert. |
|||
remoteFilePath |
string |
Datei- oder Verzeichnispfad auf dem Android-Gerät, z.B. „/sdcard/Download/filename.ext“. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
localFilePath |
string |
Der Pfad unter dem die heruntergeladene Resource (Datei oder Verzeichnis) liegt. |
PushFile¶
Lädt eine lokale Datei oder ein Verzeichnis auf das Android-Gerät.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
localFilePath |
string |
Lokaler Datei- oder Verzeichnispfad auf dem Testrechner. |
|||
remoteFilePath |
string |
Datei- oder Verzeichnispfad auf dem Android-Gerät, z.B. „/sdcard/Download/filename.ext“. |
ShellSessionClose¶
Schließt die Shell-Session mit der angegebenen Id und beendet alle Kindprozesse.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
shellId |
string |
Id der Shell-Session, die verwendet werden soll. Existiert die Session nicht, wird eine Exception geworfen. |
ShellSessionExecuteCommand¶
Löscht stdout und stderr, schreibt einen Befehl in den stdin-Stream der Shell-Session, liest die Ausgangsströme und gibt die Ausgabepuffer zurück.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
cmd |
string |
Befehl, der ausgeführt wird, z.B. „ls -l“, um das aktuelle Verzeichnis aufzulisten oder „echo ${?}“, um den letzten Rückgabewert zu erhalten. |
|||
cmdTimeout |
10 |
float |
Das Timeout des Befehls wird in Sekunden gemessen. Das Lesen von stdout oder stderr wird abgebrochen, wenn die Ausführung länger dauert als das Timeout. Wenn das Timeout 0 oder kleiner ist, wird es ignoriert. |
||
perLineTimeout |
5 |
float |
Das Timeout pro Zeile wird in Sekunden gemessen. Das Lesen von stdout oder stderr wird abgebrochen, wenn das Lesen einer einzelnen Zeile länger dauert als das Timeout. Wenn das Timeout 0 oder kleiner ist, wird es ignoriert. |
||
shellId |
string |
Id der Shell-Session, die verwendet werden soll. Existiert die Session nicht, wird eine Exception geworfen. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
object |
Gibt ein Tupel mit den empfangenen Daten aus den Streams stdout und stderr zurück. Die Daten können unvollständig sein, wenn eines der Timeouts erreicht wurde. |
ShellSessionOpen¶
Erzeugt eine neue ADB-Shell-Session, über die mit Lese- und Schreib-Jobs interagiert werden kann.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
shellId |
string |
Id der Shell-Session, die erstellt wird. Die Id wird für Lese-/Schreib-/Schließaktionen auf dieser Shell benötigt. Ist sie leer, wird eine Id generiert. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Gibt die angegebene oder erstellte Shell-Session-Id zurück. |
ShellSessionRead¶
Liest den stdout- oder stderr-Stream und gibt die Daten zurück.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
perLineTimeout |
5 |
float |
Das Timeout pro Zeile wird in Sekunden gemessen. Das Lesen von stdout oder stderr wird abgebrochen, wenn das Lesen einer einzelnen Zeile länger dauert als das Timeout. Wenn das Timeout 0 oder kleiner ist, wird es ignoriert. |
||
shellId |
string |
Id der Shell-Session, die verwendet werden soll. Existiert die Session nicht, wird eine Exception geworfen. |
|||
stderr |
☐ |
bool |
Liest den Stream stderr und gibt ihn anstelle von stdout zurück. |
ShellSessionWrite¶
Schreibt in den stdin-Stream der Shell-Session.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
cmd |
string |
Eingabe, die an den stdin-Stream gesendet wird. |
|||
newLine |
☑ |
bool |
Fügt das Zeilenumbruchzeichen „\n“ am Ende der Eingabe ein, um die Eingabetaste zu simulieren. |
||
shellId |
string |
Id der Shell-Session, die verwendet werden soll. Existiert die Session nicht, wird eine Exception geworfen. |
StartAndroidPackage¶
Startet die angegebene Activity aus einem Package.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
activityName |
string |
App-Activity, z.B. „/.HomeActivity“. |
|||
packageName |
string |
Packagename der installierten App, z.B. „com.google.android.youtube“. |
StartApp¶
Startet die gewünschte App.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
appName |
string |
Name der zu startenden App, z.B. „Chrome“. |
Rückgabewert
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
result |
string |
Der zugehörige Package-Pfad zur gestartetetn App. |
StopAndroidPackage¶
Schließt das angegebene Package.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
packageName |
string |
Packagename der installierten App, z.B. „com.google.android.youtube“. |
StopApp¶
Schließt die angegebene App.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
appName |
string |
Name der zu schließenden App, z.B. „Chrome“. |
SwipeOnScreen¶
Simuliert eine Wisch-Geste auf dem Gerät.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
duration |
0 |
int |
Dauer der Wischgeste in Millisekunden. |
||
startPosX |
0 |
int |
Pixelposition (X Achse) |
||
startPosY |
0 |
int |
Pixelposition (Y Achse) |
||
targetPosX |
0 |
int |
Pixelposition (X Achse) |
||
targetPosY |
0 |
int |
Pixelposition (Y Achse) |
TouchOnScreen¶
Simuliert eine Toucheingabe auf dem Gerät.
Parametrierung
Parameter
Name |
Verfügbar wenn |
Standardwert |
Gültige Werte |
Typ |
Beschreibung |
|---|---|---|---|---|---|
duration |
0 |
int |
Haltedauer in Millisekunden |
||
positionX |
0 |
int |
Pixelposition (X Achse) |
||
positionY |
0 |
int |
Pixelposition (Y Achse) |