picoScan150 REST interface description (2.1.0)

Download OpenAPI specification:

URL: https://github.com/SICKAG/sick_scan_rest_client

This is the REST interface description of the picoScan150. The range of functions can vary depending on the variant and software package.

1 - General

Post/checkCredentials

Returns authentication success. For more details see https://github.com/SICKAG/sick_scan_rest_client

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Post/SetPassword

Sets the password for the CoLa A/B interface only. In this example the password for user level: Service (4) is set to - test - (integer value of the password hash - test -). For more details see https://github.com/SICKAG/sick_scan_rest_client

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"siUserLevel": 4,
"udiNewPassword": 3410122659
}
}

Response samples

200

Content type

application/json

{"bSuccess": false
}

Post/getChallenge

Returns a challenge for the challenge and response authentication method. For more details see https://github.com/SICKAG/sick_scan_rest_client

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"user": "Run"
}
}

Response samples

200

Content type

application/json

{"realm": " ",
"nonce": " ",
"opaque": " ",
"salt": [ ]
}

Post/changePassword

Sets the password for the REST interface. For more details see https://github.com/SICKAG/sick_scan_rest_client

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"encryptedMessage": [ ],
"userLevel": "Run"
}
}

Response samples

200

Content type

application/json

{"result": 0
}

Post/EnableUserLevel

Activates / deactivates a specific user level for the REST interface.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"userLevel": 0,
"isEnabled": false
}
}

Response samples

200

Content type

application/json

{"result": 0
}

Post/WriteEeprom

Saves all parameters permanently.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"Success": false
}

Post/SoftReset

Reboots the device. All non-saved parameters are lost. This function requires the user level: Service.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"ProcessorNbr": 0
}
}

Post/RebootDevice

Reboots the device. All parameters are saved. This function requires the user level: Service.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Post/LoadFactoryDefaults

Resets all parameters to default. This function requires the user level: Service.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Post/EnableLegacyUserLevel

Activates / deactivates a specific user level for the CoLa A/B interface.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"userLevel": 7,
"isEnabled": false
}
}

Response samples

200

Content type

application/json

{"result": false
}

Post/LoadApplicationDefaults

Resets only the user parametrization of the fields, evaluation cases, and parameters under the section "Application". Other parameters like interface settings, echo filter, etc. remain unchanged. This function requires the user level: Service.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

2 - Status

Get/DeviceStatus

Returns the device state (9 possible states).

Responses

Response samples

200

Content type

application/json

0

0

Get/SCdevicestate

Returns the device state (busy, ready, or ready).

Responses

Response samples

200

Content type

application/json

0

0

3 - Device

Get/DeviceIdent

Returns the device name and the firmware version.

Responses

Response samples

200

Content type

application/json

{"Name": "picoScan",
"Version": "2.1.0.0R"
}

Get/LocationName

Returns/sets the device name.

Responses

Response samples

200

Content type

application/json

"not defined"

Post/LocationName

Returns/sets the device name.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"LocationName": "not defined"
}
}

Get/SerialNumber

Returns the serial number.

Responses

Response samples

200

Content type

application/json

"123456789"

Get/FirmwareVersion

Returns the current firmware version.

Responses

Response samples

200

Content type

application/json

"XXXXXXXXXX"

Get/OrderNumber

Returns the order number (SICK part number).

Responses

Response samples

200

Content type

application/json

"1234567"

Get/DeviceType

Returns the device type.

Responses

Response samples

200

Content type

application/json

"picoScan1xx"

Post/FindMe

Sets the device LEDs into blinking mode for better identification.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"uiDuration": 100
}
}

4 - Basic settings

Get/LEDState

Returns the LED status.

Responses

Response samples

200

Content type

application/json

[ ]

Get/LEDEnable

Returns/sets the LED mode (on/off).

Responses

Response samples

200

Content type

application/json

true

Post/LEDEnable

Returns/sets the LED mode (on/off).

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"LEDEnable": true
}
}

Post/mStartMeasure

Start motor and measurement.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"ErrorCode": 0
}

Post/mStandby

Enables/disables the Laser (on/off).

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"ErrorCode": 0
}

Post/mStopMeasure

Stop motor and measurement.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"ErrorCode": 0
}

Get/AutoStartMeasure

Returns/sets the mode for automatic start of measurement after boot-up.

Responses

Response samples

200

Content type

application/json

true

Post/AutoStartMeasure

Returns/sets the mode for automatic start of measurement after boot-up.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"AutoStartMeasure": true
}
}

Get/PerformanceProfileNumber

Returns/sets the scan configuration (scanning frequency and angular resolution).

Responses

Response samples

200

Content type

application/json

1

Post/PerformanceProfileNumber

Returns/sets the scan configuration (scanning frequency and angular resolution).

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"PerformanceProfileNumber": 1
}
}

Get/ScanConfig

Configuration of angular resolution, scanning frequency, start- and stop angle.

Responses

Response samples

200

Content type

application/json

{"udiScanFreq": 4000,
"ScanRange": {"uiLength": 1,
"aRange": [{"udiAngleRes": 2500,
"diStartAngle": -1380000,
"diStopAngle": 1380000
}
]
}
}

Get/EnableLongRangeMode

Enables/disables the maximum scanning range depending on the scan configuration.

Responses

Response samples

200

Content type

application/json

false

Post/EnableLongRangeMode

Enables/disables the maximum scanning range depending on the scan configuration.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EnableLongRangeMode": false
}
}

Get/SensitivityMode

Returns/sets the sensitivity of the receiver unit.

Responses

Response samples

200

Content type

application/json

0

0

Post/SensitivityMode

Returns/sets the sensitivity of the receiver unit.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"SensitivityMode": 0
}
}

5 - Date and system time

Get/TSCRole

Returns/sets the time synchronization role (none, NTP or PTP).

Responses

Response samples

200

Content type

application/json

0

0

Post/TSCRole

Returns/sets the time synchronization role (none, NTP or PTP).

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"TSCRole": 0
}
}

Get/TSCTCSrvAddr

Returns/sets the IP address of the time server.

Responses

Response samples

200

Content type

application/json

[192,
168,
0,
11
]

Post/TSCTCSrvAddr

Returns/sets the IP address of the time server.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"TSCTCSrvAddr": [192,
168,
0,
11
]
}
}

Get/TSCTCtimezone

Returns/sets the time zone of the client.

Responses

Response samples

200

Content type

application/json

0

0

Post/TSCTCtimezone

Returns/sets the time zone of the client.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"TSCTCtimezone": 0
}
}

Get/TSCTCupdatetime

Returns/sets the update time of the client.

Responses

Response samples

200

Content type

application/json

600

Post/TSCTCupdatetime

Returns/sets the update time of the client.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"TSCTCupdatetime": 600
}
}

Get/LSPdatetime

Returns the current time of the device (years, months, days, hours, minutes, seconds, microseconds).

Responses

Response samples

200

Content type

application/json

{"uiYear": 0,
"usiMonth": 1,
"usiDay": 1,
"usiHour": 0,
"usiMinute": 0,
"usiSec": 0,
"udiUSec": 0
}

Post/LSPsetdatetime

Sets the time of the device (years, months, days, hours, minutes, seconds, microseconds).

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"DateTime": {"uiYear": 0,
"usiMonth": 1,
"usiDay": 1,
"usiHour": 0,
"usiMinute": 0,
"usiSec": 0,
"udiUSec": 0
}
}
}

Response samples

200

Content type

application/json

{"ErrorCode": 0
}

6 - Filter

Get/MCSenseLevel

Returns/sets the fog filter settings.

Responses

Response samples

200

Content type

application/json

0

0

Post/MCSenseLevel

Returns/sets the fog filter settings.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"MCSenseLevel": 0
}
}

Get/LFPparticle

Returns/sets the particle filter settings. Filters out disturbances in the measurement data caused by particles such as dust, snowflakes, or similar. Configure the minimal threshold of the required distance step (mm) between the echo to be filtered and the echoes of surrounding beam angles.

Responses

Response samples

200

Content type

application/json

{"bEnable": false,
"uiThreshold": 500
}

Post/LFPparticle

Returns/sets the particle filter settings. Filters out disturbances in the measurement data caused by particles such as dust, snowflakes, or similar. Configure the minimal threshold of the required distance step (mm) between the echo to be filtered and the echoes of surrounding beam angles.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"LFPparticle": {"bEnable": false,
"uiThreshold": 500
}
}
}

Get/LFPmovingAveragingFilter

Returns/sets the mean filter settings. This filter smooths the distance value by calculating the arithmetic mean from the configured number of scans (2..4 scans). Points with zero distance are treated as missing values and are not taken into account for averaging. If all distances considered for averaging have the value 0, the result will be 0 as well.

