RDK Resources

[*RDK Preferred*]

Code Management Facility

Code Releases

RDK Forums

[RDK Conferences]

RDK Support

Archives

Papers & Presentations Archive

In the News!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Description: Set/enable Moca support for the platform.

Arguments: 

  • none

Returns:

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

disableMoca  (v1)

Description: disable Moca support in the platform

Arguments: 

  • none

Returns:

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

queryMocaStatus  (v1)

Description: Query current status of Moca interface

...

  • none

Returns:

  • success :: bool

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

getDeviceInfo  (v1)

Description: API to collect device info details

...

  • param : string Array

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getDeviceInfo","params":{"param":["string"]}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"ecm_mac/estb_mac":"<string>","success":<bool>}}

getStateInfo (v1)

Description: API to collect device state details

...

  • param : string 

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getStateInfo","params":{"param":"<methodType>"}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"<methodType>":<int>}}

reboot (v1)

Description: API to give reboot command the box

...

  • reason: string 

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.reboot","params":{"params":{"reason":"<string>"}}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":<bool>}}

requestSystemUptime (v1)

Description: API to collect system Uptime details

...

  • none

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.requestSystemUptime","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":<bool>}}

requestSystemUptime (v1)

Description: API to collect system Uptime details

...

  • none

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.requestSystemUptime","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":<bool>}}

getTimeZoneDST (v1)

Description:  Gets the time zone.  Time zone must have been set or otherwise, null is returned

Arguments:

  • none

Returns:

  • timeZone :: String
  • success :: boolean

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getTimeZoneDST","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"timeZone":<String>, "success":<bool>}}

setTimeZoneDST (v1)

Description: Sets the time zone.

Arguments:

  • timeZone :: String

Returns:

  • success :: boolean

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setTimeZoneDST","params":{ "timeZone":<String>}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":<bool>}}

getPowerState (v1)

Description: API to collect power state from the box

...

  • none

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPowerState","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"powerState":"<string>"}}

setPowerState (v1)

Description: API to set power state of a box

...

  • powerState: string
  • standbyReason: string

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setPowerState","params":{"powerState":"<string>", "standbyReason":"<string>"}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":<bool>}}

hasRebootBeenRequested (v1)

...

  • none

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setPowerState","params":{"param":{"state":"<string>", "reason":"<string>"}}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"rebootRequested":<bool>,"success":<bool>}}

getSystemVersions (v1)

Description: API to get the System version details

...

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


Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getSystemVersions","params":{}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"stbVersion":"<string>", "receiverVersion":"<string>","stbTimestamp":"<string>","success":<bool>}}

getGzEnabled (v1)

Description: API to check the status of GzEnabled

...

  • param: bool

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setGzEnabled","params":{"param":<bool>}}
 
Response : {"jsonrpc":"2.0","id":3,"result":{"success":<bool>}}

isGzEnabled (v1)

Description: API to check the  GzEnabled or not

...

  • none

Returns:

  • success :: bool

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

getFirmwareUpdateInfo (v1)

...

  • GUID: string

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getFirmwareUpdateInfo","params":{"param":{"GUID":"string"}}}
Response : {"jsonrpc":"2.0","id":3,"result":{"asyncResponse":<bool>}}

updateFirmware (v1)

Description: API to update frimeware

...

  • 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":<bool>}}

getMode (v1)

Description: API to get the mode details

...

  • success :: bool
  • mode : string
  • duration: int

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.updateFirmware","params":{}}
Response : {"jsonrpc":"2.0","id":3,"result":{"modeInfo":{"mode":"<string>","duration":<int>},"success":<bool>}}

setMode (v1)

Description: API to set the mode details

...

  • mode: string
  • duration: int

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setMode","params":{"modeInfo":{"mode":"<string>","duration":<int>}}}
Response : {"jsonrpc":"2.0","id":3,"result":{"success":<bool>}}

setPreferredStandbyMode (v1)

...

  • standbyMode: string

Returns:

  • success :: bool

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setPreferredStandbyMode","params":{"standbyMode":"<string>"}}
Response : {"jsonrpc":"2.0","id":3,"result":{"success":<bool>}}

getPreferredStandbyMode (v1)

...

  • success :: bool
  • preferredStandbyMode: string

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>}}

getAvailableStandbyModes (v1)

...

  • success :: bool
  • supportedStandbyModes: string

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getAvailableStandbyModes","params":{}}
Response : {"jsonrpc":"2.0","id":3,"result":{"supportedStandbyModes":["<string1>", "<string2>"],"success":<bool>}}

setDeepSleepTimer (v1)

Description: API to set deep spleep timer.

...

  • success :: bool
  • supportedStandbyModes: string

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setDeepSleepTimer","params":{"seconds":<unsigned int>}}
Response : {"jsonrpc":"2.0","id":3,"result":{"success":<bool>}}

getXconfParams (v1)

Description: API to get XconfParameters.

...

  • success :: bool
  • xconfParams: string array
    • eStbMac : string
    • firmwareVersion : string
    • env: string
    • model: string

Request : {"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getXconfParams","params":{}}
Response : {"jsonrpc":"2.0","id":3,"result":{"xconfParams":{"eStbMac":"<string>", "firmwareVersion":"<string>", "env":"<string>", "model":"<string>"},"success":<bool>}}




Events:

onFirmwareUpdateStateChange (v1)

...

  • firmwareUpdateState : enum

{"jsonrpc": "2.0","method": "client.events.1.onFirmwareUpdateStateChange","param":{"firmwareUpdateStateChange":<enum:0-6>}}

onTemperatureThresholdChanged (v1)

...

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

{"jsonrpc": "2.0","method": "client.events.1.onTemperatureThresholdChanged","param":{"thresholdType":"<string>","exceeded":<bool>,"temperature":<float>}}

onSystemPowerStateChanged(v1)

...

Payload:

  • powerState: string

{"jsonrpc": "2.0","method": "client.events.1.onSystemPowerStateChanged","param":{"powerState":"<string>"}}

onSystemmodeChanged(v1)

Description: Fired when there is a change in System mode.

Payload:

  • mode: string

{"jsonrpc": "2.0","method": "client.events.1.onSystemmodeChanged","param":{"mode":"<string>"}}

onFirmwareUpdateInfoReceived(v1)

...

  • status: int
  • responseString: string
  • firwareUpdateVersion: string
  • updateAvailable: int
  • updateAvailableEnum: int
  • success: bool

{"jsonrpc": "2.0","method": "client.events.1.onFirmwareUpdateInfoReceived","param":{"status":<int>,"responseString":"<string>","firmwareUpdateVersion":"<string>","updateAvailable":<int:0/1>,"updateAvailableEnum":<int>,"success":<bool>}}

onMacAddressesRetreived(v1)

...

  • 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.onSystemmodeChanged","param":{"ecm_mac":"<string>","estb_mac":"<string>","moca_mac":"<string>","eth_mac":"<string>","wifi_mac":"<string>","info":"<string>","success":<bool>}}

onRebootRequest(v1)

Description: Fired when ever there is system reboot

...

  • requestedApp: string
  • rebootReason: string

{"jsonrpc": "2.0","method": "client.events.1.onRebootRequest","param":{"requestedApp":"<string>","rebootReason":"<string>"}}