Skip to end of metadata
Go to start of metadata

Versions

org.rdk.System.1 - Initial version of SystemServices API.

Dependencies

The SystemServices API has the following build and run time dependencies:

  • sysint - getDeviceDetails.sh, rebootNow.sh, deviceInitiatedFWDnld.sh, getAccountId.sh, getPartnerId.sh, getStateDetails.sh
  • rfc - tr181Set
  • iarm - IARM_BUS_SYSMGR, IARM_BUS_PWRMGR
  • MFRUtils/MFRLibs - PDRIVersion, Manufacturer Details
  • TR069/SNMP
  • curl

Methods

cacheContains (v1)

Description: Check if a key is present in the cache.

Arguments:

  • key: string

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.cacheContains","params":{"key":"sampleKey"}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

clearLastDeepSleepReason (v1)

Description: Clear the last deep sleep reason.

Arguments:

  • none

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.clearLastDeepSleepReason","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

enableMoca (v1)

Description: Enable (or disable) Moca support for the platform. Set the value argument to true to enable Moca support or false to disable Moca support.

Arguments: 

  • value: true

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.enableMoca","params":{"value":true}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

fireFirmwarePendingReboot (v2)

Description:  Notifies the device about a pending reboot by sending an onFirmwarePendingReboot event.

Arguments:

  • none

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.2.fireFirmwarePendingReboot","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

getAvailableStandbyModes (v1)

Description: Query the available standby modes.

Arguments: 

  • none

Returns:

  • supportedStandbyModes: string[]
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getAvailableStandbyModes","params":{}}

Response : {"jsonrpc":"2.0","id":3,"result":{"supportedStandbyModes":["LIGHT_SLEEP", "DEEP_SLEEP"],"success":true}}

getCachedValue (v1)

Description: Get the value of a key in the cache.

Arguments:

  • key: string

Returns:

  • key: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getCachedValue","params":{"key":"sampleKey"}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"sampleKey":"4343.3434","success":true}}

getCoreTemperature (v1)

Description: Fetch the core temperature of the device.  Not supported on all devices.

Arguments:

  • none

Returns:

  • temperature: float
  • success: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getCoreTemperature","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"temperature":48.000000,"success":true}}

getDeviceInfo (v1)

Description: Collect device details.

Arguments: 

  • params: string[] of keys to query (optional). If no parameters are included, then all keys are returned.

    Sample key/value pairs
    • bluetooth_mac=44:AA:F5:28:64:25

    • boxIP=192.168.2.106

    • build_type=dev

    • estb_mac=44:AA:F5:28:64:22eth_mac=44:AA:F5:28:64:23

    • imageVersion=PX051AEI_VBN_2010_sprint_20210107142226sdy

    • model_num=RPI

    • make=raspberrypi_org
    • friendly_id=RPI11
    • rf4ce_mac=00:15:5F:00:3C:04:95:51

    • wifi_mac=44:AA:F5:28:64:24

Returns:

  • key/value pair: string
  • success: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getDeviceInfo","params":{"params":["estb_mac"]}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"estb_mac":"20:F1:9E:EE:62:08","success":true}}

getDownloadedFirmwareInfo (v1)

Description: Retrieve information about firmware downloads.

Arguments:

  • none

Returns:

  • currentFWVersion: string
  • downloadedFWVersion: string
  • downloadedFWLocation: string
  • isRebootDeferred: bool
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getDownloadedFirmwareInfo","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"currentFWVersion":"AX061AEI_VBN_1911_sprint_20200109040424sdy","downloadedFWVersion":"AX061AEI_VBN_1911_sprint_20200510040450sdy","downloadedFWLocation":"","isRebootDeferred":false,"success":true}}

getFirmwareDownloadPercent (v1)

Description: Fetch the current download percentage.

Arguments:

  • none

Returns:

  • downloadPercent: long int
  • success:bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getFirmwareDownloadPercent","params":{}}

