Driver Operations Auxiliary Display driver operations More...

#include <zephyr/drivers/auxdisplay.h>

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

Detailed Description

Driver Operations Auxiliary Display driver operations

This is the driver API structure any Auxiliary Display driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ backlight_get

auxdisplay_backlight_get_t auxdisplay_driver_api::backlight_get

OPT Get the backlight level details of an auxiliary display.

◆ backlight_set

auxdisplay_backlight_set_t auxdisplay_driver_api::backlight_set

OPT Update the backlight level of an auxiliary display.

◆ brightness_get

auxdisplay_brightness_get_t auxdisplay_driver_api::brightness_get

OPT Get the current brightness level of an auxiliary display.

◆ brightness_set

auxdisplay_brightness_set_t auxdisplay_driver_api::brightness_set

OPT Update the brightness level of an auxiliary display.

◆ capabilities_get

auxdisplay_capabilities_get_t auxdisplay_driver_api::capabilities_get

REQ Fetch capabilities (and details) of auxiliary display.

◆ clear

auxdisplay_clear_t auxdisplay_driver_api::clear

REQ Clear display of auxiliary display and return to home position.

◆ cursor_position_get

auxdisplay_cursor_position_get_t auxdisplay_driver_api::cursor_position_get

OPT Get current cursor on an auxiliary display.

◆ cursor_position_set

auxdisplay_cursor_position_set_t auxdisplay_driver_api::cursor_position_set

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

◆ cursor_set_enabled

auxdisplay_cursor_set_enabled_t auxdisplay_driver_api::cursor_set_enabled

OPT Set cursor enabled status on an auxiliary display.

◆ cursor_shift_set

auxdisplay_cursor_shift_set_t auxdisplay_driver_api::cursor_shift_set

OPT Set cursor shift after character write and display shift.

◆ custom_character_set

auxdisplay_custom_character_set_t auxdisplay_driver_api::custom_character_set

OPT Sets a custom character in the display.

◆ custom_command

auxdisplay_custom_command_t auxdisplay_driver_api::custom_command

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

◆ display_off

auxdisplay_display_off_t auxdisplay_driver_api::display_off

OPT Turn display off.

◆ display_on

auxdisplay_display_on_t auxdisplay_driver_api::display_on

OPT Turn display on.

◆ display_position_get

auxdisplay_display_position_get_t auxdisplay_driver_api::display_position_get

OPT Get current display position on an auxiliary display.

◆ display_position_set

auxdisplay_display_position_set_t auxdisplay_driver_api::display_position_set

OPT Set display position on an auxiliary display.

◆ is_busy

auxdisplay_is_busy_t auxdisplay_driver_api::is_busy

OPT 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

OPT Set cursor blinking status on an auxiliary display.

◆ write

auxdisplay_write_t auxdisplay_driver_api::write

REQ Write data to auxiliary display screen at current position.

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

zephyr/drivers/auxdisplay.h

Data Fields