Versions Compared

Key

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

...

  • On target - Use box's IP or the local host's IP
  • On Remote - Use only the box's IP

org.rdk.RDKShell

Plugin Toggle

Any service can be enable or disable also through JSONRPC commandsRDK Shell as an RDK service enables by default which controls the management of Composition, Layout, Z-Order, and Key handling. Below JSON RPC commands are used to validate the RDK Shell's service functionality.

FunctionRequestResponseRemarks
get Screen Resolution
activatecurl
'
http://
127.0.0.1
localhost:9998/jsonrpc
' -d
 --header "Content-Type: application/json" --request POST --data '{ "jsonrpc":"2.0",
 
"id":3,
 
"method":"
org
Controller.
rdk.RDKShell.
1.
getScreenResolution
activate",
 
"params":{"callsign":"org.rdk.RDKShell"} }'{"jsonrpc":"2.0",
 
"id":3,
 
"result":{"
w
success":
 1920, "h": 1080
true}}
set Screen Resolution
callsign argument can accept all plugins
Note: argument is case sensitive
deactivatecurl
'
http://
127.0.0.1
localhost:9998/jsonrpc
'
 -
d '{"jsonrpc":"
-header "Content-Type: application/json" --request POST --data '{ "jsonrpc":"2.0",
 
"id":3,
 
"method":"
org.rdk.RDKShell
Controller.1.
setScreenResolution
deactivate",
 
"params":{
 
"
w
callsign":
 1920"h"1080 
"org.rdk.RDKShell"} }'{"jsonrpc":"2.0",
 
"id":3,
 
"result":{"success":true}}

org.rdk.RDKShell

RDK Shell as an RDK service enables by default which controls the management of Composition, Layout, Z-Order, and Key handling. Below JSON RPC commands are used to validate the RDK Shell's service functionality.

Move to Frontd moveToFront "client": "ResidentApp" } }moveBehindWebKitBrowser,"target": "ResidentApp"
FunctionRequestResponseRemarks
get Screen Resolutionlaunch Applicationcurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.RDKShell.1.launchgetScreenResolution", "params":{ "callsign":"example", "type":"HtmlApp", "visible":true, "uri":"http://www.goggle.com" }}'{"jsonrpc":"2.0", "id":3, "result": {"w": 1920, "h": 1080} }
suspend Applicationset Screen Resolutioncurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.RDKShell.1.suspendApplicationsetScreenResolution""params":{ "clientw"1920"Cobalth"1080 }}'{"jsonrpc":"2.0""id":3"result": {} }
resume launch Applicationcurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.RDKShell.1.resumeApplicationlaunch",   "params": {"client""Cobalt"callsign":"example", "type":"HtmlApp", "visible":true, "uri":"http://www.goggle.com"}}'{"jsonrpc":"2.0", "id":3, "result": {} }
get Clientssuspend Applicationcurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getClientssuspendApplication", "params":{"client""Cobalt"}}'{"jsonrpc":"2.0", "id":3, "result": { "clients": ["ResidentApp", "org.rdk.RDKBrowser2"]} }The below functionality will be succeeded only to the clients listed in this responseget Z-Order
resume Applicationcurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.RDKShell.1.getZOrderresumeApplication""params":{"client""Cobalt"}}'{"jsonrpc":"2.0", "id":3, "result": { "clients": ["ResidentApp", "org.rdk.RDKBrowser2"]} }
get Clientscurl 'http://127.0.0.1:9998/jsonrpc' -'{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.getClients", "params":{ }}'{"jsonrpc":"2.0", "id":3, "result": { "clients": ["ResidentApp", "org.rdk.RDKBrowser2"]} }The below functionality will be succeeded only to the clients listed in this response
get Z-Orderclient argument should be the exact name of the graphics UI serviceMove to Backcurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.moveToBackgetZOrder", "params":{  "client": "ResidentApp"  }}'{"jsonrpc":"2.0", "id":3, "result": { "clients": ["ResidentApp", "org.rdk.RDKBrowser2"]} }move Behind
Move to Frontcurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.moveToFront", "params":{ "client": "ResidentApp" }}'{"jsonrpc":"2.0", "id":3, "result": {} }client argument should be the exact name of the graphics UI service
Move to Backset Focuscurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.setFocusmoveToBack", "params":{ "client": "WebKitBrowserResidentApp" }}'{"jsonrpc":"2.0", "id":3, "result": {} }
get Boundsmove Behind

curl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.

getBounds

moveBehind", "params":{ "client": "WebKitBrowser", "target": "ResidentApp"}}'

{"jsonrpc":"2.0", "id":3, "result": {
             "x": 0,
             "y": 0,
             "w": 600,
             "h": 400} }} }

set Focus

curl 'http://127.0.0.1:9998/jsonrpc

set Boundscurl 'http://127.0.0.1:9998/jsonrpc

-d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.

setBounds

setFocus", "params":{ 

             

"client": "WebKitBrowser"

"x"0"y"0"w"600, "h":

 

400 

}}'

{"jsonrpc":"2.0", "id":3, "result": {} }
get VisibilityBoundscurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.RDKShell.1.getVisibilitygetBounds""params":{ "client""ResidentApp" }}'{"jsonrpc":"2.0", "id":3, "result": {
             "x": 0,
             "y": 0,
             "w": 600,
             "h"visible": true400} }

set VisibilityBoundscurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.setVisibilitysetBounds", "params":{              "client": "ResidentApp"WebKitBrowser""x"0"y"0, "visiblew": true  600, "h"400 }}'{"jsonrpc":"2.0", "id":3, "result": {} }
get OpacityVisibilitycurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.RDKShell.1.getOpacitygetVisibility""params":{ "client""ResidentApp" }}'{"jsonrpc":"2.0", "id":3, "result": { "opacityvisible" : 100true} }
set OpacityVisibilitycurl 'http://127.0.0.1:9998/jsonrpc' -d '

{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.

setOpacity

setVisibility", "params":{ "client": "ResidentApp", "

opacity

visible": true 

100

}}'

{"jsonrpc":"2.0", "id":3, "result": {} }
get ScaleOpacitycurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.RDKShell.1.getScalegetOpacity""params":{ "client""ResidentApp"}}'{"jsonrpc":"2.0", "id":3, "result": { "sxopacity" :1.5, "sy":1.5 100} }
set ScaleOpacitycurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.RDKShell.1.setScalesetOpacity""params":{ "client""ResidentApp""sxopacity":1.5"sy":1.5 100}}'{"jsonrpc":"2.0", "id":3, "result": {} }
killget Scalecurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.RDKShell.1.killgetScale""params":{ "client": "WebKitBrowserResidentApp" }}'{"jsonrpc":"2.0", "id":3, "result": {"sx":1.5, "sy":1.5} }
generate Keyset Scalecurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.generateKeysetScale", "params":{"keysclient":[ { "keyCodeResidentApp": 49, "modifierssx": [],"delay":1.0}{"keyCode": 50,"modifiers": [],"delay":2.0}]}}5"sy":1.5}}'{"jsonrpc":"2.0", "id":3, "result": {} }
kill

Note: The above functions are referred from the RDK Service's RDK Shell wiki page

org.rdk.Network

Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions

curl http://localhost:9998/jsonrpc NetworkgetInterfaces
FunctionRequestResponseRemarks
get Interfacescurl 'http://127.0.0.1:9998/jsonrpc-d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.kill", "params":{ "client": "WebKitBrowser" }}'{"jsonrpc":"2.0", "id":3, "result": {} }
generate Keycurl 'http://127.0.0.1:9998/jsonrpc' -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.RDKShell.1.generateKey", "params":{"keys":[ {"keyCode": 49,"modifiers": [],"delay":1.0}{"keyCode": 50,"modifiers": [],"delay":2.0}]}}'{"jsonrpc":"2.0", "id":3, "result": {} }

Note: The above functions are referred from the RDK Service's RDK Shell wiki page

org.rdk.Network

Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions

FunctionRequestResponseRemarksget Current Statecurl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0curl http://localhost:9998/jsonrpc -d '{"jsonrpc2.0 id3, "method":"org.rdk.Network.1.setInterfaceEnabled", "params":{"interface":"WIFI",  persist}'"jsonrpc":"2.0", "id":3, "result": 0}set Default InterfacesetDefaultInterface ", "persist:true
FunctionRequestResponseRemarks
get Interfaces"interfaces":
[
  {
    "interface":"WIFI",
    "macAddress":"AA:AA:AA:AA:AA:AA",
    "enabled":true,
    "connected":true
  },
  {
    "interface":"ETHERNET",
    "macAddress":"AA:AA:AA:AA:AA:AD",
    "enabled":false,
    "connected":false
  }
]
} }is Interface Enabled
curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0",   "id":3,   "method":"org.rdk.Network.1.isInterfaceEnabledgetInterfaces",   "params":{"interface":"WIFI"}}'

{"jsonrpc":"2.0", "id":3, "result": {"

enabled

interfaces":

true} }


Enable Interface

[
  {
    "interface":"

WIFI",


    "

macAddress":

"AA:AA:AA:AA:AA:AA",
    "enabled":true,


    "

connected":true
  }

,
  {


    "interface":"ETHERNET",
    "macAddress":"AA:AA:AA:AA:AA:AD",
    "enabled":false,
    "connected":false
  }
]
} }


is Interface Enabled

curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1.

isInterfaceEnabled", "params":{

"interface":"WIFI

"

}}'

{"jsonrpc":"2.0", "id":3, "result": {"enabled":true} }
get Default InterfaceEnable Interface

curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1.getDefaultInterfacesetInterfaceEnabled", "params":{"interface":"WIFI", "enabled":true, "persist":true}}'

{"jsonrpc":"2.0", "id":3, "result": {"interface":"WIFI"}} 0}
set Default Interfaceget IP for default interface

curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1.getStbIpsetDefaultInterface", "params":{}} "interface":"WIFI", "persist":true}}'

{"jsonrpc":"2.0", "id":3, "result": {"ip":"192.168.xx.yyy","success":true}}
pingget Default Interface

curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1.pinggetDefaultInterface", "params":{}}'  

{"endpointjsonrpc": "45.57.221.202.0",
   "packetsid":3, "result": {"interface":"WIFI"}}

get IP for default interface

curl http://localhost:9998/jsonrpc -d ' 10
}}'{"jsonrpc":"2.0", "id":3, "

