REST API

Summary

This API is used for working with the Magellan 9900i/9600i and any attached Top Down Reader (TDR) or Color Camera Modules (CCM). Images and video can be captured as well as imformation and statistics about the scanner and satellite cameras

In addition to the REST API, there is a asynchronous Websocket used to provide real time even information. For details of the Websocket, see the Event API.

Server:

Private 9600i/9900i Server
The API is accessed from the base scanner device. URL: https://datalogic-base-SERIAL_NUMBER.local/api/1.0.0
where SerialNumber is the serial number of the scanner.

note

Unexpected URL parameters and request bodies are ignored.

Paths:

`get` /scanner_component:

Get all information, status, and statistics from all components

Operation ID: scanner_component

Responses:

200 Information, status, and statistics from all components #/components/schemas/AllInfo
400 Bad input parameter
500 Internal server error
503 Service unavailable

Example (using curl):

curl -i --insecure --cert magellan_sdk_client.pem --get https://datalogic-base-F24H01847.local:443/api/1.0.0/scanner_component	
{
	"request" : "/api/1.0.0/scanner_component",
	"values" : 
	[
		{
			"label" : "base/cpu/temperature",
			"value" : 70
		},
		{
			"label" : "base/cpu/temperature/max",
			"value" : 74
		},
		{
			"label" : "base/cpu/temperature/min",
			"value" : 65
		},
		{
			"label" : "base/eas/deactivation",
			"value" : 0
		},
		{
			"label" : "base/eas/deactivation/manual",
			"value" : 0
		},
		{
			"label" : "base/eas/io/fault",
			"value" : 0
		},
		{
			"label" : "base/eas/io/timeout",
			"value" : 0
		},
		{
			"label" : "base/eas/runtime/fault",
			"value" : 0
		},
		{
			"label" : "base/eas/tag",
			"value" : 0
		},
		{
			"label" : "base/ethernet/ports",
			"value" : 0
		},
		{
			"label" : "base/ethernet/ports/used",
			"value" : 0
		},
		{
			"label" : "base/hhs/statuses",
			"value" : 0
		},
		{
			"label" : "base/imagers/status",
			"value" : 
			[
				"OK",
				"OK",
				"OK",
				"OK"
			]
		},
		{
			"label" : "base/imagers/temperature",
			"value" : 
			[
				45,
				46,
				43,
				42
			]
		},
		{
			"label" : "base/imagers/temperature/max",
			"value" : 
			[
				49,
				51,
				47,
				46
			]
		},
		{
			"label" : "base/imagers/temperature/min",
			"value" : 
			[
				42,
				42,
				41,
				40
			]
		},
		{
			"label" : "base/mainboard/storage/available",
			"value" : 695787520
		},
		{
			"label" : "base/mainboard/storage/total",
			"value" : 1502240768
		},
		{
			"label" : "base/object_sense",
			"value" : 0
		},
		{
			"label" : "base/power_on/events",
			"value" : 77
		},
		{
			"label" : "base/power_on/time",
			"value" : 1102
		},
		{
			"label" : "base/resets",
			"value" : 108
		},
		{
			"label" : "base/resets/errors",
			"value" : 0
		},
		{
			"label" : "base/satellite",
			"value" : 2
		},
		{
			"label" : "base/scale",
			"value" : true
		},
		{
			"label" : "base/scale/calibration",
			"value" : 0
		},
		{
			"label" : "base/scale/sentry/activation",
			"value" : 0
		},
		{
			"label" : "base/scale/sentry/deactivation",
			"value" : 0
		},
		{
			"label" : "base/scale/zero/button",
			"value" : 6
		},
		{
			"label" : "base/scale/zero/pos",
			"value" : 0
		},
		{
			"label" : "base/scale/zero/required",
			"value" : 0
		},
		{
			"label" : "base/sdcard/storage/available",
			"value" : 0
		},
		{
			"label" : "base/sdcard/storage/total",
			"value" : 0
		},
		{
			"label" : "base/tpu/status",
			"value" : "FAIL"
		},
		{
			"label" : "base/tpu/temperature",
			"value" : 
			[
				0,
				0
			]
		},
		{
			"label" : "base/tpu/temperature/max",
			"value" : 0
		},
		{
			"label" : "base/tpu/temperature/min",
			"value" : 0
		},
		{
			"label" : "base/uptime",
			"value" : 171659
		},
		{
			"label" : "base/usb/drives/storage/available",
			"value" : 
			[
				0,
				0
			]
		},
		{
			"label" : "base/usb/drives/storage/total",
			"value" : 
			[
				0,
				0
			]
		},
		{
			"label" : "base/imagers/labels_read/1d",
			"value" : 
			[
				89,
				57
			]
		},
		{
			"label" : "base/imagers/labels_read/2d",
			"value" : 
			[
				4,
				6
			]
		},
		{
			"label" : "base/imagers/labels_read/dwm",
			"value" : 
			[
				0,
				0
			]
		},
		{
			"label" : "base/labels_read",
			"value" : 254
		},
		{
			"label" : "base/labels_read/1d",
			"value" : 146
		},
		{
			"label" : "base/labels_read/1d/stitched",
			"value" : 98
		},
		{
			"label" : "base/labels_read/2d",
			"value" : 10
		},
		{
			"label" : "base/labels_read/dwm",
			"value" : 0
		},
		{
			"label" : "base/labels_read/hhs",
			"value" : 0
		},
		{
			"label" : "base/application",
			"value" : "XFA-0068"
		},
		{
			"label" : "base/configuration",
			"value" : "DR9611556 \u0005"
		},
		{
			"label" : "base/dwm",
			"value" : "3.10.2 - 20210707131523"
		},
		{
			"label" : "base/ec_level",
			"value" : "0068"
		},
		{
			"label" : "base/evl",
			"value" : "2.3.7.22"
		},
		{
			"label" : "base/formatter",
			"value" : "3.19"
		},
		{
			"label" : "base/fpga",
			"value" : "0a02"
		},
		{
			"label" : "base/hardware_id",
			"value" : "9900"
		},
		{
			"label" : "base/interface",
			"value" : "05"
		},
		{
			"label" : "base/mainboard/model_number",
			"value" : "-MbMN-"
		},
		{
			"label" : "base/mainboard/serial_number",
			"value" : "-MbMN-"
		},
		{
			"label" : "base/model_number",
			"value" : "99113102735-G00560"
		},
		{
			"label" : "base/scale/version",
			"value" : "T1BA"
		},
		{
			"label" : "base/serial_number",
			"value" : "F24H01847"
		},
		{
			"label" : "tdr/cpu/temperature",
			"value" : 55
		},
		{
			"label" : "tdr/cpu/temperature/max",
			"value" : 60
		},
		{
			"label" : "tdr/cpu/temperature/min",
			"value" : 54
		},
		{
			"label" : "tdr/imagers/status",
			"value" : 
			[
				"OK",
				"OK"
			]
		},
		{
			"label" : "tdr/imagers/temperature",
			"value" : 
			[
				66,
				53
			]
		},
		{
			"label" : "tdr/imagers/temperature/max",
			"value" : 
			[
				70,
				58
			]
		},
		{
			"label" : "tdr/imagers/temperature/min",
			"value" : 
			[
				63,
				51
			]
		},
		{
			"label" : "tdr/status",
			"value" : "Connected"
		},
		{
			"label" : "tdr/imagers/labels_read/1d",
			"value" : 
			[
				46,
				4
			]
		},
		{
			"label" : "tdr/imagers/labels_read/2d",
			"value" : 
			[
				4,
				0
			]
		},
		{
			"label" : "tdr/imagers/labels_read/dwm",
			"value" : 
			[
				0,
				0
			]
		},
		{
			"label" : "tdr/labels_read",
			"value" : 54
		},
		{
			"label" : "tdr/labels_read/1d",
			"value" : 50
		},
		{
			"label" : "tdr/labels_read/2d",
			"value" : 4
		},
		{
			"label" : "tdr/labels_read/dwm",
			"value" : 0
		},
		{
			"label" : "tdr/mainboard/serial_number",
			"value" : "F24HAAAAF"
		},
		{
			"label" : "tdr/serial_number",
			"value" : "jr1"
		},
		{
			"label" : "ccmh/cpu/temperature",
			"value" : 38
		},
		{
			"label" : "ccmh/cpu/temperature/max",
			"value" : 42
		},
		{
			"label" : "ccmh/cpu/temperature/min",
			"value" : 37
		},
		{
			"label" : "ccmh/imagers/status",
			"value" : 
			[
				"OK"
			]
		},
		{
			"label" : "ccmh/imagers/temperature",
			"value" : 
			[
				47
			]
		},
		{
			"label" : "ccmh/imagers/temperature/max",
			"value" : 
			[
				52
			]
		},
		{
			"label" : "ccmh/imagers/temperature/min",
			"value" : 
			[
				45
			]
		},
		{
			"label" : "ccmh/status",
			"value" : "Connected"
		},
		{
			"label" : "ccmh/mainboard/serial_number",
			"value" : "F24G10062"
		},
		{
			"label" : "ccmh/serial_number",
			"value" : "F24GAAAAE"
		}
	]
}

