HOWTO: Installing Brooktrout TR1034 Patch

ZTN1255

ID: ZTN1255

This Zetafax technical note applies to:

• Zetafax 8.0.0.104

Summary

This technical note will tell you how to install the Patch which gives Zetafax support for Brooktrout's TR1034 high-density fax board.

This patch will tell you how to do two things:

1. How to install and configure Brooktrout's drivers.
2. How to install and configure the Zetafax patch.

Limitations and Caveats

• You must be physically on the machine that contains the card in order to install these drivers
• This patch will only run with Zetafax 8.
• This patch is only supported on Windows 2000 and Windows Server 2003.
• This patch only supports a single TR1034 board.
• This patch does not support a mixture of TR1034 and TR114 or TruFax boards.
• This patch has not been tested with other TR1000 series and TR2000 series TRxStream boards.

Installing and Configure the Brooktrout Drivers

This patch requires that you install SDK 2.1.3. To do this you need to install SDK 2.1 and install version 1.7.7 of the ECC (Enhanced Call Control).  You then apply two patches to bring the SDK up to version 2.1.3. If you are installing T1 Robbed Bit you should ignore sections coloured blue.

1. Set the module number on the card to 2 (this is the default). Then install the Brooktrout card into the machine following the instructions provided by Brooktrout.
2. Install SDK 2.1.

On the "Select Setup Option" dialog make sure "Install BOSTON files" and "Configure BOSTON files" are checked. NOTE: "Start BOSTON Service" should be unchecked. (As below)

When prompted to, make sure that both Firmware files and Bfv Binaries components are installed. (As below)

If the files have been successfully installed you will presented with a message "The BOSTON Files have successfully been installed" message. Click OK to continue.

After the install you will be presented with the "BOSTON Driver Parameters" dialog box.  Enter the total number of channels in your system. There are 30 channels for each E1 port and 24 channels for each T1 port.  You also need to specify the number of cards in the system, although this patch will only work with a single card in the system. Select "Start driver during system boot-up". Then click Next (As below)

Choose to "No, I will restart my computer later." Then Finish to continue.

3. Install Brooktrout ECC 1.7.7 selecting the default options.
4. Install SDK Patch 2.1.1
• This patch is made up of a self-extracting exe.  Copy this file into a temporary directory, and execute it.
• Drag and drop the new Boston folder created when the patch unzipped into the base folder containing the original SDK 2.1 Boston folder on your system.
• Select "Yes" to overwrite old files.
5. Install SDK Patch 2.1.3

To apply this patch then you need to do the following:

• Extract the patch into a temporary directory.
• Copy boston.sys to boston\driver\winnt\kernel\compile\i386\free.  Copy bsmisrv.exe to boston\ecc.api\server\bsmisrv. Copy cp.bin to boston\fw.
5. Editing configuration files

There are three configuration files you may need to edit or change before you can use the new card.

• If you did not install the Boston drivers in to the default directory C:\Boston then you will need to edit your btcall.cfg file.  This file can be found in the folder boston\ecc.api\server.  Open it in a text editor and change the teleph parameter so that it points to the teleph.cfg file in your boston\ecc.api\server directory.
• Navigate to boston\ecc.api\server.  Rename BTNA.CFG to BTNA.OLD.  If you have installed a T1 card you need to make a copy of BTNA.T1 and call it BTNA.CFG.  If you have installed an E1 card you need to make a copy of BTNA.E1 and call it BTNA.CFG.  If you only have a one port board you need to open your new BTNA.CFG file in a text editor, and delete the [board 0 port 1] paragraph (up to and including the [end] line).
• Still in the folder boston\ecc.api\server you need to rename teleph.cfg to teleph.old.  Once you've done this you need to find the correct teleph*.cfg file from the boston\bfv.api\samples.cfg directory.  If you have a T1 PRI board use teleph_hp02h_t1_isdn.cfg, if you have a T1 robbed bit board use teleph_hp02h_t1.cfg, and if you have an E1 PRI board use teleph_hp02h_e1_isdn.cfg.  Copy your teleph*.cfg file into boston\ecc.api\server and rename it teleph.cfg.
• Now using notepad open the teleph.cfg you have just copied over and renamed.

If you have an E1 board you might have to change the ds1_line_type value between 4 and 5, depending on whether you have CRC4 multiframing or not. You need to make this change both to the line starting "unit 1" and to the line starting "unit 2" .  By default ds1_line_type equals 5.

If there is no second port on your Brooktrout card then you need to comment out the unit 2 line using '#' characters.

If you are not using a T1 PRI or E1 PRI board, scroll down to the section headed "#Connections for Telephony Unit 1", you should notice the lines below in the format:

connect 7 0  2 0 0 F 0 0  0

connect 7 0  3 0 0 F 0 0  1

connect 7 0  4 0 0 F 0 0  2

connect 7 0  5 0 0 F 0 0  3

connect 7 0  6 0 0 F 0 0  4

connect 7 0  7 0 0 F 0 0  5

connect 7 0  8 0 0 F 0 0  6

connect 7 0  9 0 0 F 0 0  7 etc.

