DAB Request | DAB Category | Thunder Implementation for the Request |
---|
operations/list | Supported Operations | No RDK specific implementation required except platform specific key map configuration. |
applications/list | Applications
| https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=getavailabletypes Use the response to match the AppID as per DAB-2.0 spec. [Note: should have YouTube, Amazon & Netflix as types in the API response.] |
applications/launch | https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=getstate https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=launch https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=movetofront https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=setfocus https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=getvisibility https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=setvisibility Note: Implementation supports only YouTube common port. If previous state is suspended; then moveToFront & setFocus rdkshell APIs are called with AppID matching callsign. Please see Provideplatformspecificapplifecycledelays/timeouts for adding platform specific tuning. | applications/launch-with-content | If parameter is present; App specific deeplink API is invoked. https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=launch For YouTube: https://code.rdkcentral.com/r/plugins/gitiles/rdk/components/generic/cobalt/+/refs/heads/24.lts.dev/plugin/doc/CobaltPlugin.md#method.deeplinkmd#deeplink-method Please see Provideplatformspecificapplifecycledelays/timeouts for adding platform specific tuning. |
applications/launch-with-content | https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id= movetofrontgetstate https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=setfocus Note: Implementation supports only YouTube common port. If previous state is suspended; then moveToFront & setFocus rdkshell APIs are called with AppID matching callsign. Please see Provideplatformspecificapplifecycledelays/timeouts for adding platform specific tuning. | applications/get-state | launch https://code.rdkcentral. github.iocom/ rdkservicesr/ #plugins/ api/RDKShellPlugin?id=getstateapplications/exitgitiles/rdk/components/generic/cobalt/+/refs/heads/24.lts.dev/plugin/doc/CobaltPlugin.md#method.deeplink https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id= destroymovetofront https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=suspend Please see Provideplatformspecificapplifecycledelays/timeouts for adding platform specific tuning. | device/info | System
setfocus https://rdkcentral.github.io/rdkservices/#/api/ DisplaySettingsPluginRDKShellPlugin?id= getconnectedvideodisplaysgetvisibility https://rdkcentral.github.io/rdkservices/#/api/ SystemPluginRDKShellPlugin?id= getdeviceinfo [estb_mac is used as DAB Device ID]setvisibility Note: Implementation supports only YouTube common port. If previous state is suspended; then moveToFront & setFocus rdkshell APIs are called with AppID matching callsign. Please see Provideplatformspecificapplifecycledelays/timeouts for adding platform specific tuning. |
applications/get-state | https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id= getscreenresolutiongetstate |
applications/exit | https://rdkcentral.github.io/rdkservices/#/api/ NetworkPluginRDKShellPlugin?id= getinterfacesgetstate https://rdkcentral.github.io/rdkservices/#/api/ DeviceInfoPluginRDKShellPlugin?id= systeminfo [uptime is extracted from this]destroy https://rdkcentral.github.io/rdkservices/#/api/DeviceIdentificationPluginRDKShellPlugin?id=deviceidentificationsuspend Please see Provideplatformspecificapplifecycledelays/timeouts for adding platform specific tuning. |
device/info | System
| https://rdkcentral.github.io/rdkservices/#/api/NetworkPluginDisplaySettingsPlugin?id=getipsettingsgetconnectedvideodisplays https://rdkcentral.github.io/rdkservices/#/api/DeviceInfoPluginSystemPlugin?id=makegetdeviceinfo [estb_mac is used as DAB Device ID] https://rdkcentral.github.io/rdkservices/#/api/DeviceInfoPluginRDKShellPlugin?id=modelidgetscreenresolution https://rdkcentral.github.io/rdkservices/#/api/DeviceInfoPluginNetworkPlugin?id=serialnumbergetinterfaces https://rdkcentral.github.io/rdkservices/#/api/DeviceInfoPlugin?id=firmwareversionsysteminfo [uptime is extracted from this] https://rdkcentral.github.io/rdkservices/#/api/DeviceIdentificationPlugin?id=deviceidentification [chipset is extracted from this] | system/restart | https://rdkcentral.github.io/rdkservices/#/api/ SystemPluginNetworkPlugin?id= rebootsystem/settings/listgetipsettings https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPluginDeviceInfoPlugin?id=getsupportedresolutionsmake https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPluginDeviceInfoPlugin?id=getsupportedaudioportsmodelid https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPluginDeviceInfoPlugin?id=getsupportedaudiomodesserialnumber https://rdkcentral.github.io/rdkservices/#/api/FrameRatePluginDeviceInfoPlugin?id=getdisplayframeratefirmwareversion https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPluginDeviceIdentificationPlugin?id=getsettophdrsupportdeviceidentification [chipset is extracted from this] |
system/restart | https://rdkcentral.github.io/rdkservices/#/api/ DisplaySettingsPluginSystemPlugin?id= gettvhdrsupportMEMC: false LowLatencyMode: true as its being enabled by the pipeline property. No plugin exposed APIs available. VideoInputSource : Home (STB's playback source is its app itself.) PictureMode: None (not an STB feature) reboot |
system/settings/getlist
| https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getsupportedresolutions https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getsupportedaudioports https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getsupportedaudiomodes https://rdkcentral.github.io/rdkservices/#/api/HdmiCec_2Plugin?FrameRatePlugin?id=getenabledgetdisplayframerate https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getsoundmodegetsettophdrsupport https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getmutedgettvhdrsupport https://rdkcentral.github.io/rdkservices/#/api/FrameRatePluginTextToSpeechPlugin?id=getdisplayframerateisttsenabled CEC: checks availability of https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getconnectedvideodisplays https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=getsettophdrsupport https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=gettvhdrsupportHdmiCec_2Plugin MEMC: false LowLatencyMode: true as its being enabled by the pipeline property. No plugin exposed APIs available. VideoInputSource : Home (STB's playback source is its app itself.) PictureMode: None (not an STB feature) |
system/settings/get | https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPluginDisplayInfoPlugin?id=getconnectedaudioportswidth https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPluginDisplayInfoPlugin?id=getvolumelevelheight https://rdkcentral.github.io/rdkservices/#/api/TextToSpeechPluginDisplayInfoPlugin?id=isttsenabledframerate Note: expecting response as "Framerate60" instead of "FRAMERATE_60" as per component owner review. Documentation needs updation. https:https://rdkcentral.github.io/rdkservices/#/api/UserPreferencesPluginDisplaySettingsPlugin?id=getuilanguage system/settings/setgetsupportedresolutions https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setcurrentresolutiongetsupportedaudioports https://rdkcentral.github.io/rdkservices/#/api/FrameRatePluginDisplaySettingsPlugin?id=setdisplayframerategetsupportedaudiomodes https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPluginHdmiCec_2Plugin?id=setvolumelevelgetenabled https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setmutedgetsoundmode https://rdkcentral.github.io/rdkservices/#/api/HdmiCec_2PluginDisplaySettingsPlugin?id=setenabledgetmuted https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setenableaudioportgetconnectedvideodisplays https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setforcehdrmodegetsettophdrsupport https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setsoundmodegettvhdrsupport https://rdkcentral.github.io/rdkservices/#/api/TextToSpeechPluginDisplaySettingsPlugin?id=enablettsgetconnectedaudioports https://rdkcentral.github.io/rdkservices/#/api/UserPreferencesPluginDisplaySettingsPlugin?id=setuilanguagegetvolumelevel PictureMode: not implemented (not an STB feature) VideoInputSource : not implemented due to lack of device capability. https://rdkcentral.github.io/rdkservices/#/api/TextToSpeechPlugin?id=isttsenabled https://rdkcentral.github.io/rdkservices/#/api/UserPreferencesPlugin?id=getuilanguage |
system/settings/set | input/key/list
| Input
Platform configurable key map /opt/dab_platform_keymap.json. Please see Provideplatformkeymapconfiguration | input/key-press | https://rdkcentral.github.io/rdkservices/#/api/ RDKShellPluginDisplaySettingsPlugin?id= injectkeygetconnectedvideodisplays [Note: injectKey will not be overridden by the rdkshell_keymapping.json so put the final KEYCODE in /opt/dab_platform_keymap.json] input/long-key-presshttps://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setcurrentresolution https://rdkcentral.github.io/rdkservices/#/api/RDKShellPluginDisplaySettingsPlugin?id=injectkeygetconnectedaudioports [Note: injectKey will not be overridden by the rdkshell_keymapping.json so put the final KEYCODE in /opt/dab_platform_keymap.json] https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setvolumelevel https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setmuted https://rdkcentral.github.io/rdkservices/#/api/HdmiCec_2Plugin?id=setenabled https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setenableaudioport https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setforcehdrmode https://rdkcentral.github.io/rdkservices/#/api/DisplaySettingsPlugin?id=setsoundmode https://rdkcentral.github.io/rdkservices/#/api/TextToSpeechPlugin?id=enabletts https://rdkcentral.github.io/rdkservices/#/api/UserPreferencesPlugin?id=setuilanguage PictureMode: not implemented (not an STB feature) VideoInputSource : not implemented due to lack of device capability. |
input/key/list
| Input
| Platform configurable key map /opt/dab_platform_keymap.json. Please see Provideplatformkeymapconfiguration |
input/key-press | https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=injectkey [Note: injectKey will not be overridden by the rdkshell_keymapping.json so put the final KEYCODE in /opt/dab_platform_keymap.json] |
input/long-key-press | https://rdkcentral.github.io/rdkservices/#/api/RDKShellPlugin?id=injectkey [Note: injectKey will not be overridden by the rdkshell_keymapping.json so put the final KEYCODE in /opt/dab_platform_keymap.json] |
output/image | Output | https://rdkcentral.github.io/rdkservices/#/api/ScreenCapturePlugin?id=uploadscreencapture |
device-telemetry/start | Device & Application Telemetry
| As per DAB-2.0 specifiction; it is an optional requirement. TBD: Funtionality not tested. |
device-telemetry/stop | As per DAB-2.0 specifiction; it is an optional requirement. TBD: Funtionality not tested. |
device-telemetry/metrics | output/image | Output | As per DAB-2.0 specifiction; it is an optional requirement.
| https://rdkcentral.github.io/rdkservices/#/api/ ScreenCapturePluginDeviceInfoPlugin?id= uploadscreencapture | device-telemetry/start | Device & Application Telemetry
TBD: Funtionality not tested. |
device-telemetry/stop | TBD: Funtionality not tested. |
systeminfo [totalram, freeram & cpuload is used] |
app-telemetry/start | As per DAB-2.0 specifiction; it is an optional requirement. | device-telemetry/metrics | TBD: Funtionality not tested. |
app-telemetry/start | TBD: Funtionality not tested. | stop | As per DAB-2.0 specifiction; it is an optional requirement. | app-telemetry/stop | TBD: Funtionality not tested. |
app-telemetry/metrics | TBD: As per DAB-2.0 specifiction; it is an optional requirement. Funtionality not testedimplemented. |
health-check/get | Health Check | No RDK specific implementation required. |
messages | Operational General Notifications | As per DAB-2.0 specifiction; it is an optional requirement. No RDK specific implementation required TBD: Funtionality not tested. |
voice/list | Voice
| https://rdkcentral.github.io/rdkservices/#/api/VoiceControlPlugin?id=voicestatus |
| https://rdkcentral.github.io/rdkservices/#/api/VoiceControlPlugin?id=configurevoice with following parameter in the current implementation. Code Block |
---|
| {"enable":false, "ptt":{"enable":false}} |
|
voice/send-audio | |
voice/send-text | To convert the audio to platform compatible format; gst-launch-1.0 binary is required. https://rdkcentral.github.io/rdkservices/#/api/VoiceControlPlugin?id=voicesessionrequest Code Block |
---|
| {"audio_file":"/tmp/tts.wav","type":"ptt_audio_file"} |
|
version | Version | No RDK specific implementation required. |
For generating DAB Device ID | Generic | https://rdkcentral.github.io/rdkservices/#/api/SystemPlugin?id=getdeviceinfo with param estb_mac |
For feature/service availability | Generic | https://github.com/rdkcentral/Thunder/blob/master/Source/WPEFramework/doc/ControllerPlugin.md#method.activate https://github.com/rdkcentral/Thunder/blob/master/Source/WPEFramework/doc/ControllerPlugin.md#method.deactivate https://github.com/rdkcentral/Thunder/blob/master/Source/WPEFramework/doc/ControllerPlugin.md#property.services [Used as 'status@callsign'] |