`get` /scanner_component/base:

Get all information, status, and statistics from the Base component

Operation ID: scanner_component/base

Responses:

200 Information, status, and statistics from the Base component #/components/schemas/AllBaseInfo
400 Bad input parameter
500 Internal server error
503 Service unavailable

Example (using curl):

curl -i --insecure --cert magellan_sdk_client.pem --get https://datalogic-base-F24H01847.local:443/api/1.0.0/scanner_component/base

`get` /scanner_component/ccmh:

Get all information, status, and statistics from the specified Horizontal Color Camera Module (HCCM) component

Operation ID: scanner_component/ccmh

Responses:

200 Information, status, and statistics from the HCCM component #/components/schemas/AllCCMInfo
400 Bad input parameter
500 Internal server error
503 Service unavailable

Example (using curl):

curl -i --insecure --cert magellan_sdk_client.pem --get https://datalogic-base-F24H01847.local:443/api/1.0.0/scanner_component/ccmh

`get` /scanner_component/ccmv:

Get all information, status, and statistics from the specified Vertical Color Camera Module (VCCM) component

Operation ID: scanner_component/ccmv

Responses:

200 Information, status, and statistics from the VCCM component #/components/schemas/AllCCMInfo
400 Bad input parameter
500 Internal server error
503 Service unavailable

