---
title: system
slug: develop/system
docTags: 
createdAt: 2025-03-27T16:56:36.409Z
---

The *system *object provides functions related to the system software.

**system IDL**

```javascript
interface System {
    void reboot();
    void factoryReset();
    void rebootWithCrashReport();
    Promise<void> setImageSizeThreshold(Size size);
    Promise<bool> resetSshHostKeys();
};

interface Size {
    attribute int width;
    attribute int height;
};
```

## Object Creation

To create a *system* object, first load the `brightsign/system` module using the `require()` method. Then create an instance of the *system* class.

```javascript
var systemClass = require("@brightsign/system");
var system = new systemClass();
```

## System

Use this interface to call system-software methods.

**reboot()**

```javascript
 void reboot()
```

Instructs the player to perform a soft reboot.

**factoryReset()**

```javascript
 void factoryReset()
```

Instructs the player to perform a factory reset.

**rebootWithCrashReport()**

```javascript
 void rebootWithCrashReport()
```

Instructs the player to perform a reboot with a crash report.

**suspend()**

```javascript
 void suspend()
```

Puts the player into low power mode, if it is supported on the platform. The player will turn off peripherals and most of the core functionality to save power. It can be woken up with RST, SVC button, or other platform-dependent wake up sources(RTC, Wake-On-Lan etc.). Available as of BOS 9.0.168.

**setImageSizeThreshold()**

```javascript
Promise<void> setImageSizeThreshold(Size size)
```

Changes the maximum allowed resolution for images. This method accepts a *Size&#x20;*&#x69;nterface specifying the new allowed resolution.

The default image resolution limit is 2048x1280x32bpp (or 4096x2160x32bpp for XTx44, XTx43, XDx34, XDx33, 4Kx42 players). Displaying images larger than the default value may deplete the graphics memory and cause a crash, so we recommend testing a script that uses this method thoroughly before deploying it in a production environment.

:::hint{type="success"}
Without altering the default maximum resolution, you can increase the maximum width of images by sacrificing height (e.g. using a 4096x640x32bpp image on non-4K-capable players is allowed). You can also increase the maximum width/height by reducing the bpp value (e.g. using a 4096x1280x16bpp on non-4K-capable players is allowed).
:::

**resetSshHostKeys()**

Erases all the SSH server host keys and resolves the promise with true if a reboot is required for the server to start using the new keys or false if not. If the method fails then the promise is rejected. Available as of BOS 9.1.75.2 and BOS 9.0.2.14 and higher.

## Size

This interface describes the dimensions of an image.

- `width` <font color="#6554c0">int</font>: The width of the image
- `height` <font color="#6554c0">int</font>: The height of the image

## Example

```javascript
var systemClass = require("@brightsign/system");
var system = new systemClass();

imageSize = {};
imageSize.width = 4224;
imageSize.height = 2376;

system.setImageSizeThreshold(imageSize).then(
        console.log("Image threshold configured."))
    .catch(
        function(data) {
            console.log(JSON.stringify(data));
        });

```