Auxiliary (Text) Display Interface. More...

Data Structures
struct	auxdisplay_light
	Light levels for brightness and/or backlight. If not supported by a display/driver, both minimum and maximum will be AUXDISPLAY_LIGHT_NOT_SUPPORTED. More...

struct	auxdisplay_capabilities
	Structure holding display capabilities. More...

struct	auxdisplay_custom_data
	Structure for a custom command. This may be extended by specific drivers. More...

struct	auxdisplay_character
	Structure for a custom character. More...

Macros
#define	AUXDISPLAY_LIGHT_NOT_SUPPORTED 0
	Used for minimum and maximum brightness/backlight values if not supported. More...

Typedefs
typedef uint32_t	auxdisplay_mode_t
	Used to describe the mode of an auxiliary (text) display. More...

Enumerations
enum	auxdisplay_position { AUXDISPLAY_POSITION_ABSOLUTE = 0 , AUXDISPLAY_POSITION_RELATIVE , AUXDISPLAY_POSITION_RELATIVE_DIRECTION , AUXDISPLAY_POSITION_COUNT }
	Used for moving the cursor or display position. More...

enum	auxdisplay_direction { AUXDISPLAY_DIRECTION_RIGHT = 0 , AUXDISPLAY_DIRECTION_LEFT , AUXDISPLAY_DIRECTION_COUNT }
	Used for setting character append position. More...

Functions
int	auxdisplay_display_on (const struct device *dev)
	Turn display on. More...

int	auxdisplay_display_off (const struct device *dev)
	Turn display off. More...

int	auxdisplay_cursor_set_enabled (const struct device *dev, bool enabled)
	Set cursor enabled status on an auxiliary display. More...

int	auxdisplay_position_blinking_set_enabled (const struct device *dev, bool enabled)
	Set cursor blinking status on an auxiliary display. More...

int	auxdisplay_cursor_shift_set (const struct device *dev, uint8_t direction, bool display_shift)
	Set cursor shift after character write and display shift. More...

int	auxdisplay_cursor_position_set (const struct device *dev, enum auxdisplay_position type, int16_t x, int16_t y)
	Set cursor (and write position) on an auxiliary display. More...

int	auxdisplay_cursor_position_get (const struct device dev, int16_t x, int16_t *y)
	Get current cursor on an auxiliary display. More...

int	auxdisplay_display_position_set (const struct device *dev, enum auxdisplay_position type, int16_t x, int16_t y)
	Set display position on an auxiliary display. More...

int	auxdisplay_display_position_get (const struct device dev, int16_t x, int16_t *y)
	Get current display position on an auxiliary display. More...

int	auxdisplay_capabilities_get (const struct device dev, struct auxdisplay_capabilities capabilities)
	Fetch capabilities (and details) of auxiliary display. More...

int	auxdisplay_clear (const struct device *dev)
	Clear display of auxiliary display and return to home position (note that this does not reset the display configuration, e.g. custom characters and display mode will persist). More...

int	auxdisplay_brightness_get (const struct device dev, uint8_t brightness)
	Get the current brightness level of an auxiliary display. More...

int	auxdisplay_brightness_set (const struct device *dev, uint8_t brightness)
	Update the brightness level of an auxiliary display. More...

int	auxdisplay_backlight_get (const struct device dev, uint8_t backlight)
	Get the backlight level details of an auxiliary display. More...

int	auxdisplay_backlight_set (const struct device *dev, uint8_t backlight)
	Update the backlight level of an auxiliary display. More...

int	auxdisplay_is_busy (const struct device *dev)
	Check if an auxiliary display driver is busy. More...

int	auxdisplay_custom_character_set (const struct device dev, struct auxdisplay_character character)
	Sets a custom character in the display, the custom character struct must contain the pixel data for the custom character to add and valid custom character index, if successful then the character_code variable in the struct will be set to the character code that can be used with the auxdisplay_write() function to show it. More...

int	auxdisplay_write (const struct device dev, const uint8_t data, uint16_t len)
	Write data to auxiliary display screen at current position. More...

int	auxdisplay_custom_command (const struct device dev, struct auxdisplay_custom_data data)
	Send a custom command to the display (if supported by driver) More...

Detailed Description

Auxiliary (Text) Display Interface.

Macro Definition Documentation

◆ AUXDISPLAY_LIGHT_NOT_SUPPORTED

#define AUXDISPLAY_LIGHT_NOT_SUPPORTED 0

#include <include/zephyr/drivers/auxdisplay.h>

Used for minimum and maximum brightness/backlight values if not supported.

Typedef Documentation

◆ auxdisplay_mode_t

typedef uint32_t auxdisplay_mode_t

#include <include/zephyr/drivers/auxdisplay.h>

Used to describe the mode of an auxiliary (text) display.

Enumeration Type Documentation

◆ auxdisplay_direction

enum auxdisplay_direction

#include <include/zephyr/drivers/auxdisplay.h>

Used for setting character append position.

Enumerator
AUXDISPLAY_DIRECTION_RIGHT	Each character will be placed to the right of existing characters
AUXDISPLAY_DIRECTION_LEFT	Each character will be placed to the left of existing characters
AUXDISPLAY_DIRECTION_COUNT

