import {System} from 'nextion/src/system.js'

public class | source

System

System-level Nextion device functionality.

Constructor Summary

Public Constructor
public	constructor(uart: UART) Creates a System instance.

Public Members
public	uart: *

Public Methods
public	random(min: number, max: number): Promise<ResponseResult, TypeError> Gets a random value, optionally setting the allowed range via System#setRandomRange.
public	setNoTouchSleepTimer(ms: number): Promise<ResponseResult, Error> Set sleep timer when not touched.
public	setRandomRange(min: number, max: number): Promise<ResponseResult, TypeError> Sets the range of results returned by System#random.
public	setSystemVariable(name: string, value: number): Promise<ResponseResult, TypeError> Sets value of system variable.
public	sleep(shouldSleep: boolean): Promise<ResponseResult, Error> Puts Nextion to sleep.
public	wake(): Promise<ResponseResult, Error> Wakes Nextion from sleep.

Creates a System instance.

Name	Type	Attribute	Description
uart	UART		UART instance.

Gets a random value, optionally setting the allowed range via System#setRandomRange.

Name	Type	Attribute	Description
min	number	optional default: 0	Unsigned integer; no greater than `max`
max	number	optional default: 0	Unsigned integer; no less than `min`

Result or error if invalid range supplied

Set sleep timer when not touched.

Name	Type	Attribute	Description
ms	number		Sleep after `ms` milliseconds of no touching. Rounded to closest second.

Result

Sets the range of results returned by System#random.

Name	Type	Attribute	Description
min	number	optional default: 0	Unsigned integer; no greater than `max`
max	number	optional default: 4294967295	Unsigned integer; no less than `min`

Response or {@link TypeError} if invalid min or max value

Sets value of system variable.

Name	Type	Attribute	Description
name	string		Name of system variable; either `sys0`, `sys1`, or `sys2`.
value	number		Must be an unsigned integer less than or equal to `4294967295`.