Component: Nextion Display (Graphical Color)
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Graphical Color |
Nextion Display component
A simple libray to interface a Nextion display. The elements on the nextion display are built using the Nextion Editor software and uploaded to the display. The component can then interact with the display elements.
Detailed description
No detailed description exists yet for this component
Examples
Handling Buttons
This example looks for button presses with IDs 1 and 2. On a button release event the corresponding LEDs will be toggled.
Downloadable macro reference
|
GetTouchID |
| Gets the ID of the corresponding touch event. Must be called after calling GetTouchEvent component macro. | |
 - UINT
|
Return |
|
|
GetValue |
| Gets the value from a specific item | |
 - STRING
|
Name |
 - ULONG
|
Return |
|
|
SetText |
| Sets the text of a specific item | |
| - STRING
|
Name |
| - STRING
|
Text |
 - VOID
|
Return |
|
|
GetText |
| Gets the text of a specific item | |
| - STRING
|
Name |
| - STRING
|
Return |
|
|
SetFontColour |
| Sets the foreground font colour of a specific item | |
| - STRING
|
Name |
| - ULONG
|
Colour |
| - VOID
|
Return |
|
|
SetPage |
| Sets the page of the display allowing multiple configurations | |
| - STRING
|
Name |
| Name of the page e.g. "page0" | |
| - VOID
|
Return |
|
|
SetValue |
| Sets the numeric value of a specific item | |
| - STRING
|
Name |
| - ULONG
|
Number |
| - VOID
|
Return |
|
|
GetTouchEvent |
| Collects the next touch event in the queue. Returns 0 for no touch event detected, 1= touch press, 2 = touch release | |
 - BYTE
