1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/iMONDisplayDefines.h Sun Mar 16 09:11:39 2014 +0100
1.3 @@ -0,0 +1,114 @@
1.4 +#ifndef __IMON_DISPLAY_API_DEFINES_H__
1.5 +#define __IMON_DISPLAY_API_DEFINES_H__
1.6 +
1.7 +//////////////////////////////////////////////////
1.8 +//////////////////////////////////////////////////
1.9 +// Enumerations
1.10 +
1.11 +/**DSPResult
1.12 +@brief These enumeration values represent the returned result for iMON Display API function calls.\n
1.13 + All iMON Display API function calls return one of this result values.\n
1.14 + For meaning of each result, refer the comment of each line below*/
1.15 +enum DSPResult
1.16 +{
1.17 + DSP_SUCCEEDED = 0, //// Function Call Succeeded Without Error
1.18 + DSP_E_FAIL, //// Unspecified Failure
1.19 + DSP_E_OUTOFMEMORY, //// Failed to Allocate Necessary Memory
1.20 + DSP_E_INVALIDARG, //// One or More Arguments Are Not Valid
1.21 + DSP_E_NOT_INITED, //// API is Not Initialized
1.22 + DSP_E_POINTER, //// Pointer is Not Valid
1.23 +
1.24 + DSP_S_INITED = 0x1000, //// API is Initialized
1.25 + DSP_S_NOT_INITED, //// API is Not Initialized
1.26 + DSP_S_IN_PLUGIN_MODE, //// API Can Control iMON Display (Display Plug-in Mode)
1.27 + DSP_S_NOT_IN_PLUGIN_MODE, //// API Can't Control iMON Display
1.28 +};
1.29 +
1.30 +
1.31 +/**DSPNInitResult
1.32 +@brief These enumeration values represent the result status for requesting Display Plug-in Mode to iMON.\n
1.33 + iMON Display API notifies one of this result values to the caller application after requesting Display Plug-in Mode to iMON.\n
1.34 + For more information, refer the comment of each line below*/
1.35 +enum DSPNInitResult
1.36 +{
1.37 + DSPN_SUCCEEDED = 0, //// Display Plug-in Mode is Initialized Successfully
1.38 + DSPN_ERR_IN_USED = 0x0100, //// Display Plug-in is Already Used by Other Application
1.39 + DSPN_ERR_HW_DISCONNECTED, //// iMON HW is Not Connected
1.40 + DSPN_ERR_NOT_SUPPORTED_HW, //// The Connected iMON HW doesn't Support Display Plug-in
1.41 + DSPN_ERR_PLUGIN_DISABLED, //// Display Plug-in Mode Option is Disabled
1.42 + DSPN_ERR_IMON_NO_REPLY, //// The Latest iMON is Not Installed or iMON Not Running
1.43 + DSPN_ERR_UNKNOWN = 0x0200, //// Unknown Failure
1.44 +};
1.45 +
1.46 +
1.47 +/**DSPType
1.48 +@brief These enumeration values represent display type.\n
1.49 + Currently iMON Display API supports VFD and LCD products.*/
1.50 +enum DSPType
1.51 +{
1.52 + DSPN_DSP_NONE = 0,
1.53 + DSPN_DSP_VFD = 0x01, //// VFD products
1.54 + DSPN_DSP_LCD = 0x02, //// LCD products
1.55 +};
1.56 +
1.57 +
1.58 +/**DSPNotifyCode
1.59 +@brief These enumeration values represent the notification codes.\n
1.60 + iMON Display API will send or post message to the caller application.\n
1.61 + The caller application should assign the message and the winodw handle to receivce message with IMON_Display_Init fucntion.\n
1.62 + These enumeration values are used with WPARAM parameter of the message.\n
1.63 + For more information, see the explanation of each notification code below*/
1.64 +enum DSPNotifyCode
1.65 +{
1.66 + /**DSPNM_PLUGIN_SUCCEED
1.67 + @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
1.68 + LPARAM represents DSPType. This value can be 0x01 (VFD), 0x02 (LCD) or 0x03 (VFD+LCD).*/
1.69 + DSPNM_PLUGIN_SUCCEED = 0,
1.70 +
1.71 + /**DSPNM_PLUGIN_FAILED
1.72 + @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
1.73 + LPARAM represents error code with DSPNResult.*/
1.74 + DSPNM_PLUGIN_FAILED,
1.75 +
1.76 + /**DSPNM_IMON_RESTARTED
1.77 + @brief When iMON starts, API will post caller-specified message with DSPNM_IMON_RESTARTED as WPARAM parameter.\n
1.78 + LPARAM represents DSPType. This value can be 0 (No Display), 0x01 (VFD), 0x02 (LCD) or 0x03 (VFD+LCD).*/
1.79 + DSPNM_IMON_RESTARTED,
1.80 +
1.81 + /**DSPNM_IMON_CLOSED
1.82 + @brief When iMON closed, API will post caller-specified message with DSPNM_IMON_CLOSED as WPARAM parameter.\n
1.83 + LPARAM is not used.*/
1.84 + DSPNM_IMON_CLOSED,
1.85 +
1.86 + /**DSPNM_HW_CONNECTED
1.87 + @brief When iMON HW newly connected, API will post caller-specified message with DSPNM_HW_CONNECTED as WPARAM parameter.\n
1.88 + LPARAM represents DSPType. This value can be 0 (No Display), 0x01 (VFD), 0x02 (LCD) or 0x03 (VFD+LCD).*/
1.89 + DSPNM_HW_CONNECTED,
1.90 +
1.91 + /**DSPNM_HW_DISCONNECTED
1.92 + @brief When iMON HW disconnected, API will post caller-specified message with DSPNM_HW_DISCONNECTED as WPARAM parameter.\n
1.93 + LPARAM is DSPNResult value, DSPN_ERR_HW_DISCONNECTED.*/
1.94 + DSPNM_HW_DISCONNECTED,
1.95 +
1.96 +
1.97 + /**DSPNM_LCD_TEXT_SCROLL_DONE
1.98 + @brief When iMON LCD finishes scrolling Text, API will post caller-specified message with DSPNM_LCD_TEXT_SCROLL_DONE as WPARAM parameter.\n
1.99 + The caller application may need to know when text scroll is finished, for sending next text.\n
1.100 + LPARAM is not used.*/
1.101 + DSPNM_LCD_TEXT_SCROLL_DONE = 0x1000,
1.102 +};
1.103 +
1.104 +//////////////////////////////////////////////////
1.105 +//////////////////////////////////////////////////
1.106 +// Structure
1.107 +
1.108 +/**DspEqData
1.109 +@brief This structure contains Equalizer data for 16 bands.
1.110 +@param BandData It represents Equalizer data for 16 bands. Its range is from 0 to 100.*/
1.111 +typedef struct DspEqData
1.112 +{
1.113 + int BandData[16];
1.114 +
1.115 +} DSPEQDATA, *PDSPEQDATA;
1.116 +
1.117 +#endif //__IMON_DISPLAY_API_DEFINES_H__
1.118 \ No newline at end of file