Riftek RF627 Series, Руководство пользователя

Страница: 100 / 130

100
Laser Scanners
RF627, RF627Smart [Revision 2.1.2] 20.09.2021
30. Annex 4. Web API
30.1. General device information
/hello - getting general information about the device in JSON format.
o
GET:
§
192.168.1.30/hello
/api/v1/config/commands - getting a list of commands supported by the device.
The formalized description will contain the command name, web API accessibility,
command ID, access mode.
o
GET:
§
192.168.1.30/api/v1/config/commands
/api/v1/config/returnCodes - getting a textual description of the codes of the
operation results and errors returned by the device.
o
GET:
§
192.168.1.30/api/v1/config/returnCodes
30.2. Reading and writing parameters
/api/v1/config/params - getting general information about all device parameters in
JSON format. The formalized description of the parameter will contain its name, type,
access mode, index in the parameter array, offset for binary data, parameter data size,
current value, default value, minimum and maximum values, parameter value step,
maximum number of elements (for arrays).
o
GET:
§
192.168.1.30/api/v1/config/params
/api/v1/config/params/values - reading and writing device parameters. For
reading, you can request specific parameters by name or index. To write a parameter, it is
necessary to form a “PUT” request with the “parameter_name:value” parameters.
o
GET:
§
192.168.1.30/api/v1/config/params/values
§
192.168.1.30/api/v1/config/params/values?
name=fact_general_hardwareVer&index=120
o
PUT:
§
192.168.1.30/api/v1/config/params/values?
user_sensor_framerate=100&user_sensor_exposure1=100000
30.3. Saving and restoring settings. Rebooting the device
/api/v1/config/params/save - saving the current values of the device parameters
in the non-volatile memory of the device in the user area. The saved values will be used the
next time the device is turned on.
o
GET:
§
192.168.1.30/api/v1/config/params/save
/api/v1/config/params/restore/save - saving the current values of the device
parameters in the recovery area. These parameters will be applied if the parameters from
the user area are damaged.
o
GET:
§
192.168.1.30/api/v1/config/params/restore/save
/api/v1/config/params/restore/load - loading device parameters from the
recovery area. The loaded values will be written to the user area, the device will
automatically reboot.
o
GET: