Difference between revisions of "Nextion Instruction Set"

From ITEAD Wiki
Jump to: navigation, search
m (→‎ref_star)
m (→‎ref_stop)
Line 56: Line 56:
 
ref_stop: stop refreshing screen
 
ref_stop: stop refreshing screen
 
*Instance  
 
*Instance  
−
<pre>ref_stop  // no parameter</pre>
+
<pre>ref_stop  // no parameters</pre>
 
Remarks:
 
Remarks:
  

Revision as of 09:36, 10 March 2016

Note:

1. The instruction is end with three bytes "0xff 0xff 0xff"

2. All the instrucitons and parametners are in ASCII

3. All the instrucitons are in lowercase letters

Classification I: Operation Commands of Component and System

page pageid

pageid: Page ID or Page Name

  • Instance 1: 
page 0         //Refresh the page with page ID of 0
  • Instance 2: 
page main    //Refresh the page with page name of main

Remarks:

The device automatically refresh page 0 when power on.

ref cmpID

cmpID: component ID or component name

  • Instance 
ref t0   //refresh component t0

Remarks:

The default loading mode is automatically load when you create and edit a component in Nextion Editor. If set it as manually load, you should use ref command to load the component. Or when the component is covered by the other components, you can use this command to refresh the covered component.

ref 0

ref 0: refresh all components of the current page

Remarks:

If you refresh one of the components,the component will be on the first top,but covers the others.Use this command "ref 0" will be work well.

ref ob jname

ref ob jname: refresh component

ob jname: component name

  • Instance 
ref t0   //refresh component t0

Remarks:

1. Component auto refresh when attribute changes only valid for those attributes in green bold font. The other attributes not in this format can only be refreshed and displayed by the command of ref.

2.When creating a component in Nextion editor, the default loading mode is auto loading. When the loading mode is set as manual loading, it requires to use ref to load. When the component is sheltered by GUI command mapping, or when the component is sheltered by other manual loading components, you can use ref to refresh the component.

ref_stop

ref_stop: stop refreshing screen

  • Instance 
ref_stop   // no parameters

Remarks:

1.If you do not want to see the whole waveform flow progress, rather, you want to view the whole waveform all at once, you can stop refreshing the screen and refresh it when all adopted points being passed through.

2.Once stop refreshing the screen, all other commands and responded attribute assign operations will still run normally, but the components on the screen will not auto-refresh, neither will any changes in component attributes be refreshed and displayed on the screen(the changes are valid). When the device receive the command ref_star, those changes will be immediately refreshed and displayed on the screen (on condition that the changes are made from the attributes in green bold font).

3.When stop refreshing the screen, ref command will still be executed. Besides, all GUI drawing instructions such as draw point, draw line will still be executed and any changes will be immediately displayed.

ref_star

ref_star: recover refreshing screen

  • Instance 1 
ref_star   // no parameters

Remarks:

This command should be used with ref_stop command.

get att

att: Name of Variable

  • Instance 1 
get t0.txt      //return t0's txt value
  • Instance 2 
get j0.val    //return J0's val value
  • Instance 3 
get "123"      //return constant string "123"
  • Instance 4 
get 123      //return constant value: 123

Remarks:

1. When returned value is a string, the returned data is 0X70+ASCII code+0xff 0xff 0xff.

2. When returned value is numerical, returned data is 0X71+4 byte binary data+0xff 0xff 0xff. The data storage mode is little-endian mode (namely, low-order in front, and high-order at back).

3. The specific returning format of data, please refer to the table: Format of Device Return Data

sendme

  • Instance: 
sendme  //No parameter

Remarks:

If you want the page auto-send pageID every refresh, simply enter sendme in page initialize event.

cov

cov: variable type conversion

cov att1, att2, lenth

att1: source variable

att2: target variable

lenth: length of the string(0 is automatic length, not- 0 is fixed length)

  • Instance 1: 
cov h0.val, t0.txt, 0  //convert the value variable of slider h0 val into decimal string and assign the txt variable of t0, the length is automatic
  • Instance 2: 
cov t0.txt, j0.val, 0  //convert the string variable of t0 txt into value and assign the variable of slider h0 val, the length is automatic

Remarks:

1.lenth always represents the length of the string, when the value converts into string, it is the length of target variable; when the string converts into value, it is the length of source variable.

2. If the target variable and source variable are of the same type, the conversion failed.

touch_j

touch_j: calibrate touch

  • Instance 1: 
touch_j   //Enter touch calibration function, this command does not need parameter

Remarks:

All the devices have been calibrated, this command is not needed under normal circumstances

vis

vis;hide/show component

vis obj, state

obj: component name or component ID

  • Instance 1: 
vis b0, 0   //hide component b0
  • Instance 2: 
vis b0, 1   //show component b0
  • Instance 3: 
vis 1, 0   //hide the component whose ID is 1
  • Instance 4: 
vis 1, 1   //show the component whose ID is 1

Remarks:

1.The first parameter 255 means all components in current page, for example: vis 255,0 (hide all components in current page) ; vis 255,1 (show all components in current page).

cle_c //cancelled, go and refer to "tsw" command.

  • Instance 1: 
cle_c   //This command does not need parameter

Remarks:

When you use this command, all touch areas you set in the current page will neither be valid, nor automatically be identified.Until you use the "page" command, the touch areas can be reloaded.

tsw cmp,state

tsw cmp,state

cmp: component name or component ID

state: state(0 or 1)

  • Instance 1: 
tsw b0, 0  //component b0 touch invalid
  • Instance 2: 
tsw b0, 1  //component b0 touch valid
  • Instance 3: 
tsw 1, 0  //component of ID 1 touch invalid
  • Instance 4: 
tsw 1, 1  //component of ID 1 touch valid

Remarks:

1.The first parameter 255 means all components in current page, for example: tsw 255, 0 (all components in current page touch invalid) ; tsw 255, 1 (all components in current page touch valid).

tsw obj,state

tsw obj, state: Enable/disable component touch function

tsw obj, state

obj: component name or component ID

state: state (0 or 1)

  • Instance 1: 
tsw b0, 0  //disable touch function for component b0
  • Instance 2: 
tsw b0, 1  //enable touch function for component b0
  • Instance 3: 
tsw b1, 0  //disable touch function for the component whose ID is 1
  • Instance 4: 
tsw 1, 1  // enable touch function for the component whose ID is 1

Remarks: The first parameter 255 means all components in current page, for example: tsw 255, 0 (disable touch function for all components in current page); tsw 255, 1 (enable touch function for all components in current page)

com_stop

  • Instance 1: 
com_stop  //This instruction does not need parameter

Remarks:

This command is used for pausing the execution of serial port commands, but note that the device will continue receiving the commands and store them in the buffer. Until receiving "com_star" commands, the device will execute the rest commands that store in the buffer.

When using this command to pause the execution, please make sure whether the buffer size and the maximum capacity of command queue can store all the commands you need. You will find these two parameter in Nextion Hardware manual.

com_star

  • Instance 1: 
com_star  //This instruction does not need parameter

Remarks:

After receiving this command, the device will execute all the commands that store in the buffer.

When using this command to recover the execution, please make sure whether the buffer size and the maximum capacity of command queue can store all the commands you need. You will find these two parameter in Nextion Hardware manual.

randset

randset: set random value range

randset minval, maxval

minval: minimum value

maxval: maximum value

  • Instance 1: 
ranset 1, 100  //set current value randomly generated from 1 to 100

Remarks:

1. You should use randset to set random value generated range beforehand. Without setting randset, the value range is 0~4294967295 by default. By setting randset, it will obtain a random value every time the system read rand.

2. The range set by randset keeps valid unless device power up again or device restore to original settings.

code_c

Instance 1: 

code _c   //This instruction does not need parameter

Clear the commands that is stored in the buffer but not executed.

print att

print: obtain variable value/constant value without format

print att

att: variable name

  • Instance 1: 
print t0.txt //returns the txt property value of component t0 in ASCII
  • Instance 2: 
print j0.val //returns val’s property value of component j0 in 4-byte hexadecimal data
  • Instance 3: 
print "123" //returns the ASCII of string "123":0x31 0x32 0x33
  • Instance 4: 
print 123 //returns the 4-byte hexadecimal data of value "123":0x7B 0x00 0x00 0x00

Remarks:

1. When the variable obtained by using print command is string type, the device directly returns string ASCII; if it is numeric type (such as progress val property) , the device will directly return the variable’s 4-byte hexadecimal data, value is stored as little-endian mode (ie low level in the front, high level at the back ).

2. When use print command to obtain data, the device sends only the data content, no start identifier, nor end mark.

3.print command can match up printh command to add a piece of user-defined label in the front so as to tell the microcontroller which component this variable belongs to).

4. print command is very similar to get command, the only difference between them is get command returns data with initial identifier (0x70 or 0x71) and end mark (0xff 0xff 0xff), while print not.

printh hex

hex: the characters'hexadecimal string expression to be sent

  • Instance 
printh d0 a0 //let device send these two bytes 0xd0 0xa0

Remarks:

1. print and printh commands are executed only in Nextion display, they will not be shown in the software simulator.

2. When using printh command to send data, the device sends specified characters only, no Start character, Space character or End character.

3. There must have one and only Space separated between each set of characters in the parameter, both upper case and lower case are supported in the hexadecimal string expression.

add cmpID, ch, val

cmpID: Waveform component ID

ch: Waveform component channel number

val: value (maximum 255, minimum 0)

  • Instance 1 
add 1, 0, 30  //add data 30 to channel 0 of the Waveform component which ID number is 1
  • Instance 2 
add 1, 1, 50  //add data 50 to channel 1 of the Waveform component which ID number is 1

Remarks:

1.Waveform component only support 8-bit values, 0 minimum, 255 maximum.

2.Each page supports up to four Waveform components, each Waveform component supports up to four channels. It supports continuously pass through data, the component will auto-flow and display the value. It supports to change attributes during passing through data, such as change the background color or foreground color for each channel during the process.

addt cmpID, ch, qyt

addt objid, ch, qyt: Waveform data pass through command

addt objid, ch, qyt

objid: waveform component ID

ch: channel number in waveform component

qyt: adopted point quantity of the data

  • Instance 1: 
addt 1, 0, 100  //waveform component whose ID is 1 enter into data pass through mode, pass through adopted point quantity is 100

Remarks:

1.Waveform component only support 8-bit values, 0 minimum, 255 maximum. Single pass through is 1024 bits maximum.

2.After sending waveform data pass through command, it will take some time to get the device responded and started passing through values. This period takes about 5ms(it will take longer if there are other commands to be executed in the buffer zone before executing data pass through command). Following this period, it will send a data pass through ready data(0XFE+Terminator) to user, then it will start sending pass through data. The data being passed are only hexadecimal numbers. It recovers to command receiving state only after the device has adopted specified data.

3.Waveform will not refresh until specified data has been passed through completely.


Classification II: GUI Designing Command

Note: When you can’t realize some special GUI designing in Nextion Editor, you can use some GUI commands to make it happen. Generally, the controls in Nextion editor can satisfy your GUI designing demand.

cls color

color: Decimal color value or color code

  • Instance 1: 
cls 1024  //Refresh the screen with decimal 1024 color value
  • Instance 2: 
cls RED  //Refresh the screen with the color of code RED (RED represents red color)

Both Decimal color value and Color code are supported in Nextion Editor

pic x, y, picid

x: x coordinate starting point;

y: y coordinate starting point;

picid: Picture ID;

  • Instance 1: 
pic 10, 20, 0  //Display the picture (ID is 0) in resource file at the coordinate (10, 20)
  • Instance 2: 
pic 40, 50, 1  //Display the picture (ID is 1) in resource file at the coordinate (40, 50)

picq x, y, w, h, picid

x: x coordinate starting point;

y: y coordinate starting point;

w: Region width;

h: Region height;

picid: Picture ID;

  • Instance 1: 
picq 20, 50, 30, 20, 0  //Crop the area from starting coordinate (20, 50) , with a width 30×height 20 size, in the picture 0 (the background picture must be full-screen) and display it on the screen, and the display coordinate is the starting coordinate (20, 50).

Remarks:

This instruction requires that the background picture must be full-screen; otherwise, the image you crop is not the one you want. The crop image area and the display area is overlap on the screen.

xstr x, y, w, h, fontid, fontcolor, backcolor, xcenter, ycenter, sta, string

x: x coordinate starting point;

