You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Generic Card Configure 0x0122

Generic Card Configure 0x0122

SwitchKit Name

GenericCardConfigure

Type

EXS API and SwitchKit API message

Description

Generic Card Configure 0x0122

Use this message for a variety of card configuration options.

DSP Series 2 Card

For the DSP Series 2 card, use this message to configure the following:

Card-level Defaults

Alarms

NFS location and Vocabulary Index File

Sequence Number Size (8-bit or 16-bit)

Advanced Conferencing Features

T.30 Fax Parameters

Positive Voice Detection/Answering Machine Detection

Echo Cancellation Parameters

Dial Pulse Detection Parameters

Sent by

Host Application

Related API Message

Generic Card Query

SwitchKit Code

C Structure

typedef struct {

UBYTE Slot;

UBYTE reserved18[29];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_GenericCardConfigure;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE TLVCount;

UBYTE Data[250];

} XL_GenericCardConfigure;

C++ Class

class XLC_GenericCardConfigure : public XLC_OutboundMessage {

public:

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getDataType() const;

void setDataType(UBYTE x);

UBYTE getTLVCount() const;

void setTLVCount(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

C++ Class Response

class XLC_GenericCardConfigureAck : public XLC_OutboundMessage {

public:

unsigned short getStatus() const

void setStatus(unsigned short x)

UBYTE getTLVCount() const;

void setTLVCount(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x)

;

EXS API Hex Format

MESSAGE (White) | RESPONSE (Gray)
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0x00NN) | 1, 2 | Length (0x00NN)
3, 4 | Message Type (0x0122) | 3, 4 | Message Type (0x0122)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
: | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status (MSB, LSB) 0x0001 Invalid TLV Data Software can't find the TLV Data Buffer. This can also occur if the Data for a TLV is out of range. 0x0002 Invalid Data Type 0x0003 Invalid number of TLVs There are no TLVs in the message. 0x0004 Invalid TLV Length The TLV length is different from what is expected. 0x0006 Invalid TLV Unknown TLV 0x000D Mandatory TLVs missing One or more mandatory TLVs are missing Also see Common Response Status Values.
10 | Number of TLVs to Follow
Number of AEs to follow
AE 0x01 Slot
: | Data Type 0x00 TLVs | : | TLVs
: | Number of TLVs to Follow | : | Checksum
: | TLVs Mandatory TLV: 0x05FA Card Object* 0x0000 - General Card Configuration 0x0001 - Conferencing Parameters 0x0003 - Alarm Configuration 0x0004 - DSP Series 2 Fax Parameters Query 0x0005 - Echo Cancel 0x0006 - Pvd/AMD Parameters 0x0007 - Dial Pulse Detection Parameters Optional TLVs: 0x05DC File Management Configuration (mandatory for initial configuration, optional after that) 0x05DD Server Address (mandatory for initial configuration of NFS, optional after that) 0x05DF Vocabulary Index File (mandatory for initial configuration of NFS, optional after that) 0x05EF Alarm Threshold Configure (up to 16) 0x05F0 DSP 2 Main Board Memory Alarm Threshold Configure (up to 2) 0x05F1 DSP Temporary Memory Alarm Threshold Configure (up to 2) 0x05F4 Statistics Update Timer 0x0600 NFS User Group ID 0x0601 NFS Poll Retries 0x0619 PVD Parameters 0x061A AMD Parameters 0x061B AMD Reports 0x0640 Matrix/Host Sequence Number Size* 0x0750 Dial Pulse Detection Parameters - This TLV is sent to configure the Dial Pulse Detection Parameters (0x0007). See 0x05FA Card Object TLV above. * Use mandatory Card Object TLV 0x05FA (with Object ID 0x0000) and optional Matrix/Host Sequence Number Size TLV 0x0640 to select an 8 or 16 bit Sequence Number as follows: 0x00 - 8 bit 0x01 - 16 bit The following optional TLVs set the card-level defaults: 0x0607 Output Gain Control (default 0db) 0x0608 Noise Gating Enable (default disabled) 0x0609 Noise Gate Parameters 0x060A Echo Suppression Enable (default disabled) 0x060B Echo Suppression Parameters 0x060C Automatic Gain Control Enable (default disabled) 0x060D Automatic Gain Control Input Level 0x060E Automatic Gain Control Parameters 0x060F Conference Failure Behavior 0x0000 - General Card Configuration 0x0001 - Conferencing Parameters 0x0003 - Alarm Configuration
| 0x0005 - Echo Cancel 0x0673 Echo Cancel Tap Length 0x0674 Echo Cancel NLP Type 0x0675 Echo Cancel ADAPT 0x0676 Echo Cancel Bypass 0x0677 Echo Cancel G.176 Modem Answer Detection 0x0678 Echo Cancel NLP Threshold 0x0679 Echo Cancel CNG Noise Threshold
| 0x0004 - DSP Series 2 Fax Parameters Query 0x0641 Header Parameter Format 0x0643 T.30 Control Parameter Transmit Level 0x0644 T.30 Control Parameter ECM Enabled 0x0645 T.30 Control Parameter Local Session ID 0x0648 Receive Resolution Type 0x0648 Receive Resolution Type 0x0649 Receive Encoding Type 0x064B Receive Bad Line 0x064C Receive Page Size 0x0651 Receive Enable ECM 0x0651 Receive Enable ECM 0x0652 Receive Add Header 0x0654 Receive Line Error Threshold 0x0655 Receive Timeout 0x0657 Receive Terminal ID 0x065A Transmit Modem Type 0x065B Transmit Resolution Type 0x065C Transmit Page Size 0x0661 Transmit Enable ECM 0x0662 Transmit Add Header 0x05FB Silence Threshold 0x0666 Transmit Timeout 0x0668 Transmit dbm Level 0x066A Transmit Terminal ID 0x066C Fax Processing Events Set Register
: | Checksum

Digital Signal Processor
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
See Address Information Block.
Most Significant Bit
Least Significant Bit
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.