Advanced API

Information

GET /equipment/flatdevice/info

Get information about the flat panel, Coverstate represents the following values: 0: Unknown, 1: NeitherOpenNorClosed, 2: Closed, 3: Open, 4: Error, 5: Not present

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response object Required
      Hide Response attributes Show Response attributes object
      • CoverState string Required

        Values are Unknown, NeitherOpenNorClosed, Closed, Open, Error, or NotPresent.

      • LocalizedCoverState string Required
      • LocalizedLightOnState string Required
      • LightOn boolean Required
      • Brightness integer Required
      • SupportsOpenClose boolean Required
      • MinBrightness integer Required
      • MaxBrightness integer Required
      • SupportsOnOff boolean Required
      • SupportedActions array Required
      • Connected boolean Required
      • Name string Required
      • DisplayName string Required
      • Description string Required
      • DriverInfo string Required
      • DriverVersion string Required
      • DeviceId string Required
    • Error string Required
    • StatusCode integer Required
    • Success boolean Required
    • Type string Required
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/flatdevice/info 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/flatdevice/info'
Response examples (200) 
{
  "Response": {
    "CoverState": "Unknown",
    "LocalizedCoverState": "string",
    "LocalizedLightOnState": "string",
    "LightOn": true,
    "Brightness": 42,
    "SupportsOpenClose": true,
    "MinBrightness": 42,
    "MaxBrightness": 42,
    "SupportsOnOff": true,
    "SupportedActions": [],
    "Connected": true,
    "Name": "string",
    "DisplayName": "string",
    "Description": "string",
    "DriverInfo": "string",
    "DriverVersion": "string",
    "DeviceId": "string"
  },
  "Error": "string",
  "StatusCode": 42,
  "Success": true,
  "Type": "string"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}