RDKEMW-7075: COM-RPC support to SystemService plugin#738
Draft
RDKEMW-7075: COM-RPC support to SystemService plugin#738
Conversation
Reason for change: COM-RPC support to SystemServices plugin Test Procedure: Test SystemServices - All APIs Risks: Medium Priority: P1 version: Patch Signed-off-by:Dineshkumar P [dinesh_kumar2@comcast.com]
Documentation Auto-GeneratedDocumentation has been automatically generated for the changed plugins and committed to this PR branch. The generated documentation files have been added to the PR for review. |
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds COM-RPC support to the SystemServices plugin by introducing a new interface definition, updating the API documentation, and registering new interface IDs.
Changes:
- Added comprehensive COM-RPC interface definition for SystemServices
- Registered new interface IDs for SystemServices and related components
- Added SystemServices documentation link to sidebar
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 14 comments.
| File | Description |
|---|---|
| docs/apis/SystemServices.md | Complete auto-generated API documentation for SystemServices plugin methods and events |
| docs/_sidebar.md | Added navigation link for SystemServices documentation |
| apis/SystemServices/ISystemServices.h | COM-RPC interface definition with all SystemServices methods and notification structures |
| apis/Ids.h | Registered new interface IDs for SystemServices components |
Comments suppressed due to low confidence (1)
docs/apis/SystemServices.md:1
- Inconsistent capitalization: 'Wake up' should be 'wakeup' to match other descriptions, or all should use 'wake up' for consistency.
<!-- Generated automatically, DO NOT EDIT! -->
docs/apis/SystemServices.md
Outdated
Comment on lines
51
to
53
| | [getBlocklistFlag](#getBlocklistFlag) | Get block list falg. | | ||
| | [getBootTypeInfo](#getBootTypeInfo) | Get the FSR flag from the emmc raw area. | | ||
| | [getBuildType](#getBuildType) | Returns build type of the image flashed on the device. | |
There was a problem hiding this comment.
Corrected spelling of 'falg' to 'flag'.
Suggested change
| | [getBlocklistFlag](#getBlocklistFlag) | Get block list falg. | | |
| | [getBootTypeInfo](#getBootTypeInfo) | Get the FSR flag from the emmc raw area. | | |
| | [getBuildType](#getBuildType) | Returns build type of the image flashed on the device. | | |
| | [getBlocklistFlag](#getBlocklistFlag) | Get block list flag. | | |
| | [getBootTypeInfo](#getBootTypeInfo) | Get the FSR flag from the emmc raw area. | | |
| | [getBuildType](#getBuildType) | Returns build type of the image flashed on the device flashed on the device. | |
Comment on lines
+118
to
+119
| { | ||
| "jsonrpc": 2.0, |
There was a problem hiding this comment.
The JSON-RPC version should be a string "2.0", not a numeric value 2.0, according to the JSON-RPC 2.0 specification.
docs/apis/SystemServices.md
Outdated
| | Method | Description | | ||
| | :-------- | :-------- | | ||
| | [abortLogUpload](#abortLogUpload) | Stops background process to upload logs. | | ||
| | [getBlocklistFlag](#getBlocklistFlag) | Get block list falg. | |
There was a problem hiding this comment.
Corrected spelling of 'falg' to 'flag'.
Suggested change
| | [getBlocklistFlag](#getBlocklistFlag) | Get block list falg. | | |
| | [getBlocklistFlag](#getBlocklistFlag) | Get block list flag. | |
docs/apis/SystemServices.md
Outdated
| <a id="getMigrationStatus"></a> | ||
| ## *getMigrationStatus* | ||
|
|
||
| set the Migration Status of the device |
There was a problem hiding this comment.
The description states 'set' but this is a getter method (getMigrationStatus). The description should be 'Gets the Migration Status of the device' to accurately reflect the method's purpose.
Suggested change
| set the Migration Status of the device | |
| Gets the Migration Status of the device |
Comment on lines
+1016
to
+1028
| | result.platformConfig.AccountInfo @brief AccountInfo Details | AccountInfoDetails | AccountInfo Details | | ||
| | result.platformConfig.AccountInfo @brief AccountInfo Details.accountId | string | Account Id | | ||
| | result.platformConfig.AccountInfo @brief AccountInfo Details.x1DeviceId | string | X1 Device Id | | ||
| | result.platformConfig.AccountInfo @brief AccountInfo Details.XCALSessionTokenAvailable | bool | XCAL Session Token Available | | ||
| | result.platformConfig.AccountInfo @brief AccountInfo Details.experience | string | Experience | | ||
| | result.platformConfig.AccountInfo @brief AccountInfo Details.deviceMACAddress | string | Device MAC Address | | ||
| | result.platformConfig.AccountInfo @brief AccountInfo Details.firmwareUpdateDisabled | bool | Whether the firmwareUpdate Disabled | | ||
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details | DeviceInfoDetails | DeviceInfo Details | | ||
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details.quirks | string | The list of installed “quirks” | | ||
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details.mimeTypeExclusions | MIMETypeExclusions | mime Type Exclusions | | ||
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details.mimeTypeExclusions.CDVR | string | CDVR | | ||
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details.mimeTypeExclusions.DVR | string | DVR | | ||
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details.mimeTypeExclusions.EAS | string | EAS | |
There was a problem hiding this comment.
The field name 'AccountInfo @brief AccountInfo Details' is confusing as it includes '@brief' documentation syntax. This should be a clean identifier without documentation markers.
Suggested change
| | result.platformConfig.AccountInfo @brief AccountInfo Details | AccountInfoDetails | AccountInfo Details | | |
| | result.platformConfig.AccountInfo @brief AccountInfo Details.accountId | string | Account Id | | |
| | result.platformConfig.AccountInfo @brief AccountInfo Details.x1DeviceId | string | X1 Device Id | | |
| | result.platformConfig.AccountInfo @brief AccountInfo Details.XCALSessionTokenAvailable | bool | XCAL Session Token Available | | |
| | result.platformConfig.AccountInfo @brief AccountInfo Details.experience | string | Experience | | |
| | result.platformConfig.AccountInfo @brief AccountInfo Details.deviceMACAddress | string | Device MAC Address | | |
| | result.platformConfig.AccountInfo @brief AccountInfo Details.firmwareUpdateDisabled | bool | Whether the firmwareUpdate Disabled | | |
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details | DeviceInfoDetails | DeviceInfo Details | | |
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details.quirks | string | The list of installed “quirks” | | |
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details.mimeTypeExclusions | MIMETypeExclusions | mime Type Exclusions | | |
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details.mimeTypeExclusions.CDVR | string | CDVR | | |
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details.mimeTypeExclusions.DVR | string | DVR | | |
| | result.platformConfig.DeviceInfo @brief DeviceInfo Details.mimeTypeExclusions.EAS | string | EAS | | |
| | result.platformConfig.AccountInfo | AccountInfoDetails | AccountInfo Details | | |
| | result.platformConfig.AccountInfo.accountId | string | Account Id | | |
| | result.platformConfig.AccountInfo.x1DeviceId | string | X1 Device Id | | |
| | result.platformConfig.AccountInfo.XCALSessionTokenAvailable | bool | XCAL Session Token Available | | |
| | result.platformConfig.AccountInfo.experience | string | Experience | | |
| | result.platformConfig.AccountInfo.deviceMACAddress | string | Device MAC Address | | |
| | result.platformConfig.AccountInfo.firmwareUpdateDisabled | bool | Whether the firmwareUpdate Disabled | | |
| | result.platformConfig.DeviceInfo | DeviceInfoDetails | DeviceInfo Details | | |
| | result.platformConfig.DeviceInfo.quirks | string | The list of installed “quirks” | | |
| | result.platformConfig.DeviceInfo.mimeTypeExclusions | MIMETypeExclusions | mime Type Exclusions | | |
| | result.platformConfig.DeviceInfo.mimeTypeExclusions.CDVR | string | CDVR | | |
| | result.platformConfig.DeviceInfo.mimeTypeExclusions.DVR | string | DVR | | |
| | result.platformConfig.DeviceInfo.mimeTypeExclusions.EAS | string | EAS | |
| bool powerKey /* @text WAKEUPSRC_POWER_KEY */ /* @brief Power Button Wake up - GPIO */; | ||
| bool cec /* @text WAKEUPSRC_CEC */ /* @brief HDMI CEC command Wake up */; | ||
| bool lan /* @text WAKEUPSRC_LAN */ /* @brief LAN wake up */; | ||
| bool timer /* @text WAKEUPSRC_TIMER */ /* @brief TImer Wake up */; |
There was a problem hiding this comment.
Corrected capitalization of 'TImer' to 'Timer'.
Suggested change
| bool timer /* @text WAKEUPSRC_TIMER */ /* @brief TImer Wake up */; | |
| bool timer /* @text WAKEUPSRC_TIMER */ /* @brief Timer Wake up */; |
| // @param TimeZoneDSTChangedInfo: The TimeZoneDST changed information | ||
| virtual void OnTimeZoneDSTChanged(const TimeZoneDSTChangedInfo& timeZoneDSTChangedInfo) {}; | ||
|
|
||
| // @text OnMacAddressesRetreived |
There was a problem hiding this comment.
Corrected spelling of 'Retreived' to 'Retrieved'.
Suggested change
| // @text OnMacAddressesRetreived | |
| // @text OnMacAddressesRetrieved |
Comment on lines
257
to
260
| // @text OnMacAddressesRetreived | ||
| // @brief Triggered when the getMacAddresses asynchronous method is invoked. | ||
| // @param MacAddressesInfo: The Mac Addresses details | ||
| virtual void OnMacAddressesRetreived(const MacAddressesInfo& macAddressesInfo) {}; |
There was a problem hiding this comment.
Corrected spelling of 'Retreived' to 'Retrieved'.
Suggested change
| // @text OnMacAddressesRetreived | |
| // @brief Triggered when the getMacAddresses asynchronous method is invoked. | |
| // @param MacAddressesInfo: The Mac Addresses details | |
| virtual void OnMacAddressesRetreived(const MacAddressesInfo& macAddressesInfo) {}; | |
| // @text OnMacAddressesRetrieved | |
| // @brief Triggered when the getMacAddresses asynchronous method is invoked. | |
| // @param MacAddressesInfo: The Mac Addresses details | |
| virtual void OnMacAddressesRetrieved(const MacAddressesInfo& macAddressesInfo) {}; |
| virtual Core::hresult SetMigrationStatus(const bool status, bool& success /* @out */) = 0; | ||
|
|
||
| // @text getMigrationStatus | ||
| // @brief set the Migration Status of the device |
There was a problem hiding this comment.
The description states 'set' but this is a getter method (GetMigrationStatus). The description should be 'Gets the Migration Status of the device' to accurately reflect the method's purpose.
Suggested change
| // @brief set the Migration Status of the device | |
| // @brief Gets the Migration Status of the device |
| virtual Core::hresult SetBlocklistFlag(const bool blocklist, BlocklistResult& result /* @out */) = 0; | ||
|
|
||
| // @text getBlocklistFlag | ||
| // @brief Get block list falg. |
There was a problem hiding this comment.
Corrected spelling of 'falg' to 'flag'.
Suggested change
| // @brief Get block list falg. | |
| // @brief Get block list flag. |
Documentation Auto-GeneratedDocumentation has been automatically generated for the changed plugins and committed to this PR branch. The generated documentation files have been added to the PR for review. |
Documentation Auto-GeneratedDocumentation has been automatically generated for the changed plugins and committed to this PR branch. The generated documentation files have been added to the PR for review. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reason for change: COM-RPC support to SystemServices plugin
Test Procedure: Test SystemServices - All APIs
Risks: Medium
Priority: P1
version: Patch
Signed-off-by:Dineshkumar P [dinesh_kumar2@comcast.com]