result":{
  "target" : "173.194.123.7",
  "success" : true,
  "packetsTransmitted" : 10,
  "packetsReceived" : 10,
  "packetLoss" : "0.0",
  "tripMin" : "61.264",
  "tripAvg" : "130.397",
  "tripMax" : "230.832",
  "tripStdDev" : "80.919",
  "error" : null
}}

method":"org.rdk.Network.1.getStbIp", "params":{}}'

{"jsonrpc":"2.0","id":3,"result":{"ip":"192.168.xx.yyy","success":true}}
pingget Named Endpoints

curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1.getNamedEndpointsping", "params":{}}'

{

  "

jsonrpc

endpoint": "

2.0

45.57.221.20",

 


  "

id

packets":

3, "result":{"endpoints":["CMTS"]

 10
}}

ping to named Endpoint

'

curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1.pingNamedEndpoint", "params":{
"endpointName": "CMTS",
"packets": 10
}}'{"jsonrpc":"2.0", "id":3, "result":{
  "target" : "173.194.123.7",
  "success" : true,
  "packetsTransmitted" : result":{
  "target" : "173.194.123.7",
  "success" : true,
  "packetsTransmitted" : 10,
  "packetsReceived" : 10,
  "packetLoss" : "0.0",
  "tripMin" : "61.264",
  "tripAvg" : "130.397",
  "tripMax" : "230.832",
  "tripStdDev" : "80.919",
  "error" : null
}}

traceget Named Endpoints

curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1.tracegetNamedEndpoints", "params":{
"endpoint": "45.57.221.20",
"packets": 10
}}'

{"jsonrpc":"2.0", "id":3, "result":{
  "targetendpoints" : "173.194.123.7",
  "success" : true,
  "error" : null,
  "results" : "<<<traceroute command results>>>"
}}["CMTS"]}}

ping to trace a named Endpoint

curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1.traceNamedEndpointpingNamedEndpoint", "params":{
"guid": "iasoviubejcv",
"endpointName": "CMTS",
"packets": 10
}}'

{"jsonrpc":"2.0", "id":3, "result":{
  "target" : "173.194.123.7",
  "success" : true,
  "errorpacketsTransmitted" : null10,
  "packetsReceived" : 10,
  "packetLoss" : "0.0",
  "tripMin" : "61.264",
  "tripAvg" : "130.397",
  "tripMax" : "230.832",
  "resultstripStdDev" : "<<<traceroute command results>>>""80.919",
  "error" : null
}}

get IP Settingstrace

curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1.getIPSettingstrace", "params":{ 
"interfaceendpoint": "wlan0" "45.57.221.20",
"packets": 10
}}'

{"jsonrpc":"2.0", "id":3, "result":{
  "interfacetarget" : "wifi173.194.123.7",
  "ipversionsuccess": "IPv4
  "autoconfig": : true,
  "ipaddrerror": “192.168.1.101" : null,
  "netmaskresults" : "255.255.255.0"
  "gateway": "192.168.1.1",
  "primarydns": "192.168.1.1",
  "secondarydns": ""
} }<<<traceroute command results>>>"
}}

trace a named Endpointset IP Settings

curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1.setIPSettingstraceNamedEndpoint", "params":{
  "interfaceguid": "wifiiasoviubejcv",
  "ipversionendpointName": "IPv4CMTS",
  "autoconfigpackets": true,
  "ipaddr": “192.168.1.101",
  "netmask": "255.255.255.0"
  "gateway": "192.168.1.110
}}'

{"jsonrpc":"2.0", "id":3, "result":{
  "target" : "173.194.123.7",
  "primarydnssuccess" : "192.168.1.1"true,
  "error" : null,
  "secondarydnsresults" : "<<<traceroute command results>>>"
}}

get IP Settings

curl http://localhost:9998/jsonrpc -d ''{"jsonrpc":"2.0", "id":3, "

result

method":

{
  "supported": true,
  "success": true
} }

Note: The functions are referred from the RDK Service's Network wiki page

org.rdk.Wifi

Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions

"org.rdk.Network.1.getIPSettings", "

id

params":

3,

{ "

method:{

interface":

"org.rdk.Wifi.1.getCurrentState", "params"

 "wlan0" }}'

{"jsonrpc":"2.0", "id":3, "result":{
  "
state
interface":
2,"success":true}}start Scancurl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2
 "wifi",
  "ipversion": "IPv4
  "autoconfig": true,
  "ipaddr": “192.168.1.101",
  "netmask": "255.255.255.0", 
  "
id,
gateway":
3
 "
method":"org.rdk.Wifi
192.168.1.1
.startScan
",
 "params":{"incremental":false,"ssid":"","frequency":""}}'{"jsonrpc":"2.0", "id":3, "result":{"success":true}}incremental can be set to true to get each SSID in different events (mostly used from GUI)

  "primarydns": "192.168.1.1",
  "secondarydns": ""
} }

set IP Settings

curl http://localhost

stop scancurl http://127.0.0.1

:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.

Wifi

Network.1.

stopScan

setIPSettings", "params":{

}}'


{

  "

jsonrpc

interface": "

2.0

wifi",

 


  "

id

ipversion":

3,

 "

result":{"success

IPv4",
  "autoconfig": true

}}set Enabledcurl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2

,
  "ipaddr": “192.168.1.101",
  "netmask": "255.255.255.0", 
  "

id

gateway":

3, "method":"org.rdk.Wifi.1.setEnabled", "params":{"enable": true

 "192.168.1.1",
  "primarydns": "192.168.1.1",
  "secondarydns": ""
}}'

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

