IFM Electronic O3D301 Operating Instructions Manual page 20

3D camera
Main API
cancelSession(...) removes itself from RPC. Session will also
be removed, if heartbeat(...) is not called at the right time
Session
setOperatingMode(0) will remove EditMode from RPC
EditMode
stopEditApplication() will remove ApplicationConfig from RPC
ApplicationConfig
Main Object
Object-URI: /api/rpc/v1/com.ifm.efector/
This is the main object of RPC. It contains methods to open a session. The session contains methods for
activating the edit mode. Most of its methods are only getters, because it should be possible to protect
editing with a password.
Session Object
Object URI e.g.: /api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/
The URL part "d21c80db5bc1069932fbb9a3bd841d0b" is the session ID. It is returned by the command
"requestSession" of the main object. If the command "requestSession" is called without a user-defined
session ID, which can be passed as a parameter, a random session ID is generated automatically.
EditMode Object
Object URI e.g.: /api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/
This object is only available if the device is in the edit operating mode. The index of applications must be
between 1 and 32. The device must only support 32 applications and the indexes must start at 1.
DeviceConfig Object
Object-URI e.g.: /api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/device/
Device/NetworkConfig Object
Object URI e.g.:
/api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/device/network/
Application Config Object (editable application)
Object URI e.g.:
/api/rpc/v1/com.ifm.efector/session_d21c80db5bc1069932fbb9a3bd841d0b/edit/application/
20