|
Return |
|
|
SetBackgroundColour |
| Sets the background colour of a specific item | |
| - STRING
|
Name |
| - ULONG
|
Colour |
| - VOID
|
Return |
|
|
Initialise |
| Sets up the UART connection to the Nextion display | |
| - VOID
|
Return |
|
|
Start |
| Startup routine required by the hardware device. | |
| - VOID
|
Return |
|
|
SetBackgroundColour |
| Specifies the colour of the background by creating a mixture of red, green and blue. | |
| - BYTE
|
PixelColour |
| 0=White, 1=Black | |
| - VOID
|
Return |
|
|
DrawCircle |
| Draws a circle object on the display with the center of the circle at the location X,Y | |
| - UINT
|
X |
| X Coordinate for the center of the circle | |
| - UINT
|
Y |
| Y coordinate for the center of the circle | |
| - UINT
|
Radius |
| Radius of the circle specified in pixels | |
| - BYTE
|
Transparent |
| 0=Fill inside circle using background colour / 1=Draw outer circle only | |
| - BYTE
|
Solid |
| 0=Use Transparent Setting / 1=Fill with foreground colour | |
| - VOID
|
Return |
|
|
SetForegroundColour |
| Specifies the colour of the foreground by creating a mixture of red, green and blue. | |
| - BYTE
|
PixelColour |
| 0=White, 1=Black | |
| - VOID
|
Return |
|
|
DrawRectangle |
| Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2 | |
| - UINT
|
X1 |
| - UINT
|
Y1 |
| - UINT
|
X2 |
| - UINT
|
Y2 |
| - BYTE
|
Transparent |
| Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data. | |
| - BYTE
|
Solid |
| Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour. | |
| - VOID
|
Return |
|
|
Initialise |
| The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. | |
| - VOID
|
Return |
|
|
InvertDisplay |
| - VOID
|
Return |
|
|
Initialise |
| Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros | |
| - VOID
|
Return |
|
|
Initialise |
| Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros | |
| - VOID
|
Return |
|
|
Initialise |
| Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros | |
| - VOID
|
Return |
|
|
MODPMSHAPE |
| Sets PM waveform shape to; 0 = SINE, 1 = SQUARE, 2 = RAMPUP, 3 = RAMPDN, 4 = TRIANG, 5 = NOISE, 6 = DC, 7 = SINC, 8 = EXPRISE, 9 = LOGRISE, 10 = ARB1, 11 = ARB2, 12 = ARB3, 13= ARB4. | |
| - BYTE
|
Shape |
| Sets PM waveform shape (1 = SINE, 2 = SQUARE, 3 = RAMPUP, 4 = RAMPDN, 5 = TRIANG, 6 = NOISE, 7 = DC, 8 = SINC, 9 = EXPRISE, 10 = LOGRISE, 11 = ARB1, 12 = ARB2, 13 = ARB3, 14= ARB4). | |
| - VOID
|
Return |
|
|
ARB4 |
| Loads the binary-data to an existing arbitrary waveform memory location ARB4. | |
| - BYTE
|
Waveform |
| - VOID
|
Return |
|
|
CLKSRRet |
| Returns the clock source <INT> or <EXT>. | |
| [[File:]] - | Return |
|
|
MODPMDEV |
| Sets PM waveform deviation to <nrf> degrees. (Lower limit: -360° - Upper limit: 360°). | |
| [[File:]] - | Degrees |
| Sets PM waveform deviation in degrees (-360 - 360). | |
| - VOID
|
Return |
|
|
MSTLOCK |
| Sends signal to SLAVE generator to get synchronised | |
| - VOID
|
Return |
|
|
HILVL |
| Sets the amplitude-high-level to <nrf> Volts. (Lower limit: -0.490 V - Upper limit: 5.000 V). | |
| [[File:]] - | HighLevel |
| Sets the amplitude-high-level in Volts(V) (-0.490 V - 5.000 V). | |
| - VOID
|
Return |
|
|
ARB3 |
| Loads the binary-data to an existing arbitrary waveform memory location ARB3. | |
| - UINT
|
Waveform |
| - VOID
|
Return |
|
|
WAVE |
| Sets the waveform type. 0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB | |
| - BYTE
|
WaveType |
| 0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB. | |
| - VOID
|
Return |
|
|
CALADJ |
| Adjust the selected calibration value by <nrf> (Lower limit: -100 - Upper limit: 100). | |
| [[File:]] - | Calibrate |
| Adjust the selected calibration value (-100 - 100). | |
| - VOID
|
Return |
|
|
STBRet |
| Returns the value of the Status Byte Register in <nr1> numeric format. | |
| - BYTE
|
Return |
|
|
ARB2 |
| Loads the binary-data to an existing arbitrary waveform memory location ARB2. | |
| - UINT
|
Waveform |
| - VOID
|
Return |
|
|
EERRet |
| Query and clear execution error number register. | |
| - STRING
|
Return |
|
|
MODFMSRC |
| Sets FM waveform source to; 0 INT, 1 = EXT. | |
| [[File:]] - | Source |
| Sets FM waveform source (0 = INT, 1 = EXT). | |
| - VOID
|
Return |
|
|
MODAMFREQ |
| Sets AM waveform frequency to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 20kHz). | |
| [[File:]] - | Frequency |
| Sets AM waveform frequency in Hertz(Hz) (1uHz - 20kHz). | |
| - VOID
|
Return |
|
|
ESE |
| Sets the Standard Event Status Enable Register to the value of <nrf>. | |
| - BYTE
|
Value |
| Value of register 0-255 | |
| - VOID
|
Return |
|
|
ARB1 |
| Loads the binary-data to an existing arbitrary waveform memory location ARB1. | |
| - UINT
|
Waveform |
| 16 Bit binary number for arbitrary waveform. | |
| - VOID
|
Return |
|
|
ARB4DEFRet |
| Returns user specified waveform name, waveform pint interpolation state and waveform length of ARB4. | |
| - STRING
|
Return |
|
|
CLS |
| Clears status byte register of the interface. | |
| - VOID
|
Return |
|
|
MSTRELOCK |
| Resynchronises the two generators in MASTER-SLAVE mode. | |
| - VOID
|
Return |
|
|
NOISLVL |
| Sets the output noise level to <nr1> %. (Lower limit: 0% - Upper limit: 50%) | |
| - BYTE
|
Percent |
| Sets the output noise level in percent. (0 - 50) | |
| - VOID
|
Return |
|
|
LOCKMODE |
| Sets the synchronising mode to; 0 = MASTER, 1 = SLAVE, 2 = INDEP. | |
| - BYTE
|
Mode |
| Sets the synchronising mode (0 = MASTER, 1 = SLAVE, 2 = INDEP). | |
| - VOID
|
Return |
|
|
ADDRESSRet |
| Returns the instruments address | |
| [[File:]] - | Return |
|
|
MODPMSRC |
| Sets PM waveform source to; 0 INT, 1 = EXT. | |
| [[File:]] - | Source |
| Sets PM waveform source (0 = INT, 1 = EXT). | |
| - VOID
|
Return |
|
|
MODPWMSRC |
| Sets PWM waveform source to; 0 = INT, 1 = EXT. | |
| [[File:]] - | Source |
| Sets PWM waveform source (0 = INT, 1 = EXT). | |
| - VOID
|
Return |
|
|
MOD |
| Sets modulation to; 0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM. | |
| - BYTE
|
Modulation |
| Sets modulation (0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM). | |
| - VOID
|
Return |
|
|
ISTRet |
| Returns IST local message as defined by IEEE Std. 488.2. The syntax of the response is 0<rmt>, if the local message is false, or 1<rmt>, if the local message is true. | |
| [[File:]] - | Return |
|
|
LRNRet |
| Returns the complete setup of the instrument as a binary data block | |
| [[File:]] - | Return |
|
|
OPCRet |
| Query Operation Complete status. The response is always 1<rmt> and will be available immediately the command is executed because all commands are sequential. | |
| [[File:]] - | Return |
|
|
SWPTYPE |
| Sets the sweep type to; 0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP. | |
| - BYTE
|
Type |
| Set the sweep type (0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP). | |
| - VOID
|
Return |
|
|
PULSRANGE |
| Sets PWM waveform source to <1>, <2> or <3>; 1 = 1, 2 = 2, 3 = 3. | |
| - BYTE
|
Range |
| Sets the pulse rise and fall range. (1, 2 or 3) | |
| - VOID
|
Return |
|
|
TSTRet |
| The generator has no self test capability and the response is always 0 <rmt>. | |
| [[File:]] - | Return |
|
|
BSTTRGPOL |
| Sets the burst trigger slope to; 0 = POS, 1 = NEG. | |
| [[File:]] - | Slope |
| Set the burst trigger slope (0 = POS, 1 = NEG). | |
| - VOID
|
Return |
|
|
ARB3Ret |
| Returns the binary-data from an existing abbitrary wavefrom memory location. | |
| - UINT
|
Return |
|
|
BSTPHASE |
| Sets the burst phase to <nrf> degrees. (Lower limit: -360 - Upper limit: 360) | |
| [[File:]] - | Degrees |
| Sets the burst phase in degrees (-360 - 360) | |
| - VOID
|
Return |
|
|
IDNRet |
| Returns the instrument identification. The IDN is saved to the variable passed from the function 'ReturnIDN'. The return parameter is TRUE when the IDN is successfully returned. | |
| - STRING
|
ReturnIDN |
| - STRING
|
Return |
|
|
SWPTRGPER |
| Sets the sweep trigger period to <nrf> seconds | |
| [[File:]] - | Seconds |
| Set the sweep trigger period in seconds. | |
| - VOID
|
Return |
|
|
PULSDLY |
| Sets the waveform delay to <nrf> sec | |
| [[File:]] - | Sec |
| - VOID
|
Return |
|
|
Initialise |
| Opens the COM port ready for communications. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Channel |
| UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. | |
|
|
Baud Options |
| Baud rate option selector | |
|
Baud Rate |
|
TX |
| Pin to be used for Transmit data | |
|
|
RX |
| Pin to be used for Receive data | |
|
Touch Queue Size |
| Number of touch press/release events we can store before running out of memory. | |
|
|
Receive Buffer Size |
| Sets the number of byte elements inside the circular buffer. | |
|
|
Timeout |
| Time in milliseconds to wait for a reply to a command. | |
|
Connections |
|
|
Simulations |
|
Scope Traces |
| Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
Data Source |
| Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port API - Routes the communication data via a data injector component on the Panel. | |