dslt application note

7/30/2019 DSLT Application Note

1/29

DSLTDSLTDSLTDSLT

Application NoteApplication NoteApplication NoteApplication Note

Dialogic Corporation, Buffalo OfficeDialogic Corporation, Buffalo OfficeDialogic Corporation, Buffalo OfficeDialogic Corporation, Buffalo Office2350 North Forest RoadGetzville, New York, USA 14226Phone: 716-689-6700 Fax: 716-689-6800


2/29

DSLT Application Note

Copyright 2000 Dialogic Corporation. All rights reserved. 2 of 29

TABLE OF CONTENTS

1 FEATURES OF DSLT .................................................................................................................................. 3

2 API...................................................................................................................................................................... 4

2.1 NEW API FUNCTIONS .................................................................................................................................. 42.1.1 Function Prototypes .......... .......... .......... ........... .......... ........... .......... .......... ........... .......... ............ ......... 4

2.2 VBPC API SUPPORTED ON DSLT ........................................................................................................... 72.3 VBPC API NOT SUPPORTED ON DSLT.................................................................................................... 8

3 EVENTS.............................................................................................................................................................9

3.1 DSLT SPECIFIC EVENTS .......................................................................................................................... 93.2 VBPC EVENTS SUPPORTED ON DSLT..................................................................................................... 9

3.2.1 Appearance Based Events......... ........... .......... .......... ........... .......... ........... .......... .......... ........... .......... .. 93.2.1.1 Events and Detect Masks............................................................................................................... 10

3.2.2 Channel Based Events....................................................................................................................... 103.2.2.1 Events and Detection Masks ......................................................................................................... 11

4 VBPC BUTTON MAPS.................................................................................................................................. 12

4.1 COMMON DEFINES ..................................................................................................................................... 124.2 INTEGRATION SPECIFIC DEFINES ................................................................................................................ 13

4.2.1 Lucent 8400............... .......... ........... .......... .......... ........... .......... ........... .......... .......... ........... .......... ...... 134.2.1.1 Phone Map .................................................................................................................................... 13

4.2.2 Nortel Meridian 1.............. ........... ........... .......... ........... .......... ........... .......... ........... .......... ........... ...... 144.2.2.1 Phone Map .................................................................................................................................... 14

4.2.3 NEC............ .......... ........... .......... ........... .......... ........... .......... ........... .......... ........... .......... ........... ......... 154.2.3.1 Phone Map .................................................................................................................................... 15

4.2.4 Optiset ............................................................................................................................................... 164.2.4.1 Phone Map .................................................................................................................................... 16

5 CALL FLOWS................................................................................................................................................ 17

5.1 INCOMING.................................................................................................................................................. 175.2 INCOMING WITH SPEAKER.......................................................................................................................... 175.3 OUTGOING ................................................................................................................................................. 185.4 OUTGOING WITH CALL APPEARANCE ......................................................................................................... 19

6 FAR END DISCONNECT.............................................................................................................................. 20

6.1 LUCENT 8400............................................................................................................................................. 206.1.1 On-hook............................................................................................................................................. 206.1.2 Off-hook ............................................................................................................................................ 20

6.2 NEC.......... .......... ........... .......... ........... .......... ........... .......... ........... .......... ........... .......... .......... .......... .......... 206.2.1 On-hook............................................................................................................................................. 206.2.2 Off-hook ............................................................................................................................................ 21

6.3 NORTEL MERIDIAN 1.................................................................................................................................. 216.3.1 On-hook............................................................................................................................................. 216.3.2 Off-hook ............................................................................................................................................ 21

6.4 OPTISET ..................................................................................................................................................... 226.4.1 On-hook............................................................................................................................................. 226.4.2 Off-hook ............................................................................................................................................ 22

7 VOICE INFORMATION............................................................................................................................... 23

7.1 DSLTAPI VOICE CHANNEL FUNCTIONS ............................................................................................... 237.2 USING DSLT WITH DIALOGIC VOICE CARDS .......................................................................................... 257.3 EXAMPLE CODE TO ILLUSTRATE MAPPING OF TDM VOICE CHANNELS ..................................................... 26

8 CABLING REQUIREMENTS ...................................................................................................................... 28


3/29



1111 FEATURES OF DSLTFEATURES OF DSLTFEATURES OF DSLTFEATURES OF DSLT

The DSLT (Digital Set Line Tap) is a strictly passive device that monitors an existing connectionbetween a PBX and a Digital Set. Any phone activity on the line can be captured and processed by the

DSLT. The user receives host events through the PCI bus and voice information via the H.100interface. Also the user can retrieve additional information about the state of the phone by using theNative API.


4/29



2222 APIAPIAPIAPI

2.12.12.12.1 New API FunctionsNew API FunctionsNew API FunctionsNew API Functions

These new API functions are used to determine what the device information is for the specifiedchannel or board. This is useful if there is a mix of DSE and DSLT devices in the same system.

Other functions return the hook status and the voice state of the Digital Set.

These functions are valid on both DSE and DSLT channels or boards. However the functionsdse_get_phone_state and dse_get_voice_state are primarily intended for DSLT developers.

Native API Function Description

dse_get_channel_info Get the device information of a specific channel.

dse_get_device_info Get the device information.

dse_get_phone_state Get hook state of the digital set.

dse_get_voice_state Get the voice state of the digital set.

2.1.12.1.12.1.12.1.1 Function PrototypesFunction PrototypesFunction PrototypesFunction Prototypes

dse_get_channel_infodse_get_channel_infodse_get_channel_infodse_get_channel_info

Description:Description:Description:Description:Returns channel information. Allows user to determine if the specified channel is a DSE/DSLT channel.

Format:Format:Format:Format:

INT_T dse_get_channel_info (UINT_T channel, DSE_CHANNEL_INFO *info);

Input:Input:Input:Input:

UINT_T channel Channel number

DSE_CHANNEL_INFO *info Pointer to structure to contain the Product ID

DSE_ID_DSE DSE

DSE_ID_DSLT DSLT

Type:Type:Type:Type:

Blocking

Events:Events:Events:Events:

None

Return Value:Return Value:Return Value:Return Value:

VB_BAD_CHAN Invalid channel number.

VB_OK No errors.

Related Functions:Related Functions:Related Functions:Related Functions:

dse_get_device_info

Comments:Comments:Comments:Comments:Use this function to determine the product type of a given channel in a system. Applications should usethis to differentiate between DSE and DSLT channels.


5/29



dse_get_device_infodse_get_device_infodse_get_device_infodse_get_device_info

Description:Description:Description:Description:

Returns device information. Allows user to determine if the specified board is a DSE or a DSLT.


INT_T dse_get_device_info (UINT_T board, DSE_DEVICE_INFO *info);


UINT_T board Board number

DSE_DEVICE_INFO *info Pointer to structure to contain the Product ID

DSE_ID_DSE DSE

DSE_ID_DSLT DSLT


BlockingEvents:Events:Events:Events:

None


VB_NO_BOARD Invalid board number.

VB_OK No errors.


dse_get_channel_info

Comments:Comments:Comments:Comments:

Use this function to determine the product type of a given device in a system. Applications should usethis to differentiate between DSE and DSLT devices.

dse_get_phone_statedse_get_phone_statedse_get_phone_statedse_get_phone_state


Returns hook-switch state of the telephone attached to the DSLT or a DSE channel.


INT_T dse_get_phone_state(UINT_T channel, DSE_PHONE_STATE *phone_state);



DSE_PHONE_STATE *phone_state Pointer to structure containing the phone hook-switch state.

DSE_OFFHK Off Hook

DSE_ONHK On Hook


6/29




Blocking


None

Return Value:Return Value:Return Value:Return Value:VB_BAD_CHAN Invalid channel number.

VB_OK No errors.


None


This function allows an application to determine the hook-state of a connection on a DSLT or DSEchannel.

dse_get_voice_statedse_get_voice_statedse_get_voice_statedse_get_voice_state


Returns the active/inactive state of the voice connection between the telephone and the switch on aDSLT or DSE channel.


INT_T dse_get_voice_state (UINT_T channel, DSE_VOICE_STATE *voice_state);


UINT_T channel Channel numberDSE_VOICE_STATE *voice_state Pointer to structure to contain the active voice state

DSE_ACTIVE Voice Active

DSE_INACTIVE Voice Inactive


Blocking


None



VB_OK No errors.


None

Comments:Comments:Comments:Comments:This function allows an application to determine the voice state of a connection on a DSLT channel or a

DSE channel in order to determine if voice is active.


7/29



2.22.22.22.2 VBPC API Supported on DSLTVBPC API Supported on DSLTVBPC API Supported on DSLTVBPC API Supported on DSLT

The DSLT device also contains limited use of the VBPC API. Such uses of the following functionswould be to get raw displays and lamp states. Also, vb_get_eventvb_get_eventvb_get_eventvb_get_event must be used to retrieve eventsfrom the host event queue.

Native API Function Description

vb_chan_release Stop the current function on a channel.

vb_close_chan Close a channel.

vb_get_carrier_state Get the carrier state of a channel.

vb_get_cpid1 Get calling party data.

vb_get_cpid_ex1 Get calling party data including ANI/DNIS info.

vb_get_display Get raw display data.

vb_get_display_ex Get raw display data and allow for very largedisplays.

vb_get_drv_stat Get the status of the device driver.

vb_get_drv_ver Get the device driver revision level.

vb_get_err_mnemonic Get an error code mnemonic.

vb_get_err_str Get an error description message.

vb_get_event Get an event from the queue.

vb_get_evt_str Get mnemonic associated with an event type.

vb_get_int_vec Get driver interrupt vector number.

vb_get_light Get the raw light state.vb_get_line_state Get the hook state.

vb_get_pbx_type Get the type of PBX attached to a channel.

vb_get_switch_info Get the type of PBX and digital set.

vb_init_chan Initialize a channel.

vb_set_channel Enable or disable a specified channel.

vb_set_cpid_parms Set CPID parameters.

vb_set_detect_mask Enable or disable detection of specified eventson a channel.

vb_set_parm Set a specified parameter to a certain value.

vb_set_ring_delay Specify number of rings before ring event is sent.

vb_sys_release Stop the system.

vb_sys_reset Start the system.

1 The functions vb_get_cpid and vb_get_cpid_ex will execute to completion, but the data returned in theoutput parameters are not guaranteed to be accurate.


