Sat Mar 10 01:53:55 2012

Asterisk developer's documentation


adsi.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2005, Digium, Inc.
00005  *
00006  * Mark Spencer <markster@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  * \brief ADSI Support (built upon Caller*ID)
00021  */
00022 
00023 #ifndef _ASTERISK_ADSI_H
00024 #define _ASTERISK_ADSI_H
00025 
00026 #include "asterisk/callerid.h"
00027 #include "asterisk/optional_api.h"
00028 
00029 /*! \name ADSI parameters */
00030 /*@{ */
00031 
00032 /* ADSI Message types */
00033 #define ADSI_MSG_DISPLAY   132
00034 #define ADSI_MSG_DOWNLOAD  133
00035 
00036 /* ADSI Parameters (display) */
00037 #define ADSI_LOAD_SOFTKEY  128
00038 #define ADSI_INIT_SOFTKEY_LINE   129
00039 #define ADSI_LOAD_VIRTUAL_DISP   130
00040 #define ADSI_LINE_CONTROL  131
00041 #define ADSI_INFORMATION   132
00042 #define ADSI_DISC_SESSION  133
00043 #define ADSI_SWITCH_TO_DATA   134
00044 #define ADSI_SWITCH_TO_VOICE  135
00045 #define ADSI_CLEAR_SOFTKEY 136
00046 #define ADSI_INPUT_CONTROL 137
00047 #define ADSI_INPUT_FORMAT  138
00048 #define ADSI_SWITCH_TO_PERIPH 139
00049 #define ADSI_MOVE_DATA     140
00050 #define ADSI_LOAD_DEFAULT  141
00051 #define ADSI_CONNECT_SESSION  142
00052 #define ADSI_CLEAR_TYPE_AHEAD 143
00053 #define ADSI_DISPLAY_CALL_BUF 144
00054 #define ADSI_CLEAR_CALL_BUF   145
00055 #define ADSI_SWITCH_TO_ALT 146
00056 #define ADSI_SWITCH_TO_GRAPHICS  147
00057 #define ADSI_CLEAR_SCREEN  148
00058 #define ADSI_QUERY_CONFIG  149
00059 #define ADSI_QUERY_CPEID   150
00060 #define ADSI_SWITCH_TO_APP 151
00061 
00062 /* Feature download messages */
00063 #define ADSI_LOAD_SOFTKEY_TABLE  128   /* Conveniently identical to the soft version */
00064 #define ADSI_LOAD_PREDEF_DISP 129   /* Load predefined display */
00065 #define ADSI_LOAD_SCRIPT   130
00066 #define ADSI_DOWNLOAD_CONNECT 131
00067 #define ADSI_DOWNLOAD_DISC 132
00068 
00069 /* Special return string codes */
00070 #define ADSI_ENCODED_DTMF  0x80  /* Transmit following chars with encoded dtmf */
00071 #define ADSI_ON_HOOK    0x81  /* Open switch-hook */
00072 #define ADSI_OFF_HOOK      0x82  /* Close switch-hook */
00073 #define ADSI_FLASH      0x83  /* Flash switch-hook */
00074 #define ADSI_DIAL_TONE_DETECT 0x84  /* Wait for dialtone */
00075 #define ADSI_LINE_NUMBER   0x85  /* Send current line number using DTMF/encoded DTMF */
00076 #define ADSI_BLANK      0x86  /* Blank (does nothing) */
00077 #define ADSI_SEND_CHARS    0x87  /* Send collected digits/characters */
00078 #define ADSI_CLEAR_CHARS   0x88  /* Clear characters/digits collected */
00079 #define ADSI_BACKSPACE     0x89  /* Erase last collected digit */
00080 #define ADSI_TAB_COLUMN    0x8A  /* Display specified display column of current line */
00081 #define ADSI_GOTO_LINE     0x8B  /* Go to given page and line number */
00082 #define ADSI_GOTO_LINE_REL 0x8C  /* Go to given line (relative to current) */
00083 #define ADSI_PAGE_UP    0x8D  /* Go up one page */
00084 #define ADSI_PAGE_DOWN     0x8E  /* Go down one page */
00085 #define ADSI_EXTENDED_DTMF 0x8F  /* Send DTMF tones for 250ms instead of 60 ms */
00086 #define ADSI_DELAY      0x90  /* Delay for given # (times 10) of ms */
00087 #define ADSI_DIAL_PULSE_ONE   0x91  /* Send a dial pulse "1" */
00088 #define ADSI_SWITCH_TO_DATA2  0x92  /* Switch CPE to data mode */
00089 #define ADSI_SWITCH_TO_VOICE2 0x93  /* Switch CPE to voice mode */
00090 #define ADSI_DISP_CALL_BUF 0x94  /* Display specified call buffer */
00091 #define ADSI_CLEAR_CALL_B  0x95  /* Clear specified call buffer */
00092 
00093 #ifdef __ADSI_CPE
00094 /* These messages are reserved for the ADSI CPE only */
00095 #define ADSI_DISPLAY_CONTROL  0x98  /* Store predefined display identified next / Display status display page */
00096 #define ADSI_DISPLAY_SOFT_KEYS   0x99  /* Display the script soft keys identified next */
00097 #define ADSI_CHANGE_STATE  0x9A  /* Change state of service script */
00098 #define ADSI_START_CLEAR_TIMER   0x9B  /* Start / Clear timer */
00099 #define ADSI_SET_SCRIPT_FLAG  0x9C  /* Set / clear a script flag */
00100 #define ADSI_JUMP_TO_SUBSCRIPT   0x9D  /* Jump to specified subscript */
00101 #define ADSI_EVENT_22_TRIGGER 0x9E  /* Trigger an occurance of event 22 */
00102 #define ADSI_EVENT_23_TRIGGER 0x9f  /* Trigger an occurance of event 23 */
00103 #define ADSI_EXIT    0xA0  /* Exit the service script interpreter */
00104 #endif
00105 
00106 /* Display pages */
00107 #define ADSI_INFO_PAGE  0x0
00108 #define ADSI_COMM_PAGE  0x1
00109 
00110 #define ADSI_KEY_APPS   16 /* 16 to 33 reserved for applications */
00111 
00112 /* Justification */
00113 #define ADSI_JUST_LEFT  0x2
00114 #define ADSI_JUST_RIGHT 0x1
00115 #define ADSI_JUST_CENT  0x0   /* Center */
00116 #define ADSI_JUST_IND   0x3   /* Indent */
00117 
00118 #define ADSI_KEY_SKT 0x80  /* Load from SKT */
00119 #define ADSI_KEY_HILITE 0x40  /* Highlight key */
00120 
00121 #define ADSI_DIR_FROM_LEFT (0)
00122 #define ADSI_DIR_FROM_RIGHT (1)
00123 
00124 /*@} */
00125 
00126 AST_OPTIONAL_API(int, ast_adsi_begin_download, (struct ast_channel *chan, char *service, unsigned char *fdn, unsigned char *sec, int version), { return 0; });
00127 
00128 AST_OPTIONAL_API(int, ast_adsi_end_download, (struct ast_channel *chan), { return 0; });
00129 
00130 /*! Restore ADSI initialization (for applications that play with ADSI
00131  *   and want to restore it to normal.  If you touch "INFO" then you
00132  *   have to use the ast_adsi_channel_init again instead.
00133  * \param chan Channel to restore
00134  *
00135  * \retval 0 on success (or adsi unavailable)
00136  * \retval -1 on hangup
00137  */
00138 AST_OPTIONAL_API(int, ast_adsi_channel_restore, (struct ast_channel *chan), { return 0; });
00139 
00140 /*!
00141  * \brief Display some stuff on the screen
00142  * \param chan Channel to display on
00143  * \param lines NULL-terminated list of things to print (no more than 4 recommended)
00144  * \param align list of alignments to use (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CEN, etc..)
00145  * \param voice whether to jump into voice mode when finished
00146  *
00147  * \retval 0 on success (or adsi unavailable)
00148  * \retval -1 on hangup
00149  */
00150 AST_OPTIONAL_API(int, ast_adsi_print, (struct ast_channel *chan, char **lines, int *align, int voice), { return 0; });
00151 
00152 /*!
00153  * \brief Check if scripts for a given app are already loaded.
00154  * Version may be -1, if any version is okay, or 0-255 for a specific version.
00155  * \param chan Channel to test for loaded app
00156  * \param app Four character app name (must be unique to your application)
00157  * \param ver optional version number
00158  * \param data Non-zero if you want to be put in data mode
00159  *
00160  * \retval 0 if scripts is not loaded or not an ADSI CPE
00161  * \retval -1 on hangup
00162  * \retval 1 if script already loaded.
00163  */
00164 AST_OPTIONAL_API(int, ast_adsi_load_session, (struct ast_channel *chan, unsigned char *app, int ver, int data), { return 0; });
00165 AST_OPTIONAL_API(int, ast_adsi_unload_session, (struct ast_channel *chan), { return 0; });
00166 
00167 /* ADSI Layer 2 transmission functions */
00168 AST_OPTIONAL_API(int, ast_adsi_transmit_message, (struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype), { return 0; });
00169 AST_OPTIONAL_API(int, ast_adsi_transmit_message_full, (struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype, int dowait), { return 0; });
00170 /*! Read some encoded DTMF data.
00171  * Returns number of bytes received
00172  */
00173 AST_OPTIONAL_API(int, ast_adsi_read_encoded_dtmf, (struct ast_channel *chan, unsigned char *buf, int maxlen), { return 0; });
00174 
00175 /* ADSI Layer 3 creation functions */
00176 
00177 /*!
00178  * \brief Connects an ADSI Display Session
00179  * \param buf Character buffer to create parameter in (must have at least 256 free)
00180  * \param fdn Optional 4 byte Feature Download Number (for loading soft keys)
00181  * \param ver Optional version number (0-255, or -1 to omit)
00182  *
00183  * \retval number of bytes added to buffer
00184  * \retval -1 on error.
00185  */
00186 
00187 AST_OPTIONAL_API(int, ast_adsi_connect_session, (unsigned char *buf, unsigned char *fdn, int ver), { return 0; });
00188 
00189 /*! Build Query CPE ID of equipment.
00190  *  Returns number of bytes added to message
00191  */
00192 AST_OPTIONAL_API(int, ast_adsi_query_cpeid, (unsigned char *buf), { return 0; });
00193 AST_OPTIONAL_API(int, ast_adsi_query_cpeinfo, (unsigned char *buf), { return 0; });
00194 
00195 /*! Get CPE ID from an attached ADSI compatible CPE.
00196  * Returns 1 on success, storing 4 bytes of CPE ID at buf
00197  * or -1 on hangup, or 0 if there was no hangup but it failed to find the
00198  * device ID.  Returns to voice mode if "voice" is non-zero.
00199  */
00200 AST_OPTIONAL_API(int, ast_adsi_get_cpeid, (struct ast_channel *chan, unsigned char *cpeid, int voice), { return 0; });
00201 
00202 AST_OPTIONAL_API(int, ast_adsi_get_cpeinfo, (struct ast_channel *chan, int *width, int *height, int *buttons, int voice), { return 0; });
00203 
00204 /*!
00205  * \brief Begin an ADSI script download
00206  * \param buf Character buffer to create parameter in (must have at least 256 free)
00207  * \param service a 1-18 byte name of the feature
00208  * \param fdn 4 byte Feature Download Number (for loading soft keys)
00209  * \param sec 4 byte vendor security code
00210  * \param ver version number (0-255, or -1 to omit)
00211  *
00212  * \retval number of bytes added to buffer
00213  * \retval -1 on error.
00214  */
00215 
00216 AST_OPTIONAL_API(int, ast_adsi_download_connect, (unsigned char *buf, char *service, unsigned char *fdn, unsigned char *sec, int ver), { return 0; });
00217 
00218 /*!
00219  * \brief Disconnects a running session.
00220  * \param buf Character buffer to create parameter in (must have at least 256 free)
00221  *
00222  * \retval number of bytes added to buffer
00223  * \retval -1 on error.
00224  */
00225 AST_OPTIONAL_API(int, ast_adsi_disconnect_session, (unsigned char *buf), { return 0; });
00226 
00227 /*!
00228  * \brief Disconnects (and hopefully saves) a downloaded script
00229  * \param buf Character buffer to create parameter in (must have at least 256 free)
00230  *
00231  * \retval number of bytes added to buffer
00232  * \retval -1 on error.
00233  */
00234 AST_OPTIONAL_API(int, ast_adsi_download_disconnect, (unsigned char *buf), { return 0; });
00235 
00236 /*!
00237  * \brief Puts CPE in data mode.
00238  * \param buf Character buffer to create parameter in (must have at least 256 free)
00239  *
00240  * \retval number of bytes added to buffer
00241  * \retval -1 on error.
00242  */
00243 AST_OPTIONAL_API(int, ast_adsi_data_mode, (unsigned char *buf), { return 0; });
00244 AST_OPTIONAL_API(int, ast_adsi_clear_soft_keys, (unsigned char *buf), { return 0; });
00245 AST_OPTIONAL_API(int, ast_adsi_clear_screen, (unsigned char *buf), { return 0; });
00246 
00247 /*!
00248  * \brief Puts CPE in voice mode.
00249  * \param buf Character buffer to create parameter in (must have at least 256 free)
00250  * \param when (a time in seconds) to make the switch
00251  *
00252  * \retval number of bytes added to buffer
00253  * \retval -1 on error.
00254  */
00255 AST_OPTIONAL_API(int, ast_adsi_voice_mode, (unsigned char *buf, int when), { return 0; });
00256 
00257 /*!
00258  * \brief Returns non-zero if Channel does or might support ADSI
00259  * \param chan Channel to check
00260  */
00261 AST_OPTIONAL_API(int, ast_adsi_available, (struct ast_channel *chan), { return 0; });
00262 
00263 /*!
00264  * \brief Loads a line of info into the display.
00265  * \param buf Character buffer to create parameter in (must have at least 256 free)
00266  * \param page Page to load (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
00267  * \param line Line number to load (1-4 for Comm page, 1-33 for info page)
00268  * \param just Line justification (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CENT, ADSI_JUST_IND)
00269  * \param wrap Wrap (1 = yes, 0 = no)
00270  * \param col1 Text to place in first column
00271  * \param col2 Text to place in second column
00272  *
00273  * \retval number of bytes added to buffer
00274  * \retval -1 on error.
00275  */
00276 
00277 AST_OPTIONAL_API(int, ast_adsi_display, (unsigned char *buf, int page, int line, int just, int wrap, char *col1, char *col2), { return 0; });
00278 
00279 /*!
00280  * \brief Sets the current line and page.
00281  * \param buf Character buffer to create parameter in (must have at least 256 free)
00282  * \param page Which page (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
00283  * \param line Line number (1-33 for info page, 1-4 for comm page)
00284  *
00285  * \retval number of bytes added to buffer
00286  * \retval -1 on error.
00287  */
00288 
00289 AST_OPTIONAL_API(int, ast_adsi_set_line, (unsigned char *buf, int page, int line), { return 0; });
00290 
00291 /*!
00292  * \brief Creates "load soft key" parameters
00293  * \param buf Character buffer to create parameter in (must have at least 256 free)
00294  * \param key Key code from 2 to 33, for which key we are loading
00295  * \param llabel Long label for key (1-18 bytes)
00296  * \param slabel Short label for key (1-7 bytes)
00297  * \param ret Optional return sequence (NULL for none)
00298  * \param data whether to put CPE in data mode before sending digits
00299  *
00300  * \retval number of bytes added to buffer
00301  * \retval -1 on error.
00302  */
00303 AST_OPTIONAL_API(int, ast_adsi_load_soft_key, (unsigned char *buf, int key, const char *llabel, const char *slabel, char *ret, int data), { return 0; });
00304 
00305 /*!
00306  * \brief Set which soft keys should be displayed
00307  * \param buf Character buffer to create parameter in (must have at least 256 free)
00308  * \param keys Array of 8 unsigned chars with the key numbers, may be OR'd with ADSI_KEY_HILITE
00309  *             But remember, the last two keys aren't real keys, they're for scrolling
00310  *
00311  * \retval number of bytes added to buffer
00312  * \retval -1 on error.
00313  */
00314 AST_OPTIONAL_API(int, ast_adsi_set_keys, (unsigned char *buf, unsigned char *keys), { return 0; });
00315 
00316 /*!
00317  * \brief Set input information
00318  * \param buf Character buffer to create parameter in (must have at least 256 free)
00319  * \param page Which page to input on (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
00320  * \param line Line number to input on
00321  * \param display Set to zero to obscure input, or 1 to leave visible
00322  * \param format Format number to use (0-7)
00323  * \param just Justification (left, right center, indent)
00324  *
00325  * \retval number of bytes added to buffer
00326  * \retval -1 on error.
00327  */
00328 AST_OPTIONAL_API(int, ast_adsi_input_control, (unsigned char *buf, int page, int line, int display, int format, int just), { return 0; });
00329 
00330 /*!
00331  * \brief Set input format
00332  * \param buf Character buffer to create parameter in (must have at least 256 free)
00333  * \param num Which format we are setting
00334  * \param dir Which direction (ADSI_DIR_FROM_LEFT or ADSI_DIR_FROM_RIGHT)
00335  * \param wrap Set to 1 to permit line wrap, or 0 if not
00336  * \param format1 Format for column 1
00337  * \param format2 Format for column 2
00338  *
00339  * \retval number of bytes added to buffer
00340  * \retval -1 on error.
00341  */
00342 AST_OPTIONAL_API(int, ast_adsi_input_format, (unsigned char *buf, int num, int dir, int wrap, char *format1, char *format2), { return 0; });
00343 
00344 #endif /* _ASTERISK_ADSI_H */
00345 

Generated on Sat Mar 10 01:53:55 2012 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7