manualshive.com logo in svg

IDS NXT, Manual

Share
Download
IDS NXT Manual Download Page 10

March 2021 

 

                                                                                                                                         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.

Summary of Contents for NXT

Page 1: ...NXT 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 REST interface for IDS NXT SDK 2 1 0 IDS NXT OS 1 1...

Page 2: ...isting username 9 5 Device events 11 5 1 events 11 5 2 Server sent events 12 5 3 Event syntax 12 5 4 Restrictions 12 6 Device information 13 6 1 deviceinfo 13 6 2 deviceinfo avatar 16 6 3 deviceinfo d...

Page 3: ...11 2 rs232 data 40 12 Signals 42 12 1 signals 42 12 2 signals list 42 12 3 signals list id 43 13 Statistics 45 13 1 statistics 45 13 2 statistics change 46 14 Support file 48 15 System status REST 49...

Page 4: ...es image 60 17 6 License 61 17 7 Log 62 17 8 ResultSinks 62 17 8 1 vapps vapp resultsinks 62 17 8 2 vapps vapp resultsinks sink 62 17 9 ResultSources 63 17 9 1 vapps vapp resultsources 64 17 9 2 vapps...

Page 5: ...nor limited by the information contained in this manual Should you require further information on this product or encounter specific problems that are not discussed in sufficient detail in the manual...

Page 6: ...EST 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 saf...

Page 7: ...ult 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 f...

Page 8: ...ype String StringList JSonArray of Strings Int and where appropriate range either array of possible discrete values or minimum maximum values Values that are included in the URL as GET parameters are...

Page 9: ...on json Allowed true Description Receive user list Values Users Description List of Usernames Name Users Type StringList Objects admin service user Comments Objects are existing users 4 2 users existi...

Page 10: ...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...

Page 11: ...nt 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 r...

Page 12: ...text eventstream data GET camera image data GET statistics data GET statistics 5 3 Event syntax The event contains the method and URL that has changed This is used to avoid having to retrieve the OPT...

Page 13: ...0 Minimum 0 Type Double Unit Per cent Color Description True if color model Type Boolean DateTime Description Server time Must be of format RFC 2822 date e g Fri 1 Jan 2021 00 00 00 UTC Type String De...

Page 14: ...n Bytes received over Network per second Type Integer Unit bytes per second NetworkTx Description Bytes sent over Network per second Type Integer Unit bytes per second RAMLoad Description Total RAM lo...

Page 15: ...ption Uptime in seconds Type Integer VSupply Description Supply voltage Range Maximum 50 Minimum 10 RangeError0 Maximum 11 Minimum 10 RangeError1 Maximum 50 Minimum 30 RangeWarning0 Maximum 30 Minimum...

Page 16: ...Type String 6 2 deviceinfo avatar OPTIONS GET DELETE PUT DELETE Description Deleting the avatar A fallback avatar will be used for next access GET image png image bmp image jpeg Allowed true Descripti...

Page 17: ...Description Receive device datetime information Values DateTime Description Server time Type String NTP Description True if NTP is enabled Type Boolean NTPServer Description Must be of format xxx xxx...

Page 18: ...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 America Adak Ameri...

Page 19: ...S Objects in1 in2 Comments Objects are available pins thus currently in1 or in2 7 3 gpio inputs pin OPTIONS GET PATCH GET application json Description Receive status information Values Inverter Descri...

Page 20: ...ue 0V input means on level Type Boolean Comments Only difference to gpio outputs pin Level cannot be set using PATCH 7 4 gpio outputs OPTIONS Objects out1 out2 Comments Objects are available pins thus...

Page 21: ...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 Level Description Logi...

Page 22: ...posureTime Description Exposure time Range Maximum 2000018 Minimum 35 Type Integer Unit microseconds FlipHorizontal Description Horizontal image flip Type Boolean FlipVertical Description Vertical ima...

Page 23: ...sureTime Description Exposure time Range Maximum 2000018 Minimum 35 Type Integer Unit microseconds FlipHorizontal Description Horizontal image flip Type Boolean FlipVertical Description Vertical image...

