Tool Property Options Used with the Set Command

The following table provides additional information for tool property options used with the Set command.

Important: The set command, including the tool property options, must be executed before the Hwtool command is issued, otherwise the changes to the tool properties will be ignored.
Notes:
  1. 1.MDB commands are not case-sensitive. However, when using the set command, where tool option properties are passed as parameters, the parameter portion of the command line entered is case-sensitive.
  2. 2.Tool property options that you want to use with the set command must be selected before using the Hwtool command.
Table 1. Tool Property Name Options Used by the Set Command
Tool Property Name Value Tool
AutoSelectMemRanges

Determines whether the debugger will automatically select the areas of memory and program memory ranges to program.

If set to auto, the debugger will automatically select the memory and ranges. Manual means the memories and ranges will be determined by the memories properties below.

Example:

set AutoSelectMemRanges auto

auto or manual MPLAB ICD3, MPLAB ICD4, MPLAB REAL ICE, PICkit 3, MPLAB PICkit 4, MPLAB PM3, MPLAB Snap, EDBG
communication.interface

Set the communication interface to nnn (nnn is the value).

Example:

set communication.interface jtag

jtag, swd, updi, dw, isp, pdi, tpi EDBG
communication.speed

Set the communication speed to nnn (nnn is the value).

Example:

set communication.speed 0.100

a decimal value (in MHz), dependent on the device EDBG
debugoptions.useswbreakpoints

True indicates that software breakpoints will be used for program address breakpoints, false indicates that hardware breakpoints will be used (does not apply to PICkit 3).

Example:

set debugoptions.useswbreakpoints true

true or false MPLAB ICD3, MPLAB ICD4, MPLAB REAL ICE, MPLAB PICkit 4, MPLAB Snap, EDBG
memories.programmemory

If true, the program memory will be programmed; if false, it will not.

Example:

set memories.programmemory true

true or false MPLAB ICD3,MPLAB ICD4, MPLAB REAL ICE, PICkit 3,MPLAB PICkit 4, MPLAB PM3, MPLAB Snap, EDBG
memories.programmemory.start

The value represents the starting program memory address that the debug tool will begin programming.

Example:

set memories.programmemory.start 0x0000

a string representing a long value MPLAB ICD3,MPLAB ICD4, MPLAB REAL ICE, PICkit 3,MPLAB PICkit 4, MPLAB PM3, MPLAB Snap, EDBG
memories.programmemory.end

The value represents the ending program memory address that the debug tool will end programming.

Example:

set memories.programmemory.end 0xFFFF

a string representing a long value MPLAB ICD3,MPLAB ICD4, MPLAB REAL ICE, PICkit 3,MPLAB PICkit 4, MPLAB PM3, MPLAB Snap, EDBG
memories.eeprom

If true, the EEPROM memory will be programmed; if false, it will not.

Example:

set memories.eeprom true

true or false MPLAB ICD3,MPLAB ICD4, MPLAB REAL ICE, PICkit 3,MPLAB PICkit 4, MPLAB PM3, MPLAB Snap, EDBG
memories.id

If true, the user ID memory will be programmed; if false, it will not.

Example:

set memories.id true

true or false MPLAB ICD3, MPLAB ICD4, MPLAB REAL ICE, PICkit 3, MPLAB PICkit 4, MPLAB PM3, MPLAB Snap, EDBG
memories.bootflash

If true, the boot flash (PIC32 only) memory will be programmed; if false, it will not.

Example:

set memories.bootflash true

true or false MPLAB ICD3, MPLAB ICD4, MPLAB REAL ICE, PICkit 3, MPLAB PICkit 4, MPLAB PM3, MPLAB Snap, EDBG
memories.aux

If true, the auxiliary program memory (dsPIC®/PIC24 EP parts only) will be programmed; if false, it will not.

Example:

set memories.aux true

true or false MPLAB ICD3, MPLAB ICD4, MPLAB REAL ICE, PICkit 3, MPLAB PICkit 4, MPLAB PM3, MPLAB Snap, EDBG
programoptions.eraseb4program

If true, the device will be erased before it is programmed; if false it will not.

Example:

set programoptions.eraseb4program true

