libvpb  4.2.55
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Utility programs

The libvpb distribution includes a number of utility programs which may be helpful for testing your hardware, tuning the software parameters, and performing other simple tasks related to creating your own applications.


Device and driver information

The following utilities may be used to query device and driver information:

vpbscan

The vpbscan utility will scan the pci bus and report on any Voicetronix hardware found in the machine. This utility does not require kernel driver support for the cards, but can only report the most basic information about the type and presence of cards in a machine. It is used by the VpbConfigurator utility to assist with creating a basic configuration for a new system installation. You should not normally need to call this yourself, but it may be useful for low level applications.

vpbconf

The vpbconf utility will query configured Voicetronix hardware for model and port information. It requires kernel driver support for the cards, and for early model cards that cannot be properly autodetected, a correctly defined configuration file must be present as well. It is used by the PbxConfigurator utility from the OpenPBX distribution to set up a basic PBX configuration for the available hardware.

vtdeviceinfo

The vtdeviceinfo utility will query real time information about the state of installed Voicetronix hardware from the kernel /proc interface. It requires kernel driver support for the cards.

vtdriverinfo

The vtdriverinfo utility will query information about the state of the Voicetronix kernel drivers from the kernel /sys interface. It will report the driver version and module parameter values for each Voicetronix driver loaded in the running kernel, even if no cards are bound to them.


Tuning utilities

The following utilities are used to optimise or alter the operation of the support software for Voicetronix hardware:

tonetrain

The tonetrain utility is used to analyse recorded signal tones to determine the parameters required for the programmable tone detector to detect them.

tonedebug

The tonedebug utility is used to verify that the parameters used for the programmable tone detector actually do detect samples of the intended tones.


Audio utilities

The following utilities are used to optimise or alter the operation of the support software for Voicetronix hardware:

recwav

The recwav utility is used to record audio data from a Voicetronix hardware port.

playwav

The playwav utility is used to play audio data to a Voicetronix hardware port.


Test utilities

The following utilities are used to test the operation of installed Voicetronix hardware:

vpbecho

The vpbecho utility performs a simple echo test on any or all ports. It will record a short period of audio data from a port, then play it back into that same port. For FXS ports, recording will begin when the handset goes off hook. For FXO ports, the line will be answered and recording commenced after the second ring of an incoming call.

measerl

The measerl utility performs some simple tests to determine the echo return loss of the line. For cards with manually tuned hybrid circuits, this may be used to help determine the optimal settings for them.

ringstat

The ringstat utility exercises the ring generators of all FXS ports This is mostly used as a stress test to confirm the ringing operation of the cards under a worst case load.

Todo:
include cidtest, deccid, samcid and tv4log here too.