Responses

Response samples

200

Content type

application/json

{"bEnable": false,
"uiAveragingDepth": 3
}

Post/LFPmovingAveragingFilter

Returns/sets the mean filter settings. This filter smooths the distance value by calculating the arithmetic mean from the configured number of scans (2..4 scans). Points with zero distance are treated as missing values and are not taken into account for averaging. If all distances considered for averaging have the value 0, the result will be 0 as well.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"LFPmovingAveragingFilter": {"bEnable": false,
"uiAveragingDepth": 3
}
}
}

Get/FREchoFilter

Returns/sets the multi-echo filter settings. Depending on the environment the sensor receives several measurement points on the same angular step (multi-echo). The filter can out the first echo, the last echo or all echos.

Responses

Response samples

200

Content type

application/json

0

0

Post/FREchoFilter

Returns/sets the multi-echo filter settings. Depending on the environment the sensor receives several measurement points on the same angular step (multi-echo). The filter can out the first echo, the last echo or all echos.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"FREchoFilter": 0
}
}

7 - Contamination indication

Get/ContaminationConfig

Returns/sets of the contamination indication settings such as sensitivity, response time, threshold for warning, and active sectors.

Responses

Response samples

200

Content type

application/json

{"eStrategy": 0,
"usiResponseTime": 3,
"eThreshold": 0,
"eCover": 0,
"CustomSectors": [ ],
"bEnableWarning": true,
"bEnableError": true
}

Post/ContaminationConfig

Returns/sets of the contamination indication settings such as sensitivity, response time, threshold for warning, and active sectors.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"ContaminationConfig": {"eStrategy": 0,
"usiResponseTime": 3,
"eThreshold": 0,
"eCover": 0,
"CustomSectors": [ ],
"bEnableWarning": true,
"bEnableError": true
}
}
}

Get/ContaminationData

Returns the contamination state of all contamination sectors.

Responses

Response samples

200

Content type

application/json

[ ]

Get/ContaminationResult

Returns the contamination indication state of the device.

Responses

Response samples

200

Content type

application/json

{"bWarningActive": false,
"bErrorActive": false
}

8 - Ethernet

Get/EtherIPAddress

Returns/sets used static IP address.

Responses

Response samples

200

Content type

application/json

[192,
168,
0,
1
]

Post/EtherIPAddress

Returns/sets used static IP address.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EtherIPAddress": [192,
168,
0,
1
]
}
}

Get/EtherIPGateAddress

Returns/sets default gateway address.

Responses

Response samples

200

Content type

application/json

[0,
0,
0,
0
]

Post/EtherIPGateAddress

Returns/sets default gateway address.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EtherIPGateAddress": [0,
0,
0,
0
]
}
}

Get/EtherIPMask

Returns/sets the subnet mask.

Responses

Response samples

200

Content type

application/json

[255,
255,
255,
0
]

Post/EtherIPMask

Returns/sets the subnet mask.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EtherIPMask": [255,
255,
255,
0
]
}
}

Get/EtherAddressingMode

Returns/sets the mode for the IP address assignment (static or DHCP).

Responses

Response samples

200

Content type

application/json

0

0

Post/EtherAddressingMode

Returns/sets the mode for the IP address assignment (static or DHCP).

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EtherAddressingMode": 0
}
}

Get/EtherDHCPFallback

Returns/sets the mode for the DHCP fallback (retry or static)

Responses

Response samples

200

Content type

application/json

0

0

Post/EtherDHCPFallback

Returns/sets the mode for the DHCP fallback (retry or static)

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EtherDHCPFallback": 0
}
}

Post/EthernetUpdate

Applies the ethernet settings. This needs to be executed to actually change the ethernet settings.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Get/EtherIPAddressDHCP

Returns the assigned DHCP IP address.

Responses

Response samples

200

Content type

application/json

[192,
168,
0,
1
]

Get/EtherIPGateAddressDHCP

Returns the assigned DHCP default gateway address.

Responses

Response samples

200

Content type

application/json

[0,
0,
0,
0
]

Get/EtherIPMaskDHCP

Returns the assigned DHCP subnet mask.

Responses

Response samples

200

Content type

application/json

[255,
255,
255,
0
]

Get/EtherMACAddress

Returns the MAC address of the ethernet interface.

Responses

Response samples

200

Content type

application/json

