RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
...
Function | Request | Response | Remarks |
---|---|---|---|
get Screen Resolution |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.getScreenResolution" , "params" :{ }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : { "w" : 1920 , "h" : 1080 } } | |
set Screen Resolution |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.setScreenResolution" , "params" :{ "w" : 1920 , "h" : 1080 }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
launch Application |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.launchApplication" , "params" :{ "client" : "appName" , "uri" : "testapp" , "mimeType" : "application/native" }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
suspend Application |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.suspendApplication" , "params" :{ "client" : "Cobalt" }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
resume Application |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.resumeApplication" , "params" :{ "client" : "Cobalt" }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
get Clients |
"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-Order |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.getZOrder" , "params" :{ }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : { "clients" : [ "ResidentApp" , "org.rdk.RDKBrowser2" ]} } | |
Move to Front | curl 'http://127.0.0.1:9998/jsonrpc' -d ' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | client argument should be the exact name of the graphics UI service |
Move to Back | curl 'http://127.0.0.1:9998/jsonrpc' -d ' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
move Behind |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
set Focus |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
get Bounds |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.getBounds" , "params" :{ "client" : "ResidentApp" }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : { "x" : 0 , "y" : 0 , "w" : 600 , "h" : 400 } } | |
set Bounds |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.setBounds" , "params" :{ "client" : "WebKitBrowser" , "x" : 0 , "y" : 0 , "w" : 600 , "h" : 400 }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
get Visibility |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.getVisibility" , "params" :{ "client" : "ResidentApp" }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : { "visible" : true } } | |
set Visibility |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
get Opacity |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.getOpacity" , "params" :{ "client" : "ResidentApp" }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : { "opacity" : 100 } } | |
set Opacity |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.setOpacity" , "params" :{ "client" : "ResidentApp" , "opacity" : 100 }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
get Scale |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.getScale" , "params" :{ "client" : "ResidentApp" }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : { "sx" : 1.5 , "sy" : 1.5 } } | |
set Scale |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.setScale" , "params" :{ "client" : "ResidentApp" , "sx" : 1.5 , "sy" : 1.5 }}' | { "jsonrpc" : "2.0" , "id" : 3 , "result" : {} } | |
kill |
{ "jsonrpc" : "2.0" , "id" : 3 , "method" : "org.rdk.RDKShell.1.kill" , "params" :{ "client" : "WebKitBrowser " }}' | { "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
generate Key | |||||||||||
Function | Request | Response | Remarks | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
get Interfaces | curl
|
| localhost
| Network
| getInterfaces
' | {"jsonrpc":"2.0", | "id":3, | "result": { | is Interface Enabled | curl http://localhost} } |
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 -d '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Network.1.getInterfaces", "params":{}}' |
| |
is Interface Enabled |
|
| |
Enable Interface |
|
| |
set Default Interface |
|
| |
get Default Interface |
|
| |
get IP for default interface |
|
| |
ping |
|
}} | |
get Named Endpoints |
|
| |
ping to named Endpoint |
|
}} | |
trace |
|
}} | |
trace a named Endpoint |
|
}} | |
get IP Settings |
|
} } | |
set 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
Function | Request | Response | Remarks |
---|---|---|---|
get Current State |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" : { "state" : 2 , "success" : true }} | |
start Scan |
| { "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 scan |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | |
get connected SSID |
|
|
|
:{
"interface"
:
"WIFI"
|
|
|
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
Function | Request | Response | Remarks |
---|---|---|---|
enable | curl --header "Content-Type: application/json" --request POST --data |
curl http://localhost:9998/jsonrpc -d '{
"jsonrpc"
:
"2.0"
,
"id"
:
3
,
"method"
:
"org.rdk.Network.1.setInterfaceEnabled"
,
"params"
:{
"interface"
:
"WIFI"
,
"enabled"
:
true
,
"persist"
:
true
}}'
{
"jsonrpc"
:
"2.0"
,
"id"
:
3
,
"result"
:
0
}
'{"jsonrpc":"2.0", |
"id":"3", |
"method":"org.rdk. |
Bluetooth.1. |
enable" |
,
"params"
:{
"interface"
:
"WIFI"
,
"persist"
:
true
}}'
}' 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" |
,
"params"
:{}}'
}' http://127.0.0.1:9998/jsonrpc | {"jsonrpc":"2.0", |
"id":3, |
"result":{" |
success": |
"WIFI"
true}} | |
get |
Device Name |
|
|
|
|
,
"params"
:{}}'
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ " |
name" : " |
Xfinity Bluetooth Audio" , "success" : true }} |
set Device Name |
|
|
|
|
|
"packets"
:
10
}}'
|
"45.57.221.20"
,
| { "jsonrpc" : "2.0" , |
"id" : 3 , |
"result" :{ |
"target"
:
"173.194.123.7"
,
"success" |
: |
true |
,
"packetsTransmitted"
:
10
,
"packetsReceived"
:
10
,
}} | |
is Discoverable |
|
"packetLoss"
:
"0
|
|
|
|
|
|
|
|
|
"130.397"
,
"tripMax"
:
"230.832"
,
"tripStdDev"
:
"80.919"
,
"error"
:
null
}}
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "discoverable" : false , "success" : true }} | |
set Discoverable |
|
|
|
|
|
| { "jsonrpc" : "2.0" , |
"id" : 3 , |
"result" :{ " |
success" : |
"CMTS"
true }} |
start Scan |
|
|
|
|
|
|
|
|
|
10
| { "jsonrpc" : "2.0" , |
"id" : 3 , |
"result" :{ |
" |
status" |
: |
"AVAILABLE" , |
"success" |
: |
true |
,
"packetsTransmitted"
:
10
,
"packetsReceived"
:
10
,
}} | |
stop scan |
|
"packetLoss"
:
"0
|
|
|
|
|
|
|
|
|
"130.397"
,
"tripMax"
:
"230.832"
,
"tripStdDev"
:
"80.919"
,
"error"
:
null
}}
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | |
get Discovered Devices |
|
|
|
|
,
"params"
:{
|
|
|
|
|
10
}}'
{
"jsonrpc"
:
"2.0"
,
"id"
:
3
,
"result"
:{
"target"
:
"173.194.123.7"
,
"success"
:
true
,
"error"
:
null
,
"results"
:
"<<<traceroute command results>>>"
}}
| |
pair |
|
|
|
|
|
|
,
"endpointName"
:
"CMTS"
,
"packets"
:
10
}}'
| { "jsonrpc" : "2.0" , |
"id" : 3 , |
"target"
:
"result" :{ |
" |
,
"success" |
: |
true |
,
"error"
:
null
,
"results"
:
"<<<traceroute command results>>>"
}} | |
get |
Paired Devices |
|
|
|
|
,
"params"
:{
"interface"
:
"wlan0"
}}'
{
|
|
"id"
:
3
,
"result"
:{
|
|
"wifi"
|
|
|
|
|
true
,
"ipaddr"
: “
192.168
.
1.101
",
"netmask
|
|
|
|
|
|
|
|
|
|
""
|
curl http://localhost:9998/jsonrpc -d '{
"jsonrpc"
:
"2.0"
,
"id"
:
3
,
"method"
:
"org.rdk.Network.1.setIPSettings"
,
"params"
:{
"interface"
:
"wifi"
,
"ipversion"
:
"IPv4"
,
"autoconfig"
:
true
,
"ipaddr"
: “
192.168
.
1.101
",
"netmask"
:
"255.255.255.0"
,
"gateway"
:
"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
Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions
| |||||||||||||
connect |
| ||||||||||||
Function | Request | Response | Remarks | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
get Current State | curl http
| -d { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | |||||||||||
get Connected Devices |
| .Wifi.1.getCurrentState"
|
| ||||||||||
unpair |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" : { "state" : 2 , "success" : true }} | start Scan | curl http://127.0.0.1:9998/jsonrpc -d
| Wifi
| startScan
| incremental
|
| ssid"
| { "jsonrpc" : "2.0" , | "id" : 3 , | "result" :{ "success" : true }} | |
disconnect |
| incremental can be set to true to get each SSID in different events (mostly used from GUI) | stop scan |
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | ||||||||
set Audio Stream |
| get connected SSID |
"ssid" : "TP-LINK 1234" , "bssid" : "ec:08:6b:ce:09:20" , "rate" : "144.000000" , "noise" : "-121.000000" ,
|
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
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | ||||||
get Device Info |
| ||||||
Function | Request | Response | Remarks | ||||
---|---|---|---|---|---|---|---|
enable | curl
| enable
| }' http://127.0.0.1:9998/jsonrpc{
|
| ","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"}'
| |
get Audio Info |
| :9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true}} | get Device Name | curl data
: "2.0" , "id" : "3" , "method" : "org.rdk.Bluetooth.1. getNamegetAudioInfo" }' http://127.0.0.1:9998/jsonrpc, "params" : { "deviceID" : "256168644324480" }}' | {
"name" : "Xfinity Bluetooth Audio" ,
| ||
send Audio Playback Command |
| set Device Name | curl
{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.Bluetooth.1. setNamesendAudioPlaybackCommand" , "params" : { "name"deviceID" : "256168644324480" , "command" : " RDK Bluetooth DevicePLAY" }}' http://127.0.0.1:9998/jsonrpc | { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "success" : true }} | is Discoverable | ||
respond To Event | curl
{ "jsonrpc" : "2.0" , "id" : "3" , "method" : "org.rdk.Bluetooth.1. isDiscoverable"}' http://127.0.0.1:9998/jsonrpcrespondToEvent" , "params" : { "deviceID" : "256168644324480" , "eventType" : "onPairingRequest" , "responseValue" : "ACCEPTED" }}
| { "jsonrpc" : "2.0" , "id" : 3 , "result" :{ "discoverable" : false , "success" : true }} |
Note: The functions are referred from the RDK Service's Bluetooth 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 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
getConnectedVideoDisplays | curl | set Discoverable | curl--header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", | "id": | "3 | ", | "method":"org.rdk. | Bluetooth.1.setDiscoverable", DisplaySettings.1.getConnectedVideoDisplays"}' | {"jsonrpc":"2.0","id":3,"result":{"connectedVideoDisplays":["HDMI0"],"success":true}} | start Scan | |
getConnectedAudioPorts | curl curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. startScan", "params" : {"timeout" : "5" , "profile" : "DEFAULT" }}' http://127.0.0.1:9998/jsonrpcgetConnectedAudioPorts"}' | {"jsonrpc":"2.0","id":3,"result":{" statusconnectedAudioPorts":[" AVAILABLEHDMI0"],"success":true}} | |||||||||
stop scangetSupportedResolutions | curl "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1 .stopScan.getSupportedResolutions", "params":{"videoDisplay":"HDMI0"} ' http://127.0.0.1:9998/jsonrpc}' | {"jsonrpc":"2.0","id":3,"result":{"supportedResolutions":["720p","1080i","1080p60"],"success":true}} | |||||||||
getSupportedVideoDisplays | curl | get Discovered Devices | curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. getDiscoveredDevicesgetSupportedVideoDisplays"}' 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 } ], "success" : true } } "jsonrpc":"2.0","id":3,"result":{"supportedVideoDisplays":["HDMI0"],"success":true}} | |||||||
getSupportedTvResolutions | curl | pair | curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. pairgetSupportedTvResolutions", "params":{" deviceIDvideoDisplay": " 256168644324480HDMI0"}}' http://127.0.0.1:9998/jsonrpc | {"jsonrpc":"2.0","id":3,"result":{"supportedTvResolutions":["480i","480p","576i","576p","720p","1080i","1080p"],"success":true}} | |||||||
get Paired DevicesgetSupportedSettopResolutions | curl "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. getPairedDevicesgetSupportedSettopResolutions"}' http://127.0.0.1:9998/jsonrpc |
{ "deviceID" : "256168644324480" , "name" : "Eleven" , "deviceType" : "SMARTPHONE" , "connected" : true }, { "deviceID" : "26499258260618" , "name" : "Little Big" , "deviceType" : "SMARTPHONE" , "connected" : false } ], "success" : true } }
| |||||||||
getSupportedAudioPorts | curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getSupportedAudioPorts"}' | {"jsonrpc":"2.0","id":3,"result":{"supportedAudioPorts":["HDMI0"],"success":true}} | |||||||||
getSupportedAudioModes | curl | connect | curl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. connectgetSupportedAudioModes", "params":{" deviceIDaudioPort": "256168644324480" , "deviceType" : "SMARTPHONE" , "profile" : "SMARTPHONE"HDMI0"}}' http://127.0.0.1:9998/jsonrpc | {"jsonrpc":"2.0","id":3,"result":{"supportedAudioModes":["STEREO","AUTO (Stereo)"],"success":true}} | |||||||
get Connected DevicesgetZoomSetting | curl "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. getConnectedDevicesgetZoomSetting"}' http://127.0.0.1:9998/jsonrpc | { "jsonrpc": "2.0", "id": 3, "result":{ " connectedDevices": [ { "deviceID" : "256168644324480" , "name" : "Eleven" , "deviceType" : "SMARTPHONE" , "activeState" : "0" } ], zoomSetting":"FULL","success": true } } | |||||||||
unpairsetZoomSetting | curl "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. unpairsetZoomSetting", "params":{" deviceIDzoomSetting": " 256168644324480FULL"}}' http://127.0.0.1:9998/jsonrpc | {"jsonrpc":"2.0", "id":3, "result":{"success":true}} | |||||||||
disconnectgetCurrentResolution | curl '{"jsonrpc":"2.0", "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. disconnectgetCurrentResolution", "params":{" deviceIDvideoDisplay": " 256168644324480HDMI0"}}' http://127.0.0.1:9998/jsonrpc | {"jsonrpc":"2.0","id":3,"result":{"resolution":"720p","success":true}} | |||||||||
set Audio StreamsetCurrentResolution | curl "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. setAudioStreamsetCurrentResolution", "params":{" deviceIDvideoDisplay": " 256168644324480HDMI0", " audioStreamNameresolution": "PRIMARY" "720p", "persist":true}}' | {"jsonrpc":"2.0","id":3,"result":{"success":true}} | |||||||||
get Device InfogetSoundMode | curl "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. getDeviceInfogetSoundMode", "params":{" deviceIDaudioPort":" 256168644324480"}}' |
| get Audio Info | HDMI0"}}' | {"jsonrpc":"2.0","id":3,"result":{"soundMode":"STEREO","success":true}} | ||||||
setSoundMode | curl curl "id": "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. getAudioInfosetSoundMode", "params":{" deviceIDaudioPort":"HDMI0", "soundMode": "256168644324480" "stereo", "persist":true}}' | { "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 } } "success":true}} | |||||||||
readEDID | curl | {"jsonrpc":"2.0","id":3,"result":{"EDID":"AP///////wAQrMLQVEJTMQUdAQOA...","success":true}} | |||||||||
readHostEDID | send Audio Playback Command | curl curl "id" : "3" , "method" : "org.rdk.Bluetooth.1.sendAudioPlaybackCommand" , "params" : { "deviceID" : "256168644324480" , "command" : "PLAY" }}"id":3, "method":"org.rdk.DisplaySettings.1.readHostEDID"}' | {"jsonrpc":"2.0","id":3,"result":{"EDID":"AP///////wAIbSV0Z0UjARgYAQOAgEh...","success":true}} | ||||||||
respond To EventgetActiveInput | curl "3 ", "method":"org.rdk. BluetoothDisplaySettings.1. respondToEventgetActiveInput", "params":{" deviceIDvideoDisplay": " 256168644324480", "eventType" : "onPairingRequest" , "responseValue" : "ACCEPTED" HDMI0"}}' | {"jsonrpc":"2.0","id":3,"result":{"activeInput":false,"success":true}} |
Note: The functions are referred from the RDK Service's Bluetooth wiki page
Prerequisite: This service has to be enabled from the controller UI to proceed for the checking of its functions
getTvHDRSupport | ||||||
Function | Request | Response | Remarks | |||
---|---|---|---|---|---|---|
curl | getConnectedVideoDisplaysgetTvHDRSupport"}' | {"jsonrpc":"2.0","id":3,"result":{" | connectedVideoDisplayssupportsHDR":false,"standards":[" | HDMI0none"],"success":true}} | ||
getConnectedAudioPortsgetSettopHDRSupport | curl curl | {"jsonrpc":"2.0","id":3,"result":{"connectedAudioPortssupportedSettopResolutions":["HDMI0"720p","1080i","1080p60","2160p30","2160p60"],"success":true}} | ||||
getSupportedResolutionssetVideoPortStatusInStandby | curl | {"jsonrpc":"2.0","id":3,"result":{"supportedResolutions":["720p","1080i","1080p60"],"success":true}} | ||||
getSupportedVideoDisplaysgetVideoPortStatusInStandby | curl curl | {"jsonrpc":"2.0","id":3,"result":{"supportedVideoDisplaysvideoPortStatusInStandby":["HDMI0"]false,"success":true}} | ||||
getSupportedTvResolutionsgetCurrentOutputSettings | curl curl | {"jsonrpc":"2.0","id":3,"result":{"supportedTvResolutions":["480i","480p","576i","576p","720p","1080i","1080p"]":{"colorSpace":5,"colorDepth":0,"matrixCoefficients":0,"videoEOTF":0,"success":true}} | ||||
getSupportedSettopResolutionssetVolumeLeveller | curl {"jsonrpc":"2.0"setVolumeLeveller", " idparams": 3,"result":{" supportedSettopResolutionsaudioPort": [" 480pSPEAKER0"," 576p50level" ,:"9"}}' | {"jsonrpc":"2.0","id":3,"result":{ 720p","720p50","1080i","1080p","1080i50","1080p50","1080p24","1080p25","1080p30"],"success":true}} | ||||
getSupportedAudioPortsgetVolumeLeveller | curl | {"jsonrpc":"2.0","id":3,"result":{"supportedAudioPortsenable":[true,"HDMI0level"]:9,"success":true}} | ||||
getSupportedAudioModessetBassEnhancer | curl | {"jsonrpc":"2.0","id":3,"result":{"supportedAudioModes":["STEREO","AUTO (Stereo)"],"success":true}} | ||||
getZoomSettinggetBassEnhancer | curl | {"jsonrpc":"2.0","id":3,"result":{"zoomSettingbassEnhancerEnable":"FULL"true,"success":true}} | ||||
setZoomSettingsetSurroundVirtualizer | curl | {"jsonrpc":"2.0","id":3,"result":{"success":true}} | ||||
getCurrentResolutiongetSurroundVirtualizer | curl | {"jsonrpc":"2.0","id":3,"result":{"resolutionenable":true,"720pboost":90,"success":true}} | ||||
setCurrentResolutionenableSurroundDecoder | curl | {"jsonrpc":"2.0","id":3,"result":{"success":true}} | ||||
getSoundModeisSurroundDecoderEnabled | curl | {"jsonrpc":"2.0","id":3,"result":{"soundMode":"STEREO"surroundDecoderEnable":true,"success":true}} | ||||
setSoundModesetDRCMode | curl | {"jsonrpc":"2.0","id":3,"result":{"success":true}} | ||||
readEDIDgetDRCMode | curl | {"jsonrpc":"2.0","id":3,"result":{"EDIDDRCMode":"AP///////wAQrMLQVEJTMQUdAQOA...line","success":true}} | ||||
readHostEDIDsetVolumeLevel | curl | {"jsonrpc":"2.0","id":3,"result":{"EDID":"AP///////wAIbSV0Z0UjARgYAQOAgEh...","success":true}} | ||||
getActiveInputgetVolumeLevel | curl | {"jsonrpc":"2.0","id":3,"result":{"activeInputenable":true,"volumeLevel":false50,"success":true}} | ||||
getTvHDRSupportsetMuted | curl | {"jsonrpc":"2.0","id":3,"result":{"supportsHDR":false,"standards":["none"],"success":true}} | ||||
getSettopHDRSupportgetMuted | curl | {"jsonrpc":"2.0","id":3,"result":{"supportedSettopResolutionsmuted":["720p","1080i","1080p60","2160p30","2160p60"],"true,"success":true}} | ||||
setVideoPortStatusInStandbygetAudioDelay | curl | {"jsonrpc":"2.0","id":3,"result":{"audioDelay":"0","success":true}} | ||||
getVideoPortStatusInStandbysetAudioDelay | curl | {"jsonrpc":"2.0","id":3,"result":{"videoPortStatusInStandby":false,"success":true}} | ||||
getCurrentOutputSettingsgetAudioDelayOffset | curl | {"jsonrpc":"2.0","id":3,"result":{"colorSpace":5,"colorDepth":0,"matrixCoefficientsresult":0,{"videoEOTFaudioDelayOffset":"0","success":true}} | ||||
setVolumeLevellersetAudioDelayOffset | curl | {"jsonrpc":"2.0","id":3,"result":{"success":true}} | ||||
getVolumeLevellergetSinkAtmosCapability | curl | {"jsonrpc":"2.0","id":3,"result":{"enableatmos_capability":true,"level":92,"success":true}} | ||||
setBassEnhancersetAudioAtmosOutputMode | curl | {"jsonrpc":"2.0","id":3,"result":{"success":true}} | ||||
getBassEnhancergetTVHDRCapabilities | curl | {"jsonrpc":"2.0","id":3,"result":{"bassEnhancerEnablecapabilities":true3,"success":true}} setSurroundVirtualizer | ||||
getDefaultResolution | curl | setSurroundVirtualizer", "params":{"audioPort":"SPEAKER0","boost":"90"}}getDefaultResolution"}' | {"jsonrpc":"2.0","id":3,"result":{"defaultResolution":"720p","success":true}} | |||
getSurroundVirtualizersetScartParameter | curl | {"jsonrpc":"2.0","id":3,"result":{"enable":true,"boost":90,"success":truefalse}} | enableSurroundDecoder | curl
Note: The functions are referred from the RDK Service's Display Settings 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 |
---|---|---|---|
curl --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}} |
curl |
http://127.0.0.1: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}} |
curl |
http://127.0.0.1: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}} |
curl |
http://127.0.0.1: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}} |
curl |
http://127.0.0.1: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}} |
curl |
http://127.0.0.1:9998/jsonrpc
--header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0","id":"3","method":"org.rdk. |
System.1. |
getDeviceInfo","params":{" |
param":[" |
estb_mac"]}}' | {"jsonrpc":"2.0","id":3,"result":{" |
ecm_mac/estb_mac": |
"AA:BB:CC:DD:EE:FF:GG","success":true}} |
curl |
http://127.0.0.1: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}} |
curl |
http://127.0.0.1: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}} |
curl |
http://127.0.0.1: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": |
http://127.0.0.1:9998/jsonrpc
true}} | |
curl --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}} |
curl |
http://127.0.0.1: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}} |
curl |
http://127.0.0.1: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 |
http://127.0.0.1:9998/jsonrpc
,"success":true}} | |
curl --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":{" |
curl http://127.0.0.1:9998/jsonrpc
--header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.setAudioAtmosOutputMode", "params":{"enable":true}}'
{"jsonrpc":"2.0","id":3,"result":{"success":true}}
curl http://127.0.0.1:9998/jsonrpc
--header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getTVHDRCapabilities"}'
{"jsonrpc":"2.0","id":3,"result":{"capabilities":3,"success":true}}
curl http://127.0.0.1:9998/jsonrpc
--header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.DisplaySettings.1.getDefaultResolution"}'
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."],"success":true}} |
curl |
http://127.0.0.1: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":"<string>","duration":<int>},"success": |
<bool>}} |
Note: The functions are referred from the RDK Service's System wiki page
...