Note: The functions are referred from the RDK Service's Network wiki page

org.rdk.Wifi

Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions

connectconnectssid123412341234passphrasefoobar, "securityMode" 2}}'jsonrpc", "id":3.0""result :{"get connected SSIDgetConnectedSSID{}}'jsonrpc"2.0" id":3, "result":{"TP-LINK 1234bssidec:08:6b:ce:09:20","rate144000000noise"-121.000000","security":"5","signalStrength":"-27.000000","frequency":"2.442000","
FunctionRequestResponseRemarks
get Current State

curl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Wifi.1.

getCurrentState", "params":{}}'

{"jsonrpc":"2.0", "id":3, "result": {"state":2,"success":true}}
start Scan

curl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Wifi.1.

startScan", "params":

{"

incremental":

false,

"

ssid":"

","

frequency":"

"}}'

{"jsonrpc":"2.0", "id":3, "result":{"success":true}}incremental can be set to true to get each SSID in different events (mostly used from GUI)
stop scandisconnect

curl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Wifi.1.disconnectstopScan", "params":{}}'

{"jsonrpc":"2.0", "id":3, "result":{"result":"","success":true}}
initiate pairing through WPSset Enabled

curl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Wifi.1.

initiateWPSPairing"}'{"jsonrpc":"2.0"

setEnabled", "

id

params":

3, "result":

{"

result

enable":

"","success":true}}
cancel WPS pairingcurl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.Wifi.1.cancelWPSPairing""params":{

 true}}'

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

curl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Wifi.1.

saveSSID

connect", "params":{"ssid":

 

"123412341234", "passphrase": "foobar", "securityMode": 2}}'

{"jsonrpc":"2.0", "id":3, "result":{"result":0,"success":true}}
is Pairedget connected SSID

curl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Wifi.1.isPairedgetConnectedSSID", "params":{}}'

{"jsonrpc":"2.0", "id":3, "result":{"

result

ssid":

0,"success":true}}
get Paired SSIDcurl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.Wifi.1.getPairedSSID""params":{}}'

"TP-LINK 1234","bssid":"ec:08:6b:ce:09:20","rate":"144.000000","noise":"-121.000000",

"security":"5","signalStrength":"-27.000000","frequency":"2.442000

{"jsonrpc":"2.0", "id":3, "result":{"ssid": "123412341234

","success":true

}}

}


get Paired SSID Infodisconnect

curl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Wifi.1.getPairedSSIDInfodisconnect", "params":{}}'

{"jsonrpc":"2.0", "id":3, "result":{"ssidresult": "123412341234", "bssid": "ff:ff:ff:ff:ff:ff,"success":true}}
clear SSIDinitiate pairing through WPScurl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.Wifi.1.clearSSID""params":{}}initiateWPSPairing"}'{"jsonrpc":"2.0", "id":3, "result":{"result":0"","success":true}}
set Signal Threshold change enabledcancel WPS pairingcurl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.Wifi.1.setSignalThresholdChangeEnabledcancelWPSPairing""params":{"enabled"true"interval"2000}}'{"jsonrpc":"2.0", "id":3, "result":{"result":"","success":true}}
is Signal Threshold change enabledsave SSIDcurl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0""id":3"method":"org.rdk.Wifi.1.isSignalThresholdChangeEnabledsaveSSID""params":{"ssid""123412341234""passphrase""foobar""securityMode"2}}'{"jsonrpc":"2.0", "id":3, "result":{"result":10,"success":true}}

Note: The functions are referred from the RDK Service's Wifi wiki page

org.rdk.Bluetooth

Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions

curl --header "Content-Type: application/json" --request POST --data ""Bluetoothenable"}' http://127.0.0.1:9998/jsonrpc curl --header "Content-Type: application/json" --request POST --data ""Bluetoothdisable"}' http://127.0.0.1:9998/jsonrpc

is Paired

curl http://127.0.0.1:9998/jsonrpc -d

FunctionRequestResponseRemarks
enable

'{"jsonrpc":"2.0", "id":

3

, "method":"org.rdk.

Wifi.1.

isPaired", "params":{}}'

{"jsonrpc":"2.0", "id":3, "result":{"result":0,"success":true}}disable
get Paired SSIDcurl http://127.0.0.1:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Wifi.1.getPairedSSID""params":{}}'{"jsonrpc":"2.0", "id":3, "result":{"ssid": "123412341234","success":true}}}
get Device NamePaired SSID Info

curl http://127.0.0.1:9998/jsonrpc -d 'curl --header "Content-Type: application/json" --request POST --data {"jsonrpc":"2.0", "id":"3", "method":"org.rdk.BluetoothWifi.1.getName"}' http://127.0.0.1:9998/jsonrpcgetPairedSSIDInfo", "params":{}}'

