Scan Configuration JSON Schema

Below you can find the full JSON Schema used for the TireTreadScanView configuration, defined by the TireTreadConfig class.

Each attribute has a default value, so you can omit any attributes from your JSON file that do not require modification.

JSON Schemas are case sensitive The values defined in the JSON Schema are case sensitive. Make sure to only use values in your 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#",
  "title": "TireTreadConfig",
  "type": "object",
  "properties": {
    "uiConfig": {
      "type": "object",
      "properties": {
        "measurementSystem": {
          "type": "string"
        },
        "useDefaultUi": {
          "type": "boolean"
        },
        "useDefaultHaptic": {
          "type": "boolean"
        },
        "scanSpeed": {
          "type": "string"
        },
        "distanceIndicatorConfig": {
          "type": "object",
          "properties": {
            "visible": {
              "type": "boolean"
            },
            "textOk": {
              "type": "string"
            },
            "textMoveCloser": {
              "type": "string"
            },
            "textMoveAway": {
              "type": "string"
            }
          }
        },
        "focusPointTooltipConfig": {
          "type": "object",
          "properties": {
            "visible": {
              "type": "boolean"
            },
            "smallText": {
              "type": "string"
            },
            "text": {
              "type": "string"
            }
          }
        },
        "tapToStartScanningTooltipConfig": {
          "type": "object",
          "properties": {
            "visible": {
              "type": "boolean"
            },
            "textOk": {
              "type": "string"
            },
            "textNotOkMetric": {
              "type": "string"
            },
            "textNotOkImperial": {
              "type": "string"
            }
          }
        },
        "tireOverlayConfig": {
          "type": "object",
          "properties": {
            "visible": {
              "type": "boolean"
            }
          }
        },
        "uploadViewConfig": {
          "type": "object",
          "properties": {
            "visible": {
              "type": "boolean"
            },
            "text": {
              "type": "string"
            }
          }
        },
        "orientationWarningConfig": {
          "type": "object",
          "properties": {
            "visible": {
              "type": "boolean"
            },
            "text": {
              "type": "string"
            },
            "rotationLockHint": {
              "type": "string"
            }
          }
        },
        "countdownConfig": {
          "type": "object",
          "properties": {
            "visible": {
              "type": "boolean"
            }
          }
        },
        "scanDirectionConfig": {
          "type": "object",
          "properties": {
            "visible": {
              "type": "boolean"
            }
          }
        },
        "tireWidthInputConfig": {
          "type": "object",
          "properties": {
            "visible": {
              "type": "boolean"
            },
            "skipButtonText": {
              "type": "string"
            },
            "titleText": {
              "type": "string"
            },
            "explanationText": {
              "type": "string"
            },
            "continueButtonText": {
              "type": "string"
            },
            "prefilledTireWidth": {},
            "tireWidthRange": {
              "type": "object",
              "properties": {
                "lowerLimit": {
                  "type": "number"
                },
                "upperLimit": {
                  "type": "number"
                }
              }
            },
            "tireWidthOptions": {
              "type": "array",
              "items": {
                "type": "number"
              }
            }
          }
        },
        "missingPermissionConfig": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "text": {
              "type": "string"
            }
          }
        }
      }
    },
    "scanConfig": {
      "type": "object",
      "properties": {
        "tireWidth": {
          "type": "number"
        },
        "showMeasuringSpots": {
          "type": "boolean",
          "default": "true"
        },
        "heatmapStyle": {
          "type": "string",
          "enum": [
            "Colored",
            "GrayScale"
          ],
          "default": "Colored"
        }
      }
    },
    "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"
        }
      }
    }
  }
}