Port DEBUGGER - SSH¶

Stimulation¶

This port has no stimulus capabilities.

Properties 🛈¶

Name	Available if	Default value	Valid values	Type	Description
SSH host				string	Address of the SSH host.
SSH port		22		int	Port through which SSH can be accessed on the host.
SSH user name				string	Username to log in to the SSH host.
Authentication method		Private key file	[Private key file, Password]	string	Method used to log in to the remote system.
SSH key path	Authentication method: ‘Private key file’			string	Path to the SSH private key for host-based authentication. Path can be absolute or relative to the tool host base path.
SSH password	Authentication method: ‘Password’			string	Password of the specified user. Caution: The password is stored unencrypted in the TBC!
GDB path		‘gdb’		string	Path to GDB.
Argument list		‘[]’		string	Arguments for calling GDB in Python list syntax.
Timeout		2		int	Timeout for GDB commands in seconds.
Log GDB outputs		☐		bool	Write all GDB outputs into the messages window.
Load application as		Executable and symbol file	[None, Executable file, Symbol file, Executable and symbol file]	string	How to load the application when connecting the GDB port.
Executable file				string	Absolute path to the application to load on the tool host.

Jobs 🛈¶

Attach¶

Connects to a target process. The target process is stopped. (Corresponds to GDB command “attach”.)

Parameter

Name	Available if	Default value	Valid values	Type	Description
target				string	Process ID

Return value

Name	Available if	Default value	Valid values	Type	Description
attachInfo				object	Information about the attach (result, payloadDict)

ClearBreakpoints¶

Removes all breakpoints at once. (Corresponds to GDB command “delete”.)

Return value

Name	Available if	Default value	Valid values	Type	Description
breakInfo				object	Information about the break call (result, payloadDict)

Cmd¶

Executes a custom GDB/MI command.

Parameter

Name	Available if	Default value	Valid values	Type	Description
command				string	GDB/MI command

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	Return value of the command (result, payloadDict)

Continue¶

Continues the application. (Corresponds to GDB command “continue”.)

Return value

Name	Available if	Default value	Valid values	Type	Description
continueInfo				object	Information about the continue (result, payloadDict)

Detach¶

Terminates the connection to a target process. (Corresponds to GDB command “detach”.)

Parameter

Name	Available if	Default value	Valid values	Type	Description
target				string	Process ID

Return value

Name	Available if	Default value	Valid values	Type	Description
detachInfo				object	Information about the detach (result, payloadDict)

GetBreakpointList¶

Lists all existing breakpoints. (Corresponds to GDB command “info break”.)

Return value

Name	Available if	Default value	Valid values	Type	Description
breakpointList				object	List of all breakpoints (result, payloadDict)

GetCallstack¶

Returns the current call stack. (Corresponds to GDB command “backtrace” or “where”.)

Return value

Name	Available if	Default value	Valid values	Type	Description
callstack				object	Information about the callstack (result, payloadDict)

GetStatus¶

Returns the current state of the debugger.

Parameter

Name	Available if	Default value	Valid values	Type	Description
immediate		False	[False, True]	bool	Whether the latest state of the debugger will be returned immediately, without updating.

Return value

Name	Available if	Default value	Valid values	Type	Description
status				object	State of the debugger (result, payloadDict)

Interrupt¶

Interrupts the execution of the application. (Corresponds to GDB command “interrupt”.)

Return value

Name	Available if	Default value	Valid values	Type	Description
interruptInfo				object	Information about the interrupt call (result, payloadDict)

IsConnected¶

Returns true when the most recent TargetConnect job was executed successfully. Returns false if the job was not successful or when a TargetDisconnect job was executed most recently.

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

ReadVariable¶

Reads the value of a variable. When reading or writing multiple variables it is more efficient to use an explicit interrupt before and a continue after accessing the variables.

Parameter

Name	Available if	Default value	Valid values	Type	Description
displayFormat		‘natural’	[‘binary’, ‘decimal’, ‘hexadecimal’, ‘octal’, ‘natural’, ‘zero-hexadecimal’]	string	Display format of the variable (Default: natural)
variable				string	Name of the variable to read

Return value

Name	Available if	Default value	Valid values	Type	Description
variableInfo				object	Information about the variable.

RemoveBreakpoint¶

Removes a breakpoint at the specified location. (Corresponds to GDB command “delete”.)

Parameter

Name	Available if	Default value	Valid values	Type	Description
breakpoint				object	Location or number of the breakpoint to be removed
isNumber		False	[False, True]	bool	Specifies whether the parameter “breakpoint” is a breakpoint position or number.

Return value

Name	Available if	Default value	Valid values	Type	Description
breakInfo				object	Information about the break call (result, payloadDict)

Run¶

Starts the execution of the application. (Corresponds to GDB command “run”.)

Return value

Name	Available if	Default value	Valid values	Type	Description
runInfo				object	Information about the run call (result, payloadDict)

SetBreakpoint¶

Sets a breakpoint at the specified location. (Corresponds to GDB command “break”.)

Parameter

Name	Available if	Default value	Valid values	Type	Description
location				object	Location of the breakpoint. Function name, line number or address.

Return value

Name	Available if	Default value	Valid values	Type	Description
breakInfo				object	Information about the break call (result, payloadDict)

StepInto¶

Single step, enters subroutine. (Corresponds to GDB command “step”.)

Return value

Name	Available if	Default value	Valid values	Type	Description
stepInfo				object	Information about the step call (result, payloadDict)

StepOut¶

Single step, exits subroutine. (Corresponds to GDB command “finish”.)

Return value

Name	Available if	Default value	Valid values	Type	Description
stepInfo				object	Information about the step call (result, payloadDict)

StepOver¶

Single step, skips subroutine. (Corresponds to GDB command “next”.)

Return value

Name	Available if	Default value	Valid values	Type	Description
stepInfo				object	Information about the step call (result, payloadDict)

TargetConnect¶

Establishes a connection with the target system. (Corresponds to GDB command “target”.)

Parameter

Name	Default value	Valid values	Type	Description
conntype			string	Connection type
parameters			string	Connection parameters
setTargetAsync	True	[False, True]	bool	Enables the possibility to send commands to the target while the program to be debugged is running. Default true.

Return value

Name	Available if	Default value	Valid values	Type	Description
connectInfo				object	Information about the connect (result, payloadDict)

TargetDisconnect¶

Terminates the connection with the target system. (Corresponds to GDB command “disconnect”.)

Return value

Name	Available if	Default value	Valid values	Type	Description
disconnectInfo				object	Information about the disconnect (result, payloadDict)

Version¶

Returns a dictionary with information about version and license. (corresponds to GBD command “show version”.)

Return value

Name	Available if	Default value	Valid values	Type	Description
versionInfo				object	Information about the Version-call (result, payloadDict)

WriteVariable¶

Writes the value of a variable. When reading or writing multiple variables it is more efficient to use an explicit interrupt before and a continue after accessing the variables.

Parameter

Name	Available if	Default value	Valid values	Type	Description
value				string	New value of the variable. For enums, only numeric values are supported.
variable				string	Name of the variable to be written

Return value

Name	Available if	Default value	Valid values	Type	Description
variableInfo				object	Information about the variable.