DeviceOperations
The DeviceOperations object is used to get and set data for various device operations for the AirMedia Series 3 Receiver 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 |
| ProjectType | /Device/DeviceOperations/ | 2.0.0 | The type of project running on the device. | 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/ |
|
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 (
Copy
{
"Device":{
"DeviceOperations":{
"FirmwareUpgrade":"",
"FirmwareUpgradeType":"USB",
"FirmwareUpgradePath":"Path",
"Reboot":true,
"Restore":true,
"Reset":true,
"RestartWebServer": false,
"GenerateLogs":"logs_Ipaddress_yyyy.MM.DD_HH.MM.SS",
"SaveEdidFile" : "Output1",
"ProjectType": "OOTB",
"UpgradeStatus":"Firmware Upgrade Rebooting",
"ProgressPercentage" : 50,
"SystemUpgrade":
{
"TotalWaitingTime": 480
}
"Version":"2.7.0"
}
}
}