|
sl@0
|
1 |
#ifndef __IMON_DISPLAY_API_DEFINES_H__
|
|
sl@0
|
2 |
#define __IMON_DISPLAY_API_DEFINES_H__
|
|
sl@0
|
3 |
|
|
sl@0
|
4 |
//////////////////////////////////////////////////
|
|
sl@0
|
5 |
//////////////////////////////////////////////////
|
|
sl@0
|
6 |
// Enumerations
|
|
sl@0
|
7 |
|
|
sl@0
|
8 |
/**DSPResult
|
|
sl@0
|
9 |
@brief These enumeration values represent the returned result for iMON Display API function calls.\n
|
|
sl@0
|
10 |
All iMON Display API function calls return one of this result values.\n
|
|
sl@0
|
11 |
For meaning of each result, refer the comment of each line below*/
|
|
sl@0
|
12 |
enum DSPResult
|
|
sl@0
|
13 |
{
|
|
sl@0
|
14 |
DSP_SUCCEEDED = 0, //// Function Call Succeeded Without Error
|
|
sl@0
|
15 |
DSP_E_FAIL, //// Unspecified Failure
|
|
sl@0
|
16 |
DSP_E_OUTOFMEMORY, //// Failed to Allocate Necessary Memory
|
|
sl@0
|
17 |
DSP_E_INVALIDARG, //// One or More Arguments Are Not Valid
|
|
sl@0
|
18 |
DSP_E_NOT_INITED, //// API is Not Initialized
|
|
sl@0
|
19 |
DSP_E_POINTER, //// Pointer is Not Valid
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
DSP_S_INITED = 0x1000, //// API is Initialized
|
|
sl@0
|
22 |
DSP_S_NOT_INITED, //// API is Not Initialized
|
|
sl@0
|
23 |
DSP_S_IN_PLUGIN_MODE, //// API Can Control iMON Display (Display Plug-in Mode)
|
|
sl@0
|
24 |
DSP_S_NOT_IN_PLUGIN_MODE, //// API Can't Control iMON Display
|
|
sl@0
|
25 |
};
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
/**DSPNInitResult
|
|
sl@0
|
29 |
@brief These enumeration values represent the result status for requesting Display Plug-in Mode to iMON.\n
|
|
sl@0
|
30 |
iMON Display API notifies one of this result values to the caller application after requesting Display Plug-in Mode to iMON.\n
|
|
sl@0
|
31 |
For more information, refer the comment of each line below*/
|
|
sl@0
|
32 |
enum DSPNInitResult
|
|
sl@0
|
33 |
{
|
|
sl@0
|
34 |
DSPN_SUCCEEDED = 0, //// Display Plug-in Mode is Initialized Successfully
|
|
sl@0
|
35 |
DSPN_ERR_IN_USED = 0x0100, //// Display Plug-in is Already Used by Other Application
|
|
sl@0
|
36 |
DSPN_ERR_HW_DISCONNECTED, //// iMON HW is Not Connected
|
|
sl@0
|
37 |
DSPN_ERR_NOT_SUPPORTED_HW, //// The Connected iMON HW doesn't Support Display Plug-in
|
|
sl@0
|
38 |
DSPN_ERR_PLUGIN_DISABLED, //// Display Plug-in Mode Option is Disabled
|
|
sl@0
|
39 |
DSPN_ERR_IMON_NO_REPLY, //// The Latest iMON is Not Installed or iMON Not Running
|
|
sl@0
|
40 |
DSPN_ERR_UNKNOWN = 0x0200, //// Unknown Failure
|
|
sl@0
|
41 |
};
|
|
sl@0
|
42 |
|
|
sl@0
|
43 |
|
|
sl@0
|
44 |
/**DSPType
|
|
sl@0
|
45 |
@brief These enumeration values represent display type.\n
|
|
sl@0
|
46 |
Currently iMON Display API supports VFD and LCD products.*/
|
|
sl@0
|
47 |
enum DSPType
|
|
sl@0
|
48 |
{
|
|
sl@0
|
49 |
DSPN_DSP_NONE = 0,
|
|
sl@0
|
50 |
DSPN_DSP_VFD = 0x01, //// VFD products
|
|
sl@0
|
51 |
DSPN_DSP_LCD = 0x02, //// LCD products
|
|
sl@0
|
52 |
};
|
|
sl@0
|
53 |
|
|
sl@0
|
54 |
|
|
sl@0
|
55 |
/**DSPNotifyCode
|
|
sl@0
|
56 |
@brief These enumeration values represent the notification codes.\n
|
|
sl@0
|
57 |
iMON Display API will send or post message to the caller application.\n
|
|
sl@0
|
58 |
The caller application should assign the message and the winodw handle to receivce message with IMON_Display_Init fucntion.\n
|
|
sl@0
|
59 |
These enumeration values are used with WPARAM parameter of the message.\n
|
|
sl@0
|
60 |
For more information, see the explanation of each notification code below*/
|
|
sl@0
|
61 |
enum DSPNotifyCode
|
|
sl@0
|
62 |
{
|
|
sl@0
|
63 |
/**DSPNM_PLUGIN_SUCCEED
|
|
sl@0
|
64 |
@brief When API succeeds to get the control for the display, API will post caller-specified message with DSPNM_PLUGIN_SUCCEED as WPARAM parameter.\n
|
|
sl@0
|
65 |
LPARAM represents DSPType. This value can be 0x01 (VFD), 0x02 (LCD) or 0x03 (VFD+LCD).*/
|
|
sl@0
|
66 |
DSPNM_PLUGIN_SUCCEED = 0,
|
|
sl@0
|
67 |
|
|
sl@0
|
68 |
/**DSPNM_PLUGIN_FAILED
|
|
sl@0
|
69 |
@brief When API fails to get the control for the display, API will post caller-specified message with DSPNM_PLUGIN_FAILED as WPARAM parameter.\n
|
|
sl@0
|
70 |
LPARAM represents error code with DSPNResult.*/
|
|
sl@0
|
71 |
DSPNM_PLUGIN_FAILED,
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
/**DSPNM_IMON_RESTARTED
|
|
sl@0
|
74 |
@brief When iMON starts, API will post caller-specified message with DSPNM_IMON_RESTARTED as WPARAM parameter.\n
|
|
sl@0
|
75 |
LPARAM represents DSPType. This value can be 0 (No Display), 0x01 (VFD), 0x02 (LCD) or 0x03 (VFD+LCD).*/
|
|
sl@0
|
76 |
DSPNM_IMON_RESTARTED,
|
|
sl@0
|
77 |
|
|
sl@0
|
78 |
/**DSPNM_IMON_CLOSED
|
|
sl@0
|
79 |
@brief When iMON closed, API will post caller-specified message with DSPNM_IMON_CLOSED as WPARAM parameter.\n
|
|
sl@0
|
80 |
LPARAM is not used.*/
|
|
sl@0
|
81 |
DSPNM_IMON_CLOSED,
|
|
sl@0
|
82 |
|
|
sl@0
|
83 |
/**DSPNM_HW_CONNECTED
|
|
sl@0
|
84 |
@brief When iMON HW newly connected, API will post caller-specified message with DSPNM_HW_CONNECTED as WPARAM parameter.\n
|
|
sl@0
|
85 |
LPARAM represents DSPType. This value can be 0 (No Display), 0x01 (VFD), 0x02 (LCD) or 0x03 (VFD+LCD).*/
|
|
sl@0
|
86 |
DSPNM_HW_CONNECTED,
|
|
sl@0
|
87 |
|
|
sl@0
|
88 |
/**DSPNM_HW_DISCONNECTED
|
|
sl@0
|
89 |
@brief When iMON HW disconnected, API will post caller-specified message with DSPNM_HW_DISCONNECTED as WPARAM parameter.\n
|
|
sl@0
|
90 |
LPARAM is DSPNResult value, DSPN_ERR_HW_DISCONNECTED.*/
|
|
sl@0
|
91 |
DSPNM_HW_DISCONNECTED,
|
|
sl@0
|
92 |
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
/**DSPNM_LCD_TEXT_SCROLL_DONE
|
|
sl@0
|
95 |
@brief When iMON LCD finishes scrolling Text, API will post caller-specified message with DSPNM_LCD_TEXT_SCROLL_DONE as WPARAM parameter.\n
|
|
sl@0
|
96 |
The caller application may need to know when text scroll is finished, for sending next text.\n
|
|
sl@0
|
97 |
LPARAM is not used.*/
|
|
sl@0
|
98 |
DSPNM_LCD_TEXT_SCROLL_DONE = 0x1000,
|
|
sl@0
|
99 |
};
|
|
sl@0
|
100 |
|
|
sl@0
|
101 |
//////////////////////////////////////////////////
|
|
sl@0
|
102 |
//////////////////////////////////////////////////
|
|
sl@0
|
103 |
// Structure
|
|
sl@0
|
104 |
|
|
sl@0
|
105 |
/**DspEqData
|
|
sl@0
|
106 |
@brief This structure contains Equalizer data for 16 bands.
|
|
sl@0
|
107 |
@param BandData It represents Equalizer data for 16 bands. Its range is from 0 to 100.*/
|
|
sl@0
|
108 |
typedef struct DspEqData
|
|
sl@0
|
109 |
{
|
|
sl@0
|
110 |
int BandData[16];
|
|
sl@0
|
111 |
|
|
sl@0
|
112 |
} DSPEQDATA, *PDSPEQDATA;
|
|
sl@0
|
113 |
|
|
sl@0
|
114 |
#endif //__IMON_DISPLAY_API_DEFINES_H__ |