[0,
6,
119,
0,
0,
0
]

9 - Legacy protocols

Get/EtherAuxEnabled

Enables/disables the legacy interface CoLa A/B. If enabled CoLa A uses port 2111 and CoLa B uses 2112.

Responses

Response samples

200

Content type

application/json

true

Post/EtherAuxEnabled

Enables/disables the legacy interface CoLa A/B. If enabled CoLa A uses port 2111 and CoLa B uses 2112.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EtherAuxEnabled": true
}
}

Get/EtherCoLaScanMode

Configures the device search by SICK tools. If disabled, finding the device via device search and changing the IP address via SICK tools is not possible.

Responses

Response samples

200

Content type

application/json

0

0

Post/EtherCoLaScanMode

Configures the device search by SICK tools. If disabled, finding the device via device search and changing the IP address via SICK tools is not possible.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EtherCoLaScanMode": 0
}
}

10 - Webserver settings

Post/SetWebserverEnabled

Sets availability of the webserver (reboot required). If disabled, the webserver-based GUI and the REST interface can not be used anymore.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"Enable": true
}
}

Post/GetWebserverEnabled

Returns the availability of the web server.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"IsEnabled": true
}

11 - Inputs and outputs

Get/InputState

Returns the state of all inputs.

Responses

Response samples

200

Content type

application/json

{"uiVersionNumber": 1,
"udiSystCount": 0,
"aDigitalIn": [{"IOState": {"eIOState": 0
}
},
{"IOState": {"eIOState": 0
}
},
{"IOState": {"eIOState": 0
}
},
{"IOState": {"eIOState": 0
}
},
{"IOState": {"eIOState": 0
}
},
{"IOState": {"eIOState": 0
}
},
{"IOState": {"eIOState": 0
}
},
{"IOState": {"eIOState": 0
}
}
],
"aTimeBlock": [ ]
}

Get/OutputState

Returns the state of all outputs.

Responses

Response samples

200

Content type

application/json

{"uiVersionNumber": 1,
"udiSystCount": 0,
"aDigitalOut": [{"IOState": {"eIOState": 0
},
"udiCounter": 0
},
{"IOState": {"eIOState": 0
},
"udiCounter": 0
},
{"IOState": {"eIOState": 0
},
"udiCounter": 0
},
{"IOState": {"eIOState": 0
},
"udiCounter": 0
},
{"IOState": {"eIOState": 0
},
"udiCounter": 0
},
{"IOState": {"eIOState": 0
},
"udiCounter": 0
},
{"IOState": {"eIOState": 0
},
"udiCounter": 0
},
{"IOState": {"eIOState": 0
},
"udiCounter": 0
}
],
"aTimeBlock": [ ]
}

Get/PortState

Returns the state of the ports. "PortState" is preferred over "OutputState".

Responses

Response samples

200

Content type

application/json

{"uiVersionNumber": 0,
"udiSystCount": 0,
"aInternalPorts": [ ],
"aExternalPorts": [ ],
"aTimeBlock": [ ]
}

Post/mResetOutputCounter

Resets the counter for the outputs.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"ErrorCode": 0
}

Get/PortConfiguration

Returns/sets the port configuration of all I/Os.

Responses

Response samples

200

Content type

application/json

[{"PortType": 0,
"Name": "IOx",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 0,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 0,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 0,
"Name": "IOx",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 0,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 0,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 0,
"Name": "IOx",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 0,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 0,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 0,
"Name": "IOx",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 0,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 0,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 0,
"Name": "IOx",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 0,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 0,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 0,
"Name": "IOx",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 0,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 0,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 0,
"Name": "IOx",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 0,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 0,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 0,
"Name": "IOx",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 0,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 0,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
}
]

Post/PortConfiguration

