Skip to content

Conversation

@jdmedlin1
Copy link
Contributor

📝 Description

This branch provides clear documentation and updated code samples that demonstrate three different methods to enable the Local Diagnostic Web Server (LDWS) on BrightSign devices: using BrightScript, Node.js, and direct registry settings. The example helps developers choose and implement the best approach for enabling LDWS in their projects.

Issue: Url to Jira Issue

📋 List of Changes

  • README.md: Explains the three different methods to enable the Local Diagnostic Web Server (LDWS) and provides setup instructions.
  • autorun.brs: BrightScript example that enables LDWS using the roNetworkConfiguration API (recommended for BrightScript apps).
  • index.js: Node.js example that enables LDWS using the @brightsign/dwsconfiguration module (for Node.js-based apps).
  • autorun-nodejs.brs: BrightScript autorun file that launches the Node.js example on the device.
  • registry.brs: BrightScript example that enables LDWS by directly writing to the device registry (alternative, low-level approach).

🧪 Steps to Test

Run each example on your player.

✔️ Dev Complete Checklist

  • PR template filled out
  • Change is tested by submitter
  • PR follows all linting and coding standards
  • Team member has been assigned
  • At least one commit message is in Conventional Commit format

Copilot AI review requested due to automatic review settings August 14, 2025 18:39
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR provides comprehensive documentation and code examples for enabling the Local Diagnostic Web Server (LDWS) on BrightSign devices. It demonstrates three different implementation approaches to help developers choose the best method for their specific use case.

  • Adds three different methods to enable LDWS: BrightScript with roNetworkConfiguration, Node.js with @brightsign/dwsconfiguration, and direct registry manipulation
  • Provides comprehensive documentation with setup instructions, security considerations, and troubleshooting guidance
  • Includes working code examples for each method with proper error handling and configuration options

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
registry.brs BrightScript example using direct registry manipulation to configure LDWS
index.js Node.js example using @brightsign/dwsconfiguration module for LDWS setup
autorun.brs BrightScript example using roNetworkConfiguration API (recommended approach)
autorun-nodejs.brs BrightScript autorun file to launch the Node.js LDWS configuration
README.md Comprehensive documentation covering all three methods with usage instructions

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@jdmedlin1 jdmedlin1 requested a review from blshukla August 14, 2025 20:46
evan-morgan
evan-morgan previously approved these changes Aug 15, 2025
Copy link

@evan-morgan evan-morgan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@evan-morgan evan-morgan self-requested a review August 18, 2025 15:10
… readme to provide solution for players that have ldws disabled via setup, not just disabled by default
@jdmedlin1 jdmedlin1 requested a review from blshukla September 9, 2025 19:53
@jdmedlin1 jdmedlin1 merged commit 8e45b88 into main Sep 9, 2025
2 checks passed
@jdmedlin1 jdmedlin1 deleted the PE-1039 branch September 9, 2025 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants