{"id":10136,"date":"2022-06-21T09:10:50","date_gmt":"2022-06-21T09:10:50","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/documentation\/rdk_video_documentation\/components\/open-sourced_components\/component_rdkshell\/rdkshell_configuration\/"},"modified":"2025-03-25T05:18:36","modified_gmt":"2025-03-25T05:18:36","slug":"rdkshell_configuration","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/","title":{"rendered":"RDKShell Configuration"},"content":{"rendered":"\n

The complexity of the configuration of RDKShell is increasing. Perhaps the time has come to consider a configuration file. This page suggests a possible format for one and how it would work alongside the current environment variables approach.<\/p>

Environment Variables<\/h2>

Currently RDKShell is configured by a series of environment variables.<\/p>

<\/colgroup>

Name<\/p><\/th>

Type<\/p><\/th>

Default<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

RDKSHELL_CRITICALLY_LOW_MEMORY_THRESHOLD<\/p><\/td>

integer<\/td>
<\/td>		The number of Mb of free memory below which to send a <\/span>critical<\/strong> <\/span>notification to clients.<\/td><\/tr>

RDKSHELL_ENABLE_IPC<\/p><\/td>

Boolean (“0” or “1”)<\/td>false<\/td>
<\/td><\/tr>

RDKSHELL_ENABLE_WS_IPC<\/p><\/td>

Boolean (“0” or “1”)<\/p><\/td>

false<\/td>
<\/td><\/tr>

RDKSHELL_EASTER_EGG_FILE<\/p><\/td>

file path<\/td>
<\/td>
<\/td><\/tr>
RDKSHELL_EXTENDED_INPUT_ENABLED<\/td>Boolean<\/td>false<\/td>Whether the Westeros “rdkshell_extended_input” plugin is loaded.<\/td><\/tr>
RDKSHELL_FRAMERATE<\/td>integer<\/td>
<\/td>		Desired framerate.<\/td><\/tr>
RDKSHELL_INPUT_DEVICES_CONFIG<\/td>file path<\/td>
<\/td>		A JSON file containing input device configuration.<\/td><\/tr>

RDKSHELL_KEY_INITIAL_DELAY<\/p><\/td>

integer<\/td>500<\/td>Initial delay before repeating key in milliseconds.<\/td><\/tr>

RDKSHELL_KEY_REPEAT_INTERVAL<\/p><\/td>

integer<\/td>100<\/td>Interval at which key repeats.<\/td><\/tr>
RDKSHELL_KEYMAP_FILE<\/td>file path<\/td>
<\/td>
<\/td><\/tr>
RDKSHELL_LOG_LEVEL<\/td>

“debug”,<\/p>

“info”,<\/p>

“warn”,<\/p>

“error”,<\/p>

“fatal”<\/p><\/td>


<\/td>		Set the logging level to use.<\/td><\/tr>
RDKSHELL_LOW_MEMORY_THRESHOLD<\/td>integer<\/td>
<\/td>		The number of Mb of free memory below which to send a notification to clients.<\/td><\/tr>

RDKSHELL_SERVER_ADDRESS<\/p><\/td>

network address<\/td>“localhost”<\/td>
<\/td><\/tr>

RDKSHELL_SERVER_PORT<\/p><\/td>

integer<\/td>9996<\/td>
<\/td><\/tr><\/tbody><\/table> <\/div>

Proposed Configuration File<\/h2>

Since JSON has been used for other configuration files in RDKShell then I would suggest JSON again.<\/p>

Currently <\/span>all<\/strong> <\/span>fields will be optional since RDKShell does not require any environment variables to be set.<\/p>

The top-level JSON object has fields:<\/p>

<\/colgroup>

Field<\/p><\/th>

Description<\/p><\/th><\/tr><\/thead>

logging<\/td>Related to logging<\/td><\/tr>
resource_usage<\/td>Related to the resource usage of RDKShell<\/td><\/tr>
input<\/td>Related to inputs handled by RDKShell<\/td><\/tr>
comms<\/td>Related to communication with RDKShell<\/td><\/tr><\/tbody><\/table> <\/div>

where the values associated with all fields are JSON objects.<\/p>

Logging<\/h3>

The logging JSON object would initially only have the following field:<\/p>

<\/colgroup>

Field<\/p><\/th>

Type<\/p><\/th>

Description<\/p><\/th>

Environment Variable<\/p><\/th><\/tr><\/thead>

level<\/td>

“debug”,<\/p>

“info”,<\/p>

“warn”,<\/p>

“error”,<\/p>

“fatal”<\/p><\/td>

The level of logging to use.<\/td>RDKSHELL_LOG_LEVEL<\/td><\/tr><\/tbody><\/table> <\/div>

Resource Usage<\/h3>

The resource usage JSON object would initially have a single field “memory” with an associated JSON object. This JSON object would have the following fields:<\/p>

<\/colgroup>

Field<\/p><\/th>

Type<\/p><\/th>

Description<\/p><\/th>

Environment Variable<\/p><\/th><\/tr><\/thead>

critical_low_threshold<\/td>integer<\/td>Send client critical notifications if this threshold is breached.<\/td>RDKSHELL_CRITICALLY_LOW_MEMORY_THRESHOLD<\/td><\/tr>
low_threshold<\/td>integer<\/td>Send clients notifications if this threshold is breached.<\/td>RDKSHELL_LOW_MEMORY_THRESHOLD<\/td><\/tr><\/tbody><\/table> <\/div>

So the <\/span>path<\/em> <\/span>would be ‘config[\"resource_usage\"][\"memory\"][\"low_threshold\"]<\/code>‘.<\/p>

Input<\/h3>

The input JSON object has the following fields.<\/p>

<\/colgroup>

Field<\/p><\/th>

Type<\/p><\/th>

Description<\/p><\/th>

Environment Variable<\/p><\/th><\/tr><\/thead>

key<\/td>object<\/td>Configuration related to keys.<\/td>
<\/td><\/tr>
device_config<\/td>file path<\/td>A file containing configuration for the device.<\/td>RDKSHELL_INPUT_DEVICES_CONFIG<\/td><\/tr>
easter_egg_file<\/td>file path<\/td>
<\/td>		RDKSHELL_EASTER_EGG_FILE<\/td><\/tr>
plugin<\/td>filename<\/td>An external Westeros plugin to support custom input events.<\/td>~ RDKSHELL_EXTENDED_INPUT_ENABLED<\/em><\/td><\/tr><\/tbody><\/table> <\/div>

where the key JSON object has the following fields.<\/p>

<\/colgroup>

Field<\/p><\/th>

Type<\/p><\/th>

Description<\/p><\/th>

Environment Variable<\/p><\/th><\/tr><\/thead>

initial_delay<\/td>integer<\/td>Initial delay before repeating key in milliseconds.<\/td>RDKSHELL_KEY_INITIAL_DELAY<\/td><\/tr>
repeat interval<\/td>integer<\/td>Interval at which key repeats in milliseconds.<\/td>RDKSHELL_KEY_REPEAT_INTERVAL<\/td><\/tr>
map_file<\/td>file path<\/td>
<\/td>		RDKSHELL_KEYMAP_FILE<\/td><\/tr><\/tbody><\/table> <\/div>

Comms<\/h3>

The communications JSON object would have the following fields:<\/p>

<\/colgroup>

Field<\/p><\/th>

Type<\/p><\/th>

Description<\/p><\/th>

Environment Variable<\/p><\/th><\/tr><\/thead>

enable_ipc<\/td>boolean<\/td>
<\/td>		RDKSHELL_ENABLE_IPC<\/td><\/tr>
enable_ws_ipc<\/td>boolean<\/td>
<\/td>		RDKSHELL_ENABLE_WS_IPC<\/td><\/tr>
server_address<\/td>network address<\/td>
<\/td>		RDKSHELL_SERVER_ADDRESS<\/td><\/tr>
server_port<\/td>integer<\/td>
<\/td>		RDKSHELL_SERVER_PORT<\/td><\/tr><\/tbody><\/table> <\/div>

Example<\/h3>

An example configuration file could be:<\/p>

<\/colgroup>

{<\/code>
    <\/code>\"logging\": {<\/code>
        <\/code>\"level\": \"debug\"<\/code>
    <\/code>},<\/code>
    <\/code>\"resource_usage\": {<\/code>
        <\/code>\"memory\": {<\/code>
            <\/code>\"low_threshold\": 100<\/code>
        <\/code>}<\/code>
    <\/code>},<\/code>
    <\/code>\"input\" : {<\/code>
        <\/code>\"key\" : {<\/code>
            <\/code>\"repeat_interval\": 150,<\/code>
            <\/code>\"map_file\": \"\/etc\/rdkshell\/custom_mapping.conf\"<\/code>
        <\/code>},<\/code>
        <\/code>\"device_config\": \"\/etc\/rdkshell\/xi1_inputdevices.conf\",<\/code>
        <\/code>\"plugin\": \"libwesteros_plugin_rdkshell_extended_input.so<\/a>\"<\/code>
    <\/code>}<\/code>
}<\/code><\/p><\/td><\/tr><\/tbody><\/table> <\/div>

