DebugServer¶
-
class
DebugServer(host=None, port=None)¶ DebugServer Class for creating and communicating with DebugServer-js
Initializes DebugServer object
Parameters: - host (str, optional) – hostname of existing DebugServer to connect to (default=”localhost”)
- port (int) – port number of existing DebugServer to connect to
-
attach_ccs()¶ Opens a CCS GUI instance for the DebugServer
Raises: Exception– raises exception if problem opening CCS
-
create_config(name, connection=None, device=None, board=None, directory=None)¶ Creates a ccxml file using the provided parameters
Parameters: - name (str) – name of ccxml file to create
- connection (str) – connection name to use (required if board is ommitted)
- device (str) – devicetype name to use (required if board is ommitted)
- board (str) – board name to use (required if connection + device ommitted)
- directory (str) – full path to directory location to place file
-
get_config()¶ Get ccxml file in use by DebugServer
Returns: ccxml file in use by DebugServer Return type: str
-
get_list_of_configurations()¶ Returns list of configuration files
Returns: list of configuration files Return type: list
-
get_list_of_connections()¶ Returns list of connection names
Returns: list of connection names Return type: list
-
get_list_of_cpus()¶ Returns list of CPU names
Returns: list of CPU names Return type: list
-
get_list_of_devices()¶ Returns list of device names
Returns: list of device names Return type: list
-
get_list_of_sessions()¶ Returns list of open sessions
Returns: list of open sessions Return type: list
-
get_session(name)¶ Returns handle to the open session
Parameters: name (str) – name of open session to retrieve handle for Returns: DebugSession object Return type: DebugSession
-
kill()¶ Kills Debug Server (including any open sessions)
-
open_session(name)¶ Open a session for the provided session name
Parameters: name (str) – session name to open Returns: DebugSession object Return type: DebugSession
-
set_config(ccxml_path)¶ Set ccxml file for DebugServer
Parameters: ccxml_path (str) – full path to ccxml file to set
-
terminate_session(name)¶ Terminates an open session
Parameters: name (str) – name of session to terminate Raises: Exception– raises exception if problem terminating session