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

Request Accessory Names

[TCP/WebSocket -> InvisOutlet]

Request and retrieve accessory names from the device.

Request

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

  • payload:

    • callbackName: 3

{
    "packetID": 180072,
    "payload":
    {
        "callbackName": 3   
    }
}

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: 3

    • callbackArgs:

      • accessory: 1 - Outlet 1 (Top), 2 - Outlet 2 (Bottom), 3 - Nightlight (if InvisDeco is installed).

      • name: The corresponding names for the accessory.

{
    "sn": "0003C44076",
    "packetID": 180072,
    "PUBACK": 1,
    "payload": {
        "callbackName": 3,
        "callbackArgs": {
            "payload": [
                {
                    "accessory": 1,
                    "name": "Outlet 1"
                },
                {
                    "accessory": 2,
                    "name": "Outlet 2"
                },
                {
                    "accessory": 3,
                    "name": "Nightlight"
                }
            ]
        }
    }
}
PreviousConfigure Device ConfigurationNextConfigure Accessory Names

Last updated 4 months ago