You need to comment out all the lines in that section as follows.

#connect 7 0  2 0 0 F 0 0  0

#connect 7 0  3 0 0 F 0 0  1

#connect 7 0  4 0 0 F 0 0  2

#connect 7 0  5 0 0 F 0 0  3

#connect 7 0  6 0 0 F 0 0  4

#connect 7 0  7 0 0 F 0 0  5

#connect 7 0  8 0 0 F 0 0  6

#connect 7 0  9 0 0 F 0 0  7 etc..

Repeat this for the section headed "#Connections for Telephony Unit 2".  If you are using a single port board you will need to comment out the connect lines even if you are using robbed bit.

Save your changes to teleph.cfg.

7. Installation of Boston driver

Next you need to install the Boston driver.  Open a command prompt and change directory to boston\driver\winnt\install.  Type "install" and provide the following answers to the questions:

      Do you want to overwrite the existing installation?

      Overwrite? (y or n, default y): y  

How many ISA board addresses do you wish to configure (default: 0):0

      Physical buffer size (default 32768): 32768

      Application buffer size (default 10240): 10240

      Maximum number of application sessions (default 8): 90

      Machine ID, in hex (default 1): 1

      Do initial reset (default 1): 1

      History enable (default 0): 0

      To reserve module numbers, enter mod_id (serial number) and

      mod_num, in hex. Mod_num will default as indicated:

      mod_id mod_num[20]: (Enter)

      Configuring Boston driver:

            Phys buf size 32768

              App buf size 10240

              Num apps 90

              Machine ID 1

              History disabled     

      Start the driver automatically at boot time? (y or n, default n): n

      When using Boston PCI boards, a system memory adjustment

      may be required in order to properly access the boards.

      For a small number of boards this is often not required,

      but many factors, including other devices that are or will

      be in the system, affect this. After this adjustment is

      made, the system must be rebooted.

      Do you wish to perform this adjustment? (default n): n

      Installing free driver version.

      The C:\WINNT\boston directory has been created.

      The service named 'boston' has been added to the registry.

      To start the driver now, run 'net start boston'.

      A reboot is recommended. Do you wish to reboot now [n]? y

8. Flash your firmware

After the reboot you will need to flash the board's firmware.  To do this open a command prompt, change directory to boston\fw, and run net start Boston followed by flashupd.bat.  This is a one time process that brings your board up to date to match the software that you will run.  This process should not be interrupted.

9. If you are using a T1 PRI or E1 PRI board you will have to install the BSMI service. To do this you need to have the Boston driver running and the firmware downloaded.

·         Open a command prompt

·         Run net start boston if you have not already done so

·         Change directory to C:\Bosston\Bfv.api\winnt\bapp.src

·         Run Firmload.bat -c#\Boston\fw to download the firmware onto the board

      (where "#" is the number of channels you want to download for.)

·         Change directory to C:\Boston\ecc.api\server\bsmisrv.

·         Run bsmisrv -install and select the appropriate values (see Figure 1). Be aware that the defaults will be incorrect if you did not install the Boston files to your C drive.

Figure 1: Installing the BSMI service

·         Run net start bsmiservice

10. Finally you should test the installation to make sure it works.  To do this you have to use Brooktrout's test program BSMIFAX.exe (FAX.exe if you are using robbed bit).  To help you with this we ship a file IPS.1G3 which you can send using these applications.  To send a fax:

·         Open a Command Prompt and change your directory to the one which contains your patch files

·         Run BSMIFAX -s fax_number IPS.1G3 where fax_number is a valid fax number. (The command line is FAX -s fax_number IPS.1G3 if you are using robbed bit)

·         The fax should be sent correctly

Your TR1034 board should now be configured correctly.

Installing the Configure the Zetafax files

1. This patch comes with three new files to get copied into Zetafax's server directory

·         DEVBTxS.EXE - this is a new file

·         BFAXINIT.EXE - rename the old file, and put this file in its place

·         SHARESETUP.DLL - rename the old file, and put this file in its place

2. If your Zetafax server was upgraded to version 8 then you will need to edit your SETUP.INI so that it can find the new device driver.  Open SETUP.INI in a text editor and add the following line to the SERVER paragraph:

Device:  BTxSTR   "DEVBTxS.EXE"      "Brooktrout TRxStream board"    NNRNRN

3. Run the Zetafax configuration program, and add the new channels.  These are reported as "Brooktrout TRxStream fax board port" within the configuration program.  You should configure a device for each channel on the incoming PRI line.  So even if you are using a 16 channel TR1034 board you should configure 24 Zetafax channels if you have a full T1 line coming into the board. If you have a fractional PRI line coming in to the board you should configure as many channels as you have incoming channels.
4. If you are using Robbed Bit you need to edit Setup.ini and add the following line to each BTxSTR paragraph:

RobbedBit: Yes

5. Start the Zetafax server.  In the Zetafax server program window check that BFAXINIT runs correctly and the new Brooktrout channels you added initialise correctly.
6. Send a fax!

Last updated: 1 Oct 2003 (AG/SV)