Response : {"jsonrpc":"2.0","id":3,"result":{"downloadPercent":25,"success":true}}

getFirmwareUpdateInfo (v1)

Description: Check the firmware update information. The requested details are sent as an onFirmwareUpdateInfoReceived event.  

Arguments: 

  • GUID: string

Returns:

  • asyncResponse: bool
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getFirmwareUpdateInfo","params":{"GUID":"1234abcd"}}

Response : {"jsonrpc":"2.0","id":3,"result":{"asyncResponse":true,"success":true}}

getFirmwareUpdateState (v1)

Description: Check the state of the firmware update. The following states are supported:

  • Uninitialized

  • Requesting
  • Downloading
  • Failed
  • DownLoad Complete
  • Validation Complete
  • Preparing to Reboot

Arguments:

  • none

Returns:

  • firmwareUpdateState: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getFirmwareUpdateState","params":{}}

Response : {"jsonrpc":"2.0","id":3,"result":{"firmwareUpdateState":"Download Complete","success":true}}

getLastDeepSleepReason (v1)

Description: Retrieve the last deep sleep reason.

Arguments:

  • none

Returns:

  • lastDeepSleepReason: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getLastDeepSleepReason","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"lastDeepSleepReason":"thermal_deepsleep_critical_threshold","success":true}}

getLastFirmwareFailureReason (v2)

Description: Retrieves the last firmware failure reason.

Arguments:

  • none

Returns:

  • failureReason: string - the reason the failure occurred.
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getLastFirmwareFailureReason","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"failureReason":"Image Download Failed - Unable to connect","success":true}}

getMacAddresses (v1)

Description: Get the MAC address of the device. The requested details is sent as an onMacAddressesRetreived event.

Arguments:

  • GUID: string

Returns:

  • asyncResponse: bool
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getMacAddresses","params":{"GUID":"61734787891723481"}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"asyncResponse":true,"success":true}}

getMilestones (v1)

Description: Fetch the list of milestones.

Arguments:

  • none

Returns:

  • milestones: string []
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method": "org.rdk.System.1.getMilestones","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"milestones":["RDK_STARTED:20410","2020 Jan 28 08:24:06.762355 arrisxi6 systemd[1]: Starting Log RDK Started Service...","-- Subject: Unit log-rdk-start.service has begun with start-up","-- Defined-By: systemd","-- Support: http://lists.freedesktop.org/mailman/listinfo/systemd-devel","-- ","-- Unit log-rdk-start.service has begun starting up.","2020 Jan 28 08:24:06.791823 arrisxi6 systemd[1]: Started Log RDK Started Service.","-- Subject: Unit log-rdk-start.service has finished start-up","-- Defined-By: systemd","-- Support: http://lists.freedesktop.org/mailman/listinfo/systemd-devel","-- ","-- Unit log-rdk-start.service has finished starting up.","-- ","-- The start-up result is done.","UPNP_START_DISCOVERY:52660","IP_ACQUISTION_COMPLETED:53230","PWIFI_CONNECTED:56270","SEND_DHCP_REQUEST:56370","RECV_DHCP_RESPONSE:56940","IP_ACQUISTION_COMPLETED:57070","CONNECT_TO_APPLICATION:78340","CONNECT_TO_NTP_SERVER:79460","SPLASH_SCREEN_DISPLAYED:81300","SET_XSCT_TOKEN:106480","CONNECT_TO_APPLICATION:113490","CONNECT_TO_APPLICATION:116590","CONNECT_TO_APPLICATION:119460"],"success":true}}

getMode (v1)

Description: Retrieve the currently set mode information.

Arguments: 

  • none

Returns:

  • modeInfo: JSON object
    • mode: string
    • duration: int
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getMode","params":{}}

Response : {"jsonrpc":"2.0","id":3,"result":{"modeInfo":{"mode":"NORMAL","duration":0},"success":true}}

getNetworkStandbyMode (v1)

Description: Retrieve the network standby mode of the device. If network standby is true, device will it support WakeOnLAN and WakeOnWLAN actions in STR (S3) mode

