1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/**
******************************************************************************
* @file DispTools.h
* @author MCD Application Team
* @brief Header file for functions for creating MMI on a terminal.
******************************************************************************
* @attention
*
* Copyright (c) 2018-2021 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
*/
#ifndef __DISP_TOOLS_H__
#define __DISP_TOOLS_H__
#include "ble_common.h"
/*
************************************************************************
* ***** Define & Macro declaration. *****
************************************************************************
*/
/* Errors definition */
#define CONSOLE_MENU_NO_ERR 0
#define CONSOLE_MENU_USART_ERR 1
#define MAX_MENU 10 /* Max number of Menu that can be created */
#undef FALSE
#undef TRUE
#define FALSE ((int8_t)0)
#define TRUE ((int8_t)1)
/* -- For Menu Management -- */
#define HOME 0x00FE
#define EXIT 0x00FF
#define SIGN 16
#define DEL 0x7F
#define BKSP 0x08
#define RIGHT 0xC3
#define LEFT 0xC4
#define UP 0xC1
#define DOWN 0xC2
#define ESC 0x1b
#define ENTER 0x0d
#define MAX_BUFF_SIZE 80
#define MAX_TAB_CONV 22
/* -- For Menu Display -- */
#define RECREATE 1
#undef DISPLAY
#define DISPLAY 2
#undef CAPTURE
#define CAPTURE 4
#undef REFRESH
#define REFRESH 8
#define CAPTURE_NON_BLOCKING 16
#define DRAW_WINDOW 32
/* Flag in MSB byte of returned Item number of RunMenu API. Used to indicate User Action */
#define ESC_FLAG 0x100
#define ENTER_FLAG 0x200
#define ITEM_CHANGED 0x400
/* -- For Title Display -- */
#define BLOCK_RESULT 0x01
#define TESTCASE_RESULT 0x02
#define SUBTEST_RESULT 0x03
/* -- For ReadPcStr function -- */
#define INS 0
#define OVERSTK 1
/* -- For Memory Test Functions -- */
#define ACCESS_8 0
#define ACCESS_16 1
#define ACCESS_32 2
/* -- For ReadPcStr function -- */
#define SNUM 1
#define UNUM 2
/* -- For PrintCrt, PrintPcCrt function -- */
#define FREE_FLAG 1
#define BUSY_FLAG 2
#define MAXCOLNB 8 /* max column */
#define MAXITEMNB 50 /* max items in table */
/*
************************************************************************
* ***** Structure & Enum declaration. *****
************************************************************************
*/
/**
******************************************************************************
* @typedef POINT_T
* @author Gilles Spinelli
* @brief Describe a point on display terminal : X (or col) & Y (or line).
******************************************************************************
**/
typedef struct point
{
uint8_t line; /* Line or Y position on display. */
uint8_t col; /* Column or X position on display. */
} POINT_T;
enum _type_menu
{
TOGGLE = 1, /* Toggle and store value. Value (U16) can be 0 or 1. */
SEL_NUM, /* SELECTBOX and store value. Value (U16) between 0 to N. */
SEL_TXT, /* SELECTNUMBERBOX and store value. Value (U16) between 0 to N. */
STRTAB, /* Display string from table (no edit). Value (U16) between 0 to N. */
NUM16, /* GETNUMBER and store value. Number entry on (U16). */
NUM32, /* GETNUMBER and store value. Number entry on (U32). */
VAL16, /* (U16) Number display. Inactive cell */
VAL32, /* (U32) Number display. Inactive cell */
SVAL32, /* (S32) Number display. Inactive cell. */
TITLE, /* Display Item & Msg on a Inactive cell. (U16). */
ACTION, /* Display Item & Msg on an Active cell. No direct action. (U16). */
FUNCT /* Run function. */
};
/**
******************************************************************************
* @typedef STRUCTMENU
* @author Gilles Spinelli
* @brief Describe Menu.
******************************************************************************
**/
typedef struct
{
char *Item; /* Pointer on ASCII chain, display on Menu before "select arrow". */
void *Var; /* Pointer on variable to display/get, in function of "Type" Value. */
int8_t Type; /* Type of Menu line. Describe in "_type_menu" enum. */
void *Msg; /* Pointer on SelectBox, or ASCII chain that display on Menu after "select arrow". */
} STRUCTMENU_T;
typedef struct
{
void *MinValue; /* Minimum allowed value */
void *MaxValue; /* Maximum allowed value */
} STRUCTRANGE_T;
typedef struct
{
void *CapValue; /* Minimum allowed value */
void *MinValue; /* Minimum allowed value */
void *MaxValue; /* Maximum allowed value */
} STRUCTCAPTUREVAL_T;
/*
************************************************************************
* ***** Global Functions declaration. *****
************************************************************************
*/
uint16_t UartTransmitStr (char *StrToDisp);
void ConsoleMenu_Init (void);
int8_t CreateMenu(STRUCTMENU_T * menu, uint8_t x, uint8_t y, int8_t flag, int8_t menuhandle);
uint16_t DisplayMenu (char *menu[], uint8_t lineNumb, uint8_t x, uint8_t y);
uint16_t RunMenu(uint8_t MenuHandle, uint16_t ItemNumb, uint8_t x, uint8_t y, uint8_t flag);
void DeleteMenu(int8_t MenuHandle);
void DisplayTitle (uint8_t iY, char *szTitle, char *szVersion);
void DisplaySubTitle(int y, char *title, char dispVer);
void ClearScreen (void);
void ClearLines(uint8_t iStart_Line, uint8_t iNumber_Of_Line);
int8_t ReadPcStr (uint8_t x, uint8_t y, char buffer[], int8_t nbDigit,
int8_t pad, int8_t deflt, int8_t mode);
void PrintPcCrt (uint8_t x, uint8_t y, char *szFormat, ...);
void PrintCrt (char *szFormat, ...);
void PosCur (uint8_t iX, uint8_t iY);
uint16_t StringLength (const char *szString);
#endif /* __TOOLS_P_H__ */
|