8/29



2.32.32.32.3 VBPC API Not Supported on DSLTVBPC API Not Supported on DSLTVBPC API Not Supported on DSLTVBPC API Not Supported on DSLT

Since the DSLT device is only passive, any API function that could alter the state of the line is notsupported. If one of the following functions are called it will return with VB_NOTIMP.

Native API Functions Description

vb_abort_xfer Abort a supervised transfer.

vb_complete_xfer Complete a supervised transfer.

vb_dial Dial a string of digits.

vb_drop_call Release a call.

vb_mwi Set or clear a message waiting light.

vb_press_key Press a key on the phone.

vb_seize_line Seize the first call appearance.

vb_set_interdigit_char Set pause character for dialing

vb_set_interdigit_delay Set delay time for interdigit character.

vb_set_key Press a key on the phone.

vb_set_key_state Press a key and wait for a lamp state change.

vb_set_line_state Set hook state of a channel.

vb_xfer Transfer a call.


9/29



3333 EVENTSEVENTSEVENTSEVENTS

3.13.13.13.1 DSLT Specific EventsDSLT Specific EventsDSLT Specific EventsDSLT Specific Events

These are DSLT device specific events that are used to determine when certain activities have takenplace on the Digital Set. Button presses, hook status and voice state changes are all reported asDSLT events.

The button press and release events return the VBPC button mapping number that is associated withthat specific key. Call appearance zero maps with button press 46 and each additional callappearance increments by one. (Note: For more detailed information see the following VBPC ButtonMapping section in this document.)

Be careful when using the voice active event because this does not necessarily mean that a call isconnected, only that the voice connection between the PBX and the Digital Set transitioned frominactive to active. This same would be true for the hook status events. If a Digital Set goes on-hookthis might not mean that the current call disconnected. (Note: For more information see the Call Flowand Far End Disconnect sections in this document.)

DSLT specific events are always enabled and there are no associated detection masks to disable theDigital Set events.

Native API Event Description

DSE_BUTTON_PRESS Button was pressed on the digital set.

DSE_BUTTON_RELEASE Button was released on the digital set.

DSE_PHONE_HOOK_OFF Digital Set is in an off-hook state.

DSE_PHONE_HOOK_ON Digital Set is an on-hook state.

DSE_VOICE_ACTIVE Voice is in an active state.

DSE_VOICE_INACTIVE Voice is in an inactive state.

3.23.23.23.2 VBPC Events Supported on DSLTVBPC Events Supported on DSLTVBPC Events Supported on DSLTVBPC Events Supported on DSLT

There are two types of events that can be enabled or disabled using the VBPC API. These areappearance based events and channel based events. Appearance based events include lamp statechanges and ring detected events and are enabled or disabled per zero-based call appearancenumber. Channel based events include things such as carrier detection and display stable events andare enabled or disabled per one-based channel number.

The default detection mask for DSLT has all channel based events enabled for all channels in thesystem, but all appearance based events are initially disabled.

3.2.13.2.13.2.13.2.1 Appearance Based EventsAppearance Based EventsAppearance Based EventsAppearance Based Events

Each call appearance can be configured with a different event detection mask by usingvb_set_detect_maskvb_set_detect_maskvb_set_detect_maskvb_set_detect_mask, passing the appropriate zero-based call appearance along with the requireddetect mask. To enable more than one event type for a given call appearance, use a bitwise or ofthe detect masks. For example, to enable ring detection, loop current on, and loop current off onthe second call appearance of channel 5, the call to vb_set_detect_maskvb_set_detect_maskvb_set_detect_maskvb_set_detect_mask would be:

vb_set_detect_mask (5, VB_RING_DETECTED|VB_LC_ON|VB_LC_OFF, 1);

The detect mask for a given appearance is completely set with each vb_set_detect_maskvb_set_detect_maskvb_set_detect_maskvb_set_detect_mask call.Therefore, set all event enabling and disabling with a single vb_set_detect_maskvb_set_detect_maskvb_set_detect_maskvb_set_detect_mask function call. After


10/29



that, vb_set_detect_maskvb_set_detect_maskvb_set_detect_maskvb_set_detect_mask only needs to be called again when the events reporting requirements ofan application change.

To disable all events for a given appearance, set the detect mask to 0.

3.2.1.13.2.1.13.2.1.13.2.1.1 Events and Detect MasksEvents and Detect MasksEvents and Detect MasksEvents and Detect Masks

The event data returned by vb_get_eventvb_get_eventvb_get_eventvb_get_event contains the zero-based appearance number of the callappearance for which the event occurred.

Native API Event Description Detection Mask

VB_LC_ON Gain in loop current isdetected. Lamp statetransition from off or flashto steady.

VB_ENBL_LC_ON

VB_LC_OFF Drop in loop current isdetected. Lamp state

transition to off.

VB_ENBL_LC_OFF

VB_LIGHT_CHANGE Call appearance lamp statechange.

VB_ENBL_LT_CHG

VB_LIGHT_DARK Call appearance lamp stateis off.

VB_ENBL_DARK

VB_LIGHT_BLINK

VB_LIGHT_BLINK_RED

Call appearance lamp stateis blink.