Arguments:

  • none

Returns:

  • nwStandby: bool
  • success: bool


Request : {"jsonrpc":"2.0","id":6,"method":"org.rdk.System.1.getNetworkStandbyMode"}
 
Response : {"jsonrpc":"2.0","id":6,"result":{"nwStandby":false,"success":true}}

getPowerState (v1)

Description: Collect the power state of the device.

Arguments: 

  • none

Returns:

  • powerState: string
  • success: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPowerState","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"powerState":"ON","success":true}}

getPowerStateBeforeReboot (v2)

Description: Collect the power state of the device before reboot.

Arguments:

  • none

Returns:

  • state: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPowerStateBeforeReboot","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"state":"ON","success":true}}

getPreferredStandbyMode (v1)

Description: Retrieve the preferred standby mode. Possible values are either LIGHT_SLEEP or DEEP_SLEEP. This method returns an empty string if the preferred mode has not been set.

Arguments: 

  • none

Returns:

  • preferredStandbyMode: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreferredStandbyMode","params":{}}

Response : {"jsonrpc":"2.0","id":3,"result":{"preferredStandbyMode":"DEEP_SLEEP","success":true}}

getPreviousRebootInfo (v1)

Description: Retrieve basic information about a reboot.

Arguments:

  • none

Returns:

  • timestamp: string
  • reason: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreviousRebootInfo","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"timeStamp":"20200128083540","reason":"Triggered from System Plugin API Validation","success":true}}

getPreviousRebootInfo2 (v1)

Description: Retrieve detailed information about a reboot.

Arguments:

  • none

Returns:

  • rebootInfo: JSON object
    • timestamp: string
    • source: string
    • reason: string
    • customReason: string
    • lastHardPowerReset: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreviousRebootInfo2","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"rebootInfo":{"timestamp":"Tue Jan 28 08:35:40 UTC 2020","source":"SystemPlugin","reason":"FIRMWARE_FAILURE","customReason":"API Validation","lastHardPowerReset":"Tue Jan 28 08:22:22 UTC 2020"},"success":true}}

getPreviousRebootReason (v1)

Description: Retrieve the last reboot reason.

Arguments:

  • none

Returns:

  • reason: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreviousRebootReason","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"reason":"FIRMWARE_FAILURE","success":true}}

getRFCConfig (v1)

Description: Retrieve information that is related to RDK Feature Control (RFC) configurations.

Arguments: 

  • rfcList: string[] of RFC configuration properties

Returns:

  • RFCConfig: JSON object
  • success: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getRFCConfig","params":{"rfcList":["Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AccountInfo.AccountID","Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.UPnP.Enabled","Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AllowOpenPorts.Enabled","Device.DeviceInfo.MemoryStatus.Total","Device.DeviceInfo.MemoryStatus.Free"]}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"RFCConfig":{"Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AccountInfo.AccountID":"1181405614235499371","Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.UPnP.Enabled":"Empty response received","Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AllowOpenPorts.Enabled":"Empty response received","Device.DeviceInfo.MemoryStatus.Total":"1144560","Device.DeviceInfo.MemoryStatus.Free":"732144"},"success":true}}

getSerialNumber (v1)

Description: Retrieve the device serial number.

Arguments:

  • none

Returns:

  • serialNumber: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getSerialNumber","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"serialNumber":"M11806TK0024","success":true}}

getStateInfo (v1)

Description: Query device state information of various properties.

Arguments:

  • param: property to query as a string

Returns:

  • property as a string: value
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getStateInfo","params":{"param":"com.comcast.channel_map"}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"com.comcast.channel_map":2,"success":true}}

getSystemVersions (v1)

Description: Get system version details.

Arguments: 

  • none

Returns:

  • stbVersion: string
  • receiverVersion: string
  • stbTimestamp: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getSystemVersions","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"stbVersion":"AX061AEI_VBN_1911_sprint_20200109040424sdy","receiverVersion":"3.14.0.0","stbTimestamp":"Thu 09 Jan 2020 04:04:24 AP UTC","success":true}}

getTemperatureThresholds (v1)

Description: Retrieves temperature threshold values.  Not supported on all devices.

Arguments:

  • none

Returns:

  • temperatureThresholds: JSON object
    • WARN: string
    • MAX: string
    • temperature: string
  • success: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getTemperatureThresholds","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"temperatureThresholds":{"WARN":"100.000000","MAX":"110.000000","temperature":"48.000000"},"success":true}}

getTimeZoneDST (v1)

Description:  Get the configured time zone from the file referenced by TZ_FILE. If the time zone is not set, then null is returned.

Arguments:

  • none

Returns:

  • timeZone: String
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getTimeZoneDST","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"timeZone":"America/New_York","success":true}}

getTimeZones (v2)

Description:  Gets the available timezones from the system's time zone database.  Useful for determining time offsets per zone.

Arguments:

  • none

Returns:

  • zoneInfo: String
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.2.getTimeZones","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{

  "zoneinfo":{

  "America":

    {"Anchorage":"Thu Nov 5 11:21:17 2020 AKST","Chicago":"Thu Nov 5 14:21:17 2020 CST","Denver":"Thu Nov 5 13:21:17 2020 MST","Edmonton":"Thu Nov 5 13:21:17 2020 MST",

     "Halifax":"Thu Nov 5 16:21:17 2020 AST","Los_Angeles":"Thu Nov 5 12:21:17 2020 PST","New_York":"Thu Nov 5 15:21:17 2020 EST","Phoenix":"Thu Nov 5 13:21:18 2020 MST",

     "Regina":"Thu Nov 5 14:21:18 2020 CST","St_Johns":"Thu Nov 5 16:51:18 2020 NST","Toronto":"Thu Nov 5 15:21:18 2020 EST","Vancouver":"Thu Nov 5 12:21:18 2020 PST",

      "Winnipeg":"Thu Nov 5 14:21:18 2020 CST"},


  "Europe":
    {"London":"Thu Nov 5 20:21:18 2020 GMT","Moscow":"Thu Nov 5 23:21:18 2020 MSK","Paris":"Thu Nov 5 21:21:18 2020 CET"},


  "Pacific":

    {"Honolulu":"Thu Nov 5 10:21:18 2020 HST"},


  "US":

    {"Alaska":"Thu Nov 5 11:21:18 2020 AKST","Aleutian":"Thu Nov 5 10:21:18 2020 HST","Arizona":"Thu Nov 5 13:21:18 2020 MST","Central":"Thu Nov 5 14:21:18 2020 CST",

     "East-Indiana":"Thu Nov 5 15:21:18 2020 EST","Eastern":"Thu Nov 5 15:21:18 2020 EST","Hawaii":"Thu Nov 5 10:21:18 2020 HST","Indiana-Starke":"Thu Nov 5 14:21:18 2020 CST",

     "Michigan":"Thu Nov 5 15:21:18 2020 EST","Mountain":"Thu Nov 5 13:21:18 2020 MST","Pacific":"Thu Nov 5 12:21:18 2020 PST","Samoa":"Thu Nov 5 09:21:18 2020 SST"}}}

,"success":true}}

getWakeupReason (v2)

Description:  Return the reason for the device coming out of deep sleep.

Arguments:

  • none

Returns:

  • wakeupReason: String - Possible values are "WAKEUP_REASON_IR", "WAKEUP_REASON_RCU_BT", "WAKEUP_REASON_RCU_RF4CE", WAKEUP_REASON_GPIO", "WAKEUP_REASON_LAN", "WAKEUP_REASON_WLAN", "WAKEUP_REASON_TIMER", "WAKEUP_REASON_FRONT_PANEL", "WAKEUP_REASON_WATCHDOG", "WAKEUP_REASON_SOFTWARE_RESET", "WAKEUP_REASON_THERMAL_RESET", "WAKEUP_REASON_WARM_RESET", "WAKEUP_REASON_COLDBOOT", "WAKEUP_REASON_STR_AUTH_FAILURE", "WAKEUP_REASON_CEC", "WAKEUP_REASON_PRESENCE", "WAKEUP_REASON_VOICE", "WAKEUP_REASON_UNKNOWN"
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.2.getWakeupReason","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"wakeupReason":"WAKEUP_REASON_VOICE","success":true}}

