# Settings

The IPC CLI settings file is the file to change behavior in the IPC CLI. Most of these must be set before the first call to ipccli.baseaccess. Options need to be in all caps and free of typos.

Example:

    >>> from ipccli import settings
    >>> settings.PROMPT_DISPLAY = False
    >>> import ipccli
    >>> ipc = ipccli.baseaccess()

OR you can set using environment variable by preceding the setting with IPCCLI:

    IPCCLI_PROMPT_DISPLAY=True

OUT_OF_PROCESS If OUT_OF_PROCESS is set to false, you can’t use NorthPeak, cannot have another CLI or any other IPC client open.

IPC_LAUNCH_SERVER Attempt to launch a new server instead of connecting to an existing one. The port for the new server can optionally be specified in the IPC_API_SERVER variable.

IPC_API_SERVER The URI for the IPC API server to connect to (e.g. “domain.corp.com:1234”, “10.2.14.13:1234”, “[::1]:1234”). Assumes that the server is already started and listening on that address. This option takes precedence over OUT_OF_PROCESS.

IPC_CONFIG_FILE The configuration file for configuring the IPC API server. When set to None, the server’s default configuration is used.

VERSION_CHECK checks the version for implemented functions.

IPC_PATH is the path to the OpenIPC. Typically it’s C:\Intel\OpenIPC\Bin, but sometimes C:\Intel\DAL.

EVENT_DISPLAY turns on the default event displays for Target Events, Run Control Events, and Message Events.

EVENT_TIMESTAMP turns on or off whether events show a timestamp.

DISPLAY_WAIT_TIME specifies the number of seconds to wait for a run control event before displaying. This only works for the default run control event. This allows time to queue the printout for a condensed output. Default is 0.1 seconds.

PROMPT_PREFIX allows the user to specify a prefix in to the python prompt (like an IP address).

Or for command line usage:

    usage: ipccli   [-h] [--in-process] [--ipc-launch-server]
                    [--ipc-api-server IPC_API_SERVER]
                    [--ipc-config-file IPC_CONFIG_FILE]
                    [--ipc-config-params IPC_CONFIG_PARAMS] [--ipc-path IPC_PATH]
                    [--no-version-check] [--no-event-display]
                    [--no-event-timestamp] [--display-wait-time DISPLAY_WAIT_TIME]
                    [--event-wait-time EVENT_WAIT_TIME] [--developer]
                    [--prompt-display] [--prompt-prefix PROMPT_PREFIX]

    Launches an interactive IPC CLI session.

    optional arguments:
      -h, --help            show this help message and exit
      --in-process          Connect to IPC API in the same process space.
      --ipc-launch-server   Force launch of IPC API server (instead of attaching
                            to an existing server). Use --ipc-api-server to
                            specify a port for the server.
      --ipc-api-server IPC_API_SERVER
                            URI for the IPC API server to connect to (e.g.
                            "domain.corp.com:1234", "10.2.14.13:1234",
                            "[::1]:1234"). Assumes that the server is already
                            started and listening on that address. This option
                            takes precendence over --in-process.
      --ipc-config-file IPC_CONFIG_FILE
                            Path to the configuration file for configuring the IPC
                            API server. When not specified, the server's default
                            configuration is used.
      --ipc-config-params IPC_CONFIG_PARAMS
                            Configuration parameter values to apply to the
                            selected configuration as key/value pairs separated by
                            commas (e.g.
                            "TargetIpAddress=127.0.0.1,TargetPort=987").
      --ipc-path IPC_PATH   Path to the IPC API implementation to connect to.
      --no-version-check    Disable checking IPC API and implementation version
                            before invoking newer APIs.
      --no-event-display    Disable display of IPC API events.
      --no-event-timestamp  Disable display of IPC API event timestamps.
      --display-wait-time DISPLAY_WAIT_TIME
                            Time to wait before displaying queued events.
      --event-wait-time EVENT_WAIT_TIME
                            Time to delay event display before checking for
                            another event.
      --developer           Enable developer mode.
      --prompt-display      Enable display of current status on the prompt.
      --prompt-prefix PROMPT_PREFIX
                            Prefix before the prompt.