Returns/sets the port configuration of all I/Os.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"PortConfiguration": [{"PortType": 0,
"Name": "InOut1",
"InputSettings": {"Logic": 0,
"Debounce": 1,
"Sensitivity": 1,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 1,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 1,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 1,
"Name": "InOut2",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 1,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 1,
"OutputMode": 2,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 1,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [{"Name": "DRDY",
"Invert": false,
"Reserved5": 0,
"Reserved6": 0
}
]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 1,
"Name": "InOut3",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 1,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 1,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [{"Name": "FE01",
"Invert": false,
"Reserved5": 0,
"Reserved6": 0
}
]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 0,
"Name": "InOut4",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 1,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 1,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 0,
"Name": "InOut5",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 1,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 1,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 0,
"Name": "InOut6",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 1,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 0,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 1,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [ ]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 1,
"Name": "InOut7",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 1,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 1,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 1,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [{"Name": "DRDY",
"Invert": false,
"Reserved5": 0,
"Reserved6": 0
}
]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
},
{"PortType": 1,
"Name": "InOut8",
"InputSettings": {"Logic": 0,
"Debounce": 10,
"Sensitivity": 1,
"Reserved1": 0,
"Reserved2": 0
},
"OutputSettings": {"Logic": 1,
"OutputMode": 0,
"RestartType": 0,
"RestartTime": 200,
"RestartInput": 1,
"Combination": 1,
"Reserved3": 0,
"Reserved4": 0,
"Sources": [{"Name": "DRDY",
"Invert": false,
"Reserved5": 0,
"Reserved6": 0
}
]
},
"Reserved7": 0,
"Reserved8": 0,
"Reserved9": 0,
"Reserved10": 0
}
]
}
}

Post/SetOutput

Sets the output state for an individual output. Precondition ist to set the output source to "SOPAS command".

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"Output": 0,
"Value": 0
}
}

Response samples

200

Content type

application/json

{"Success": false
}

12 - Measurement data output

Get/ScanDataEthSettings

Returns/sets the destination IP address settings for measurement data streaming (UDP).

Responses

Response samples

200

Content type

application/json

{"Protocol": 1,
"IPAddress": [192,
168,
0,
100
],
"Port": 2115
}

Post/ScanDataEthSettings

Returns/sets the destination IP address settings for measurement data streaming (UDP).

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"ScanDataEthSettings": {"Protocol": 1,
"IPAddress": [192,
168,
0,
100
],
"Port": 2115
}
}
}

Get/ScanDataEnable

Enables/disables the measurement data streaming. The measurement data itself is sent via a UDP-based SICK-specific format. A Python example can be found at https://github.com/SICKAG/ScanSegmentAPI.

Responses

Response samples

200

Content type

application/json

false

Post/ScanDataEnable

Enables/disables the measurement data streaming. The measurement data itself is sent via a UDP-based SICK-specific format. A Python example can be found at https://github.com/SICKAG/ScanSegmentAPI.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"ScanDataEnable": false
}
}

Get/ScanDataFormat

Returns/sets the scan data format (e.g. Compact format).

Responses

Response samples

200

Content type

application/json

1

Post/ScanDataFormat

Returns/sets the scan data format (e.g. Compact format).

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"ScanDataFormat": 1
}
}

13 - IMU data output

Get/ImuDataEthSettings

Returns/sets the destination IP address settings for IMU data streaming (UDP).

Responses

Response samples

200

Content type

application/json

{"Protocol": 1,
"IPAddress": [192,
168,
0,
100
],
"Port": 7503
}

Post/ImuDataEthSettings

Returns/sets the destination IP address settings for IMU data streaming (UDP).

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"ImuDataEthSettings": {"Protocol": 1,
"IPAddress": [192,
168,
0,
100
],
"Port": 7503
}
}
}

Get/ImuDataEnable

Enables/Disables IMU data streaming.

Responses

Response samples

200

Content type

application/json

false

Post/ImuDataEnable

Enables/Disables IMU data streaming.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"ImuDataEnable": false
}
}

Get/InertialMeasurementUnit

Returns the current IMU data (e.g. Acceleration, Orientation, ... ). The data is given in the following coordinate system which is based on the DIN70000 system. The x-axis lies on the 90-degree-beam of the 0-degree-layer. The y-axis is perpendicular to the x-axis and lies in the 0-degree-layer. The y-values are rising in the counterclockwise rotation direction (right-handed system). The z-axis is perpendicular to the x-y-plane and the scanner top points to rising z-values.

Responses

Response samples

200

Content type

application/json

{"Acceleration": [ ],
"AngularVelocity": [ ],
"Orientation": [ ],
"TimeStamp": 0
}

14 - Data reduction

Get/LFPangleRangeFilter

Returns/sets the angle range filter settings. The filter restricts the output scan to a specified angle range. Filtered measurement values are set to 0. If the content of a complete data segment is set to 0 this segment is not output anymore.

Responses

Response samples

200

Content type

application/json