VB_ENBL_BLINK

VB_LIGHT_FLASH

VB_LIGHT_FLASH_RED

Call appearance lamp stateflash.

VB_ENBL_FLASH

VB_LIGHT_STEADY

VB_LIGHT_STEADY_RED

Call appearance lamp state

steady.

VB_ENBL_STEADY

VB_LIGHT_WINK

VB_LIGHT_WINK_RED

Call appearance lamp statewink.

VB_ENBL_WINK

VB_RING_DETECTED Incoming ring is detected. VB_ENBL_RING

3.2.23.2.23.2.23.2.2 Channel Based EventsChannel Based EventsChannel Based EventsChannel Based Events

To set the detect mask for carrier and display stable events, a separate vb_set_detect_maskvb_set_detect_maskvb_set_detect_maskvb_set_detect_mask must becalled for each desired channel. Channel based events are maskable independent of individualappearance events. For example to enable gain of carrier detection and loss of carrier detection onchannel 5, the call to vb_set_detect_maskvb_set_detect_maskvb_set_detect_maskvb_set_detect_mask would be:

vb_set_detect_mask (5, VB_ENABLE_CD_ON|VB_ENABLE_CD_OFF, VB_CHANNEL_MASK);


11/29



3.2.2.13.2.2.13.2.2.13.2.2.1 Events and Detection MasksEvents and Detection MasksEvents and Detection MasksEvents and Detection Masks

The event data returned by vb_get_eventvb_get_eventvb_get_eventvb_get_event contains the one-based channel number of the channel forwhich the event occurred.

Native API Event Description Detection Mask

VB_DISP_STABLE Display changed and it isstable.

VB_ENBL_DISP_STABLE_CLEAR

VB_ENBL_DISP_STABLE_FILLED

VB_GAIN_CARRIER Gain of carrier is detected. VB_ENBL_CD_ON

VB_LOSS_CARRIER Loss of carrier is detected. VB_ENBL_CD_OFF

VB_MISC_LIGHT_CHANGE Miscellaneous lamp statechange.

VB_ENBL_MISC_LIGHT_CHANGE


12/29



4444 VBPC BUTTON MAPSVBPC BUTTON MAPSVBPC BUTTON MAPSVBPC BUTTON MAPS

