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. OTA

Request Available Updates

[TCP/WebSocket<-->IM]

Check available firmware updates (Over-the-Air updates) for InvisOutlet and InvisDeco.

Request

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

  • payload:

    • callbackName: 20

{
    "packetID": 221040,
    "payload":
    {
        "callbackName": 20
    }
}

Response

Success:

  • 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.

    • callbackName: 20

      • callbackArgs:

        • IM:

          • fw_rev: The current running firmware version of the InvisOutlet.

          • available_fw_rev: The available firmware version for the InvisOutlet; if the available firmware revision matches the current firmware revision, indicating that there is no available updates.

          • www_fw_rev: The current running web firmware version of the InvisOutlet.

          • available_www_fw_rev: The available web firmware version for the InvisOutlet; if the available firmware revision matches the current firmware revision, indicating that there is no available updates.

        • PM :

          • fw_rev: The current running firmware version of the InvisDeco.

          • available_fw_rev: The available firmware version for the InvisDeco; if the available firmware revision matches the current firmware revision, indicating that there is no available updates.

{
    "sn": "0003C44076",
    "packetID": 221040,
    "PUBACK": 1,
    "payload": {
        "callbackName": 20,
        "callbackArgs": {
            "IM": {
                "fw_rev": "0.0.1",
                "available_fw_rev": "0.0.1",
                "www_fw_rev": "0.1.2",
                "available_www_fw_rev": "0.3.0"
            },
            "PM": {
                "fw_rev": "0.5.0",
                "available_fw_rev": "0.5.1"
            }
        }
    }
}

Fail:

  • 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; 0 - Failed.

{
    "sn": "0003C44076",
    "packetID": 221040,
    "PUBACK": 0
}
PreviousOTANextPerform OTA Update

Last updated 8 months ago