Example (using curl):

curl -i --insecure --cert magellan_sdk_client.pem --get https://datalogic-base-F24H01847.local:443/api/1.0.0/scanner_component/ccmv

`get` /scanner_component/tdr:

Get all information, status, and statistics from the specified TDR component

Operation ID: scanner_component/tdr

Responses:

200 Information, status, and statistics from the TDR component #/components/schemas/AllTDRInfo
400 Bad input parameter
500 Internal server error
503 Service unavailable

Example (using curl):

curl -i --insecure --cert magellan_sdk_client.pem --get https://datalogic-base-F24H01847.local:443/api/1.0.0/scanner_component/tdr

`get` /scanner_component/(component)/(fieldLabel):

Get information, status, and statistics from component

Operation ID: scanner_component/component/fieldLabel

Parameters:

#/components/parameters/component
#/components/parameters/fieldLabel

Responses:

200 Information, status, and statistics of component #/components/schemas/Info
400 Bad input parameter
500 Internal server error
503 Service unavailable

`get` /scanner_component/(component)/image/(when):

Get captured image
Operation ID: scanner_component/component/image/when
Parameters:

#/components/parameters/component
#/components/parameters/when
#/components/parameters/format
#/components/parameters/quality
#/components/parameters/scale
#/components/parameters/roi
#/components/parameters/imager

Responses:

200 When successful, the captured image. The content type depends on the "format".

