Reads the version resource

Example:

read /version

Example Response:

{
  "payload": {
    "_links": {
      "self": {
        "href": "/version"
      }
    },
    "apiVersion": "1.0.0"
  },
  "status": 1,
  "type": "response"
}

Reads the system properties.

Example:

read /system

Method Trait: (WearsFlash)

Updates system properties.

Example:

update /system {"autoStart" : true }

Occurs whenever the system properties change (ie. sensor is started, stopped, etc.).

Example:

{ "eventType" : "updated", "path" : "/system",
  "payload" : {system properties} }

Starts the sensor system.

Example:

call /system/commands/start

Stops the sensor system.

Example:

call /system/commands/stop

Start the upgrade with the provided package.

Payload:

Example:

call /system/commands/upgrade {"skipValidation" : false, "package": <binary data>}

or

call /system/commands/upgrade {"skipValidation" : false, "package": "upgradeFile.dat"}

Method Trait: (WearsFlash) ( NoRestart )

Factory restores the sensor configuration.
The job is set to factory defaults and all jobs within persistent storage are cleared. See the Resource Reference#/jobs resource for information about how to read jobs out before performing a factory restore.

Example:

call /system/commands/factoryRestore

Method Trait:( NoRestart )

Resets the sensor.

Example:

call /system/commands/restart

Performs a snapshot with the scanner .

NOTE: This operation may take awhile to execute because the the scanner and sensor(s) involved must accumulate data for a snapshot to be complete.

Example:

call /system/commands/snapshot 

Performs a simulate with the scanner, which processes the last frame (if available) through the pipe.

Example:

call /system/commands/simulate

Performs a backup operation based on the argument passed. If there is no argument, then get all the files ie Jobs, workspace, global, replay and support.

Payload:

Response:

The response for this transaction contains additional information besides the standard control message response fields .

Examples:

To recreate what the GUI does during Maintenance > Backup:

call /system/commands/archive {"contents" : ["global", "allWorkspaces", "alljobs", "replay"]}

To recreate what the GUI doesduring Support > Download:

call /system/commands/archive {"contents" : ["global", "allWorkspaces", "alljobs", "replay", "support", "liveJob"]}

To recreate what the GUI doesduring Replay > Download:

call /system/commands/archive {"contents" : ["liveJob", "replay"]}

Example Response :

{
  "status": 1,
  "payload": {
    "data": [ <binary data> ]
  }
}

Performs a restore operation based on the argument and the binary data passed. This will work only with both these fields present. Otherwise, it will return an error.

Validation of data is also part of these resources. It means the contents filed are verified with the binary data passed. If any of the content field data is missing then the command will report an error.

If contents are specified which are not in the provided archive, the request will fail.

Note: Support data can not be restored.

Payload:

Examples:

To recreate what the GUI does during Maintenance > Restore:

call /system/commands/restore {"data":{binary data}, "contents" : ["global", "allWorkspaces", "allJobs", "replay"]}

To recreate what the GUI does during Replay > Upload:

call /system/commands/restore {"data":{binary data}, "contents" : ["liveJob", "replay"]}

Application ID.

1.1.x.x Added.

This resource provides various additional information about the GoPxL application system and state. All properties in this resource are readonly and therefore only the read method is acceptable.

Example:

read /system/info

Reads the latest system metrics.

Example:

read /system/metrics

which for example, returns:

{
  "payload": {
    "_links": {
      "self": {
        "href": "/system/metrics"
      }
    },
    "advanced": {
      "hostPorts": [
        {
          "commandCount": 0,
          "port": 3210,
          "replyCount": 0,
		  "responseDataDropCount": 0,
          "streamDataDropCount": 0,
          "streamDataSkipCount": 0,
          "streamQueueSizeExceededCount": 0
        }
      ],
      "maxSafeInteger": 9007199254740991,
      "maxSafeIntegerPlus": 9007199254740992,
      "runCount": 0
    },
    "appUpTime": 6,
    "cpuCores": [
      {
        "used": 0
      },
      {
        "used": 0
      }
    ],
    "cpuCoresUsedAvg": 0,
    "cpuCoresUsedMax": 0,
    "memCapacity": 1053257728,
    "memUsed": 127340960,
    "networkIfs": [
      {
        "linkCapacity": 125000000,
        "linkStatus": 32,
        "rxBytes": 8038,
        "rxRate": 305,
        "txBytes": 43550,
        "txRate": 788
      }
    ],
    "pipeBacklogCount": -9223372036854775808,
    "pipeBacklogSize": -9223372036854775808,
    "processingDrops": 0,
    "processingLatencyLast": 0,
    "processingLatencyMax": 0,
    "storageVolumes": [
      {
        "capacity": 251133952,
        "used": 87003136
      },
      {
        "capacity": 6762496,
        "used": 2347008
      }
    ],
    "upTime": 24
  },
  "status": 1,
  "type": "response"
}

Receive continuous stream of system metrics.

Example:

stream /system/metrics

Cancel continuous stream of system metrics.

Example:

cancelStream /system/metrics

Read the ipConfig properties.

Example:

read /environ/ipConfig

Example Response:

{
  "payload": {
    "_links": {
      "self": {
        "href": "/environ/ipConfig"
      }
    },
    "_schema": {
      "properties": {
        "interfaces": {
          "items": [
            {
              "properties": {
                "dhcp": {
                  "type": "boolean"
                },
                "gatewayAddress": {
                  "type": "string"
                },
                "ipAddress": {
                  "type": "string"
                },
                "ipVersion": {
                  "type": "integer"
                },
                "subnetMask": {
                  "type": "string"
                }
              },
              "type": "object"
            },
            {
              "properties": {
                "dhcp": {
                  "type": "boolean"
                },
                "gatewayAddress": {
                  "type": "string"
                },
                "ipAddress": {
                  "type": "string"
                },
                "ipVersion": {
                  "type": "integer"
                },
                "subnetMask": {
                  "type": "string"
                }
              },
              "type": "object"
            },
            {
              "properties": {
                "dhcp": {
                  "type": "boolean"
                },
                "gatewayAddress": {
                  "type": "string"
                },
                "ipAddress": {
                  "type": "string"
                },
                "ipVersion": {
                  "type": "integer"
                },
                "subnetMask": {
                  "type": "string"
                }
              },
              "type": "object"
            }
          ],
          "type": "array"
        }
      },
      "type": "object"
    },
    "interfaces": [
      {
        "dhcp": true,
        "gatewayAddress": "0.0.0.0",
        "ipAddress": "192.168.208.78",
        "ipVersion": 4,
        "subnetMask": "255.255.255.255"
      },
      {
        "dhcp": true,
        "gatewayAddress": "0.0.0.0",
        "ipAddress": "10.0.0.178",
        "ipVersion": 4,
        "subnetMask": "255.255.255.0"
      },
      {
        "dhcp": true,
        "gatewayAddress": "0.0.0.0",
        "ipAddress": "127.0.0.1",
        "ipVersion": 4,
        "subnetMask": "255.0.0.0"
      }
    ]
  },
  "status": 1,
  "type": "response"
}

Change the IP configuration of the system host (eg. Sensor or GoMax)

Example:

update /environ/ipConfig {"interfaces":[{"dhcp": true, "gatewayAddress": "0.0.0.0", "ipAddress": "90.23.29.25", "ipVersion": 4, "subnetMask": "255.255.0.0"}]}

Note:- Only sensor and GoMax network configurations can be updated.

• 0: Gocator Sensor
• 1: GoPxL on PC
• 2: GoMax

Model of the sensor.

1.0.x.x Added.

Unique serial number of a sensor.

1.0.x.x Added.

Version of the sensor firmware.

1.0.x.x Added.

Model name of the sensor.

1.0.x.x Added.

{
  "_links": {
    "self": {
      "href": "/api/environ/info"
    }
  },
  "_schema": {
    "properties": {
      "applicationType": {
        "readOnly": true,
        "sortOrder": 0,
        "title": "applicationType",
        "type": "integer"
      },
      "controllerType": {
        "readOnly": true,
        "sortOrder": 1,
        "title": "controllerType",
        "type": "integer"
      }
    },
    "sortOrder": 0,
    "title": "",
    "type": "object"
  },
  "applicationType": 2,
  "controllerType": 1
}

Boolean of whether sensor is remote connected or not.