{"jsonrpc":"2.0", "id":3, "result":{"namessid":"Xfinity Bluetooth Audio" "123412341234", "bssid": "ff:ff:ff:ff:ff:ff,"success":true}}
clear SSIDcurl http://127.0.0.1:9998/jsonrpc -d set Device Namecurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.BluetoothWifi.1.setNameclearSSID", "params":{"name": "RDK Bluetooth Device"}}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0", "id":3, "result":{"result":0,"success":true}}is Discoverable
set Signal Threshold change enabledcurl http://127.0.0.1:9998/jsonrpc -d curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.BluetoothWifi.1.isDiscoverablesetSignalThresholdChangeEnabled"}' http://127.0.0.1:9998/jsonrpc"params":{"enabled"true"interval"2000}}'{"jsonrpc":"2.0", "id":3, "result":{"discoverable":false,"success":true}}set Discoverable
is Signal Threshold change enabledcurl http://127.0.0.1:9998/jsonrpc -d curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.BluetoothWifi.1.setDiscoverableisSignalThresholdChangeEnabled", "params":{"discoverable":true, "timeout":10}}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0", "id":3, "result":{"result":1,"success":true}}start Scan

Note: The functions are referred from the RDK Service's Wifi wiki page

org.rdk.Bluetooth

Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions

  startScan", "params": {"timeout": "5", "profile": "DEFAULT"}}"status":"AVAILABLE",stop scan  stopScan
FunctionRequestResponseRemarks
enable curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.enable"}http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true}}
disable curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.disable"}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true}}
get Discovered DevicesDevice Name

curl --header "Content-Type: application/json" --request POST --

data '

data {"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.

getDiscoveredDevices

getName"}' http://127.0.0.1:9998/jsonrpc

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "discoveredDevices": [
      {
        "deviceID": "61579454946360",
        "name": "[TV] UE32J5530",
        "deviceType": "TV",
        "connected": false,
        "paired": false
      }
    ],
    "Xfinity Bluetooth Audio","success": true
  }
}

pairset Device Name

curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.

pair

setName", "params":{"

deviceID

name": "

256168644324480

RDK Bluetooth Device"}}' http://127.0.0.1:9998/jsonrpc

{"jsonrpc":"2.0","id":3,"result":{"success":true}}
get Paired Devicesis Discoverablecurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.getPairedDevicesisDiscoverable"}' http://127.0.0.1:9998/jsonrpc{
  "jsonrpc": "2.0",
  "id": 3,
  "result":{
    "pairedDevicesdiscoverable": [
      {
        "deviceID": "256168644324480",
        "name": "Eleven",
        "deviceType": "SMARTPHONE",
        "connected": true
      },
      {
        "deviceID": "26499258260618",
        "name": "Little Big",
        "deviceType": "SMARTPHONE",
        "connected": false
      }
    ],
    "success": true
  }
}false,"success":true}}

set Discoverablecurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.setDiscoverable", "params":{"discoverable":true, "timeout":10}}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true}}
start Scanconnectcurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.connectstartScan", "params": {"deviceIDtimeout": "2561686443244805", "deviceType": "SMARTPHONE", "profile": "SMARTPHONEDEFAULT"}}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"status":"AVAILABLE","success":true}}
get Connected Devicesstop scancurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.getConnectedDevicesstopScan"}' http://127.0.0.1:9998/jsonrpc{
  "jsonrpc": "2.0",
  "id": 3,
  "result":{
    "success":true}}

get Discovered Devicescurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.getDiscoveredDevices"}' http://127.0.0.1:9998/jsonrpc

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "discoveredDevices": [
connectedDevices": [
      {
        "deviceID": "25616864432448061579454946360",
        "name": "Eleven[TV] UE32J5530",
        "deviceType": "SMARTPHONETV",
        "activeStateconnected": false,
        "0paired": false
      }
    ],
    "success": true
  }
}


unpairpaircurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.unpairpair", "params": {"deviceID": "256168644324480"}}http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true}}
disconnectget Paired Devicescurl --header "Content-Type: application/json" --request POST --data   '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.disconnect", "params": {"deviceID": "256168644324480"}}getPairedDevices"}' http://127.0.0.1:9998/jsonrpc

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {

"success":true}}


    "pairedDevices": [
      {
        "deviceID": "256168644324480",
        "name": "Eleven",
        "deviceType": "SMARTPHONE",
        "connected": true
      },
      {
        "deviceID": "26499258260618",
        "name": "Little Big",
        "deviceType": "SMARTPHONE",
        "connected": false
      }
    ],
    "success": true
  }
}


connectcurl set Audio Streamcurl http://127.0.0.1:9998/jsonrpc  --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.setAudioStreamconnect", "params": {"deviceID": "256168644324480", "audioStreamNamedeviceType": "PRIMARY"}}'{"jsonrpcSMARTPHONE", "profile": "SMARTPHONE"}}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id"2.0","id":3,"result":{"success":true}}
get Device InfoConnected Devicescurl  http://127.0.0.1:9998/jsonrpc  --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.getDeviceInfogetConnectedDevices""params":{"deviceID":"256168644324480"}}'}' http://127.0.0.1:9998/jsonrpc

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "deviceInfoconnectedDevices": [
      {
              "deviceID": "256168644324480",
              "name": "Eleven",
              "deviceType": "SMARTPHONE",
              "manufactureractiveState": "640"0"
      }
    ],
          "MACsuccess": "E8:FB:E9:0C:2C:80",
      "signalStrength": "0",
      "rssi": "0",
      "supportedProfile": "Not Identified;Not Identified;..."
    },
    "success": true
  }
}

get Audio Info

true
  }
}


unpair

curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.unpair", "params": {"deviceID": "256168644324480"}}'

curl

 http://127.0.0.1:9998/jsonrpc

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

curl

 

--header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.