image/bmp: When format is bmp
image/jpeg: When format is jpg
image/png: When format is png
application/octet-stream: When format is raw

400 Bad input parameter
500 Internal server error
503 Service unavailable

Example (using curl):

curl --insecure --cert magellan_sdk_client.pem --get --output tdr.jpg https://datalogic-base-F24H01847.local:443/api/1.0.0/scanner_component/tdr/image/next?format=jpg

`post` /scanner_component/(component)/stream:

Starts video streaming
Operation ID: scanner_component/component/stream
Parameters: #/components/parameters/component
RequestBody: Stream options

#/components/schemas/protocol
#/components/schemas/codec
#/components/schemas/scale_video
#/components/schemas/imager
#/components/schemas/currency_assist
Responses:
200 Video streaming started

request: #/components/schemas/request
protocol: #/components/schemas/protocol
codec: #/components/schemas/codec
scale: #/components/schemas/codec
scale: #/components/schemas/scale_video
imager: #/components/schemas/imager
url: When protocol is rtsp, the RTSP stream url

Example:

curl -i --insecure --cert magellan_sdk_client.pem -X POST --data '{"protocol":"rtsp"}' https://datalogic-base-F24H01847.local:443/api/1.0.0/scanner_component/ccmh/stream   

{
	"request" : "/api/1.0.0/scanner_component/ccmh/stream",
	"protocol" : "rtsp",
	"codec" : "h.264",
	"scale" : "1.0",
	"imager" : "ccmh"
	"url" : "rtsp://datalogic-ccm-F24GAAAAE.local:8554/stream"
}	

400 Bad input parameter
500 Internal server error
503 Service unavailable

`delete`

Stops video streaming

Operation ID: scanner_component/component/stream/id

Responses:

200 Video streaming stopped
410 No such video stream
503 Service unavailable

Example:

curl -i --insecure --cert magellan_sdk_client.pem -X DELETE https://datalogic-base-F24H01847.local:443/api/1.0.0/scanner_component/ccmh/stream

`get` /scanner_component/base/reset:

Cause the application to reset. Does not cause a system reboot.

Operation ID: scanner_component/base/reset

Responses:

200 Reset requested
400 Bad input parameter
503 Service unavailable

`get` /scanner_component/base/sound/(sound):

Play a sound

Operation ID: scanner_component/base/sound/sound

Parameters: #/components/parameters/sound

Responses:

200 Sound played
400 Bad input parameter
500 Internal server error
503 Service unavailable

`put` /scanner_component/base/sound/(sound):

Upload a custom sound as a form submission.

Operation ID: scanner_component/base/sound/custom_sound

Parameters: #/components/parameters/sound

requestBody: Sound Data Content: application/x-www-form-urlencoded: properties:

Responses:

200 Sound played
400 Bad input parameter
500 Internal server error
503 Service unavailable

Components:

Request:

The request path

Example:

{
	"request" : "/api/1.0.0/scanner_component/base"
}

/scanner_component/base

Application:

The application software version for the specified component.

Example:

{
		"label" : "application",
		"value" : "DR9401630"
}

Configuration:

The configuration file name.

Example:

{
		"label" : "configuration",
		"value" : "DR9611556"
}

CPU-Temperature:

The current temperature (in Celsius) of the CPU in the specified component.

Example:

{
		"label" : "cpu/temperature",
		"value" : 42
}

CPU Temperature Max:

The maximum temperature (in Celsius) of the CPU in the specified component.

Example:

{
		"label" : "cpu/temperature/max",
		"value" : 65
}

CPU Temperature Min:

The minimum temperature (in Celsius) of the CPU in the specified component.

Example:

{
		"label" : "cpu/temperature/min",
		"value" : 38
}

DWM:

The Digital Watermark (DWM) decoding library from Digimarc version for the specified component.

Example:

{
		"label" : "dwm",
		"value" : "3.10.2 - 20210707131523"		
}

EAS Deactivation:

The total number of Electronic Article Surveillance (EAS) deactivations. A deactivation disables the EAS tag.

Example:

{
		"label" : "eas/deactivation",
		"value" : 156	
}

EAS Deactivation Manual:

The total number of manual Electronic Article Surveillance (EAS) deactivations. A manual deactivation is triggered by the user pressing the EAS deactivation button or sending a EAS deactivation command over the Scanner Host Port.

Example:

{
		"label" : "eas/deactivation/manual",
		"value" : 0
}

EAS IO Fault:

The total number of communications to the Electronic Article Surveillance (EAS) controller resulted in a fault.

Example:

{
		"label" : "eas/io/fault",
		"value" : 0		
}

EAS IO Timeout:

The total number of times commands sent by the component to the Electronic Article Surveillance (EAS) controller failed to respond.

Example:

{
		"label" : "eas/io/timeout",
		"value" : 0
}

EAS Runtime Fault:

The total number of Electronic Article Surveillance (EAS) runtime faults.

Example:

{
		"label" : "eas/runtime/fault",
		"value" : 0
}

EAS Tag:

The total number of Electronic Article Surveillance (EAS) tags seen.

Example:

{
		"label" : "eas/tag",
		"value" : 1
}

EC Level:

The numeric identifier for the component application version. This value increases every component software release.

Example:

{
		"label" : "ec_level",
		"value" : "0068"
}

Ethernet Ports:

The total number of Ethernet ports the attached Datalogic switch supports. If no switch connected or a non-Datalogic switch is used, the value of 0 will be reported.

Example:

{
		"label" : "ethernet/ports",
		"value" : 7
}

Ethernet Ports Used:

The number of Ethernet ports in use on the attached Datalogic switch. If no switch connected or a non-Datalogic switch is used, the value of 0 will be reported.

Example:

{
		"label" : "ethernet/ports/used",
		"value" : 3
}

EVL:

The barcode decoding software version for the specified component.

Example:

{
		"label" : "evl",
		"value" : "2.3.7.22"
}

Formatter:

The label formatting software version for the specified component.

Example:

{
		"label" : "formatter",
		"value" : "3.19"
}

FPGA:

The FPGA version for the specified component.

Example:

{
		"label" : "fpga",
		"value" : "0a02"
}

Hardware ID:

The identifier that specifies the hardware version of the specified component.

9900: Magellan 9900i
9600: Magellan 9600i

Example:

{
		"label" : "hardware_id",
		"value" : "9900"
}

HHS Statuses:

The number of attached Handheld or Secondary scanners.

Example:

{
		"label" : "hhs/statuses",
		"value" : 0
}

Imagers Labels Read 1D:

The number of 1D labels read by the imagers in the specified component. Imager order depends on the component.
Base:

horizontal
vertical

TDR:

TDR
CFR (only included if TDR has a Customer Facing Reader (CFR) installed)

Example:

{
		"label" : "imagers/labels_read/1d",
		"value" : 
		[
			3289,
			3481
		]
}

Imagers Labels Read 2D:

The number of 2D labels read by the imagers in the specified component. Imager order depends on the component.
Base:

horizontal
vertical

TDR:

TDR
CFR (only included if TDR has a Customer Facing Reader (CFR) installed)

Example:

{
		"label" : "imagers/labels_read/2d",
		"value" : 
		[
			654,
			25
		]
}

Imagers Labels Read DWM:

The number of Digital Watermark (DWM) labels from Digimarc labels read by the imagers in the specified component.
Base:

horizontal
vertical

Example:

{
		"label" : "imagers/labels_read/dwm",
		"value" : 
		[
			46,
			99
		]
}

Imagers Status:

The status of the imagers in the specified component.
Base:

horizontal left
horizontal right
vertical left
vertical right

TDR:

TDR
CFR (only included if TDR has a Customer Facing Reader (CFR) installed)

CCMH or CCMV: Single Imager

Example:

{
		"label" : "imagers/status",
		"value" : 
		[
			"OK",
			"OK",
			"OK",
			"OK"
		]
}

Imagers Temperature:

The current temperature (in Celsius) of the imagers in the specified component. Imager order depends on the component.
Base:

horizontal left
horizontal right
vertical left
vertical right

TDR:

TDR
CFR (only included if TDR has a Customer Facing Reader (CFR) installed)

CCMH or CCMV: Single Imager

Example:

{
		"label" : "imagers/temperature",
		"value" : 
		[
			46,
			47,
			45,
			43
		]
}

Imagers Temperature Max:

The maximum temperature (in Celsius) of the imagers in the specified component. Imager order depends on the component.
Base:

horizontal left
horizontal right
vertical left
vertical right

TDR:

TDR
CFR (only included if TDR has a Customer Facing Reader (CFR) installed)

CCMH or CCMV: Single Imager

Example:

{
		"label" : "imagers/temperature/max",
		"value" : 
		[
			47,
			49,
			45,
			44
		]
}

Imagers Temperature Min:

The minimum temperature (in Celsius) of the imagers in the specified component. Imager order depends on the component.
Base:

horizontal left
horizontal right
vertical left
vertical right

TDR:

TDR
CFR (only included if TDR has a Customer Facing Reader (CFR) installed)

CCMH or CCMV: Single Imager

Example:

{
		"label" : "imagers/temperature/min",
		"value" : 
		[
			44,
			43,
			42,
			40
		]
}

Interface:

The current interface number the specified component is using for POS Scanner Host communication.

"05": RS-232 Standard
"12": RS-232 Wincor-Nixdorf
"1E": USB COM Single Cable
"20": RS-232 Single Cable
"35": USB Keyboard
"45": USB OEM
"47": USB COM

Example:

{
		"label" : "interface",
		"value" : "05"
}

Labels Read:

The total number of labels read by the component.

Example:

{
		"label" : "labels_read",
		"value" : 253
}

Labels Read 1D:

The number of 1D labels read by all imagers in the specified component.

Example:

{
		"label" : "labels_read/1d",
		"value" : 146
}

Labels Read 1D Stitched:

The number of labels read via stitching by all imagers in the specified component.

Example:

{
		"label" : "labels_read/1d/stitched",
		"value" : 98
}

Labels Read 2D:

The number of 2D labels read by all imagers in the specified component.

Example:

{
		"label" : "labels_read/2d",
		"value" : 9
}

Labels Read DWM:

The number of Digital Watermark (DWM) labels from Digimarc labels read by all imagers in the specified component.

Example:

{
		"label" : "labels_read/dwm",
		"value" : 0
}

Labels Read HHS:

The number of labels read from all attached Handheld or Secondary scanners.

Example:

{
		"label" : "labels_read/hhs",
		"value" : 0
}

Mainboard Model Number:

The model number of the main board in the specified component.

Example:

{
		"label" : "mainboard/model_number",
		"value" : "686018014"
}

Mainboard Serial Number:

The serial number of the main board in the specified component.

Example:

{
		"label" : "mainboard/serial_number",
		"value" : "G23HBCXKE"
}

Mainboard Storage Available:

The storage (in Bytes) available to be used by the specified component.

Example:

{
		"label" : "mainboard/storage/available",
		"value" : 695791616
}

Mainboard Storage Total:

The total storage (in Bytes) the specified component has.

Example:

{
			"label" : "mainboard/storage/total",
			"value" : 1502240768
}

Model Number:

The model number of the specified component.

Example:

{
		"label" : "model_number",
		"value" : "99113102735-G00560"
}

Object Sense:

The number of Object Sense events.

Example:

{
		"label" : "object_sense",
		"value" : 0
}

Power On Events:

The total number of power on events.

Example:

{
		"label" : "power_on/events",
		"value" : 77
}

Power On Time:

The total number of hours the component has been powered on.

Example:

{
		"label" : "power_on/time",
		"value" : 1056
}

Resets:

The total number of times the specified component has reset.

Example:

{
		"label" : "resets",
		"value" : 108
}

Resets Errors:

The total number of times the specified component has reset due to an error.

Example:

{
		"label" : "resets/errors",
		"value" : 0
}