y: y coordinate starting point;

w: Region width;

h: Region height;

fontid: Font ID;

fontcolor: Font color;

backcolor: Background color (when set sta as Crop Image or Image, backcolor means image ID );

xcenter: Horizontal alignment (0 is left-aligned, 1 is centered, 2 is right-aligned);

ycenter: Vertical alignment (0 is upper-aligned, 1 is centered, 2 is lower-aligned);

sta: Background fill(0-crop image;1-solid color;2-Image, when set sta as Crop Image or Image, backcolor means image ID);

string: Character content;

  • Instance 1: 
xstr 0, 0, 100, 30, 1, RED, BLACK, 1, 1, 1, China
  • Explanation:

Use font 1, at the starting point coordinate(0,0), write"China" in an area that its width is 100, height is 30, the font color is RED, background color is BLACK(if you do not want any background color, use NULL), horizontal alignment is center, and vertical alignment is center too.


Remarks:

1.There is automatic word wrapping if characters exceeds the default set w. If there are remaining characters not written out when wrapped to h, they will be neglected.

2. For more information about color value, please refer to cls command.

fill x, y, w, h, color

x: x coordinate starting point;

y: y coordinate starting point;

w: Region width;

h: Region height;

color: Fill color;

  • Instance 1: 
fill 0, 0, 100, 30, RED  //Fill color RED in the area of starting coordinate (0, 0) and width 100×height 30

Remarks:

For more information about color value, please refer to cls command.

line x, y, x2, y2, color

x: x coordinate starting point;

y: y coordinate starting point;

x2: x coordinate ending point;

y2: y coordinate ending point;

color: Line color;

  • Instance 1: 
line 0, 0, 100, 100, RED  //Draw a line in color RED between the coordinate (0, 0) and the coordinate (100, 100)

Remarks:

For more information about color value, please refer to cls command.

draw x, y, x2, y2, color

x: x coordinate of starting point;

y: y coordinate of starting point;

x2: x coordinate of ending point;

y2: y coordinate of ending point;

color: Line color;

  • Instance 1: 
draw 0, 0, 100, 100, RED    //Draw a rectangle, the top left coordinate is (0, 0) and bottom right corner is (100, 100), rectangle frame color is RED.

Remarks:

1. What is drawn by draw is hollow rectangle. Please directly use area fill instruction of fill if the filled rectangle needs filling. 2. For more information about color value, please refer to cls command.

cir x, y, r, color

x: Coordinate x of the center of a circle

y: Coordinate y of the center of a circle

r: Radius

color: Line color;

  • Instance 1: 
cir 100, 100, 30, RED    //Draw a hollow circle of radius of 30 with the coordinate (100, 100) as the center of a circle, circle frame line is RED

Remarks: For more information about color value, please refer to cls command.

Nextion Editor supports decimal color value and color code using in all GUI designing commands, for more information, please refer to Color Code List.

Nextion HMI: System Variables List

Serial Number Name Meaning Instance/Remarks
1 dim Current value of backlight b1ightness 1.dim=50 2.dim=dim+l0 3.dim=dim-l0

When you set dim=80, it means you set the brightness to 80,but doesn’t save the data. Next time you power the the Nextion TFT, the brightness of backlight will keep its default setting.

2 dims default backlight brightness when Nextion power on 1.dims=50 2.dims=dims+10 3.dims=dims-l0

When you set dims=80 to Nextion TFT, it means you set the brightness to 80, and save the data as default. Next time you power the Nextion TFT, the brightness of backlight will be 80 by default.

3 baud Current value of baud 1.baud=2400 2.baud=4800 3.baud=9600

4.baud=19200 5.baud=38400 6.baud=57600 7.baud=115200

4 bauds Default value of baud when Nextion power on 1.bauds=9600 is the default value of baud from factory.

2.when you set bauds=115200 to Nextion, it means you set the baud to115200, and save the data as default. Next time you power the Nextion, the value of baud will be 115200 by detault.

5 spax Hori spacing of font display

(Powered default is 0)

spax=2
6 spay Vertical spacing of font display

(Powered default is 0)

