sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-01-31 02:00:45 +00:00
Code Issues Releases Wiki Activity

doc/connection: Update connection documentation

Browse Source
This commit is contained in:
Marc Bonnici 2019-08-19 17:30:34 +01:00
parent 156915f26f
commit 66de30799b
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/connection.rst
View File

@ -100,7 +100,7 @@ class that implements the following methods.
Connection Types Connection Types
---------------- ----------------
.. class:: AdbConnection(device=None, timeout=None) .. class:: AdbConnection(device=None, timeout=None, adb_server=None, adb_as_root=False)
A connection to an android device via ``adb`` (Android Debug Bridge). A connection to an android device via ``adb`` (Android Debug Bridge).
``adb`` is part of the Android SDK (though stand-alone versions are also ``adb`` is part of the Android SDK (though stand-alone versions are also
@ -113,10 +113,13 @@ Connection Types
:param timeout: Connection timeout in seconds. If a connection to the device :param timeout: Connection timeout in seconds. If a connection to the device
is not established within this period, :class:`HostError` is not established within this period, :class:`HostError`
is raised. is raised.
:param adb_server: Allows specifying the address of the adb server to use.
:param adb_as_root: Specify whether the adb server should be restarted in root mode.
.. class:: SshConnection(host, username, password=None, keyfile=None, port=None,\ .. class:: SshConnection(host, username, password=None, keyfile=None, port=None,\
timeout=None, password_prompt=None) timeout=None, password_prompt=None, \
sudo_cmd="sudo -- sh -c {}")
A connection to a device on the network over SSH. A connection to a device on the network over SSH.
@ -141,6 +144,7 @@ Connection Types
:param password_prompt: A string with the password prompt used by :param password_prompt: A string with the password prompt used by
``sshpass``. Set this if your version of ``sshpass`` ``sshpass``. Set this if your version of ``sshpass``
uses something other than ``"[sudo] password"``. uses something other than ``"[sudo] password"``.
:param sudo_cmd: Specify the format of the command used to grant sudo access.
.. class:: TelnetConnection(host, username, password=None, port=None,\ .. class:: TelnetConnection(host, username, password=None, port=None,\