getAudioInfo

disconnect", "params": {"deviceID": "256168644324480"}}' http://127.0.0.1:9998/jsonrpc

{
  "jsonrpc": "2.0",
  "id": 3,
  "result":{
    "trackInfosuccess": {
      "album": "Spacebound Apes",
      "genre": "Jazz",
      "title": "Grace",
      "artist": "Neil Cowley Trio",
      "ui32Duration": "217292",
      "ui32TrackNumber": "1",
      "ui32NumberOfTracks": "73"
    },
    "success": true
  }
}true}}

set Audio Streamsend Audio Playback Commandcurl http://127.0.0.1:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0"

curl http://127.0.0.1:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0"

, "id":"3", "method":"org.rdk.Bluetooth.1.

sendAudioPlaybackCommand

setAudioStream", "params": {"deviceID": "256168644324480", "

command

audioStreamName": "

PLAY

PRIMARY"}}'

{"jsonrpc":"2.0","id":3,"result":{"success":true}}
respond To Eventget Device Infocurl http://127.0.0.1:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id": "3""method":"org.rdk.Bluetooth.1.respondToEventgetDeviceInfo""params":{"deviceID": "256168644324480""eventType}}'

{
  "jsonrpc": "

onPairingRequest

2.0",

 


  "id": 3,
  "result": {
    "deviceInfo": {
      "deviceID": "256168644324480",
      "name": "Eleven",
      "deviceType": "SMARTPHONE",
      "manufacturer": "640",
      "MAC": "E8:FB:E9:0C:2C:80",
      "signalStrength": "0",
      "rssi": "0",
      "supportedProfile": "Not Identified;Not Identified;..."
    },
    "success": true
  }
}


get Audio Infocurl http://127.0.0.1:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":"3", "method":"org.rdk.Bluetooth.1.getAudioInfo", "params": {"deviceID": "256168644324480"}}'

{
  "jsonrpc": "2.0",
  "id": 3,
  "result": {
    "trackInfo": {
      "album": "Spacebound Apes",
      "genre": "Jazz",
      "title": "Grace",
      "artist": "Neil Cowley Trio",
      "ui32Duration": "217292",
      "ui32TrackNumber": "1",
      "ui32NumberOfTracks": "73"
    },
    "success": true
  }
}


send Audio Playback Commandcurl http://127.0.0.1:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0""id":"3""method":"org.rdk.Bluetooth.1.sendAudioPlaybackCommand""params": {"deviceID""256168644324480""command""PLAY"}}'{"jsonrpc":"2.0","id":3,"result":{"success":true}}
respond To Eventcurl http://127.0.0.1:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id""3""method":"org.rdk.Bluetooth.1.respondToEvent""params": {"deviceID""256168644324480""eventType""onPairingRequest""responseValue""responseValue""ACCEPTED"}}'{"jsonrpc":"2.0","id":3,"result":{"success":true}}

...

curl http://localhost:9998/jsonrpc 
FunctionRequestResponseRemarks
cacheContainscurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.cacheContains","params":{"key":"sampleKey"}}'{"jsonrpc":"2.0","id":3,"result":{"success":true}}
clearLastDeepSleepReasoncurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.clearLastDeepSleepReason","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"success":true}}
getAvailableStandbyModescurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getAvailableStandbyModes","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"supportedStandbyModes":["LIGHT_SLEEP", "DEEP_SLEEP"],"success":true}}
getCachedValuecurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getCachedValue","params":{"key":"sampleKey"}}'{"jsonrpc":"2.0","id":3,"result":{"sampleKey":"4343.3434","success":true}}
getCoreTemperaturecurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getCoreTemperature","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"temperature":48.000000,"success":true}}
getDeviceInfocurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getDeviceInfo","params":{"params":["estb_mac"]}}'{"jsonrpc":"2.0","id":3,"result":{"ecm_mac/estb_mac":"AA:BB:CC:DD:EE:FF:GG","success":true}}
getDownloadedFirmwareInfocurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getDownloadedFirmwareInfo","params":{}}'

{"jsonrpc":"2.0","id"3,"result" {"currentFWVersion":"AX061AEI_VBN_1911_sprint_20200109040424sdy",

"downloadedFWVersion":"AX061AEI_VBN_1911_sprint_20200510040450sdy",

"downloadedFWLocation":"","isRebootDeferred":false,"success":true}}


getFirmwareDownloadPercentcurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getFirmwareDownloadPercent","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"downloadPercent":25,"success":true}}
getFirmwareUpdateInfocurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getFirmwareUpdateInfo","params":{"param":{"GUID":"1234abcd"}}}'{"jsonrpc":"2.0","id":3,"result":{"asyncResponse":true}}
getFirmwareUpdateStatecurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getFirmwareUpdateState","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"firmwareUpdateState":"Download Complete","success":true}}
getLastDeepSleepReasoncurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getLastDeepSleepReason","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"lastDeepSleepReason":"thermal_deepsleep_critical_threshold","success":true}}
getMacAddressescurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getMacAddresses","params":{"GUID":"61734787891723481"}}'{"jsonrpc":"2.0","id":3,"result":{"asyncResponse":true,"success":true}}
getMilestonescurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method": "org.rdk.System.1.getMilestones","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"milestones":["RDK_STARTED:8893","SEND_DHCP_REQUEST:9530","RECV_DHCP_RESPONSE:9602","UPNP_START_DISCOVERY:12863","UPNP_START_DISCOVERY:13618","IP_ACQUISTION_COMPLETED:15716","IP_ACQUISTION_COMPLETED:16470","2020 Sep 24 20:32:49.688454 raspberrypi-rdk-mc systemd[1]: Starting Log RDK Started Service...","-- Subject: Unit log-rdk-start.service has begun start-up","-- Defined-By: systemd","-- Support: http://lists.freedesktop.org/mailman/listinfo/systemd-devel","-- ","-- Unit log-rdk-start.service has begun starting up.","2020 Sep 24 20:32:50.088253 raspberrypi-rdk-mc 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."]-devel","-- ","-- Unit log-rdk-start.service has finished starting up.","-- ","-- The start-up result is done."],"success":true}}
getModecurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getMode","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"modeInfo":{"mode":"NORMAL","duration":0},"success":true}}
getModegetPowerStatecurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getModegetPowerState","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"modeInfopowerState":{"mode":"NORMAL","duration":0}ON", "success":true}}
getPowerStategetPreferredStandbyModecurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPowerStategetPreferredStandbyMode","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"powerStatepreferredStandbyMode":"ONDEEP_SLEEP","success":true}}
getPreferredStandbyModegetPreviousRebootInfocurl curl http://localhost:9998/jsonrpc  --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreferredStandbyModegetPreviousRebootInfo","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"preferredStandbyModetimeStamp":"20200128083540","reason":"DEEP_SLEEPTriggered from System Plugin API Validation","success":true}}
getPreviousRebootInfogetPreviousRebootInfo2curl curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreviousRebootInfogetPreviousRebootInfo2","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"rebootInfo":{"timestamp":"Tue Jan 28 08:35:40 UTC 2020","paramssource":{}}'{"jsonrpc":"2.0","id":3,"result":{"timeStamp":"20200128083540","reason":"Triggered from System Plugin API Validation""SystemPlugin","reason":"FIRMWARE_FAILURE","customReason":"API Validation","lastHardPowerReset":"Tue Jan 28 08:22:22 UTC 2020"},"success":true}}
getPreviousRebootInfo2getPreviousRebootReasoncurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreviousRebootInfo2getPreviousRebootReason","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"rebootInfoRFCConfig":{"timestampDevice.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AccountInfo.AccountID":"Tue Jan 28 08:35:40 UTC 20201181405614235499371","sourceDevice.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.UPnP.Enabled":"SystemPluginEmpty response received","reasonDevice.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AllowOpenPorts.Enabled":"FIRMWARE_FAILUREEmpty response received","customReasonDevice.DeviceInfo.MemoryStatus.Total":"API Validation1144560","lastHardPowerResetDevice.DeviceInfo.MemoryStatus.Free":"Tue Jan 28 08:22:22 UTC 2020732144"},"success":true}}
getPreviousRebootReasongetRFCConfigcurl curl http://localhost:9998/jsonrpc  --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getPreviousRebootReasongetRFCConfig","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"]}}'{"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}}
getRFCConfiggetSerialNumbercurl http://localhost:9998/jsonrpc  --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getRFCConfiggetSerialNumber","params":{}}'{"rfcListjsonrpc":["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"]}}'2.0","id":3,"result":{"serialNumber":"M11806TK0024","success":true}}
getStateInfocurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","resultmethod":{"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}}"org.rdk.System.1.getStateInfo","params":{"param":"com.comcast.channel_map"}}' {"jsonrpc":"2.0","id":3,"result":{"com.comcast.channel_map”:2, “success”:true}}
getSystemVersionscurl getSerialNumbercurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getSerialNumbergetSystemVersions","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"serialNumber":"M11806TK0024"stbVersion":"AX061AEI_VBN_1911_sprint_20200109040424sdy","receiverVersion":"3.14.0.0","stbTimestamp":"Thu 09 Jan 2020 04:04:24 AP UTC","success":true}}
getStateInfogetTemperatureThresholdscurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getStateInfogetTemperatureThresholds","params":{"param":"com.comcast.channel_map"}}'{"jsonrpc":"2.0","id":3,"result":{"temperatureThresholds":{"WARN":"com.comcast.channel_map”:2, “success”100.000000","MAX":"110.000000","temperature":"48.000000"},"success":true}}
getSystemVersionsgetTimeZoneDSTcurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getSystemVersions","params":{}}'getTimeZoneDST","params":{}}'{"jsonrpc":"2{"jsonrpc":"2.0","id":3,"result":{"stbVersion":"AX061AEI_VBN_1911_sprint_20200109040424sdy","receiverVersion":"3.14.0.0","stbTimestampid":"Thu 09 Jan 2020 04:04:24 AP UTC3,"result":{"timeZone":"America/New_York","success":true}}
getTemperatureThresholdsgetXconfParamscurl curl http://localhost:9998/jsonrpc  --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getTemperatureThresholdsgetXconfParams","params":{}}' {"jsonrpc":"2.0","id":3,"result":{"temperatureThresholdsxconfParams":{"WARNenv":"vbn","eStbMac":"100.00000020:F1:9E:EE:62:08","MAXmodel":"110.000000AX061AEI","temperaturefirmwareVersion":"48.000000AX061AEI_VBN_1911_sprint_20200109040424sdy"},"success":true}}
getTimeZoneDSThasRebootBeenRequestedcurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getTimeZoneDSThasRebootBeenRequested","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"timeZonerebootRequested":"America/New_York"false,"success":true}}
getXconfParamsisGzEnabledcurl http://localhost:9998/jsonrpc  --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.getXconfParamsisGzEnabled","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"xconfParams":{"env":"vbn","eStbMac":"20:F1:9E:EE:62:08","model":"AX061AEI","firmwareVersion":"AX061AEI_VBN_1911_sprint_20200109040424sdy"}enabled":false,"success":true}}
hasRebootBeenRequestedqueryMocaStatuscurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method": "org.rdk.System.1.hasRebootBeenRequestedqueryMocaStatus","params":{}}'{"jsonrpc":"2.0","id":3,"result":{"rebootRequestedmocaEnabled":falsetrue,"success":true}}
isGzEnabledrebootcurl curl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.isGzEnabledreboot","params":{"rebootReason":"API Validation"}}'{"jsonrpc":"2.0","id":3,"result":{"enabledIARM_Bus_Call_STATUS":false1,"success":true}}
queryMocaStatusremoveCacheKeycurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method": "org.rdk.System.1.queryMocaStatusremoveCacheKey","params":{key:"sampleKey"}}' {"jsonrpc":"2.0","id":3,"result":{"mocaEnabled":true,"success":true}}
rebootrequestSystemUptimecurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.rebootrequestSystemUptime","params":{"rebootReason":"API Validation"}}'{"jsonrpc":"2.0","id":3,"result":{"IARM_Bus_Call_STATUSsystemUptime":1"1666.92","success":true}}
removeCacheKeysetCachedValuecurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.removeCacheKeysetCachedValue","params":{"key":"sampleKey","value":4343.3434}}'{"jsonrpc":"2.0","id":3,"result":{"success":true}}
requestSystemUptimesetDeepSleepTimercurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.requestSystemUptimesetDeepSleepTimer","params":{"seconds":3}}'{"jsonrpc":"2.0","id":3,"result":{"systemUptime":"1666.92","success":true}}
setCachedValuesetGzEnabledcurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setCachedValuesetGzEnabled","params":{"keyenabled":"sampleKey","value":4343.3434true}}'{"jsonrpc":"2.0","id":3,"result":{"success":true}}
setDeepSleepTimerset STB modecurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setDeepSleepTimersetGzEnabled","params":{"secondsmodeInfo":{"mode":"NORMAL","duration":320}}}' {"jsonrpc":"2.0","id":3,"result":{"success":true}}
setGzEnabledcurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setGzEnabledsetPowerState","params":{"enabled":true"powerState":"STANDBY", "standbyReason":"APIUnitTest"}}' {"jsonrpc":"2.0","id":3,"result":{"success":true}}
set STB modesetPreferredStandbyModecurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setGzEnabledsetPreferredStandbyMode","params":{"modeInfostandbyMode":{"mode":"NORMAL","duration":20}}}"DEEP_SLEEP"}}'{"jsonrpc":"2.0","id":3,"result":{"success":true}}
setGzEnabledsetTemperatureThresholdscurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setPowerStatesetTemperatureThresholds","params":{"powerStatethresholds":{"WARN":"STANDBY50.000000","standbyReasonMAX":"APIUnitTest80.000000"}}}'{"jsonrpc":"2.0","id":3,"result":{"success":true}}
setPreferredStandbyModesetTimeZoneDSTcurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setPreferredStandbyModesetTimeZoneDST","params":{"standbyModetimeZone":"DEEP_SLEEPUTC-5"}}'{"jsonrpc":"2.0","id":3,"result":{"success":true}}
setTemperatureThresholdsupdateFirmwarecurl http://localhost:9998/jsonrpc --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk.System.1.setTemperatureThresholdsupdateFirmware","params":{"thresholds":{"WARN":"50.000000","MAX":"80.000000"}}}' {"jsonrpc":"2.0","id":3,"result":{"success":true}}setTimeZoneDST