spay=2
7 thc Brush color at touch drawing l.thc=RED 2.thc=l024
8 thdra Switch of touch drawing function thdra=0(C1ose) thdra=1(Open)
9 ussp If no serial data, it automatically activates sleep time (unit: second, minimum 3, maximum 65,535, power-on default 0) ussp=30(No serial data within 30 seconds, it automatically enters into sleep mode)

ussp=0(invalid)

10 thsp If no touch operation, it automatically enters into sleep time (unit: second, minimum 3, maximum 65,535, power-on default 0) thsp=30(No touch operation within 30 seconds, it automatically enters into sleep mode)

thsp=0(invalid)

11 thup Touch in sleep mode will auto-awake switch (power-on default 0) thup=0(Touch will not automatically awake switch during sleep mode)

thup=1(Touch will automatically awake switch during sleep mode) Remarks: No matter thup is 0 or 1, if any touch operation in sleep mode, the device will send touch coordinates to the serial port.

12 sendxy Switch of real-time sending function of touch coordinate sendxy=0(C1ose) sendxy=1(Open)

Remarks:

1. When sending function is open, the device will send touch coordinate through serial port when you touch the screen. 2. Please refer to the table: Format of Device Return Data to know more about the format of sending the coordinate.

13 delay Delay=100(Pause the device for l00ms)

Remarks: When delay command is executed, the CPU of the device will not execute any command, but will continue receiving serial port command and store them into buffer.

14 sleep sleep=0 (Exit Sleep)

sleep=l (Enter Sleep)

Remarks:

When the device is enabled from sleep mode, the device will automatically re-fresh the current page, and the backlight brightness will recover to the default brightness value. Two commands available for changing the brightness of backlight, dim and dims.

15 bkcmd Set serial command successful execution or fail execution data return(Default is 2) bkcmd=0 (No return)

bkcmd=l (Only return the successful result)

bkcmd=2(Only return the failed result)

bkcmd=3（Always return）

Remarks:

This setting only affects the serial command’s successful execution or fail execution’s data return. In Nextion Editor’s editing interface, when there is a command execution error, it will return error data; when the command executes successfully, it will not return execution result data.

Conditional Statements In Nextion: if

  • Instance 1: If to.txt equals to 123456, it will switch to page 1 
if(t0.txt==”123456”)
{    
Page 1
}
  • Instance 2: Below codes can switch content of txt of button component b0 between start and stop in press event) 
if(b0.txt==”start”
{    
  b0.txt==”stop”  
} else
{ 
  b0.txt==”start”  
}
  • Instance 3: Below codes can switch content of txt of button component b0 among 1, 2, 3 in press event) 
