| Documentation For Arduino users

- Main Page
- Related Pages
- Modules
- Classes
- Files
- Examples

- File List
- File Members

readme.md
1 @mainpage Home Page
2
3 # Nextion
4
5 --------------------------------------------------------------------------------
6
7 # Introduction
8
9 Nextion Arduino library provides an easy-to-use way to manipulate Nextion serial
10 displays. Users can use the libarry freely, either in commerical projects or
11 open-source prjects, without any additional condiitons.
12
13 For more information about the Nextion display project, please visit
14 [the wiki。](http://wiki.iteadstudio.com/Nextion_HMI_Solution)
15 The wiki provdies all the necessary technical documnets, quick start guide,
16 tutorials, demos, as well as some useful resources.
17
18 To get your Nextion display, please visit
19 [iMall.](http://imall.itead.cc/display/nextion.html)
20
21 To discuss the project? Request new features? Report a BUG? please visit the
22 [Forums](http://support.iteadstudio.com/discussions/1000058038)
23
24 # Download Source Code
25
26 Latest version is unstable and a mass of change may be applied in a short time
27 without any notification for users. Commonly, it is for developers of this
28 library.
29
30 **Release version is recommanded for you, unless you are one of developers of this
31 library.**
32
33 **Release notes** is at
34 <https://github.com/itead/ITEADLIB_Arduino_Nextion/blob/master/release_notes.md>.
35
36 ## Latest(unstable)
37
38 Latest source code(master branch) can be downloaded:
39 <https://github.com/itead/ITEADLIB_Arduino_Nextion/archive/master.zip>.
40
41 You can also clone it via git:
42
43 git clone https://github.com/itead/ITEADLIB_Arduino_Nextion
44
45 ## Releases(stable)
46
47 - https://github.com/itead/ITEADLIB_Arduino_Nextion/archive/v0.7.0.zip
48 - https://github.com/itead/ITEADLIB_Arduino_Nextion/archive/v0.7.0.tar.gz
49
50 All releases can be available from:
51 <https://github.com/itead/ITEADLIB_Arduino_Nextion/releases>.
52
53 # Documentation
54
55 [Latest Online Documentation](http://docs.iteadstudio.com/ITEADLIB_Arduino_Nextion/index.html)
56 contains Configuration, Get Started, Reference of API and Examples, etc.
57
58 Offline Documentation's entry `doc/Documentation/index.html` shiped with source code
59 can be open in your browser such as Chrome, Firefox or any one you like.
60
61 # Suppported Mainboards
62
63 **All boards, which has one or more hardware serial, can be supported.**
64
65 For example:
66
67 - Iteaduino MEGA2560
68 - Iteaduino UNO
69 - Arduino MEGA2560
70 - Arduino UNO
71
72 # Configuration
73
74 In configuration file NexConfig.h, you can find two macros below:
75
76 - dbSerial: Debug Serial (baudrate:9600), needed by beginners for debug your
77 nextion applications or sketches. If your complete your work, it will be a
78 wise choice to disable Debug Serial.
79
80 - nexSerial: Nextion Serial, the bridge of Nextion and your mainboard.
81
82 **Note:** the default configuration is for MEGA2560.
83
84 ## Redirect dbSerial and nexSerial
85
86 If you want to change the default serial to debug or communicate with Nextion ,
87 you need to modify the line in configuration file:
88
89 #define dbSerial Serial ---> #define dbSerial Serialxxx
90 #define nexSerial Serial2 ---> #define nexSeria Serialxxx
91
92 ## Disable Debug Serial
93
94 If you want to disable the debug information,you need to modify the line in
95 configuration file:
96
97 #define DEBUG_SERIAL_ENABLE ---> //#define DEBUG_SERIAL_ENABLE
98
99 # UNO-like Mainboards
100
101 If your board has only one hardware serial, such as UNO, you should disable
102 dbSerial and redirect nexSerial to Serial(Refer to section:`Serial configuration`).
103
104 # Useful Links
105
106 <http://blog.iteadstudio.com/nextion-tutorial-based-on-nextion-arduino-library/>
107
108 # License
109
110 -------------------------------------------------------------------------------
111
112
113 DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
114 Version 2, December 2004
115
116 Copyright (C) 2014 ITEAD Studio
117
118 Everyone is permitted to copy and distribute verbatim or modified
119 copies of this license document, and changing it is allowed as long
120 as the name is changed.
121
122 DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
123
124 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
125
126 0. You just DO WHAT THE FUCK YOU WANT TO.
127
128
129 -------------------------------------------------------------------------------