textdisplay.h File Reference

Text display interface. More...

#include <stdbool.h>
#include "emstatus.h"
Include dependency graph for textdisplay.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  TEXTDISPLAY_Config_t
 Initialization data structure for text display devices. More...

Defines

#define TEXTDISPLAY_EMSTATUS_OK   (0)
 EMSTATUS codes of the textdisplay module.
#define TEXTDISPLAY_EMSTATUS_INVALID_PARAM   (TEXTDISPLAY_EMSTATUS_BASE | 1)
 Invalid parameter.
#define TEXTDISPLAY_EMSTATUS_OUT_OF_RANGE   (TEXTDISPLAY_EMSTATUS_BASE | 2)
 Parameters out of range.
#define TEXTDISPLAY_EMSTATUS_ALREADY_INITIALIZED   (TEXTDISPLAY_EMSTATUS_BASE | 3)
 Device is already initialized.
#define TEXTDISPLAY_EMSTATUS_NOT_SUPPORTED   (TEXTDISPLAY_EMSTATUS_BASE | 4)
 Feature/option not supported.
#define TEXTDISPLAY_EMSTATUS_NOT_ENOUGH_MEMORY   (TEXTDISPLAY_EMSTATUS_BASE | 5)
 Not enough memory.
#define TEXTDISPLAY_EMSTATUS_NOT_INITIALIZED   (TEXTDISPLAY_EMSTATUS_BASE | 6)
 Device is not initialized.

Typedefs

typedef void * TEXTDISPLAY_Handle_t
 VT52/VT100 Escape Sequence codes supported by TEXTDISPLAY:

Functions

EMSTATUS TEXTDISPLAY_New (TEXTDISPLAY_Config_t *config, TEXTDISPLAY_Handle_t *handle)
 Create a new text display device.
EMSTATUS TEXTDISPLAY_Delete (TEXTDISPLAY_Handle_t handle)
 Delete a text display device.
EMSTATUS TEXTDISPLAY_WriteChar (TEXTDISPLAY_Handle_t handle, char c)
 Write a single character to a text display.
EMSTATUS TEXTDISPLAY_WriteString (TEXTDISPLAY_Handle_t handle, char *str)
 Write a string of characters to a text display.
EMSTATUS TEXTDISPLAY_LfToCrLf (TEXTDISPLAY_Handle_t handle, bool on)
 Enable or disable LF to CR+LF conversion.

Detailed Description

Text display interface.

Version:
4.0.0

License

(C) Copyright 2014 Silicon Labs, http://www.silabs.com

This file is licensed under the Silabs License Agreement. See the file "Silabs_License_Agreement.txt" for details. Before using this software for any purpose, you must agree to the terms of that agreement.

Definition in file textdisplay.h.