getXconfParams (v1)

Description: Return Xconf configuration parameters for the device.

Arguments: 

  • none

Returns:

  • xconfParams: JSON object
    • env: string
    • eStbMac: string
    • model: string
    • firmwareVersion: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getXconfParams","params":{}}

Response : {"jsonrpc":"2.0","id":3,"result":{"xconfParams":{"env":"vbn","eStbMac":"20:F1:9E:EE:62:08","model":"AX061AEI","firmwareVersion":"AX061AEI_VBN_1911_sprint_20200109040424sdy"},"success":true}}

hasRebootBeenRequested (v1)

Description: Check whether a reboot has been requested.

Arguments: 

  • none

Returns:

  • rebootRequested: bool
  • success: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.hasRebootBeenRequested","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"rebootRequested":false,"success":true}}

isGzEnabled (v1)

Description: Check whether GZ is enabled.

Arguments: 

  • none

Returns:

  • enabled: bool
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.isGzEnabled","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"enabled":false,"success":true}}

isOptOutTelemetry (v2)

Description: Checks the telemetry opt-out status. 

Arguments: none

Returns:

  • Opt-Out: bool - true if opt-out is set, otherwise false
  • success: bool


Request : {"jsonrpc":"2.0","id":6,"method":"org.rdk.System.1.isOptOutTelemetry","params":{}}
 
Response : {"jsonrpc":"2.0","id":6,"result":{"Opt-Out":false "success":true}}

queryMocaStatus  (v1)

Description: Check whether Moca is enabled.

Arguments

  • none

Returns:

  • mocaEnabled: bool
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method": "org.rdk.System.1.queryMocaStatus","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"mocaEnabled":true,"success":true}}

reboot (v1)

Description: Request that the system perform a reboot of the set-top box.

Arguments: 

  • rebootReason: string 

Returns:

  • success: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.reboot","params":{"rebootReason":"API Validation"}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"IARM_Bus_Call_STATUS":1,"success":true}}

removeCacheKey (v1)

Description: Delete a key from the cache.

Arguments:

  • key: string

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.removeCacheKey","params":{key:"sampleKey"}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

requestSystemUptime (v1)

Description: Fetch the device uptime. The uptime is reported using seconds.

Arguments: 

  • none

Returns:

  • systemUptime: string
  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.requestSystemUptime","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"systemUptime":"1666.92","success":true}}

setCachedValue (v1)

Description: Set the value for a key in the cache.

Arguments:

  • key: string
  • value: double

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setCachedValue","params":{"key":"sampleKey","value":4343.3434}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setDeepSleepTimer (v1)

Description: Set the deep sleep timeout period. The timeout period is entered using seconds.

Arguments:

  • seconds: unsigned int

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setDeepSleepTimer","params":{"seconds":3}}

Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setFirmwareAutoReboot (v2)

Description: Enable or disable the AutoReboot Feature. This method internally sets the tr181 AutoReboot.Enable parameter to true or false.

Arguments:

  • enable: bool

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.2.setFirmwareAutoReboot","params":{"enable":true}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setFirmwareRebootDelay (v2)

Description:  Delays the firmware reboot.

Arguments:

  • delaySeconds - time, in seconds, to delay the reboot.

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.2.setFirmwareRebootDelay","params":{"delaySeconds":60}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setGzEnabled (v1)

Description: enables or disables GZ.

Arguments: 

  • enabled: bool

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setGzEnabled","params":{"enabled":true}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setMode (v1)

