ESPHome
2024.11.1
|
#include <nextion.h>
Public Member Functions | |
void | set_component_text (const char *component, const char *text) |
Set the text of a component to a static string. More... | |
void | set_component_text_printf (const char *component, const char *format,...) __attribute__((format(printf |
Set the text of a component to a formatted string. More... | |
void void | set_component_value (const char *component, int32_t value) |
Set the integer value of a component. More... | |
void | set_component_picture (const char *component, uint8_t picture_id) |
Set the picture of an image component. More... | |
void | set_component_background_color (const char *component, uint16_t color) |
Set the background color of a component. More... | |
void | set_component_background_color (const char *component, const char *color) |
Set the background color of a component. More... | |
void | set_component_background_color (const char *component, Color color) override |
Set the background color of a component. More... | |
void | set_component_pressed_background_color (const char *component, uint16_t color) |
Set the pressed background color of a component. More... | |
void | set_component_pressed_background_color (const char *component, const char *color) |
Set the pressed background color of a component. More... | |
void | set_component_pressed_background_color (const char *component, Color color) override |
Set the pressed background color of a component. More... | |
void | set_component_foreground_color (const char *component, uint16_t color) |
Set the foreground color of a component. More... | |
void | set_component_foreground_color (const char *component, const char *color) |
Set the foreground color of a component. More... | |
void | set_component_foreground_color (const char *component, Color color) override |
Set the foreground color of a component. More... | |
void | set_component_pressed_foreground_color (const char *component, uint16_t color) |
Set the pressed foreground color of a component. More... | |
void | set_component_pressed_foreground_color (const char *component, const char *color) |
Set the pressed foreground color of a component. More... | |
void | set_component_pressed_foreground_color (const char *component, Color color) override |
Set the pressed foreground color of a component. More... | |
void | set_component_pic (const char *component, uint8_t pic_id) |
Set the picture id of a component. More... | |
void | set_component_picc (const char *component, uint8_t pic_id) |
Set the background picture id of component. More... | |
void | set_component_font_color (const char *component, uint16_t color) |
Set the font color of a component. More... | |
void | set_component_font_color (const char *component, const char *color) |
Set the font color of a component. More... | |
void | set_component_font_color (const char *component, Color color) override |
Set the font color of a component. More... | |
void | set_component_pressed_font_color (const char *component, uint16_t color) |
Set the pressed font color of a component. More... | |
void | set_component_pressed_font_color (const char *component, const char *color) |
Set the pressed font color of a component. More... | |
void | set_component_pressed_font_color (const char *component, Color color) override |
Set the pressed font color of a component. More... | |
void | set_component_coordinates (const char *component, uint16_t x, uint16_t y) |
Set the coordinates of a component on screen. More... | |
void | set_component_font (const char *component, uint8_t font_id) override |
Set the font id for a component. More... | |
void | set_nextion_rtc_time (ESPTime time) |
Send the current time to the nextion display. More... | |
void | goto_page (const char *page) |
Show the page with a given name. More... | |
void | goto_page (uint8_t page) |
Show the page with a given id. More... | |
void | hide_component (const char *component) override |
Hide a component. More... | |
void | show_component (const char *component) override |
Show a component. More... | |
void | enable_component_touch (const char *component) |
Enable touch for a component. More... | |
void | disable_component_touch (const char *component) |
Disable touch for a component. More... | |
void | add_waveform_data (uint8_t component_id, uint8_t channel_number, uint8_t value) |
Add waveform data to a waveform component. More... | |
void | open_waveform_channel (uint8_t component_id, uint8_t channel_number, uint8_t value) |
void | display_picture (uint16_t picture_id, uint16_t x_start, uint16_t y_start) |
Display a picture at coordinates. More... | |
void | fill_area (uint16_t x1, uint16_t y1, uint16_t width, uint16_t height, uint16_t color) |
Fill a rectangle with a color. More... | |
void | fill_area (uint16_t x1, uint16_t y1, uint16_t width, uint16_t height, const char *color) |
Fill a rectangle with a color. More... | |
void | fill_area (uint16_t x1, uint16_t y1, uint16_t width, uint16_t height, Color color) |
Fill a rectangle with a color. More... | |
void | line (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, uint16_t color) |
Draw a line on the screen. More... | |
void | line (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, const char *color) |
Draw a line on the screen. More... | |
void | line (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, Color color) |
Draw a line on the screen. More... | |
void | rectangle (uint16_t x1, uint16_t y1, uint16_t width, uint16_t height, uint16_t color) |
Draw a rectangle outline. More... | |
void | rectangle (uint16_t x1, uint16_t y1, uint16_t width, uint16_t height, const char *color) |
Draw a rectangle outline. More... | |
void | rectangle (uint16_t x1, uint16_t y1, uint16_t width, uint16_t height, Color color) |
Draw a rectangle outline. More... | |
void | circle (uint16_t center_x, uint16_t center_y, uint16_t radius, uint16_t color) |
Draw a circle outline. More... | |
void | circle (uint16_t center_x, uint16_t center_y, uint16_t radius, const char *color) |
Draw a circle outline. More... | |
void | circle (uint16_t center_x, uint16_t center_y, uint16_t radius, Color color) |
Draw a circle outline. More... | |
void | filled_circle (uint16_t center_x, uint16_t center_y, uint16_t radius, uint16_t color) |
Draw a filled circled. More... | |
void | filled_circle (uint16_t center_x, uint16_t center_y, uint16_t radius, const char *color) |
Draw a filled circled. More... | |
void | filled_circle (uint16_t center_x, uint16_t center_y, uint16_t radius, Color color) |
Draw a filled circled. More... | |
void | qrcode (uint16_t x1, uint16_t y1, const char *content, uint16_t size=200, uint16_t background_color=65535, uint16_t foreground_color=0, uint8_t logo_pic=-1, uint8_t border_width=8) |
Draws a QR code in the screen. More... | |
void | qrcode (uint16_t x1, uint16_t y1, const char *content, uint16_t size, Color background_color=Color(255, 255, 255), Color foreground_color=Color(0, 0, 0), uint8_t logo_pic=-1, uint8_t border_width=8) |
Draws a QR code in the screen. More... | |
void | set_backlight_brightness (float brightness) |
Set the brightness of the backlight. More... | |
void | set_touch_sleep_timeout (uint16_t timeout) |
Set the touch sleep timeout of the display. More... | |
void | set_wake_up_page (uint8_t page_id=255) |
Sets which page Nextion loads when exiting sleep mode. More... | |
void | set_start_up_page (uint8_t page_id=255) |
Sets which page Nextion loads when connecting to ESPHome. More... | |
void | set_auto_wake_on_touch (bool auto_wake) |
Sets if Nextion should auto-wake from sleep when touch press occurs. More... | |
void | set_exit_reparse_on_start (bool exit_reparse) |
Sets if Nextion should exit the active reparse mode before the "connect" command is sent. More... | |
void | set_skip_connection_handshake (bool skip_handshake) |
Sets whether the Nextion display should skip the connection handshake process. More... | |
void | sleep (bool sleep) |
Sets Nextion mode between sleep and awake. More... | |
bool | set_protocol_reparse_mode (bool active_mode) |
Sets the Nextion display's protocol reparse mode. More... | |
void | set_component_vid (const char *component, uint8_t vid_id) |
Set the video id of a component. More... | |
void | set_component_drag (const char *component, bool drag) |
Set the drag availability of a component. More... | |
void | set_component_aph (const char *component, uint8_t aph) |
Set the opaqueness (fading) of a component. More... | |
void | set_component_position (const char *component, uint32_t x, uint32_t y) |
Set the position of a component. More... | |
void | register_touch_component (NextionComponentBase *obj) |
void | register_switch_component (NextionComponentBase *obj) |
void | register_binarysensor_component (NextionComponentBase *obj) |
void | register_sensor_component (NextionComponentBase *obj) |
void | register_textsensor_component (NextionComponentBase *obj) |
void | setup () override |
void | set_brightness (float brightness) |
float | get_setup_priority () const override |
void | update () override |
void | loop () override |
void | set_writer (const nextion_writer_t &writer) |
void | set_wait_for_ack (bool wait_for_ack) |
bool | send_command (const char *command) |
Manually send a raw command to the display. More... | |
bool | send_command_printf (const char *format,...) __attribute__((format(printf |
Manually send a raw formatted command to the display. More... | |
bool void | set_tft_url (const std::string &tft_url) |
Set the tft file URL. More... | |
bool | upload_tft (uint32_t baud_rate=0, bool exit_reparse=true) |
Uploads the TFT file to the Nextion display. More... | |
void | dump_config () override |
void | soft_reset () |
Softreset the Nextion. More... | |
void | add_sleep_state_callback (std::function< void()> &&callback) |
Add a callback to be notified of sleep state changes. More... | |
void | add_wake_state_callback (std::function< void()> &&callback) |
Add a callback to be notified of wake state changes. More... | |
void | add_setup_state_callback (std::function< void()> &&callback) |
Add a callback to be notified when the nextion completes its initialize setup. More... | |
void | add_new_page_callback (std::function< void(uint8_t)> &&callback) |
Add a callback to be notified when the nextion changes pages. More... | |
void | add_touch_event_callback (std::function< void(uint8_t, uint8_t, bool)> &&callback) |
Add a callback to be notified when Nextion has a touch event. More... | |
void | update_all_components () |
void | set_nextion_sensor_state (int queue_type, const std::string &name, float state) |
Set the nextion sensor state object. More... | |
void | set_nextion_sensor_state (NextionQueueType queue_type, const std::string &name, float state) |
void | set_nextion_text_state (const std::string &name, const std::string &state) |
void | add_no_result_to_queue_with_set (NextionComponentBase *component, int32_t state_value) override |
void | add_no_result_to_queue_with_set (const std::string &variable_name, const std::string &variable_name_to_send, int32_t state_value) override |
void | add_no_result_to_queue_with_set (NextionComponentBase *component, const std::string &state_value) override |
void | add_no_result_to_queue_with_set (const std::string &variable_name, const std::string &variable_name_to_send, const std::string &state_value) override |
void | add_to_get_queue (NextionComponentBase *component) override |
void | add_addt_command_to_queue (NextionComponentBase *component) override |
Add addt command to the queue. More... | |
void | update_components_by_prefix (const std::string &prefix) |
void | set_touch_sleep_timeout_internal (uint32_t touch_sleep_timeout) |
void | set_wake_up_page_internal (uint8_t wake_up_page) |
void | set_start_up_page_internal (uint8_t start_up_page) |
void | set_auto_wake_on_touch_internal (bool auto_wake_on_touch) |
void | set_exit_reparse_on_start_internal (bool exit_reparse_on_start) |
size_t | queue_size () |
Retrieves the number of commands pending in the Nextion command queue. More... | |
bool | is_updating () override |
Check if the TFT update process is currently running. More... | |
Public Member Functions inherited from esphome::nextion::NextionBase | |
bool | is_sleeping () |
bool | is_setup () |
bool | is_detected () |
Public Member Functions inherited from esphome::PollingComponent | |
PollingComponent () | |
PollingComponent (uint32_t update_interval) | |
Initialize this polling component with the given update interval in ms. More... | |
virtual void | set_update_interval (uint32_t update_interval) |
Manually set the update interval in ms for this polling object. More... | |
void | call_setup () override |
virtual uint32_t | get_update_interval () const |
Get the update interval in ms of this sensor. More... | |
void | start_poller () |
void | stop_poller () |
Public Member Functions inherited from esphome::Component | |
float | get_actual_setup_priority () const |
void | set_setup_priority (float priority) |
virtual float | get_loop_priority () const |
priority of loop(). More... | |
void | call () |
virtual void | on_shutdown () |
virtual void | on_safe_shutdown () |
uint32_t | get_component_state () const |
virtual void | mark_failed () |
Mark this component as failed. More... | |
bool | is_failed () const |
bool | is_ready () const |
virtual bool | can_proceed () |
bool | status_has_warning () const |
bool | status_has_error () const |
void | status_set_warning (const char *message="unspecified") |
void | status_set_error (const char *message="unspecified") |
void | status_clear_warning () |
void | status_clear_error () |
void | status_momentary_warning (const std::string &name, uint32_t length=5000) |
void | status_momentary_error (const std::string &name, uint32_t length=5000) |
bool | has_overridden_loop () const |
void | set_component_source (const char *source) |
Set where this component was loaded from for some debug messages. More... | |
const char * | get_component_source () const |
Get the integration where this component was declared as a string. More... | |
Public Member Functions inherited from esphome::uart::UARTDevice | |
UARTDevice ()=default | |
UARTDevice (UARTComponent *parent) | |
void | set_uart_parent (UARTComponent *parent) |
void | write_byte (uint8_t data) |
void | write_array (const uint8_t *data, size_t len) |
void | write_array (const std::vector< uint8_t > &data) |
template<size_t N> | |
void | write_array (const std::array< uint8_t, N > &data) |
void | write_str (const char *str) |
bool | read_byte (uint8_t *data) |
bool | peek_byte (uint8_t *data) |
bool | read_array (uint8_t *data, size_t len) |
template<size_t N> | |
optional< std::array< uint8_t, N > > | read_array () |
int | available () |
void | flush () |
int | read () |
size_t | write (uint8_t data) |
int | peek () |
void | check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8) |
Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More... | |
Protected Member Functions | |
uint16_t | recv_ret_string_ (std::string &response, uint32_t timeout, bool recv_flag) |
void | all_components_send_state_ (bool force_update=false) |
bool | remove_from_q_ (bool report_empty=true) |
void | process_nextion_commands_ () |
void | process_serial_ () |
bool | send_command_ (const std::string &command) |
Manually send a raw command to the display and don't wait for an acknowledgement packet. More... | |
void | add_no_result_to_queue_ (const std::string &variable_name) |
bool | add_no_result_to_queue_with_ignore_sleep_printf_ (const std::string &variable_name, const char *format,...) __attribute__((format(printf |
bool void | add_no_result_to_queue_with_command_ (const std::string &variable_name, const std::string &command) |
bool | add_no_result_to_queue_with_printf_ (const std::string &variable_name, const char *format,...) __attribute__((format(printf |
Sends a formatted command to the nextion. More... | |
bool void | add_no_result_to_queue_with_set_internal_ (const std::string &variable_name, const std::string &variable_name_to_send, int32_t state_value, bool is_sleep_safe=false) |
void | add_no_result_to_queue_with_set_internal_ (const std::string &variable_name, const std::string &variable_name_to_send, const std::string &state_value, bool is_sleep_safe=false) |
void | check_pending_waveform_ () |
WiFiClient * | get_wifi_client_ () |
int | upload_by_chunks_ (HTTPClient &http_client, uint32_t &range_start) |
will request chunk_size chunks from the web server and send each to the nextion More... | |
int | upload_by_chunks_ (esp_http_client_handle_t http_client, uint32_t &range_start) |
will request 4096 bytes chunks from the web server and send each to Nextion More... | |
bool | upload_end_ (bool successful) |
Ends the upload process, restart Nextion and, if successful, restarts ESP. More... | |
uint32_t | get_free_heap_ () |
Returns the ESP Free Heap memory. More... | |
bool | get_is_connected_ () |
bool | check_connect_ () |
void | remove_front_no_sensors_ () |
void | print_queue_members_ () |
void | reset_ (bool reset_nextion=true) |
Protected Member Functions inherited from esphome::Component | |
virtual void | call_loop () |
virtual void | call_dump_config () |
void | set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f) |
Set an interval function with a unique name. More... | |
void | set_interval (uint32_t interval, std::function< void()> &&f) |
bool | cancel_interval (const std::string &name) |
Cancel an interval function. More... | |
void | set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f) |
Set an retry function with a unique name. More... | |
void | set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f) |
bool | cancel_retry (const std::string &name) |
Cancel a retry function. More... | |
void | set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f) |
Set a timeout function with a unique name. More... | |
void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
bool | cancel_timeout (const std::string &name) |
Cancel a timeout function. More... | |
void | defer (const std::string &name, std::function< void()> &&f) |
Defer a callback to the next loop() call. More... | |
void | defer (std::function< void()> &&f) |
Defer a callback to the next loop() call. More... | |
bool | cancel_defer (const std::string &name) |
Cancel a defer callback using the specified name, name must not be empty. More... | |
|
overridevirtual |
Add addt command to the queue.
component_id | The waveform component id |
wave_chan_id | The waveform channel to send it to |
buffer_to_send | The buffer size |
buffer_size | The buffer data |
Implements esphome::nextion::NextionBase.
Definition at line 1129 of file nextion.cpp.
void esphome::nextion::Nextion::add_new_page_callback | ( | std::function< void(uint8_t)> && | callback | ) |
Add a callback to be notified when the nextion changes pages.
callback | The void(std::string) callback. |
Definition at line 185 of file nextion.cpp.
|
protected |
variable_name | Name for the queue |
Definition at line 970 of file nextion.cpp.
|
protected |
variable_name | Variable name for the queue |
command |
Definition at line 991 of file nextion.cpp.
|
protected |
Definition at line 1000 of file nextion.cpp.
|
protected |
Sends a formatted command to the nextion.
variable_name | Variable name for the queue |
format | The printf-style command format, like "vis %s,0" |
... | The format arguments |
Definition at line 1026 of file nextion.cpp.
|
overridevirtual |
variable_name | Variable name for the queue |
variable_name_to_send | Variable name for the left of the command |
state_value | Value to set |
is_sleep_safe | The command is safe to send when the Nextion is sleeping |
Implements esphome::nextion::NextionBase.
Definition at line 1053 of file nextion.cpp.
|
overridevirtual |
Implements esphome::nextion::NextionBase.
Definition at line 1058 of file nextion.cpp.
|
overridevirtual |
variable_name | Variable name for the queue |
variable_name_to_send | Variable name for the left of the command |
state_value | String value to set |
is_sleep_safe | The command is safe to send when the Nextion is sleeping |
Implements esphome::nextion::NextionBase.
Definition at line 1081 of file nextion.cpp.
|
overridevirtual |
Implements esphome::nextion::NextionBase.
Definition at line 1085 of file nextion.cpp.
|
protected |
Definition at line 1063 of file nextion.cpp.
|
protected |
Definition at line 1091 of file nextion.cpp.
void esphome::nextion::Nextion::add_setup_state_callback | ( | std::function< void()> && | callback | ) |
Add a callback to be notified when the nextion completes its initialize setup.
callback | The void() callback. |
Definition at line 181 of file nextion.cpp.
void esphome::nextion::Nextion::add_sleep_state_callback | ( | std::function< void()> && | callback | ) |
Add a callback to be notified of sleep state changes.
callback | The void() callback. |
Definition at line 173 of file nextion.cpp.
|
overridevirtual |
Implements esphome::nextion::NextionBase.
Definition at line 1101 of file nextion.cpp.
void esphome::nextion::Nextion::add_touch_event_callback | ( | std::function< void(uint8_t, uint8_t, bool)> && | callback | ) |
Add a callback to be notified when Nextion has a touch event.
callback | The void() callback. |
Definition at line 189 of file nextion.cpp.
void esphome::nextion::Nextion::add_wake_state_callback | ( | std::function< void()> && | callback | ) |
Add a callback to be notified of wake state changes.
callback | The void() callback. |
Definition at line 177 of file nextion.cpp.
void esphome::nextion::Nextion::add_waveform_data | ( | uint8_t | component_id, |
uint8_t | channel_number, | ||
uint8_t | value | ||
) |
Add waveform data to a waveform component.
component_id | The integer component id. |
channel_number | The channel number to write to. |
value | The value to write. |
Definition at line 231 of file nextion_commands.cpp.
|
protected |
Definition at line 877 of file nextion.cpp.
|
protected |
Definition at line 42 of file nextion.cpp.
|
protected |
Definition at line 1144 of file nextion.cpp.
void esphome::nextion::Nextion::circle | ( | uint16_t | center_x, |
uint16_t | center_y, | ||
uint16_t | radius, | ||
uint16_t | color | ||
) |
Draw a circle outline.
center_x | The center x coordinate. |
center_y | The center y coordinate. |
radius | The circle radius. |
color | The color to draw with (number). Use this color picker to convert color codes to Nextion HMI colors. |
Definition at line 301 of file nextion_commands.cpp.
void esphome::nextion::Nextion::circle | ( | uint16_t | center_x, |
uint16_t | center_y, | ||
uint16_t | radius, | ||
const char * | color | ||
) |
Draw a circle outline.
center_x | The center x coordinate. |
center_y | The center y coordinate. |
radius | The circle radius. |
color | The color to draw with (as a string). Use Nextion Instruction Set for a list of Nextion HMI colors constants. |
Definition at line 306 of file nextion_commands.cpp.
void esphome::nextion::Nextion::circle | ( | uint16_t | center_x, |
uint16_t | center_y, | ||
uint16_t | radius, | ||
Color | color | ||
) |
Draw a circle outline.
center_x | The center x coordinate. |
center_y | The center y coordinate. |
radius | The circle radius. |
color | The color to draw with (as Color). |
Definition at line 311 of file nextion_commands.cpp.
void esphome::nextion::Nextion::disable_component_touch | ( | const char * | component | ) |
Disable touch for a component.
component | The component name. |
Example:
Disables touch for component named button
.
Definition at line 215 of file nextion_commands.cpp.
void esphome::nextion::Nextion::display_picture | ( | uint16_t | picture_id, |
uint16_t | x_start, | ||
uint16_t | y_start | ||
) |
Display a picture at coordinates.
picture_id | The picture id. |
x1 | The x coordinate. |
y1 | The y coordniate. |
Example:
Displays the picture who has the id 2
at the x coordinates 15
and y coordinates 25
.
Definition at line 247 of file nextion_commands.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 137 of file nextion.cpp.
void esphome::nextion::Nextion::enable_component_touch | ( | const char * | component | ) |
Enable touch for a component.
component | The component name. |
Example:
Enables touch for component named button
.
Definition at line 211 of file nextion_commands.cpp.
void esphome::nextion::Nextion::fill_area | ( | uint16_t | x1, |
uint16_t | y1, | ||
uint16_t | width, | ||
uint16_t | height, | ||
uint16_t | color | ||
) |
Fill a rectangle with a color.
x1 | The starting x coordinate. |
y1 | The starting y coordinate. |
width | The width to draw. |
height | The height to draw. |
color | The color to draw with (number). |
Example:
Fills an area that starts at x coordinate 50
and y coordinate 50
with a height of 100
and width of 100
with the red color. Use this color picker to convert color codes to Nextion HMI colors.
Definition at line 252 of file nextion_commands.cpp.
void esphome::nextion::Nextion::fill_area | ( | uint16_t | x1, |
uint16_t | y1, | ||
uint16_t | width, | ||
uint16_t | height, | ||
const char * | color | ||
) |
Fill a rectangle with a color.
x1 | The starting x coordinate. |
y1 | The starting y coordinate. |
width | The width to draw. |
height | The height to draw. |
color | The color to draw with (as a string). |
Example:
Fills an area that starts at x coordinate 50
and y coordinate 50
with a height of 100
and width of 100
with the red color. Use Nextion Instruction Set for a list of Nextion HMI colors constants.
Definition at line 257 of file nextion_commands.cpp.
void esphome::nextion::Nextion::fill_area | ( | uint16_t | x1, |
uint16_t | y1, | ||
uint16_t | width, | ||
uint16_t | height, | ||
Color | color | ||
) |
Fill a rectangle with a color.
x1 | The starting x coordinate. |
y1 | The starting y coordinate. |
width | The width to draw. |
height | The height to draw. |
color | The color to draw with (as Color). |
Example:
Fills an area that starts at x coordinate 50
and y coordinate 50
with a height of 100
and width of 100
with blue color.
Definition at line 262 of file nextion_commands.cpp.
void esphome::nextion::Nextion::filled_circle | ( | uint16_t | center_x, |
uint16_t | center_y, | ||
uint16_t | radius, | ||
uint16_t | color | ||
) |
Draw a filled circled.
center_x | The center x coordinate. |
center_y | The center y coordinate. |
radius | The circle radius. |
color | The color to draw with (number). |
Example:
Makes a filled circle at the x coordinate 25
and y coordinate 25
with a radius of 10
with the red color. Use this color picker to convert color codes to Nextion HMI colors.
Definition at line 316 of file nextion_commands.cpp.
void esphome::nextion::Nextion::filled_circle | ( | uint16_t | center_x, |
uint16_t | center_y, | ||
uint16_t | radius, | ||
const char * | color | ||
) |
Draw a filled circled.
center_x | The center x coordinate. |
center_y | The center y coordinate. |
radius | The circle radius. |
color | The color to draw with (as a string). |
Example:
Makes a filled circle at the x coordinate 25
and y coordinate 25
with a radius of 10
with the blue color. Use Nextion Instruction Set for a list of Nextion HMI colors constants.
Definition at line 321 of file nextion_commands.cpp.
void esphome::nextion::Nextion::filled_circle | ( | uint16_t | center_x, |
uint16_t | center_y, | ||
uint16_t | radius, | ||
Color | color | ||
) |
Draw a filled circled.
center_x | The center x coordinate. |
center_y | The center y coordinate. |
radius | The circle radius. |
color | The color to draw with (as Color). |
Example:
Makes a filled circle at the x coordinate 25
and y coordinate 25
with a radius of 10
with blue color.
Definition at line 326 of file nextion_commands.cpp.
|
inlineprotected |
Returns the ESP Free Heap memory.
This is framework independent.
Definition at line 24 of file nextion_upload_arduino.cpp.
|
inlineprotected |
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 163 of file nextion.cpp.
|
protected |
Definition at line 364 of file nextion_upload_arduino.cpp.
void esphome::nextion::Nextion::goto_page | ( | const char * | page | ) |
Show the page with a given name.
page | The name of the page. |
Example:
Switches to the page named main
. Pages are named in the Nextion Editor.
Definition at line 183 of file nextion_commands.cpp.
void esphome::nextion::Nextion::goto_page | ( | uint8_t | page | ) |
Show the page with a given id.
page | The id of the page. |
Example:
Switches to the page named main
. Pages are named in the Nextion Editor.
Definition at line 184 of file nextion_commands.cpp.
|
overridevirtual |
Hide a component.
component | The component name. |
Example:
Hides the component named button
.
Implements esphome::nextion::NextionBase.
Definition at line 203 of file nextion_commands.cpp.
|
overridevirtual |
Check if the TFT update process is currently running.
This method provides a way to determine if the Nextion display is in the process of updating its TFT firmware. When a TFT update is in progress, certain operations or commands may be restricted or could interfere with the update process. By checking the state of the update process, the system can make informed decisions about performing actions that involve communication with the Nextion display.
Reimplemented from esphome::nextion::NextionBase.
Definition at line 1166 of file nextion.cpp.
void esphome::nextion::Nextion::line | ( | uint16_t | x1, |
uint16_t | y1, | ||
uint16_t | x2, | ||
uint16_t | y2, | ||
uint16_t | color | ||
) |
Draw a line on the screen.
x1 | The starting x coordinate. |
y1 | The starting y coordinate. |
x2 | The ending x coordinate. |
y2 | The ending y coordinate. |
color | The color to draw with (number). |
Example:
Makes a line that starts at x coordinate 50
and y coordinate 50
and ends at x coordinate 75
and y coordinate 75
with the red color. Use this color picker to convert color codes to Nextion HMI colors.
Definition at line 268 of file nextion_commands.cpp.
void esphome::nextion::Nextion::line | ( | uint16_t | x1, |
uint16_t | y1, | ||
uint16_t | x2, | ||
uint16_t | y2, | ||
const char * | color | ||
) |
Draw a line on the screen.
x1 | The starting x coordinate. |
y1 | The starting y coordinate. |
x2 | The ending x coordinate. |
y2 | The ending y coordinate. |
color | The color to draw with (as a string). |
Example:
Makes a line that starts at x coordinate 50
and y coordinate 50
and ends at x coordinate 75
and y coordinate 75
with the blue color. Use Nextion Instruction Set for a list of Nextion HMI colors constants.
Definition at line 273 of file nextion_commands.cpp.
void esphome::nextion::Nextion::line | ( | uint16_t | x1, |
uint16_t | y1, | ||
uint16_t | x2, | ||
uint16_t | y2, | ||
Color | color | ||
) |
Draw a line on the screen.
x1 | The starting x coordinate. |
y1 | The starting y coordinate. |
x2 | The ending x coordinate. |
y2 | The ending y coordinate. |
color | The color to draw with (as Color). |
Example:
Makes a line that starts at x coordinate 50
and y coordinate 50
and ends at x coordinate 75
and y coordinate 75
with blue color.
Definition at line 278 of file nextion_commands.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 263 of file nextion.cpp.
void esphome::nextion::Nextion::open_waveform_channel | ( | uint8_t | component_id, |
uint8_t | channel_number, | ||
uint8_t | value | ||
) |
Definition at line 236 of file nextion_commands.cpp.
|
protected |
Definition at line 244 of file nextion.cpp.
|
protected |
Definition at line 341 of file nextion.cpp.
|
protected |
Definition at line 332 of file nextion.cpp.
void esphome::nextion::Nextion::qrcode | ( | uint16_t | x1, |
uint16_t | y1, | ||
const char * | content, | ||
uint16_t | size = 200 , |
||
uint16_t | background_color = 65535 , |
||
uint16_t | foreground_color = 0 , |
||
uint8_t | logo_pic = -1 , |
||
uint8_t | border_width = 8 |
||
) |
Draws a QR code in the screen.
x1 | The top left x coordinate to start the QR code. |
y1 | The top left y coordinate to start the QR code. |
content | The content of the QR code (as a plain text - Nextion will generate the QR code). |
size | The size (in pixels) for the QR code. Defaults to 200px. |
background_color | The background color to draw with (as rgb565 integer). Defaults to 65535 (white). |
foreground_color | The foreground color to draw with (as rgb565 integer). Defaults to 0 (black). |
logo_pic | The picture id for the logo in the center of the QR code. Defaults to -1 (no logo). |
border_width | The border width (in pixels) for the QR code. Defaults to 8px. |
Example:
Draws a QR code with a Wi-Fi network credentials starting at the given coordinates (25,25).
Definition at line 331 of file nextion_commands.cpp.
void esphome::nextion::Nextion::qrcode | ( | uint16_t | x1, |
uint16_t | y1, | ||
const char * | content, | ||
uint16_t | size, | ||
Color | background_color = Color(255, 255, 255) , |
||
Color | foreground_color = Color(0, 0, 0) , |
||
uint8_t | logo_pic = -1 , |
||
uint8_t | border_width = 8 |
||
) |
Draws a QR code in the screen.
x1 | The top left x coordinate to start the QR code. |
y1 | The top left y coordinate to start the QR code. |
content | The content of the QR code (as a plain text - Nextion will generate the QR code). |
size | The size (in pixels) for the QR code. Defaults to 200px. |
background_color | The background color to draw with (as Color). Defaults to 65535 (white). |
foreground_color | The foreground color to draw with (as Color). Defaults to 0 (black). |
logo_pic | The picture id for the logo in the center of the QR code. Defaults to -1 (no logo). |
border_width | The border width (in pixels) for the QR code. Defaults to 8px. |
Example:
Draws a QR code with a Wi-Fi network credentials starting at the given coordinates (25,25) with size of 150px in red on a blue background.
Definition at line 338 of file nextion_commands.cpp.
|
inline |
Retrieves the number of commands pending in the Nextion command queue.
This function returns the current count of commands that have been queued but not yet processed for the Nextion display. The Nextion command queue is used to store commands that are sent to the Nextion display for various operations like updating the display, changing interface elements, or other interactive features. A larger queue size might indicate a higher processing time or potential delays in command execution. This function is useful for monitoring the command flow and managing the execution efficiency of the Nextion display interface.
void esphome::nextion::Nextion::rectangle | ( | uint16_t | x1, |
uint16_t | y1, | ||
uint16_t | width, | ||
uint16_t | height, | ||
uint16_t | color | ||
) |
Draw a rectangle outline.
x1 | The starting x coordinate. |
y1 | The starting y coordinate. |
width | The width of the rectangle. |
height | The height of the rectangle. |
color | The color to draw with (number). |
Example:
Makes a outline of a rectangle that starts at x coordinate 25
and y coordinate 35
and has a width of 40
and a length of 50
with the red color. Use this color picker to convert color codes to Nextion HMI colors.
Definition at line 283 of file nextion_commands.cpp.
void esphome::nextion::Nextion::rectangle | ( | uint16_t | x1, |
uint16_t | y1, | ||
uint16_t | width, | ||
uint16_t | height, | ||
const char * | color | ||
) |
Draw a rectangle outline.
x1 | The starting x coordinate. |
y1 | The starting y coordinate. |
width | The width of the rectangle. |
height | The height of the rectangle. |
color | The color to draw with (as a string). |
Example:
Makes a outline of a rectangle that starts at x coordinate 25
and y coordinate 35
and has a width of 40
and a length of 50
with the blue color. Use Nextion Instruction Set for a list of Nextion HMI colors constants.
Definition at line 289 of file nextion_commands.cpp.
void esphome::nextion::Nextion::rectangle | ( | uint16_t | x1, |
uint16_t | y1, | ||
uint16_t | width, | ||
uint16_t | height, | ||
Color | color | ||
) |
Draw a rectangle outline.
x1 | The starting x coordinate. |
y1 | The starting y coordinate. |
width | The width of the rectangle. |
height | The height of the rectangle. |
color | The color to draw with (as Color). |
Example:
Makes a outline of a rectangle that starts at x coordinate 25
and y coordinate 35
and has a width of 40
and a length of 50
with blue color.
Definition at line 295 of file nextion_commands.cpp.
|
protected |
Definition at line 916 of file nextion.cpp.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
protected |
Definition at line 308 of file nextion.cpp.
|
protected |
|
protected |
Definition at line 127 of file nextion.cpp.
bool esphome::nextion::Nextion::send_command | ( | const char * | command | ) |
Manually send a raw command to the display.
command | The pcommand, like "page 0" |
Definition at line 211 of file nextion.cpp.
|
protected |
Manually send a raw command to the display and don't wait for an acknowledgement packet.
command | The command to write, for example "vis b0,0". |
Definition at line 29 of file nextion.cpp.
bool esphome::nextion::Nextion::send_command_printf | ( | const char * | format, |
... | |||
) |
Manually send a raw formatted command to the display.
format | The printf-style command format, like "vis %s,0" |
... | The format arguments |
Definition at line 222 of file nextion.cpp.
void esphome::nextion::Nextion::set_auto_wake_on_touch | ( | bool | auto_wake | ) |
Sets if Nextion should auto-wake from sleep when touch press occurs.
auto_wake | True or false. When auto_wake is true and Nextion is in sleep mode, the first touch will only trigger the auto wake mode and not trigger a Touch Event. |
Example:
The display will wake up by touch.
Definition at line 194 of file nextion_commands.cpp.
|
inline |
void esphome::nextion::Nextion::set_backlight_brightness | ( | float | brightness | ) |
Set the brightness of the backlight.
brightness | The brightness percentage from 0 to 1.0. |
Example:
Changes the brightness of the display to 30%.
Definition at line 186 of file nextion_commands.cpp.
|
inline |
void esphome::nextion::Nextion::set_component_aph | ( | const char * | component, |
uint8_t | aph | ||
) |
Set the opaqueness (fading) of a component.
component | The component name. |
aph | An integer between 0 and 127 related to the opaqueness/fading level. |
Example:
This will set the opaqueness level of the component textview
to 64.
Note: Requires Nextion Intelligent series display.
Definition at line 163 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_background_color | ( | const char * | component, |
uint16_t | color | ||
) |
Set the background color of a component.
component | The component name. |
color | The color (as a uint16_t). |
Example:
This will change the background color of the component button
to red. Use this color picker to convert color codes to Nextion HMI colors.
Definition at line 60 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_background_color | ( | const char * | component, |
const char * | color | ||
) |
Set the background color of a component.
component | The component name. |
color | The color (as a string). |
Example:
This will change the background color of the component button
to red. Use Nextion Instruction Set for a list of Nextion HMI colors constants.
Definition at line 64 of file nextion_commands.cpp.
|
overridevirtual |
Set the background color of a component.
component | The component name. |
color | The color (as Color). |
Example:
This will change the background color of the component button
to blue.
Implements esphome::nextion::NextionBase.
Definition at line 68 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_coordinates | ( | const char * | component, |
uint16_t | x, | ||
uint16_t | y | ||
) |
Set the coordinates of a component on screen.
component | The component name. |
x | The x coordinate. |
y | The y coordinate. |
Example:
This will move the position of the component pic
to the x coordinate 55
and y coordinate 100
.
Definition at line 241 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_drag | ( | const char * | component, |
bool | drag | ||
) |
Set the drag availability of a component.
component | The component name. |
drag | False: Drag not available, True: Drag available. |
Example:
This will enable drag to the component textview
.
Note: Requires Nextion Intelligent series display.
Definition at line 159 of file nextion_commands.cpp.
|
overridevirtual |
Set the font id for a component.
component | The component name. |
font_id | The ID of the font (number). |
Example:
Changes the font of the component named textveiw
. Font IDs are set in the Nextion Editor.
Implements esphome::nextion::NextionBase.
Definition at line 199 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_font_color | ( | const char * | component, |
uint16_t | color | ||
) |
Set the font color of a component.
component | The component name. |
color | The color (as a uint16_t). |
Example:
This will change the font color of the component textview
to a red color. Use this color picker to convert color codes to Nextion HMI colors.
Definition at line 118 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_font_color | ( | const char * | component, |
const char * | color | ||
) |
Set the font color of a component.
component | The component name. |
color | The color (as a string). |
Example:
This will change the font color of the component textview
to a red color. Use Nextion Instruction Set for a list of Nextion HMI colors constants.
Definition at line 122 of file nextion_commands.cpp.
|
overridevirtual |
Set the font color of a component.
component | The component name. |
color | The color (as Color). |
Example:
This will change the font color of the component textview
to black.
Implements esphome::nextion::NextionBase.
Definition at line 126 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_foreground_color | ( | const char * | component, |
uint16_t | color | ||
) |
Set the foreground color of a component.
component | The component name. |
color | The color (as a uint16_t). |
Example:
This will change the foreground color of the component button
to red. Use this color picker to convert color codes to Nextion HMI colors.
Definition at line 89 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_foreground_color | ( | const char * | component, |
const char * | color | ||
) |
Set the foreground color of a component.
component | The component name. |
color | The color (as a string). |
Example:
This will change the foreground color of the component button
to red. Use Nextion Instruction Set for a list of Nextion HMI colors constants.
Definition at line 93 of file nextion_commands.cpp.
|
overridevirtual |
Set the foreground color of a component.
component | The component name. |
color | The color (as Color). |
Example:
This will change the foreground color of the component button
to black.
Implements esphome::nextion::NextionBase.
Definition at line 97 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_pic | ( | const char * | component, |
uint8_t | pic_id | ||
) |
Set the picture id of a component.
component | The component name. |
pic_id | The picture ID. |
Example:
This will change the picture id of the component textview
.
Definition at line 146 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_picc | ( | const char * | component, |
uint8_t | pic_id | ||
) |
Set the background picture id of component.
component | The component name. |
pic_id | The picture ID. |
Example:
This will change the background picture id of the component textview
.
Definition at line 150 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_picture | ( | const char * | component, |
uint8_t | picture_id | ||
) |
Set the picture of an image component.
component | The component name. |
value | The picture id. |
Example:
This will change the image of the component pic
to the image with ID 4
.
Definition at line 219 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_position | ( | const char * | component, |
uint32_t | x, | ||
uint32_t | y | ||
) |
Set the position of a component.
component | The component name. |
x | The new X (horizontal) coordinate for the component. |
y | The new Y (vertical) coordinate for the component. |
Example:
This will move the component textview
to the column 64 of row 35 of the display.
Note: Requires Nextion Intelligent series display.
Definition at line 167 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_pressed_background_color | ( | const char * | component, |
uint16_t | color | ||
) |
Set the pressed background color of a component.
component | The component name. |
color | The color (as a uint16_t). |
Example:
This will change the pressed background color of the component button
to red. This is the background color that is shown when the component is pressed. Use this color picker to convert color codes to Nextion HMI colors.
Definition at line 74 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_pressed_background_color | ( | const char * | component, |
const char * | color | ||
) |
Set the pressed background color of a component.
component | The component name. |
color | The color (as a string). |
Example:
This will change the pressed background color of the component button
to red. This is the background color that is shown when the component is pressed. Use Nextion Instruction Set for a list of Nextion HMI colors constants.
Definition at line 79 of file nextion_commands.cpp.
|
overridevirtual |
Set the pressed background color of a component.
component | The component name. |
color | The color (as Color). |
Example:
This will change the pressed background color of the component button
to red. This is the background color that is shown when the component is pressed.
Implements esphome::nextion::NextionBase.
Definition at line 83 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_pressed_font_color | ( | const char * | component, |
uint16_t | color | ||
) |
Set the pressed font color of a component.
component | The component name. |
color | The color (as a uint16_t). |
Example:
This will change the pressed font color of the component button
to a red. Use this color picker to convert color codes to Nextion HMI colors.
Definition at line 132 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_pressed_font_color | ( | const char * | component, |
const char * | color | ||
) |
Set the pressed font color of a component.
component | The component name. |
color | The color (as a string). |
Example:
This will change the pressed font color of the component button
to a red color. Use Nextion Instruction Set for a list of Nextion HMI colors constants.
Definition at line 136 of file nextion_commands.cpp.
|
overridevirtual |
Set the pressed font color of a component.
component | The component name. |
color | The color (as Color). |
Example:
This will change the pressed font color of the component button
to black.
Implements esphome::nextion::NextionBase.
Definition at line 140 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_pressed_foreground_color | ( | const char * | component, |
uint16_t | color | ||
) |
Set the pressed foreground color of a component.
component | The component name. |
color | The color (as a uint16_t). |
Example:
This will change the pressed foreground color of the component button
to red. This is the foreground color that is shown when the component is pressed. Use this color picker to convert color codes to Nextion HMI colors.
Definition at line 103 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_pressed_foreground_color | ( | const char * | component, |
const char * | color | ||
) |
Set the pressed foreground color of a component.
component | The component name. |
color | The color (as a string). |
Example:
This will change the pressed foreground color of the component button
to red. This is the foreground color that is shown when the component is pressed. Use Nextion Instruction Set for a list of Nextion HMI colors constants.
Definition at line 108 of file nextion_commands.cpp.
|
overridevirtual |
Set the pressed foreground color of a component.
component | The component name. |
color | The color (as Color). |
Example:
This will change the pressed foreground color of the component button
to blue. This is the foreground color that is shown when the component is pressed.
Implements esphome::nextion::NextionBase.
Definition at line 112 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_text | ( | const char * | component, |
const char * | text | ||
) |
Set the text of a component to a static string.
component | The component name. |
text | The static text to set. |
Example:
This will set the txt
property of the component textview
to Hello World
.
Definition at line 223 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_text_printf | ( | const char * | component, |
const char * | format, | ||
... | |||
) |
Set the text of a component to a formatted string.
component | The component name. |
format | The printf-style format string. |
... | The arguments to the format. |
Example:
This will change the text on the component named textview
to The uptime is:
Then the value of uptime_sensor
. with zero decimals of accuracy (whole number). For example when uptime_sensor
= 506, then, The uptime is: 506
will be displayed.
Definition at line 172 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_value | ( | const char * | component, |
int32_t | value | ||
) |
Set the integer value of a component.
component | The component name. |
value | The value to set. |
Example:
This will change the property value
of the component gauge
to 50.
Definition at line 227 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_component_vid | ( | const char * | component, |
uint8_t | vid_id | ||
) |
Set the video id of a component.
component | The component name. |
vid_id | The video ID. |
Example:
This will change the video id of the component textview
.
Note: Requires Nextion Intelligent series display.
Definition at line 155 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_exit_reparse_on_start | ( | bool | exit_reparse | ) |
Sets if Nextion should exit the active reparse mode before the "connect" command is sent.
exit_reparse | True or false. When exit_reparse is true, the exit reparse command will be sent before requesting the connection from Nextion. |
Example:
The display will be requested to leave active reparse mode before setup.
Definition at line 57 of file nextion_commands.cpp.
|
inline |
void esphome::nextion::Nextion::set_nextion_rtc_time | ( | ESPTime | time | ) |
Send the current time to the nextion display.
time | The time instance to send (get this with id(my_time).now() ). |
Definition at line 346 of file nextion_commands.cpp.
void esphome::nextion::Nextion::set_nextion_sensor_state | ( | int | queue_type, |
const std::string & | name, | ||
float | state | ||
) |
Set the nextion sensor state object.
[in] | queue_type | Index of NextionQueueType. |
[in] | name | Component/variable name. |
[in] | state | State to set. |
Definition at line 820 of file nextion.cpp.
void esphome::nextion::Nextion::set_nextion_sensor_state | ( | NextionQueueType | queue_type, |
const std::string & | name, | ||
float | state | ||
) |
Definition at line 824 of file nextion.cpp.
void esphome::nextion::Nextion::set_nextion_text_state | ( | const std::string & | name, |
const std::string & | state | ||
) |
Definition at line 864 of file nextion.cpp.
bool esphome::nextion::Nextion::set_protocol_reparse_mode | ( | bool | active_mode | ) |
Sets the Nextion display's protocol reparse mode.
This function toggles the Nextion display's protocol reparse mode between active and passive. In active mode, the display actively parses incoming data. In passive mode, it does not parse data unless specifically instructed to do so. This is useful for managing how the Nextion display interprets incoming commands, especially during initialization or in scenarios where precise control over command processing is needed.
active_mode | A boolean value indicating the desired reparse mode.
|
Definition at line 39 of file nextion_commands.cpp.
|
inline |
Sets whether the Nextion display should skip the connection handshake process.
skip_handshake | True or false. When skip_connection_handshake is true, the connection will be established without performing the handshake. This can be useful when using Nextion Simulator. |
Example:
When set to true, the display will be marked as connected without performing a handshake.
void esphome::nextion::Nextion::set_start_up_page | ( | uint8_t | page_id = 255 | ) |
Sets which page Nextion loads when connecting to ESPHome.
page_id | The page id, from 0 to the lage page in Nextion. Set 255 (not set to any existing page) to wakes up to current page. |
Example:
The display will go to page 2 when it establishes a connection to ESPHome.
Definition at line 17 of file nextion_commands.cpp.
|
inline |
|
inline |
void esphome::nextion::Nextion::set_touch_sleep_timeout | ( | uint16_t | timeout | ) |
Set the touch sleep timeout of the display.
timeout | Timeout in seconds. |
Example:
After 30 seconds the display will go to sleep. Note: the display will only wakeup by a restart or by setting up thup
.
Definition at line 19 of file nextion_commands.cpp.
|
inline |
void esphome::nextion::Nextion::set_wait_for_ack | ( | bool | wait_for_ack | ) |
void esphome::nextion::Nextion::set_wake_up_page | ( | uint8_t | page_id = 255 | ) |
Sets which page Nextion loads when exiting sleep mode.
Note this can be set even when Nextion is in sleep mode.
page_id | The page id, from 0 to the lage page in Nextion. Set 255 (not set to any existing page) to wakes up to current page. |
Example:
The display will wake up to page 2.
Definition at line 13 of file nextion_commands.cpp.
|
inline |
void esphome::nextion::Nextion::set_writer | ( | const nextion_writer_t & | writer | ) |
Definition at line 1161 of file nextion.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 12 of file nextion.cpp.
|
overridevirtual |
Show a component.
component | The component name. |
Example:
Shows the component named button
.
Implements esphome::nextion::NextionBase.
Definition at line 207 of file nextion_commands.cpp.
void esphome::nextion::Nextion::sleep | ( | bool | sleep | ) |
Sets Nextion mode between sleep and awake.
True | or false. Sleep=true to enter sleep mode or sleep=false to exit sleep mode. |
Definition at line 28 of file nextion_commands.cpp.
void esphome::nextion::Nextion::soft_reset | ( | ) |
Softreset the Nextion.
Definition at line 11 of file nextion_commands.cpp.
|
overridevirtual |
Implements esphome::PollingComponent.
Definition at line 164 of file nextion.cpp.
void esphome::nextion::Nextion::update_all_components | ( | ) |
Definition at line 193 of file nextion.cpp.
void esphome::nextion::Nextion::update_components_by_prefix | ( | const std::string & | prefix | ) |
Definition at line 897 of file nextion.cpp.
|
protected |
will request chunk_size chunks from the web server and send each to the nextion
HTTPClient | http_client HTTP client handler. |
int | range_start Position of next byte to transfer. |
Definition at line 32 of file nextion_upload_arduino.cpp.
|
protected |
will request 4096 bytes chunks from the web server and send each to Nextion
esp_http_client_handle_t | http_client HTTP client handler. |
int | range_start Position of next byte to transfer. |
Definition at line 22 of file nextion_upload_idf.cpp.
|
protected |
Ends the upload process, restart Nextion and, if successful, restarts ESP.
bool | url successful True: Transfer completed successfuly, False: Transfer failed. |
Definition at line 341 of file nextion_upload_arduino.cpp.
bool esphome::nextion::Nextion::upload_tft | ( | uint32_t | baud_rate = 0 , |
bool | exit_reparse = true |
||
) |
Uploads the TFT file to the Nextion display.
This function initiates the upload of a TFT file to the Nextion display. Users can specify a target baud rate for the transfer. If the provided baud rate is not supported by Nextion, the function defaults to using the current baud rate set for the display. If no baud rate is specified (or if 0 is passed), the current baud rate is used.
Supported baud rates are: 2400, 4800, 9600, 19200, 31250, 38400, 57600, 115200, 230400, 250000, 256000, 512000 and 921600. Selecting a baud rate supported by both the Nextion display and the host hardware is essential for ensuring a successful upload process.
baud_rate | The desired baud rate for the TFT file transfer, specified as an unsigned 32-bit integer. If the specified baud rate is not supported, or if 0 is passed, the function will use the current baud rate. The default value is 0, which implies using the current baud rate. |
exit_reparse | If true, the function exits reparse mode before uploading the TFT file. This parameter defaults to true, ensuring that the display is ready to receive and apply the new TFT file without needing to manually reset or reconfigure. Exiting reparse mode is recommended for most upload scenarios to ensure the display properly processes the uploaded file command. |
Definition at line 153 of file nextion_upload_arduino.cpp.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |