@signageos/front-applet 8.0.2 → 8.0.3

package/docs/fpath/index.md

@@ -6,7 +6,7 @@ sidebar_position: 99
 
 fpath utility mirrors node [path](https://nodejs.org/docs/latest/api/path.html)
 module, but accepts IFilePath type instead of strings. It is useful when
-working with [sos.filesystem](/sdk/sos/fileSystem).
+working with [sos.fileSystem](/sdk/sos/fileSystem).
 
 Not implemented functions:
 - format

package/docs/sos/browser.md

@@ -19,22 +19,6 @@ The `sos.browser` API groups together methods for working with the integrated we
 
 :::
 
-```ts
-sos.browser.open('https://www.signageos.io', {
-	aclDomains: ['google.com', 'yahoo.com'],
-	aclMode: 'blacklist', // or 'whitelist'
-	readOnlyAddressBar: true,
-	coordinates: { // Supported only on Linux and Android
-		x: 0,
-		y: 0,
-		height: 500,
-		width: 500,
-	},
-	// theme: { ... }
-	headlessMode: false,
-});
-```
-
 ## Methods
 
 ### close()
@@ -177,7 +161,7 @@ sos.browser.open('https://www.signageos.io', {
 
 ### ~openLink()~
 
-:::danger
+:::danger Deprecated
 
 This method was deprecated. use `sos.browser.open()` instead
 
@@ -227,4 +211,30 @@ type ITheme = {
     };
 };
 
+```
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	await sos.browser.open('https://www.signageos.io', {
+		aclDomains: ['google.com', 'yahoo.com'],
+		aclMode: 'blacklist', // or 'whitelist'
+		readOnlyAddressBar: true,
+		coordinates: {
+			// Supported only on Linux and Android
+			x: 0,
+			y: 0,
+			height: 500,
+			width: 500,
+		},
+		// theme: { ... } // supported only on Android
+		headlessMode: false, // supported only on Android
+	});
+
+	await sos.browser.close(); // Close the browser
+});
+
 ```

package/docs/sos/command.md

@@ -6,14 +6,6 @@ sidebar_position: 0
 
 The `sos.command` API groups together methods for sending logs and receiving commands from signageOS.
 
-```ts
-await sos.command.dispatch({
-  type: 'Files.StartLoading',
-  fileName: 'my-file',
-  fileType: 'txt'
-});
-```
-
 ## Methods
 
 ### dispatch()
@@ -77,4 +69,24 @@ interface ICommand {
 
 - [Receiving commands](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/command/receiving)
 
-:::
+:::
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	/* Example of dispatching information about file download */
+	await sos.command.dispatch({
+		type: 'Files.StartLoading', // mandatory *type* with custom value
+		fileName: 'my-file', // custom parameter and value
+		fileType: 'txt', // custom parameter and value
+	});
+
+	sos.command.onCommand((command) => {
+		console.log(`new command ${command.type} received, with data:`, command.command);
+	});
+});
+
+```

package/docs/sos/debug.md

@@ -26,4 +26,21 @@ The `onRemoteDebugChanged()` method sets up a listener, which is called whenever
 onRemoteDebugChanged(listener: (data: {
     enabled: boolean;
 }) => void): void;
+```
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	if (await sos.debug.isRemoteDebugEnabled()) {
+		console.log('Remote debug is turned on');
+	}
+
+	sos.debug.onRemoteDebugChanged((enabled) => {
+		console.log('Weinre debug is', { enabled });
+	});
+});
+
 ```

package/docs/sos/deviceInfo.md

@@ -50,4 +50,30 @@ interface IOrganizationTag {
     name: string;
 }
 
+```
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	await printLocation();
+	await printTags();
+});
+
+const printLocation = async () => {
+	const { name, customId, description } = (await sos.deviceInfo.getLocation()) ?? {};
+
+	console.log('Location: ', { name, customId, description });
+};
+
+const printTags = async () => {
+	const tags = await sos.deviceInfo.getOrganizationTags();
+
+	for (const { name } of tags) {
+		console.log('Tag: ', name);
+	}
+};
+
 ```

package/docs/sos/display.md

@@ -22,4 +22,21 @@ type DisplayCapability = 'FILE_SYSTEM_INTERNAL_STORAGE' | 'FILE_SYSTEM_EXTERNAL_
 
 type AnyString = string & {};
 
+```
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	const supports = await sos.display.supports('SERIAL');
+
+	if (supports) {
+		console.log('This device supports serial port.');
+	} else {
+		console.log('This device does NOT support serial port.');
+	}
+});
+
 ```

package/docs/sos/fileSystem.md

@@ -599,4 +599,50 @@ interface IStorageUnit {
 
 #### Possible errors
 
-The method throws an error if the parent directory does not exist or the `filePath` is a directory.
+The method throws an error if the parent directory does not exist or the `filePath` is a directory.
+
+## API Example
+
+```ts
+import { sos, fpath } from '@signageos/front-applet';
+import { IFilePath } from '@signageos/front-applet/es6/FrontApplet/FileSystem/types';
+
+void sos.onReady(async () => {
+	const [internal] = await sos.fileSystem.listInternalStorageUnits();
+
+	const root: IFilePath = {
+		storageUnit: internal,
+		filePath: '', // empty string points to root directory
+	};
+
+	// list files in the root directory
+	const contents = await sos.fileSystem.listFiles(root);
+
+	// print files from the root directory
+	for (const entries of contents) {
+		if (await sos.fileSystem.isDirectory(entries)) {
+			console.log(`${entries.filePath} (directory)`);
+		} else {
+			console.log(`${entries.filePath} (file)`);
+		}
+	}
+
+	// write data into a file
+	const writePath = fpath.join(root, 'value.json');
+	await sos.fileSystem.writeFile(writePath, JSON.stringify({ data: 'Lorem ipsum dolor sit amet' }));
+
+	// download a file from the internet and play it
+	const downloadPath = fpath.join(root, 'video.mp4');
+	await sos.fileSystem.downloadFile(
+		downloadPath,
+		'https://static.signageos.io/assets/test-videos-03_AME/video-test-03_15s_1920x1080_2fe7b039750a134aeac1c0a515710007.mp4',
+	);
+	const file = await sos.fileSystem.getFile(downloadPath);
+
+	if (file) {
+		await sos.video.prepare(file.filePath, 0, 0, 1920, 1080);
+		await sos.video.play(file.filePath, 0, 0, 1920, 1080);
+	}
+});
+
+```

package/docs/sos/hardware/index.md

@@ -69,4 +69,39 @@ interface ISerialPort {
 | `options.parity` *(optional)*   | `Parity`  | Specifies the form of error checking, whether (or what) extra bits are added to a byte.                             |
 | `options.databits` *(optional)* | `number`  | Specifies the number of bits in a byte.                                                                             |
 | `options.stopbits` *(optional)* | `number`  | Specifies the number of bits used to signal the end of a communication packet.                                      |
-| `options.rtscts` *(optional)*   | `boolean` | Enables or disables RTS/CTS handshaking over the serial port. Currently supported by selected models of BrightSign. |
+| `options.rtscts` *(optional)*   | `boolean` | Enables or disables RTS/CTS handshaking over the serial port. Currently supported by selected models of BrightSign. |
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	// Open default serial port based platform
+	const serialPort = await sos.hardware.openSerialPort({
+		baudRate: 115200,
+	});
+
+	await serialPort.close();
+});
+
+void sos.onReady(async () => {
+	// Open specific serial port
+	const serialPort = await sos.hardware.openSerialPort({
+		device: '/dev/ttyUSB0',
+		baudRate: 115200,
+	});
+
+	serialPort.onData((data) => {
+		const dataString = [...data].map((char) => String.fromCharCode(char)).join('');
+		console.log(dataString);
+	});
+
+	await serialPort.write('68656c6c6f'); // hexadecimal string
+	await serialPort.write([10, 20, 30, 40]); // array of numbers
+	await serialPort.write(Uint8Array.from([10, 20, 30, 40])); // Uint8Array
+
+	await serialPort.close();
+});
+
+```

package/docs/sos/hardware/led.md

@@ -15,4 +15,15 @@ The `setColor()` methods sets the LED color (if string is passed) or disabled (i
 
 ```ts expandable
 setColor(color: string | null): Promise<void>;
+```
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	await sos.hardware.led.setColor('#00FF00'); // For GREEN light
+});
+
 ```

package/docs/sos/index.md

@@ -8,17 +8,7 @@ sidebar_position: 0
   Learn more about using this API [here](https://developers.signageos.io/docs/applets/getting-started/#using-the-sos-sdk)
 </Admonition>
 
-The `sos` API groups together all functionality the
-
-```ts
-sos.onReady().then(async function () {
-  console.log(await sos.app.getType());
-});
-
-sos.onReady(async function () {
-  console.log(await sos.app.getType());
-});
-```
+The `sos` API groups together all functionality the \@signageos/front-applet offers.
 
 ## Properties
 
@@ -92,6 +82,12 @@ The `refresh()` method initializes refresh of the applet. Similar to window.loca
 refresh(): Promise<void>;
 ```
 
+#### Example
+
+```ts
+await sos.refresh();
+```
+
 <Separator />
 
 ### restore()
@@ -100,9 +96,15 @@ The `restore()` method clears all previously played videos, streams, clear displ
 is playing a loop with some specified duration. This method should be called always when the loop is changed. It will clear all
 previously played videos, streams, clear display views, and notify for garbage collection.
 