Description: Set the mode of the set-top box for a specific duration before returning to normal mode. Valid modes are:

  • NORMAL - The set-top box is operating in normal mode.
  • EAS - The set-top box is operating in Emergency Alert System (EAS) mode. This mode is set when the device needs to perform certain tasks when entering EAS mode, such as setting the clock display or preventing the user from using the diagnostics menu.
  • WAREHOUSE - The set-top box is operating in warehouse mode.

Arguments: 

  • modeInfo: JSON object
    • mode: string
    • duration: int

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setMode","params":{"modeInfo":{"mode":"NORMAL","duration":20}}}

Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setNetworkStandbyMode (v1)

Description: Enable or disable the network standby mode of the device. Valid values are true or false. If network standby is enabled, device will it support WakeOnLAN and WakeOnWLAN actions in STR (S3) mode

Arguments: 

  • nwStandby: bool

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":6,"method":"org.rdk.System.1.setNetworkStandbyMode","params":{"nwStandby":true}}
 
Response : {"jsonrpc":"2.0","id":6,"result":{"success":true}}

setOptOutTelemetry (v2)

Description: Sets the telemetry opt-out status. 

Arguments: 

  • Opt-Out: bool - true to opt-out, otherwise false

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":6,"method":"org.rdk.System.1.setOptOutTelemetry","params":{"Opt-Out":true}}
 
Response : {"jsonrpc":"2.0","id":6,"result":{"success":true}}

setPowerState (v1)

Description: Set the power state of the device. Valid values are STANDBY, DEEP_SLEEP, LIGHT_SLEEP, ON.

Arguments: 

  • powerState: string
  • standbyReason: string

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setPowerState","params":{"powerState":"STANDBY", "standbyReason":"APIUnitTest"}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setPreferredStandbyMode (v1)

Description: Set and persist the preferred standby mode (see getAvailableStandbyModes for valid modes). Invoking this function does not change the power state of the device. It only sets the user preference for the preferred action when the setPowerState method is invoked with a value of STANDBY.

Arguments: 

  • standbyMode: string

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setPreferredStandbyMode","params":{"standbyMode":"DEEP_SLEEP"}}

Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setTemperatureThresholds (v1)

Description: Set the temperature threshold values.  Not supported on all devices.

Arguments:

  • Thresholds: JSON object
    • WARN: string
    • MAX: string

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setTemperatureThresholds","params":{"thresholds":{"WARN":"50.000000","MAX":"80.000000"}}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

setTimeZoneDST (v1)

Description: Set the system time zone. Please refer to getTimeZones(v2) to get list of available timezones on the system.

Arguments:

  • timeZone: string

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setTimeZoneDST","params":{"timeZone":"America/New_York"}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

updateFirmware (v1)

Description: Initiate a firmware update. This method has no affect if an update is not available.

Arguments: 

  • none

Returns:

  • success: bool


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.updateFirmware","params":{}}

Response : {"jsonrpc":"2.0","id":3,"result":{"success":true}}

Events:

onFirmwarePendingReboot (v2)

Description: Fires when the fireFirmwarePendingReboot method is invoked.

Payload:

  • Seconds: int


{"jsonrpc": "2.0","method": "client.events.2.onFirmwarePendingReboot","param":{"seconds":2,"success":true}}

onFirmwareUpdateInfoReceived (v1)

Description: Fires when the getFirmwareUpdateInfo asynchronous method is invoked.

Payload:

  • status: int
  • responseString: string
  • firmwareUpdateVersion: string
  • updateAvailable: boolean - The value false indicates that there is no update available, either because there was no firmware update version returned from XCONF, or because the version returned from XCONF matches the version already on the device.  The value of true indicates there is a firmware version available for update.
  • updateAvailableEnum: int -
    • 0: A new firmware version is available. 
    • 1: The firmware version is at the current version.
    • 2: XCONF did not return a firmware version (timeout or other XCONF error)
    • 3: The device is configured not to update the firmware (swupdate.conf exists on the device)
  • success: bool