IP Address of remote controller.

Control Port of remote controller.

Web Port of remote controller.

{
  "_links": {
    "self": {
      "href": "/api/environ/remoteController"
    }
  },
  "_schema": {
    "properties": {
      "controlPort": {
        "readOnly": true,
        "sortOrder": 200,
        "title": "controlPort",
        "type": "integer"
      },
      "ipAddress": {
        "readOnly": true,
        "sortOrder": 100,
        "title": "ipAddress",
        "type": "string"
      },
      "remoteConnected": {
        "readOnly": true,
        "sortOrder": 0,
        "title": "remoteConnected",
        "type": "boolean"
      },
      "webPort": {
        "readOnly": true,
        "sortOrder": 300,
        "title": "webPort",
        "type": "integer"
      }
    },
    "sortOrder": 0,
    "title": "",
    "type": "object"
  },
  "controlPort": 0,
  "ipAddress": "",
  "remoteConnected": false,
  "webPort": 0
}

Reads the replay properties.

Occurs whenever the properties change, e.g., when the frame count or frame index changes. The server may throttle the update rate to avoid notification spam.
This is limited to a 10Hz rate

Read all tracks from the replay module.

Example:

read /replay/tracks

Example Response:

{
  "payload": {
    "_embedded": {
      "item": [
        {
          "_links": {
            "self": {
              "href": "/replay/tracks/0"
            }
          }
        },
        {
          "_links": {
            "self": {
              "href": "/replay/tracks/1"
            }
          }
        }
      ]
    },
    "_links": {
      "self": {
        "href": "/replay/tracks"
      }
    }
  },
  "status": 1,
  "type": "response"

Reads the resource.

Returns the properties of track.

Example:

read  /replay/tracks/0

Example Response:

{
  "payload": {
    "_embedded": {
      "channels": [
        {
          "_links": {
            "self": {
              "href": "/replay/tracks/0/channels/0"
            }
          }
        },
        {
          "_links": {
            "self": {
              "href": "/replay/tracks/0/channels/1"
            }
          }
        }
      ]
    },
    "_links": {
      "self": {
        "href": "/replay/tracks/0"
      }
    },
    "displayName": "New Scanner 1",
    "engineId": "test",
    "scannerId": "0"
  },
  "status": 1,
  "type": "response"
}

Read all channels from the corresponding track.

Example:

read  /replay/tracks/0/channels

Example Response:

{
  "payload": {
    "_embedded": {
      "item": [
        {
          "_links": {
            "self": {
              "href": "/replay/tracks/0/channels/0"
            }
          }
        },
        {
          "_links": {
            "self": {
              "href": "/replay/tracks/0/channels/1"
            }
          }
        }
      ]
    },
    "_links": {
      "self": {
        "href": "/replay/tracks/0/channels"
      }
    }
  },
  "status": 1,
  "type": "response"
}

Reads the resource.

Returns the properties of channel added to track.

Example:

read  /replay/tracks/0/channels/0

Example Response:

{
  "payload": {
    "_links": {
      "self": {
        "href": "/replay/tracks/0/channels/1"
      }
    },
    "dataSourceId": "scan:test:0:Stamp",
    "displayName": "New Scanner 1: Stamp Output"
  },
  "status": 1,
  "type": "response"
}

Reads the playback settings.

Occurs whenever the properties change.

Reads the playback settings.

Occurs whenever the properties change.

Invokes the command.

Invokes the command.

Invokes the command.

Returns the array of data sources.

Example:

read /dataSources

Occurs whenever the dataSource collection changes due to additions, deletions, or moves/reorders during a job load.

Example:

{ "eventType" : "embeddedUpdated", "path" : "/dataSources"

1.0.x.x Added

Read a specific dataSource.

Example:

read /dataSources/gocator:scanner-0:top:profile
read /dataSources/tools:TestForward-0:otuputs:Output0

Occurs whenever a datasource output (eg. from scanners or tools ) is updated. The path indicates the data source output id that was deleted.

Example:

{ "eventType" : "updated", "path" : "path" : "/dataSources/tools:TestForward-0:outputs:Output0",
  "payload" : {display source output properties} }

Occurs whenever a datasource (eg. scanner or tool output) is deleted or gets disabled.. The path indicates the data source output id that was deleted.

Example:

{ "eventType" : "deleted", "path" : "path" : "/dataSources/tools:TestForward-0:outputs:Output0" }

Streams data from a specific dataSource.

Arguments:

Example:

stream /dataSources/gocator:scanner-0:top:profile/data
stream /dataSources/tools:TestForward-0:otuputs:Output0/data {"period": 250000}
stream /dataSources/tools:TestForward-0:otuputs:Output0/data {"streamLastFrame":true}

Read high-level job information from the system.

Examples:

Read the high-level job information, and expands any embedded information such as /jobs/files resource within it.

read /jobs { "expandLevel" : -1 }

Occurs whenever high-level job information changes, such as the default job, loaded job, and if the loaded job becomes dirty. The path indicates the /jobs resource.

Example:

{ "eventType" : "updated", "path" : "/jobs",
  "payload" : {updated jobs properties} }

Reads the current list of problems.

Example:

read /problems

Example response

{
  "_links": {
    "self": {
      "href": "/api/problems"
    }
  },
  "_schema": {
    "properties": {
      "msg": {
        "type": "string"
      },
      "severity": {
        "type": "integer"
      },
      "source": {
        "type": "string"
      }
    },
    "type": "object"
  },
  "items": [
    {
      "msg": "Data source required (at: ProfilePosition-0 tool[Profile Input]).",
      "severity": 0,
      "source": "Pipe"
    }
  ]
}

Occurs whenever the problems collection changes due to additions or deletions (or if all problems are resolved).

Example:

{ "eventType" : "updated", "path" : "/problems",
  "payload" : {updated /problems collection} }

Reads the /logs collection.

Payload:

If either of these are out of the range[ idStart , idEnd], kERROR_PARAMETER is thrown. If startId > endId, logs is empty.

Examples:

read /logs
read /logs {"startId": 1, "endId": 3}

Reads the list of visible sensors, across all scan engines.

Example response:

{  
  "sensors": [
    {
      "connectionMessage": "",
      "connectionStatus": 0,
      "engineId": "LMILaserLineProfiler",
      "isLocal": false,
      "model": "2330",
      "parameters": {
        "ipAddress": "90.23.50.45",
        "optionCode": 1
      },
      "serialNumber": "45045",
      "version": "1.0.0.0"
    },
    {
      "connectionMessage": "",
      "connectionStatus": 0,
      "engineId": "LMIConfocalLineProfiler",
      "isLocal": false,
      "model": "5512",
      "parameters": {
        "ipAddress": "90.55.52.68",
        "optionCode": 1
      },
      "serialNumber": "55268",
      "version": "1.0.0.0"
    },
  ]
}

Occurs when the visible sensors for any scan engine changes. The path indicates the overall visible sensors list.

Example notification:

{ "eventType" : "updated", "path" : "/scan/visibleSensors" }

Reads all scan engines, the list of scan engines are returned as embedded items.

Example response:

{
  "_embedded": {
    "item": [
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler"
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMIFringeSnapshot"
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMIConfocalLineProfiler"
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "/scan/engines/test"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "/scan/engines"
    }
  }
}

Max sensor count.

1.0.x.x Added.

Reads a specific scan engine.

Example response:

{
  "_links": {
    "self": {
      "href": "/scan/engines/LMILaserLineProfiler"
    }
  },
  "displayName": "Gocator Laser Profiler",
  "id": "LMILaserLineProfiler",
  "maxSensorCount" : 31
}

Reads the list of visible sensors, for a specific scan engine.

Example response:

{  
  "sensors": [
    {
      "connectionMessage": "",
      "connectionStatus": 0,
      "engineId": "LMILaserLineProfiler",
      "isLocal": false,
      "model": "2330",
      "parameters": {
        "ipAddress": "90.23.50.45",
        "optionCode": 1
      },
      "serialNumber": "45045",
      "version": "1.0.0.0"
    },
    {
      "connectionMessage": "",
      "connectionStatus": 0,
      "engineId": "LMILaserLineProfiler",
      "isLocal": false,
      "model": "2340",
      "parameters": {
        "ipAddress": "90.23.50.46",
        "optionCode": 1
      },
      "serialNumber": "45046",
      "version": "1.0.0.0"
    },
  ]
}

Occurs when the visible sensors for a specific scan engine changes. The path indicates the specific scan engine's visible sensors list.

Example notification:

{ "eventType" : "updated", "path" : "/scan/engines/LMILaserLineProfiler/visibleSensors" }

Reads all scanners under the engine; the list of scanners are returned as embedded items.

Example response:

{
  "_embedded": {
    "item": [
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "/scan/engines/LMILaserLineProfiler/scanners"
    }
  },
  "creationParams": {
    "defaultSerialNumber": 0
  }
}

Creates a scanner resource.
NOTE: A client should read the scanners resource to see if there are creationParams that can be supplied in the create method.

Example request:

create /scan/engines/LMILaserLineProfiler/scanners {"defaultSerialNumber": 12345}

Occurs when a new scanner is added. The path indicates the new scanner id.

Example notification:

{ "eventType" : "created", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0"}

Occurs when a scanner's properties change. The path indicates the affected scanner id.

Example notification:

{ "eventType" : "updated", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0" }

Occurs when a scanner is deleted. The path indicates the scanner id that was deleted.

Example notification:

{ "eventType" : "deleted", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0" }

Reads the scanner resource.
Returns child resources as embedded items.
Returns actions as links.

Example response:

{
  "_embedded": {
    "go:content": [  // see /scan/engines/(engineId)/scanners/(scannerId)/(contentId)
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/alignment"
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/layout"
          }
        }
      }
    ],
    "go:output": [  // see /scan/engines/(engineId)/scanners/(scannerId)/outputs
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/outputs/sensor-0:profile"
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/outputs/stamp"
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/outputs/top:profile"
          }
        }
      }
    ],
    "go:sensor": [  // see /scan/engines/(engineId)/scanners/(scannerId)/sensors
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0"
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-1"
          }
        }
      }
    ]
  },
  "_links": {
    "go:action": [  // see /scan/engines/(engineId)/scanners/(scannerId)/actions
      {
        "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/actions/autoLayout"
      },
      {
        "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/actions/trigger"
      }
    ],
    "self": {
      "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0"
    }
  },
  "displayName": "Gocator 0",
  "id": "scanner-0",
  "parameters": {
    // scan-engine-specific scanner parameters
  }
}

Updates the scanner resource.

Arguments:

Example request:

update /scan/engines/LMILaserLineProfiler/scanners/scanner-0 { "parameters" : { "uniformSpacingEnabled" : true } }

Deletes the scanner resource.

Example request:

delete /scan/engines/LMILaserLineProfiler/scanners/scanner-0

Occurs when a scanner is created. The path indicates the affected scanner.

Example notification:

{ "eventType" : "created", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0"}

Occurs when a scanner's properties change. The path indicates the affected scanner.

Example notification:

{ "eventType" : "updated", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0"}

Occurs when a scanner resource has been deleted. The path indicates the affected scanner.

Example notification:

{ "eventType" : "deleted", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0"}

Returns the alignment state & config.

Example response:

{
  "payload": {
    "alignState": 0,
    "alignConfig": {
      "timeout": 120
    }
  },
  "status": 1,
  "type": "response"
}

Update the alignment configuration. The state is read-only and cannot be updated.

update /scan/engines/LMILaserLineProfiler/scanners/scanner-0/alignment { "alignConfig" : { "timeout" : 90 } }

Occurs when the alignment configuration is updated or the alignment state changes.

{ "eventType" : "updated", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/alignment"}

Returns the alignment transforms.

Example response:

{
  "payload": {
    "_links": {
      "self": {
        "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/transform"
      }
    },
    "encoderResolution": 1.0,
    "speed": 100.0,
    "transform": {
      "xAngle": 0.0,
      "xOffset": 0.0,
      "yAngle": 0.0,
      "yOffset": 0.0,
      "zAngle": 0.0,
      "zOffset": 0.0
    }
  },
  "status": 1,
  "type": "response"
}

Update the alignment transforms manually. This will not change the scanner's alignment state.

update /scan/engines/LMILaserLineProfiler/scanners/scanner-0/transform { "transform" : { "xAngle" : -2.1} }

Occurs when the alignment configuration is updated or the alignment state changes.

{ "eventType" : "updated", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/alignment"}

Reads the latest scanner metrics.

Example:

read /scan/engines/LMILaserLineProfiler/scanners/scanner-0/metrics

which for example, returns:

{
  "payload": {
    "_links": {
      "self": {
        "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/metrics"
      }
    },
    "advanced": {
      "overSpeedJitterCount": -9223372036854775808,
      "overSpeedJitterMax": -1.7976931348623157e+308
    },
    "encoderFreq": 0,
    "encoderValue": 0,
    "g2Scanner": {},
    "maxSpeed": 208.55397148676172,
    "scanCount": -9223372036854775808,
    "scannerDrops": 0,
    "speed": -1.7976931348623157e+308,
    "triggerDrops": 0
  },
  "status": 1,
  "type": "response"
}

Receive continuous stream of scanner metrics.

Example:

stream /scan/engines/LMILaserLineProfiler/scanners/scanner-0/metrics

Cancel continuous stream of scanner metrics.

Example:

cancelStream /scan/engines/LMILaserLineProfiler/scanners/scanner-0/metrics

Returns the list of scanner outputsas embedded resources.

Example response:

{
  "payload": {
    "_embedded": {
      "item": [
        {
          "_links": {
            "self": {
              "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/outputs/sensor-0:profile"
            }
          }
        },
        {
          "_links": {
            "self": {
              "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/outputs/stamp"
            }
          }
        },
        {
          "_links": {
            "self": {
              "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/outputs/top:profile"
            }
          }
        }
      ]
    },
    "_links": {
      "self": {
        "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/outputs"
      }
    }
  },
  "status": 1,
  "type": "response"
}

Priority of the scanner output as an unsigned 32-bit integer.

Highest priority being 1 and 0 being undefined priority which will always be last.

0.3.x.x Added

Returns the output parameters described above.

Example response:

{
  "_links": {
    "self": {
      "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/outputs/stamp"
    }
  },
  "dataFormat": {
    "arrayed": false,
    "type": 8
  },
  "dataSourceId": "scan:LMILaserLineProfiler:scanner-0:stamp",
  "displayName": "Stamp",
  "enabled": true,
  "id": "stamp",
  "recordingEnabled": true
}

Occurs when a new output is added. The path indicates the new scanner output.

Example:

{ "eventType" : "created", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/top:surface"}

Occurs when a scanner output's properties change. The path indicates the affected scanner output.

Example:

{ "eventType" : "updated", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/stamp" }

Occurs when a scanner output is deleted. The path indicates the scanner output that was deleted.

Example:

{ "eventType" : "deleted", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/top:surface" }

Reads scanner custom content.

Example request:

read /scan/engines/LMILaserLineProfiler/scanners/scanner-0/layout

Example response:

{
  "_links": {
    "self": {
      "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/layout"
    }
  },
  "grid": {
    // ...
  }
}

Updates the custom scanner content resource.

Example request:

update /scan/engines/LMILaserLineProfiler/scanners/scanner-0/layout {...}

Occurs when the custom scanner content resource changes.

Example notification:

{ "eventType" : "updated", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/layout" }

Aligns the scanner. The response to calling this resource may be returned immediately, even if if alignment has not completed. In this case, clients can check for alignment completion by checking alignState on the parent scanner resource. More specific behavior information can be found within the scan engine specific documentation.

Arguments:

Example request:

call /scan/engines/LMILaserLineProfiler/scanners/scanner-0/commands/align {"interactive":false}

Cancels scanner alignment.

Example request

call /scan/engines/LMILaserLineProfiler/scanners/scanner-0/commands/cancelAlign

Clears scanner alignment.

Example request

call /scan/engines/LMILaserLineProfiler/scanners/scanner-0/commands/clearAlign

Returns a list of custom scanner actions as embedded resources.

Example request:

read /scan/engines/engineId/scanners/scannerId/actions

Example response:

{
  "_embedded": {
    "item": [
      {
        "_links": {
          "self": {
            "href": "/scan/engines/engineId/scanners/scannerId/actions/sampleAction"
          }
        }
      }
    ]
  },

    ]
  },
  "_links": {
    "self": {
      "href": "/scan/engines/engineId/scanners/scannerId/actions"
    }
  }
}

Reads the scanner custom action resource.

Example request:

read /scan/engines/engineId/scanners/scannerId/actions/sampleAction 

Example response:

{
  "_links": {
    "self": {
      "href": "/scan/engines/engineId/scanners/scannerId/actions/sampleAction"
    }
  },
  "_schema": {
    "parameters": {
      "properties": {
        "arg1": {
          "type": "string",
          "title": "Argument 1"
        }
      }
    }
  },
  "id": "trigger",
  "parameters": {
    "arg1": "default value"
  }
}

Calls the action resource.

Example request:

call /scan/engines/engineId/scanners/scannerId/actions/sampleAction {arg1: "user value"}

Reads all sensors under the scanner; the list of sensors are returned as embedded items.

{
   "_embedded": {
      "item": [
        {
          "_links": {
            "self": {
              "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0"
            }
          }
        },
        {
          "_links": {
            "self": {
              "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-1"
            }
          }
        }
      ]    },
    "_links": {
      "self": {
        "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors"
      }
    },
    "creationParams": {
      "serialNumber": 0
    }
  },
}

Method Trait: ( NoRestart ) System will not be restarted when adding sensors. This applies if a scanner already has sensors and is already running. After the addition of a sensor to the scanner, the system will remain in stopped state.

Creates a sensor resource underneath the scanner.
NOTE: A client should read the sensors resource to see if there are creationParams that can be supplied in the create method.

Example request:

create /scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors {"serialNumber": 12345}

Reads the sensor resource.
Returns child resources as embedded items.
Returns actions as links.

Example response:

{
  "_embedded": {
    "go:content": [ // see /scan/engines/(engineId)/scanners/(scannerId)/sensors/(sensorId)/content
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/alignment"
          }
        }
      }
    ],
  },
  "_links": {
    "go:actions": [ // see /scan/engines/(engineId)/scanners/(scannerId)/sensors/(sensorId)/actions
      {
        "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/actions/setAddress"
      },
      {
        "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/actions/upgrade"
      },
      {
        "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/actions/resetActiveArea"
      },
    ],
    "self": {
      "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0"
    }
  },
  "displayName": "Sensor 0",
  "id": "sensor-0",
  "parameters": {
    // scan-engine-specific sensor parameters
  }
  // SensorInfo properties
}

Updates the sensor resource.

Arguments:

Example request:

update /scan/engines/test/scanners/0/sensors/sensor-0 {"parameters" : { "subsamplingSettings" : { "xSubsampling" : 1 } } }

Deletes the sensor resource.

Example request:

delete /scan/engines/test/scanners/0/sensors/sensor-0

Occurs when a sensor is added to the scanner. The path indicates the affected sensor.

Example notification:

{ "eventType" : "created", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0"}

Occurs when a sensor's properties change. The path indicates the affected sensor.

Example notification:

{ "eventType" : "updated", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0" }

Occurs when a sensor is removed from a scanner. The path indicates the affected sensor.

Example notification:

{ "eventType" : "deleted", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0" }

Returns the alignment transforms.

Example response:

{
  "payload": {
    "_links": {
      "self": {
        "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/transform"
      }
    },
    "encoderResolution": 1.0,
    "speed": 100.0,
    "transform": {
      "xAngle": 0.0,
      "xOffset": 0.0,
      "yAngle": 0.0,
      "yOffset": 0.0,
      "zAngle": 0.0,
      "zOffset": 0.0
    }
  },
  "status": 1,
  "type": "response"
}

Update the alignment transforms manually. This will not change the scanner's alignment state.

update /scan/engines/LMILaserLineProfiler/scanners/scanner-0/transform { "transform" : { "xAngle" : -2.1} }

Occurs when the alignment configuration is updated or the alignment state changes.

{ "eventType" : "updated", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/alignment"}

Reads the latest sensor metrics.

Example:

read /scan/engines/LMILaserLineProfiler/scanners/0/sensors/sensor-0/metrics

which for example returns:

{
  "payload": {
    "_links": {
      "self": {
        "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/metrics"
      }
    },
    "cameraBufferDrops0": 0,
    "cameraBufferDrops1": -9223372036854775808,
    "cameraTemp0": -9223372036854775808,
    "cameraTemp1": -9223372036854775808,
    "connectAttempts": 1,
    "cpuCores": [
      {
        "used": 1
      },
      {
        "used": 3
      }
    ],
    "cpuCoresUsedAvg": 2,
    "cpuCoresUsedMax": 3,
    "cpuTemp": 40259,
    "expTimeTotal": 3298,
    "intTemp": 31250,
    "laserDriverTemp": 29812,
    "laserSafety": true,
    "masterConnected": false,
    "masterStatus": false,
    "maxSpots": 1256,
    "memCapacity": 1053257728,
    "memUsed": 128603264,
    "networkIfs": [
      {
        "linkCapacity": 125000000,
        "linkStatus": 32,
        "rxBytes": 658570,
        "rxRate": 3118,
        "txBytes": 16242729,
        "txRate": 61384
      }
    ],
    "storageVolumes": [
      {
        "capacity": 251133952,
        "used": 87003136
      },
      {
        "capacity": 6762496,
        "used": 2347008
      }
    ],
    "syncSource": 2,
    "triggerDrops": 0,
    "upTime": 817
  },
  "status": 1,
  "type": "response"
}

Receive continuous stream of sensor metrics.

Example:

stream /scan/engines/LMILaserLineProfiler/scanners/0/sensors/sensor-0/metrics

Cancel continuous stream of sensor metrics.

Example:

cancelStream /scan/engines/LMILaserLineProfiler/scanners/0/sensors/sensor-0/metrics

Reads sensor custom content.

Example request:

read /scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/alignment

Example response:

{
  "_links": {
    "self": {
      "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/alignment"
    }
  },
  "targetParams": {
    "alignmentType": 0,
    "targetType": 0,
    "targetValues": [],
    "updateEncoderSpeedCalibration": false
  },
  "transform": {
    "xAngle": 0.0,
    "xOffset": 0.0,
    "yAngle": 0.0,
    "yOffset": 0.0,
    "zAngle": 1.0,
    "zOffset": 0.0
  }
}

Updates the custom sensor content resource.

Example request:

update /scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/alignment {...}

Occurs when the custom sensor content resource changes.

Example notification:

{ "eventType" : "updated", "path" : "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/alignment" }

Returns a list of custom sensor actions as embedded resources.

Example response:

{
  "_embedded": {
    "item": [
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/actions/setAddress"
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/actions/upgrade"
          }
        }
      },
      {
        "_links": {
          "self": {
            "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/actions/resetActiveArea"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/actions"
    }
  }
}

Reads the sensor custom action resource.

Example response:

{
  "_links": {
    "self": {
      "href": "/scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/actions/setAddress"
    }
  },
  "id": "setAddress",
  "parameters": {
    "address": "",
    "dhcpEnabled": false,
    "gateway": "",
    "subnet": ""
  }
}

Calls the sensor custom action resource.

Example request:

call /scan/engines/LMILaserLineProfiler/scanners/scanner-0/sensors/sensor-0/actions/setAddress {"address": "90.23.50.45, "dhcpEnabled" : false, ...}

scannerDrops

Total drops across all sensor cameras & projectors that don't fall under trigger drops. Value resets on scan start, not stop, so value will persist when scanning stops.

0.3.x.x Added

Ycenter (mm). The limits of Y (ie minimum and maximum) vary according to the current Length. AsLength increases, the freedom of motion for Y decreases.

Not used by all scanners, in which case used=false.

1.0.x.x Added readOnly.

Y extent (mm). Not used by all scanners, in which case used=false.

1.0.x.x Added readOnly.

Enhanced surface flatness feature parameters

1.1.x.x Parameter group created.

Array of coefficients if filterType is not 0.

ADVANCED

Size of the filter if filterType is not 0. Allowed values3, 5, 7, 9, 11 and 13.

ADVANCED

ADVANCED

HDR mode

0 - disabled

1 - Gamma compression

1.1.x.x Added.

HDR gamma compression

1.1.x.x Added.

LMILaserLineProfiler scan engine provided additional sensor information.

Example:

{  
	"parameters": {
		"ipAddress": "90.23.50.45",
		"optionCode": 1
	}
}

creationParams

parameters