{"bEnable": false,
"fThetaStart": -900000,
"fThetaStop": 900000,
"fPhiStart": -900000,
"fPhiStop": 900000,
"uiBeamIncrement": 1
}

Post/LFPangleRangeFilter

Returns/sets the angle range filter settings. The filter restricts the output scan to a specified angle range. Filtered measurement values are set to 0. If the content of a complete data segment is set to 0 this segment is not output anymore.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"LFPangleRangeFilter": {"bEnable": false,
"fThetaStart": -900000,
"fThetaStop": 900000,
"fPhiStart": -900000,
"fPhiStop": 900000,
"uiBeamIncrement": 1
}
}
}

Get/LFPintervalFilter

Returns/sets the interval filter settings. The filter reduces the scan output rate by a given factor.

Responses

Response samples

200

Content type

application/json

{"bEnable": false,
"uiReductionFactor": 2
}

Post/LFPintervalFilter

Returns/sets the interval filter settings. The filter reduces the scan output rate by a given factor.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"LFPintervalFilter": {"bEnable": false,
"uiReductionFactor": 2
}
}
}

15 - Region of interest

Get/LFPradialDistanceRangeFilter

Returns/sets the scanning range filter settings. Restriction of the distance measurements to a specified distance range. Measurement distances outside of the specified distance are assigned the distance and RSSI value 0.

Responses

Response samples

200

Content type

application/json

{"bEnable": false,
"ulDistMin": 0,
"ulDistMax": 200000
}

Post/LFPradialDistanceRangeFilter

Returns/sets the scanning range filter settings. Restriction of the distance measurements to a specified distance range. Measurement distances outside of the specified distance are assigned the distance and RSSI value 0.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"LFPradialDistanceRangeFilter": {"bEnable": false,
"ulDistMin": 0,
"ulDistMax": 200000
}
}
}

Get/LFPcubicareafilter

Returns/sets the cuboid area filter settings. The cuboid area filter limits the measurement data box defined by its extension in the x- and y-axis.

Responses

Response samples

200

Content type

application/json

{"bEnable": false,
"lXMin": 0,
"lXMax": 5000,
"lYMin": -5000,
"lYMax": 5000,
"lZMin": -20000,
"lZMax": 20000
}

Post/LFPcubicareafilter

Returns/sets the cuboid area filter settings. The cuboid area filter limits the measurement data box defined by its extension in the x- and y-axis.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"LFPcubicareafilter": {"bEnable": false,
"lXMin": 0,
"lXMax": 5000,
"lYMin": -5000,
"lYMax": 5000,
"lZMin": -20000,
"lZMax": 20000
}
}
}

16 - Field evaluation

Get/FieldEvaluationResult

Returns the state of all possible fields.

Responses

Response samples

200

Content type

application/json

{"Version": 1,
"Timestamp": 0,
"EvaluationResultList": [ ]
}

Post/ActivateEvaluationGroup

Sets the activation condition for all existing evaluation groups (not configured, active, or inactive).

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"List": [{"GroupId": 1,
"Activate": true
},
{"GroupId": 2,
"Activate": false
},
{"GroupId": 3,
"Activate": true
}
]
}
}

Response samples

200

Content type

application/json

{"Success": [ ]
}

Post/SetFieldEvaluationContour

Sets the contour of an existing field.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EvaluationId": 1,
"LowerZLimit": 0,
"UpperZLimit": 0,
"Points": [{"x": 0,
"y": -1000
},
{"x": 1000,
"y": -1000
},
{"x": 1000,
"y": 1000
},
{"x": 0,
"y": 1000
}
]
}
}

Response samples

200

Content type

application/json

{"ErrorCode": 0
}

Post/GetFieldEvaluationContour

Returns the contour of an existing field.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EvaluationId": 0
}
}

Response samples

200

Content type

application/json

{"Contour": [ ]
}

Get/FieldEvaluationGroupState

Returns the activation condition for all existing evaluation groups (not configured, active, or inactive).

Responses

Response samples

200

Content type

application/json

[0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
]

Post/StartTeachIn

Starts the teach in process.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Post/StopTeachIn

Stops the teach in process.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Get/perpendicularDistanceResult

Returns the perpendicular distance within a field.

Responses

Response samples

200

Content type

application/json

{"timestamp": 0,
"evaluations": [ ]
}

17 - Operating data

Get/LastParaDate

Returns the last date (e.g. 12.11.2024) when a permanent parameter save was executed.

Responses

