From a0a49ca6450ffb10037d674bcf11e3cb6476a36a Mon Sep 17 00:00:00 2001 From: hgfell683 <107510770+hgfell683@users.noreply.github.com> Date: Mon, 9 Dec 2024 14:02:40 -0500 Subject: [PATCH 1/7] DELIA-66702: Documentation update Reason for change: Documentation Update Test Procedure: Risks: low Priority: P1 Signed-off-by:Hayden Gfeller --- DisplaySettings/DisplaySettings.json | 12 ++-- SystemServices/System.json | 82 +++++++++++++++++----------- 2 files changed, 56 insertions(+), 38 deletions(-) diff --git a/DisplaySettings/DisplaySettings.json b/DisplaySettings/DisplaySettings.json index d497d1b877..d31760e699 100644 --- a/DisplaySettings/DisplaySettings.json +++ b/DisplaySettings/DisplaySettings.json @@ -28,7 +28,7 @@ "type": "array", "items": { "type": "string", - "example": "`SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`" + "example": "`NONE`, `SDR`, `HDR10`, `HDR10PLUS`, `HLG`, `DV`, `Technicolor Prime`" } }, "currentAudioFormat": { @@ -2073,17 +2073,17 @@ } }, "setForceHDRMode": { - "summary": "Enables or disables the force HDR mode. If enabled, the HDR format that is currently configured on the device is used.", + "summary": " This API force the output HDR video format passed as input arumgents. If force output video format is set as "NONE" or this API not called video format changes as per input video format type", "params": { "type": "object", "properties": { "hdr_mode": { - "summary": "`true` to force the HDR format or `false` to reset the mode to the default.", - "type": "boolean", - "example": true + "$ref": "#/definitions/supportedVideoFormat" } }, - "required": [] + "required": [ + "hdr_mode" + ] }, "result": { "$ref": "#/common/result" diff --git a/SystemServices/System.json b/SystemServices/System.json index d481b0c5a7..1be538988c 100644 --- a/SystemServices/System.json +++ b/SystemServices/System.json @@ -1945,6 +1945,46 @@ ] } }, + "setFSRFlag":{ + "summary": "Set the FSR flag into the emmc raw area. This API will fail if you attempt to set the same value.", + "result": { + "type": "object", + "properties": { + "fsrFlag": { + "summary": "FSR flag", + "type": "boolean", + "example": true + }, + "success":{ + "$ref": "#/common/success" + } + }, + "required": [ + "fsrFlag", + "success" + ] + } + }, + "getFSRFlag":{ + "summary": "Get the FSR flag from the emmc raw area.", + "result": { + "type": "object", + "properties": { + "fsrFlag": { + "summary": "FSR flag.", + "type": "boolean", + "example": true + }, + "success":{ + "$ref": "#/common/success" + } + }, + "required": [ + "fsrFlag", + "success" + ] + } + }, "setPrivacyMode": { "summary": "Setting Privacy Mode.", "events": { @@ -2394,43 +2434,21 @@ ] } }, - "setFSRFlag":{ - "summary": "Set the FSR flag into the emmc raw area. This API will fail if you attempt to set the same value.", - "result": { - "type": "object", - "properties": { - "fsrFlag": { - "summary": "FSR flag", - "type": "boolean", - "example": true - }, - "success":{ - "$ref": "#/common/success" - } - }, - "required": [ - "fsrFlag", - "success" - ] - } - }, - "getFSRFlag":{ - "summary": "Get the FSR flag from the emmc raw area.", - "result": { - "type": "object", + "onBlocklistChanged":{ + "summary": "Triggers when the blocklist flag is modified", + "params": { + "type" :"object", "properties": { - "fsrFlag": { - "summary": "FSR flag.", - "type": "boolean", - "example": true + "oldBlocklistFlag": { + "$ref": "#/definitions/oldblocklist" }, - "success":{ - "$ref": "#/common/success" + "newBlocklistFlag": { + "$ref": "#/definitions/newblocklist" } }, "required": [ - "fsrFlag", - "success" + "oldBlocklistFlag", + "newBlocklistFlag" ] } } From 244b60015ccb6c5402b2bdd78c490d5f8301fdcf Mon Sep 17 00:00:00 2001 From: hgfell683 <107510770+hgfell683@users.noreply.github.com> Date: Thu, 19 Dec 2024 10:15:23 -0500 Subject: [PATCH 2/7] DELIA-66702: Documentation update Reason for change: Documentation Update Test Procedure: Risks: low Priority: P1 --- DisplaySettings/DisplaySettings.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/DisplaySettings/DisplaySettings.json b/DisplaySettings/DisplaySettings.json index d31760e699..e2ad88443c 100644 --- a/DisplaySettings/DisplaySettings.json +++ b/DisplaySettings/DisplaySettings.json @@ -2224,22 +2224,22 @@ "operation": { "summary": "The audio profile state", "type": "string", - "example": "" + "example": "`ADD`, `REMOVE`" }, "profileName": { "summary": "An MS12 audio profile name from `getSupportedMS12AudioProfile`", "type": "string", - "example": "Sports" + "example": "`Sports`, `User`" }, "ms12SettingsName": { "summary": "An ms12 setting name", "type": "string", - "example": "Dialog Enhance" + "example": "`DialogEnhance`, `VolumeLevellerMode`, `VolumeLevellerLevel`, `BassEnhancer`, `SurroundVirtualizerMode`, `SurroundVirtualizerLevel`" }, "ms12SettingsValue": { "summary": "The value to set", "type": "string", - "example": "On" + "example": "`0`, `1`" } }, "required": [ From bfe81bdd83d1c8c5e8e696add9fbce47f2d7b307 Mon Sep 17 00:00:00 2001 From: hgfell683 <107510770+hgfell683@users.noreply.github.com> Date: Thu, 19 Dec 2024 10:17:06 -0500 Subject: [PATCH 3/7] DELIA-66702: Documentation update Reason for change: Documentation Update Test Procedure: Risks: low Priority: P1 --- DisplaySettings/DisplaySettings.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DisplaySettings/DisplaySettings.json b/DisplaySettings/DisplaySettings.json index e2ad88443c..b90803967b 100644 --- a/DisplaySettings/DisplaySettings.json +++ b/DisplaySettings/DisplaySettings.json @@ -2239,7 +2239,7 @@ "ms12SettingsValue": { "summary": "The value to set", "type": "string", - "example": "`0`, `1`" + "example": "`0`, `1`, `2`" } }, "required": [ From 7d33fe5ce643497cc8239f24e226de20230f4ce1 Mon Sep 17 00:00:00 2001 From: apatel859 <48992974+apatel859@users.noreply.github.com> Date: Thu, 19 Dec 2024 12:45:38 -0500 Subject: [PATCH 4/7] Update DisplaySettings.json --- DisplaySettings/DisplaySettings.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DisplaySettings/DisplaySettings.json b/DisplaySettings/DisplaySettings.json index b90803967b..59fc7fe210 100644 --- a/DisplaySettings/DisplaySettings.json +++ b/DisplaySettings/DisplaySettings.json @@ -2073,7 +2073,7 @@ } }, "setForceHDRMode": { - "summary": " This API force the output HDR video format passed as input arumgents. If force output video format is set as "NONE" or this API not called video format changes as per input video format type", + "summary": " This API force the output HDR video format passed as input arumgents. If force output video format is set as \"NONE\" or this API not called video format changes as per input video format type", "params": { "type": "object", "properties": { From c3d83da55550953ead391ff7e9474f7dd30800f4 Mon Sep 17 00:00:00 2001 From: hgfell683 <107510770+hgfell683@users.noreply.github.com> Date: Tue, 24 Dec 2024 08:36:33 -0500 Subject: [PATCH 5/7] DELIA-66702: Documentation update Reason for change: Documentation Update Test Procedure: Risks: low Priority: P1 Signed-off-by:Hayden Gfeller Hayden_Gfeller@comcast.com --- DisplaySettings/CHANGELOG.md | 4 ++++ DisplaySettings/DisplaySettings.cpp | 2 +- SystemServices/CHANGELOG.md | 4 ++++ SystemServices/SystemServices.cpp | 2 +- 4 files changed, 10 insertions(+), 2 deletions(-) diff --git a/DisplaySettings/CHANGELOG.md b/DisplaySettings/CHANGELOG.md index 4f0195c5c3..5db26bd5a4 100644 --- a/DisplaySettings/CHANGELOG.md +++ b/DisplaySettings/CHANGELOG.md @@ -16,6 +16,10 @@ All notable changes to this RDK Service will be documented in this file. * For more details, refer to [versioning](https://github.com/rdkcentral/rdkservices#versioning) section under Main README. +## [2.0.2] - 2024-12-03 +### Fixed +- Corrected the documentation for several functions to make them more accurate for their actual use. + ## [2.0.1] - 2024-12-03 ### Fixed - Fixed unhandled exception that was occasionally causing a crash if thread creation failed. diff --git a/DisplaySettings/DisplaySettings.cpp b/DisplaySettings/DisplaySettings.cpp index a771a5e82e..9f4a4ae25c 100644 --- a/DisplaySettings/DisplaySettings.cpp +++ b/DisplaySettings/DisplaySettings.cpp @@ -85,7 +85,7 @@ using namespace std; #define API_VERSION_NUMBER_MAJOR 2 #define API_VERSION_NUMBER_MINOR 0 -#define API_VERSION_NUMBER_PATCH 0 +#define API_VERSION_NUMBER_PATCH 2 static bool isCecEnabled = false; static bool isResCacheUpdated = false; diff --git a/SystemServices/CHANGELOG.md b/SystemServices/CHANGELOG.md index e48c10098e..60f6e8665d 100644 --- a/SystemServices/CHANGELOG.md +++ b/SystemServices/CHANGELOG.md @@ -16,6 +16,10 @@ All notable changes to this RDK Service will be documented in this file. * For more details, refer to [versioning](https://github.com/rdkcentral/rdkservices#versioning) section under Main README. +## [3.4.1] - 2024-12-03 +### Fixed +- Fixed the location of the get and set FSR functions within the documentation. + ## [3.4.0] - 2024-12-09 ### Added - Added implementation for BootType get API. diff --git a/SystemServices/SystemServices.cpp b/SystemServices/SystemServices.cpp index 7eae266b66..06086ea7af 100644 --- a/SystemServices/SystemServices.cpp +++ b/SystemServices/SystemServices.cpp @@ -67,7 +67,7 @@ using namespace std; #define API_VERSION_NUMBER_MAJOR 3 #define API_VERSION_NUMBER_MINOR 4 -#define API_VERSION_NUMBER_PATCH 0 +#define API_VERSION_NUMBER_PATCH 1 #define MAX_REBOOT_DELAY 86400 /* 24Hr = 86400 sec */ #define TR181_FW_DELAY_REBOOT "Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AutoReboot.fwDelayReboot" From c2bc2fb4be062379e24577732feb651c2befdc9f Mon Sep 17 00:00:00 2001 From: hgfell683 <107510770+hgfell683@users.noreply.github.com> Date: Tue, 24 Dec 2024 08:39:57 -0500 Subject: [PATCH 6/7] DELIA-66702: Documentation update Reason for change: Documentation Update Test Procedure: Risks: low Priority: P1 Signed-off-by:Hayden Gfeller --- SystemServices/System.json | 57 +++++++++++++++++++++++++++++++++++++- 1 file changed, 56 insertions(+), 1 deletion(-) diff --git a/SystemServices/System.json b/SystemServices/System.json index 1be538988c..35bc0c2121 100644 --- a/SystemServices/System.json +++ b/SystemServices/System.json @@ -374,6 +374,21 @@ ], "type": "string", "example": "NORMAL" + }, + "blocklist": { + "summary": "the blocklist flag value", + "type": "boolean", + "example": true + }, + "oldblocklist": { + "summary": "the old blocklist flag value", + "type": "boolean", + "example": true + }, + "newblocklist": { + "summary": "the new blocklist flag value", + "type": "boolean", + "example": true } }, "methods": { @@ -2014,6 +2029,46 @@ "example": "DO_NOT_SHARE" } }, + "getBlocklistFlag":{ + "summary": "get the blocklist flag on device for device state. Valid flags are: \n* `true` - The device is in blocked state. \n* `false` - The device is in un-blocked state.", + "result": { + "type": "object", + "properties": { + "blocklist": { + "summary": "blocklist flag", + "type": "boolean", + "example": true + }, + "success":{ + "$ref": "#/common/success" + } + }, + "required": [ + "blocklist", + "success" + ] + } + }, + "setBlocklistFlag":{ + "summary": "Sets the blocklist flag on device for device state. Valid flags are: \n* `true` - The device is in blocked state. \n* `false` - The device is in un-blocked state.", + "events": { + "onBlocklistChanged" : "Triggers when the blocklist flag is modified" + }, + "params": { + "type":"object", + "properties": { + "blocklist": { + "$ref": "#/definitions/blocklist" + } + }, + "required": [ + "blocklist" + ] + }, + "result": { + "$ref": "#/common/result" + } + }, "getBootTypeInfo":{ "summary": "Getting Boot Type", "result": { @@ -2453,4 +2508,4 @@ } } } -} +} \ No newline at end of file From 4265020c9d88351f4983ae273990cb75f4e09925 Mon Sep 17 00:00:00 2001 From: hgfell683 <107510770+hgfell683@users.noreply.github.com> Date: Tue, 24 Dec 2024 08:41:10 -0500 Subject: [PATCH 7/7] DELIA-66702: Documentation update Reason for change: Documentation Update Test Procedure: Risks: low Priority: P1 Signed-off-by:Hayden Gfeller --- SystemServices/System.json | 57 +------------------------------------- 1 file changed, 1 insertion(+), 56 deletions(-) diff --git a/SystemServices/System.json b/SystemServices/System.json index 35bc0c2121..1be538988c 100644 --- a/SystemServices/System.json +++ b/SystemServices/System.json @@ -374,21 +374,6 @@ ], "type": "string", "example": "NORMAL" - }, - "blocklist": { - "summary": "the blocklist flag value", - "type": "boolean", - "example": true - }, - "oldblocklist": { - "summary": "the old blocklist flag value", - "type": "boolean", - "example": true - }, - "newblocklist": { - "summary": "the new blocklist flag value", - "type": "boolean", - "example": true } }, "methods": { @@ -2029,46 +2014,6 @@ "example": "DO_NOT_SHARE" } }, - "getBlocklistFlag":{ - "summary": "get the blocklist flag on device for device state. Valid flags are: \n* `true` - The device is in blocked state. \n* `false` - The device is in un-blocked state.", - "result": { - "type": "object", - "properties": { - "blocklist": { - "summary": "blocklist flag", - "type": "boolean", - "example": true - }, - "success":{ - "$ref": "#/common/success" - } - }, - "required": [ - "blocklist", - "success" - ] - } - }, - "setBlocklistFlag":{ - "summary": "Sets the blocklist flag on device for device state. Valid flags are: \n* `true` - The device is in blocked state. \n* `false` - The device is in un-blocked state.", - "events": { - "onBlocklistChanged" : "Triggers when the blocklist flag is modified" - }, - "params": { - "type":"object", - "properties": { - "blocklist": { - "$ref": "#/definitions/blocklist" - } - }, - "required": [ - "blocklist" - ] - }, - "result": { - "$ref": "#/common/result" - } - }, "getBootTypeInfo":{ "summary": "Getting Boot Type", "result": { @@ -2508,4 +2453,4 @@ } } } -} \ No newline at end of file +}