Location<\/h3>

A default location for the configuration file could be a build-time parameter with default locations per OS e.g. “\/etc\/rdkshell\/config.json” for <\/span>UNIX flavour<\/em>. Absence of the configuration file implies defaults are used.<\/p>

Precedence: Environment Variables vs Configuration File<\/h2>

To ensure backwards compatibility supporting both seems sensible. A standard approach is for environment variables to have precedence over the configuration file. Having the configuration printed to log when RDKShell starts will make it easier to see the configuration.<\/p>


<\/p><\/body><\/html>\n","protected":false},"excerpt":{"rendered":"

The complexity of the configuration of RDKShell is increasing. Perhaps the time has come to […]<\/p>\n","protected":false},"author":28,"featured_media":0,"parent":10128,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-10136","page","type-page","status-publish","hentry"],"yoast_head":"\nRDKShell Configuration - RDK Documentation Portal | Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"RDKShell Configuration - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"The complexity of the configuration of RDKShell is increasing. Perhaps the time has come to […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-03-25T05:18:36+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/\",\"name\":\"RDKShell Configuration - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2022-06-21T09:10:50+00:00\",\"dateModified\":\"2025-03-25T05:18:36+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"RDK Entertainment\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Components\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"RDK Services\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"Component: RDKShell\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/\"},{\"@type\":\"ListItem\",\"position\":7,\"name\":\"RDKShell Configuration\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/\",\"name\":\"RDK Documentation Portal | Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"RDKShell Configuration - RDK Documentation Portal | Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/","og_locale":"en_US","og_type":"article","og_title":"RDKShell Configuration - RDK Documentation Portal | Documentation","og_description":"The complexity of the configuration of RDKShell is increasing. Perhaps the time has come to […]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2025-03-25T05:18:36+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/","name":"RDKShell Configuration - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2022-06-21T09:10:50+00:00","dateModified":"2025-03-25T05:18:36+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/rdkshell_configuration\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"RDK Entertainment","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/"},{"@type":"ListItem","position":4,"name":"Components","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/"},{"@type":"ListItem","position":5,"name":"RDK Services","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/"},{"@type":"ListItem","position":6,"name":"Component: RDKShell","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/rdk_services\/component_rdkshell\/"},{"@type":"ListItem","position":7,"name":"RDKShell Configuration"}]},{"@type":"WebSite","@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website","url":"https:\/\/developer.rdkcentral.com\/documentation\/","name":"RDK Documentation Portal | Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10136","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/comments?post=10136"}],"version-history":[{"count":1,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10136\/revisions"}],"predecessor-version":[{"id":10137,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10136\/revisions\/10137"}],"up":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/10128"}],"wp:attachment":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/media?parent=10136"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}