if(b0.txt==”1”
{    
  b0.txt==”2”  
} else if (b0.txt==”2” )
{ 
  b0.txt==”3”  
}else
{ 
  b0.txt==”1”
}

Remarks:

1. Numerical variable supports operators: “>, <, ==, !=, >=, <=”

2. Character and String variable supports operators: “==, !=”

3. Nested “()” operator is not allowed. It does not support comparison operation, such as: if (j0.val + 1> 0).

4. Operator “()” must be paired.

5. Supports nested “if” and “else if” statement.

6.Complex expression, such as “if (j0.val+1>0)” is not supported

7.Download "if" HMI demo here: Demo

Nextion HMI: Color Code List

Code Decimal System Indicator Color
RED 63488 Red
BLUE 31 Blue
GRAY 33840 Gray
BLACK 0 Black
WHITE 65535 White
GREEN 2016 Green
BROWN 48192 Brown
YELLOW 65504 Yellow

Format of Device Return Data

Table 1: serial l instruction execution success or failure notification format

1.Only when the system variable bkcmd is not zero will return instruction execution succeed or fail data, bkcmd defaults to 0 after each power on, which means it does not return the result of instruction execution.

2.The code of the source file is not affected by bkcmd when software is under editing, the error data will be returned when there is an execution error, and the error data will not be returned when execute success.

3.The returned data is end with three bytes of “0XFF 0XFF 0XFF”.

The first byte of returned data Meaning Format
0X00 Invalid instruction 0X00+End
Return this data when receiving the invalid instruction sent by the user
0X01 Successful execution of instruction 0X01+End
Return this data when the instruction sent by the user is successfully executed
0X03 Page ID invalid 0X03+End
Return this data when the instruction sent by the user contains invalid page ID or invalid page name
0X04 Picture ID invalid 0X04+End
Return this data when the instruction sent by the user contains invalid picture ID
0X05 Font ID invalid 0X05+End
Return this data when the instruction sent by the user contains invalid font ID
0X11 Baud rate setting invalid 0X11+End
The baud rate setting instruction sent by the user contains invalid baud rate parameter
Baud rate supported by the device including:2400 4800 9600 19200 38400 57600 115200
0X12 Curve control ID number or channel number is invalid 0X12+End
When users use the add commands to add data to curve, this data will be returned as curve control ID number or channel number is invalid
0X1A Variable name invalid 0X1A+End
Return this data when the serial port receives invalid variable name
Note: control attribute is also called variable. For example, when you set the attribute of a control, it will return this data if the unavailable attribute name is input.
0X1B Variable operation invalid 0X1B+End
For example, when txt attribute of text component t0 is assigned, it should be written as t0.txt=“abc” It is wrong if you write t0.txt=abc.
For another example, the val attribute of progress bar j0 should be numerical, so it should be written as j0.val=50; it will be wrong if you write j0.val=“50” or j0.val=abc.

Table 2: other data return format

1.The returned data is end with three bytes of “0XFF 0XFF 0XFF”.

2.The following data’s return does not be affected by bkcmd.

The first byte of returned data Meaning Format
0X65 Touch event return data 0X65+Page ID+Component ID+TouchEvent+End
Return this data when the touch event created by the user is pressed.
Definition of TouchEvent: Press Event 0x01, Release Event 0X00)
Instance: 0X65 0X00 0X02 0X01 0XFF 0XFF 0XFF'
Meaning: Page 0, Button 2, Press
0X66 Current page ID number returns 0X66+Page ID+End
The device returns this data after receiving “sendme” instruction)
Instance: 0X66 0X02 0XFF 0XFF 0XFF
Meaning: Current page ID is 2
0X67 Touch coordinate data returns 0X67++ Coordinate X High-order+Coordinate X Low-order+Coordinate Y High-order+Coordinate Y Low-order+TouchEvent State+End
When the system variable “sendxy” is 1, return this data at TouchEvent occurring
Definition of TouchEvent: Press Event 0x01, Release Event 0X00
Instance: 0X67 0X00 0X7A 0X00 0X1E 0X01 0XFF 0XFF 0XFF
Meaning: Coordinate (122,30), Touch Event: Press
0X68 Touch Event in sleep mode 0X68++Coordinate X High-order+Coordinate X Low-order+Coordinate Y High-order+Coordinate Y Low-order+TouchEvent State+End
When the device enters sleep mode, return this data at TouchEvent occurring
Definition of TouchEvent: Press Event 0x01, Release Event 0X00
Instance: 0X68 0X00 0X7A 0X00 0X1E 0X01 0XFF 0XFF 0XFF
Meaning: Coordinate (122,30), Touch Event: Press
0X70 String variable data returns 0X70+Variable Content in ASCII code+End
When the variable obtained through get command is string type, return this data
Instance: 0X70 0X61 0X62 0X63 0XFF 0XFF 0XFF
Meaning: Return the string data: “abc”
0X71 Numeric variable data returns 0X71+variable binary data(4 bytes little endian mode, low in front)+End
When the variable obtained by get command is value, this data returns.
Instance:0X71 0X66 0X00 0X00 0X00 0XFF 0XFF 0XFF
Meaning:return value data:102
0X86 Device automatically enters into sleep mode 0X86+End

Only when the device automatically enters into sleep mode will return this data. If execute serial command “sleep = 1” to enter into sleep mode, it will not return this data.

0X87 Device automatically wake up 0X87+End

Only when the device automatically wake up will return this data. If execute serial command “sleep=0” to wake up, it will not return this data.

0X88 System successful start up This data is sent after a successful power-on initialization on the device
0X89 Start SD card upgrade This data is sent after the device power on and detect SD card, and then enter upgrade interface

Useful link

Discuss Nextion here: http://support.iteadstudio.com/discussions/1000058038

Retrieved from "https://wiki.iteadstudio.com/index.php?title=Nextion_Instruction_Set&oldid=4431"