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. Information and Preferences

Configure Device Configuration

[TCP/WebSocket<-->IM]

Configure various preferences of the device.

Request

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

  • payload :

    • callbackName : 2

    • callbackArgs :

      • acc_prefs :

        • outletPwrIndicatorOn: Enable/disable InvisDeco outlet indicator lights; 1 - On, 0 - Off.

        • pmIndicatorBrightness: Configure the indicators brightness; 1 - 100.

        • capacitiveCtrl: Enable/disable InvisDeco to control outlets via capacitive touch; 1 - On, 0 - Off.

        • aqiColorRGBFeature: Enable/disable InvisDeco's RGB indicator light to indicator AQI color code; 1 - On, 0 - Off.

        • motionAwayFeature: Enable/disable InvisDeco's Security Alert feature; 1 - On, 0 - Off.

        • adaptiveNightlightFeature: Enable/disable InvisDeco's Adaptive Nightlight feature; 1 - On, 0 - Off.

        • adaptiveMinBrightness: Configure the minimum brightness for Adaptive Nightlight feature; 0-99.

        • adaptiveMaxBrightness: Configure the maximum brightness for Adaptive Nightlight feature; 1-100. The value cannot be less than adaptiveMinBrightness.

        • occupancyNightlightFeature: Enable/disable InvisDeco's Occupancy Nightlight feature; 1 - On, 0 - Off.

      • sys_prefs :

        • mqtt :

          • enabled : Enable/disable MQTT TCP client service; 1 - On, 0 - Off.

          • mqtt_broker_url : The URL of the MQTT broker that InvisOutlet will be connected to.

          • user : The username to authenticate and connect to the MQTT broker.

          • pass : The password to authenticate and connect to the MQTT broker.

          • qos : The QoS level of the MQTT message; 0, 1, 2, or 3.

        • internet :

          • ip : IP address of the device in uint32_t.

          • mainDNS : IP address of the primary DNS in uint32_t.

          • backupDNS : IP address of the secondary DNS in uint32_t.

{
    "packetID": 713327,
    "payload":
    {
        "callbackName": 2,
        "callbackArgs":
        [
            {
                "acc_prefs": {
                    "outletPwrIndicatorOn": 1,
                    "pmIndicatorBrightness": 50,
                    "capacitiveCtrl": 0,
                    "aqiColorRGBFeature": 1,
                    "motionAwayFeature": 0,
                    "adaptiveNightlightFeature": 0,
                    "adaptiveMinBrightness": 0,
                    "adaptiveMaxBrightness": 100,
                    "occupancyNightlightFeature": 0
                },
                "sys_prefs": {
                    "mqtt": {
                        "enabled": 1,
                        "mqtt_broker_url": "mqtt://homeassistant.local:1883",
                        "user": "mqttuser",
                        "pass": "mqttpass",
                        "qos": 1
                    },
                    "internet": {
                        "ip": 2835523776,
                        "mainDNS": 16843009,
                        "backupDNS": 16777217
                    }
                }
            }
        ]
    }
}
Special Features Description
  • Security Alert: If any motion is detected, all InvisDeco indicators and nightlight will flash at maximum brightness, until no motion is detected.

  • Adaptive Nightlight: The nightlight will automatically adjust its brightness based on ambient brightness. The adaptive minimum and maximum brightness can be adjusted via the adaptiveMinBrightness and adaptiveMaxBrightness parameter to suit your preferences.

  • Occupancy Nightlight: The nightlight will automatically be turned on when occupancy is detected. adaptiveNightlightFeature and occupancyNightlightFeature can be activated at the same time. When adaptiveNightlightFeature is not activated, the nightlight will be turned on based on previously set brightness, when adaptiveNightlightFeature is activated, then it will follow Adaptive Nightlight's settings to turn on/off the nightlight.

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.

{
    "sn": "0003C44076",
    "packetID": 713327,
    "PUBACK": 1
}

PreviousRequest Device ConfigurationNextRequest Accessory Names

Last updated 4 months ago