The Diva TTY driver management interface is located in the TTY device driver. It is structured like a virtual file space, containing directories and variables. Each directory and variable is identified by its path and name. A path contains a directory name followed by a specific variable or subdirectory that is separated by a backslash "\". TTY driver management interface is accessible via logical Diva Media Board number 1001. The TTY driver provides only one management entity, and cannot be accessed by multiple applications simultaneously. For this reason, the user should perform access in "exclusive" mode (divactrl mantool -Exclusive -c 1001 -r). In exclusive mode, divactrl mantool will use the file lock to synchronize the access to the management interface fully transparent to the caller.
You can use the management interface of the Diva TTY driver to obtain information about the Diva TTY driver, to change the configuration of the TTY driver and to view and to control the state of the Diva TTY interfaces.
The Diva TTY management interface contains the following directories:
The "GlobalOptions" management interface directory allows to change the values of the configuration parameters that affect the TTY interfaces (global configuration parameters). The values of these parameters are passed to the TTY driver module at load time. Using the management interface, allows for changing the values of parameters at run time.
Name |
Type |
Attribute |
Description |
GlobalOptionsRaw |
MI_HINT |
W |
Bitmask that reflects values of the boolean configuration parameters. |
FAX_FORCE_ECM |
MI_BOOLEAN |
W |
Use ECM, MR, MMR T.6 if supported by the opposite side. The Diva Media Board handles the conversion of MR/MMR (MMR/MR) compressed data transparent to the application. |
FAX_FORCE_V34 |
MI_BOOLEAN |
W |
Use V.34 (33600) fax if supported by the opposite side. V.34 connections are handled transparently to the application. They are indicated to the application as V.17 (14400) connections. |
FAX_FORCE_SEP_ |
MI_BOOLEAN |
W |
You can activate SEP/SUB/PWD (polled document selection, sub- addressing and polled document password protection). The Dialogic® Diva® TTY will report appropriate frames (if received) to the application. WARNING: Activate this option only if you really use the requested features. Otherwise it will slow down the connection establishment. |
TTY_INIT |
MI_ASCIIZ |
W |
TTY interface initialization string. You can use this parameter if your application cannot init the TTY interface |
The "CallFilter" management interface directory allows for configuration of the call filters. The call filter allows for processing of the calls with a specific Calling Party Number with a preconfigured protocol, instead of using the protocol auto-detection procedure. This can be necessary for callers with non-standard behavior, that does not allow reliable detection of the bearer protocol.
Name |
Type |
Attribute |
Description |
TotalFilters |
MI_UINT |
R |
Total amount of available call filters |
ActiveFilters |
MI_UINT |
R |
Total amount of used filters |
AvailableProtocols |
MI_UINT |
R |
Comma-separated list of the protocols that can be used in call filters |
FXX-YY |
MI_DIR |
R |
Directory that contains 50 (F1...F50) call filters |
Reset |
MI_EXECUTE |
R |
Used to clear and to de-activate the filters |
Every call filter consists of two entries: Calling Party Number and protocol to be used. The numbers are compared from behind, i.e., 123 with math 123, 77123, 721999123, ... .
Name |
Type |
Attribute |
Description |
Nr |
MI_UINT |
R |
Filter number |
Number |
MI_ASCIIZ |
W |
Calling Party Number |
Protocol |
MI_ASCIIZ |
W |
Protocol name |
Reset |
MI_EXECUTE |
R |
Used to clear and to de-activate current filter |
The "TTY" management interface directory allows you to control the state of the available TTY interfaces (TTY ports). Moreover, it is possible to issue one "DTR drop" to the TTY interface that will clear the connection and re-initialize the selected TTY interface.
Applications can use the context of this directory to retrieve the information about the last processed call (detected protocol, bit rate, calling party number, ...) and use this information for example for call-back.
Name |
Type |
Attribute |
Description |
Count |
MI_UINT |
R |
Total amount of ports available in the system |
Open |
MI_UINT |
R |
Total amount of ports in use |
Connected |
MI_UINT |
R |
Total amount of established connections |
TXX-YY |
MI_DIR |
R |
Directories that contains information about TTY interfaces |
Name |
Type |
Attribute |
Description |
Nr |
MI_UINT |
R |
Port number |
Open |
MI_ASCIIZ |
R |
Port status; indicates if current port is in use |
DCD |
MI_BOOLEAN |
R |
Indicates status of the DCD line |
Connected |
MI_ASCIIZ |
R |
Indicates status of the connection |
SystemName |
MI_ASCIIZ |
R |
Name of the device node in the "/dev" directory |
Protocol |
MI_UINT |
R |
Protocol used to process current (last) call |
ProtocolName |
MI_ASCIIZ |
R |
Name of the protocol used to process current (last) call |
Profile |
MI_UINT |
R |
TTY profile to select protocol used to process current (last) call |
AtInit |
MI_ASCIIZ |
R |
AT command to select protocol used to process current (last) call |
TxSpeed |
MI_UINT |
R |
Current (last) transmission speed |
RxSpeed |
MI_UINT |
R |
Current (last) reception speed |
DTR drop |
MI_EXECUTE |
R |
Used to issue "DTR drop" on current TTY interface |