@signageos/front-applet 8.0.2 → 8.1.0

package/docs/sos_management/package.md

@@ -6,15 +6,6 @@ sidebar_position: 0
 
 The `sos.management.package` API groups together methods for installing custom Android packages.
 
-```ts
-await sos.management.package.install(
-  'https://cdn.your-cms.com',
-  'io.signageosWebView.app.ota',
-  '2.4.0',
-  'benq'
-);
-```
-
 ## Methods
 
 ### install()
@@ -34,13 +25,13 @@ install(baseUrl: string, packageName: string, version: string, build: string | n
 | `version`     | `string`         | Package version                    |
 | `build`       | `string \| null` | If relevant for your device        |
 
-#### Example
+## API Example
 
 ```ts
-await sos.management.package.install(
-  'https://cdn.your-cms.com',
-  'io.signageosWebView.app.ota',
-  '2.4.0',
-  'benq'
-);
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	await sos.management.package.install('https://cdn.your-cms.com', 'io.signageosWebView.app.ota', '2.4.0', 'benq');
+});
+
 ```

package/docs/sos_management/power.md

@@ -17,6 +17,28 @@ The `appRestart()` method initializes a restart of the signageOS app.
 appRestart(): Promise<void>;
 ```
 
+#### Example
+
+```ts
+await sos.management.power.appRestart();
+```
+
+<Separator />
+
+### clearScheduledReboots()
+
+Removes all scheduled reboot rules from the device.
+
+```ts expandable
+clearScheduledReboots(): Promise<void>;
+```
+
+#### Example
+
+```ts
+await sos.management.power.clearScheduledReboots();
+```
+
 <Separator />
 
 ### getProprietaryTimers()
@@ -36,6 +58,39 @@ interface IProprietaryTimer {
 
 ```
 
+#### Example
+
+```ts
+const timers = await sos.management.power.getProprietaryTimers();
+```
+
+<Separator />
+
+### getScheduledReboots()
+
+Returns all scheduled reboot rules on the device.
+
+```ts expandable
+getScheduledReboots(): Promise<IScheduledRebootActions[]>;
+// show-more
+interface IScheduledRebootActions {
+    id: string;
+    rule: IScheduledRebootRule;
+}
+
+interface IScheduledRebootRule {
+    weekdays: number[] | string[];
+    time: string;
+}
+
+```
+
+#### Example
+
+```ts
+await sos.management.power.getScheduledReboots();
+```
+
 <Separator />
 
 ### getTimers()
@@ -55,6 +110,38 @@ interface ITimer {
 
 ```
 
+#### Example
+
+```ts
+const timers = await sos.management.power.getTimers();
+```
+
+<Separator />
+
+### removeScheduledReboot()
+
+Removes scheduled reboot rule from the device.
+
+```ts expandable
+removeScheduledReboot(id: string): Promise<void>;
+```
+
+#### Params
+
+| Name | Type     | Description                     |
+|------|----------|---------------------------------|
+| `id` | `string` | - ID of the rule to be removed. |
+
+#### Example
+
+```ts
+// Get scheduled reboots
+const scheduledReboots = await sos.management.power.getScheduledReboots();
+
+// Remove scheduled reboot
+await sos.management.power.removeScheduledReboot(scheduledReboots[0].id);
+```
+
 <Separator />
 
 ### setProprietaryTimer()
@@ -76,6 +163,48 @@ setProprietaryTimer(type: ProprietaryTimerType, timeOn: string | null, timeOff:
 | `weekdays`                       | `string[]`          | The days of the week when the timer should be active (`mon`, ..., `sun`).               |
 | `keepAppletRunning` *(optional)* | `boolean`           | If `true`, the applet will be kept running when the timer is active on certain devices. |
 
+#### Example
+
+```ts
+await sos.management.power.setProprietaryTimer("TIMER_20", "08:00", "22:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], 30);
+```
+
+<Separator />
+
+### setScheduledReboot()
+
+Schedule automatic reboot on the device. Calling this function will create one rule.
+It is possible to set multiple rules, which can be later obtained by `getScheduledReboots` function.
+
+:::note
+- Setting new scheduled reboot on device might take up to 10 minutes to show in Box.
+- Every new scheduled reboot rule gets unique identifier generated by device, it might be later returned by `getScheduledReboots()`.
+:::
+
+```ts expandable
+setScheduledReboot(weekdays: WeekdayType[], time: string): Promise<void>;
+// show-more
+type WeekdayType = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
+
+```
+
+#### Params
+
+| Name       | Type            | Description                                                      |
+|------------|-----------------|------------------------------------------------------------------|
+| `weekdays` | `WeekdayType[]` |                                                                  |
+| `time`     | `string`        | - Time when the reboot should be executed. Format is `HH:mm:ss`. |
+
+#### Example
+
+```ts
+// Schedule reboot every Monday at 3:00 AM
+await sos.management.power.setScheduledReboot(["MONDAY"], "03:00:00");
+
+// Schedule reboot every Monday and Friday at 7:30 PM / 19:30
+await sos.management.power.setScheduledReboot(["MONDAY", "FRIDAY"], "19:30:00");
+```
+
 <Separator />
 
 ### setTimer()
@@ -96,6 +225,12 @@ setTimer(type: keyof typeof TimerType, timeOn: string | null, timeOff: string |
 | `weekdays` | `string[]`                                                                                | The days of the week when the timer should be active (`mon`, ..., `sun`). |
 | `volume`   | `number`                                                                                  | The volume level set when the device is turned on.                        |
 
+#### Example
+
+```ts
+await sos.management.power.setTimer("TIMER_1", "08:00", "22:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], 30);
+```
+
 <Separator />
 
 ### systemReboot()
@@ -106,6 +241,12 @@ The `systemReboot()` method initializes a system reboot.
 systemReboot(): Promise<void>;
 ```
 
+#### Example
+
+```ts
+await sos.management.power.systemReboot();
+```
+
 <Separator />
 
 ### unsetProprietaryTimer()
@@ -123,6 +264,12 @@ unsetProprietaryTimer(type: ProprietaryTimerType): Promise<void>;
 |--------|---------------------|----------------------------------------------------|
 | `type` | ``TIMER_${number}`` | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
 
+#### Example
+
+```ts
+await sos.management.power.unsetProprietaryTimer("TIMER_2");
+```
+
 <Separator />
 
 ### unsetTimer()
@@ -137,4 +284,10 @@ unsetTimer(type: keyof typeof TimerType): Promise<void>;
 
 | Name   | Type                                                                                      | Description                                        |
 |--------|-------------------------------------------------------------------------------------------|----------------------------------------------------|
-| `type` | `"TIMER_1" \| "TIMER_2" \| "TIMER_3" \| "TIMER_4" \| "TIMER_5" \| "TIMER_6" \| "TIMER_7"` | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
+| `type` | `"TIMER_1" \| "TIMER_2" \| "TIMER_3" \| "TIMER_4" \| "TIMER_5" \| "TIMER_6" \| "TIMER_7"` | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
+
+#### Example
+
+```ts
+await sos.management.power.unsetTimer("TIMER_2");
+```

package/docs/sos_management/proxy.md

@@ -14,6 +14,12 @@ The `disable()` method disables the proxy on the device.
 disable(): Promise<void>;
 ```
 
+#### Example
+
+```ts
+await sos.management.proxy.disable();
+```
+
 <Separator />
 
 ### getConnectedTo()
@@ -24,6 +30,13 @@ The `getConnectedTo()` methods returns the current connected proxy server uri on
 getConnectedTo(): Promise<string>;
 ```
 
+#### Example
+
+```ts
+const uri = await sos.management.proxy.getConnectedTo();
+console.log(uri); // 178.62.193.192
+```
+
 <Separator />
 
 ### isEnabled()
@@ -34,6 +47,12 @@ The `isEnabled()` method returns whether the proxy is enabled on the device.
 isEnabled(): Promise<boolean>;
 ```
 
+#### Example
+
+```ts
+const enabled = await sos.management.proxy.isEnabled();
+```
+
 <Separator />
 
 ### setManual()
@@ -42,4 +61,10 @@ The `setManual()` method sets the proxy on the device.
 
 ```ts expandable
 setManual(uri: string, port: number, username?: string, password?: string): Promise<void>;
+```
+
+#### Example
+
+```ts
+const enabled = await sos.management.proxy.setManual('178.62.193.192', 1080, 'username', 'password');
 ```

package/docs/sos_management/remoteControl.md

@@ -16,6 +16,12 @@ The `disable()` method disables remote control.
 disable(): Promise<void>;
 ```
 
+#### Example
+
+```ts
+await sos.management.remoteControl.disable();
+```
+
 <Separator />
 
 ### enable()
@@ -35,6 +41,12 @@ Always set the Remote Control Lock to `enable` after the deployment.
 enable(): Promise<void>;
 ```
 
+#### Example
+
+```ts
+await sos.management.remoteControl.enable();
+```
+
 <Separator />
 
 ### isEnabled()
@@ -45,6 +57,12 @@ The `isEnabled()` method returns whether the remote control is enabled.
 isEnabled(): Promise<boolean>;
 ```
 
+#### Example
+
+```ts
+const enabled = await sos.management.remoteControl.isEnabled();
+```
+
 <Separator />
 
 ### isLocked()
@@ -55,6 +73,12 @@ The `isLocked()` method returns whether the remote control is locked (disabled).
 isLocked(): Promise<boolean>;
 ```
 
+#### Example
+
+```ts
+const locked = await sos.management.remoteControl.isLocked();
+```
+
 <Separator />
 
 ### lock()
@@ -65,6 +89,12 @@ The `lock()` method is an alias for the `disable()` method.
 lock(): Promise<void>;
 ```
 
+#### Example
+
+```ts
+await sos.management.remoteControl.lock();
+```
+
 <Separator />
 
 ### unlock()
@@ -73,4 +103,10 @@ The `unlock()` method is an alias for the `enable()` method.
 
 ```ts expandable
 unlock(): Promise<void>;
+```
+
+#### Example
+
+```ts
+await sos.management.remoteControl.unlock();
 ```

package/docs/sos_management/screen.md

@@ -25,24 +25,6 @@ There is a specific behavior based on the device type you operate:
 
 :::
 
-```ts
-// for Tizen
-await sos.management.screen.resize(
-    "https://cdn.your-cms.com/tizen/1.0.4",
-    "PORTRAIT",
-    "FULL_READY",
-    "1.0.4"
-);
-
-// for all other supported device
-await sos.management.screen.resize(
-    "",
-    "PORTRAIT",
-    "HD_READY",
-    ""
-);
-```
-
 ## Methods
 
 ### getBrightness()
@@ -92,7 +74,7 @@ isPoweredOn(): Promise<boolean>;
 
 ### powerOff()
 
-The `powerOff()` method turn the screen off.
+The `powerOff()` method turn the screen off. It will turn off the display backlight and the panel, and it will also disable applet.
 
 :::warning
 
@@ -201,7 +183,7 @@ await sos.management.screen.setBrightness(
 
 <Separator />
 
-### takeAndUploadScreenshot()
+### takeAndUploadScreenshot(uploadBaseUrl, computeHash)
 
 The `takeAndUploadScreenshot()` method takes a screenshot and uploads it to a specified url. This can be either a signageOS upload url
 (`https://upload.signageos.io`) or a dedicated server url for uploading screenshots. Format in which the screenshot is uploaded may be
@@ -215,6 +197,39 @@ To implement a custom screenshot upload server, it needs to implement these endp
 signageOS provides standalone server which is implements all of those methods. It is provided to all of our partners through the
 [support ticketing system](https://box.signageos.io/support/).
 
+```ts expandable
+takeAndUploadScreenshot(uploadBaseUrl: string, computeHash?: boolean): Promise<{
+    screenshotUrl: string;
+    aHash?: string;
+}>;
+```
+
+#### Params
+
+| Name                       | Type      | Description                                                                                                   |
+|----------------------------|-----------|---------------------------------------------------------------------------------------------------------------|
+| `uploadBaseUrl`            | `string`  | URL to which the screenshot will be uploaded. It can be either a signageOS upload url or a custom server url. |
+| `computeHash` *(optional)* | `boolean` | Whether to compute a hash of the screenshot and return it in the response.                                    |
+
+#### Example
+
+```ts
+const { screenshotUrl, aHash } = await sos.management.screen.takeAndUploadScreenshot(
+   'https://your.upload.server/upload/file?prefix=screenshot/',
+   true,
+);
+```
+
+<Separator />
+
+### ~takeAndUploadScreenshot(uploadBaseUrl)~
+
+:::danger Deprecated
+
+This method was deprecated. Use `takeAndUploadScreenshot(uploadBaseUrl: string, computeHash?: boolean): Promise<{ screenshotUrl: string; aHash?: string }>` instead.
+
+:::
+
 ```ts expandable
 takeAndUploadScreenshot(uploadBaseUrl: string): Promise<string>;
 ```

package/docs/sos_management/time.md

@@ -27,11 +27,14 @@ interface IGetTime {
 
 ### setManual(dateTime, timezone)
 
-The `setManual()` method sets the system time and the system timezone.
+The `setManual()` method sets the system time and the system timezone and disables NTP server settings.
 
-:::warning
+:::warning Setting NTP server and timezone has side effects
 
-This method will disable NTP server settings.
+- **Tizen**: After calling this API, display Reboots!
+  Tizen has limited set of available timezones. Read more here.
+- **RaspberryPi**: After calling this API, RPi Reboots backend server which can take up to 60 seconds! During the reboot no JS API is
+  available. **Always wait for Promise resolution.**
 
 :::
 
@@ -65,6 +68,15 @@ interface DateTime {
 
 The `setNTP()` method sets the NTP server and the system timezone.
 
+:::warning Setting NTP server and timezone has side effects
+
+- **Tizen / WebOS**: After calling this API, display Reboots!
+  Tizen has limited set of available timezones. Read more here.
+- **RaspberryPi**: After calling this API, RPi Reboots backend server which can take up to 60 seconds! During the reboot no JS API is
+  available. **Always wait for Promise resolution.**
+
+:::
+
 ```ts expandable
 setNTP(ntpServer: string, timezone: string): Promise<void>;
 ```
@@ -80,7 +92,7 @@ setNTP(ntpServer: string, timezone: string): Promise<void>;
 
 ### ~set()~
 
-:::danger
+:::danger Deprecated
 
 This method was deprecated. Use `setManual(dateTime, timezone)` instead.
 
@@ -94,7 +106,7 @@ set(currentDate: Date, timezone: string): Promise<void>;
 
 ### ~setManual(currentDate, timezone)~
 
-:::danger
+:::danger Deprecated
 
 This method was deprecated. Use `setManual(dateTime, timezone)` instead.
 
@@ -102,4 +114,32 @@ This method was deprecated. Use `setManual(dateTime, timezone)` instead.
 
 ```ts expandable
 setManual(currentDate: Date, timezone: string): Promise<void>;
+```
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	const { currentDate, timezone, ntpServer } = await sos.management.time.get();
+	console.log({ currentDate, timezone, ntpServer });
+
+	// Set the time without a ntp server
+	await sos.management.time.setManual(
+		{
+			year: 2025,
+			month: 5,
+			day: 23,
+			hour: 13,
+			minute: 0,
+			second: 0,
+		},
+		'Europe/Amsterdam',
+	);
+
+	// Set the time with a ntp server
+	await sos.management.time.setNTP('pool.ntp.org', 'Europe/Amsterdam');
+});
+
 ```