TCP/WebSocket API
  • Getting Started
  • Information and Preferences
    • Get Device Information
    • Request Device Configuration
    • Configure Device Configuration
    • Request Accessory Names
    • Configure Accessory Names
  • Accessory Controls
    • Outlets
    • Nightlight
    • Color Light - HSV
    • Color Light - Temperature
  • Fetch Accessory Status
    • Outlets
    • Nightlight
    • Color Light
    • Sensors
  • Synchronous Updates
    • Outlets
    • Nightlight
    • Sensors
  • OTA
    • Request Available Updates
    • Perform OTA Update
    • OTA Download Progress (Synchronous)
    • OTA Result Update (Synchronous)
  • Device Management
    • InvisOutlet
      • Restart InvisOutlet
      • Reset InvisOutlet's Network Settings
      • Factory Reset InvisOutlet
      • Check MQTT Status
      • Home Assistant Discovery
    • InvisDeco
      • Restart InvisDeco
      • Reset InvisDeco
      • Occupancy Sensor Calibration
      • Temperature and Relative Humidity Calibration
  • API Reference
    • Terminology
Powered by GitBook
On this page
  1. Fetch Accessory Status

Sensors

[TCP/WebSocket -> InvisOutlet]

Fetch InvisDeco's latest sensor readings.

Request

  • packetID: Represents the ID of the packet. This can be any six digit number, no leading zeros.

  • payload:

    • callbackName: 11

{
    "packetID": 371939,
    "payload":
    {
        "callbackName": 11
    }
}

Response

  • sn: The serial number of the InvisOutlet.

  • packetID: Represents the ID of the packet based on request packetID.

  • PUBACK : If the request is successfully processed; 1 - Successful, 0 - Fail.

  • payload:

    • callbackName : 11

    • callbackArgs :

      • 1 : The InvisDeco device type; reserved for internal use.

      • 2 :

        • temp_valid : A flag indicating the validity of the temperature and humidity sensor; 1 - valid, 0 - invalid.

        • aqi_valid : A flag indicating the validity of the air quality sensor; 1 - valid, 0 - invalid.

        • temp_celsius: Temperature in Celsius.

        • humidity: Relative humidity in percentage.

        • BME680_temp_celsius: Temperature from the air quality sensor. for development use only

        • BME680_humidity: Humidity from the air quality sensor. for development use only

        • AQI: Air quality index level.

        • AQI_accuracy : Accuracy of the AQI measurement; 3 - most accurate, 2 - average accuracy, 1 - least accuracy, 0 - calibration in process.

        • pressure: Atmospheric pressure in Pascals (Pa).

        • gas: Gas sensor reading in Ohms.

        • co2_equiv: Equivalent CO2 concentration in parts per million (ppm).

        • co2_peak_lvl: Peak CO2 concentration in ppm.

        • co2_accuracy: Accuracy of the CO2 measurement; 3 - most accurate, 2 - average accuracy, 1 - least accuracy, 0 - calibration in process.

        • bvoc_equiv: Equivalent breathe volatile organic compounds (bVOC) concentration in ppm.

        • bvoc_accuracy: Accuracy of the bVOC measurement; 3 - most accurate, 2 - average accuracy, 1 - least accuracy, 0 - calibration in process.

        • lux_valid: A flag indicating the ambient brightness sensor validity of the sensor; 1 - valid, 0 - invalid.

        • lux: Ambient brightness level in LUX.

        • occupancy_valid: A flag indicating the occupancy sensor validity of the sensor; 1 - valid, 0 - invalid.

        • occupancy_state: The occupancy detected state; 0: no occupancy, 1: movement only, 2: stationary only, 3: stationary and movement, 4: calibration in progress, 5: calibration completed, 6: calibration failed.

        • distance: The occupancy detected distance in centimeter (cm) between the device and the human movement.

        • movement_energy: The energy level of the detected movement occupancy; 0 (lowest) - 100 (highest)

        • stationary_energy: The energy level of the detected stationary occupancy; 0 (lowest) - 100 (highest)

{
    "sn": "000FE441F7",
    "packetID": 371939,
    "payload": {
        "callbackName": 11,
        "callbackArgs": [
            4,
            {
                "temp_valid": 1,
                "aqi_valid": 1,
                "temp_celsius": "27.95",
                "humidity": "63.00",
                "BME680_temp_celsius": "28.74",
                "BME680_humidity": "63.64",
                "AQI": 50,
                "AQI_accuracy": 0,
                "pressure": 100925,
                "gas": 108414,
                "co2_equiv": 500,
                "co2_peak_lvl": 500,
                "co2_accuracy": 0,
                "bvoc_equiv": "0.49",
                "bvoc_accuracy": 0,
                "lux_valid": 1,
                "lux": "141.51",
                "occupancy_valid": 1,
                "occupancy_state": 3,
                "distance": 76,
                "movement_energy": 100,
                "stationary_energy": 100
            }
        ]
    }
}
PreviousColor LightNextSynchronous Updates

Last updated 8 months ago