Nextion Instruction Set

From ITEAD Wiki
Revision as of 09:36, 17 August 2015 by ITead (Talk | contribs)

Jump to: navigation, search

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 cpmID

cpmID: the component to refresh

  • 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.

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

Remarks:

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

2. When returned value is numerical data, 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:

Device will immediately send the current page ID to serial port after receiving this instruction.

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

touch_j

  • 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

cle_c

  • 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.

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.

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 str

str: string content to be sent

  • Instance: print abcd (let the device send the four bytes string abcd)

Remarks:

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

2. When using the print command to send data, the device sends specified characters only, neither Start character nor End character.

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 cpmID, ch, val

cpmid: 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.Each page supports up to four Waveform components, each Waveform component supports up to four channels. User can transmit data continuously, the component will automatically push and display the data. In the process of sending data, control properties can be modified at any time, such as modify the foreground or background color of each channel.

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 dim=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.the=RED 2.thc=l024
8 thdra Switch of touch drawing function thdra=0(C1ose) thdra=1(Open)
9 sendxy Switch of real-time sending function of touch coordinate sendxy=0(C1ose) sendxy=0(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.

10 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.

11 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.

12 bkcmd Set serial command successful execution or fail execution data return(Default is 0) 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.

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

  • Note: The returned data is end with three bytes of “0XFF 0XFF 0XFF”.
The first bit of return 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
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.

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

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