Satellite:

The number of Top Down Reader (TDR) and Color Camera Modules (CCM) paired to the specified component.

Example:

{
		"label" : "satellite",
		"value" : 2
}

Scale:

Indicates if scale feature is enabled.

Example:

{
		"label" : "scale",
		"value" : true
}

Scale Calibration:

The number of scale calibration attempts.

Example:

{
		"label" : "scale/calibration",
		"value" : 2
}

Scale Sentry Activation:

The number of Scale Sentry activations.

Example:

{
		"label" : "scale/sentry/activation",
		"value" : 2
}

Scale Sentry Deactivation:

The number of Scale Sentry deactivations.

Example:

{
		"label" : "scale/sentry/deactivation",
		"value" : 1
}

Scale Version:

The version of the integrated scale.

Example:

{
		"label" : "base/scale/version",
		"value" : "T1BA"
}

Scale Zero Button:

The number of Scale Zero attempts by button press.

Example:

{
		"label" : "base/scale/zero/button",
		"value" : 5
}

Scale Zero POS:

The number of Scale Zero attempts by command sent by the Point of Sale.

Example:

{
		"label" : "base/scale/zero/pos",
		"value" : 2
}

Scale Zero Required:

The number of times the scale required being re-zeroed.

Example:

{
		"label" : "base/scale/zero/required",
		"value" : 0
}

SDcard Storage Available:

The storage (in Bytes) available to be used by the SD Card inserted in the specified component.

Example:

{
		"label" : "base/sdcard/storage/available",
		"value" : 91254329
}

SDcard Storage Total:

The total storage (in Bytes) on the SD Card inserted in the specified component.

Example:

{
		"label" : "base/sdcard/storage/available",
		"value" : 1950654832
}

Serial Number:

The serial number of the specified component.

Example:

{
		"label" : "base/serial_number",
		"value" : "F24H01847"
}

TPU Status:

Indicates if the Tensor Processing Unit (TPU) is installed in the component.

Example:

{
		"label" : "base/tpu/status",
		"value" : "FAIL"
}

TPU Temperature:

The current temperature (in Celsius) of the TPU in the specified component.

Example:

{
		"label" : "base/tpu/temperature",
		"value" : 42
}

TPU Temperature Max:

The maximum temperature (in Celsius) of the TPU in the specified component.

Example:

{
		"label" : "base/tpu/temperature/max",
		"value" : 50
}

TPU Temperature Min:

The minimum temperature (in Celsius) of the TPU in the specified component.

Example:

{
		"label" : "base/tpu/temperature/min",
		"value" : 38
}

Uptime:

The time in seconds since the last boot.

Example:

{
		"label" : "base/uptime",
		"value" : 2484
}

USB Drive Storage Available:

The storage (in Bytes) available to be used by each USB drive attached to the specified component. An entry for each USB Drive attached.

Example:

{
		"label" : "base/usb/drives/storage/available",
		"value" : 
		[
			0,
			0
		]
}

USB Drive Storage Total:

The total storage (in Bytes) on each USB drive attached to the specified component. An entry for each USB Drive attached

Example:

{
		"label" : "base/usb/drives/storage/total",
		"value" : 
		[
			0,
			0
		]
}

M7:

The M7 software version for the specified component.

Example:

{
		"label" : "tdr/m7",
		"value" : "2.2.0"
}

Mainboard Focused Serial Number:

The focused serial number of the main board in the specified component.

Example:

{
		"label" : "tdr/mainboard/focused_serial_number",
		"value" : "F24HAAAAF"
}

Status:

Indicates if the specified Top Down Reader (TDR) or Color Camera Module (CCM) is installed.

Responses:

Not Configured
Connecting
Connected
Disconnected
Resetting
Reset Complete

Example:

{
			"label" : "tdr/status",
			"value" : "Connected"
}

Summary​

Server:​

Paths:​

get /scanner_component:​

get /scanner_component/base:​

get /scanner_component/ccmh:​

get /scanner_component/ccmv:​

