RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
...
Function | Request | Response | Remarks |
---|
activate | curl |
|
|
|
"id":3, |
"method":" |
Controller. |
1. |
activate", |
"params":{"callsign":"org.rdk.RDKShell"} }' | {"jsonrpc":"2.0", |
"id":3, |
"result":{" |
success": |
1920
,
"h"
:
1080
true}} |
callsign argument can accept all plugins Note: argument is case sensitive | |
deactivate | curl |
|
|
|
{
"jsonrpc"
:
"-header "Content-Type: application/json" --request POST --data '{ "jsonrpc":"2.0", |
"id":3, |
"method":" |
Controller.1. |
deactivate", |
"params":{ |
" |
callsign": |
1920
,
"h"
:
1080
"org.rdk.RDKShell"} }' | {"jsonrpc":"2.0", |
"id":3, |
"result":{"success":true}} |
Function | Request | Response | Remarks | ||||
---|---|---|---|---|---|---|---|
get Screen Resolutionlaunch Application |
{ "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 Resolution |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.suspendApplicationsetScreenResolution" , "params" :{ "clientw" : 1920 , "Cobalth" : 1080 }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |||||
resume launch Application | curl '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 Application |
{ "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 response | get Z-Order | |||
resume Application |
{ "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 Clients |
| d
"jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1. | moveToFrontgetClients" , "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-Order | } }client argument should be the exact name of the graphics UI service | Move to Back |
{ "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 Front | curl 'http://127.0.0.1:9998/jsonrpc' -d ' | moveBehind
| WebKitBrowser
| , |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | client argument should be the exact name of the graphics UI service |
Move to Backset Focus | curl 'http://127.0.0.1:9998/jsonrpc' -d ' setFocus WebKitBrowser
| { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |||||
get Boundsmove Behind |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" : { "x" : 0 , "y" : 0 , "w" : 600 , "h" : 400 } } } } | |||||
set Focus |
| set Bounds | curl 'http://127.0.0.1:9998/jsonrpc'
, "x" : 0 , "y" : 0 , "w" : 600 , "h" :
400
| { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |||
get VisibilityBounds |
{ "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" : true 400 } } | |||||
set VisibilityBounds |
{ "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 OpacityVisibility |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.getOpacitygetVisibility" , "params" :{ "client" : "ResidentApp" }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : { "opacityvisible" : 100 true } } | |||||
set OpacityVisibility |
100
| { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |||||
get ScaleOpacity |
{ "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 ScaleOpacity |
{ "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 Scale |
{ "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 Scale |
{ "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
Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions
Function | Request | Response | Remarks | ||
---|---|---|---|---|---|
get Interfaces | curl http://localhost:9998/jsonrpc
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk. | NetworkRDKShell.1. | getInterfaceskill" , "params" :{ "client" : "WebKitBrowser " }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
generate Key |
' | {"jsonrpc":"2.0", "id":3, "result": {} } |
Note: The above functions are referred from the RDK Service's RDK Shell wiki page
Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions
curl http://127.0.0.1:9998/jsonrpc -d '
{
"jsonrpc"
:
"2.0Function | Request | Response | Remarks | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
get Interfaces"interfaces" : [
] } } is Interface Enabled | curl http://localhost:9998/jsonrpc -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1. isInterfaceEnabledgetInterfaces", "params":{ "interface" : "WIFI" }}' |
true } } | Enable Interface |
| 2.0
|
| id
|
|
| persist
| }'
|
| |
is Interface Enabled | set Default Interface
| setDefaultInterface
|
| "
|
|
| |||||||
get Default InterfaceEnable Interface |
|
| |||||||||||
set Default Interfaceget IP for default interface |
|
| |||||||||||
pingget Default Interface |
| endpoint 45.57.221.20
packets
| |||||||||||
get IP for default interface |
:{
}}
|
| |||||||||||
pingget Named Endpoints |
{
3 , "result" :{ "endpoints" :[ "CMTS" ]
| ping to named Endpoint |
| curl http://localhost:9998/jsonrpc -d ' method": "org.rdk.Network.1.pingNamedEndpoint" , "params" :{
}}'
}} | |||||||||
traceget Named Endpoints |
|
}}
| |||||||||||
ping to trace a named Endpoint |
|
}} | |||||||||||
get IP Settingstrace |
|
} }
}} | |||||||||||
trace a named Endpoint | set IP Settings |
|
primarydns
"192.168.1.1"
secondarydns
}} | ||||||||||
get IP Settings |
} } |
Note: The functions are referred from the RDK Service's Network wiki page
Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions
|
|
3
,
|
|
"org.rdk.Wifi.1.getCurrentState"
,
"params"
|
|
|
2
,
"success"
:
true
}}
curl http://127.0.0.1:9998/jsonrpc -d '
{
"jsonrpc"
:
"2
|
|
3
|
:
"org.rdk.Wifi
|
|
"params"
:{
"incremental"
:
false
,
"ssid"
:
""
,
"frequency"
:
""
}}'
{
"jsonrpc"
:
"2.0"
,
"id"
:
3
,
"result"
:{
"success"
:
true
}}
} } | |
set IP Settings |
|
|
|
|
{
|
|
|
|
|
3
,
|
:{
"success
|
}}
curl http://127.0.0.1:9998/jsonrpc -d '
{
"jsonrpc"
:
"2
|
|
3
,
"method"
:
"org.rdk.Wifi.1.setEnabled"
,
"params"
:{
"enable"
:
true
|
} } |
Note: The functions are referred from the RDK Service's Network wiki page
Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions
Function | Request | Response | Remarks | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
get Current State | connect
| connect
| { " | ssidjsonrpc" : " | 1234123412342.0" , " | passphraseid" : 3 , " | foobarresult" | : | { " | jsonrpcstate" : | "2 | .0""result, | " | success" : true }} | |||
start Scan |
| getConnectedSSID
| {}}'
| jsonrpc
|
|
| id"
| TP-LINK 1234
| bssid
| ec:08:6b:ce:09:20"
| { "jsonrpc | " : " | 1442. | 0000000" , " | noiseid" : | 3 , "result" :{ "success" : true }} | incremental can be set to true to get each SSID in different events (mostly used from GUI) |
stop scandisconnect |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "result" : "" , "success" : true }} | |||||||||||||||
initiate pairing through WPSset Enabled |
}' { "jsonrpc" : "2.0"
3 , "result" :
"" , "success" : true }} | cancel WPS pairing |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.Wifi.1.cancelWPSPairing" , "params" :{
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "result" : "" , "success" : true }} | |||||||||||||
save SSIDconnect |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "result" : 0 , "success" : true }} | |||||||||||||||
is Pairedget connected SSID |
|
0 , "success" : true }} | get Paired SSID |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.Wifi.1.getPairedSSID" , "params" :{}}' |
{ "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "ssid" : "123412341234
| ||||||||||||
get Paired SSID Infodisconnect |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "ssidresult" : "123412341234" , "bssid" : "ff:ff:ff:ff:ff:ff, "success" : true }} | |||||||||||||||
clear SSIDinitiate pairing through WPS |
{ "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 pairing |
{ "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 SSID |
{ "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" : 1 0 , "success" : true }} |
Note: The functions are referred from the RDK Service's Wifi wiki page
Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions
is Paired |
| |||||||
Function | Request | Response | Remarks | |||||
---|---|---|---|---|---|---|---|---|
enable | curl --header "Content-Type: application/json" --request POST --data
| "
| "
| Bluetooth
| enable"}' http://127.0.0.1:9998/jsonrpc
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "result" : 0 , "success" : true }} | disable | curl --header "Content-Type: application/json" --request POST --data|
get Paired SSID |
{ "jsonrpc" : "2.0" , "id" : | "3 | ", "method" : "org.rdk. | BluetoothWifi.1. | disable"}' http://127.0.0.1:9998/jsonrpcgetPairedSSID" , "params" :{}}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "ssid" : "123412341234" , "success" : true }}} | ||
get Device NamePaired SSID Info |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "namessid" : "Xfinity Bluetooth Audio" "123412341234" , "bssid" : "ff:ff:ff:ff:ff:ff," success": true }} | ||||||
clear SSID |
| set Device Name | curl --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 enabled |
{ "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 enabled |
{ "jsonrpc" : "2.0" , "id" :" 3 ", "method" : "org.rdk. BluetoothWifi.1. setDiscoverableisSignalThresholdChangeEnabled" , "params" :{ | { "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
Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions
Function | Request | Response | Remarks | ||||
---|---|---|---|---|---|---|---|
enable | curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", | "id":"3", | "method":"org.rdk.Bluetooth.1. | startScan", 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. | stopScandisable"}' http://127.0.0.1:9998/jsonrpc | {"jsonrpc":"2.0","id":3,"result":{"success":true}} | ||
get Discovered DevicesDevice Name |
| { "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 |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | |||||
get Paired Devicesis Discoverable |
| { "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 Discoverable |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | |||||
start Scanconnect |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "status" : "AVAILABLE" , "success" : true }} | |||||
get Connected Devicesstop scan |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | |||||
get Discovered Devices |
|
| |||||
unpairpair | unpair
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | |||||
disconnectget Paired Devices | disconnect", "params" : { "deviceID" : "256168644324480" }}
|
"success" : true }}
| |||||
connect |
| set Audio Stream | curl http://127.0.0.1:9998/jsonrpc setAudioStream audioStreamName PRIMARY"}}' { "jsonrpc
| { "jsonrpc" : "2.0" , "id" 2.0", "id" : 3 , "result" :{ "success" : true }} | |||
get Device InfoConnected Devices |
|
| get Audio Info |
| |||
unpair |
curl
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | |||||
disconnect |
| { "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 Stream | send Audio Playback Command |
{ "jsonrpc" : "2.0"
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | ||||
respond To Eventget Device Info | respondToEvent
, "eventType
|
| |||||
get Audio Info |
: "2.0" , "id" : "3" , "method" : "org.rdk.Bluetooth.1.getAudioInfo" , "params" : { "deviceID" : "256168644324480" }}' |
| |||||
send Audio Playback Command |
{ "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 Event |
{ "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 }} |
...
Function | Request | Response | Remarks | ||
---|---|---|---|---|---|
cacheContains | curl | {"jsonrpc":"2.0","id":3,"result":{"success":true}} | |||
clearLastDeepSleepReason | curl | {"jsonrpc":"2.0","id":3,"result":{"success":true}} | |||
getAvailableStandbyModes | curl | {"jsonrpc":"2.0","id":3,"result":{"supportedStandbyModes":["LIGHT_SLEEP", "DEEP_SLEEP"],"success":true}} | |||
getCachedValue | curl | {"jsonrpc":"2.0","id":3,"result":{"sampleKey":"4343.3434","success":true}} | |||
getCoreTemperature | curl | {"jsonrpc":"2.0","id":3,"result":{"temperature":48.000000,"success":true}} | |||
getDeviceInfo | curl | {"jsonrpc":"2.0","id":3,"result":{"ecm_mac/estb_mac":"AA:BB:CC:DD:EE:FF:GG","success":true}} | |||
getDownloadedFirmwareInfo | curl |
| |||
getFirmwareDownloadPercent | curl | {"jsonrpc":"2.0","id":3,"result":{"downloadPercent":25,"success":true}} | |||
getFirmwareUpdateInfo | curl | {"jsonrpc":"2.0","id":3,"result":{"asyncResponse":true}} | |||
getFirmwareUpdateState | curl | {"jsonrpc":"2.0","id":3,"result":{"firmwareUpdateState":"Download Complete","success":true}} | |||
getLastDeepSleepReason | curl | {"jsonrpc":"2.0","id":3,"result":{"lastDeepSleepReason":"thermal_deepsleep_critical_threshold","success":true}} | |||
getMacAddresses | curl | {"jsonrpc":"2.0","id":3,"result":{"asyncResponse":true,"success":true}} | |||
getMilestones | curl | {"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}} | |||
getMode | curl | {"jsonrpc":"2.0","id":3,"result":{"modeInfo":{"mode":"NORMAL","duration":0},"success":true}} | |||
getModegetPowerState | curl | {"jsonrpc":"2.0","id":3,"result":{"modeInfopowerState":{"mode":"NORMAL","duration":0}ON", "success":true}} | |||
getPowerStategetPreferredStandbyMode | curl | {"jsonrpc":"2.0","id":3,"result":{"powerStatepreferredStandbyMode":"ONDEEP_SLEEP","success":true}} | |||
getPreferredStandbyModegetPreviousRebootInfo | curl curl | {"jsonrpc":"2.0","id":3,"result":{"preferredStandbyModetimeStamp":"20200128083540","reason":"DEEP_SLEEPTriggered from System Plugin API Validation","success":true}} | |||
getPreviousRebootInfogetPreviousRebootInfo2 | curl curl | {"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}} | |||
getPreviousRebootInfo2getPreviousRebootReason | curl | {"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}} | |||
getPreviousRebootReasongetRFCConfig | curl curl | {"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}} | |||
getRFCConfiggetSerialNumber | curl | {"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}} | |||
getStateInfo | curl {"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}} | |||
getSystemVersions | curl | getSerialNumber | curl |
| |
getStateInfogetTemperatureThresholds | curl |
| |||
getSystemVersionsgetTimeZoneDST |
|
| |||
getTemperatureThresholdsgetXconfParams | curl |
| |||
getTimeZoneDSThasRebootBeenRequested |
|
| |||
getXconfParamsisGzEnabled |
|
| |||
hasRebootBeenRequestedqueryMocaStatus |
|
| |||
isGzEnabledreboot |
|
| |||
queryMocaStatusremoveCacheKey |
|
| |||
rebootrequestSystemUptime |
|
| |||
removeCacheKeysetCachedValue |
|
| |||
requestSystemUptimesetDeepSleepTimer |
|
| |||
setCachedValuesetGzEnabled |
|
| |||
setDeepSleepTimerset STB mode |
|
| |||
setGzEnabled |
|
| |||
set STB modesetPreferredStandbyMode |
|
| |||
setGzEnabledsetTemperatureThresholds |
|
| |||
setPreferredStandbyModesetTimeZoneDST |
|
| |||
setTemperatureThresholdsupdateFirmware |
|
| setTimeZoneDST | curl http://localhost:9998/jsonrpc
Note: The functions are referred from the RDK Service's System wiki page
Function | Request | Response | Remarks | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
upgrade | curl --header "Content-Type: application/json" --request POST -- | data '{data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.FirmwareControl.1.upgrade", "params":{"name": "firmware_v.0", " | idlocation": " | 3http://my.site.com/images", " | methodtype": " | org.rdk.System.1.setTimeZoneDSTRCDL", " | paramsprogressinterval": | {10, " | timeZonehmac": " | UTC-52834e6d07fa4c7778ef7a4e394f38a5c321afbed51d54ad512bd3fffbc7aa5debc"}}' http://127.0.0.1:9998/jsonrpc |
|
| {
| |
resume |
| http://localhost:9998/jsonrpc
| header
| data
|
| org.rdk.System
| updateFirmware
| { "jsonrpc": "2.0", "id": | 1234567890, "result": | {null } |
Note: The functions are referred from the RDK Thunder Nano Service's System wiki pageGitHub link
Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions
...