@driver_ops{Auxiliary Display} More...

#include <auxdisplay.h>

Data Fields
auxdisplay_display_on_t	display_on
	@driver_ops_optional Turn display on.
auxdisplay_display_off_t	display_off
	@driver_ops_optional Turn display off.
auxdisplay_cursor_set_enabled_t	cursor_set_enabled
	@driver_ops_optional Set cursor enabled status on an auxiliary display.
auxdisplay_position_blinking_set_enabled_t	position_blinking_set_enabled
	@driver_ops_optional Set cursor blinking status on an auxiliary display.
auxdisplay_cursor_shift_set_t	cursor_shift_set
	@driver_ops_optional Set cursor shift after character write and display shift.
auxdisplay_cursor_position_set_t	cursor_position_set
	@driver_ops_optional Set cursor (and write position) on an auxiliary display.
auxdisplay_cursor_position_get_t	cursor_position_get
	@driver_ops_optional Get current cursor on an auxiliary display.
auxdisplay_display_position_set_t	display_position_set
	@driver_ops_optional Set display position on an auxiliary display.
auxdisplay_display_position_get_t	display_position_get
	@driver_ops_optional Get current display position on an auxiliary display.
auxdisplay_capabilities_get_t	capabilities_get
	@driver_ops_mandatory Fetch capabilities (and details) of auxiliary display.
auxdisplay_clear_t	clear
	@driver_ops_mandatory Clear display of auxiliary display and return to home position.
auxdisplay_brightness_get_t	brightness_get
	@driver_ops_optional Get the current brightness level of an auxiliary display.
auxdisplay_brightness_set_t	brightness_set
	@driver_ops_optional Update the brightness level of an auxiliary display.
auxdisplay_backlight_get_t	backlight_get
	@driver_ops_optional Get the backlight level details of an auxiliary display.
auxdisplay_backlight_set_t	backlight_set
	@driver_ops_optional Update the backlight level of an auxiliary display.
auxdisplay_is_busy_t	is_busy
	@driver_ops_optional Check if an auxiliary display driver is busy.
auxdisplay_custom_character_set_t	custom_character_set
	@driver_ops_optional Sets a custom character in the display.
auxdisplay_write_t	write
	@driver_ops_mandatory Write data to auxiliary display screen at current position.
auxdisplay_custom_command_t	custom_command
	@driver_ops_optional Send a custom command to the display (if supported by driver).

Detailed Description

@driver_ops{Auxiliary Display}

Field Documentation

◆ backlight_get

auxdisplay_backlight_get_t auxdisplay_driver_api::backlight_get

@driver_ops_optional Get the backlight level details of an auxiliary display.

◆ backlight_set

auxdisplay_backlight_set_t auxdisplay_driver_api::backlight_set

@driver_ops_optional Update the backlight level of an auxiliary display.

◆ brightness_get

auxdisplay_brightness_get_t auxdisplay_driver_api::brightness_get

@driver_ops_optional Get the current brightness level of an auxiliary display.

◆ brightness_set

auxdisplay_brightness_set_t auxdisplay_driver_api::brightness_set

@driver_ops_optional Update the brightness level of an auxiliary display.

◆ capabilities_get

auxdisplay_capabilities_get_t auxdisplay_driver_api::capabilities_get

@driver_ops_mandatory Fetch capabilities (and details) of auxiliary display.

◆ clear

auxdisplay_clear_t auxdisplay_driver_api::clear

@driver_ops_mandatory Clear display of auxiliary display and return to home position.

◆ cursor_position_get

auxdisplay_cursor_position_get_t auxdisplay_driver_api::cursor_position_get

@driver_ops_optional Get current cursor on an auxiliary display.

◆ cursor_position_set

auxdisplay_cursor_position_set_t auxdisplay_driver_api::cursor_position_set

@driver_ops_optional Set cursor (and write position) on an auxiliary display.

◆ cursor_set_enabled

auxdisplay_cursor_set_enabled_t auxdisplay_driver_api::cursor_set_enabled

@driver_ops_optional Set cursor enabled status on an auxiliary display.

◆ cursor_shift_set

auxdisplay_cursor_shift_set_t auxdisplay_driver_api::cursor_shift_set

@driver_ops_optional Set cursor shift after character write and display shift.

◆ custom_character_set

auxdisplay_custom_character_set_t auxdisplay_driver_api::custom_character_set

@driver_ops_optional Sets a custom character in the display.

◆ custom_command

auxdisplay_custom_command_t auxdisplay_driver_api::custom_command

@driver_ops_optional Send a custom command to the display (if supported by driver).

◆ display_off

auxdisplay_display_off_t auxdisplay_driver_api::display_off

@driver_ops_optional Turn display off.

◆ display_on

auxdisplay_display_on_t auxdisplay_driver_api::display_on

@driver_ops_optional Turn display on.

◆ display_position_get

auxdisplay_display_position_get_t auxdisplay_driver_api::display_position_get

@driver_ops_optional Get current display position on an auxiliary display.

◆ display_position_set

auxdisplay_display_position_set_t auxdisplay_driver_api::display_position_set

@driver_ops_optional Set display position on an auxiliary display.

◆ is_busy

auxdisplay_is_busy_t auxdisplay_driver_api::is_busy

@driver_ops_optional Check if an auxiliary display driver is busy.

◆ position_blinking_set_enabled

auxdisplay_position_blinking_set_enabled_t auxdisplay_driver_api::position_blinking_set_enabled

@driver_ops_optional Set cursor blinking status on an auxiliary display.

◆ write

auxdisplay_write_t auxdisplay_driver_api::write

@driver_ops_mandatory Write data to auxiliary display screen at current position.

The documentation for this struct was generated from the following file:

include/zephyr/drivers/auxdisplay.h

Data Fields