{"jsonrpc": "2.0","method": "client.events.1.onFirmwareUpdateInfoReceived","param":{"status":0,"responseString":"","firmwareUpdateVersion":"AX061AEI_VBN_1911_sprint_20200109040424sdy","updateAvailable":true,"updateAvailableEnum":0,"success":true}}

onFirmwareUpdateStateChange (v1)

Description: Fires when the state of a firmware update changes.

Payload:

  • firmwareUpdateState : enum


{"jsonrpc": "2.0","method": "client.events.1.onFirmwareUpdateStateChange","param":{"firmwareUpdateStateChange":0}}

enumerationDescription
0Uninitialized- there is no firmware update in progress
1Requesting - Requesting firmware update information
2Downloading
3Failed
4DownLoad Complete
5Validation Complete
6Preparing to Reboot

onMacAddressesRetrieved(v1)

Description: Fires when the getMacAddresses asynchronous method is invoked.

Payload:

  • ecm_mac:  string
  • estb_mac: string
  • moca_mac: string
  • eth_mac: int
  • wifi_mac: string
  • info: string
  • success: bool

{"jsonrpc": "2.0","method":"client.events.1.onMacAddressesRetreived","param":{"ecm_mac":"12:99:3B:17:01:CA","estb_mac":"20:F1:9E:EE:62:08","moca_mac":"A4:D1:6D:72:24:F5","eth_mac":"37:8E:21:FA:4F:1A","wifi_mac":"00:F0:FE:D2:AB:4E","info":"","success":true}}

onRebootRequest (v1)

Description: Fires when an application invokes the reboot method.

Payload:

  • requestedApp: string
  • rebootReason: string


{"jsonrpc": "2.0","method": "client.events.1.onRebootRequest","param":{"requestedApp":"SystemPlugin","rebootReason":"FIRMWARE_FAILURE"}}

onSystemClockSet (v1)

Description: Fired when the clock on the set-top device is updated.

Payload: none


{"jsonrpc": "2.0","method": "client.events.1.onSystemClockSet","param":{}}

onSystemModeChanged(v1)

Description: Fires when the device operating mode changes. 

Payload:

  • mode: string


{"jsonrpc": "2.0","method": "client.events.1.onSystemModeChanged","param":{"mode":"DEEP_SLEEP"}}

onSystemPowerStateChanged (v1)

Description: Fires when the power manager detects a device power state change.

Payload:

  • powerState: string
  • currentPowerState: string


{"jsonrpc": "2.0","method": "client.events.1.onSystemPowerStateChanged","param":{"powerState":"STANDBY","currentPowerState":"ON"}}

onTemperatureThresholdChanged (v1)

Description: Fires when the device temperature changes beyond the WARN and MAX limits (see setTemperatureThresholds).  Not supported on all devices.

Payload:

  • thresholdType : string
  • exceeded: bool
  • temperature: float


{"jsonrpc": "2.0","method": "client.events.1.onTemperatureThresholdChanged","param":{"thresholdType":"MAX","exceeded":true,"temperature":80.000000}}

  • No labels

5 Comments

  1. Hi all,

            Please modify the getPreferredStandbyMode (v1)

    Request command.

    Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setPreferredStandbyMode","params":{"param":{"mode":"<string>"}}}

    Response : {"jsonrpc":"2.0","id":3,"result":{"success":<bool>}}

    It should be GET method and params should be empty as it is get method.

    Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreferredStandbyMode","params":{"param":{}}

    Response : {"jsonrpc":"2.0","id":3,"result":{"success":<bool>}}

    Correct me if i am wrong.

    Thanks,

    kanthi

  2. Please correct if valid:

    • rfclist: string[] of RFC configuration properties [This is not 'rfclist'; its 'rfcList'].


    Thanks,

    1. Arun P Madhavan,

      The documentation has been updated to rfcList as verified in the latest code.

  3. spelling mistake in onMacAddressesRetreived. ('i' before 'e' except after 'c'. )