Дополнительная информация¶
PARAMETERS¶
Description of device parameters. All device parameters are readable. Those parameters that cannot be written without authorization as manufacturer have «awrite» access type. If no minimum value is specified for a parameter, the minimum value corresponds to the minimum value of the parameter type. If no maximum value is specified, it corresponds to the maximum value of the parameter type.
The main elements of the parameter description:
- Access - describes the availability of the parameter for reading and writing.
- read - parameter is readable,
- write - parameter is writable by user,
- awrite - parameter is writable after authorization as a manufacturer
- Type - the data type of the parameter. - uint32_t - unsigned integer, 32 bits,
- uint64_t - unsigned integer, 64 bits,
- int32_t - signed integer, 32 bits,
- int64_t - signed integer, 64 bits,
- float_t - floating point, 32 bits,
- double_t - floating point, 64 bits,
- u32_arr_t - array of unsigned integer, 32 bits,
- u64_arr_t - array of unsigned integer, 64 bits,
- i32_arr_t - array of signed integer, 32 bits,
- i64_arr_t - array of signed integer, 64 bits,
- flt_array_t - array of floating point, 32 bits,
- dbl_array_t - array of floating point, 64 bits,
- string_t - string, ending with «0», the maximum length of the string is specified in the parameter description
- Min value - minimum parameter value, writing a value less than this is not allowed. If no minimum
value is specified, it is defined by the type of parameter.
- Max value - maximum parameter value, writing a value greater than this is
not allowed. If no maximum value is specified, it is defined by the type
of parameter.
- Step - step with which it is allowed to change the
parameter value. Values that do not match the step will not be set. If
no step is specified, any parameter change is allowed.
- Enum - enumeration of valid parameter values. Values that do not match the
enumeration will not be set.
- Default value - default value of the parameter, set by the manufacturer
or after switching on the device (depending on the parameter).
User¶
- user_general_deviceState - Current device state - combination
of enum values. The device changes the value of this parameter when
initializing the equipment, transferring important data over the
network (e.g. firmware), updating the firmware and in other cases. In
all modes except DEV_STATE_NORMAL, the device can pause the
transfer of profiles and other data not related to the current
operating mode.
- Access: read
- Type: uint32_t
- Min value: DEV_STATE_NORMAL
- Max value: DEV_STATE_HARDWARE_INIT
- Enum:
- DEV_STATE_NORMAL - the device operates in normal mode,
- DEV_STATE_CALIB_FILE_RCV - the device receives a
calibration file,
- DEV_STATE_CALIB_FILE_SND - the device is transfer
calibration file,
- DEV_STATE_CALIB_FILE_SAVE - the device saves the
calibration file to the internal flash drive,
- DEV_STATE_FIRMWARE_RCV - device receives firmware,
- DEV_STATE_FIRMWARE_SND - the device is transfer firmware,
- DEV_STATE_FIRMWARE_SAVE - the device saves the firmware file
to the internal flash drive,
- DEV_STATE_ETH_INIT - the device initializes hardware and
software for ethernet connection,
- DEV_STATE_DUMP_DOWNLOAD - the device transfers dump data,
- DEV_STATE_ETH_EXCESS - required connection speed exceeds
current value for ethernet connection,
- DEV_STATE_HARDWARE_INIT - device initializes hardware
- Default value: DEV_STATE_NORMAL
- user_general_deviceName - User-defined scanner name. It is
displayed on the web page of the scanner and can be used to quickly
identify scanners.
- Access: read/write
- Type: string_t
- Max len: 128
- Default value: «2D laser scanner»
- user_general_logSaveEnabled - Allow automatic log saving after
device boot and after critical events. When this option is enabled,
it slightly (~ 100ms) increases the time until the device is ready
for operation.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_general_logSize - The current size (number of records) of
the device’s internal log file.
- Access: read
- Type: uint32_t
- Default value: 0
- user_sysMon_fpgaTemp - The current temperature of the FPGA
(internal computing module) of the device.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_paramsChanged - Device settings have been changed
but not saved.
- Access: read
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_sysMon_tempSens00 - Current temperature inside the device
case, measured by the sensor with address 00.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_tempSens00Max - Maximum temperature fixed by sensor
with address 00.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_tempSens00Min - Minimum temperature fixed by sensor
with address 00.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_tempSens01 - Current temperature inside the device
case, measured by the sensor with address 01.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_tempSens01Max - Maximum temperature fixed by sensor
with address 01.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_tempSens01Min - Minimum temperature fixed by sensor
with address 01.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_tempSens10 - Current temperature inside the device
case, measured by the sensor with address 10.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_tempSens10Max - Maximum temperature fixed by sensor
with address 10.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_tempSens10Min - Minimum temperature fixed by sensor
with address 10.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_tempSens11 - Current temperature inside the device
case, measured by the sensor with address 11.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_tempSens11Max - Maximum temperature fixed by sensor
with address 11.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sysMon_tempSens11Min - Minimum temperature fixed by sensor
with address 11.
- Access: read
- Type: float_t
- Min value: -100
- Max value: +100
- Default value: 0
- Units: °C
- user_sensor_syncSource - Measurement synchronization source.
- Access: read/write
- Type: uint32_t
- Min value: SYNC_INTERNAL
- Max value: SYNC_SOFTWARE
- Enum:
- SYNC_INTERNAL - start of measurements from the device’s
internal generator,
- SYNC_EXTERNAL - start of measurements from an external source,
- SYNC_SOFTWARE - start of measurements by software request
- Default value: SYNC_INTERNAL
- user_sensor_framerate - Frame rate of the CMOS-sensor, sets the
measurement frequency. The value to be written should not exceed the
value of the parameter user_sensor_maxFramerate.
- Access: read/write
- Type: uint32_t
- Min value: 1
- Max value: 20000
- Default value: 490
- Units: Hz
- user_sensor_maxFramerate - Maximum frame rate (measurement
frequency) for the current operation mode.
- Access: read
- Type: uint32_t
- Min value: 1
- Max value: 20000
- Default value: 490
- Units: Hz
- user_sensor_exposureControl - CMOS-sensor exposure control
method.
- Access: read/write
- Type: uint32_t
- Min value: EXPOSE_AUTO
- Max value: EXPOSE_MULTI_3
- Enum:
- EXPOSE_AUTO - automatic exposure control based on profile
analysis,
- EXPOSE_FIXED - exposure time is user-defined,
- EXPOSE_MULTI_2 - mode with 2 exposures, used to obtain a
profile on surfaces with different levels of reflection,
- EXPOSE_MULTI_3 - mode with 3 exposures, used to obtain a
profile on surfaces with different levels of reflection
- Default value: EXPOSE_FIXED
- user_sensor_exposure1 - Frame exposure time in EXPOSE_AUTO and
EXPOSE_FIXED modes.
- Access: read/write
- Type: uint32_t
- Min value: 3000
- Max value: 300000000
- Step: 100
- Default value: 300000
- Units: ns
- user_sensor_exposure2 - Frame #2 exposure time in
EXPOSE_MULTI_2 mode.
- Access: read/write
- Type: uint32_t
- Min value: 3000
- Max value: 300000000
- Step: 100
- Default value: 300000
- Units: ns
- user_sensor_exposure3 - Frame #3 exposure time in
EXPOSE_MULTI_2 mode.
- Access: read/write
- Type: uint32_t
- Min value: 3000
- Max value: 300000000
- Step: 100
- Default value: 300000
- Units: ns
- user_sensor_maxExposure - Maximum frame exposure time in the
current device mode.
- Access: read/write
- Type: uint32_t
- Min value: 3000
- Max value: 300000000
- Step: 100
- Default value: 300000
- Units: ns
- user_sensor_defectivePixels - Array of coordinates [X1, Y1, X2,
Y2, … X15, Y15] of the sensor’s defective pixels.
- Access: read/write
- Type: u32_arr_t
- Max value: 4096
- Max elements: 32,
- Default value: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
- user_sensor_doubleSpeedEnabled - Turns on and off the sensor’s
double frame rate mode. Enabling this mode allows almost double the
frequency of measurements (profiles per second) by reducing accuracy
in the Z-axis.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_sensor_edrType - Enable CMOS-sensor operation in the
extended dynamic range. Allows get a quality profile on light and
dark surfaces.
- Access: read/write
- Type: uint32_t
- Min value: EDR_DISABLE
- Max value: EDR_COLUMN
- Enum:
- EDR_DISABLE - extended dynamic range mode disabled,
- EDR_COLUMN - different exposure mode for even and odd columns
- Default value: EDR_DISABLE
- user_sensor_edrColumnDivider - Exposure time divider for odd
columns. This parameter controls the sensitivity to very bright areas
of the profile.
- Access: read/write
- Type: uint32_t
- Min value: 2
- Max value: 32
- Default value: 2
- user_roi_enabled - Turns on and off the mode of obtaining
measurements in the region of interest.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_roi_active - Indicates the status of the ROI in automatic
positioning mode. In the automatic position control mode, if the
profile is not detected, the activity switches to the FALSE state,
when the profile is detected, the parameter switches to the TRUE
state. In manual positioning mode, the parameter is always TRUE.
- Access: read
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_roi_posMode - ROI position control mode.
- Access: read/write
- Type: uint32_t
- Min value: ROI_POSITION_MANUAL
- Max value: ROI_POSITION_AUTO
- Enum:
- ROI_POSITION_MANUAL - ROI position is set by the user,
- ROI_POSITION_AUTO - ROI automatic position control with
profile holding in the center
- Default value: ROI_POSITION_MANUAL
- user_roi_pos - Current position of the upper edge of the ROI in
the sensor lines.
- Access: read/write
- Type: uint32_t
- Max value: 1280
- Default value: 100
- Units: lines
- user_roi_maxPos - Maximum position of the upper limit of the
ROI in the current operating mode of the device.
- Access: read
- Type: uint32_t
- Max value: 1280
- Default value: 1180
- Units: lines
- user_roi_size - Sets the size of the area in the lines where
the profile is searched and processed.
- Access: read/write
- Type: uint32_t
- Min value: 8
- Max value: 488
- Step: 8
- Default value: 64
- Units: lines
- user_roi_reqProfSize - Minimum required number of profile
points for activating an ROI in ROI_POSITION_AUTO mode.
- Access: read/write
- Type: uint32_t
- Max value: 1280
- Step: 64
- Default value: 320
- Units: points
- user_roi_zsmr - ROI start position in mm.
- Access: read
- Type: float_t
- Max value: 10000
- Default value: 0
- Units: mm
- user_roi_zemr - ROI end position in mm.
- Access: read
- Type: float_t
- Max value: 10000
- Default value: 0
- Units: mm
- user_network_speed - Current Ethernet connection speed. The
connection speed is changed by writing to this parameter. In case of
auto-negotiation, writing is ignored.
- Access: read/write
- Type: uint32_t
- Min value: LINK_SPEED_10MBIT
- Max value: LINK_SPEED_1GBIT
- Enum:
- LINK_SPEED_10MBIT - the connection speed is 10 Mbs, currently
almost unused,
- LINK_SPEED_100MBIT - the connection speed is 100 Mbs,
- LINK_SPEED_1GBIT - the connection speed is 1000 Mbs
- Default value: LINK_SPEED_1GBIT
- Units: Mbps
- user_network_requiredSpeed - The required Ethernet connection
speed in the current device operation mode. Depends on the number of
profiles per second, the number of points in the profile, etc.
- Access: read
- Type: uint32_t
- Min value: 1
- Max value: 10000
- Default value: 1
- Units: Mbps
- user_network_autoNeg - Turns on and off the automatic
negotiation of the Ethernet connection speed.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: TRUE
- user_network_ip - The network address of the device.
- Access: read/write
- Type: u32_arr_t
- Max value: 255
- Max elements: 4,
- Default value: [192, 168, 1, 30]
- user_network_mask - Subnet mask for the device.
- Access: read/write
- Type: u32_arr_t
- Max value: 255
- Max elements: 4,
- Default value: [255, 255, 255, 0]
- user_network_gateway - Gateway address.
- Access: read/write
- Type: u32_arr_t
- Max value: 255
- Max elements: 4,
- Default value: [192, 168, 1, 1]
- user_network_hostIP - The network address of the device to
which profiles and calculation results are sent using the UDP
protocol.
- Access: read/write
- Type: u32_arr_t
- Max value: 255
- Max elements: 4,
- Default value: [192, 168, 1, 2]
- user_network_hostPort - The port number on the device to which
profiles and calculation results are sent over the UDP protocol.
- Access: read/write
- Type: uint32_t
- Max value: 65535
- Default value: 50001
- user_network_webPort - Port number to access the Web page.
- Access: read/write
- Type: uint32_t
- Max value: 65535
- Default value: 80
- user_network_servicePort - Port number for service protocol.
- Access: read/write
- Type: uint32_t
- Max value: 65535
- Default value: 50011
- user_streams_udpEnabled - Enabling and disabling the profile
stream, transmitted via the UDP protocol (sending to the network
address, set by the user_network_hostIP parameter and the port, set
by the user_network_hostPort parameter).
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_streams_format - The format of the transmitted profiles.
- Access: read/write
- Type: uint32_t
- Min value: DATA_FORMAT_RAW_PROFILE
- Max value: DATA_FORMAT_PROFILE
- Enum:
- DATA_FORMAT_RAW_PROFILE - the position of the points in the
profile is transferred without applying calibration data, in
subpixel values. Used for debugging and setting up the device,
allows to compare the image, generated by the CMOS-sensor and
the calculated profile position,
- DATA_FORMAT_PROFILE - the position of the points in the
profile is transmitted in discretes, the main format for the
operation of the device
- Default value: DATA_FORMAT_PROFILE
- user_streams_pointsCount - The number of points in the profile
that the device calculates and transmits.
- Access: read/write
- Type: uint32_t
- Min value: 648
- Max value: 1296
- Step: 648
- Default value: 648
- Units: points
- user_streams_includeIntensity - Enable or disable the transfer
of brightness points in the profile. The brightness values are
transferred after the profile data in the format of 1 byte per point,
0 - black … 255 - white.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_streams_udpPacketsCounter - Internal counter of
transmitted UDP packets with profiles. It can be used to control the
loss of packets with profiles.
- Access: read/write
- Type: uint32_t
- Default value: 0
- user_processing_threshold - Threshold of profile points
detection. Smaller values of the parameter allow detect the profile
at a lower brightness of the signal, which may cause false detections
on flare and reflections. Higher parameter values require higher
signal brightness, but provide confident detection of the profile
position.
- Access: read/write
- Type: uint32_t
- Max value: 100
- Default value: 2
- Units: %
- user_processing_profPerSec - The number of processed profiles
per second.
- Access: read
- Type: uint32_t
- Max value: 20000
- Default value: 490
- Units: pps
- user_processing_medianMode - Enable and width of median profile
filtering. The median filter allows remove random outliers and fill
the gaps in the profile with a width of up to half the size of the
filter.
- Access: read/write
- Type: uint32_t
- Max value: 15
- Enum:
- 0 - the filter is disabled,
- 3 - the filter is enabled, filter size is 3 points,
- 5 - the filter is enabled, filter size is 5 points,
- 7 - the filter is enabled, filter size is 7 points,
- 9 - the filter is enabled, filter size is 9 points,
- 11 - the filter is enabled, filter size is 11 points,
- 13 - the filter is enabled, filter size is 13 points,
- 14 - the filter is enabled, filter size is 15 points,
- Default value: 0
- user_processing_bilateralMode - Bilateral filter allows smooth
the values of the points of the profile, while maintaining its
sharp changes.
- Access: read/write
- Type: uint32_t
- Max value: 15
- Enum:
- 0 - the filter is disabled,
- 3 - the filter is enabled, filter size is 3 points,
- 5 - the filter is enabled, filter size is 5 points,
- 7 - the filter is enabled, filter size is 7 points,
- 9 - the filter is enabled, filter size is 9 points,
- 11 - the filter is enabled, filter size is 11 points,
- 13 - the filter is enabled, filter size is 13 points,
- 14 - the filter is enabled, filter size is 15 points,
- Default value: 0
- user_processing_peakMode - Profile peak detection mode for
position calculation. Used to ignore reflections and highlights.
- Access: read/write
- Type: uint32_t
- Min value: PEAK_MODE_INTENSITY
- Max value: PEAK_MODE_NUMBER_4
- Enum:
- PEAK_MODE_INTENSITY - the position of the profile points is
calculated at maximum intensity,
- PEAK_MODE_FIRST - the position of the profile points is
calculated from the first overstepping of the detection
threshold,
- PEAK_MODE_LAST - the position of the profile points is
calculated from the last overstepping of the detection
threshold,
- PEAK_MODE_NUMBER_2 - when calculating the position of
profile points, the advantage is given to peak #2,
- PEAK_MODE_NUMBER_3 - when calculating the position of
profile points, the advantage is given to peak #3,
- PEAK_MODE_NUMBER_4 - when calculating the position of
profile points, the advantage is given to peak #4
- Default value: PEAK_MODE_INTENSITY
- user_processing_flip - Profile reflection mode. Reflection
applies only if user_streams_format is set to
DATA_FORMAT_PROFILE.
- Access: read/write
- Type: uint32_t
- Min value: FLIP_MODE_OFF
- Max value: FLIP_MODE_XZ
- Enum:
- FLIP_MODE_OFF - no reflections,
- FLIP_MODE_X - reflection along the X axis,
- FLIP_MODE_Z - reflection along the Z axis,
- FLIP_MODE_XZ - reflection along the X and Z axis
- Default value: FLIP_MODE_OFF
- user_laser_enabled - Switching the laser radiation on and off.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_laser_value - Sets the brightness of the laser radiation.
- Access: read/write
- Type: uint32_t
- Max value: 100
- Step: 5
- Default value: 0
- Units: %
- user_trigger_sync_source - Selection of inputs and their
combinations for synchronization of measurements.
- Access: read/write
- Type: uint32_t
- Min value: TRIG_SOURCE_IN1
- Max value: TRIG_SOURCE_IN1_AND_IN2
- Enum:
- TRIG_SOURCE_IN1 - trigger measurements on an event at input
1,
- TRIG_SOURCE_IN2 - trigger measurements on an event at input
2,
- TRIG_SOURCE_IN1_OR_IN2 - trigger measurements on an event
at input 1 or input 2,
- TRIG_SOURCE_IN1_AND_IN2 - trigger measurements on an event
at input 1 and input 2
- Default value: TRIG_SOURCE_IN1
- user_trigger_sync_strictEnabled - Enable or disable strict
synchronization mode. When this mode is enabled, synchronization
events that occurred during a frame exposure will be ignored and the
next measurement will only be triggered by the synchronization event,
when the sensor has finished exposing the previous frame. In this
case, if the synchronization event rate is slightly higher than the
maximum frame rate of the sensor, the number of profiles per second
will be lower than the maximum frame rate due to the stroboscopic
effect. If the mode is off and there were synchronization events
during the exposure, the next measurement will start as soon as the
sensor finishes exposing the previous frame. In any situation, the
encoder value in the profile will be recorded at the middle of the
frame exposure.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_trigger_sync_divider - The synchronization event divider.
Does not affect the encoder counter.
- Access: read/write
- Type: uint32_t
- Min value: 1
- Max value: 8192
- Default value: 1
- user_trigger_sync_delay - The value of the delay in the start
of measurement (start of frame exposure) relative to the
synchronization event.
- Access: read/write
- Type: uint32_t
- Min value: 700
- Max value: 100000000
- Step: 100
- Default value: 700
- Units: ns
- user_trigger_sync_value - The value of the internal
measurement start counter. Shows the number of measurements taken.
- Access: read/write
- Type: uint32_t
- Default value: 0
- user_trigger_counter_type - Type of encoder counter (internal
pulse counter) at synchronization inputs.
- Access: read/write
- Type: uint32_t
- Min value: TRIG_COUNTER_UNIDIR
- Max value: TRIG_COUNTER_BIDIR
- Enum:
- TRIG_COUNTER_UNIDIR - unidirectional counter, that does not
take into account the phase of the signals at inputs 1 and 2,
- TRIG_COUNTER_BIDIR - bidirectional counter, that takes into
account the phase of the signals at inputs 1 and 2, and can
both increase and decrease
- Default value: TRIG_COUNTER_UNIDIR
- user_trigger_counter_maxValue - The maximum value of the
encoder counter, upon reaching which it is reset to the 0.
- Access: read/write
- Type: uint32_t
- Min value: 1
- Max value: 4294967295
- Default value: 4294967295
- user_trigger_counteraser_resetTimerEnabled - Enabling and
disabling the timer for automatically resetting the encoder counter
to 0. If the timer is enabled, then if no synchronization events
during the time, specified by the
user_trigger_counter_resetTimerValue parameter, the encoder
counter will be reset to 0.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_trigger_counter_resetTimerValue - Timeout value until the
encoder counter value is automatically reset to 0.
- Access: read/write
- Type: uint32_t
- Min value: 100
- Max value: 4294967295
- Step: 1000
- Default value: 4294967295
- Units: ns
- user_trigger_counter_value - Encoder counter value. This is an
internal event counter at inputs 1 and 2.
- Access: read/write
- Type: uint32_t
- Default value: 0
- user_trigger_counter_dir - The ratio of the phases of the
signals at inputs 1 and 2. Determines the direction of movement if
using a movement system.
- Access: read
- Type: uint32_t
- Default value: 0
- user_input1_enabled - Turning the input 1 on and off. If the
input is turned off, then all signals will be ignored.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_input1_mode - Input 1 operation mode. Defines which signal
change is a synchronization event for a given input.
- Access: read/write
- Type: uint32_t
- Min value: IN1_MODE_RISE_OR_FALL
- Max value: IN1_MODE_LVL0
- Enum:
- IN1_MODE_RISE_OR_FALL - the synchronization event is both
the transition from low to high state (edge of the pulse) and
from high to low state (fall of the pulse),
- IN1_MODE_RISE - the synchronization event is only the
transition from low to high state (edge of the pulse),
- IN1_MODE_FALL - the synchronization event is only the
transition from high to low (fall of the pulse),
- IN1_MODE_LVL1 - the synchronization event is a high level at
the input, measures starts from the internal generator,
- IN1_MODE_LVL0 - the synchronization event is a low level at
the input, measures starts from the internal generator
- Default value: IN1_MODE_RISE_OR_FALL
- user_input2_enabled - Turning the input 2 on and off. If the
input is turned off, then all signals will be ignored.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Default value: FALSE
- user_input2_mode - Input 2 operation mode. Defines which signal
change is a synchronization event for a given input.
- Access: read/write
- Type: uint32_t
- Min value: IN2_MODE_RISE_OR_FALL
- Max value: IN2_MODE_LVL0
- Enum:
- IN2_MODE_RISE_OR_FALL - the synchronization event is both
the transition from low to high state (edge of the pulse) and
from high to low state (fall of the pulse),
- IN2_MODE_RISE - the synchronization event is only the
transition from low to high state (edge of the pulse),
- IN2_MODE_FALL - the synchronization event is only the
transition from high to low (fall of the pulse),
- IN2_MODE_LVL1 - the synchronization event is a high level at
the input, measures starts from the internal generator,
- IN2_MODE_LVL0 - the synchronization event is a low level at
the input, measures starts from the internal generator
- Default value: IN2_MODE_RISE_OR_FALL
- user_input3_enabled - Turning the input 3 on and off. If the
input is turned off, then all signals will be ignored.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_input3_mode - Input 3 operation mode. This input is mainly
used to reset the encoder counter value.
- Access: read/write
- Type: uint32_t
- Min value: IN3_MODE_RISE
- Max value: IN3_MODE_FALL
- Enum:
- IN3_MODE_RISE - reset the encoder counter value at the rising
edge of the pulse at the input,
- IN3_MODE_FALL - reset the encoder counter value at the
falling edge of the pulse at the input
- Default value: IN3_MODE_RISE
- user_input1_samples - An array of signal values at input 1.
The parameter is a time scan of the signals at input 1. Every 2 bits
indicate the state of the signal at a certain point in time. Value
0b00 - low signal level, 0b01 - state changed (pulses), 0b10 -
reserved, 0b11 - high level.
- Access: read/write
- Type: u32_arr_t
- Max elements: 6,
- Default value: [0, 0, 0, 0, 0, 0]
- user_input2_samples - An array of signal values at input 2.
The parameter is a time scan of the signals at input 2. Every 2 bits
indicate the state of the signal at a certain point in time. Value
0b00 - low signal level, 0b01 - state changed (pulses), 0b10 -
reserved, 0b11 - high level.
- Access: read/write
- Type: u32_arr_t
- Max elements: 6,
- Default value: [0, 0, 0, 0, 0, 0]
- user_input3_samples - An array of signal values at input 3.
The parameter is a time scan of the signals at input 3. Every 2 bits
indicate the state of the signal at a certain point in time. Value
0b00 - low signal level, 0b01 - state changed (pulses), 0b10 -
reserved, 0b11 - high level.
- Access: read/write
- Type: u32_arr_t
- Max elements: 6,
- Default value: [0, 0, 0, 0, 0, 0]
- user_output1_enabled - Turning output 1 on and off. When turned
off, the output is low. In the on state, the signal is set by the
parameters user_output1_mode and user_output1_pulseWidth.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_output1_mode - Output 1 mode. Sets which signal will be
output.
- Access: read/write
- Type: uint32_t
- Min value: OUT_MODE_EXPOSE_START
- Max value: OUT_MODE_IN3_REPEATER
- Enum:
- OUT_MODE_EXPOSE_START - impulse at the moment the frame
starts to be exposed for the next measurement,
- OUT_MODE_EXPOSE_TIME - pulse during the exposure of the
frame for the next measurement,
- OUT_MODE_IN1_REPEATER - input 1 repeater, regardless of
whether the input is on or off,
- OUT_MODE_IN2_REPEATER - input 2 repeater, regardless of
whether the input is on or off,
- OUT_MODE_IN3_REPEATER - input 3 repeater, regardless of
whether the input is on or off
- Default value: OUT_MODE_EXPOSE_START
- user_output1_pulseWidth - Pulse width when
user_output1_mode parameter has value OUT_MODE_EXPOSE_START.
- Access: read
- Type: uint32_t
- Min value: 10
- Max value: 1000000
- Step: 10
- Default value: 1000
- Units: ns
- user_output2_enabled - Turning output 2 on and off. When turned
off, the output is low. In the on state, the signal is set by the
parameters user_output2_mode and user_output2_pulseWidth.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_output2_mode - Output 2 mode. Sets which signal will be
output.
- Access: read/write
- Type: uint32_t
- Min value: OUT_MODE_EXPOSE_START
- Max value: OUT_MODE_IN3_REPEATER
- Enum:
- OUT_MODE_EXPOSE_START - impulse at the moment the frame
starts to be exposed for the next measurement,
- OUT_MODE_EXPOSE_TIME - pulse during the exposure of the
frame for the next measurement,
- OUT_MODE_IN1_REPEATER - input 1 repeater, regardless of
whether the input is on or off,
- OUT_MODE_IN2_REPEATER - input 2 repeater, regardless of
whether the input is on or off,
- OUT_MODE_IN3_REPEATER - input 3 repeater, regardless of
whether the input is on or off
- Default value: OUT_MODE_EXPOSE_START
- user_output2_pulseWidth - Pulse width when
user_output2_mode parameter has value OUT_MODE_EXPOSE_START.
- Access: read
- Type: uint32_t
- Min value: 10
- Max value: 1000000
- Step: 10
- Default value: 1000
- Units: ns
- user_dump_enabled - Enabling profile recording in the internal
memory of the device - forming a dump. The recording will be stopped
when the maximum dump capacity is reached, either when
user_dump_capacity is reached or when FALSE is written to this
parameter. Before starting the dump recording,
user_trigger_sync_value and user_trigger_counter_value counters
will be reset to 0.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_dump_capacity - User-defined number of profiles to be
dumped. Upon reaching this value, the recording will automatically
stop and the value of the user_dump_enabled parameter will
become FALSE.
- Access: read/write
- Type: uint32_t
- Min value: 1
- Max value: 80000
- Default value: 80000
- Units: profiles
- user_dump_size - The current number of profiles in the dump.
Before starting dump recording, this value is reset to 0. During dump
recording, this value increases.
- Access: read
- Type: uint32_t
- Max value: 80000
- Default value: 0
- Units: profiles
- user_dump_timeStamp - The time stamp of the dump. Setted by the
device when the dump recording starts.
- Access: read
- Type: uint64_t
- Default value: 0
- Units: ticks
- user_dump_view3d_motionType - Type of movement system on which
the device is installed. The value of the parameter is used to
correctly draw the dump as a 3D model.
- Access: read/write
- Type: uint32_t
- Min value: MOTION_TYPE_LINEAR
- Max value: MOTION_TYPE_RADIAL
- Enum:
- MOTION_TYPE_LINEAR - linear motion system,
- MOTION_TYPE_RADIAL - radial motion system
- Default value: MOTION_TYPE_LINEAR
- user_dump_view3d_ySource - Source of the Y-axis coordinates.
The value of the parameter is used to correctly draw the dump as a 3D
model.
- Access: read/write
- Type: uint32_t
- Min value: Y_AXIS_SYSTEM_TIME
- Max value: Y_AXIS_MEASURES_COUNTER
- Enum:
- Y_AXIS_SYSTEM_TIME - internal device timer,
- Y_AXIS_STEP_COUNTER - parameter
user_trigger_counter_value,
- Y_AXIS_MEASURES_COUNTER - measurements counter
- Default value: Y_AXIS_SYSTEM_TIME
- user_dump_view3d_yStep - The value of a single step in the
Y-axis.
- Access: read/write
- Type: double_t
- Max value: 10000
- Default value: 0.0005
- Units: mm
- user_dump_view3d_paintMode - 3D model coloring mode. This
parameter is used when drawing a 3D model in the WEB-interface.
- Access: read/write
- Type: uint32_t
- Min value: PAINT_MODE_HEIGHTMAP
- Max value: PAINT_MODE_INTENSITY
- Enum:
- PAINT_MODE_HEIGHTMAP - coloring according to the height map,
- PAINT_MODE_INTENSITY - intensity mapping, parameter
user_streams_includeIntensity must be set to TRUE,
- Default value: PAINT_MODE_HEIGHTMAP
- user_dump_view3d_decimation - Profiles decimation when drawing
a 3D model. This parameter is used when drawing a 3D model in the
WEB-interface.
- Access: read/write
- Type: uint32_t
- Min value: DUMP_VIEW3D_DECIM_1
- Max value: DUMP_VIEW3D_DECIM_200
- Enum:
- DUMP_VIEW3D_DECIM_1 - all dump profiles are displayed,
- DUMP_VIEW3D_DECIM_2 - step to display dump profiles 2,
- DUMP_VIEW3D_DECIM_5 - step to display dump profiles 5,
- DUMP_VIEW3D_DECIM_10 - step to display dump profiles 10,
- DUMP_VIEW3D_DECIM_20 - step to display dump profiles 20,
- DUMP_VIEW3D_DECIM_50 - step to display dump profiles 50,
- DUMP_VIEW3D_DECIM_100 - step to display dump profiles 100,
- DUMP_VIEW3D_DECIM_200 - step to display dump profiles 200,
- Default value: DUMP_VIEW3D_DECIM_1
- user_eip_tcpPort - The port number that the device listens for
incoming TCP connections via EthernetIP.
- Access: read/write
- Type: uint32_t
- Max value: 65535
- Default value: 44818
- user_eip_udpPort - The port number that the device listens for
UDP packets with EthernetIP data.
- Access: read/write
- Type: uint32_t
- Max value: 65535
- Default value: 2222
- user_compatibility_rf625Enabled - Enable or disable
compatibility mode with the obsolete RF625 scanner. When enabling
compatibility mode, UDP profile stream will be suspended.
- Access: read/write
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
- user_compatibility_rf625TCPPort - Port number for incoming TCP
connections via RF625 protocol.
- Access: read/write
- Type: uint32_t
- Max value: 65535
- Default value: 620
Factory¶
- fact_general_firmwareVer - Device firmware version [Major,
Minor, Patch].
- Access: read
- Type: u32_arr_t
- Max elements: 3,
- Default value: [1, 0, 0]
- fact_general_hardwareVer - Device hardware version.
- Access: read
- Type: uint32_t
- Default value: 403051520
- fact_general_deviceType - Device type identifier.
- Access: read/awrite
- Type: uint32_t
- Max value: 65535
- Default value: 627
- fact_general_serial - Device serial number.
- Access: read/awrite
- Type: uint32_t
- Default value: 0
- fact_general_pcbSerial - Device PCB serial number.
- Access: read/awrite
- Type: uint32_t
- Default value: 0
- fact_general_lifeTime - Total device runtime in UNIX format.
- Access: read/awrite
- Type: uint32_t
- Max value: 1577846300
- Default value: 0
- Units: s
- fact_general_workTime - Device uptime in UNIX format.
- Access: read/awrite
- Type: uint32_t
- Max value: 1577846300
- Default value: 0
- Units: s
- fact_general_startsCount - Total number of device starts.
- Access: read/awrite
- Type: uint32_t
- Max value: 8760
- Default value: 0
- Units: times
- fact_general_customerID - Device customer identifier. The
identifier of the company that purchased / ordered the device.
- Access: read/awrite
- Type: uint32_t
- Default value: 0
- Units: id
- fact_general_fpgaFreq - FPGA project clock frequency for this
device.
- Access: read/awrite
- Type: uint32_t
- Min value: 10000000
- Max value: 500000000
- Default value: 10000000
- Units: Hz
- fact_general_smr - Start of measuring range in Z axis in mm.
- Access: read/awrite
- Type: uint32_t
- Max value: 10000
- Default value: 80
- Units: mm
- fact_general_mr - Size of the measuring range in Z axis in mm.
- Access: read/awrite
- Type: uint32_t
- Max value: 10000
- Default value: 130
- Units: mm
- fact_general_xsmr - The size along the X axis of the measuring
range at the beginning of the range.
- Access: read/awrite
- Type: uint32_t
- Max value: 10000
- Default value: 40
- Units: mm
- fact_general_xemr - The size along the X axis of the measuring
range at the end of the range.
- Access: read/awrite
- Type: uint32_t
- Max value: 10000
- Default value: 40
- Units: mm
- fact_general_pixDivider - Divider to obtain the subpixel
position of profile points in the uncalibrated data transfer mode
(parameter user_streams_format is set to
DATA_FORMAT_RAW_PROFILE).
- Access: read
- Type: uint32_t
- Max value: 65535
- Default value: 32
- fact_general_profDivider - Divider to obtain the subpixel
position of profile points in the calibrated data transfer mode
(parameter user_streams_format is set to
DATA_FORMAT_PROFILE).
- Access: read
- Type: uint32_t
- Max value: 65535
- Default value: 16384
- fact_general_oemDevName - Device name assigned by the OEM
customer.
- Access: read/awrite
- Type: string_t
- Max len: 128
- Default value: «Laser scanner»
- fact_general_authStatus - Authorization status for changing the
factory settings of the device.
- Access: read
- Type: uint32_t
- Min value: AUTH_STATUS_USER
- Max value: AUTH_STATUS_FACTORY
- Enum:
- AUTH_STATUS_USER - authorized as a user, factory settings
cannot be changed,
- AUTH_STATUS_FACTORY - authorized as a manufacturer, factory
settings can be changed
- Default value: AUTH_STATUS_USER
- fact_sensor_name - Name of the sensor used in the device.
- Access: read/awrite
- Type: string_t
- Max len: 64
- Default value: «TYPE 1»
- fact_sensor_width - Number of pixels in the CMOS sensor.
- Access: read/awrite
- Type: uint32_t
- Min value: 648
- Max value: 648
- Default value: 648
- Units: pixels
- fact_sensor_height - Number of lines in the CMOS sensor.
- Access: read/awrite
- Type: uint32_t
- Min value: 488
- Max value: 488
- Default value: 488
- Units: lines
- fact_sensor_pixFreq - Pixel frequency for installed CMOS
sensor.
- Access: read/awrite
- Type: uint32_t
- Min value: 1000000
- Max value: 500000000
- Default value: 40000000
- Units: Hz
- fact_sensor_frmConstPart - Constant part of the frame cycle.
- Access: read/awrite
- Type: uint32_t
- Min value: 200
- Max value: 200000
- Default value: 3500
- Units: ticks
- fact_sensor_frmPerLinePart - Frame cycle part for each line.
- Access: read/awrite
- Type: uint32_t
- Min value: 10
- Max value: 100000
- Default value: 160
- Units: ticks
- fact_sensor_minExposure - Minimum allowable exposure value.
- Access: read/awrite
- Type: uint32_t
- Max value: 100000000
- Step: 10
- Default value: 3000
- Units: ns
- fact_sensor_maxExposure - Maximum allowable exposure value.
- Access: read/awrite
- Type: uint32_t
- Max value: 300000000
- Step: 10
- Default value: 300000000
- Units: ns
- fact_sensor_imgFlip - Image reflection mode. Applies directly
to the image transmitted, by the CMOS sensor.
- Access: read/awrite
- Type: uint32_t
- Min value: FLIP_MODE_OFF
- Max value: FLIP_MODE_XZ
- Enum:
- FLIP_MODE_OFF - no reflections,
- FLIP_MODE_X - reflection along the X axis,
- FLIP_MODE_Z - reflection along the Z axis,
- FLIP_MODE_XZ - reflection along the X and Z axis
- Default value: FLIP_MODE_OFF
- fact_sensor_analogGain - CMOS sensor analog gain value.
- Access: read/awrite
- Type: uint32_t
- Max value: 7
- Default value: 5
- fact_sensor_digitalGain - CMOS sensor digital gain value.
- Access: read/awrite
- Type: uint32_t
- Max value: 55
- Default value: 48
- fact_sensor_blackOdd - Black level for odd lines.
- Access: read/awrite
- Type: uint32_t
- Max value: 65535
- Default value: 2300
- fact_sensor_blackEven - Black level for even lines.
- Access: read/awrite
- Type: uint32_t
- Max value: 65535
- Default value: 2400
- fact_network_initRegs - CMOS sensor registers values [regAddr,
regValue …].
- Access: read/awrite
- Type: u32_arr_t
- Max value: 255
- Max elements: 64,
- Default value: [41, 1, 83, 155, 58, 20, 59, 0, 60, 11, 69, 9,
80, 4, 97, 0, 98, 12, 101, 98, 102, 34, 103, 64, 106, 90, 107,
110, 108, 91, 109, 82, 110, 80, 117, 91]
- fact_network_macAddr - Physical address of the device.
- Access: read/awrite
- Type: u32_arr_t
- Max value: 255
- Max elements: 6,
- Default value: [0x00, 0x0A, 0x35, 0x01, 0x02, 0x03]
- fact_network_forceAutoNegTime - The time after which the
auto-negotiation of the Ethernet connection will be forced if the
connection is not established.
- Access: read/awrite
- Type: uint32_t
- Max value: 255
- Default value: 5
- Units: s
- fact_network_webSockServicePort - Port number for the service
data transmission WEB-socket. Used by the Web-page.
- Access: read/awrite
- Type: uint32_t
- Min value: 16384
- Max value: 65535
- Default value: 50002
- fact_network_webSockDataPort - Port number for the large data
transmission WEB-socket. Used by the Web-page.
- Access: read/awrite
- Type: uint32_t
- Min value: 16384
- Max value: 65535
- Default value: 50003
- fact_network_webSockMathPort - Port number for the math data
transmission WEB-socket. Used by the Web-page.
- Access: read/awrite
- Type: uint32_t
- Min value: 16384
- Max value: 65535
- Default value: 50004
- fact_laser_waveLength - The wavelength of the laser, installed
in the device.
- Access: read/awrite
- Type: uint32_t
- Max value: 10000
- Default value: 650
- Units: nm
- fact_laser_minValue - Minimum DAC value. At this value, the
laser stops emitting light.
- Access: read/awrite
- Type: uint32_t
- Max value: 4095
- Default value: 0
- fact_laser_maxValue - Maximum DAC value. At this value, the
laser starts to emit light with maximum power.
- Access: read/awrite
- Type: uint32_t
- Max value: 4095
- Default value: 4095
- fact_eip_identity_vendorID - Identification number for the
manufacturer of an EtherNet/IP device.
- Access: read
- Type: uint32_t
- Default value: 1588
- fact_eip_identity_deviceType - The list of device types is
managed by ODVA and CI. It is used to identify the device profile
that a particular product is using.
- Access: read
- Type: uint32_t
- Max value: 65535
- Default value: 0x2B
- fact_eip_identity_productCode - Product identifier according
to developer documentation.
- Access: read
- Type: uint32_t
- Default value: 627
- fact_eip_identity_rev - The Revision attribute, which consists
of major and minor revisions, identifies the revision of the item the
Identity Object is representing.
- Access: read
- Type: u32_arr_t
- Max value: 255
- Max elements: 2,
- Default value: [1, 0]
- fact_eip_identity_status - Represents the current status of
the entire device. Its value changes as the state of the device
changes.
- Access: read
- Type: uint32_t
- Enum:
- Owned - the device (or an object within the device) has an
owner,
- Configured - the application of the device has been configured
to do something different than the “out–of–box” default,
- Minor Recoverable Fault - the device detected a problem with
itself, which is thought to be recoverable. The problem does
not cause the device to go into one of the faulted states,
- Minor Unrecoverable Fault- the device detected a problem with
itself, which is thought to be unrecoverable. The problem does
not cause the device to go into one of the faulted states,
- Major Recoverable Fault - the device detected a problem with
itself, which caused the device to go into the “Major
Recoverable Fault” state,
- Major Unrecoverable Fault - the device detected a problem with
itself, which caused the device to go into the “Major
Unrecoverable Fault” state
- Default value: 0
- fact_eip_tcpIntrf_status - is a bitmap that shall indicate the
status of the TCP/IP network interface.
- Access: read
- Type: uint32_t
- Enum:
- No configured - The Interface Configuration attribute has not
been configured,
- Configured - The Interface Configuration attribute contains
configuration obtained from BOOTP, DHCP or nonvolatile storage,
- Hardware Configured - The IP address member of the Interface
Configuration attribute contains configuration, obtained from
hardware settings,
- Mcast Pending - Indicates a pending configuration change in the
TTL Value and/or Mcast Config attributes,
- Interface Configuration Pending - Indicates a pending
configuration change in the Interface Configuration attribute,
- Address Conflict Detection Status - Indicates when an IP
address conflict has been detected by ACD
- Default value: 0
- fact_eip_tcpIntrf_capability - is a bitmap that indicates the
device’s support for optional network configuration capability.
- Access: read
- Type: uint32_t
- Enum:
- BOOTP Client - the device is capable of obtaining its network
configuration via BOOTP,
- DNS Client - the device is capable of resolving host names by
querying a DNS server,
- DHCP Client - the device is capable of obtaining its network
configuration via DHCP,
- Configuration Settable - the Interface Configuration attribute
is settable,
- Hardware Configurable - the IP Address member of the Interface
Configuration attribute can be obtained from hardware settings
(e.g., pushwheel, thumbwheel, etc.),
- Interface Configuration Change Requires Reset - the device
requires a restart in order for a change to the Interface
Configuration attribute to take effect,
- Address Conflict Detection Capable - the device is capable of
ACD
- Default value: 0x14
- fact_eip_tcpIntrf_control - is a bitmap used to control
network configuration options.
- Access: read
- Type: uint32_t
- Enum:
- Static ip mode - The device shall use statically-assigned IP
configuration values,
- BOOTP mode - The device shall obtain its interface
configuration values via BOOTP,
- DHCP mode - The device shall obtain its interface configuration
values via DHCP
- DNS Enable - the device shall resolve host names by querying a
DNS server
- Default value: 0
- fact_eip_tcpIntrf_phyLink - identifies the object associated
with the underlying physical communications interface (e.g., an 802.3
interface).
- Access: read
- Type: u32_arr_t
- Max value: 255
- Max elements: 6
- Default value: [0x20, 0xF6, 0x24, 0x01]
- fact_eip_tcpIntrf_inactTimeout - is used to enable TCP socket
cleanup (closing) when the defined number of seconds have elapsed
with no Encapsulation activity.
- Access: read/awrite
- Type: uint32_t
- Max value: 255
- Default value: 120
- fact_smart_enabled - Turn on and off the capabilities of a
smart device.
- Access: read/awrite
- Type: uint32_t
- Min value: FALSE
- Max value: TRUE
- Default value: FALSE
WEB API v1¶
Using the easy-to-use WEB API, the user can get information about the device, read or write the value of the parameter. Also, through the WEB API, the device can execute some commands. A complete list of commands supported through this access is given in the description of the commands. The WEB API examples use the factory IP address of the device and presented as they should be typed in the address bar of the browser. If it has been changed by the user, the IP address of the device should be used.
Quick device info¶
- /hello - Getting general information about the device in JSON
format.
- GET:
- 192.168.1.30/hello
- /api/v1/config/commands - Getting the list of commands, supported
by the device. The formalized description will contain the command
name, WEB API access capability, command identifier and access mode.
- GET:
- 192.168.1.30/api/v1/config/commands
- /api/v1/config/returnCodes - Getting a text description of the
codes of operation results and errors, returned by the device.
- GET:
- 192.168.1.30/api/v1/config/returnCodes
Device 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, for arrays - the maximum number of elements.
- GET:
- 192.168.1.30/api/v1/config/params
- /api/v1/config/params/values - Reading and writing values of
the device parameters. For reading it is possible to request specific
parameters by name or index. To write a parameter, it is necessary to
form a «PUT» request with the parameters «parameter_name:value».
- 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
- PUT:
- 192.168.1.30/api/v1/config/params/values?user_sensor_framerate=100&user_sensor_exposure1=100000
- /api/v1/sensor - Reading and writing CMOS-sensor registers.
- GET:
- 192.168.1.30/api/v1/sensor?reg=0x5B&val=0x003F
- 192.168.1.30/api/v1/sensor?index=0®=0x5B&val=0x003F
- PUT:
- 192.168.1.30/api/v1/sensor?reg=0x5B&val=0x003F
- 192.168.1.30/api/v1/sensor?index=0®=0x5B&val=0x003F
Save, restore and reboot¶
- /api/v1/config/params/save - Saving the current values of the
device parameters in non-volatile memory in user area. Saved values
will be used when the device is switched on again.
- 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 when parameters from the user area are damaged.
- GET:
- 192.168.1.30/api/v1/config/params/restore/save
- /api/v1/config/params/restore/load - Loading device parameter
values from the recovery area. The loaded values will be written to
the user area, the device will be automatically rebooted.
- GET:
- 192.168.1.30/api/v1/config/params/restore/load
- /api/v1/reboot - Reboot the device. The parameters will be loaded
from the user area (if they are not damaged).
- GET:
- 192.168.1.30/api/v1/reboot
Log¶
- /api/v1/log - Getting a log of the device with full description
of records.
- GET:
- 192.168.1.30/api/v1/log
- /api/v1/log/content - Getting the device log in an abbreviated
form - is easier to read.
- GET:
- 192.168.1.30/api/v1/log/content
Authorization¶
- /api/v1/authorization - Authorization on the device as a
manufacturer - allows editing factory parameters of the device. Using
the «GET» request, get a token for which generate a key and send to
the device in the «PUT» request.
- GET:
- 192.168.1.30/api/v1/authorization
- PUT:
- 192.168.1.30/api/v1/authorization?key=230d84e16c0dae529098f1f1bb…..
COMMANDS¶
The commands transmitted to the device are intended for searching devices in the network, reading and setting parameters, downloading service data, firmware upgrade, receiving frames generated by CMOS-sensor and other functions. The commands and their answers are given in the service protocol (in the current revision, RF627 protocol). The service protocol uses UDP packets sent to the device’s network address (parameter user_network_ip) and the service port (parameter user_network_servicePort).
General device commands¶
- HELLO_JSON_REQUEST - Search for devices on the network. In
answer to the command, JSON will be sent with a description of the
main parameters of the device.
- URI: /hello
- CID: 0x0010
- Access: unlocked
- Command payload: no
- Answer payload: JSON
- PARAMS_DESCRIPTION_REQUEST - 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, for arrays - the maximum number of elements.
- URI: /api/v1/config/params
- CID: 0x0110
- Access: unlocked
- Command payload: no
- Answer payload: JSON
- COMMANDS_DESCRIPTION_REQUEST - Getting the list of commands,
supported by the device. The formalized description will contain the
command name, WEB API access capability, command identifier and
access mode.
- URI: /api/v1/config/commands
- CID: 0x0210
- Access: unlocked
- Command payload: no
- Answer payload: JSON
- PARAMS_VALUES_JSON_REQUEST - Reading values of the device
parameters. For reading it is possible to request specific parameters
by name or index.
- URI: /api/v1/config/params/values
- CID: 0x0310
- Access: unlocked
- Command payload: JSON [name:XXXX, name:XXXX, index:XXXX…]
- Answer payload: JSON [name:value, name:value, name:value…]
- PARAMS_VALUES_JSON_WRITE - Writing values of the device
parameters, it is necessary to send the parameters in form of pair
«parameter_name:value».
- CID: 0x1010
- Access: unlocked
- Command payload: JSON [name:value, name:value, index:value…]
- Answer payload: JSON [name:OK, name:OK, name:OK…]
- PARAMS_VALUES_BIN_REQUEST - Reading parameter values in binary
form. Each parameter will be stacked according to its index and size.
- CID: 0x0410
- Access: unlocked
- Command payload: no
- Answer payload: BIN
- RETURN_CODES_JSON_REQUEST - Getting a text description of the
codes of operation results and errors, returned by the device.
- URI: /api/v1/config/returnCodes
- CID: 0x2010
- Access: unlocked
- Command payload: no
- Answer payload: JSON
- PARAMS_SAVE - Saving the current values of the device parameters
in non-volatile memory in user area. Saved values will be used when
the device is switched on again.
- URI: /api/v1/config/params/save
- CID: 0x0510
- Access: unlocked
- Command payload: no
- Answer payload: JSON [result:OK]
- PARAMS_RESTORE_SAVE - Saving the current values of the device
parameters in the recovery area. These parameters will be applied
when parameters from the user area are damaged.
- URI: /api/v1/config/params/restore/save
- CID: 0x0610
- Access: unlocked
- Command payload: no
- Answer payload: JSON [result:OK]
- PARAMS_RESTORE_LOAD - Loading device parameter values from the
recovery area. The loaded values will be written to the user area,
the device will be automatically rebooted.
- URI: /api/v1/config/params/restore/load
- CID: 0x0710
- Access: unlocked
- Command payload: no
- Answer payload: JSON [result:OK]
- AUTHORIZATION_REQUEST - Authorization on the device as a
manufacturer - allows editing factory parameters of the device.
- URI: /api/v1/authorization
- CID: 0x2110
- Access: unlocked
- Command payload: no/key
- Answer payload: JSON
Calibration file¶
- CALIB_FILE_DATA_WRITE - Writing a fragment of a calibration
file into a device.
- CID: 0x1052
- Access: unlocked
- Command payload: BIN (uint32_t: offset; uint8_t: data[])
- Answer payload: no
- CALIB_FILE_CRC16_REQUEST - Getting the checksum of the
calibration file, uploaded to the device.
- CID: 0x1252
- Access: unlocked
- Command payload: no
- Answer payload: BIN (uint16_t: CRC)
- CALIB_FILE_SAVE - Saving the calibration file in a non-volatile
memory of the device.
- CID: 0x2052
- Access: unlocked
- Command payload: no
- Answer payload: no
Profiles request¶
- PROFILE_CAPTURE - Command to start measurement. It is used only
in the software measurement start mode (parameter
user_sensor_syncSource = SYNC_SOFTWARE). When the command is
received, the device starts the cycle of measurement, after that, the
profile is calculated and a standard package with the profile is
sent.
- CID: 0x0459
- Access: unlocked
- Command payload: BIN (uint32_t: count (max: 16777215))
- Answer payload: no
- PROFILE_REQUEST - The command to read the last calculated
profile. The profile will be transferred in the payload of the
service protocol message.
- CID: 0x0559
- Access: unlocked
- Command payload: no
- Answer payload: BIN
Dump request¶
- DUMP_CONTENT_REQUEST - Request the contents of the profile
dump.
- CID: 0x2259
- Access: unlocked
- Command payload: BIN (uint32_t: index; uint32_t: count)
- Answer payload: BIN
Frame request¶
- FRAME_REQUEST - Request one frame of the image, exposed by the
CMOS sensor.
- CID: 0x1083
- Access: unlocked
- Command payload: BIN (uint32_t: index; uint32_t: count)
- Answer payload: BIN (uint32_t: offset; uint8_t: data[])
Log request¶
- LOG_PART_REQUEST - Request a part of the device log file with a
full description of the entries.
- URI: /api/v1/log
- CID: 0x0357
- Access: unlocked
- Command payload: JSON {index: XXX, count: XXX}
- Answer payload: JSON
- LOG_CONTENT_REQUEST - Request the device log in an abbreviated
form - is easier to read.
- URI: /api/v1/log/content
- CID: 0x0457
- Access: unlocked
- Command payload: no
- Answer payload: JSON
Internal non-volatile memory¶
- FLASH_ERASE - Cleaning of the internal non-volatile memory of
the device (execution of the command may lead to inoperability of the
device). The command arguments are the start address of the erase
area and the size of the erase area. The address must be aligned to
65536 bytes and the size is a multiple of 65536 bytes.
- CID: 0x005A
- Access: locked
- Command payload: BIN (uint32_t: addr; uint32_t: size}
- Answer payload: no
- FLASH_FIRMWARE_READ - Reading the firmware of the device.
- CID: 0x1A5A
- Access: unlocked
- Command payload: no
- Answer payload: BIN (uint32_t: offset; uint8_t: data[])
- FLASH_FIRMWARE_WRITE - Write device firmware.
- CID: 0x205A
- Access: unlocked
- Command payload: BIN (uint32_t: offset; uint8_t: data[])
- Answer payload: no
- FLASH_FIRMWARE_CRC16_REQUEST - Request the checksum of the
firmware that has been uploaded to the device. The request must be
made before writing the firmware to the internal non-volatile memory
of the device.
- CID: 0x215A
- Access: unlocked
- Command payload: no
- Answer payload: BIN (uint16_t: CRC)
- FLASH_FIRMWARE_SAVE - Saving the loaded firmware to the
internal non-volatile memory of the device. A checksum (command
FLASH_FIRMWARE_CRC16_REQUEST) must be requested before saving.
- CID: 0x225A
- Access: unlocked
- Command payload: no
- Answer payload: no
Device to Web-page notification¶
- FLASH_FIRMWARE_SAVE - With this command, the device notifies
the Web-page of various internal events: status changes, warnings,
errors.
- CID: 0x1063
- Access: locked
- Command payload: JSON {time: XXX, type:
(NTF_INFO/NTF_WARN/NTF_ERR), message: TEXT}
- Answer payload: no
Periphery commands¶
- PERIPHERY_TRANSFER - Transfer of data to and from connected
peripheral devices.
- CID: 0x1080
- Access: unlocked
- Command payload: BIN
- Answer payload: BIN