Response samples

200

Content type

application/json

"DD.MM.YYYY"

Get/LastParaTime

Returns the last time (e.g. 13:24) when a permanent parameter save was executed.

Responses

Response samples

200

Content type

application/json

"HH:MM"

Get/PowerOnCnt

Returns the number of power on cycles.

Responses

Response samples

200

Content type

application/json

0

0

Get/DailyOpHours

Returns the runtime duration since the last power on (non-persistent).

Responses

Response samples

200

Content type

application/json

0

0

Get/OpHours

Returns the total number of operating hours during the lifetime of the device. The resolution is a 1/10 hour.

Responses

Response samples

200

Content type

application/json

0

0

Get/CurrentTempDev

Returns the current device temperature.

Responses

Response samples

200

Content type

application/json

20

18 - Diagnostic file

Get/crown/file

Downloads the diagnostic file (zip file) if one exists.

query Parameters

filePath

required

string

Example: filePath=diagnosisDump.zip

path

Responses

Post/DoDiagnosisDump

Creates a diagnostic file (zip file) for further analysis.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"DoRunlevelLoop": true,
"Output": "file"
}
}

Response samples

200

Content type

application/json

{"Successfull": false
}

Post/GetDiagnosisDumpInfo

Returns additional meta-information about the diagnostic file.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"DiagDumpExists": false,
"DiagDumpTimestamp": 0
}

19 - Firmware update

Put/update

Transfers a firmware file (.spk) from the file location to the device. The maximum possible file size is 100 MB.

Request Body schema: application/octet-stream

object

Responses

Post/RunFirmwareUpdate

Starts the firmware update process. This function requires the user level: Service.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Get/UpdateState

Returns the state of the update process.

Responses

Response samples

200

Content type

application/json

0

0

20 - Detection History

Post/EnableDetectionHistory

Returns/sets the detection history.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EnableDetectionHistory": true
}
}

Get/EvaluationsToLog

Returns/sets the evaluations which are logged (if they are in use).

Responses

Response samples

200

Content type

application/json

[true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true
]

Post/EvaluationsToLog

Returns/sets the evaluations which are logged (if they are in use).

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"EvaluationsToLog": [true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true,
true
]
}
}

Post/ResetDetectionHistory

Resets the detection history logs.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

21 - Cybersecurity

Get/httpsStatus

Returns the status of the HTTPS interface.

Responses

Response samples

200

Content type

application/json

{"enabled": false,
"errorCode": {"error": " "
}
}

Get/certificateBundleInfo

Returns information about the uploaded certificate bundle.

Responses

Response samples

200

Content type

application/json

{"uuidBundle": " ",
"certificates": [ ],
"errorCode": {"error": " "
}
}

Post/removeCertificateBundle

Removes the uploaded certificate bundle.

Request Body schema: application/json
required

successful operation

object or null

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"success": false,
"errorCode": {"error": " "
}
}

Post/setCertificateBundle

Uploads a certificate bundle in the PEM format via JSON.

Request Body schema: application/json
required

successful operation

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"contentCertificateBundle": " ",
"contentPrivateKey": " "
}
}

Response samples

200

Content type

application/json

{"success": false,
"errorCode": {"error": " "
}
}

picoScan150 REST interface description (2.1.0)

1 - General

Post/checkCredentials

Request Body schema: application/jsonrequired

Responses

Request samples

Post/SetPassword

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Post/getChallenge

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Post/changePassword

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Post/EnableUserLevel

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Post/WriteEeprom

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Post/SoftReset

Request Body schema: application/jsonrequired

Responses

Request samples

Post/RebootDevice

Request Body schema: application/jsonrequired

Responses

Request samples

Post/LoadFactoryDefaults

Request Body schema: application/jsonrequired

Responses

Request samples

Post/EnableLegacyUserLevel

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Post/LoadApplicationDefaults

Request Body schema: application/jsonrequired

Responses

Request samples

2 - Status

Get/DeviceStatus

Responses

Response samples

Get/SCdevicestate

Responses

Response samples

3 - Device

Get/DeviceIdent

Responses

Response samples

Get/LocationName

Responses

Response samples

Post/LocationName

Request Body schema: application/jsonrequired

Responses

Request samples

Get/SerialNumber

Responses

Response samples

Get/FirmwareVersion

Responses

Response samples

Get/OrderNumber

Responses

Response samples

Get/DeviceType

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required