DeviceOperations

The DeviceOperations object is used to get and set data for various device operations for the DM NVX device.

NOTE: Prior to issuing a FirmwareUpgrade POST request, ensure that the firmware file has been loaded to the device at the path specified within the POST request body. The POST request body should be formatted as multipart/form-data.

Syntax

  • HTTP Methods: GET, POST
  • Base URI: /Device/DeviceOperations/

Properties

Property Name Parent Path Version Description Type Methods Validation Rules
DeviceOperations /Device/ 2.0.0 The top‑level DeviceOperations object Object N/A N/A
FirmwareUpgrade /Device/DeviceOperations/ 2.0.0 Use a multipart POST with this property to upgrade the firmware.
 String POST N/A
FirmwareUpgradeType /Device/DeviceOperations/ 2.0.0 The firmware upgrade type. String POST "Http"
FirmwareUpgradePath /Device/DeviceOperations/ 2.0.0 The firmware upgrade path. String POST 255 characters maximum
GetXPanel /Device/DeviceOperations/ 2.4.0 Obtains the OS-specific link for an XPanel installer or obtains the project download link based on the Ethernet IP address, Control Subnet IP address, host name, or FQDN. String POST "Installer", "Project"
Reboot /Device/DeviceOperations/ 2.0.0 If true, reboots the device. Boolean POST N/A
Restore /Device/DeviceOperations/ 2.0.0 If true, restores the device to factory default settings. Boolean POST N/A
Reset /Device/DeviceOperations/ 2.6.0 If true, resets the device to its default user settings. Boolean POST N/A
RestartWebserver /Device/DeviceOperations/ 2.2.0 If true, restarts the web server on the device. Boolean POST N/A
EnterSetup /Device/DeviceOperations/ 2.0.1 If true, enters Setup mode. Boolean POST N/A
ExitSetup /Device/DeviceOperations/ 2.7.0 If true, exits Setup mode. Boolean POST N/A
EnterStandby /Device/DeviceOperations/ 2.0.1 If true, enters Standby mode. Boolean POST N/A
ExitStandby /Device/DeviceOperations/ 2.3.0 If true, exits Standby mode. Boolean POST N/A
GenerateLogs /Device/DeviceOperations/ 2.0.0 Generates logs with specified file name on the device. Logs can be downloaded by browsing to /logs/ramdiskLogs/<filenamespecified>.tgz. String POST 255 characters maximum
ProjectType /Device/DeviceOperations/ 2.0.0 The type of project running on the device. String POST 255 characters maximum
UploadProject /Device/DeviceOperations/ 2.0.0 Use a multipart POST with this property to upload the project. String POST 255 characters maximum
UpgradeStatus /Device/DeviceOperations/ 2.0.0 Provides the current status of an update in progress. String GET "PUF Started", "PUF Failed", "Inflating", "Firmware Upgrade Loading", "Puf Upgrade InProgress", "Firmware Upgrade Rebooting", "Firmware Upgrade Failed", "Firmware Upgrade Started","Puf Upgrade Success"
ProgressPercentage /Device/DeviceOperations/ 2.0.0 Provides the current upgrade progress as a percentage. Numeric (Unsigned 32-bit) GET 0–100%
SystemUpgrade /Device/DeviceOperations/ 2.5.0 A subobject for system upgrades. Object N/A N/A
TotalWaitingTime /Device/DeviceOperations/SystemUpgrade 2.5.0 Indicates the total remaining time for a firmware upgrade to complete (in seconds). Numeric (Unsigned 32-bit) GET 1–3600
SaveEdidFile /Device/DeviceOperations/ 2.3.0 Used to download the EDID from a specific output file. String POST "Output1", "Output2", "Output3", "Output4", "Output5" ,"Output6", "Output7", "Output8"
Version /Device/DeviceOperations/ 2.7.0 The object version.

"2.0.0": Initial public release,
"2.0.1" Added: EnterSetup, EnterStandby,
"2.1.0": Added: Exit Standby,
"2.2.0": Added RestartWebServer property,
"2.3.0": Added SaveEdidFile property,
"2.4.0": Added GetXPanel property.
"2.5.0": Added SystemUpgrade subobject,
"2.6.0": Added Reset property,
"2.7.0": Added ExitSetup property.		 String GET N/A

Example JSON

The following example JSON uses the current object version (2.7.0).

Copy 
{
   "Device":{
      "DeviceOperations":{
         "FirmwareUpgrade":"",
         "FirmwareUpgradeType":"USB",
         "FirmwareUpgradePath":"Path",
         "GetXpanel: "Installer",
         "Reboot":true,
         "Restore":true,
         "Reset":true,
         "RestartWebServer": false,
         "EnterSetup":false,
         "ExitSetup": true,
         "EnterStandby":false,
         "ExitStandby":false,
         "GenerateLogs":"logs_Ipaddress_yyyy.MM.DD_HH.MM.SS",
         "SaveEdidFile" : "Output1", 
         "ProjectType": "OOTB",    
         "UploadProject":"",
         "UpgradeStatus":"Firmware Upgrade Rebooting",
         "ProgressPercentage" : 50,
         "SystemUpgrade": 
          {
             "TotalWaitingTime": 480
          }
         "Version":"2.7.0"
      }
   }
}