Skip to content

README.md

Latest commit

 

History

History
102 lines (82 loc) · 2.91 KB

README.md

File metadata and controls

102 lines (82 loc) · 2.91 KB
Raw

SceneSet Documentation

This documentation provides comprehensive technical details about the SceneSet application launcher service for RDK-based Set-Top Boxes.

Overview

SceneSet is a systemd-managed service that automatically launches the RDK reference application during system boot. It integrates with the WPEFramework (Thunder) ecosystem to manage application lifecycle, preinstallation of app bundles, and over-the-air (OTA) updates.

Documentation Index

Document Description
Architecture Overview High-level system design, component interactions, and architectural diagrams
RALF Package Support Package verification and metadata extraction using libralf
Configuration Guide Build-time and runtime configuration options
Testing Guide Test infrastructure, coverage, and testing strategies

Quick Links

Key Features

mindmap
  root((SceneSet))
    App Lifecycle
      Auto Launch
      Crash Recovery
      State Monitoring
    Preinstall Management
      Factory Reset Support
      Bundle Copying
      Completion Tracking
    OTA Updates
      Download Monitoring
      Package Verification
      Version Management
    System Integration
      Thunder/COMRPC
      Systemd Notify
      Signal Handling
Loading

System Requirements

  • WPEFramework (Thunder) with the following plugins:
    • org.rdk.AppManager
    • org.rdk.PreinstallManager
    • org.rdk.AppPackageManager
  • libralf for RALF package verification
  • libsystemd for systemd integration
  • C++17 compatible compiler

Architecture at a Glance

graph TB
    subgraph SceneSet Service
        SS[SceneSetApp]
        AH[AppManagerEventHandler]
        PH[PreinstallManagerEventHandler]
        PKH[PackageInstallerEventHandler]
        RS[RalfPackageSupport]
    end

    subgraph WPEFramework
        AM[AppManager Plugin]
        PM[PreinstallManager Plugin]
        APM[AppPackageManager Plugin]
    end

    subgraph External
        SD[Systemd]
        FS[Filesystem]
        RALF[libralf]
    end

    SS --> AM
    SS --> PM
    SS --> APM
    AH -.-> SS
    PH -.-> SS
    PKH -.-> SS
    RS --> RALF
    SS --> SD
    SS --> FS
Loading

Getting Started

  1. Build the project - See Configuration Guide
  2. Configure the service - Set appropriate CMake variables or runtime config files
  3. Deploy - Install the sceneset binary and systemd service file
  4. Enable - systemctl enable sceneset.service

License

Copyright 2024-2026 RDK Management. Licensed under the Apache License, Version 2.0.