Function open

  • open(appName, protocolVersion, options?): Promise<OpenEvent>

  • Try opening a connection to SimConnect

    Parameters

    • appName: string

      An appropriate name for the client program. Your app will appear with this name in the SimConnect inspector in MSFS.

    • protocolVersion: Protocol

      Lowest protocol version

    • Optional options: ConnectionOptions

      Used for connecting to a remote instance of SimConnect. If omitted it will attempt to read connection parameters from the following sources:

      • IP + port number from SimConnect.cfg in the node.js installation directory (or the installation directory of the Electron app)

      • IP + port number from SimConnect.cfg in the user's home directory

      • Named pipe found in the Windows registry (available when the sim has started)

      • Port number, for use with localhost, found in the Windows registry (available when the sim has started)

    Returns Promise<OpenEvent>

Settings

Member Visibility

Theme

Generated using TypeDoc