Page 24: ...ce Description Trigger debouncing Range Maximum 20000 Minimum 0 Type Integer Unit microseconds Delay Description Trigger delay in microseconds Range Maximum 16777215 Minimum 0 Type Integer Unit micros...

Page 25: ...Minimum 0 Type Integer Unit microseconds TriggerType Description Trigger type Range Freerun Hardware Software Type String Objects PATCH application x www form urlencoded Description Update trigger set...

Page 26: ...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 microse...

Page 27: ...e Integer Quality Description Quality of image Mandatory false Type Integer Comments If no MIME type or image is specified image jpeg is returned An ETag is returned the same one for each image regard...

Page 28: ...it pixel OffsetY Description Y coordinate of upper left corner of the ROI Range Maximum 1088 Minimum 0 Step 2 Type Integer Unit pixel Width Description Width of the ROI Range Maximum 1456 Minimum 32 S...

Page 29: ...nteger Unit per cent RedGain Description Red Gain Range Maximum 100 Minimum 0 Type Integer Unit per cent WhiteBalance Range Off Once Continuous Type String Objects PATCH application x www form urlenco...

Page 30: ...March 2021 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...

Page 31: ...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 Maximu...

Page 32: ...777215 Minimum 0 Type Integer Unit microseconds Duration Description Flash on time Range Maximum 16777215 Minimum 0 Type Integer Unit microseconds Inverted Description Inverts the flash signal Type Bo...

Page 33: ...f 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 man...

Page 34: ...e GET application json Description Receive general network settings Values MAC Description MAC Address Type String RestrictHTTP Description If true HTTP connections will be redirected to HTTPS Type Bo...

Page 35: ...eway must be of format xxx xxx xxx xxx Type String Netmask Description Netmask must be of format xxx xxx xxx xxx Type String Options PATCH application x www form urlencoded Description Set network IPv...

Page 36: ...IONS GET PATCH DELETE GET application json Description Receive current nameservers Values Nameserver1 Description Current name server 1 Must be of format xxx xxx xxx xxx Type String Nameserver2 Descri...

Page 37: ...n Current time server Must be of format xxx xxx xxx xxx Type String PATCH application x www form urlencoded Description Set time server Values Timeserver Description Current time server Must be of for...

Page 38: ...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...

Page 39: ...scription Receive 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 Ra...

Page 40: ...0 2400 4800 9600 19200 38400 57600 115200 230400 Type Integer Unit baud Parity Description Parity setting Range None Odd Even Type String Stopbits Description Stopbit length Range One OneAndHalf Two T...

Page 41: ...March 2021 41 IDS NXT REST interface Objects PUT application octet stream Description Send data via RS232...

Page 42: ...rs the list of signals GET text csv Description Get list of signals as comma separated value file Parameters Sender Description Limit to this sources comma seperated Mandatory false Type String Severi...

Page 43: ...Because a since restriction transfers only part of the body no If Modified Since is used here 12 3 signals list id OPTIONS GET GET application json Description Return specific signal Values Brief Des...

Page 44: ...escription Maximal height of image Mandatory false Type Integer MaxWidth Description Maximal width of image Mandatory false Type Integer Quality Description Quality of image Mandatory false Type Integ...

Page 45: ...ription Number of missed triggers Title Missed triggers Type Integer ImageTotal Brief Number of captured images Description Number of captured images Title Total images Type Integer LastReset Brief Ti...

Page 46: ...s VisionOK Images processed as Good VisionFailed Images processed as Bad FreeBuffers Image buffers still available currently maximum 10 13 2 statistics change OPTIONS GET GET application json Descript...

Page 47: ...otal images Type Double VisionFailed Brief Number of unsuccessfully processed images Description Number of unsuccessfully processed images Title Image processing failed Type Double VisionOK Brief Numb...

Page 48: ...ved using a GET support This requires administrator authorizations The support file contains the following data messages dmesg Output of top Output of ps Detailed version information user json without...

Page 49: ...r ObtainingDHCP Paused TemperatureTooHigh Training VSupplyTooHigh VSupplyTooLow Objects contain all possible system state identifiers or UUIDs which can then be separately requested see states identif...

Page 50: ...scription 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 M...

Page 51: ...commended 16 1 vapps OPTIONS GET GET application json Description Receive information on vision apps Values APIVersion Description Installed API versions Type StringList Installed Description List of...

