Documentation: readme.md Source File

| 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 Offline Documentation's entry `doc/Documentation/index.html` shiped with source code
56 can be open in your browser such as Chrome, Firefox or any one you like.
57
58 # Suppported Mainboards
59
60 **All boards, which has one or more hardware serial, can be supported.**
61
62 For example:
63
64 - Iteaduino MEGA2560
65 - Iteaduino UNO
66 - Arduino MEGA2560
67 - Arduino UNO
68
69 # Configuration
70
71 In configuration file NexConfig.h, you can find two macros below:
72
73 - dbSerial: Debug Serial (baudrate:9600), needed by beginners for debug your
74 nextion applications or sketches. If your complete your work, it will be a
75 wise choice to disable Debug Serial.
76
77 - nexSerial: Nextion Serial, the bridge of Nextion and your mainboard.
78
79 **Note:** the default configuration is for MEGA2560.
80
81 ## Redirect dbSerial and nexSerial
82
83 If you want to change the default serial to debug or communicate with Nextion ,
84 you need to modify the line in configuration file:
85
86 #define dbSerial Serial ---> #define dbSerial Serialxxx
87 #define nexSerial Serial2 ---> #define nexSeria Serialxxx
88
89 ## Disable Debug Serial
90
91 If you want to disable the debug information,you need to modify the line in
92 configuration file:
93
94 #define DEBUG_SERIAL_ENABLE ---> //#define DEBUG_SERIAL_ENABLE
95
96 # UNO-like Mainboards
97
98 If your board has only one hardware serial, such as UNO, you should disable
99 dbSerial and redirect nexSerial to Serial(Refer to section:`Serial configuration`).
100
101 # Useful Links
102
103 <http://blog.iteadstudio.com/nextion-tutorial-based-on-nextion-arduino-library/>
104
105 # License
106
107 -------------------------------------------------------------------------------
108
109
110 The MIT License (MIT)
111
112 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
113
114 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
115
116 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
117
118
119 -------------------------------------------------------------------------------