Note: The functions are referred from the RDK Service's System wiki page

Firmware Control

data '{"jsonrpc":"2id3methodorg.rdk.System.1.setTimeZoneDSTparams{timeZoneUTC-53{"success":true}updateFirmware http://localhost:9998/jsonrpc header data "3"org.rdk.SystemupdateFirmware3"success":true}}{
FunctionRequestResponseRemarks
upgradecurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.FirmwareControl.1.upgrade", "params":{"name": "firmware_v.0", "location": "http://my.site.com/images", "type": "RCDL", "progressinterval": 10, "hmac": "2834e6d07fa4c7778ef7a4e394f38a5c321afbed51d54ad512bd3fffbc7aa5debc"}}' http://127.0.0.1:9998/jsonrpc

{ "jsonrpc": "2.0", "id":

1234567890, "result":

null }


resume

curl

--

header "Content-Type: application/json" --request POST --

data '

{ "jsonrpc": "2.0", "id":

1234567890, "method": "

FirmwareControl.1.

resume", "params": { "name": "firmware_v.0", "location": "http://my.site.com/images" } }

' http://127.0.0.1:9998/jsonrpc

{ "jsonrpc": "2.0", "id":

1234567890, "result":

null }


Note: The functions are referred from the RDK Thunder Nano Service's System wiki pageGitHub link

org.rdk.FrameRate

Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions

...