Scan Configuration JSON Schema
Below you can find the full JSON Schema used for the Plugin Configuration classes. You can also view the plugin_config.schema.json raw file.
| JSON Schemas are case sensitive The values defined in the JSON Schema are case sensitive. Make sure to only use values in your Plugin JSON that are also listed in the JSON Schemas. Using incorrect spelling or wrongly cased values may result in undefined behavior. |
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"measurementSystem": {
"type": "string",
"default": "Metric"
},
"scanSpeed": {
"type": "string",
"enum": [
"Slow",
"Fast"
],
"default": "Slow"
},
"useDefaultUI": {
"type": "boolean",
"default": "true"
},
"defaultUIConfig": {
"type": "object",
"properties": {
"distanceIndicatorConfig": {
"type": "object",
"properties": {
"visible": {
"type": "boolean"
},
"textOk": {
"type": "string"
},
"textMoveCloser": {
"type": "string"
},
"textMoveAway": {
"type": "string"
}
}
},
"focusPointTooltipConfig": {
"type": "object",
"properties": {
"visible": {
"type": "boolean"
},
"text": {
"type": "string"
}
}
},
"howToScanTooltipConfig": {
"type": "object",
"properties": {
"visible": {
"type": "boolean"
},
"text": {
"type": "string"
}
}
},
"tapToStartScanningTooltipConfig": {
"type": "object",
"properties": {
"visible": {
"type": "boolean"
},
"text": {
"type": "string"
}
}
},
"tireOverlayConfig": {
"type": "object",
"properties": {
"visible": {
"type": "boolean"
}
}
},
"uploadViewConfig": {
"type": "object",
"properties": {
"visible": {
"type": "boolean"
},
"text": {
"type": "string"
}
}
},
"progressTimerConfig": {
"type": "object",
"properties": {
"visible": {
"type": "boolean"
}
}
},
"lineProgressBarConfig": {
"type": "object",
"properties": {
"visible": {
"type": "boolean"
}
}
},
"orientationWarningConfig": {
"type": "object",
"properties": {
"visible": {
"type": "boolean"
},
"text": {
"type": "string"
}
}
}
}
},
"additionalContext": {
"type": "object",
"properties": {
"tirePosition": {
"type": "object",
"properties": {
"axle": {
"type": "integer",
"minimum": 1
},
"side": {
"type": "string",
"enum": [
"Left",
"Right",
"Center"
]
},
"positionOnAxle": {
"type": "integer",
"minimum": 1
}
},
"required": ["axle", "side", "positionOnAxle"]
},
"correlationId": {
"type": "string"
}
}
}
}
}