- It stops all video playback and clears out the memory. The following function should be triggered only in a case the whole playback
+It stops all video playback and clears out the memory. The following function should be triggered only in a case the whole playback
 needs to be restarted as it's completely switching the playback 'loop/playlist'.
 
 ```ts expandable
 restore(): void;
+```
+
+#### Example
+
+```ts
+sos.restore();
 ```

package/docs/sos/input.md

@@ -74,4 +74,17 @@ The `removeEventListeners()` method removes all event listeners bind on `sos.inp
 
 ```ts expandable
 removeEventListeners(): void;
+```
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	sos.input.onKeyUp((keyUpEvent) => {
+		console.log(`Pressed: ${keyUpEvent.keyCode} (${keyUpEvent.keyName})`);
+	});
+});
+
 ```

package/docs/sos/monitors.md

@@ -4,7 +4,7 @@ sidebar_position: 0
 
 # monitors
 
-The `sos.management.monitors` API groups together methods for providing information about monitors connected to the device.
+The `sos.monitors` API groups together methods for providing information about monitors connected to the device.
 
 ## Methods
 
@@ -22,4 +22,19 @@ interface IConnectedMonitor {
     firmware?: string;
 }
 
+```
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	const monitors = await sos.monitors.getList();
+
+	for (const { model, manufacturer, serial } of monitors) {
+		console.log('Connected monitor: ', { model, manufacturer, serial });
+	}
+});
+
 ```

package/docs/sos/native/mdc.md

@@ -18,15 +18,6 @@ You can ensure that the device supports MDC commands via `sos.management.support
 
 :::
 
-```ts
-await sos.native.mdc.sendOne('localhost', CodesMDC.BRIGHTNESS_CONTROL); // Promise<IMDCResponse>
-await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.VOLUME_CONTROL, [50]); // Promise<IMDCResponse>
-await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.PICTURE_CONTROL, [0x54, 0x03]); // Promise<IMDCResponse>
-
-// You can also send custom number if we don't have predefined command in our enum
-await sos.native.mdc.sendOne('192.168.0.10', 0x01, []); // Promise<IMDCResponse>
-```
-
 ## Methods
 
 ### sendOne()

package/docs/sos/offline/index.md

@@ -16,20 +16,6 @@ Emulator has certain limitations while handling offline files. [Read more here](
 
 :::
 
-```ts
-await sos.offline.addFile([{
-	uri: 'https://unpkg.com/normalize.css@8.0.1/normalize.css',
-	uid: 'normalize.css',
-	type: sos.offline.types.css,
-	flags: [sos.offline.flags.append(document.head)],
-}, {
-	uri: 'https://code.jquery.com/jquery-3.7.1.slim.min.js',
-	uid: 'jquery-3.7.1.slim.min.js',
-	type: sos.offline.types.javascript,
-	flags: [sos.offline.flags.append(document.body)],
-}]);
-```
-
 ## Methods
 
 ### addFile()

package/docs/sos/osd.md

@@ -14,4 +14,19 @@ The `showOSD()` method opens the OSD without typing the pin.
 
 ```ts expandable
 showOSD(): Promise<void>;
+```
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(() => {
+	sos.input.onKeyUp(async (e) => {
+		if (e.keyName === 'BLUE') {
+			await sos.osd.showOSD();
+		}
+	});
+});
+
 ```

package/docs/sos/proofOfPlay.md

@@ -4,18 +4,6 @@ sidebar_position: 0
 
 # proofOfPlay
 
-```ts
-await sos.proofOfPlay.recordItemPlayed({
-  name: 'generic-brand-christmas-coffee-ad',
-  customId: 'dBE43bFB3312VFfvd34bgGHJVV334cd2',
-  type: 'video',
-  tags: ['generic-brand', 'christmas'],
-  fileName: 'coffee.mp4',
-  playbackSuccess: false,
-  errorMessage: 'Unsupported framerate 60fps',
-});
-```
-
 ## Methods
 
 ### recordItemPlayed()
@@ -38,16 +26,21 @@ interface IRecordItemOptions {
 
 ```
 
-#### Example
+## API Example
 
 ```ts
-await sos.proofOfPlay.recordItemPlayed({
-  name: 'generic-brand-christmas-coffee-ad',
-  customId: 'dBE43bFB3312VFfvd34bgGHJVV334cd2',
-  type: 'video',
-  tags: ['generic-brand', 'christmas'],
-  fileName: 'coffee.mp4',
-  playbackSuccess: false,
-  errorMessage: 'Unsupported framerate 60fps',
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	await sos.proofOfPlay.recordItemPlayed({
+		name: 'generic-brand-christmas-coffee-ad',
+		customId: 'dBE43bFB3312VFfvd34bgGHJVV334cd2',
+		type: 'video',
+		tags: ['generic-brand', 'christmas'],
+		fileName: 'coffee.mp4',
+		playbackSuccess: false,
+		errorMessage: 'Unsupported framerate 60fps',
+	});
 });
+
 ```

package/docs/sos/sync.md

@@ -7,20 +7,6 @@ sidebar_position: 0
 The `sos.sync` API groups together methods for synchronization of multiple devices. Devices are synchronized either through an external
 server or one of the devices becomes a master device.
 
-```ts
-// use default engine
-await sos.sync.connect();
-
-// use sync-server engine and default server
-await sos.sync.connect({ engine: 'sync-server' });
-
-// use sync-server engine and custom server
-await sos.sync.connect({ engine: 'sync-server', uri: syncServerUri });
-
-// use p2p-local engine
-await sos.sync.connect({ engine: 'p2p-local' });
-```
-
 ## Methods
 
 ### broadcastValue()
@@ -277,7 +263,7 @@ wait(data?: any, groupName?: string, timeout?: number): Promise<any>;
 
 ### ~connect(options)~
 
-:::danger
+:::danger Deprecated
 
 This method was deprecated. Use `connect({ engine: 'sync-server' })` instead.
 
@@ -291,7 +277,7 @@ connect(options?: string): Promise<void>;
 
 ### ~init()~
 
-:::danger
+:::danger Deprecated
 
 This method was deprecated. use `sos.sync.joinGroup()` instead.
 
@@ -305,7 +291,7 @@ init(groupName?: string, deviceIdentification?: string): Promise<void>;
 
 ### ~setValue()~
 
-:::danger
+:::danger Deprecated
 
 This method was deprecated. use `sos.sync.broadcastValue()` instead.
 

package/docs/sos_management/audio.md

@@ -30,4 +30,17 @@ setVolume(volume: number): Promise<void>;
 
 | Name     | Type     | Description              |
 |----------|----------|--------------------------|
-| `volume` | `number` | Value between 0 and 100. |
+| `volume` | `number` | Value between 0 and 100. |
+
+## API Example
+
+```ts
+import { sos } from '@signageos/front-applet';
+
+void sos.onReady(async () => {
+	await sos.management.audio.getVolume(); // Returns number e.g. 39
+
+	await sos.management.audio.setVolume(90);
+});
+
+```

package/docs/sos_management/firmware.md

@@ -18,6 +18,13 @@ This information, when combined with firmware version, can be used to identify a
 getType(): Promise<string>;
 ```
 
+#### Example
+
+```ts
+const type = await sos.management.firmware.getType();
+console.log(type); // e.g. rpi4
+```
+
 <Separator />
 
 ### getVersion()
@@ -28,6 +35,13 @@ The `getVersion()` method returns the version of the firmware currently installe
 getVersion(): Promise<string>;
 ```
 
+#### Example
+
+```ts
+const version = await sos.management.firmware.getVersion();
+console.log(version); // Returns String e.g. T-HKMLAKUC-2020.5
+```
+
 <Separator />
 
 ### upgrade(baseUrl, version)
@@ -45,6 +59,12 @@ upgrade(baseUrl: string, version: string): Promise<void>;
 | `baseUrl` | `string` | The server URL where firmware files are located. |
 | `version` | `string` | The version of the firmware being installed.     |
 
+#### Example
+
+```ts
+await sos.management.firmware.upgrade('https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem', 'T-HKMLAKUC-2080.4');
+```
+
 <Separator />
 
 ### upgrade(fwUri)
@@ -70,6 +90,12 @@ upgrade(fwUri: string): Promise<void>;
 |---------|----------|--------------------------------------------------|
 | `fwUri` | `string` | FQN uri where the firmware main file is located. |
 
+#### Example
+
+```ts
+await sos.management.firmware.upgrade('https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem');
+```
+
 <Separator />
 
 ### upgrade(version, baseUrl)

package/docs/sos_management/index.md

@@ -181,7 +181,7 @@ type AnyString = string & {};
 
 ### ~getNetworkInfo()~
 
-:::danger
+:::danger Deprecated
 
 This method was deprecated. Use `sos.management.network.listInterfaces()` instead.
 

package/docs/sos_management/network.md

@@ -124,7 +124,7 @@ interface INetworkOptions {
 
 ### ~getActiveInfo()~
 
-:::danger
+:::danger Deprecated
 
 This method was deprecated. Use `sos.management.network.listInterfaces()` instead.
 
@@ -162,7 +162,7 @@ type NetworkInterface = 'wifi' | 'ethernet';
 
 ### ~setDHCP(networkInterface)~
 
-:::danger
+:::danger Deprecated
 
 This method was deprecated. Use `sos.management.network.setDHCP(interfaceName)` instead.
 
@@ -179,7 +179,7 @@ type NetworkInterface = 'wifi' | 'ethernet';
 
 ### ~setManual(options)~
 
-:::danger
+:::danger Deprecated
 
 This method was deprecated. Use `sos.management.network.setManual(interfaceName, options)` instead.