background image

Programmers Guide 

Interface description 

3D Camera

O3X100

706447 / 00

  

12 / 2018

UK

Summary of Contents for O3X1 Series

Page 1: ...Programmers Guide Interface description 3D Camera O3X100 706447 00 12 2018 UK...

Page 2: ...6 TimeConfig Object 7 4 2 7 Application Config Object 7 4 2 8 Application Imager Config Object 8 5 Process Interface 9 5 1 Protocol structure 9 5 2 Receiving Images 10 5 3 Image data 10 5 3 1 Chunk t...

Page 3: ...and company names used are subject to the copyright of the respective companies This device contains maybe modified open source software which is subject to special licensing terms For copyright infor...

Page 4: ...perating instructions or the technical data are not adhered to personal injury and damage to property can occur 1 3 Further documents Operating instructions Interface description The documents can be...

Page 5: ...y command which is sent via the XML RPC interface must end with carriage return CR and linefeed LF Several commands will use different URLs in the XML RPC header Preferably use the ifm3Dlib for access...

Page 6: ...RPC objects Different commands need different XML RPC objects see XML RPC command references The interface of O3X1xx is structured in an object oriented way Some of the objects are available all the...

Page 7: ...D is generated automatically 4 2 3 EditMode Object Object URI e g api rpc v1 com ifm efector session_d21c80db5bc1069932fbb9a3bd841d0b edit 4 2 4 DeviceConfig Object Object URI e g api rpc v1 com ifm e...

Page 8: ...d when calling save on the application config object The imager config RPC object has multiple sub types Only parameters relevant for a specific type are available while it is active They are based on...

Page 9: ...escription ASCII code dec ASCII code hex CR Carriage Return 13 D LF Linefeed 10 A Marking of a placeholder e g code is a placeholder for code Optional argument possible but not required Command Descri...

Page 10: ...nature CR LF Only configured images will be displayed 5 3 Image data For every image there will be a separate chunk The chunk is part of the response frame data of the process interface The header of...

Page 11: ...s at the image border is corrected The visual impression of this grayscale image is comparable to that of a common 2D camera Invalid PMD pixels e g due to saturation have an amplitude value of 0 Data...

Page 12: ...llimetres CARTESIAN_ALL 203 CARTESIAN_X_COMPONENT CARTESIAN_Y_COMPONENT CARTESIAN_Z_COMPONENT UNIT_VECTOR_ALL 223 The unit vector matrix contains 3 values ex ey ez for each PMD pixel i e the data layo...

Page 13: ...due to strong ambient light or very short integration times or PMD interference may also contribute Contributes to pixel validity yes 3 1 amplitude below minimum amplitude threshold Amplitude limits...

Page 14: ...the current value of the parameter Input parameters Name of parameter string Output parameters Value of parameter string getAllParameters Method name getAllParameters Description Returns all paramete...

Page 15: ...st specified on specific parameters 6 2 Main Object getParameter Method name getParameter Description Getter for the device global parameters This is an additional getter outside of edit sessions so i...

Page 16: ...n Calibration_Version Calibration_Device getHWInfo Method name getHWInfo Description Returns hardware information of all components Input parameters none Output parameters Struct of strings e g MACAdd...

Page 17: ...gnored Input parameters 1 Password string 2 Session ID string Output parameters Session ID string reboot Method name reboot Description Reboot system parameter defines which mode system will be booted...

Page 18: ...rd with E g 0001 0001 1 0 or 0001 1 getUnitVectors Method name getUnitVectors Description Returns a chunk containing the current unit vectors Input parameters none Output parameters Unit vector chunk...

Page 19: ...bility with classic XmlRPC client exportConfig Method name exportConfig Description Exports the whole configuration of the sensor device Input parameters none Output parameters Configuration as a data...

Page 20: ...ata BLOB binary base64 Output parameters Index of new application setOperatingMode Method name setOperatingMode Description Changes the operating mode of the device Setting this to edit will enable th...

Page 21: ...parameters Empty string compatibility with classic XmlRPC client 6 5 Device Config Object activatePassword Method name activatePassword Description Sets a password and activates it for the next edit s...

Page 22: ...in the network 2 LinkLocal configured to DHCP but no server which provided an address 3 Discovery changed by IP4Discovery mechanism PasswordActivated Bool readonly Is true if the password protection...

Page 23: ...nfig Description Reinitialise the network interface so that it uses the configuration which was set by the other RPC methods There will be no XMLRPC reply because the network interface is instantly re...

Page 24: ...t saveAndActivateConfig Method name saveAndActivateConfig Description Save and immediately apply the current time configuration might lead to jump in the system time Input parameters none Output param...

Page 25: ...icleNumber ArticleStatus or volatile UpTime ImageTimestampReference Minimum and maximum values of Time Config parameters The minimum and maximum values of the time configuration parameters are Paramet...

Page 26: ...images are generated in the application Allowed values 1 free run 2 software trigger OutputDistanceImage Bool Output the radial distance image OutputAmplitudeImage Bool Output the amplitude image Out...

Page 27: ...config Methods for parameter access are defined here Parameter name Data type Description FrameRate Double has limits Target frame rate in frames per second for free run mode ExposureTime Int has lim...

Page 28: ...Parameter name Data type Description ExposureTimeRatio Double has limits Ratio of long exposure time to short exposure time Only available in double exposure modes Default values of double exposure mo...

Page 29: ...low upTo07m_moderate upTo15m_low upTo15m_moderate upTo30m_low upTo30m_moderate The capture mode consists of Section Description upTo30m_ Length of the unambiguous range 1 measurement frequency unambig...

Reviews: