IDS NXT Manual
  1. Manuals
  2. Brands
  3. IDS Manuals
  4. Recording Equipment
  5. NXT
  6. Manual

IDS NXT Manual

Rest interface
Hide thumbs Also See for NXT:
Table of Contents

Advertisement

Quick Links

Download this manual
IDS NXT
REST interface
for IDS NXT SDK 2.1.0 / IDS NXT OS 1.1.0
IDS Imaging Development Systems GmbH
Dimbacher Str. 6-8
D-74182 Obersulm, Germany
T: +49 7134 96196-0
E: info@ids-imaging.com
W: http://www.ids-nxt.com

Advertisement

Table of Contents
loading

Related Manuals for IDS NXT

Summary of Contents for IDS NXT

  • Page 1 IDS NXT REST interface for IDS NXT SDK 2.1.0 / IDS NXT OS 1.1.0 IDS Imaging Development Systems GmbH Dimbacher Str. 6-8 D-74182 Obersulm, Germany T: +49 7134 96196-0 E: info@ids-imaging.com W: http://www.ids-nxt.com...

  • Page 2: Table Of Contents

    IDS NXT: REST interface Contents 1 Preface .............................. 5 2 Symbols and hints ..........................6 3 Introduction ............................7 3.1 Version hint ..........................7 3.2 User authentication ........................7 3.3 Units ............................7 3.4 Types ............................7 3.5 Implemented services ........................8 4 User control ............................
  • Page 3 IDS NXT: REST interface 9 Light ..............................31 9.1 /light ............................31 9.2 /light/external ..........................31 9.3 Flash modes (external light) ......................32 10 Network settings ........................... 34 10.1 /network ..........................34 10.2 /network/ipv4 ........................... 35 10.3 /network/nameservers ....................... 36 10.4 /network/timeserver ........................
  • Page 4 IDS NXT: REST interface 17.3 Configurables .......................... 57 17.4 Files ............................58 17.4.1 /vapps/<vapp>/files ....................... 58 17.4.2 /vapps/<vapp>/files/<file> ....................59 17.4.3 /vapps/<vapp>/files/<file>/data ..................60 17.5 Images ............................ 60 17.5.1 /vapps/<vapp>/images ....................60 17.5.2 /vapps/<vapp>/images/<image> ..................60 17.6 License ........................... 61 17.7 Log ............................

  • Page 5: Preface

    Please contact your local IDS distributors for first level support in your language. For a list of IDS distributors worldwide please go to our website http://www.ids-nxt.com.

  • Page 6: Symbols And Hints

    IDS NXT: REST interface 2 Symbols and hints This symbol indicates hints with useful information for better understanding and using features and functions. This symbol indicates important warnings for product safety to prevent damage. March 2021...

  • Page 7: Introduction

    Set important device parameters and update The default password for each user class is "ids". When you log in for the first time, you must change the password to be able to log in. If you log in with the administrator profile, you can change the passwords for the user classes "Service"...

  • Page 8: Implemented Services

    IDS NXT: REST interface Type Qt/C++ equivalent Integer qint64 Boolean bool Double double 3.5 Implemented services Variable paths are specified in angle brackets (e.g. <appname>) and match [a-zA-Z]+[_a-zA-Z0-9-]* The (partially exemplary) response to an OPTIONS request is shown here. GET, DELETE etc. relate to the possible HTTP methods for the specified address. The JSON objects in the level below specify the permitted or available MIME types.

  • Page 9: User Control

    IDS NXT: REST interface 4 User control Creating and deleting users, and changing group association is currently deactivated on the device side. · /users · /users/<existing-username> 4.1 /users · OPTIONS · "GET": { "application/json": { "Allowed": true, "Description": "Receive user list", "Values": {...
  • Page 10 IDS NXT: REST interface "Objects": [ "admin", "writeparam", "readparam", "modvapp" "PATCH": { "application/x-www-form-urlencoded": { "Allowed": true, "Description": "Modifies the user", "Values": { "Password": { "Description": "New password", "Type": "String" Comments Objects are group names and have no REST answers. March 2021...

  • Page 11: Device Events

    IDS NXT: REST interface 5 Device events · /events · Server sent events · Event syntax · Restrictions 5.1 /events · Events can be transferred using the device event resource "/events". The client makes a one-off GET request for /events and then receives the events in the body of the response. Chunked transfer encoding is used to enable the events to be sent regardless of the time of the GET request.

  • Page 12: Server Sent Events

    IDS NXT: REST interface 5.2 Server sent events In addition to the proprietary interface (deprecated), the events can also be requested using SSE. To do this, the request must include an HTTP header (Accept: text/eventstream) and the events (see Event syntax) are then transferred in the data block.

  • Page 13: Device Information

    IDS NXT: REST interface 6 Device information · /deviceinfo · /deviceinfo/avatar · /deviceinfo/datetime 6.1 /deviceinfo · OPTIONS · · PATCH "GET": { "application/json": { "Description": "Receive device information", "Values": { "CPULoad": { "Description": "Total CPU load", "Range": { "Maximum": 100, "Minimum": 0...
  • Page 14 IDS NXT: REST interface "Minimum": 75 "Type": "Double", "Unit": "Per cent" "FPS": { "Description": "Frames per seconds, average.", "Type": "Double", "Unit": "fps" "Language": { "Description": "Default language", "Range": [ "en" "Type": "String" "Location": { "Description": "Given location of the device", "Type": "String"...
  • Page 15 IDS NXT: REST interface "RangeWarning0": { "Maximum": 0, "Minimum": -5 "RangeWarning1": { "Maximum": 91, "Minimum": 78 "Type": "Double", "Unit": "Degrees Celsius" "UniqueID": { "Description": "Unique-ID, used for device identification", "Type": "String" "Uptime": { "Description": "Uptime in seconds", "Type": "Integer" "VSupply": { "Description": "Supply voltage",...

  • Page 16: Deviceinfo/Avatar

    IDS NXT: REST interface "Values": { "DateTime": { "Description": "Server time", "Type": "String" "DeviceName": { "Description": "Given name of the device", "Type": "String" "Language": { "Description": "Default language", "Range": [ "en" "Type": "String" "Location": { "Description": "Given location of the device", "Type": "String"...

  • Page 17: Deviceinfo/Datetime

    IDS NXT: REST interface Options [ "PUT": { "image/png, image/jpeg, image/gif, image/bmp": { "Description": "Upload a new avatar, implicitly deleting the old one. Image must be 256x256px." 6.3 /deviceinfo/datetime · OPTIONS · · PATCH "GET": { "application/json": { "Description": "Receive device datetime information", "Values": {...
  • Page 18 IDS NXT: REST interface "Values": { "DateTime": { "Description": "Server time", "Type": "String" "NTP": { "Description": "True if NTP is enabled.", "Type": "Boolean" "NTPServer": { "Description": " Must be of format 'xxx.xxx.xxx.xxx'.", "Type": "String" "Timezone": { "Description": "Current used timezone", "Range": [...

  • Page 19: Gpio

    IDS NXT: REST interface 7 GPIO · /gpio · /gpio/inputs · /gpio/inputs/<pin> · /gpio/outputs · /gpio/outputs/<pin> 7.1 /gpio · OPTIONS "Objects": [ "inputs", "outputs" 7.2 /gpio/inputs · OPTIONS "Objects": [ "in1", "in2" Comments Objects are available pins, thus currently in1 or in2 7.3 /gpio/inputs/<pin>...

  • Page 20: Gpio/Outputs

    IDS NXT: REST interface "Title": { "Description": "Pin title", "Type": "String" Options [ "PATCH": { "application/x-www-form-urlencoded": { "Description": "Update the GPIO settings.", "Values": { "Inverter": { "Description": "Enabled additional inverter. If true, 0V input means on-level", "Type": "Boolean" Comments Only difference to /gpio/outputs/<pin>: Level cannot be set using PATCH.
  • Page 21 IDS NXT: REST interface "Level": { "Description": "Logic-Level, note that true hardware level depends on Invert", "Type": "Boolean" "Title": { "Description": "Pin title", "Type": "String" Objects [ "PATCH": { "application/x-www-form-urlencoded": { "Description": "Update the GPIO settings.", "Values": { "Inverter": { "Description": "Enabled additional inverter.

  • Page 22: Camera Settings

    IDS NXT: REST interface 8 Camera settings · /camera · /camera/trigger · /camera/image · /camera/roi · /camera/color 8.1 /camera · OPTIONS · · PATCH "GET": { "application/json": { "Description": "Receive camera settings", "Values": { "ExposureTime": { "Description": "Exposure time", "Range": { "Maximum": 2000018,...
  • Page 23 IDS NXT: REST interface "GainAuto": { "Range": [ "Off", "Once", "Continuous" "Type": "String" "Objects": [ "color", "image", "roi", "trigger" "PATCH": { "application/x-www-form-urlencoded": { "Allowed": true, "Description": "Modify camera settings", "Values": { "ExposureTime": { "Description": "Exposure time", "Range": { "Maximum": 2000018, "Minimum": 35...

  • Page 24: Camera/Trigger

    IDS NXT: REST interface "Range": [ "Off", "Once", "Continuous" "Type": "String" 8.2 /camera/trigger · OPTIONS · · PATCH · POST "GET": { "application/json": { "Description": "Receive trigger settings.", "Values": { "Debounce": { "Description": "Trigger debouncing", "Range": { "Maximum": 20000, "Minimum": 0 "Type": "Integer",...
  • Page 25 IDS NXT: REST interface "Minimum": 0 "Type": "Integer", "Unit": "milliseconds" "Prescaler": { "Description": "Prescaler", "Range": { "Maximum": 64, "Minimum": 1 "Type": "Integer" "Timeout": { "Description": "Trigger timeout in microseconds", "Range": { "Maximum": 16777215, "Minimum": 0 "Type": "Integer", "Unit": "microseconds" "TriggerType": { "Description": "Trigger type",...
  • Page 26 IDS NXT: REST interface "Edge": { "Description": "Trigger edge type", "Range": [ "Falling", "Rising", "Both" "Type": "String" "NoTriggerThreshold": { "Description": "Maximum time between to received images before warning.", "Range": { "Maximum": 86400000, "Minimum": 0 "Type": "Integer", "Unit": "milliseconds" "Prescaler": { "Description": "Prescaler",...

  • Page 27: Camera/Image

    IDS NXT: REST interface 8.3 /camera/image · OPTIONS · "GET": { "image/jpeg": { "Description": "Receive the latest acquired image. Returns 503 if no image acquired so far." "image/png,image/bmp": { "Description": "Receive the latest acquired image. Returns 503 if no image acquired so far.",...

  • Page 28: Camera/Color

    IDS NXT: REST interface "Range": { "Maximum": 1088, "Minimum": 32, "Step": 8 "Type": "Integer", "Unit": "pixel" "OffsetX": { "Description": "X-coordinate of upper left corner of the ROI", "Range": { "Maximum": 1456, "Minimum": 0, "Step": 8 "Type": "Integer", "Unit": "pixel" "OffsetY": { "Description": "Y-coordinate of upper left corner of the ROI",...
  • Page 29 IDS NXT: REST interface "Description": "Blue Gain", "Range": { "Maximum": 100, "Minimum": 0 "Type": "Integer", "Unit": "per cent" "GreenGain": { "Description": "Green Gain", "Range": { "Maximum": 100, "Minimum": 0 "Type": "Integer", "Unit": "per cent" "RedGain": { "Description": "Red Gain", "Range": { "Maximum": 100,...
  • Page 30 IDS NXT: REST interface "Type": "Integer", "Unit": "per cent" "RedGain": { "Description": "Red Gain", "Range": { "Maximum": 100, "Minimum": 0 "Type": "Integer", "Unit": "per cent" "WhiteBalance": { "Range": [ "Off", "Once", "Continuous" "Type": "String" March 2021...

  • Page 31: Light

    IDS NXT: REST interface 9 Light · /light · /light/external · Flash modes (external light) 9.1 /light · OPTIONS "Objects": [ "external" 9.2 /light/external · OPTIONS · · PATCH "GET": { "application/json": { "Description": "Receive the internal flash settings.", "Values": { "AutoDuration": {...

  • Page 32: Flash Modes (External Light)

    IDS NXT: REST interface Objects [ "PATCH": { "application/x-www-form-urlencoded": { "Description": "Update the internal flash settings.", "Values": { "AutoDuration": { "Description": Automatic flash duration configuration based on exposure time and sensor", "Type": "Boolean" "Delay": { "Description": "Flash delay in microseconds", "Range": {...
  • Page 33 IDS NXT: REST interface · If necessary, set a delay · Inverted = true Automatic flash (depending on model) · AutoDuration = Activates (true) or deactivates (false) the automatic control of the flash output. If "AutoDuration" is activated, the manual value under "Duration" has no effect.

  • Page 34: Network Settings

    IDS NXT: REST interface 10 Network settings · /network · /network/ipv4 · /network/nameservers · /network/timeserver · /network/ssl 10.1 /network · OPTIONS · · PATCH You need administrator privileges ( ) to set the RestrictHTTP node. "GET": { "application/json": { "Description": "Receive general network settings", "Values": {...

  • Page 35: Network/Ipv4

    IDS NXT: REST interface 10.2 /network/ipv4 · OPTIONS · · PATCH "GET": { "application/json": { "Description": "Receive network IPv4 settings", "Values": { "Address": { "Description": "Local IP-Address, valid for non-DHCP method only. Must be of format \"xxx.xxx.xxx.xxx\"", "Type": "String" "DHCP": { "Description": "If true, DHCP is used to obtain an IP address",...

  • Page 36: Network/Nameservers

    IDS NXT: REST interface NOTICE! Unlike the IDS NXT cockpit, the PATCH command via the REST interface does not check if the IP address is within the permitted range. Therefore, you can also set an invalid IP address, which means that you cannot communicate with the camera any more. Do not set an invalid IP address, e.g.

  • Page 37: Network/Timeserver

    IDS NXT: REST interface 10.4 /network/timeserver · OPTIONS · · PATCH · DELETE "GET": { "application/json": { "Description": "Receive current time server", "Values": { "Timeserver": { "Description": "Current time server. Must be of format 'xxx.xxx.xxx.xxx'", "Type": "String" "PATCH": { "application/x-www-form-urlencoded": { "Description": "Set time server",...
  • Page 38 IDS NXT: REST interface "GET": { "application/json": { "Description": "Get custom SSL Information", "Values": { "Exists": { "Description": "If true, custom SSL files are available.", "Type": "Boolean" "Issuer": { "Description": "Issuer of the SSL files.", "Type": "String" "Objects": [ "PUT": { "application/NXT_SSL": {...

  • Page 39: Rs-232

    IDS NXT: REST interface 11 RS-232 · /rs232 · /rs232/data 11.1 /rs232 · OPTIONS · · PATCH "GET": { "application/json": { "Description": "Receive RS-232 settings", "Values": { "Baudrate": { "Description": "Baudrate in baud", "Range": [ 300, 1200, 2400, 4800, 9600,...

  • Page 40: Rs232/Data

    IDS NXT: REST interface "PATCH": { "application/x-www-form-urlencoded": { "Description": "Modify RS-232 settings", "Values": { "Baudrate": { "Description": "Baudrate in baud", "Range": [ 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400 "Type": "Integer", "Unit": "baud" "Parity": { "Description": "Parity setting", "Range": [...
  • Page 41 IDS NXT: REST interface Objects [ "PUT": { "application/octet-stream": { "Description": "Send data via RS232" March 2021...

  • Page 42: Signals

    IDS NXT: REST interface 12 Signals · /signals · /signals/list · /signals/list/<id> 12.1 /signals · OPTIONS · PATCH "Objects": [ "list" 12.2 /signals/list · OPTIONS · · DELETE "DELETE": { "<none>": { "Description": "Clears the list of signals." "GET": { "text/csv": {...

  • Page 43: Signals/List/

    IDS NXT: REST interface "Mandatory": false, "Type": "String", "Unit": "RFC2822" "Objects": [ "identifier1", "identifier2", "…" Note: Filtering by sender and severity is currently not possible. Comments · Objects are available signals (<id>). · Source can be either "system" or a VisionApp (e.g. "autoset").
  • Page 44 IDS NXT: REST interface "Timestamp": { "Description": "Time of signal creation", "Type": "Timestamp", "Unit": "RFC2822" "image/png,image/bmp,image/jpeg": { "Description": "Return event's image, not always possible (may return 404)", "Parameters": { "MaxHeight": { "Description": "Maximal height of image.", "Mandatory": false, "Type": "Integer"...

  • Page 45: Statistics

    IDS NXT: REST interface 13 Statistics · /statistics · /statistics/change 13.1 /statistics · OPTIONS · · DELETE "DELETE": { "<none>": { "Description": "Reset statistic data." "GET": { "application/json": { "Description": "Read statistic data", "Values": { "ImageFree": { "Brief": "Numbers of free image buffers", "Description": "Numbers of free image buffers",...

  • Page 46: Statistics/Change

    IDS NXT: REST interface "Type": "Integer" "Objects":[ "change" Note: The ID and number of counters can vary and is dynamic. The ID "LastReset" is not a counter ID; it specifies the time of the last counter reset. There are some predefined identifiers that can be used for calculations etc. (if they are present) in the client.
  • Page 47 IDS NXT: REST interface "ImageTotal": { "Brief": "Number of captured images", "Description": "Number of captured images", "Title": "Total images", "Type": "Double" "VisionFailed": { "Brief": "Number of unsuccessfully processed images", "Description": "Number of unsuccessfully processed images", "Title": "Image processing failed", "Type": "Double"...

  • Page 48: Support File

    IDS NXT: REST interface 14 Support file /support · OPTIONS · "GET": { "application/x-compressed-tar": { "Description": "Get this file!" A support file can be retrieved using a GET /support. This requires administrator authorizations. The support file contains the following data: ·...

  • Page 49: System Status (Rest)

    IDS NXT: REST interface 15 System status (REST) · /states · /states/<identifier> 15.1 /states · OPTIONS · "GET": { "application/json": { "Description": "Receive status", "Values": { "Active": { "Description": "Identifier of active states", "Type": "StringList" "Objects": [ "BuffersFilled", "DiskLoadTooHigh", "FirmwareUpdate", "NoEthernet",...
  • Page 50 IDS NXT: REST interface "Description": "Description", "Type": "String" "Title": { "Description": "Title", "Type": "String" "Type": { "Description": "Type", "Type": "String" "image/png,image/bpmp/image/jpeg": { "Description": "Receive state symbol", "Parameters": { "MaxHeight": { "Description": "Maximal height of image.", "Mandatory": false, "Type": "Integer" "MaxWidth": { "Description": "Maximal width of image",...

  • Page 51: Vision App List

    IDS NXT: REST interface 16 Vision app list Vision app identifiers must follow these guidelines: · Maximum 100 characters · Only letters, numbers and underscores A-Za-z0-9_ · Not starting with a number · Starting with underscore is reserved for the system. Although this is possible, it is not recommended.

  • Page 52: Vapps/Activated/

    IDS NXT: REST interface "rs232gateway" Comments Objects are all vision apps (not just those activated!) 16.3 /vapps/activated/<vapp> · OPTIONS · DELETE · "DELETE": { "<none>": { "Description": "Deactivate the vision app.", "Parameters": { "Temporary": { "Description": "If true, the vision app is deactivated temporarily only.",...
  • Page 53 IDS NXT: REST interface "PUT": { "application/vapp": { "Description": "Updates/installs the vision app" Body for the PUT must be a vision app (*.vapp). March 2021...

  • Page 54: Individual Vision Apps

    IDS NXT: REST interface 17 Individual vision apps /vapps/<vapp> · OPTIONS · GET: · PUT: · DELETE: "DELETE": { "<none>": { "Description": "Removes the vision app." "GET": { "application/json": { "Description": "Receive vision app information", "Values": { "Activated": { "Description": "Activation status", "Type": "Boolean"...

  • Page 55: Actions

    IDS NXT: REST interface "Debugging" "Type": "String" "Title": { "Description": "Title", "Type": "String" "Type": { "Description": "Type", "Range": [ "VApp", "Plugin", "System" "Type": "String" "Version": { "Description": "Version", "Type": "String" "Objects": [ "actions", "avatar", "configurables", "files", "images", "license", "log", "resultsinks", "resultsources",...

  • Page 56: Vapps//Actions/

    IDS NXT: REST interface Comments Objects are available actions in the vision app. 17.1.2 /vapps/<vapp>/actions/<action> · OPTIONS · · POST "GET": { "application/json": { "Description": "Receive action settings.", "Values": { "Active": { "Description": "True if action is executing", "Type": "Boolean"...

  • Page 57: Configurables

    IDS NXT: REST interface · "GET": { "image/png,image/bmp,image/jpeg": { "Description": "Read Vision app avatar" "Parameters": { "MaxHeight": { "Description": "Maximal height of image.", "Mandatory": false, "Type": "Integer" "MaxWidth": { "Description": "Maximal width of image", "Mandatory": false, "Type": "Integer" "Quality": { "Description": "Quality of image.",...

  • Page 58: Files

    IDS NXT: REST interface "Objects": [ "PATCH": { "application/x-www-form-urlencoded": { "Description": "Modify VApp-Configurables.", "Values": { "a_header": { "Brief": "Header of result output", "Description": "Header of the result output. Special characters can be set with \\xx where xx is the corresponding hexadecimal value (ASCII).", "Title": "Header",...

  • Page 59: Vapps//Files/

    IDS NXT: REST interface 17.4.2 /vapps/<vapp>/files/<file> · OPTIONS · "GET": { "application/json": { "Description": "Get ConfigurableFile information", "Values": { "Brief": { "Description": "Brief description of the file.", "Type": "String" "Deletable": { "Description": "True if file is deletable.", "Type": "Boolean" "Description": { "Description": "Description of the file.",...

  • Page 60: Vapps//Files//Data

    IDS NXT: REST interface 17.4.3 /vapps/<vapp>/files/<file>/data · OPTIONS · (Available if ConfigurableFile is set to "Readable"). · (Available if ConfigurableFile is set to "Writable"). · DELETE (Available if ConfigurableFile is set to "Deletable"). The MIME type (e.g. image/jpeg) depends on the ConfigurableFile and therefore can be any type. Title, Brief, Description are only specified if they are set and not blank.

  • Page 61: License

    IDS NXT: REST interface "Description": { "Description": "Long description of image", "Type": "String" "Title": { "Description": "Title of image", "Type": "String" "ZIndex": { "Description": "Z-Index of the ResultImage", "Type": "Integer" "image/png,image/bmp,image/jpeg": { "Description": "Receive the latest acquired image. Returns 503 if no image acquired so far.",...

  • Page 62: Log

    IDS NXT: REST interface 17.7 Log /vapps/<vapp>/log · OPTIONS · "GET": { "text/plain": { "Description": "Log of the vision app" "Objects": [ 17.8 ResultSinks · /vapps/<vapp>/resultsinks · /vapps/<vapp>/resultsinks/<sink> 17.8.1 /vapps/<vapp>/resultsinks · OPTIONS "Objects": [ "<string1>", "…" 17.8.2 /vapps/<vapp>/resultsinks/<sink> · OPTIONS ·...

  • Page 63: Resultsources

    IDS NXT: REST interface "Description": "The specific result source", "Range": [ "<string>" "Type": "String" "Title": { "Description": "Title of the result sink", "Type": "String" "Type": { "Description": "Type of the result sink", "Type": "String" "VApp": { "Description": "The result source's vision app", "Range": [...

  • Page 64: Vapps//Resultsources

    IDS NXT: REST interface 17.9.1 /vapps/<vapp>/resultsources · OPTIONS "Objects": [ "dummy", "last", "list" 17.9.2 /vapps/<vapp>/resultsources/dummy · OPTIONS · "GET": { "application/json": { "Description": "Receive the result data.", "Values": { "class": { "Title": "Class", "Type": "StringObject", "ZIndex": 0 "count": { "Title": "Count", "Type": "StringObject",...

  • Page 65: Vapps//Resultsources/Last

    IDS NXT: REST interface Comments · The dummy object has been incorporated to enable the OPTIONS for a list entry (/vapps/<vapp>/resultsources/list/<key>) to be requested without it having or exist or be explicitly selected. No GET is permitted here. · Like the Configurables, ResultSources can have ranges ("Range", "WarningRange..", "ErrorRange..") and units.

  • Page 66: Vapps//Resultsources/List

    IDS NXT: REST interface Comments · /vapps/<vapp>/resultsources/last returns the last result. · Like the Configurables, ResultSources can have ranges ("Range", "WarningRange..", "ErrorRange..") and units. Title, Brief and Description can also be specified. · Unfortunately, the complex response to a GET is not shown in full here. To see it, refer to the following section.
  • Page 67 IDS NXT: REST interface "Description": "Receive the result data.", "Values": { "class": { "Title": "Class", "Type": "StringObject", "ZIndex": 0 "count": { "Title": "Count", "Type": "StringObject", "ZIndex": 0 "data": { "Title": "Data", "Type": "StringObject", "ZIndex": 0 "inference": { "Title": "Inference", "Type": "StringObject", "ZIndex": 0...

  • Page 68: Roi

    IDS NXT: REST interface "Content": "[{\"Height\":1080,\"Index\":\"1\",\"Inference\":[{\"Class\": \"binder\",\"Probability\":\"0.60\"},{\"Class\":\"bookcase\",\"Probability\": \"0.30\"},{\"Class\":\"bookshop\",\"Probability\":\"0.04\"},{\"Class\": \"comic_book\",\"Probability\":\"0.02\"}],\"OffsetX\":0,\"OffsetY\":0, \"Width\":1440}]" "inferencetime": { "Content": "69" 17.10 ROI · /vapps/<vapp>/rois · /vapps/<vapp>/rois/<roi> 17.10.1 /vapps/<vapp>/rois · OPTIONS "Objects": [ "<string>" 17.10.2 /vapps/<vapp>/rois/<roi> · OPTIONS · · PATCH "GET": { "application/json": { "Description": "Receive region of interest (ROI) settings.", "Values": {...
  • Page 69 IDS NXT: REST interface "Maximum": 1456, "Minimum": 0 "Type": "Integer", "Unit": "pixel" "OffsetY": { "Description": "Y-coordinate of upper left corner of the ROI", "Range": { "Maximum": 1088, "Minimum": 0 "Type": "Integer", "Unit": "pixel" "Title": { "Description": "Title of the ROI", "Type": "String"...
  • Page 70 IDS NXT: REST interface "Type": "Integer", "Unit": "pixel" "Width": { "Description": "Width of the ROI", "Range": { "Maximum": 1456, "Minimum": 0 "Type": "Integer", "Unit": "pixel" March 2021...

  • Page 71: Index

    IDS NXT: REST interface version - A - - I - Action information Image vision app JPEG Avatar - B - Input Bild invert status - C - Interface Camera RS-232 color gain - L - exposure time frame rate...
  • Page 72 IDS NXT: REST interface Signal update detail list Statistics 45, 46 Support file System details status - T - Trigger delay hardware prescaler software Boolean Double Integer String StringList - U - Unit display localization User authentification create delete list...

Table of Contents