sdfobject-addressable_text_display.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "OMA/IPSO Addressable Text Display (Object ID 3341)",
    "version": "2022-02-22",
    "license": {
      "name": "BSD-3-Clause",
      "x-copyright": "Copyright 2019 Open Mobile Alliance."
    }
  },
  "schemes": [
    "http"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/Omaipsoaddressabletextdisplayobjectid3341ResURI": {
      "get": {
        "description": " This IPSO object is used to send text to a text-only or text mode graphics display. Writing a string of text to the text resource causes it to be displayed at the selected X and Y locations on the display. If X or Y are set to a value greater than the size of the display, the position \"wraps around\" to the modulus of the setting and the display size. Likewise, if the text string overflows the display size, the text \"wraps around\" and displays on the next line down or, if the last line has been written, wraps around to the top of the display. Brightness and Contrast controls are provided to allow control of various display types including STN and DSTN type LCD character displays. Writing an empty payload to the Clear Display resource causes the display to be erased.",
        "parameters": [
          {
            "$ref": "#/parameters/interface"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/Omaipsoaddressabletextdisplayobjectid3341"
            }
          }
        }
      }
    }
  },
  "parameters": {
    "interface": {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": [
        "oic.if.s",
        "oic.if.baseline"
      ]
    }
  },
  "definitions": {
    "Omaipsoaddressabletextdisplayobjectid3341": {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": [
              "oic.r.o.addressable.text.display"
            ],
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "n": {
          "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "if": {
          "description": "The OCF Interface set supported by this Resource.",
          "items": {
            "enum": [
              "oic.if.s",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "Text": {
          "description": "A string of text.",
          "x-label": "Text",
          "type": "string"
        },
        "X_Coordinate": {
          "description": "X Coordinate.",
          "x-label": "X Coordinate",
          "type": "integer"
        },
        "Y_Coordinate": {
          "description": "Y Coordinate.",
          "x-label": "Y Coordinate",
          "type": "integer"
        },
        "Max_X_Coordinate": {
          "description": "The highest X coordinate the display supports before wrapping to the next line.",
          "x-label": "Max X Coordinate",
          "type": "integer",
          "readOnly": true
        },
        "Max_Y_Coordinate": {
          "description": "The highest Y coordinate the display supports before wrapping to the next line.",
          "x-label": "Max Y Coordinate",
          "type": "integer",
          "readOnly": true
        },
        "Level": {
          "description": "Used to represent a level control such as audio volume.",
          "x-label": "Level",
          "maximum": 100,
          "minimum": 0,
          "type": "number",
          "x-unit": "/100"
        },
        "Contrast": {
          "description": "Proportional control, integer value between 0 and 100 as a percentage.",
          "x-label": "Contrast",
          "maximum": 100,
          "minimum": 0,
          "type": "number",
          "x-unit": "/100"
        },
        "Application_Type": {
          "description": "The application type of the sensor or actuator as a string depending on the use case.",
          "x-label": "Application Type",
          "type": "string"
        }
      },
      "type": "object",
      "required": [
        "Text"
      ]
    }
  }
}