RDKCOM-5479: RDKBDEV-3321 Add CcspLMLite Documentation#31
RDKCOM-5479: RDKBDEV-3321 Add CcspLMLite Documentation#31raslam930 wants to merge 1 commit intordkcentral:developfrom
Conversation
pradeeptakdas
changed the title
tinaelizabeth84
force-pushed
the
feature/RDKBDEV-3321
branch
from
9346e9e to
8d4b244
Compare
There was a problem hiding this comment.
Pull request overview
Adds a comprehensive Markdown documentation page for the CcspLMLite (LAN Manager Lite) component, covering architecture, TR-181 data models, module breakdown, and interaction/call flows.
Changes:
- Introduces a new top-level
README.mdwith detailed component documentation. - Adds multiple Mermaid diagrams (architecture, state flow, call flows) to visualize behavior and integrations.
- Documents supported TR-181 objects/parameters and key internal modules/interactions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # CcspLMLite Documentation | ||
|
|
||
| CcspLMLite (LAN Manager Lite) is the RDK-B component responsible for managing and monitoring LAN-side network devices and hosts connected to the gateway. This component serves as the primary interface for discovering, tracking, and reporting network connectivity status, device information, and traffic analytics for connected devices across WiFi, Ethernet, and MoCA interfaces. LMLite provides comprehensive host management capabilities including device discovery, presence detection, network traffic monitoring, and telemetry reporting. It implements TR-181 data model parameters for hosts management and integrates with WebPA for cloud-based management and monitoring. CcspLMLite acts as a centralized hub for collecting network device information from various sources and presenting a unified view through standardized TR-181 interfaces. | ||
|
|
There was a problem hiding this comment.
Adding a top-level README.md will become the repository’s default landing page on GitHub and may effectively hide the existing build/usage instructions currently in the README file. Consider either migrating/linking the build instructions here (or adding a prominent link to README) so readers can still find them easily.
| > **Build and usage instructions:** If you are looking for setup, build, and usage information, see the legacy [`README`](README) file. |
| subgraph ReportsModule ["Network Reports & Analytics"] | ||
| ReportsInternal[Reports Module] | ||
| NDStatus[NW Device Status] | ||
| NDTraffic[NW Device Traffix] |
There was a problem hiding this comment.
Typo in the Mermaid node label: NW Device Traffix should be NW Device Traffic.
| NDTraffic[NW Device Traffix] | |
| NDTraffic[NW Device Traffic] |
| * **Systemd Services**: `CcspCrSsp.service`, `CcspPsmSsp.service` must be active before `CcspLMLite.service` starts | ||
| * **Message Bus**: RBus registration under `com.cisco.spvtg.ccsp.lmlite` namespace for performance optimization and inter-component communication | ||
| * **TR-181 Data Model**: `Device.Hosts` object hierarchy and `Device.ManagementServer.ManageableDevice` support for device management and reporting | ||
| * **Configuration Files**: `LMLite.xml` for TR-181 parameter definitions; component configuration files located in `/usr/ccsp/lmlite/` |
There was a problem hiding this comment.
The docs refer to LMLite.xml, but the repository config file is config/LMLite.XML (different casing/extension). For accuracy (and to avoid confusion on case-sensitive filesystems), please update the filename in the documentation to match the actual file name/path used by this repo.
| * **Configuration Files**: `LMLite.xml` for TR-181 parameter definitions; component configuration files located in `/usr/ccsp/lmlite/` | |
| * **Configuration Files**: `config/LMLite.XML` for TR-181 parameter definitions; component configuration files located in `/usr/ccsp/lmlite/` |
| | **RDK-B Middleware Components** | | ||
| | CcspPandM | TR-181 parameter registration and access control, configuration management | `registerCapabilities`, `getParameterValues`, `setParameterValues` | | ||
| | OneWifi | WiFi device association/disassociation events, wireless client enumeration | `Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.*`, WiFi HAL callbacks | | ||
| | CcspMoCAAgent | MoCA network topology changes, node status updates, device discovery | `Device.MoCA.Interface.{i}.AssociatedDevice.{i}.*` | | ||
| | CcspPsm | Persistent device information storage, configuration parameter backup | `PSM_Set_Record_Value2()`, `PSM_Get_Record_Value2()` | | ||
| | **System & HAL Layers** | |
There was a problem hiding this comment.
The “Interaction Matrix” table has header/group rows like | **RDK-B Middleware Components** | and | **System & HAL Layers** | that don’t include the same number of columns as the table header, which breaks GitHub Markdown table rendering. Use a consistent 3-column row format (e.g., add empty cells) or split the matrix into separate tables/sections.
| | **RDK-B Middleware Components** | | |
| | CcspPandM | TR-181 parameter registration and access control, configuration management | `registerCapabilities`, `getParameterValues`, `setParameterValues` | | |
| | OneWifi | WiFi device association/disassociation events, wireless client enumeration | `Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.*`, WiFi HAL callbacks | | |
| | CcspMoCAAgent | MoCA network topology changes, node status updates, device discovery | `Device.MoCA.Interface.{i}.AssociatedDevice.{i}.*` | | |
| | CcspPsm | Persistent device information storage, configuration parameter backup | `PSM_Set_Record_Value2()`, `PSM_Get_Record_Value2()` | | |
| | **System & HAL Layers** | | |
| | **RDK-B Middleware Components** | | | | |
| | CcspPandM | TR-181 parameter registration and access control, configuration management | `registerCapabilities`, `getParameterValues`, `setParameterValues` | | |
| | OneWifi | WiFi device association/disassociation events, wireless client enumeration | `Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.*`, WiFi HAL callbacks | | |
| | CcspMoCAAgent | MoCA network topology changes, node status updates, device discovery | `Device.MoCA.Interface.{i}.AssociatedDevice.{i}.*` | | |
| | CcspPsm | Persistent device information storage, configuration parameter backup | `PSM_Set_Record_Value2()`, `PSM_Get_Record_Value2()` | | |
| | **System & HAL Layers** | | | |
| | `lmlite.conf` | Runtime configuration parameters and operational settings | Environment variables, systemd overrides | | ||
| | `presence_detection.ini` | Advanced presence detection algorithm parameters | TR-181 parameter interface, configuration API | |
There was a problem hiding this comment.
lmlite.conf and presence_detection.ini are listed as key configuration files, but they don’t appear anywhere in this repository (no config/ entries and no references in source/build scripts). Either add them (if they are part of this component), or clarify that they are platform/integration-specific files that are not shipped/maintained in this repo.
| | `lmlite.conf` | Runtime configuration parameters and operational settings | Environment variables, systemd overrides | | |
| | `presence_detection.ini` | Advanced presence detection algorithm parameters | TR-181 parameter interface, configuration API | | |
| | `lmlite.conf` | Platform/integration-specific runtime configuration, when provided by the target deployment | Environment variables, init/systemd/service-layer overrides | | |
| | `presence_detection.ini` | Platform/integration-specific presence-detection tuning parameters, when supported by the target deployment | TR-181 parameter interface, vendor/platform configuration APIs | | |
| > **Note:** `lmlite.conf` and `presence_detection.ini` are not shipped or maintained in this repository as standalone configuration files. When used, they are typically supplied by downstream platform integration, packaging, or deployment layers. |
GoutamD2905
left a comment
GoutamD2905
left a comment
There was a problem hiding this comment.
@raslam930 Please address all Copilot review comments.
[https://jira.rdkcentral.com/jira/browse/RDKBDEV-3321]
Reason for Change:
To add Component Documentation for CcspLMLite
Fix:
Added the documentation
Test Procedure:
None
Signed-off-by: Raheen Aslam [raheen_aslam@comcast.com]