ipc.diagnostic.<function>

ipc.diagnostic.markExperiment()
   *do something interesting*
ipc.diagnostic.collect()
>>>...Collecting Log Results
...Logging Preset Restored to *previous preset*
...Compiling Payload
...Diagnostic Payload can be found at: *PATH to payload*

ipc.logger.<function>

ipc.logger.level("ipc","debugall") # to turn on ALL debug information for the IPC CLI
ipc.logger.echo(True) # to echo the output to the screen
ipc.logger.setFile("path_to_log.log") # to send out put to the file
ipc.logger.openipc_echo(True) # to echo the output to the Open IPC log files
... do something interesting
ipc.logger.reset() # put all logging back to defaults

• The CALLER should show the first call outside of the ipccli that called the function in the ipccli.

• The ENTER will show the value of the parameters passed in to the ipccli function.

• The EXIT will show the code leaving the ipccli function and the value of any data that was created.

>>> ipc.threads[0].irdrscan(2,32)
CALLER: File "<stdin>", line 1, in <module>
ENTER: irdrscan(device=0x10003e8L,instruction=0x02, bitCount=32, data=None, writeData=None)
EXIT : irdrscan result = [32b] 0x0A3CA013
[32b] 0x0A3CA013

Windows:

C:Users<user>.OpenIPC

Linux:

~/.OpenIPC

macOS:

~/.OpenIPC

ipccli.cli_​logging. openipc_​echo (echoOn = None)

Enable logging to Open IPC log files when echoOn is True (you must use level() to set which loggers are enabled for debug). Disables logging to Open IPC log files when echoOn is False and returns the current state if echoOn is None.

Open IPC uses a logging.xml file to configure its own logging. The Open IPC’s IpcInterface logger must be set to a log level of “Info” or above for log messages from ipccli to be recorded. See Open IPC documentation for further details on configuring Open IPC logging.

Args: echoOn (boolean) - see above.

Returns: None

ipccli.cli_​logging. openipc_​loadpreset (preset)

Load a known logging preset setting that controls the level of detail that OpenIPC will log (logging verbosity).

Call the openipc_​presetnames() command to get a list of available logging presets.

• The “GeneralDebug” preset should cover most logging needs and should be selected by default.

• The “All” preset is appropriate to set when low level driver, probe hw or debug transport issues are suspected.

• Use the “Off” preset to turn logging off

Args: preset (str) - name of an acceptable logging preset

Returns: None

ipccli.cli_​logging. openipc_​flush ( )

Write any pending log messages to disk. Then create a new rollback log file for further messages. This typically happens after the session closes, but this can be used to force a flush and new file.

Args: None

Returns: None

ipccli.cli_​logging. openipc_​clear ( )

Delete the log files in the standard logging directory (free up disk space).

Args: None

Returns: None

ipccli.cli_​logging. openipc_​archive ( )

Creates an archive zip file containing every log file in the standard logging directory and then removes them from the directory. Intended to easily package log files to hand off to another person.

Args: None

Returns: None

ipccli.cli_​logging. openipc_​presetnames ( )

Returns a list of acceptable logging preset names that can be loaded when calling openipc_​loadpreset()

Args: None

Returns: list of strings

ipccli.cli_​logging. openipc_​writemessage (message)

Writes the specified user message to the OpenIPC log file. Makes it easy to place a marker in the log file to pass specific debug information or to tag the beginning and end of a section of commands of interest.

Args: message (str) - message to write to the log

Returns: None

ipccli.cli_​logging. openipc_​getloadedpreset ( )

Returns the name of the current loaded logging preset. Some preset will always be loaded.

Args: None

Returns: a preset name (str)

>>> from ipc import ipc_logging
>>> log = ipc_logging.getLogger("my script")