These button maps are useful to the DSLT user because when a button press event or a non-call appearancelamp event is received the corresponding mapped button number is also returned. An example would be ifan 11 was returned with a button press event, then the user would know that the pound dialpad key (#) wasthe button that was pressed.

Remember that only button press and release events and miscellaneous lamp state change events return the

following button mapping. All other events return a zero-based appearance number and\or a one-basedchannel number.

The internal DSLT button mapping is mapped to the largest Digital Set available for each PBX, thereforealmost every button or lamp should have a corresponding event. The only case would be if certain buttonpresses and lamp state changes are only local to the phone and no information is passed to or from the PBX.

4.14.14.14.1 Common DefinesCommon DefinesCommon DefinesCommon Defines

The following defines are common across all integrations.

NUMBER_0_KEY 0 /* 0 keypad key */NUMBER_1_KEY 1 /* 1 keypad key */NUMBER_2_KEY 2 /* 2 keypad key */NUMBER_3_KEY 3 /* 3 keypad key */

NUMBER_4_KEY 4 /* 4 keypad key */NUMBER_5_KEY 5 /* 5 keypad key */NUMBER_6_KEY 6 /* 6 keypad key */NUMBER_7_KEY 7 /* 7 keypad key */NUMBER_8_KEY 8 /* 8 keypad key */NUMBER_9_KEY 9 /* 9 keypad key */STAR_KEY 10 /* * keypad key */POUND_KEY 11 /* # keypad key */DTMF_A 12 /* DTMF A */DTMF_B 13 /* DTMF B */DTMF_C 14 /* DTMF C */DTMF_D 15 /* DTMF D */HOLD_KEY 16 /* Hold key */DISCONNECT_KEY 17 /* Disconnect key */TRANSFER_KEY 18 /* Transfer key */MWI_LIGHT 19 /* MWI lamp */

DISPLAY_KEY 20 /* Display key */CONFERENCE_KEY 21 /* Conference key */DROP_KEY 22 /* Drop key */RECALL_KEY 23 /* Recall key */DISPLAY_KEY_1 24 /* Display key 1 (softkey) */DISPLAY_KEY_2 25 /* Display key 2 (softkey) */DISPLAY_KEY_3 26 /* Display key 3 (softkey) */DISPLAY_KEY_4 27 /* Display key 4 (softkey) */DISPLAY_KEY_5 28 /* Display key 5 (softkey) */DISPLAY_KEY_6 29 /* Display key 6 (softkey) */DISPLAY_KEY_7 30 /* Display key 7 (softkey) */DISPLAY_KEY_8 31 /* Display key 8 (softkey) */RELEASE_KEY 32 /* Release key */VOLUME_UP 33 /* Volume Up */VOLUME_DOWN 34 /* Volume Down */MICROPHONE_KEY 35 /* Microphone key */HANDS_FREE_KEY 36 /* Hands-free key */PROGRAM_KEY 37 /* Program key */HOOK_SWITCH 38 /* Hook switch */SEL_FEATURE_KEY 39 /* Select Feature key */SPEAKER_KEY 40 /* Speaker key */


13/29



4.24.24.24.2 IntegrationIntegrationIntegrationIntegration Specific DefinesSpecific DefinesSpecific DefinesSpecific Defines

The following defines are specific to each integration. The common link between them is that all callappearances start at number 46. The user will receive an event for all buttons and lamps that are not local tothe phone, but the DSLT only supports commonality among integrations for the first seven call appearances.If more call appearances are enabled and the user sees events that seem abnormal then consult thecorresponding phone map for that integration. In addition, soft keys are not supported for any of the

integrations.

4.2.14.2.14.2.14.2.1 Lucent 8400Lucent 8400Lucent 8400Lucent 8400

Lucent dialpad keys will not have a corresponding DSE_BUTTON_PRESS event because the dialing digits aretransferred as in-band DTMF tones to the PBX. To capture dialpad key press events for Lucent an additionalDSP resource is needed.

Also, the Login button for Callmaster IV sets is mapped to KN67 and the Redial button on the 6400 series setsis not mapped.

Finally, DSLT does not support softkeys on any Lucent phone except an 8434DX.

START_APP 46 /* Start Call App */END_APP 79 /* End Call App */

START_FB 100 /* Start Feature keys */END_FB 114 /* End Feature keys */

4.2.1.14.2.1.14.2.1.14.2.1.1 Phone MapPhone MapPhone MapPhone Map


14/29



4.2.24.2.24.2.24.2.2 Nortel Meridian 1Nortel Meridian 1Nortel Meridian 1Nortel Meridian 1

On Meridian 2616, the volume up/down (KN33 & KN34), and Appearance 7 (KN53) buttons are local to thephone. Therefore no key press or release events are passed to PBX.




15/29



4.2.34.2.34.2.34.2.3 NECNECNECNEC

HELP_KEY 41 /* Help Key */EXIT_KEY 42 /* Exit Key */LNR_SNR_KEY 43 /* Redial Key */ANS_KEY 44 /* Answer Key */ICM_LIGHT 45 /* Intercom Lamp */START_APP 46 /* Start Call App */END_APP 89 /* End Call App */

4.2.3.14.2.3.14.2.3.14.2.3.1 Phone MapPhone MapPhone MapPhone Map2222

2 NEC Lamp State Events (Special lamp states/events):

When light is Green:When light is Green:When light is Green:When light is Green: When light is Red:When light is Red:When light is Red:When light is Red: When light is Dark:When light is Dark:When light is Dark:When light is Dark:

VB_LIGHT_STEADY VB_LIGHT_STEADY_RED VB_LIGHT_DARK

VB_LIGHT_FLASH VB_LIGHT_FLASH_RED

VB_LIGHT_BLINK VB_LIGHT_BLINK_RED

VB_LIGHT_WINK VB_LIGHT_WINK_RED

The RED light events are enabled along with the standard light events (e.g. Invoking vb_set_detect_mask()with VB_ENBL_STEADY parameter enables VB_LIGHT_STEADY and VB_LIGHT_STEADY_RED events.


16/29



4.2.44.2.44.2.44.2.4 OptisetOptisetOptisetOptiset



KN 54AP 8

Optiset E Advance

Plus

1 2 3

4 5 6

7 8 9

* 0 #

KN 55

KN 56+

-

KN 57

KN 46

KN 47

KN 48

KN 49

KN 50

KN 51

KN 52

KN 53

Display Size = 2x24SIEMENS

AP 9

AP 10 AP 6

AP 5

AP 4

AP 3

AP 2

AP 1

AP 0

KN 33

KN 34

KN 24 KN 26

KN 38

Hook

KN 25

AP 7AP 11


17/29



5555 CALL FLOWSCALL FLOWSCALL FLOWSCALL FLOWS

The following sections contain sample event captures from different call scenarios with all channel based andappearance based events enabled. Two are inbound calls ringing the primary call appearance with oneanswering the call by going off-hook and the other by pressing the speaker key. There is also a capture of anoutgoing call were the user goes off-hook and then dials an extension.

The events received during a logging session depend on the type of call (external inbound call, internal

inbound call, etc), the type of phone, and the type of integration. Therefore the DSLT user should notassume that they would get the same events on different PBXs even though the call scenario might be similar.

5.15.15.15.1 IncomingIncomingIncomingIncoming

A call is inbound to the phone and it is ringing on call appearance zero.

Channel Index Event Data Event Data Description Event

1 0000 Call Appearance VB_LIGHT_CHANGE

1 0000 Call Appearance VB_LIGHT_FLASH

1 0000 Call Appearance VB_RING_DETECTED

1 0001 Display Filled VB_DISP_STABLE

The Digital Set user lifts the handset and goes off-hook.


1 0000 DSE_PHONE_HOOK_OFF

1 0000 DSE_VOICE_ACTIVE


1 0000 Call Appearance VB_LIGHT_STEADY

1 0000 Call Appearance VB_LC_ON

The Digital Set user returns the handset to the on-hook state.


1 0000 DSE_PHONE_HOOK_ON

1 0000 DSE_VOICE_INACTIVE1 0000 Call Appearance VB_LIGHT_CHANGE

1 0000 Call Appearance VB_LIGHT_DARK

1 0000 Call Appearance VB_LC_OFF


5.25.25.25.2 Incoming with SpeakerIncoming with SpeakerIncoming with SpeakerIncoming with Speaker

A call is inbound to the phone and it is ringing on call appearance zero.


1 0000 Call Appearance VB_LIGHT_CHANGE1 0000 Call Appearance VB_LIGHT_FLASH

1 0000 VB_RING_DETECTED


The phone user presses the speaker key, but is still on-hook.


1 0040 Button Index (speaker) DSE_BUTTON_PRESS

1 0040 Button Index (speaker) DSE_BUTTON_RELEASE



18/29



1 0040 Button Index (speaker) VB_MISC_LIGHT_CHANGE




The phone user presses the speaker key again to release the call.

Channel Index Event Data Event Data Description Event1 0040 Button Index (speaker) DSE_BUTTON_PRESS

1 0040 Button Index (speaker) DSE_BUTTON_RELEASE

1 0000 DSE_VOICE_INACTIVE

1 0040 Button Index (speaker) VB_MISC_LIGHT_CHANGE





5.35.35.35.3 OutgoingOutgoingOutgoingOutgoing

The user of the Digital Set goes off-hook.


1 0000 DSE_PHONE_HOOK_OFF






The phone user dials extension 123 on the keypad.

Channel Index Event Data Event Data Description Event1 0001 Button Index (1) DSE_BUTTON_PRESS

1 0001 Button Index (1) DSE-BUTTON_RELEASE

1 0002 Button Index (2) DSE_BUTTON_PRESS

1 0002 Button Index (2) DSE-BUTTON_RELEASE


1 0003 Button Index (3) DSE_BUTTON_RELEASE


The phone user returns the handset back to the on-hook position.


1 0000 DSE_PHONE_HOOK_ON

1 0000 DSE_VOICE_INACTIVE1 0000 Call Appearance VB_LIGHT_CHANGE





19/29



5.45.45.45.4 Outgoing with Call AppearanceOutgoing with Call AppearanceOutgoing with Call AppearanceOutgoing with Call Appearance

The user of the Digital Set presses the primary call appearance.


1 0046 Button Index (Call Appearance 0) DSE_BUTTON_PRESS

1 0046 Button Index (Call Appearance 0) DSE_BUTTON_RELEASE


1 0000 Call Appearance VB_LIGHT_CHANGE1 0000 Call Appearance VB_LIGHT_STEADY



The phone user dials extension 123 on the keypad.









The phone user presses the call appearance again to release the call.


1 0046 Button Index (Call Appearance 0) DSE_BUTTON_PRESS

1 0046 Button Index (Call Appearance 0) DSE_BUTTON_RELEASE







20/29



6666 FAR END DISCONNECTFAR END DISCONNECTFAR END DISCONNECTFAR END DISCONNECT

Different integrations may have different ways of signaling that a call has been disconnected. If the Digital Setuser drops the call, known button press and lamp state changes can be captured through host events, but ifthe far end party abandons the call sometimes voice state and lamp state changes cannot be counted upon.

The DSLT is limited to what activity is captured on the line between the PBX and the Digital Set user so if noinformation is passed back through the line the user can only wait and receive whatever the PBX is going to

do.If the DSE_VOICE_INACTIVE event is not seen during the disconnect of a call then consult the sample tablesbelow of what each integration will see on a internal far end disconnect and what events that will be seendepending if the handset was on-hook or off-hook.

6.16.16.16.1 Lucent 8400Lucent 8400Lucent 8400Lucent 8400

6.1.16.1.16.1.16.1.1 OnOnOnOn----hookhookhookhook

Action Event

Red Call Appearance OFF 1 0040 VB_MISC_LIGHT_CHANGE

Green Call Appearance OFF 1 0000 VB_LIGHT_CHANGE1 0000 VB_LIGHT_DARK1 0000 VB_LC_OFF

Red Call Appearance ON 1 0040 VB_MISC_LIGHT_CHANGE

Never receives DSE_VOICE_INACTIVE

6.1.26.1.26.1.26.1.2 OffOffOffOff----hhhhookookookook

Action Event

Red Call Appearance OFF 1 0040 VB_MISC_LIGHT_CHANGE

Green Call Appearance OFF1 0000 VB_LIGHT_CHANGE1 0000 VB_LIGHT_DARK1 0000 VB_LC_OFF

Will not receive DSE_VOICE_INACTIVE andDSE_PHONE_HOOK_ON until user goes backon-hook.

6.26.26.26.2 NENENENECCCC


Action Event (NEAX IAS IAG) Event (NEAX IAX)

Reorder Tone for 35 seconds True False

Flashing HANG UP! in display 1 0001 VB_DISP_STABLE False


21/29



Call Appearance ON OFF and the following events:

1 0000 VB_LIGHT_CHANGE

1 0000 VB_LIGHT_DARK

1 0000 VB_LC_OFF


6.2.26.2.26.2.26.2.2 OffOffOffOff----hookhookhookhook

Action Event

Reorder Tone for 35 seconds

Flashing HANG UP! in display1 0001 VB_DISP_STABLE

Call Appearance stays ON


6.36.36.36.3 Nortel Meridian 1Nortel Meridian 1Nortel Meridian 1Nortel Meridian 1


Action Event

Call Appearance OFF1 0000 VB_LIGHT_CHANGE1 0000 VB_LIGHT_DARK1 0000 VB_LC_OFF1 0000 DSE_VOICE_INACTIVE

Call duration time stays in display for 10seconds

1 0001 VB_DISP_STABLE


Action Event

Call Appearance OFF1 0000 VB_LIGHT_CHANGE

1 0000 VB_LIGHT_DARK1 0000 VB_LC_OFF

Call duration time stays in display for 10seconds

1 0001 VB_DISP_STABLE



22/29



6.46.46.46.4 OptisetOptisetOptisetOptiset


Action Event

Call Appearance OFF

1 0000 VB_LIGHT_CHANGE

1 0000 VB_LIGHT_DARK1 0000 VB_LC_OFF1 0000 DSE_VOICE_INACTIVE


Action Event

Clear? shown in display 1 0001 VB_DISP_STABLE

Busy Tone for 10 seconds

Call Appearance OFF 1 0000 VB_LIGHT_CHANGE1 0000 VB_LIGHT_DARK1 0000 VB_LC_OFF

Will not receive DSE_VOICE_INACTIVE andDSE_PHONE_HOOK_ON until user goes backon-hook


23/29



7777 VOICE INFORMATIONVOICE INFORMATIONVOICE INFORMATIONVOICE INFORMATION

7.17.17.17.1 DSLTDSLTDSLTDSLT API Voice Channel FunctionsAPI Voice Channel FunctionsAPI Voice Channel FunctionsAPI Voice Channel Functions

The DSLT allows the capture of the voice channel for both the PBX and Set side of the Tap. The mapping of

DSLT voice channels to SCBus/H.100 time slots is managed through the API calls vb_set_xmittslot() andvb_get_xmittslot(). These calls are documented below.

vb_set_xmitslotvb_set_xmitslotvb_set_xmitslotvb_set_xmitslot

DescripDescripDescripDescription:tion:tion:tion:

Assigns a local transmit time slot on the SCBus or H.100 voice bus


INT_T vb_setxmitslot (UINT_T channel, VB_SC_TSINFO *sc_tsinfo, USHORT_T bearer_ch)



VB_SC_TSINFO *sc_tsinfo Pointer to the SCBus timeslot information structure

USHORT_T bearer_ch The bearer channel of the PBX and Set Channel.

SC_VOICE for the PBX

SC_VOICE_PHONE for the Set side


Blocking


None



VB_OK No errors.

VB_BD_FAIL Failure on the board.

VB_NO_BOARD Driver is present but no boards are installed.

VB_NO_DRVR No device driver present.

VB_SC_INV_BEARER_CH Invalid bearer channel number.

VB_SC_SETXMIT_FAIL Internal firmware error.


vb_get_xmittslot



24/29



vb_get_xmitslotvb_get_xmitslotvb_get_xmitslotvb_get_xmitslot


Queries the SCBus or H.100 switch matrix for the assigned local transmit time slot used by a bearer

channel.


INT_T vb_getxmitslot (UINT_T channel, VB_SC_TSINFO *sc_tsinfo, USHORT_T bearer_ch)



VB_SC_TSINFO *sc_tsinfo Pointer to the SCBus timeslot information structure

USHORT_T bearer_ch The bearer channel of the PBX and Set Channel.

SC_VOICE for the PBX

SC_VOICE_PHONE for the Set side


Blocking


None



VB_OK No errors.VB_BD_FAIL Failure on the board.

VB_NO_BOARD Driver is present but no boards are installed.

VB_NO_DRVR No device driver present.

VB_SC_INV_BEARER_CH Invalid bearer channel number.

VB_SC_BC_NOT_XMITTING The bearer channel is not transmitting on the voice bus.

VB_SC_SETXMIT_FAIL Internal firmware error.


vb_set_xmittslot


The sc_tsarrayp field of the structure must be initialized with a pointer to a valid array before invoking thefunction. Upon return, the VB_SC_TSINFO structure contains the number of the Scbus / H.100 transmittime slots the channel is driving (sc_numts always set to 1) and the time slot on which the specified bearerchannel is transmitting (sc_tsarrayp[0]).


25/29



Typically, vb_set_xmittslot() will be used only at system initialization to set the local TDM bus to SCBus/H.100bus mapping that will be used for the rest of time. Applications then query the system using vb_get_xmittslot()in order to use the mapping that has been setup.

7.27.27.27.2 Using DSLTUsing DSLTUsing DSLTUsing DSLT with Dialogic Voice Cardswith Dialogic Voice Cardswith Dialogic Voice Cardswith Dialogic Voice Cards

When using the DSLT in conjunction with Dialogic Voice cards, the SCBus/H.100 timeslots are assignedduring driver initialization. The slots are assign so that all PBX side channels are assigned starting at timeslot 0and all of the Set side are assigned immediately after the PBX slots.

For example, in a system with a DSE board with 16 channels of Set emulation and a DSLT board, theSCBus/H.100 time slots would be assigned as follows:

Voice Channels SCBus/H.100Time Slots

DSE channels 0-15 0-15

DSLT PBX 16-31

DSLT Set 32-47

TableTableTableTable 1111 ---- SCBus/H.100 Time Slot AssignementsSCBus/H.100 Time Slot AssignementsSCBus/H.100 Time Slot AssignementsSCBus/H.100 Time Slot Assignements


26/29



7.37.37.37.3 Example Code to Illustrate mapping of TDMExample Code to Illustrate mapping of TDMExample Code to Illustrate mapping of TDMExample Code to Illustrate mapping of TDM Voice ChannelsVoice ChannelsVoice ChannelsVoice Channels

/////////////////////////////////////////////////////////////////////////////////////////

//

// routeChannel

//

// Routes a DSLT voice channel to a dialogic voice channel//

// Input:

// dialogicDevName - The Name of the dialogic voice channel

// port - The DLST channel number

// bearerChannel - The DSLT bearer channel (SC_VOICE or SC_VOICE_PHONE)

//

// return:

// BOOL - Success or Failure

//

/////////////////////////////////////////////////////////////////////////////////////////

BOOL RouteSCBus::routeChannel(const CString& dialogicDevName, UINT port, UINT bearerChan)

{

CString str;long vbts;

int dialogic_dev;

SC_TSINFO sc_tsinfo; // SCBus Timeslots information structure

VB_SC_TSINFO vb_tsinfo; // DSLT Timeslot information structure

VB_RETURN_STATUS_T vb_return_status;

vb_tsinfo.sc_numts = 1;

vb_tsinfo.sc_tsarrayp = &vbts;

// open the dialogic channel

dialogic_dev = dx_open(dialogicDevName, NULL);

if (dialogic_dev == -1)

{

OutputDebugString("RouteSCBus::getRouteInfo: failed dx_open\n");

return FALSE;

}

// open the DSLT channel

if ((vb_return_status = vb_init_chan((INT_T)port)) != VB_OK)

{

OutputDebugString("RouteSCBus: vb_init_chan failed\n");

return FALSE;

}

// get the SCBus/H.100 time slot of the DSLT voice channel

vb_return_status = vb_getxmitslot((unsigned short)port,

&vb_tsinfo,

(unsigned short)bearerChan);

if (vb_return_status != VB_OK)

{

str.Format("RouteSCBus: %d: vb_getxmitslot ERROR: %s\n",

port,(char *) vb_get_err_str (vb_return_status));

OutputDebugString(str);


27/29



return FALSE;

}

// Close the DSLT channel

if ((vb_return_status = vb_close_chan((INT_T)port)) != VB_OK)

{

OutputDebugString("RouteSCBus: vb_close_chan failed\n");

}

// copy VBPC time slot info to Dialogic time slot info

sc_tsinfo.sc_numts = vb_tsinfo.sc_numts;

sc_tsinfo.sc_tsarrayp = vb_tsinfo.sc_tsarrayp;

// tell the dialogic voice channel to listen on the

// SCBus/H.100 time slot that DSLT is transmitting on

if (dx_listen(dialogic_dev, &sc_tsinfo) == -1)

{

str.Format("nr_scroute: %s: Cannot dx_listen %d ERROR: %s\n",

ATDV_NAMEP(dialogic_dev),

sc_tsinfo.sc_tsarrayp[0],

ATDV_ERRMSGP(dialogic_dev));OutputDebugString(str);

return FALSE;

}

// close the dialogic channel

dx_close(dialogic_dev);

return TRUE;

}


28/29



8888 CABLING REQUIREMENTSCABLING REQUIREMENTSCABLING REQUIREMENTSCABLING REQUIREMENTS

The following table shows the required pinout when connecting to the DSLT 8 using a type 66 interconnectblock and the DSLT 8 Telco Cable shipped with the product.

Physical PairNumber

Pin Number Pair Color Board Channel

1 261

White-BlueBlue-White

1

2 283

White-GreenGreen-White

9

3 294

White-BrownBrown-White

2

4 316

Red-BlueBlue-Red

10

5 327

Red-OrangeOrange-Red

3

6 349

Red-BrownBrown-Red

11

7 3510 Red-SlateSlate-Red 4

8 3712

Black-OrangeOrange-Black

12

9 3813

Black-GreenGreen-Black

5

10 4015

Black-SlateSlate-Black

13

11 4116

Yellow-BlueBlue-Yellow

6

12 4318

Yellow-GreenGreen-Yellow

14

13 44

19

Yellow-Brown

Brown-Yellow

7

14 4621

Violet-BlueBlue-Violet

15

15 4722

Violet-OrangeOrange-Violet

8

16 4924

Violet-BrownBrown-Violet

16


29/29


The following figure shows the port assignments when using the optional break box. Note that in this figure,the DSLT channel number are identified by the LT and are 0 based. For example, the first channel on a DSLTboard uses the pair 26/1 and is identified by LT0.

123

3

16 1015

813 4

11 27

05 914

50/25 45/20 40/15 35/10 30/5

49/24 44/19 39/14 34/9 29/4

48/23 43/18 38/13 33/8 28/3

47/22 42/17 37/12 32/7 27/2

46/21 41/16 36/11 31/6 26/1

DSE / DSLT BREAKOUT BOX

PORT ASIGNMENT

dslt application note

Documents