openapi: 3.1.0
info:
title: Magellan 9900i/9600i SDK REST API
description: |
This API is used for working with the Magellan 9900i/9600i and any attached Top Down Reader (TDR) or
Color Camera Modules (CCM).
Note that unexpected URL parameters and request bodies are ignored.
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 `Datalogic Fixed Retail Scanner - Event API`.
The Websocket is available from the scanner at `wss://datalogic-base-SERIAL_NUMBER.local/ws`.
contact:
url: https://datalogic.com
version: 1.0.0
license:
name: Proprietary
url: https://datalogic.com
x-logo:
url: logo.png
href: /
servers:
- url: https://datalogic-base-SERIAL_NUMBER.local/api/1.0.0
description: The API is accessed from the base device
security:
- default: []
tags:
- name: Image Capture
description: Take or get images from the component
- name: Video Streaming
description: Start or stop video streaming from the component
- name: Information and Statistics
description: Information, status, and statistics calls
- name: Sounds
description: Play sounds
- name: Control
description: Miscellaneous actions to control the device
paths:
/scanner_component:
get:
tags:
- Information and Statistics
summary: Get all information, status, and statistics from all components
description: |
Returns all of the information, status, and statistics from all components
operationId: scanner_component
responses:
'200':
description: Information, status, and statistics
content:
application/json:
schema:
$ref: '#/components/schemas/AllInfo'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/scanner_component/base:
get:
tags:
- Information and Statistics
summary: Get all information, status, and statistics from the Base component
description: |
Returns all of the information, status, and statistics for the `base` component
operationId: scanner_component/base
responses:
'200':
description: |
Information, status, and statistics of the `base` component
content:
application/json:
schema:
$ref: '#/components/schemas/AllBaseInfo'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/scanner_component/{ccm}:
get:
tags:
- Information and Statistics
summary: Get all information, status, and statistics from the specified CCM component type
description: |
Returns all of the information, status, and statistics for the a CCM component type
operationId: scanner_component/ccm
parameters:
- $ref: '#/components/parameters/ccm'
responses:
'200':
description: |
Information, status, and statistics of the CCM component type
content:
application/json:
schema:
$ref: '#/components/schemas/AllCCMInfo'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/scanner_component/tdr:
get:
tags:
- Information and Statistics
summary: Get all information, status, and statistics from the TDR component
description: |
Returns all of the information, status, and statistics for the `tdr` component
operationId: scanner_component/tdr
responses:
'200':
description: |
Information, status, and statistics of the `tdr` component
content:
application/json:
schema:
$ref: '#/components/schemas/AllTDRInfo'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/scanner_component/{component}/{fieldLabel}:
get:
tags:
- Information and Statistics
summary: Get information, status, and statistics from component
description: |
Returns information, status, and statistics for component
operationId: scanner_component/component/fieldLabel
parameters:
- $ref: '#/components/parameters/component'
- $ref: '#/components/parameters/fieldLabel'
responses:
'200':
description: Information, status, and statistics of component
content:
application/json:
schema:
$ref: '#/components/schemas/Info'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/scanner_component/{component}/image/{when}:
get:
tags:
- Image Capture
summary: Get captured image
description: |
Returns an image captured by the component
operationId: scanner_component/component/image/when
parameters:
- $ref: '#/components/parameters/component'
- $ref: '#/components/parameters/when'
- $ref: '#/components/parameters/format'
- $ref: '#/components/parameters/quality'
- $ref: '#/components/parameters/scale'
- $ref: '#/components/parameters/roi'
- $ref: '#/components/parameters/imager'
responses:
'200':
description: |
When successful, the captured image.
The content type depends on the `format`.
content:
image/bmp:
schema:
description: When `format` is `bmp`
type: string
format: binary
examples:
bmp:
summary: A BMP image
value: The image data
image/jpeg:
schema:
description: When `format` is `jpg`
type: string
format: binary
examples:
jpeg:
summary: A JPEG image
value: The image data
image/png:
schema:
description: When `format` is `png`
type: string
format: binary
examples:
png:
summary: A PNG image
value: The image data
application/octet-stream:
schema:
description: When `format` is `raw`
type: string
format: binary
examples:
raw:
summary: The raw image
value: The image data
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/scanner_component/{component}/stream:
post:
tags:
- Video Streaming
summary: Starts video streaming
description: Starts video streaming
operationId: scanner_component/component/stream
parameters:
- $ref: '#/components/parameters/component'
requestBody:
description: Stream options
content:
application/json:
schema:
type: object
required:
- protocol
properties:
protocol:
$ref: '#/components/schemas/protocol'
codec:
$ref: '#/components/schemas/codec'
scale:
$ref: '#/components/schemas/scale_video'
imager:
$ref: '#/components/schemas/imager'
currency_assist:
$ref: '#/components/schemas/currency_assist'
responses:
'200':
description: Video streaming started
content:
application/json:
schema:
required:
- request
- protocol
- scale
type: object
properties:
request:
$ref: '#/components/schemas/request'
examples:
- /scanner_component/base/stream
protocol:
$ref: '#/components/schemas/protocol'
codec:
$ref: '#/components/schemas/codec'
scale:
$ref: '#/components/schemas/scale_video'
imager:
$ref: '#/components/schemas/imager'
url:
description: When `protocol` is `rtsp`, the RTSP stream url
type: string
examples:
- rtsp://datalogic-base-g23hbcxke.local:8554/stream
examples:
- request: /api/1.0.0/scanner_component/base/stream
protocol: rtsp
codec: h.264
scale: 0.25
imager: montage
url: rtsp://datalogic-base-g23hbcxke.local:8554/stream
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
delete:
tags:
- Video Streaming
summary: Stops video streaming
description: Stops video streaming
operationId: scanner_component/component/stream/id
parameters:
- $ref: '#/components/parameters/component'
responses:
'200':
description: Video streaming stopped
'410':
description: No such video stream
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
/scanner_component/base/reset:
get:
tags:
- Control
summary: Reset the scanner
description: |
Cause the application to reset.
Does not cause a system reboot.
operationId: scanner_component/base/reset
responses:
'200':
description: Reset requested
'400':
$ref: '#/components/responses/400'
'503':
$ref: '#/components/responses/503'
/scanner_component/base/sound/{sound}:
get:
tags:
- Sounds
summary: Play a sound
description: Play a sound
operationId: scanner_component/base/sound/sound
parameters:
- $ref: '#/components/parameters/sound'
responses:
'200':
description: Sound played
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
'503':
$ref: '#/components/responses/503'
put:
tags:
- Sounds
summary: Upload a custom sound
description: Upload a custom sound as a form submission.
operationId: scanner_component/base/sound/custom_sound
parameters:
- $ref: '#/components/parameters/sound'
requestBody:
description: Sound data
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
required:
- sound
properties:
sound:
$ref: '#/components/schemas/sound-data'
responses:
'200':
description: Custom sound uploaded
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
components:
securitySchemes:
default:
type: http
scheme: basic
schemas:
request:
description: The request path
type: string
examples:
- /scanner_component/base
application:
required:
- label
- value
type: object
properties:
label:
description: |
The application software version for the specified component
type: string
value:
type: string
minLength: 1
examples:
- DR9401630
configuration:
required:
- label
- value
type: object
properties:
label:
description: |
The configuration file name
type: string
value:
type: string
minLength: 0
maxLength: 10
examples:
- DR9611516
cpu-temperature:
required:
- label
- value
type: object
properties:
label:
description: |
The current temperature (in Celsius) of the CPU in the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 42
cpu-temperature-max:
required:
- label
- value
type: object
properties:
label:
description: |
The maximum temperature (in Celsius) of the CPU in the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 50
cpu-temperature-min:
required:
- label
- value
type: object
properties:
label:
description: |
The minimum temperature (in Celsius) of the CPU in the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 38
dwm:
required:
- label
- value
type: object
properties:
label:
description: |
The Digital Watermark (DWM) decoding library from Digimarc version for the specified component
type: string
value:
type: string
minLength: 1
examples:
- '3.12'
eas-deactivation:
required:
- label
- value
type: object
properties:
label:
description: |
The total number of Electronic Article Surveillance (EAS) deactivations.
A deactivation disables the EAS tag.
type: string
value:
type: integer
minimum: 0
examples:
- 156
eas-deactivation-manual:
required:
- label
- value
type: object
properties:
label:
description: |
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.
A deactivation disables the EAS tag.
type: string
value:
type: integer
minimum: 0
examples:
- 2
eas-io-fault:
required:
- label
- value
type: object
properties:
label:
description: |
The total number of communications to the Electronic Article Surveillance (EAS) controller resulted in a fault
type: string
value:
type: integer
minimum: 0
examples:
- 0
eas-io-timeout:
required:
- label
- value
type: object
properties:
label:
description: |
The total number of times commands sent by the component to the Electronic Article Surveillance (EAS) controller
failed to respond.
type: string
value:
type: integer
minimum: 0
examples:
- 0
eas-runtime-fault:
required:
- label
- value
type: object
properties:
label:
description: |
The total number of Electronic Article Surveillance (EAS) runtime faults
type: string
value:
type: integer
minimum: 0
examples:
- 0
eas-tag:
required:
- label
- value
type: object
properties:
label:
description: |
The total number of Electronic Article Surveillance (EAS) tags seen
type: string
value:
type: integer
minimum: 0
examples:
- 1
ec_level:
required:
- label
- value
type: object
properties:
label:
description: |
The numeric identifier for the component application version.
This value increases every component software release.
type: string
value:
type: string
minLength: 4
maxLength: 4
examples:
- '0051'
ethernet-ports:
required:
- label
- value
type: object
properties:
label:
description: |
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.
type: string
value:
type: integer
minimum: 0
maximum: 7
examples:
- 7
ethernet-ports-used:
required:
- label
- value
type: object
properties:
label:
description: |
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.
type: string
value:
type: integer
minimum: 0
maximum: 7
examples:
- 3
evl:
required:
- label
- value
type: object
properties:
label:
description: |
The barcode decoding software version for the specified component
type: string
value:
type: string
minLength: 1
examples:
- 2.3.7.14.3
formatter:
required:
- label
- value
type: object
properties:
label:
description: |
The label formatting software version for the specified component
type: string
value:
type: string
minLength: 1
examples:
- '3.11'
fpga:
required:
- label
- value
type: object
properties:
label:
description: |
The FPGA version for the specified component
type: string
value:
type: string
minLength: 4
maxLength: 4
examples:
- 0a02
hardware_id:
required:
- label
- value
type: object
properties:
label:
description: |
The identifier that specifies the hardware version of the specified component
type: string
value:
description: |
- `9900`: Magellan 9900i
- `9600`: Magellan 9600i
type: string
enum:
- '9900'
- '9600'
examples:
- '9900'
hhs-statuses:
required:
- label
- value
type: object
properties:
label:
description: |
The number of attached Handheld or Secondary scanners.
type: string
value:
type: integer
minimum: 0
maximum: 2
examples:
- 1
imagers-labels_read-1d:
required:
- label
- value
type: object
properties:
label:
description: |
The number of 1D labels read by the imagers in the specified component
type: string
value:
description: |
Imager order depends on the component
- `base`:
- `horizontal`
- `vertical`
- `tdr`:
- `tdr`
- `cfr` (only included if TDR has a Customer Facing Reader (CFR) installed)
type: array
minItems: 1
maxItems: 2
items:
type: integer
minimum: 0
examples:
- - 3289
- 3481
imagers-labels_read-2d:
required:
- label
- value
type: object
properties:
label:
description: |
The number of 2D labels read by the imagers in the specified component
type: string
value:
description: |
Imager order depends on the component
- `base`:
- `horizontal`
- `vertical`
- `tdr`:
- `tdr`
- `cfr` (only included if TDR has a Customer Facing Reader (CFR) installed)
type: array
minItems: 1
maxItems: 2
items:
type: integer
minimum: 0
examples:
- - 654
- 25
imagers-labels_read-dwm:
required:
- label
- value
type: object
properties:
label:
description: |
The number of Digital Watermark (DWM) labels from Digimarc labels read by the imagers in the specified component
type: string
value:
description: |
Imager order depends on the component
- `base`:
- `horizontal`
- `vertical`
type: array
minItems: 2
maxItems: 2
items:
type: integer
minimum: 0
examples:
- - 46
- 99
imagers-status:
required:
- label
- value
type: object
properties:
label:
description: |
The status of the imagers in the specified component
type: string
value:
description: |
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
type: array
minItems: 1
maxItems: 4
items:
type: string
enum:
- OK
- FAIL
examples:
- - OK
- OK
- FAIL
- OK
- - OK
- OK
- - OK
imagers-temperature:
required:
- label
- value
type: object
properties:
label:
description: |
The current temperature (in Celsius) of the imagers in the specified component
type: string
value:
description: |
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
type: array
minItems: 1
maxItems: 4
items:
type: integer
minimum: 0
examples:
- - 42
- 43
- 40
- 42
- - 42
- 42
- - 43
imagers-temperature-max:
required:
- label
- value
type: object
properties:
label:
description: |
The maximum temperature (in Celsius) of the imagers in the specified component
type: string
value:
description: |
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
type: array
minItems: 1
maxItems: 4
items:
type: integer
minimum: 0
examples:
- - 52
- 53
- 50
- 52
- - 52
- 52
- - 53
imagers-temperature-min:
required:
- label
- value
type: object
properties:
label:
description: |
The minimum temperature (in Celsius) of the imagers in the specified component
type: string
value:
description: |
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
type: array
minItems: 1
maxItems: 4
items:
type: integer
minimum: 0
examples:
- - 32
- 33
- 30
- 32
- - 30
- 32
- - 35
interface:
required:
- label
- value
type: object
properties:
label:
description: |
The current interface number the specified component is using for POS Scanner Host communication
type: string
value:
description: |
- `"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
type: string
enum:
- '05'
- '12'
- 1E
- '20'
- '35'
- '45'
- '47'
examples:
- '45'
labels_read:
required:
- label
- value
type: object
properties:
label:
description: |
The total number of labels read by the component.
type: string
value:
type: integer
minimum: 0
examples:
- 23487
labels_read-1d:
required:
- label
- value
type: object
properties:
label:
description: |
The number of 1D labels read by all imagers in the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 3289
labels_read-1d-stitched:
required:
- label
- value
type: object
properties:
label:
description: |
The number of labels read via stitching by all imagers in the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 385
labels_read-2d:
required:
- label
- value
type: object
properties:
label:
description: |
The number of 2D labels read by all imagers in the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 654
labels_read-dwm:
required:
- label
- value
type: object
properties:
label:
description: |
The number of Digital Watermark (DWM) labels from Digimarc labels read by all imagers in the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 38
labels_read-hhs:
required:
- label
- value
type: object
properties:
label:
description: |
The number of labels read from all attached Handheld or Secondary scanners.
type: string
value:
type: integer
minimum: 0
examples:
- 379
mainboard-model_number:
required:
- label
- value
type: object
properties:
label:
description: |
The model number of the main board in the specified component
type: string
value:
type: string
minLength: 1
maxLength: 32
examples:
- '686018014'
mainboard-serial_number:
required:
- label
- value
type: object
properties:
label:
description: |
The serial number of the main board in the specified component
type: string
value:
type: string
minLength: 1
maxLength: 32
examples:
- G23HBCXKE
mainboard-storage-available:
required:
- label
- value
type: object
properties:
label:
description: |
The storage (in Megabytes) available to be used by the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 673
mainboard-storage-total:
required:
- label
- value
type: object
properties:
label:
description: |
The total storage (in Megabytes) the specified component has
type: string
value:
type: integer
minimum: 0
examples:
- 99
model_number:
required:
- label
- value
type: object
properties:
label:
description: |
The model number of the specified component
type: string
value:
type: string
minLength: 1
maxLength: 32
examples:
- '686018014'
object_sense:
required:
- label
- value
type: object
properties:
label:
description: |
The number of Object Sense events
type: string
value:
type: integer
minimum: 0
examples:
- 537
power_on-events:
required:
- label
- value
type: object
properties:
label:
description: |
The total number of power on events
type: string
value:
type: integer
minimum: 1
examples:
- 7
power_on-time:
required:
- label
- value
type: object
properties:
label:
description: |
The total number of hours the component has been powered on
type: string
value:
type: integer
minimum: 0
examples:
- 2962
resets:
required:
- label
- value
type: object
properties:
label:
description: |
The total number of times the specified component has reset
type: string
value:
type: integer
minimum: 0
examples:
- 4
resets-errors:
required:
- label
- value
type: object
properties:
label:
description: |
The total number of times the specified component has reset due to an error
type: string
value:
type: integer
minimum: 0
examples:
- 1
satellite:
required:
- label
- value
type: object
properties:
label:
description: |
The number of Top Down Reader (TDR) and Color Camera Modules (CCM) paired to the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 1
scale:
required:
- label
- value
type: object
properties:
label:
description: |
Indicates if scale feature is enabled
type: string
value:
type: boolean
examples:
- false
scale-calibration:
required:
- label
- value
type: object
properties:
label:
description: |
The number of scale calibration attempts
type: string
value:
type: integer
minimum: 0
examples:
- 2
scale-sentry-activation:
required:
- label
- value
type: object
properties:
label:
description: |
The number of Scale Sentry activations
type: string
value:
type: integer
minimum: 0
examples:
- 2
scale-sentry-deactivation:
required:
- label
- value
type: object
properties:
label:
description: |
The number of Scale Sentry deactivations
type: string
value:
type: integer
minimum: 0
examples:
- 1
scale-version:
required:
- label
- value
type: object
properties:
label:
description: |
The version of the integrated scale
type: string
value:
type: string
minLength: 4
maxLength: 4
examples:
- T1BA
scale-zero-button:
required:
- label
- value
type: object
properties:
label:
description: |
The number of Scale Zero attempts by button press
type: string
value:
type: integer
minimum: 0
examples:
- 7
scale-zero-pos:
required:
- label
- value
type: object
properties:
label:
description: |
The number of Scale Zero attempts by command sent by the Point of Sale
type: string
value:
type: integer
minimum: 0
examples:
- 1
scale-zero-required:
required:
- label
- value
type: object
properties:
label:
description: |
The number of times the scale required being re-zeroed
type: string
value:
type: integer
minimum: 0
examples:
- 2
sdcard-storage-available:
required:
- label
- value
type: object
properties:
label:
description: |
The storage (in Megabytes) available to be used by the SD Card inserted in the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 99
sdcard-storage-total:
required:
- label
- value
type: object
properties:
label:
description: |
The total storage (in Megabytes) the SD Card inserted in the specified component has
type: string
value:
type: integer
minimum: 0
examples:
- 673
serial_number:
required:
- label
- value
type: object
properties:
label:
description: |
The serial number of the specified component
type: string
value:
type: string
minLength: 1
maxLength: 32
examples:
- G23HBCXKE
tpu-status:
required:
- label
- value
type: object
properties:
label:
description: |
Indicates if the Tensor Processing Unit (TPU) is installed in the component
type: string
value:
type: boolean
examples:
- true
tpu-temperature:
required:
- label
- value
type: object
properties:
label:
description: |
The current temperature (in Celsius) of the TPU in the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 42
tpu-temperature-max:
required:
- label
- value
type: object
properties:
label:
description: |
The maximum temperature (in Celsius) of the TPU in the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 50
tpu-temperature-min:
required:
- label
- value
type: object
properties:
label:
description: |
The minimum temperature (in Celsius) of the TPU in the specified component
type: string
value:
type: integer
minimum: 0
examples:
- 38
uptime:
required:
- label
- value
type: object
properties:
label:
description: |
The time in seconds since the last boot
type: string
value:
type: integer
minimum: 0
examples:
- 67339
usb-drives-storage-available:
required:
- label
- value
type: object
properties:
label:
description: |
The storage (in Megabytes) available to be used by each USB drive attached to the specified component
type: string
value:
description: |
An entry for each USB Drive attached
type: array
minItems: 0
minimum: 0
items:
type: integer
examples:
- - 99
usb-drives-storage-total:
required:
- label
- value
type: object
properties:
label:
description: |
The total storage (in Megabytes) each USB drive attached to the specified component has
type: string
value:
description: |
An entry for each USB Drive attached
type: array
minItems: 0
minimum: 0
items:
type: integer
examples:
- - 673
m7:
required:
- label
- value
type: object
properties:
label:
description: |
The M7 software version for the specified component
type: string
value:
type: string
minLength: 1
examples:
- 2.2.0
mainboard-focused_serial_number:
required:
- label
- value
type: object
properties:
label:
description: |
The focused serial number of the main board in the specified component
type: string
value:
type: string
minLength: 1
maxLength: 32
examples:
- G23HBCXKE
status:
required:
- label
- value
type: object
properties:
label:
description: |
Indicates if the specified Top Down Reader (TDR) or Color Camera Module (CCM) is installed
type: string
value:
type: string
examples:
- 'Not Configured'
- 'Connecting'
- 'Connected'
- 'Disconnected'
- 'Resetting'
- 'Reset Complete'
AllInfo:
required:
- request
- values
type: object
properties:
request:
$ref: '#/components/schemas/request'
title: .
properties:
label:
enum:
- .
values:
type: array
description: |
All information values from all components
items:
anyOf:
- $ref: '#/components/schemas/application'
title: base/application
properties:
label:
enum:
- base/application
- $ref: '#/components/schemas/configuration'
title: base/configuration
properties:
label:
enum:
- base/configuration
- $ref: '#/components/schemas/cpu-temperature'
title: base/cpu/temperature
properties:
label:
enum:
- base/cpu/temperature
- $ref: '#/components/schemas/cpu-temperature-max'
title: base/cpu/temperature/max
properties:
label:
enum:
- base/cpu/temperature/max
- $ref: '#/components/schemas/cpu-temperature-min'
title: base/cpu/temperature/min
properties:
label:
enum:
- base/cpu/temperature/min
- $ref: '#/components/schemas/dwm'
title: base/dwm
properties:
label:
enum:
- base/dwm
- $ref: '#/components/schemas/eas-deactivation'
title: base/eas/deactivation
properties:
label:
enum:
- base/eas/deactivation
- $ref: '#/components/schemas/eas-deactivation-manual'
title: base/eas/deactivation/manual
properties:
label:
enum:
- base/eas/deactivation/manual
- $ref: '#/components/schemas/eas-io-fault'
title: base/eas/io/fault
properties:
label:
enum:
- base/eas/io/fault
- $ref: '#/components/schemas/eas-io-timeout'
title: base/eas/io/timeout
properties:
label:
enum:
- base/eas/io/timeout
- $ref: '#/components/schemas/eas-runtime-fault'
title: base/eas/runtime/fault
properties:
label:
enum:
- base/eas/runtime/fault
- $ref: '#/components/schemas/eas-tag'
title: base/eas/tag
properties:
label:
enum:
- base/eas/tag
- $ref: '#/components/schemas/ec_level'
title: base/ec_level
properties:
label:
enum:
- base/ec_level
- $ref: '#/components/schemas/ethernet-ports'
title: base/ethernet/ports
properties:
label:
enum:
- base/ethernet/ports
- $ref: '#/components/schemas/ethernet-ports-used'
title: base/ethernet/ports/used
properties:
label:
enum:
- base/ethernet/ports/used
- $ref: '#/components/schemas/evl'
title: base/evl
properties:
label:
enum:
- base/evl
- $ref: '#/components/schemas/formatter'
title: base/formatter
properties:
label:
enum:
- base/formatter
- $ref: '#/components/schemas/fpga'
title: base/fpga
properties:
label:
enum:
- base/fpga
- $ref: '#/components/schemas/hardware_id'
title: base/hardware_id
properties:
label:
enum:
- base/hardware_id
- $ref: '#/components/schemas/hhs-statuses'
title: base/hhs/statuses
properties:
label:
enum:
- base/hhs/statuses
- $ref: '#/components/schemas/imagers-labels_read-1d'
title: base/imagers/labels_read/1d
properties:
label:
enum:
- base/imagers/labels_read/1d
- $ref: '#/components/schemas/imagers-labels_read-2d'
title: base/imagers/labels_read/2d
properties:
label:
enum:
- base/imagers/labels_read/2d
- $ref: '#/components/schemas/imagers-labels_read-dwm'
title: base/imagers/labels_read/dwm
properties:
label:
enum:
- base/imagers/labels_read/dwm
- $ref: '#/components/schemas/imagers-status'
title: base/imagers/status
properties:
label:
enum:
- base/imagers/status
- $ref: '#/components/schemas/imagers-temperature'
title: base/imagers/temperature
properties:
label:
enum:
- base/imagers/temperature
- $ref: '#/components/schemas/imagers-temperature-max'
title: base/imagers/temperature/max
properties:
label:
enum:
- base/imagers/temperature/max
- $ref: '#/components/schemas/imagers-temperature-min'
title: base/imagers/temperature/min
properties:
label:
enum:
- base/imagers/temperature/min
- $ref: '#/components/schemas/interface'
title: base/interface
properties:
label:
enum:
- base/interface
- $ref: '#/components/schemas/labels_read'
title: base/labels_read
properties:
label:
enum:
- base/labels_read
- $ref: '#/components/schemas/labels_read-1d'
title: base/labels_read/1d
properties:
label:
enum:
- base/labels_read/1d
- $ref: '#/components/schemas/labels_read-1d-stitched'
title: base/labels_read/1d/stitched
properties:
label:
enum:
- base/labels_read/1d/stitched
- $ref: '#/components/schemas/labels_read-2d'
title: base/labels_read/2d
properties:
label:
enum:
- base/labels_read/2d
- $ref: '#/components/schemas/labels_read-dwm'
title: base/labels_read/dwm
properties:
label:
enum:
- base/labels_read/dwm
- $ref: '#/components/schemas/labels_read-hhs'
title: base/labels_read/hhs
properties:
label:
enum:
- base/labels_read/hhs
- $ref: '#/components/schemas/mainboard-model_number'
title: base/mainboard/model_number
properties:
label:
enum:
- base/mainboard/model_number
- $ref: '#/components/schemas/mainboard-serial_number'
title: base/mainboard/serial_number
properties:
label:
enum:
- base/mainboard/serial_number
- $ref: '#/components/schemas/mainboard-storage-available'
title: base/mainboard/storage/available
properties:
label:
enum:
- base/mainboard/storage/available
- $ref: '#/components/schemas/mainboard-storage-total'
title: base/mainboard/storage/total
properties:
label:
enum:
- base/mainboard/storage/total
- $ref: '#/components/schemas/model_number'
title: base/model_number
properties:
label:
enum:
- base/model_number
- $ref: '#/components/schemas/object_sense'
title: base/object_sense
properties:
label:
enum:
- base/object_sense
- $ref: '#/components/schemas/power_on-events'
title: base/power_on/events
properties:
label:
enum:
- base/power_on/events
- $ref: '#/components/schemas/power_on-time'
title: base/power_on/time
properties:
label:
enum:
- base/power_on/time
- $ref: '#/components/schemas/resets'
title: base/resets
properties:
label:
enum:
- base/resets
- $ref: '#/components/schemas/resets-errors'
title: base/resets/errors
properties:
label:
enum:
- base/resets/errors
- $ref: '#/components/schemas/satellite'
title: base/satellite
properties:
label:
enum:
- base/satellite
- $ref: '#/components/schemas/scale'
title: base/scale
properties:
label:
enum:
- base/scale
- $ref: '#/components/schemas/scale-calibration'
title: base/scale/calibration
properties:
label:
enum:
- base/scale/calibration
- $ref: '#/components/schemas/scale-sentry-activation'
title: base/scale/sentry/activation
properties:
label:
enum:
- base/scale/sentry/activation
- $ref: '#/components/schemas/scale-sentry-deactivation'
title: base/scale/sentry/deactivation
properties:
label:
enum:
- base/scale/sentry/deactivation
- $ref: '#/components/schemas/scale-version'
title: base/scale/version
properties:
label:
enum:
- base/scale/version
- $ref: '#/components/schemas/scale-zero-button'
title: base/scale/zero/button
properties:
label:
enum:
- base/scale/zero/button
- $ref: '#/components/schemas/scale-zero-pos'
title: base/scale/zero/pos
properties:
label:
enum:
- base/scale/zero/pos
- $ref: '#/components/schemas/scale-zero-required'
title: base/scale/zero/required
properties:
label:
enum:
- base/scale/zero/required
- $ref: '#/components/schemas/sdcard-storage-available'
title: base/sdcard/storage/available
properties:
label:
enum:
- base/sdcard/storage/available
- $ref: '#/components/schemas/sdcard-storage-total'
title: base/sdcard/storage/total
properties:
label:
enum:
- base/sdcard/storage/total
- $ref: '#/components/schemas/serial_number'
title: base/serial_number
properties:
label:
enum:
- base/serial_number
- $ref: '#/components/schemas/tpu-status'
title: base/tpu/status
properties:
label:
enum:
- base/tpu/status
- $ref: '#/components/schemas/tpu-temperature'
title: base/tpu/temperature
properties:
label:
enum:
- base/tpu/temperature
- $ref: '#/components/schemas/tpu-temperature-max'
title: base/tpu/temperature/max
properties:
label:
enum:
- base/tpu/temperature/max
- $ref: '#/components/schemas/tpu-temperature-min'
title: base/tpu/temperature/min
properties:
label:
enum:
- base/tpu/temperature/min
- $ref: '#/components/schemas/uptime'
title: base/uptime
properties:
label:
enum:
- base/uptime
- $ref: '#/components/schemas/usb-drives-storage-available'
title: base/usb/drives/storage/available
properties:
label:
enum:
- base/usb/drives/storage/available
- $ref: '#/components/schemas/usb-drives-storage-total'
title: base/usb/drives/storage/total
properties:
label:
enum:
- base/usb/drives/storage/total
- $ref: '#/components/schemas/application'
title: ccmh/application
properties:
label:
enum:
- ccmh/application
- $ref: '#/components/schemas/cpu-temperature'
title: ccmh/cpu/temperature
properties:
label:
enum:
- ccmh/cpu/temperature
- $ref: '#/components/schemas/cpu-temperature-max'
title: ccmh/cpu/temperature/max
properties:
label:
enum:
- ccmh/cpu/temperature/max
- $ref: '#/components/schemas/cpu-temperature-min'
title: ccmh/cpu/temperature/min
properties:
label:
enum:
- ccmh/cpu/temperature/min
- $ref: '#/components/schemas/imagers-status'
title: ccmh/imagers/status
properties:
label:
enum:
- ccmh/imagers/status
- $ref: '#/components/schemas/imagers-temperature'
title: ccmh/imagers/temperature
properties:
label:
enum:
- ccmh/imagers/temperature
- $ref: '#/components/schemas/imagers-temperature-max'
title: ccmh/imagers/temperature/max
properties:
label:
enum:
- ccmh/imagers/temperature/max
- $ref: '#/components/schemas/imagers-temperature-min'
title: ccmh/imagers/temperature/min
properties:
label:
enum:
- ccmh/imagers/temperature/min
- $ref: '#/components/schemas/m7'
title: ccmh/m7
properties:
label:
enum:
- ccmh/m7
- $ref: '#/components/schemas/mainboard-focused_serial_number'
title: ccmh/mainboard/focused_serial_number
properties:
label:
enum:
- ccmh/mainboard/focused_serial_number
- $ref: '#/components/schemas/mainboard-serial_number'
title: ccmh/mainboard/serial_number
properties:
label:
enum:
- ccmh/mainboard/serial_number
- $ref: '#/components/schemas/mainboard-storage-available'
title: ccmh/mainboard/storage/available
properties:
label:
enum:
- ccmh/mainboard/storage/available
- $ref: '#/components/schemas/mainboard-storage-total'
title: ccmh/mainboard/storage/total
properties:
label:
enum:
- ccmh/mainboard/storage/total
- $ref: '#/components/schemas/serial_number'
title: ccmh/serial_number
properties:
label:
enum:
- ccmh/serial_number
- $ref: '#/components/schemas/status'
title: ccmh/status
properties:
label:
enum:
- ccmh/status
- $ref: '#/components/schemas/application'
title: ccmv/application
properties:
label:
enum:
- ccmv/application
- $ref: '#/components/schemas/cpu-temperature'
title: ccmv/cpu/temperature
properties:
label:
enum:
- ccmv/cpu/temperature
- $ref: '#/components/schemas/cpu-temperature-max'
title: ccmv/cpu/temperature/max
properties:
label:
enum:
- ccmv/cpu/temperature/max
- $ref: '#/components/schemas/cpu-temperature-min'
title: ccmv/cpu/temperature/min
properties:
label:
enum:
- ccmv/cpu/temperature/min
- $ref: '#/components/schemas/imagers-status'
title: ccmv/imagers/status
properties:
label:
enum:
- ccmv/imagers/status
- $ref: '#/components/schemas/imagers-temperature'
title: ccmv/imagers/temperature
properties:
label:
enum:
- ccmv/imagers/temperature
- $ref: '#/components/schemas/imagers-temperature-max'
title: ccmv/imagers/temperature/max
properties:
label:
enum:
- ccmv/imagers/temperature/max
- $ref: '#/components/schemas/imagers-temperature-min'
title: ccmv/imagers/temperature/min
properties:
label:
enum:
- ccmv/imagers/temperature/min
- $ref: '#/components/schemas/m7'
title: ccmv/m7
properties:
label:
enum:
- ccmv/m7
- $ref: '#/components/schemas/mainboard-focused_serial_number'
title: ccmv/mainboard/focused_serial_number
properties:
label:
enum:
- ccmv/mainboard/focused_serial_number
- $ref: '#/components/schemas/mainboard-serial_number'
title: ccmv/mainboard/serial_number
properties:
label:
enum:
- ccmv/mainboard/serial_number
- $ref: '#/components/schemas/mainboard-storage-available'
title: ccmv/mainboard/storage/available
properties:
label:
enum:
- ccmv/mainboard/storage/available
- $ref: '#/components/schemas/mainboard-storage-total'
title: ccmv/mainboard/storage/total
properties:
label:
enum:
- ccmv/mainboard/storage/total
- $ref: '#/components/schemas/serial_number'
title: ccmv/serial_number
properties:
label:
enum:
- ccmv/serial_number
- $ref: '#/components/schemas/status'
title: ccmv/status
properties:
label:
enum:
- ccmv/status
- $ref: '#/components/schemas/application'
title: tdr/application
properties:
label:
enum:
- tdr/application
- $ref: '#/components/schemas/cpu-temperature'
title: tdr/cpu/temperature
properties:
label:
enum:
- tdr/cpu/temperature
- $ref: '#/components/schemas/cpu-temperature-max'
title: tdr/cpu/temperature/max
properties:
label:
enum:
- tdr/cpu/temperature/max
- $ref: '#/components/schemas/cpu-temperature-min'
title: tdr/cpu/temperature/min
properties:
label:
enum:
- tdr/cpu/temperature/min
- $ref: '#/components/schemas/imagers-labels_read-1d'
title: tdr/imagers/labels_read/1d
properties:
label:
enum:
- tdr/imagers/labels_read/1d
- $ref: '#/components/schemas/imagers-labels_read-2d'
title: tdr/imagers/labels_read/2d
properties:
label:
enum:
- tdr/imagers/labels_read/2d
- $ref: '#/components/schemas/imagers-status'
title: tdr/imagers/status
properties:
label:
enum:
- tdr/imagers/status
- $ref: '#/components/schemas/imagers-temperature'
title: tdr/imagers/temperature
properties:
label:
enum:
- tdr/imagers/temperature
- $ref: '#/components/schemas/imagers-temperature-max'
title: tdr/imagers/temperature/max
properties:
label:
enum:
- tdr/imagers/temperature/max
- $ref: '#/components/schemas/imagers-temperature-min'
title: tdr/imagers/temperature/min
properties:
label:
enum:
- tdr/imagers/temperature/min
- $ref: '#/components/schemas/labels_read-1d'
title: tdr/labels_read/1d
properties:
label:
enum:
- tdr/labels_read/1d
- $ref: '#/components/schemas/labels_read-2d'
title: tdr/labels_read/2d
properties:
label:
enum:
- tdr/labels_read/2d
- $ref: '#/components/schemas/m7'
title: tdr/m7
properties:
label:
enum:
- tdr/m7
- $ref: '#/components/schemas/mainboard-focused_serial_number'
title: tdr/mainboard/focused_serial_number
properties:
label:
enum:
- tdr/mainboard/focused_serial_number
- $ref: '#/components/schemas/mainboard-serial_number'
title: tdr/mainboard/serial_number
properties:
label:
enum:
- tdr/mainboard/serial_number
- $ref: '#/components/schemas/mainboard-storage-available'
title: tdr/mainboard/storage/available
properties:
label:
enum:
- tdr/mainboard/storage/available
- $ref: '#/components/schemas/mainboard-storage-total'
title: tdr/mainboard/storage/total
properties:
label:
enum:
- tdr/mainboard/storage/total
- $ref: '#/components/schemas/serial_number'
title: tdr/serial_number
properties:
label:
enum:
- tdr/serial_number
- $ref: '#/components/schemas/status'
title: tdr/status
properties:
label:
enum:
- tdr/status
examples:
- request: /api/1.0.0/scanner_component
values:
- label: base/application
value: DR9401630
- label: base/configuration
value: DR9611516
- label: base/cpu/temperature
value: 42
- label: base/cpu/temperature/max
value: 50
- label: base/cpu/temperature/min
value: 38
- label: base/dwm
value: '3.12'
- label: base/eas/deactivation
value: 156
- label: base/eas/deactivation/manual
value: 2
- label: base/eas/io/fault
value: 0
- label: base/eas/io/timeout
value: 1
- label: base/eas/runtime/fault
value: 0
- label: base/eas/tag
value: 1
- label: base/ec_level
value: '0051'
- label: base/ethernet/ports
value: 7
- label: base/ethernet/ports/used
value: 3
- label: base/evl
value: 2.3.7.14.3
- label: base/formatter
value: '3.11'
- label: base/fpga
value: 0a02
- label: base/hardware_id
value: '9900'
- label: base/hhs/statuses
value: 1
- label: base/imagers/labels_read/1d
value:
- 3289
- 3481
- label: base/imagers/labels_read/2d
value:
- 654
- 25
- label: base/imagers/labels_read/dwm
value:
- 46
- 99
- label: base/imagers/status
value:
- OK
- OK
- FAIL
- OK
- label: base/imagers/temperature
value:
- 42
- 43
- 40
- 42
- label: base/imagers/temperature/max
value:
- 52
- 53
- 50
- 52
- label: base/imagers/temperature/min
value:
- 32
- 33
- 30
- 32
- label: base/interface
value: '45'
- label: base/labels_read
value: 23487
- label: base/labels_read/1d
value: 3289
- label: base/labels_read/1d/stitched
value: 385
- label: base/labels_read/2d
value: 654
- label: base/labels_read/dwm
value: 38
- label: base/labels_read/hhs
value: 379
- label: base/mainboard/model_number
value: '686018014'
- label: base/mainboard/serial_number
value: G23HBCXKE
- label: base/mainboard/storage/available
value: 673
- label: base/mainboard/storage/total
value: 99
- label: base/model_number
value: '686018014'
- label: base/object_sense
value: 537
- label: base/power_on/events
value: 7
- label: base/power_on/time
value: 2962
- label: base/resets
value: 4
- label: base/resets/errors
value: 1
- label: base/satellite
value: 1
- label: base/scale
value: false
- label: base/scale/calibration
value: 2
- label: base/scale/sentry/activation
value: 2
- label: base/scale/sentry/deactivation
value: 1
- label: base/scale/version
value: T1BA
- label: base/scale/zero/button
value: 7
- label: base/scale/zero/pos
value: 1
- label: base/scale/zero/required
value: 2
- label: base/sdcard/storage/available
value: 99
- label: base/sdcard/storage/total
value: 673
- label: base/serial_number
value: G23HBCXKE
- label: base/tpu/status
value: true
- label: base/tpu/temperature
value: 42
- label: base/tpu/temperature/max
value: 50
- label: base/tpu/temperature/min
value: 38
- label: base/uptime
value: 67339
- label: base/usb/drives/storage/available
value:
- 99
- label: base/usb/drives/storage/total
value:
- 673
- label: ccmh/application
value: DR9401631
- label: ccmh/cpu/temperature
value: 42
- label: ccmh/cpu/temperature/max
value: 50
- label: ccmh/cpu/temperature/min
value: 38
- label: ccmh/imagers/status
value:
- OK
- label: ccmh/imagers/temperature
value:
- 43
- label: ccmh/imagers/temperature/max
value:
- 53
- label: ccmh/imagers/temperature/min
value:
- 33
- label: ccmh/m7
value: 2.2.0
- label: ccmh/mainboard/focused_serial_number
value: G23HBCXKE
- label: ccmh/mainboard/serial_number
value: G23HBCXKE
- label: ccmh/mainboard/storage/available
value: 673
- label: ccmh/mainboard/storage/total
value: 99
- label: ccmh/serial_number
value: G23HBCXKE
- label: ccmh/status
value: 'Connected'
- label: ccmv/application
value: DR9401631
- label: ccmv/cpu/temperature
value: 42
- label: ccmv/cpu/temperature/max
value: 50
- label: ccmv/cpu/temperature/min
value: 38
- label: ccmv/imagers/status
value:
- OK
- label: ccmv/imagers/temperature
value:
- 43
- label: ccmv/imagers/temperature/max
value:
- 53
- label: ccmv/imagers/temperature/min
value:
- 33
- label: ccmv/m7
value: 2.2.0
- label: ccmv/mainboard/focused_serial_number
value: G23HBCXKF
- label: ccmv/mainboard/serial_number
value: G23HBCXKF
- label: ccmv/mainboard/storage/available
value: 673
- label: ccmv/mainboard/storage/total
value: 99
- label: ccmv/serial_number
value: G23HBCXKF
- label: ccmv/status
value: 'Connected'
- label: tdr/application
value: DR9401631
- label: tdr/cpu/temperature
value: 42
- label: tdr/cpu/temperature/max
value: 50
- label: tdr/cpu/temperature/min
value: 38
- label: tdr/imagers/labels_read/1d
value:
- 3289
- 32
- label: tdr/imagers/labels_read/2d
value:
- 654
- 1
- label: tdr/imagers/status
value:
- OK
- OK
- label: tdr/imagers/temperature
value:
- 42
- 43
- label: tdr/imagers/temperature/max
value:
- 52
- 53
- label: tdr/imagers/temperature/min
value:
- 32
- 33
- label: tdr/labels_read/1d
value: 654
- label: tdr/labels_read/2d
value: 79
- label: tdr/m7
value: 2.2.0
- label: tdr/mainboard/focused_serial_number
value: G23HBCXKE
- label: tdr/mainboard/serial_number
value: G23HBCXKE
- label: tdr/mainboard/storage/available
value: 673
- label: tdr/mainboard/storage/total
value: 99
- label: tdr/serial_number
value: G23HBCXKE
- label: tdr/status
value: 'Connected'
AllBaseInfo:
required:
- request
- values
type: object
properties:
request:
$ref: '#/components/schemas/request'
values:
type: array
description: |
All information values from `base` component
items:
anyOf:
- $ref: '#/components/schemas/application'
title: application
properties:
label:
enum:
- application
- $ref: '#/components/schemas/configuration'
title: configuration
properties:
label:
enum:
- configuration
- $ref: '#/components/schemas/cpu-temperature'
title: cpu/temperature
properties:
label:
enum:
- cpu/temperature
- $ref: '#/components/schemas/cpu-temperature-max'
title: cpu/temperature/max
properties:
label:
enum:
- cpu/temperature/max
- $ref: '#/components/schemas/cpu-temperature-min'
title: cpu/temperature/min
properties:
label:
enum:
- cpu/temperature/min
- $ref: '#/components/schemas/dwm'
title: dwm
properties:
label:
enum:
- dwm
- $ref: '#/components/schemas/eas-deactivation'
title: eas/deactivation
properties:
label:
enum:
- eas/deactivation
- $ref: '#/components/schemas/eas-deactivation-manual'
title: eas/deactivation/manual
properties:
label:
enum:
- eas/deactivation/manual
- $ref: '#/components/schemas/eas-io-fault'
title: eas/io/fault
properties:
label:
enum:
- eas/io/fault
- $ref: '#/components/schemas/eas-io-timeout'
title: eas/io/timeout
properties:
label:
enum:
- eas/io/timeout
- $ref: '#/components/schemas/eas-runtime-fault'
title: eas/runtime/fault
properties:
label:
enum:
- eas/runtime/fault
- $ref: '#/components/schemas/eas-tag'
title: eas/tag
properties:
label:
enum:
- eas/tag
- $ref: '#/components/schemas/ec_level'
title: ec_level
properties:
label:
enum:
- ec_level
- $ref: '#/components/schemas/ethernet-ports'
title: ethernet/ports
properties:
label:
enum:
- ethernet/ports
- $ref: '#/components/schemas/ethernet-ports-used'
title: ethernet/ports/used
properties:
label:
enum:
- ethernet/ports/used
- $ref: '#/components/schemas/evl'
title: evl
properties:
label:
enum:
- evl
- $ref: '#/components/schemas/formatter'
title: formatter
properties:
label:
enum:
- formatter
- $ref: '#/components/schemas/fpga'
title: fpga
properties:
label:
enum:
- fpga
- $ref: '#/components/schemas/hardware_id'
title: hardware_id
properties:
label:
enum:
- hardware_id
- $ref: '#/components/schemas/hhs-statuses'
title: hhs/statuses
properties:
label:
enum:
- hhs/statuses
- $ref: '#/components/schemas/imagers-labels_read-1d'
title: imagers/labels_read/1d
properties:
label:
enum:
- imagers/labels_read/1d
- $ref: '#/components/schemas/imagers-labels_read-2d'
title: imagers/labels_read/2d
properties:
label:
enum:
- imagers/labels_read/2d
- $ref: '#/components/schemas/imagers-labels_read-dwm'
title: imagers/labels_read/dwm
properties:
label:
enum:
- imagers/labels_read/dwm
- $ref: '#/components/schemas/imagers-status'
title: imagers/status
properties:
label:
enum:
- imagers/status
- $ref: '#/components/schemas/imagers-temperature'
title: imagers/temperature
properties:
label:
enum:
- imagers/temperature
- $ref: '#/components/schemas/imagers-temperature-max'
title: imagers/temperature/max
properties:
label:
enum:
- imagers/temperature/max
- $ref: '#/components/schemas/imagers-temperature-min'
title: imagers/temperature/min
properties:
label:
enum:
- imagers/temperature/min
- $ref: '#/components/schemas/interface'
title: interface
properties:
label:
enum:
- interface
- $ref: '#/components/schemas/labels_read'
title: labels_read
properties:
label:
enum:
- labels_read
- $ref: '#/components/schemas/labels_read-1d'
title: labels_read/1d
properties:
label:
enum:
- labels_read/1d
- $ref: '#/components/schemas/labels_read-1d-stitched'
title: labels_read/1d/stitched
properties:
label:
enum:
- labels_read/1d/stitched
- $ref: '#/components/schemas/labels_read-2d'
title: labels_read/2d
properties:
label:
enum:
- labels_read/2d
- $ref: '#/components/schemas/labels_read-dwm'
title: labels_read/dwm
properties:
label:
enum:
- labels_read/dwm
- $ref: '#/components/schemas/labels_read-hhs'
title: labels_read/hhs
properties:
label:
enum:
- labels_read/hhs
- $ref: '#/components/schemas/mainboard-model_number'
title: mainboard/model_number
properties:
label:
enum:
- mainboard/model_number
- $ref: '#/components/schemas/mainboard-serial_number'
title: mainboard/serial_number
properties:
label:
enum:
- mainboard/serial_number
- $ref: '#/components/schemas/mainboard-storage-available'
title: mainboard/storage/available
properties:
label:
enum:
- mainboard/storage/available
- $ref: '#/components/schemas/mainboard-storage-total'
title: mainboard/storage/total
properties:
label:
enum:
- mainboard/storage/total
- $ref: '#/components/schemas/model_number'
title: model_number
properties:
label:
enum:
- model_number
- $ref: '#/components/schemas/object_sense'
title: object_sense
properties:
label:
enum:
- object_sense
- $ref: '#/components/schemas/power_on-events'
title: power_on/events
properties:
label:
enum:
- power_on/events
- $ref: '#/components/schemas/power_on-time'
title: power_on/time
properties:
label:
enum:
- power_on/time
- $ref: '#/components/schemas/resets'
title: resets
properties:
label:
enum:
- resets
- $ref: '#/components/schemas/resets-errors'
title: resets/errors
properties:
label:
enum:
- resets/errors
- $ref: '#/components/schemas/satellite'
title: satellite
properties:
label:
enum:
- satellite
- $ref: '#/components/schemas/scale'
title: scale
properties:
label:
enum:
- scale
- $ref: '#/components/schemas/scale-calibration'
title: scale/calibration
properties:
label:
enum:
- scale/calibration
- $ref: '#/components/schemas/scale-sentry-activation'
title: scale/sentry/activation
properties:
label:
enum:
- scale/sentry/activation
- $ref: '#/components/schemas/scale-sentry-deactivation'
title: scale/sentry/deactivation
properties:
label:
enum:
- scale/sentry/deactivation
- $ref: '#/components/schemas/scale-version'
title: scale/version
properties:
label:
enum:
- scale/version
- $ref: '#/components/schemas/scale-zero-button'
title: scale/zero/button
properties:
label:
enum:
- scale/zero/button
- $ref: '#/components/schemas/scale-zero-pos'
title: scale/zero/pos
properties:
label:
enum:
- scale/zero/pos
- $ref: '#/components/schemas/scale-zero-required'
title: scale/zero/required
properties:
label:
enum:
- scale/zero/required
- $ref: '#/components/schemas/sdcard-storage-available'
title: sdcard/storage/available
properties:
label:
enum:
- sdcard/storage/available
- $ref: '#/components/schemas/sdcard-storage-total'
title: sdcard/storage/total
properties:
label:
enum:
- sdcard/storage/total
- $ref: '#/components/schemas/serial_number'
title: serial_number
properties:
label:
enum:
- serial_number
- $ref: '#/components/schemas/tpu-status'
title: tpu/status
properties:
label:
enum:
- tpu/status
- $ref: '#/components/schemas/tpu-temperature'
title: tpu/temperature
properties:
label:
enum:
- tpu/temperature
- $ref: '#/components/schemas/tpu-temperature-max'
title: tpu/temperature/max
properties:
label:
enum:
- tpu/temperature/max
- $ref: '#/components/schemas/tpu-temperature-min'
title: tpu/temperature/min
properties:
label:
enum:
- tpu/temperature/min
- $ref: '#/components/schemas/uptime'
title: uptime
properties:
label:
enum:
- uptime
- $ref: '#/components/schemas/usb-drives-storage-available'
title: usb/drives/storage/available
properties:
label:
enum:
- usb/drives/storage/available
- $ref: '#/components/schemas/usb-drives-storage-total'
title: usb/drives/storage/total
properties:
label:
enum:
- usb/drives/storage/total
examples:
- request: /api/1.0.0/scanner_component/base
values:
- label: application
value: DR9401630
- label: configuration
value: DR9611516
- label: cpu/temperature
value: 42
- label: cpu/temperature/max
value: 50
- label: cpu/temperature/min
value: 38
- label: dwm
value: '3.12'
- label: eas/deactivation
value: 156
- label: eas/deactivation/manual
value: 2
- label: eas/io/fault
value: 0
- label: eas/io/timeout
value: 1
- label: eas/runtime/fault
value: 0
- label: eas/tag
value: 1
- label: ec_level
value: '0051'
- label: ethernet/ports
value: 7
- label: ethernet/ports/used
value: 3
- label: evl
value: 2.3.7.14.3
- label: formatter
value: '3.11'
- label: fpga
value: 0a02
- label: hardware_id
value: '9900'
- label: hhs/statuses
value: 1
- label: imagers/labels_read/1d
value:
- 3289
- 3481
- label: imagers/labels_read/2d
value:
- 654
- 25
- label: imagers/labels_read/dwm
value:
- 46
- 99
- label: imagers/status
value:
- OK
- OK
- FAIL
- OK
- label: imagers/temperature
value:
- 42
- 43
- 40
- 42
- label: imagers/temperature/max
value:
- 52
- 53
- 50
- 52
- label: imagers/temperature/min
value:
- 32
- 33
- 30
- 32
- label: interface
value: '45'
- label: labels_read
value: 23487
- label: labels_read/1d
value: 3289
- label: labels_read/1d/stitched
value: 385
- label: labels_read/2d
value: 654
- label: labels_read/dwm
value: 38
- label: labels_read/hhs
value: 379
- label: mainboard/model_number
value: '686018014'
- label: mainboard/serial_number
value: G23HBCXKE
- label: mainboard/storage/available
value: 673
- label: mainboard/storage/total
value: 99
- label: model_number
value: '686018014'
- label: object_sense
value: 537
- label: power_on/events
value: 7
- label: power_on/time
value: 2962
- label: resets
value: 4
- label: resets/errors
value: 1
- label: satellite
value: 1
- label: scale
value: false
- label: scale/calibration
value: 2
- label: scale/sentry/activation
value: 2
- label: scale/sentry/deactivation
value: 1
- label: scale/version
value: T1BA
- label: scale/zero/button
value: 7
- label: scale/zero/pos
value: 1
- label: scale/zero/required
value: 2
- label: sdcard/storage/available
value: 99
- label: sdcard/storage/total
value: 673
- label: serial_number
value: G23HBCXKE
- label: tpu/status
value: true
- label: tpu/temperature
value: 42
- label: tpu/temperature/max
value: 50
- label: tpu/temperature/min
value: 38
- label: uptime
value: 67339
- label: usb/drives/storage/available
value:
- 99
- label: usb/drives/storage/total
value:
- 673
AllCCMInfo:
required:
- request
- values
type: object
properties:
request:
$ref: '#/components/schemas/request'
values:
type: array
description: |
All information values from a CCM component type
items:
anyOf:
- $ref: '#/components/schemas/application'
title: application
properties:
label:
enum:
- application
- $ref: '#/components/schemas/cpu-temperature'
title: cpu/temperature
properties:
label:
enum:
- cpu/temperature
- $ref: '#/components/schemas/cpu-temperature-max'
title: cpu/temperature/max
properties:
label:
enum:
- cpu/temperature/max
- $ref: '#/components/schemas/cpu-temperature-min'
title: cpu/temperature/min
properties:
label:
enum:
- cpu/temperature/min
- $ref: '#/components/schemas/imagers-status'
title: imagers/status
properties:
label:
enum:
- imagers/status
- $ref: '#/components/schemas/imagers-temperature'
title: imagers/temperature
properties:
label:
enum:
- imagers/temperature
- $ref: '#/components/schemas/imagers-temperature-max'
title: imagers/temperature/max
properties:
label:
enum:
- imagers/temperature/max
- $ref: '#/components/schemas/imagers-temperature-min'
title: imagers/temperature/min
properties:
label:
enum:
- imagers/temperature/min
- $ref: '#/components/schemas/m7'
title: m7
properties:
label:
enum:
- m7
- $ref: '#/components/schemas/mainboard-focused_serial_number'
title: mainboard/focused_serial_number
properties:
label:
enum:
- mainboard/focused_serial_number
- $ref: '#/components/schemas/mainboard-serial_number'
title: mainboard/serial_number
properties:
label:
enum:
- mainboard/serial_number
- $ref: '#/components/schemas/mainboard-storage-available'
title: mainboard/storage/available
properties:
label:
enum:
- mainboard/storage/available
- $ref: '#/components/schemas/mainboard-storage-total'
title: mainboard/storage/total
properties:
label:
enum:
- mainboard/storage/total
- $ref: '#/components/schemas/serial_number'
title: serial_number
properties:
label:
enum:
- serial_number
- $ref: '#/components/schemas/status'
title: status
properties:
label:
enum:
- status
examples:
- request: /api/1.0.0/scanner_component/ccmh
values:
- label: application
value: DR9401631
- label: cpu/temperature
value: 42
- label: cpu/temperature/max
value: 50
- label: cpu/temperature/min
value: 38
- label: imagers/status
value:
- OK
- label: imagers/temperature
value:
- 43
- label: imagers/temperature/max
value:
- 53
- label: imagers/temperature/min
value:
- 33
- label: m7
value: 2.2.0
- label: mainboard/focused_serial_number
value: G23HBCXKE
- label: mainboard/serial_number
value: G23HBCXKE
- label: mainboard/storage/available
value: 673
- label: mainboard/storage/total
value: 99
- label: serial_number
value: G23HBCXKE
- label: status
value: 'Connected'
AllTDRInfo:
required:
- request
- values
type: object
properties:
request:
$ref: '#/components/schemas/request'
values:
type: array
description: |
All information values from `tdr` component
items:
anyOf:
- $ref: '#/components/schemas/application'
title: application
properties:
label:
enum:
- application
- $ref: '#/components/schemas/cpu-temperature'
title: cpu/temperature
properties:
label:
enum:
- cpu/temperature
- $ref: '#/components/schemas/cpu-temperature-max'
title: cpu/temperature/max
properties:
label:
enum:
- cpu/temperature/max
- $ref: '#/components/schemas/cpu-temperature-min'
title: cpu/temperature/min
properties:
label:
enum:
- cpu/temperature/min
- $ref: '#/components/schemas/imagers-labels_read-1d'
title: imagers/labels_read/1d
properties:
label:
enum:
- imagers/labels_read/1d
- $ref: '#/components/schemas/imagers-labels_read-2d'
title: imagers/labels_read/2d
properties:
label:
enum:
- imagers/labels_read/2d
- $ref: '#/components/schemas/imagers-status'
title: imagers/status
properties:
label:
enum:
- imagers/status
- $ref: '#/components/schemas/imagers-temperature'
title: imagers/temperature
properties:
label:
enum:
- imagers/temperature
- $ref: '#/components/schemas/imagers-temperature-max'
title: imagers/temperature/max
properties:
label:
enum:
- imagers/temperature/max
- $ref: '#/components/schemas/imagers-temperature-min'
title: imagers/temperature/min
properties:
label:
enum:
- imagers/temperature/min
- $ref: '#/components/schemas/labels_read-1d'
title: labels_read/1d
properties:
label:
enum:
- labels_read/1d
- $ref: '#/components/schemas/labels_read-2d'
title: labels_read/2d
properties:
label:
enum:
- labels_read/2d
- $ref: '#/components/schemas/m7'
title: m7
properties:
label:
enum:
- m7
- $ref: '#/components/schemas/mainboard-focused_serial_number'
title: mainboard/focused_serial_number
properties:
label:
enum:
- mainboard/focused_serial_number
- $ref: '#/components/schemas/mainboard-serial_number'
title: mainboard/serial_number
properties:
label:
enum:
- mainboard/serial_number
- $ref: '#/components/schemas/mainboard-storage-available'
title: mainboard/storage/available
properties:
label:
enum:
- mainboard/storage/available
- $ref: '#/components/schemas/mainboard-storage-total'
title: mainboard/storage/total
properties:
label:
enum:
- mainboard/storage/total
- $ref: '#/components/schemas/serial_number'
title: serial_number
properties:
label:
enum:
- serial_number
- $ref: '#/components/schemas/status'
title: status
properties:
label:
enum:
- status
examples:
- request: /api/1.0.0/scanner_component/tdr
values:
- label: application
value: DR9401631
- label: cpu/temperature
value: 42
- label: cpu/temperature/max
value: 50
- label: cpu/temperature/min
value: 38
- label: imagers/labels_read/1d
value:
- 3289
- 32
- label: imagers/labels_read/2d
value:
- 654
- 1
- label: imagers/status
value:
- OK
- OK
- label: imagers/temperature
value:
- 42
- 43
- label: imagers/temperature/max
value:
- 52
- 53
- label: imagers/temperature/min
value:
- 32
- 33
- label: labels_read/1d
value: 654
- label: labels_read/2d
value: 79
- label: m7
value: 2.2.0
- label: mainboard/focused_serial_number
value: G23HBCXKE
- label: mainboard/serial_number
value: G23HBCXKE
- label: mainboard/storage/available
value: 673
- label: mainboard/storage/total
value: 99
- label: serial_number
value: G23HBCXKE
- label: status
value: 'Connected'
Info:
required:
- request
- values
type: object
properties:
request:
$ref: '#/components/schemas/request'
value:
type: array
items:
type: object
description: The requested `{fieldLabel}` and value
required:
- label
- value
properties:
label:
type: string
description: The `{fieldLabel}`
examples:
- ccmv/imagers/status
value:
description: |
The value of the requested `{fieldLabel}`.
For details, see the `{fieldLabel}` in the `/scanner_component` endpoint.
oneOf:
- type: string
description: When `{fieldLabel}` is a string type
examples:
- DR9401630
- type: boolean
description: When `{fieldLabel}` is a boolean type
examples:
- false
- type: integer
description: When `{fieldLabel}` is a integer type
examples:
- 42
- type: array
items:
oneOf:
- type: string
description: When `{fieldLabel}` is a array of strings type
examples:
- - OK
- OK
- type: integer
description: When `{fieldLabel}` is a array of integer type
examples:
- - 32
- 30
examples:
- request: /api/1.0.0/scanner_component/base/application
values:
- label: application
value: DR9401630
- request: /api/1.0.0/scanner_component/ccmh/status
values:
- label: status
value: false
- request: /api/1.0.0/scanner_component/tdr/cpu/temperature
values:
- label: cpu/temperature
value: 42
- request: /api/1.0.0/scanner_component/ccmh/imagers/temperature/max
values:
- label: imagers/temperature/max
value:
- 53
- request: /api/1.0.0/scanner_component/ccmv/imagers/status
values:
- label: imagers/status
value:
- OK
roi:
required:
- bottom
- left
- right
- top
type: object
properties:
left:
maximum: 2559
minimum: 0
type: integer
description: |
Number of pixels from the left edge to start ROI.
Value must be less than the `right` value.
format: int32
top:
maximum: 1599
minimum: 0
type: integer
description: |
Number of pixels from the top edge to start ROI
Value must be less than the `bottom` value.
format: int32
right:
maximum: 2559
minimum: 0
type: integer
description: |
Number of pixels from the right edge to start ROI
Value must be greater than the `left` value.
format: int32
bottom:
maximum: 1599
minimum: 0
type: integer
description: |
Number of pixels from the bottom edge to start ROI
Value must be greater than the `top` value.
format: int32
protocol:
type: string
description: |
Streaming protocol
- `rtsp`: Real-Time Streaming Protocol (RTSP) stream over the network
- `uvc`: USB Video via the USB3 cable connected to the Top Down Reader (TDR) or Color Camera Module (CCM)
- Only supported if `component` is `tdr`, `ccmv`, or `ccmh`.
enum:
- rtsp
- uvc
codec:
description: |
When `protocol` is `rtsp`, the codec of the video stream.
- `h.264`: Use the H.264 compression standard
- `h.265`: Use the H.265 compression standard
type: string
enum:
- h.264
- h.265
scale_video:
description: |
How the video should is scaled.
Scaling preserves the aspect ratio.
- `1.0`: no scale applied
- `0.5`: video scaled to 50% in both dimensions
- `0.25`: video scaled to 25% in both dimensions
type: number
default: 1.0
enum:
- 1.0
- 0.5
- 0.25
examples:
- 0.25
imager:
type: string
description: |
When `component` is `base`, the imager to stream from.
For other `component` values, `imager` is not valid.
Left/right is determined when the user is looking at the vertical bonnet with the buttons facing the user.
- `montage`: All 4 imagers in a 2 x 2 grid where:
- Top Left: `vertical-left`
- Top Right: `vertical-right`
- Bottom Left: `horizontal-left`
- Bottom Right: `horizontal-right`
- `horizontal-left`: Imager on the left side of the horizontal plane (below the platter)
- `horizontal-right`: Imager on the right side of the horizontal plane (below the platter)
- `vertical-left`: Imager on the left side of the vertical plane (in the bonnet)
- `vertical-right`: Imager on the right side of the vertical plane (in the bonnet)
default: montage
examples:
- vertical-left
currency_assist:
type: boolean
description: |
Indicates whether Currency Assist should be activated.
Only valid for TDR.
- true: activate Currency Assist
- false: do not activate Currency Assist
default: false
examples:
- true
sound-data:
type: string
description: |
Contents of the sound file to upload
responses:
'400':
description: Bad input parameter
'500':
description: Internal server error
'503':
description: Service unavailable
parameters:
ccm:
name: ccm
in: path
description: |
The CCM component type
- `ccmv`: The Color Camera Module (CCM) in the vertical plane (in the bonnet)
- `ccmh`: The Color Camera Module (CCM) in the horizontal plane (below the platter)
required: true
style: simple
explode: false
schema:
type: string
enum:
- ccmv
- ccmh
examples:
- ccmv
component:
name: component
in: path
description: |
Targeted scanner component
- `base`: The base barcode scanner
- `tdr`: The Top Down Reader (TDR)
- `ccmv`: The Color Camera Module (CCM) in the vertical plane (in the bonnet)
- `ccmh`: The Color Camera Module (CCM) in the horizontal plane (below the platter)
required: true
style: simple
explode: false
schema:
type: string
enum:
- base
- tdr
- ccmv
- ccmh
example: base
fieldLabel:
name: fieldLabel
in: path
description: |
Label of specific information, status, or statistic
Possible values are any of the items returned by the `/scanner_component/{component}` request
required: true
style: simple
explode: false
schema:
type: string
example: cpu/temperature
when:
name: when
in: path
description: |
Get a new image or a previously requested image
- `next`: get a new image from the next frame
- `previous`: return a previously requested image
required: true
style: simple
explode: false
schema:
type: string
enum:
- next
- previous
example: next
format:
name: format
in: query
description: |
The format of the image to get.
- `bmp`: Return a Bitmap image
- `jpg`: Return a JPEG image
- `png`: Return a PNG image
- `raw`: Return the raw image data
- Images from the `base` are grayscale in 8 bits per pixel format
- Images from the other components are in YUV color format
required: false
style: form
explode: true
schema:
type: string
default: raw
enum:
- bmp
- jpg
- png
- raw
example: jpg
quality:
name: quality
in: query
description: |
When `format` is `jpg`, the quality of the image.
For other `format` values, `quality` is not valid.
required: false
style: form
explode: true
schema:
maximum: 100
minimum: 1
type: integer
format: int32
default: 90
example: 75
scale:
name: scale
in: query
description: |
How the image should be scaled. Scaling is applied after any `roi` cropping.
Scaling preserves the aspect ratio.
- `1`: no sale applied
- `0.5`: image scaled to 50% in both dimensions
- `0.25`: image scaled to 25% in both dimensions
required: false
style: form
explode: true
schema:
type: number
default: 1
enum:
- 1
- 0.5
- 0.25
examples:
- 0.25
roi:
name: roi
in: query
description: |
Define the 4 corners of the Region of Interest (ROI) of the image to return.
Image is cropped to specified region before applying any `scale`.
Values are in pixels.
When not specified, image is not cropped.
The true maximum value depends on the `component`:
- width (`left`/`right`)
- `base`: depends on the `imager`
- `montage`: 2559
- `horizontal-left`: 1279
- `horizontal-right`: 1279
- `vertical-left`: 1279
- `vertical-right`: 1279
- `tdr`: 1279
- `ccmv`: 1279
- `ccmh`: 1080
- height (`top`/`bottom`)
- `base`: depends on the `imager`
- `montage`: 1599
- `horizontal-left`: 799
- `horizontal-right`: 799
- `vertical-left`: 799
- `vertical-right`: 799
- `tdr`: 799
- `ccmv`: 799
- `ccmh`: 799
**Limitations**:
- When `format` is `bmp`, width (right-left) must be a multiple of 4
- When `component` is `ccmh`, `ccmv`, or `tdr`, the image may be slightly bigger than expected.
- The software will force the `left`/`top` to an even number, subtracting one from either or both if needed.
- The image will also be forced to an even width and height, adding one to the `right`/`bottom` if respectively
needed.
required: false
style: deepObject
explode: true
schema:
$ref: '#/components/schemas/roi'
example:
left: 750
top: 200
right: 1279
bottom: 499
imager:
name: imager
in: query
description: |
When `component` is `base`, the imager to get the picture from.
For other `component` values, `imager` is not valid.
Left/right is determined when the user is looking at the vertical bonnet with the buttons facing the user.
- `montage`: All 4 imagers in a 2 x 2 grid where:
- Top Left: `vertical-left`
- Top Right: `vertical-right`
- Bottom Left: `horizontal-left`
- Bottom Right: `horizontal-right`
- `horizontal-left`: Imager on the left side of the horizontal plane (below the platter)
- `horizontal-right`: Imager on the right side of the horizontal plane (below the platter)
- `vertical-left`: Imager on the left side of the vertical plane (in the bonnet)
- `vertical-right`: Imager on the right side of the vertical plane (in the bonnet)
required: false
style: form
explode: true
schema:
type: string
default: montage
enum:
- montage
- horizontal-left
- horizontal-right
- vertical-left
- vertical-right
example: vertical-left
sound:
name: sound
in: path
description: |
The sound to play or replace.
- 'good_beep': Beep that is played after successfully scanning a label.
- 'good_beep_cfr': Beep that is played after successfully scanning a label with the CFR.
- 'eas_error_beep': Beep that is played when an EAS error occurs.
- 'powerup_beep': Beep that is played at startup.
- 'sd_powerup_beep': Beep that is played at startup if booting from an SD card.
- 'alternate_beep': Beep that is played when an error occurs.
- 'prog_good_beep': Beep that is played when a label programming mode label is accepted.
- 'prog_bad_beep': Beep that is played when a label programming mode label is rejected.
- 'prog_spl_beep': Beep that is played when in label programming node.
- 'nof_beep': Beep that is played when not on file.
- 'trill_beep': Beep that is played when a label is rejected or when entering limited scanning mode.
- 'svc_port_plug_in': Beep that is played when USB service port is plugged in.
- 'svc_port_unplug': Beep that is played when USB service port is unplugged.
- 'hh_plug_in': Beep that is played when a handheld is plugged in.
- 'hh_unplug': Beep that is played when a handheld is unplugged.
- 'sdcard_mounted': Beep that is played when an SD card is plugged in & mounted.
- 'sdcard_unplug': Beep that is played when an SD card is unplugged.
- 'sdcard_mount': Beep that is played when an SD card is mounting.
- 'zero_beep': Beep that is played when zero button is pressed.
- 'special_beep': Beep that is played for special occasions.
- 'fru_beep': Beep that is played in FRU identification.
- 'reset_beep': Beep that is played before a user reset.
- 'limp_beep': Beep that is played when entering a limp condition.
- 'click_beep': Beep that is played when a button is pressed.
- 'scale_sentry_beep': Beep that is played on a scale sentry notification.
- 'btn_spl_beep': Beep that is played when adjusting the volume and tone.
- 'user_beep_1': User-defined beep #1.
- 'user_beep_2': User-defined beep #2.
- 'user_beep_3': User-defined beep #3.
- 'user_beep_4': User-defined beep #4.
- 'user_beep_5': User-defined beep #5.
- 'user_beep_6': User-defined beep #6.
- 'user_beep_7': User-defined beep #7.
- 'user_beep_8': User-defined beep #8.
- 'user_beep_9': User-defined beep #9.
- 'user_beep_10': User-defined beep #10.
- 'good_beep_low_tone': Beep that is played at the start and end of an Auto ID Queue Busting transaction.
- 'good_beep_med_tone': Beep that is played at the start and end of an Auto ID Queue Busting transaction.
- 'good_beep_high_tone': Beep that is played at the start and end of an Auto ID Queue Busting transaction.
- 'error_beep_tone': Beep that is played when an error occurs.
- 'user_test_beep': Beep that is played when after a user test.
- 'swu_update_beep': Beep that is played when starting a software update.
- 'error_beep': Beep that is played when a general error occurs.
- 'swu_update_success_beep': Beep that is played when a software update has completed.
required: true
style: simple
explode: false
schema:
type: string
enum:
- good_beep
- good_beep_cfr
- eas_error_beep
- powerup_beep
- sd_powerup_beep
- alternate_beep
- prog_good_beep
- prog_bad_beep
- prog_spl_beep
- nof_beep
- trill_beep
- svc_port_plug_in
- svc_port_unplug
- hh_plug_in
- hh_unplug
- sdcard_mounted
- sdcard_unplug
- sdcard_mount
- zero_beep
- special_beep
- fru_beep
- reset_beep
- limp_beep
- click_beep
- scale_sentry_beep
- btn_spl_beep
- user_beep_1
- user_beep_2
- user_beep_3
- user_beep_4
- user_beep_5
- user_beep_6
- user_beep_7
- user_beep_8
- user_beep_9
- user_beep_10
- good_beep_low_tone
- good_beep_med_tone
- good_beep_high_tone
- error_beep_tone
- user_test_beep
- swu_update_beep
- error_beep
- swu_update_success_beep