Home Reference Source Test Repository 
import {Nextion} from 'nextion/src/nextion.js'
public class | source

Nextion

Extends:

EventEmitter → Nextion

High-level abstraction for interacting with a Nextion device.

Constructor Summary

Public Constructor
public

constructor(uart: UART, opts: Object | Function, connectListener: Function)

Begins listening for data via a UART instance.

Member Summary

Public Members
public

System-level Nextion commands

Method Summary

Public Methods
public

Closes connection to Nextion device.
public

Sets a the value of a local component
public

setValue(name: string, value: *): Promise<ResponseResult>

Sets a local or global variable on the current page to a value

Public Constructors

public constructor(uart: UART, opts: Object | Function, connectListener: Function) source

Begins listening for data via a UART instance.

Params:

NameTypeAttributeDescription
uart UART

UART instance
opts Object | Function
  • optional

Options or connectListener
connectListener Function
  • optional

Callback to run when listening for Nextion data

Emit:

error

When binding via uart fails

Throw:

ReferenceError

When uart is missing

Public Members

public system: System source

System-level Nextion commands

Public Methods

public close(): Promise<Nextion> source

Closes connection to Nextion device.

Return:

Promise<Nextion>

This instance

public setComponentValue(name: string, value: *): Promise<ResponseResult> source

Sets a the value of a local component

Params:

NameTypeAttributeDescription
name string

Name of component
value *
  • optional

New component value

Return:

Promise<ResponseResult>

Result

public setValue(name: string, value: *): Promise<ResponseResult> source

Sets a local or global variable on the current page to a value

Params:

NameTypeAttributeDescription
name string

Name of variable
value *
  • optional

New variable value

Return:

Promise<ResponseResult>

Result