RDKEMW-2905: USB Feature - UserManual Update #116

Dosakaya · 2025-03-27T11:23:28Z

Reason for change:
Updated Usb Plugins documentation as per code flow.

Risks: None

ramasat · 2025-03-27T12:26:51Z

docs/apis/USBMassStoragePlugin.md

+            "partitionName": "/dev/sda1",
+            "mountFlags": "READ_ONLY",
+            "mountPath": "/tmp/media/usb2",
+            "fileSystem": "VFAT"


I dont see fileSystem in the documentation. Are we returning this param in the code?

Yes @ramasat. We are using USBStorageMountInfo iterator, which has 4 member variables (https://github.com/rdkcentral/entservices-apis/blob/develop/apis/USBMassStorage/IUSBMassStorage.h#L61) in the getMountPoints method.

Ok, I have added this as "optional" parameter in the API Spec. Please see my other comments in the corresponding "json" file.

ramasat · 2025-03-27T12:29:39Z

docs/apis/USBMassStoragePlugin.md

-| result[#]?.usedSpace | integer | <sup>*(optional)*</sup> Used space of the partition in MB |
-| result[#]?.availableSpace | integer | <sup>*(optional)*</sup> Available space in the partition in MB |
+| result | object |  |
+| result?.fileSystem | string | <sup>*(optional)*</sup> The file system of the partition |


As per document, it should be result.partitionInfo?fileSystem. Is the code differently implements this response?

The response is coming as below...

{"jsonrpc":"2.0","id":42,"result":{"fileSystem":"VFAT","size":14687,"startSector":0,"numSectors":30080992,"sectorSize":512,"totalSpace":14671,"usedSpace":22,"availableSpace":14649}}

No, we can't deviate the API Spec, as the apps team has already started developing their app using the Spec. Please create a ticket similar to "https://ccp.sys.comcast.net/browse/RDKEMW-2907" or add additional scope in the same ticket to fix this (i.e., introduce the partitionInfo object here).

ramasat · 2025-03-27T12:31:43Z

docs/apis/USBMassStoragePlugin.md

+| params.mountPoints[#].partitionName | string | The name of the partition being mounted |
+| params.mountPoints[#].mountFlags | string | Flags indicating how the partition is mounted |
+| params.mountPoints[#].mountPath | string | The mount point path in the file system |
+| params.mountPoints[#].fileSystem | string | File system |


fileSystem is not part of this response as per spec.

We are using USBStorageMountInfo iterator, which has 4 member variables (https://github.com/rdkcentral/entservices-apis/blob/develop/apis/USBMassStorage/IUSBMassStorage.h#L61) in the getMountPoints method.

ok, as mentioned above, I made this an optional param. Please also refer my related comment in the "json file".

ramasat · 2025-03-27T12:35:58Z

docs/apis/USBDevicePlugin.md

-| result.deviceInfo[#]?.productInfo4?.serialNumber | string | <sup>*(optional)*</sup> Unicode string representing the serial number of the device |
-| result.deviceInfo[#]?.productInfo4?.manufacturer | string | <sup>*(optional)*</sup> Unicode string representing the manufacturer of the device |
-| result.deviceInfo[#]?.productInfo4?.product | string | <sup>*(optional)*</sup> Unicode string representing the product |
+| result | array | An array of USBDeviceInfo |


This should not be an array as per spec

Yes. currently it is an array in the middleware code. we have created jira (https://ccp.sys.comcast.net/browse/RDKEMW-2907) to work on this.

ok. We need to prioritize the above ticket and get it fixed quickly as we cannot keep the API Spec broken for long time.

ramasat · 2025-03-27T12:38:17Z

docs/apis/USBDevicePlugin.md

+| result[#].protocol | integer | Protocol supported by the device |
+| result[#].serialnumber | string | Serial number of the device |
+| result[#].device | object |  |
+| result[#].device.deviceClass | integer | USB class of the device |


Too many fields when compared with the spec.

As per current middleware code, we added all these properties..
Please find the response for getDeviceInfo interface...

{"jsonrpc":"2.0","id":42,"result":[{"parentId":6,"deviceStatus":1,"deviceLevel":2,"portNumber":4,"vendorId":1921,"productId":21889,"protocol":0,"serialNumber":"0401805e4532973503374df52c237c098397d34849b2bc891105dbf81be234f933de00000000000000000000ff7c2bd3ff1d6a1881558107882f56e3","device":{"deviceClass":8,"deviceSubclass":6,"deviceName":"001/006","devicePath":"/dev/sda"},"flags":"AVAILABLE","features":0,"busSpeed":"High","numLanguageIds":1,"productInfo1":{"languageId":1033,"serialNumber":"0401805e4532973503374df52c237c098397d34849b2bc891105dbf81be234f933de00000000000000000000ff7c2bd3ff1d6a1881558107882f56e3","manufacturer":" USB","product":" SanDisk 3.2Gen1"},"productInfo2":{"languageId":0,"serialNumber":"","manufacturer":"","product":""},"productInfo3":{"languageId":0,"serialNumber":"","manufacturer":"","product":""},"productInfo4":{"languageId":0,"serialNumber":"","manufacturer":"","product":""}}]}

Ok, we can add the missing fields in the API Spec. However, we need to introduce the "deviceInfo" object in the response (For ex., result.deviceInfo.parentId) . Please create a new ticket or expand the scope for https://ccp.sys.comcast.net/browse/RDKEMW-2907 to add fix for this.

ramasat · 2025-03-28T12:54:53Z

tools/json_generator/output/USBMassStorage/USBMassStorage.json

                    }
                },
-                "required": ["partitionName", "mountFlags", "mountPath"]
-            }
+                "required": ["partitionName", "mountFlags", "mountPath", "fileSystem"]


Please make the fileSystem "optional" (as we have already published the spec and team has started using it, we cant add this as mandatory param).

ramasat · 2025-03-28T12:57:17Z

docs/apis/USBMassStoragePlugin.md

+            "partitionName": "/dev/sda1",
+            "mountFlags": "READ_ONLY",
+            "mountPath": "/tmp/media/usb2",
+            "fileSystem": "VFAT"


Ok, I have added this as "optional" parameter in the API Spec. Please see my other comments in the corresponding "json" file.

ramasat · 2025-03-28T13:05:57Z

docs/apis/USBMassStoragePlugin.md

-| result[#]?.usedSpace | integer | <sup>*(optional)*</sup> Used space of the partition in MB |
-| result[#]?.availableSpace | integer | <sup>*(optional)*</sup> Available space in the partition in MB |
+| result | object |  |
+| result?.fileSystem | string | <sup>*(optional)*</sup> The file system of the partition |


No, we can't deviate the API Spec, as the apps team has already started developing their app using the Spec. Please create a ticket similar to "https://ccp.sys.comcast.net/browse/RDKEMW-2907" or add additional scope in the same ticket to fix this (i.e., introduce the partitionInfo object here).

ramasat · 2025-03-28T13:07:00Z

docs/apis/USBMassStoragePlugin.md

+| params.mountPoints[#].partitionName | string | The name of the partition being mounted |
+| params.mountPoints[#].mountFlags | string | Flags indicating how the partition is mounted |
+| params.mountPoints[#].mountPath | string | The mount point path in the file system |
+| params.mountPoints[#].fileSystem | string | File system |


ok, as mentioned above, I made this an optional param. Please also refer my related comment in the "json file".

ramasat · 2025-03-28T13:28:23Z

docs/apis/USBDevicePlugin.md

+| result[#].protocol | integer | Protocol supported by the device |
+| result[#].serialnumber | string | Serial number of the device |
+| result[#].device | object |  |
+| result[#].device.deviceClass | integer | USB class of the device |


Ok, we can add the missing fields in the API Spec. However, we need to introduce the "deviceInfo" object in the response (For ex., result.deviceInfo.parentId) . Please create a new ticket or expand the scope for https://ccp.sys.comcast.net/browse/RDKEMW-2907 to add fix for this.

Dosakaya added 3 commits March 27, 2025 15:55

RDKEMW-2905: USB Feature - UserManual Update

bee19b6

updated documentation

50ac7dd

updated doc

aeadc33

Dosakaya requested a review from a team as a code owner March 27, 2025 11:23

ramasat reviewed Mar 27, 2025

View reviewed changes

ramasat reviewed Mar 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RDKEMW-2905: USB Feature - UserManual Update #116

RDKEMW-2905: USB Feature - UserManual Update #116

Dosakaya commented Mar 27, 2025

ramasat Mar 27, 2025

Dosakaya Mar 27, 2025

ramasat Mar 28, 2025

ramasat Mar 27, 2025

Dosakaya Mar 27, 2025

ramasat Mar 28, 2025

ramasat Mar 27, 2025

Dosakaya Mar 27, 2025

ramasat Mar 28, 2025

ramasat Mar 27, 2025

Dosakaya Mar 27, 2025

ramasat Mar 28, 2025

ramasat Mar 27, 2025

Dosakaya Mar 27, 2025

ramasat Mar 28, 2025 •

edited

Loading

ramasat Mar 28, 2025

ramasat Mar 28, 2025

ramasat Mar 28, 2025

ramasat Mar 28, 2025

ramasat Mar 28, 2025 •

edited

Loading

RDKEMW-2905: USB Feature - UserManual Update #116

Are you sure you want to change the base?

RDKEMW-2905: USB Feature - UserManual Update #116

Conversation

Dosakaya commented Mar 27, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ramasat Mar 28, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ramasat Mar 28, 2025 • edited Loading

Choose a reason for hiding this comment

ramasat Mar 28, 2025 •

edited

Loading

ramasat Mar 28, 2025 •

edited

Loading