Versions Compared

Key

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

...

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

org.rdk.ScreenCapture

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

FunctionRequestResponseRemarks
upload capture screencurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"com.comcast.ScreenCapture.1.uploadScreenCapture", "params": {"url": "http://server/cgi-bin/upload.cgi"}}http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true}}

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

org.rdk.Timer

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

FunctionRequestResponseRemarks
start Timercurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Timer.1.startTimer", "params":{"interval":1.2, "mode":"WAKE", "repeatInterval":1.4, "remindBefore":0.2}}http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"timerId":0,"success":true}}
cancelcurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Timer.1.cancel", "params":{"timerId":0}}http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true}}
suspendcurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Timer.1.suspend", "params":{"timerId":0}}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true}}
resumecurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Timer.1.resume", "params":{"timerId":0}}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true}}
get Timer Statuscurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Timer.1.getTimerStatus", "params":{"timerId":0}}http://127.0.0.1:9998/jsonrpc{
    "jsonrpc": "2.0",    "id": 3,
    "result": {
        "state": "RUNNING",
        "mode": "WAKE",
        "timeRemaining": "1894.646",
        "repeatInterval": "2000.000",
        "remindBefore": "1000.000",
        "success": true
    }
}

get All Timerscurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Timer.1.getTimers"}' http://127.0.0.1:9998/jsonrpc{   "jsonrpc": "2.0",    "id": 3,
    "result": {
        "timers": [
            {
                "timerId": 0,
                "state": "RUNNING",
                "mode": "WAKE",
                "timeRemaining": "1984.411",
                "repeatInterval": "2000.000",
                "remindBefore": "1000.000"
            }
        ],
        "success": true
    }
}

Note: The functions are referred from the RDK Service's Sleep/Wake Timer wiki page

org.rdk.UserPreferences

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

FunctionRequestResponseRemarks
get UI Languagecurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.UserPreferences.1.getUILanguage"}http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"ui_language":"US_en","success":true}}
set UI Languagecurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.UserPreferences.1.setUILanguage", "params": {"ui_language": "US_en"}}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true}}

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

org.rdk.WareHouse

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

FunctionRequestResponseRemarks
resetDevicecurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Warehouse.1.resetDevice", "params":{"suppressReboot":true}}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"PARAM_SUCCESS":true,"success":true}}
getDeviceInfocurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Warehouse.1.getDeviceInfo"}' http://127.0.0.1:9998/jsonrpc

{"jsonrpc":"2.0","id":3,"result":{"bluetooth_mac":"00:00:00:00:00:00","boxIP":"192.168.0.145","build_type":"PI",

"estb_mac":"B8:27:EB:C5:97:AF","eth_mac":"","imageVersion":"","version":"","software_version":"",

"model_number":"pi","rf4ce_mac":"","wifi_mac":"","success":true}}


internalResetcurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Warehouse.1.internalReset", "params":{"passPhrase":"FOR TEST PURPOSES ONLY2"}}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":false,"error":"incorrect pass phrase"}}
lightResetcurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Warehouse.1.lightReset"}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true}}
isCleancurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Warehouse.1.isClean"}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0","id":3,"result":{"success":true,"files":[],"clean":true}}

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

org.rdk.XCast

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

FunctionRequestResponseRemarks
getAPIVersionNumbercurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"com.comcast.Xcast.1.getApiVersionNumber"}http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0", "id":3, "result":{"version":1, "success":true}}
get Quirkscurl --header "Content-Type: application/json" --request POST --data '{"jsonrpc":"2.0", "id":3, "method":"org.rdk.Xcast.1.getQuirks"}' http://127.0.0.1:9998/jsonrpc{"jsonrpc":"2.0", "id":3, "result":{"quirks":[], "success":true}}

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