Interface Target

Connect or reconnect the debugger to the target.

Remarks

Returns once the target is connected and the debugger is idle.

Will throw if the target target is already connected.

Example

// connects and disconnects from the target
session.target.connect()
session.target.disconnect()
Copy

Disconnect the debugger from the target

Remarks

Returns once the target is disconnected and the debugger is idle.

Will throw if not connected to the target.

Example

// connects and disconnects from the target
session.target.connect()
session.target.disconnect()
Copy

Query the target's available reset types.

Example

// Get a list of the resets which can currently be performed
let resets = session.target.getResets();
// This might look like
// resets = {
//   "CPU Reset": true,
//   "Board Reset": false
// }
let allowedResets = Object.keys(resets).filter((reset) => resets[reset]);
// allowedResets = ["CPU Reset"];
Copy

Halt the target.

Remarks

Returns immediately if the target is already halted.

Example

session.target.halt();
Copy

Query if the target is connected

Example

session.target.connect();
let status = session.target.isConnected(); // will be true
session.target.disconnect();
status = session.target.isConnected(); // will be false
Copy

Query if the target is halted.

Example

session.target.halt();
let status = session.target.isHalted(); // will be true
session.target.run(false);
status = session.target.isHalted(); // will be false
Copy

Issue the specified reset on the target

Remarks

Returns once the debugger is idle.

If the reset requires the target to be halted, use Target.halt or Target.waitForHalt.

Does not throw if the reset fails.

Example

// Issue the System Reset (possible reset types vary by target)
session.target.reset("System Reset");
Copy

Issue a run command to the target, and wait until it has halted.

Remarks

By default, this will wait until the target has halted after running. If waitForHalt is false this will return as soon as the target begins to run.

Will throw if the target is not halted.

Example

// run to foo
session.breakpoints.add("foo");
session.target.run();

// run and return once the target is running
session.target.run(false);
Copy

Steps the target, stepping into function calls. Returns once the step operation is completed and the target is once again halted.

If symbol information is loaded for the location at which the target is currently halted, then a source step is performed. Otherwise, or if explicitly ordered to do so, an assembly step is performed.

Remarks

Will throw if the target is not halted.

Example

// source step into (assuming symbol information is loaded for the target's current location)
session.target.stepInto();

// explicit assembly step into
session.target.stepInto(true);
Copy

Steps the target, stepping out of the current function. Returns once the step operation is completed and the target is once again halted.

Remarks

Will throw if the target is not halted.

This operation requires symbol imformation to be loaded for the location at which the target is currently halted.

Example

session.target.stepOut();
Copy

Steps the target, stepping over function calls. Returns once the step operation is completed and the target is once again halted.

If symbol information is loaded for the location at which the target is currently halted, then a source step is performed. Otherwise, or if explicitly ordered to do so, an assembly step is performed.

Remarks

Will throw if the target is not halted.

Example

// source step over (assuming symbol information is loaded for the target's current location)
session.target.stepOver();

// explicit assembly step over
session.target.stepOver(true);
Copy

Waits until the target has halted for any reason.

Example

// run the target and separately wait until it is halted
session.target.run(false);
session.target.waitForHalt();
Copy