◆ auxdisplay_position

enum auxdisplay_position

#include <include/zephyr/drivers/auxdisplay.h>

Used for moving the cursor or display position.

Enumerator
AUXDISPLAY_POSITION_ABSOLUTE	Moves to specified X,Y position
AUXDISPLAY_POSITION_RELATIVE	Shifts current position by +/- X,Y position, does not take display direction into consideration
AUXDISPLAY_POSITION_RELATIVE_DIRECTION	Shifts current position by +/- X,Y position, takes display direction into consideration
AUXDISPLAY_POSITION_COUNT

Function Documentation

◆ auxdisplay_backlight_get()

int auxdisplay_backlight_get	(	const struct device *	dev,
		uint8_t *	backlight
	)

#include <include/zephyr/drivers/auxdisplay.h>

Get the backlight level details of an auxiliary display.

Parameters

dev	Auxiliary display device instance
backlight	Will be updated with the current backlight level

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-errno	Negative errno code on other failure.

◆ auxdisplay_backlight_set()

int auxdisplay_backlight_set	(	const struct device *	dev,
		uint8_t	backlight
	)

#include <include/zephyr/drivers/auxdisplay.h>

Update the backlight level of an auxiliary display.

Parameters

dev	Auxiliary display device instance
backlight	The backlight level to set

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-EINVAL	if provided argument is invalid.
-errno	Negative errno code on other failure.

◆ auxdisplay_brightness_get()

int auxdisplay_brightness_get	(	const struct device *	dev,
		uint8_t *	brightness
	)

#include <include/zephyr/drivers/auxdisplay.h>

Get the current brightness level of an auxiliary display.

Parameters

dev	Auxiliary display device instance
brightness	Will be updated with the current brightness

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-errno	Negative errno code on other failure.

◆ auxdisplay_brightness_set()

int auxdisplay_brightness_set	(	const struct device *	dev,
		uint8_t	brightness
	)

#include <include/zephyr/drivers/auxdisplay.h>

Update the brightness level of an auxiliary display.

Parameters

dev	Auxiliary display device instance
brightness	The brightness level to set

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-EINVAL	if provided argument is invalid.
-errno	Negative errno code on other failure.

◆ auxdisplay_capabilities_get()

int auxdisplay_capabilities_get	(	const struct device *	dev,
		struct auxdisplay_capabilities *	capabilities
	)

#include <include/zephyr/drivers/auxdisplay.h>

Fetch capabilities (and details) of auxiliary display.

Parameters

dev	Auxiliary display device instance
capabilities	Will be updated with the details of the auxiliary display

Return values

0	on success.
-errno	Negative errno code on other failure.

◆ auxdisplay_clear()

int auxdisplay_clear ( const struct device * dev )

#include <include/zephyr/drivers/auxdisplay.h>

Clear display of auxiliary display and return to home position (note that this does not reset the display configuration, e.g. custom characters and display mode will persist).

Parameters

dev	Auxiliary display device instance

Return values

0	on success.
-errno	Negative errno code on other failure.

◆ auxdisplay_cursor_position_get()

int auxdisplay_cursor_position_get	(	const struct device *	dev,
		int16_t *	x,
		int16_t *	y
	)

#include <include/zephyr/drivers/auxdisplay.h>

Get current cursor on an auxiliary display.

Parameters

dev	Auxiliary display device instance
x	Will be updated with the exact X position
y	Will be updated with the exact Y position

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-EINVAL	if provided argument is invalid.
-errno	Negative errno code on other failure.

◆ auxdisplay_cursor_position_set()

int auxdisplay_cursor_position_set	(	const struct device *	dev,
		enum auxdisplay_position	type,
		int16_t	x,
		int16_t	y
	)

#include <include/zephyr/drivers/auxdisplay.h>

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

Parameters

dev	Auxiliary display device instance
type	Type of move, absolute or offset
x	Exact or offset X position
y	Exact or offset Y position

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-EINVAL	if provided argument is invalid.
-errno	Negative errno code on other failure.

◆ auxdisplay_cursor_set_enabled()

int auxdisplay_cursor_set_enabled	(	const struct device *	dev,
		bool	enabled
	)

#include <include/zephyr/drivers/auxdisplay.h>

Set cursor enabled status on an auxiliary display.

Parameters

dev	Auxiliary display device instance
enabled	True to enable cursor, false to disable

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-errno	Negative errno code on other failure.

◆ auxdisplay_cursor_shift_set()

int auxdisplay_cursor_shift_set	(	const struct device *	dev,
		uint8_t	direction,
		bool	display_shift
	)

#include <include/zephyr/drivers/auxdisplay.h>

Set cursor shift after character write and display shift.

Parameters

dev	Auxiliary display device instance
direction	Sets the direction of the display when characters are written
display_shift	If true, will shift the display when characters are written (which makes it look like the display is moving, not the cursor)

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-EINVAL	if provided argument is invalid.
-errno	Negative errno code on other failure.

◆ auxdisplay_custom_character_set()