true or false MPLAB ICD3, MPLAB ICD4, MPLAB REAL ICE, PICkit 3, MPLAB PICkit 4, MPLAB PM3, MPLAB Snap
programoptions.ledbrightness

Sets the brightness of the LEDs on the hardware tool. Setting 1 is darkest and 10 is the brightest. The default is 5.

Example:

set programoptions.ledbrightness 7

1 to 10 MPLAB ICD4, MPLAB PICkit 4
programoptions.pgcconfig

Sets the type of resistance to be applied to the PGC line. The default is pull down. The value of the resistance is set by the PGC resistor option.

Example:

set programoptions.pgcconfig pullup

none or pull up or pull down MPLAB ICD4, MPLAB PICkit 4
programoptions.pgcresistor.value

Sets the value of the resistance on the PGC line. Maximum value is 50 kohms. If PGC configuration is set to none, this value is ignored.

Example:

set programoptions.pgcresistor.value 4.7

0.1 to 50.0 MPLAB ICD4, MPLAB PICkit 4
programoptions.pgdconfig

Sets the type of resistance to be applied to the PGD line. The default is pull down. The value of the resistance is set by the PGD resistor option.

Example:

set programoptions.pgdconfig pullup

none or pull up or pull down MPLAB ICD4, MPLAB PICkit 4
programoptions.pgdresistor.value

Sets the value of the resistance on the PGD line. Maximum value is 50 kohms. If PGD configuration is set to none, this value is ignored.

Example:

set programoptions.pgdresistor.value 4.7

0.1 to 50.0 MPLAB ICD4, MPLAB PICkit 4
programoptions.pgmentry.voltage

Sets the method the hardware tool will use to put the target device in programming mode. For the low voltage method, Vpp will not exceed the Vdd supply voltage. Instead, a test pattern will be used on Vpp. For the high voltage method, a voltage in excess of 9 volts will be placed on Vpp.

Example:

set programoptions.pgmentry.voltage low

Low or High MPLAB ICD4, MPLAB PICkit 4, MPLAB Snap
programoptions.pgmspeed

Sets the speed that the hardware tool will use to program the target. If programming fails, try a slower speed. The default is Med.

Example:

set programoptions.pgmspeed Min

Min or Med or Max

MPLAB ICD4, MPLAB PICkit 4

MPLAB Snap

poweroptions.powerenable

If true, the debug tool will supply target power at the default voltage for the tool. If false it will not supply target power.

Note: This property does not apply to MPLAB REAL ICE.

To set a non-default voltage for the target power, first set the poweroptions.powerenable to true, then set the voltage value where n.n represents the desired voltage:

set voltagevalue n.n

Example:

set poweroptions.powerenable true

set voltagevalue 3.3

true or false MPLAB ICD3, MPLAB ICD4, PICkit 3, MPLAB PICkit 4, MPLAB PM3
SecureSegment.SegmentProgramming SegmentProgrammingAll

If true, it permits programming to “Program Over Secure and Protected FLASH.” This property must be set prior to using the program operation on the MDB. Use the -p option to set the tool as a programmer if it’s for a production final image and not just a debug image.

Example:

set SecureSegment.SegmentProgramming SegmentProgrammingAll true

true or false MPLAB ICD3, MPLAB ICD4, MPLAB REAL ICE, PICkit 3, MPLAB PICkit 4
system.disableerrormsg

This option has been deprecated as of v3.15 but will still function with existing projects. For new projects, use the <Link>

system.disableoutput and

<Link>system.yestoalldialog options.

If true, the system will disable warnings and error messages and answer “yes” to all dialogs; if false the system will enable warning and error messages (this is the default).

Example:

set system.disableerrormsg true

true or false Not tool dependent
system.disableoutput

If true, the system will disable warnings and error message outputs but not disable dialogs; if false the system will enable warning and error message outputs and dialogs (this is the default).

Example:

set system.disableoutput true

true or false Not tool dependent
system.yestoalldialog

If true, the system will disable dialogs and answer “yes” to all of them; if false the sys-tem will enable dialogs (this is the default).

Example:

set system.yestoalldialog true

true or false Not tool dependent