Page 52: ...s Temporary Description If true the vision app is deactivated temporarily only Mandatory false Type Boolean Objects PUT none Description Activate the vision app Parameters Temporary Description If tru...

Page 53: ...March 2021 53 IDS NXT REST interface PUT application vapp Description Updates installs the vision app Body for the PUT must be a vision app vapp...

Page 54: ...iption Activation status Type Boolean Brief Description Brief Type String Description Description Description Type String Manufacturer Description Name of manufacturing company Type String ModuleDepen...

Page 55: ...ersion Description Version Type String Objects actions avatar configurables files images license log resultsinks resultsources rois PUT application vapp Description Updates installs the vision app Bod...

Page 56: ...ription True if action is executing Type Boolean Brief Description Brief description of the action Type String Description Description Long description of the action Type String Enabled Description Tr...

Page 57: ...17 3 Configurables vapps vapp configurables OPTIONS GET PATCH GET application json Description Read VApp Configurables Values a_header Brief Header of result output Description Header of the result ou...

Page 58: ...b_footer Brief Footer of result output Description Footer of the result output Special characters can be set with xx where xx is the corresponding hexadecimal value ASCII Title Footer Type String ZInd...

Page 59: ...ue if file is deletable Type Boolean Description Description Description of the file Type String Filter Description Filter of the file Type StringList MimeType Description Mimetype of the file Type St...

Page 60: ...ation octet stream Description Set ConfigurableFile To transmit the filename add header value Content Disposition Attachment filename filename url encoded 17 5 Images vapps vapp images vapps vapp imag...

Page 61: ...age jpeg Description Receive the latest acquired image Returns 503 if no image acquired so far Parameters MaxHeight Description Maximal height of image Mandatory false Type Integer MaxWidth Descriptio...

Page 62: ...ultsinks sink 17 8 1 vapps vapp resultsinks OPTIONS Objects string1 17 8 2 vapps vapp resultsinks sink OPTIONS GET GET application json Description Get result sink data Values Brief Description Brief...

Page 63: ...ce s vision app Range string Type String Objects PATCH application x www form urlencoded Description Set result sink data Values Source Description The specific result source Range string Type String...

Page 64: ...n 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 Str...

Page 65: ...tle Brief and Description can also be specified _Finished is generated by the system 17 9 3 vapps vapp resultsources last OPTIONS GET GET application json Description Receive the result data Values cl...

Page 66: ...ted by the system Response to GET class Content binder count Content 1 data Content Height 1080 Index 1 Inference Class binder Probability 0 60 Class bookcase Probability 0 30 Class bookshop Probabili...

Page 67: ...Probability Type StringObject ZIndex 0 inferencetime Title Inferencetime each ROI Type IntegerObject Unit milliseconds ZIndex 0 Objects Comments Like the Configurables ResultSources can have ranges Ra...

Page 68: ...ois vapps vapp rois roi 17 10 1 vapps vapp rois OPTIONS Objects string 17 10 2 vapps vapp rois roi OPTIONS GET PATCH GET application json Description Receive region of interest ROI settings Values Bri...

Page 69: ...n Width of the ROI Range Maximum 1280 Minimum 0 Type Integer Unit pixel PATCH application x www form urlencoded Description Setup the region of interest ROI Values Height Description Height of the ROI...

Page 70: ...March 2021 70 IDS NXT REST interface Type Integer Unit pixel Width Description Width of the ROI Range Maximum 1456 Minimum 0 Type Integer Unit pixel...

Page 71: ...E Event 11 restriction 12 server 12 syntax 12 F Flash 31 mode 32 G Gain RGB 28 H HTTP version 7 I Image BMP 27 JPEG 27 PNG 27 Input 19 invert 19 status 19 Interface RS 232 39 L Lighting 31 external 31...

Page 72: ...p Boolean 7 Double 7 Integer 7 String 7 StringList 7 U Unit display 7 localization 7 User authentification 7 create 9 delete 9 list 9 rights 9 User class 7 V Vision app 51 action 56 activate 52 availa...

Reviews:

No comments

Brands by name

Popular brands

Load more brands