int auxdisplay_custom_character_set	(	const struct device *	dev,
		struct auxdisplay_character *	character
	)

#include <include/zephyr/drivers/auxdisplay.h>

Sets a custom character in the display, the custom character struct must contain the pixel data for the custom character to add and valid custom character index, if successful then the character_code variable in the struct will be set to the character code that can be used with the auxdisplay_write() function to show it.

A character must be valid for a display consisting of a uint8 array of size character width by character height, values should be 0x00 for pixel off or 0xff for pixel on, if a display supports shades then values between 0x00 and 0xff may be used (display driver dependent).

Parameters

dev	Auxiliary display device instance
character	Pointer to custom character structure

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-EINVAL	if provided argument is invalid.
-errno	Negative errno code on other failure.

◆ auxdisplay_custom_command()

int auxdisplay_custom_command	(	const struct device *	dev,
		struct auxdisplay_custom_data *	data
	)

#include <include/zephyr/drivers/auxdisplay.h>

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

Parameters

dev	Auxiliary display device instance
data	Custom command structure (this may be extended by specific drivers)

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-EINVAL	if provided argument is invalid.
-errno	Negative errno code on other failure.

◆ auxdisplay_display_off()

int auxdisplay_display_off ( const struct device * dev )

#include <include/zephyr/drivers/auxdisplay.h>

Turn display off.

Parameters

dev	Auxiliary display device instance

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-errno	Negative errno code on other failure.

◆ auxdisplay_display_on()

int auxdisplay_display_on ( const struct device * dev )

#include <include/zephyr/drivers/auxdisplay.h>

Turn display on.

Parameters

dev	Auxiliary display device instance

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-errno	Negative errno code on other failure.

◆ auxdisplay_display_position_get()

int auxdisplay_display_position_get	(	const struct device *	dev,
		int16_t *	x,
		int16_t *	y
	)

#include <include/zephyr/drivers/auxdisplay.h>

Get current display position on an auxiliary display.

Parameters

dev	Auxiliary display device instance
x	Will be updated with the exact X position
y	Will be updated with the exact Y position

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-EINVAL	if provided argument is invalid.
-errno	Negative errno code on other failure.

◆ auxdisplay_display_position_set()

int auxdisplay_display_position_set	(	const struct device *	dev,
		enum auxdisplay_position	type,
		int16_t	x,
		int16_t	y
	)

#include <include/zephyr/drivers/auxdisplay.h>

Set display position on an auxiliary display.

Parameters

dev	Auxiliary display device instance
type	Type of move, absolute or offset
x	Exact or offset X position
y	Exact or offset Y position

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-EINVAL	if provided argument is invalid.
-errno	Negative errno code on other failure.

◆ auxdisplay_is_busy()

int auxdisplay_is_busy ( const struct device * dev )

#include <include/zephyr/drivers/auxdisplay.h>

Check if an auxiliary display driver is busy.

Parameters

dev	Auxiliary display device instance

Return values

1	on success and display busy.
0	on success and display not busy.
-ENOSYS	if not supported/implemented.
-errno	Negative errno code on other failure.

◆ auxdisplay_position_blinking_set_enabled()

int auxdisplay_position_blinking_set_enabled	(	const struct device *	dev,
		bool	enabled
	)

#include <include/zephyr/drivers/auxdisplay.h>

Set cursor blinking status on an auxiliary display.

Parameters

dev	Auxiliary display device instance
enabled	Set to true to enable blinking position, false to disable

Return values

0	on success.
-ENOSYS	if not supported/implemented.
-errno	Negative errno code on other failure.

◆ auxdisplay_write()

int auxdisplay_write	(	const struct device *	dev,
		const uint8_t *	data,
		uint16_t	len
	)

#include <include/zephyr/drivers/auxdisplay.h>

Write data to auxiliary display screen at current position.

Parameters

dev	Auxiliary display device instance
data	Text data to write
len	Length of text data to write

Return values

0	on success.
-EINVAL	if provided argument is invalid.
-errno	Negative errno code on other failure.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ AUXDISPLAY_LIGHT_NOT_SUPPORTED

Typedef Documentation

◆ auxdisplay_mode_t

Enumeration Type Documentation

◆ auxdisplay_direction

◆ auxdisplay_position

Function Documentation

◆ auxdisplay_backlight_get()

◆ auxdisplay_backlight_set()

◆ auxdisplay_brightness_get()

◆ auxdisplay_brightness_set()

◆ auxdisplay_capabilities_get()

◆ auxdisplay_clear()

◆ auxdisplay_cursor_position_get()

◆ auxdisplay_cursor_position_set()

◆ auxdisplay_cursor_set_enabled()

◆ auxdisplay_cursor_shift_set()

◆ auxdisplay_custom_character_set()

◆ auxdisplay_custom_command()

◆ auxdisplay_display_off()

◆ auxdisplay_display_on()

◆ auxdisplay_display_position_get()

◆ auxdisplay_display_position_set()

◆ auxdisplay_is_busy()

◆ auxdisplay_position_blinking_set_enabled()

◆ auxdisplay_write()