---
title: BrightDev
slug: develop/brightdev
docTags: 
createdAt: 2026-01-30T16:59:19.537Z
---

::Image[]{src="https://api.archbee.com/api/optimize/0prk6SO2dy9LdU77jB8D1/vniF2Etd49qnVcH7VSWjt-20260130-185530.svg" darkSrc="https://archbee-image-uploads.s3.amazonaws.com/0prk6SO2dy9LdU77jB8D1/gRlsfpn1mf80J7z-w2YlW-20260130-185506.svg" size="30" width="284" height="140" darkWidth="284" darkHeight="140" position="center" showCaption="false"}

:::hint{type="success"}
The content below is pulled from the BrightDev README.md in GitHub and may not be current. For the most up-to-date README.md, click [here](https://github.com/BrightDevelopers/BrightDev/blob/main/README.md).
:::

# BrightDev

**Build your BrightSign integration in hours, not weeks.**

<font color="#6B21A8"></font>

<font color="#4283c7"></font>

[`DISCUSSIONS`](https://github.com/orgs/BrightDevelopers/discussions)

BrightDev is your starting point for BrightSign development. Complete SDK, working examples, and documentation that gets you to your first deployment in under 15 minutes.

## Getting Started

### Install the Brightsign MCP Server

We wrote this for AI assistants as much as for you. Connect your editor to our MCP server and get working BrightSign code on the first try.

**Claude Code:**

:::BlockQuote
claude mcp add brightdeveloper-docs --transport http https\://brightdeveloper-mcp.bsn.cloud/mcp
:::

**VS Code / Cursor:** Add to your MCP settings:

:::BlockQuote
\{
&#x20; "servers": \{
&#x20;   "brightdeveloper": \{
&#x20;     "type": "http",
&#x20;     "url": "https\://brightdeveloper-mcp.bsn.cloud/mcp"
&#x20;   }
&#x20; }
}
:::

An example prompt for generating BrightSign applications is provided in the [AI-Assisted Development](https://github.com/BrightDevelopers/BrightDev/blob/main/README.md#ai-assisted-development) section below.

## Integrating with BrightSign

Here's the recommended path to go from zero to production:

| **Stage**                                | **Goal**                             | **Start here**                                                                                        |
| ---------------------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| **1. Hello BrightSign on Single Player** | Deploy content in under 15 minutes   | [Hello BrightSign](https://github.com/BrightDevelopers/BrightDev/blob/main/examples/hello-brightsign) |
| **2. Single Player Deployment**          | Get your MVP deployed on 1 player    | 🚧 Coming Soon                                                                                        |
| **3. Multi-Player Deployment**           | Scale to a fleet                     | 🚧 Coming Soon                                                                                        |
| **4. Production**                        | Monitoring, metrics, and maintenance | 🚧 Coming Soon                                                                                        |

## Migration Guides

Already have an application built for another platform? Our migration guides help you port existing codebases to BrightSign.

| **Platform**             | **Description**                           | **Guide**                                                                                                             |
| ------------------------ | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| **Kotlin**               | Migrate Kotlin applications to BrightSign | [Kotlin Migration Guide](https://github.com/BrightDevelopers/BrightDev/blob/main/migration-guides/kotlin)             |
| **Progressive Web Apps** | Migrate Progressive Web Applications      | [PWA Migration Guide](https://github.com/BrightDevelopers/BrightDev/blob/main/migration-guides/progressive-web-app)   |
| **Electron**             | Migrate Electron applications             | [Electron Migration Guide](https://github.com/BrightDevelopers/BrightDev/blob/main/migration-guides/electron)         |
| **Flutter/Dart**         | Convert Flutter web apps to BrightSign    | [Flutter/Dart Migration Guide](https://github.com/BrightDevelopers/BrightDev/blob/main/migration-guides/flutter-dart) |
| **Tizen (Samsung)**      | Port Samsung Smart Signage Platform apps  | 🚧 Coming Soon                                                                                                        |

## AI-Assisted Development

The MCP server is a powerful tool that accelerates development, but it doesn't generate perfect code every time. You should:

- **Debug and iterate** on the generated code
- **Test thoroughly** on actual BrightSign hardware
- **Read the documentation** at [docs.brightsign.biz](https://docs.brightsign.biz) to understand BrightSign-specific APIs
- **Refine your prompts** based on the output - be specific about error messages and desired behavior

### Template Prompt for Building BrightSign Applications

Use this template with the BrightDeveloper MCP server to generate BrightSign applications:

:::BlockQuote
I want to create a BrightSign application with the following features:
\- \[Feature 1: e.g., Display rotating images from a remote API]
\- \[Feature 2: e.g., Show device information (model, serial number, firmware version)]
\- \[Feature 3: e.g., Play video content on a schedule]
\- \[Feature 4: e.g., Send analytics to a remote server]

Preferences:
\- Platform: \[BrightScript / HTML+JavaScript / Node.js v18/14]
\- Display Resolution: \[1920x1080 / 3840x2160 / other]
\- Network Requirements: \[WiFi / Ethernet / Both]
\- Storage: \[Local file system / Cloud-based]

Additional Requirements:
\- Include local development setup instructions
\- Add debugging and trace logging configuration
\- Provide instructions for deploying to BrightSign player
\- \[Any other specific requirements]
:::

**Common issues and how to address them:**

- API mismatches: Check [docs.brightsign.biz/developers/player-apis-brightscript-and-javascript](https://docs.brightsign.biz/developers/player-apis-brightscript-and-javascript) for correct syntax
- Module not found errors: Verify you're using BrightSign-supported Node.js modules
- Display issues: Ensure your HTML/CSS accounts for the player's resolution and GPU capabilities

For detailed development environment setup, debugging tools, and logging configuration, see [DEVELOPMENT.md](https://github.com/BrightDevelopers/BrightDev/blob/main/DEVELOPMENT.md).

## FAQ

### Should I use BrightScript or JavaScript?

- Use **BrightScript** for: Simple media playback, GPIO control, legacy compatibility
- Use **HTML/JavaScript/Node.js** for: Complex UIs, web content, API integrations, modern web frameworks

See [Player APIs: BrightScript and JavaScript](https://docs.brightsign.biz/developers/player-apis-brightscript-and-javascript) for details.

### How do I find my player's IP address?

1. **No storage boot** - Boot the player without any storage device; it displays its IP on screen
2. **DHCP server** - Check your router's DHCP client list
3. **Local DWS** - If enabled, browse to brightsign-\<SERIAL\_NUMBER>.local
4. **Serial/SSH** - Run ifconfigcommand
5. **BSN.cloud** - View in BrightSign Author or the BSN.Cloud web interface

See [Find a Player's IP Address](https://docs.brightsign.biz/how-tos/find-a-players-ip-address) for details.

### How do I enable the Local Diagnostic Web Server (DWS)?

1. **Via BrightAuthor\:Connected** - Enable in your BSN.Cloud setup
2. **Via BrightScript/JavaScript** - Enable programmatically in your application
3.

:::BlockQuote
registry write networking http\_server 80
registry flush
reboot
:::

**Via Serial Shell**:

See [DWS: Local Access](https://docs.brightsign.biz/advanced/dws-local-access) for details.

### How do I factory reset my player?

1. **SVC + RST Buttons** - Press & hold both buttons together during boot until the red power light rapidly flashes, release buttons and allow player to boot
2. **Via Local DWS** - Control → "Factory Reset"
3. **Via Serial Shell** - factoryreset confirm

**Warning:** This erases all content, settings, and user data.

See [Factory Reset a Player](https://docs.brightsign.biz/how-tos/factory-reset-a-player) for details.

### My player is stuck in a reboot loop. How do I recover?

1. **Replace SD card** - Insert a new SD card with recovery content (or no content)
2. **Serial shell recovery** - Connect via serial, press SVC key after "Starting BrightSign application..." message to access the shell

See [Stop a Continuously Rebooting Player](https://docs.brightsign.biz/how-tos/stop-a-continuously-rebooting-player) for details.

## Community & Support

- [BrightSign Documentation](https://docs.brightsign.biz) — Official BrightSign API and platform documentation
- [Contributing ](https://github.com/BrightDevelopers/BrightDev/blob/main/CONTRIBUTING.md)— Found a bug? Have an example?
- [BrightSign Support Community](https://support.brightsign.biz/hc/en-us/community/topics) — Hardware, BSN.Cloud, and developer support
