VirtualSerialPortOption

VirtualSerialPortOption
VirtualSerialPortOption

The VirtualSerialPortOption data object contains the options for configuring the virtual serial port device defined by the VirtualSerialPort data object.

These options include information about how the device is backed physically on the host: by a network socket, a host file, a host serial port device, or a pipe to another process.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "type": "string",
    "connectOption": {
        "_typeName": "string",
        "startConnected": {
            "_typeName": "string",
            "valueIsReadonly": false,
            "supported": false,
            "defaultValue": false
        },
        "allowGuestControl": {
            "_typeName": "string",
            "valueIsReadonly": false,
            "supported": false,
            "defaultValue": false
        }
    },
    "busSlotOption": {
        "_typeName": "string",
        "type": "string"
    },
    "controllerType": "string",
    "autoAssignController": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "supported": false,
        "defaultValue": false
    },
    "backingOption": [
        {
            "_typeName": "string",
            "type": "string"
        }
    ],
    "defaultBackingOptionIndex": 0,
    "licensingLimit": [
        "string"
    ],
    "deprecated": false,
    "plugAndPlay": false,
    "hotRemoveSupported": false,
    "numaSupported": false,
    "yieldOnPoll": {
        "_typeName": "string",
        "valueIsReadonly": false,
        "supported": false,
        "defaultValue": false
    }
}
yieldOnPoll
Required

The BoolOption data object type describes if an option is supported ("true") and if the option is set to "true" or "false" by default.