get /scanner_component/tdr:​

get /scanner_component/(component)/(fieldLabel):​

get /scanner_component/(component)/image/(when):​

post /scanner_component/(component)/stream:​

delete​

get /scanner_component/base/reset:​

get /scanner_component/base/sound/(sound):​

put /scanner_component/base/sound/(sound):​

Components:​

Request:​

Application:​

Configuration:​

CPU-Temperature:​

CPU Temperature Max:​

CPU Temperature Min:​

DWM:​

EAS Deactivation:​

EAS Deactivation Manual:​

EAS IO Fault:​

EAS IO Timeout:​

EAS Runtime Fault:​

EAS Tag:​

EC Level:​

Ethernet Ports:​

Ethernet Ports Used:​

EVL:​

Formatter:​

FPGA:​

Hardware ID:​

HHS Statuses:​

Imagers Labels Read 1D:​

Imagers Labels Read 2D:​

Imagers Labels Read DWM:​

Imagers Status:​

Imagers Temperature:​

Imagers Temperature Max:​

Imagers Temperature Min:​

Interface:​

Labels Read:​

Labels Read 1D:​

Labels Read 1D Stitched:​

Labels Read 2D:​

Labels Read DWM:​

Labels Read HHS:​

Mainboard Model Number:​

Mainboard Serial Number:​

Mainboard Storage Available:​

Mainboard Storage Total:​

Model Number:​

Object Sense:​

Power On Events:​

Power On Time:​

Resets:​

Resets Errors:​

Satellite:​

Scale:​

Scale Calibration:​

Scale Sentry Activation:​

Scale Sentry Deactivation:​

Scale Version:​

Scale Zero Button:​

Scale Zero POS:​

Scale Zero Required:​

SDcard Storage Available:​

SDcard Storage Total:​

Serial Number:​

TPU Status:​

TPU Temperature:​

TPU Temperature Max:​

TPU Temperature Min:​

Uptime:​

USB Drive Storage Available:​

USB Drive Storage Total:​

Summary

Server:

Paths:

`get` /scanner_component:

`get` /scanner_component/base:

`get` /scanner_component/ccmh:

`get` /scanner_component/ccmv:

`get` /scanner_component/tdr:

`get` /scanner_component/(component)/(fieldLabel):

`get` /scanner_component/(component)/image/(when):

`post` /scanner_component/(component)/stream:

`delete`

`get` /scanner_component/base/reset:

`get` /scanner_component/base/sound/(sound):

`put` /scanner_component/base/sound/(sound):

Components:

Request:

Application:

Configuration:

CPU-Temperature:

CPU Temperature Max:

CPU Temperature Min:

DWM:

EAS Deactivation:

EAS Deactivation Manual:

EAS IO Fault:

EAS IO Timeout:

EAS Runtime Fault:

EAS Tag:

EC Level:

Ethernet Ports:

Ethernet Ports Used:

EVL:

Formatter:

FPGA:

Hardware ID:

HHS Statuses:

Imagers Labels Read 1D:

Imagers Labels Read 2D:

Imagers Labels Read DWM:

Imagers Status:

Imagers Temperature:

Imagers Temperature Max:

Imagers Temperature Min:

Interface:

Labels Read:

Labels Read 1D:

Labels Read 1D Stitched:

Labels Read 2D:

Labels Read DWM:

Labels Read HHS:

Mainboard Model Number:

Mainboard Serial Number:

Mainboard Storage Available:

Mainboard Storage Total:

Model Number:

Object Sense:

Power On Events:

Power On Time:

Resets:

Resets Errors:

Satellite:

Scale:

Scale Calibration:

Scale Sentry Activation:

Scale Sentry Deactivation:

Scale Version:

Scale Zero Button:

Scale Zero POS:

Scale Zero Required:

SDcard Storage Available:

SDcard Storage Total:

Serial Number:

TPU Status:

TPU Temperature:

TPU Temperature Max:

TPU Temperature Min:

Uptime:

USB Drive Storage Available:

USB Drive Storage Total: