Product Support
PT3000 Protocol Translator
PT3000 Tech Notes
PT3000 Update Read Me File
PT3000 Update Readme file
(for PT3000 Protocol Translator User Manual) 12.02.001
Product: PT3000 Editor
Platform: Windows
Versions: 12.02.001
What's New
Documentation Corrections/Omissions
Corrections to the Using the PT3000 manual
What's New
CSV Reports File>Report
1) The report dialog menu now includes a Type feature that lets you output normal reports or CSV (comma separated variable) reports. If you generate a CSV report, you can import it into other database programs to manipulate the data.
2) New CSV Report option on the various defining protocol parameters windows. This button lets you generate a CSV report.
3) New options on the PT3000 Editing Toolbar.
HTTP Tags: You can generate HTTP Tags to Include in the homepage for network access. Refer to the Documentation Corrections section.
Custom Scripting: The PT3000 Editor Upgrade gives you more custom scripting options for non-port scripts. Refer to the Documentation Corrections section.
Documentation Corrections /Omissions
The changes listed below refer to Version 1 of the User Manual
_____________________________
Page 4
Standard Unit, Features, and Options
Each standard (or base) PT3000 package comes with the following items:
- PT3000 Unit (with options you order)
- PT3000 Program Software
- PT3000 Editor Software
- 2 Serial I/O ports (RS-232C only)
- Ethernet support (both 10-Base-T and AUI ports provided)
- Brackets for mounting the PT3000 in an industry standard 19" equipment rack
- DB-9 Molded cable to connect Editing Station-to-Terminal port
- 10-Base-T twisted pair network cable
- Standard features/protocols
- Custom Scripting (create your own protocol and non-port scripts)
- Modbus RTU Host Protocol
- Terminal Port protocol (download and view database information)
- Pass_Thru Port
- Network/Internet capabilities
- TCP/IP
- HTTP Homepage
- FTP (File Transfer Protocol)
- Telnet
- Printer capabilities
- WWVB Clock Receiver
Plus additional ports you order - up to 18 total
Protocols you specified when you ordered the unit. The PT3000 supports and translates a wide variety of protocols, with new ones developed regularly. Contact Tetragenics for a current list.
Serial Ports
All the serial ports can be either RS-232C or RS-442/485 in groups of two.
_____________________________
Page 9
Chapter 3. PT3000 Editor Basics - A Quick Start
Important
The Quick Start section provides only a brief overview of the basic features of the PT3000 Editor. It contains basic steps on how to perform the tasks below. For step-by-step instructions on how to perform each task, refer to the sections referenced. This chapter assumes you have installed the PT3000 Editor onto the Editing Station.
The Editor menus are primarily self explanatory. A good tip to remember if you get stuck is to read the information on the screen or use the online help files.
_____________________________
Page 13
Setting Port 1 as a Terminal Port
Terminal Port and Modems
Port 1 is the only port you can use for the optional internal telephone dial modem. Also, it is the only port from which, in terminal mode, you can interrupt an auto boot and change the PT3000 station ID. If you use the internal telephone dial modem, you can pre-empt the modem by connecting a terminal to port 1 with the terminal’s DTR (Data Terminal Ready) active (high). Set the terminal’s DTR line from the Main PT3000 Editor Window’s Communications>Setup window. The default, factory set baud rate for port 1 on a new PT3000 is 38400. Refer to Setting Up the Communications Port (Set Up) in the manual.
To set parameters for the default Terminal port 1, from the PT3000 Editing Window:
1. Select port 1. The Port Description Window appears.
2. Check the parameters and change them if necessary. If an internal modem is installed, select DTR for the RTS line.
3. Select OK.
To set another port as a Terminal port, from the PT3000 Editing Window:
1. Select a port. The Port Description Window appears.
2. From the protocol list, select TERMINAL.
3. Check the parameters and change them if necessary. Select RTS or DTR for the RTS line.
4. Select OK.
__________________________
Page 20
Main Screen Menu Bar
Creating Reports
File>Report
Creating Reports
File>Report
The report dialog menu now includes a Type feature that lets you output normal reports or CSV (comma separated variable) reports. If you generate a CSV report, you can import it into other database programs to manipulate the data.
Creating/Using Custom Scripts
The custom scripting features in the PT3000 have been expanded and moved to another section: Working with Custom Scripts in the Working with Standard Port Protocols and Features.
__________________________
Working with the PT3000 Editing Window
Using the PT3000 Editing Window Toolbar
Page 29
Ethernet Config Button: This section has been expanded to include the section previously on page 41, Specifying Ethernet Configuration Settings.
<Added> Custom Script Button: Click this button to create new or edit existing non-protocol scripts (control activated or startup activated) and generate reports. If you add a script here, you can use it with other PT3000s. Refer to the revised section Working with Custom Scripts. Click this button to create new or edit existing non-protocol scripts (control activated or startup activated) and generate reports. If you add a script here, you can use it with other PT3000s. Refer to the revised section Working with Custom Scripts.
<Added>Http Tags Button
Generating HTTP Tags to include in a homepage
tip: For homepage access, the PT3000 must contain a file called homepage.htm. This file can contain links to other pages. The HTTP tag codes can be added to the linked pages as well.
Click the Http Tags button to generate http code to display information about specified points in the PT3000 database on the PT3000 Homepage. When you click the button, the HTTP Tag Generation Utility Window appears.
This window generates the HTTP code to display the specific station, group, and point information you select. [The station is the name you selected as the Device Name for the IED. The Editor assigns the group names and you specify the point names when you configure the IED.] Once you have the HTTP code, you insert it into the PT3000 homepage.htm file, and download the file to the PT3000 unit. When you access the PT3000 with an Internet browser, the status information will appear on the homepage.
Generating HTTP Code to Display Status of Points
If you have not assigned any of the PT3000 ports, and you click the HTTP tag button, you may get a pop-up message saying the program is unable to open point data. Click OK and the HTTP Tag window appears but there will be nothing in the scroll areas.
If you have not assigned any of the PT3000 ports, and you click the HTTP tag button, you may get a pop-up message saying the program is unable to open point data. Click OK and the HTTP Tag window appears but there will be nothing in the scroll areas.
Before the HTTP tag window can show the station, group, and point information, you must have protocol or script assigned to a port(s) and you must build the database.
1. From the HTTP Tag Generation Utility window, select the Station, Group, and Point you want displayed on the homepage. You can select points for any protocol or script included in the current PT3000.
2. From the Type of Information scroll box, select what type of information you want displayed for the point: numeric value; station, group, and point text; just point text; just state text, etc.
3. Click the Generate button. In the TG Http Tag box, the correct HTTP code appears.
4. In the TG HTTP Tag box, select the entire code text.
5. Press <Ctrl>C to copy the text.
6. From Explorer, access and edit the homepage.htm file in the root PT3000 directory (installation directory), or the homepage.htm file in the particular directory for the PT3000 you are working on. Each PT3000 has its own homepage.htm file, for example,
E:\Tetra\PT3000ED\REG_5\PT_0\homepage.htm. Use any text or HTML editor to edit the file.
7. In the file, paste the copied code somewhere after the header codes. There is text that says, TG INSERT DATA. You can place it after that code or wherever you want the status to be displayed.
8. Save the file and exit the text editor.
9. In the PT3000 Editor, HTTP Tag Window, click Cancel to cancel the window, or click Clear Point to clear the selections and generate code for a different point, or change the type of information for the same point and generate another code.
10. When you are finished placing the code in the homepage.htm file, send the homepage.htm file you modified to the PT3000 Unit. You must send it to the PT3000 unit in order to see the status points on the actual homepage. Refer to Transferring Individual Files to and From the PT3000 in the manual.
Once you send the file to the PT3000 unit, you can view the changes on the homepage. Refer to Viewing the PT3000 Data Using the Internet in the manual.
__________________________
Page 32
Enable Capture Button
Enable and disable data capturing. This button toggles the capture status:
if data capturing is off, the button label reads Enable Capture.
if data capturing is on, the button label reads Disable Capture.
When data capturing is enabled, all commands you type in the dialog area, and all responses from the PT3000, are captured to a disk file on the PT3000 Edit Station. This allows you to keep a record of the process.
When you select Enable Capture, a browse window appears. From this window, specify a name for the dmp file, rewrite the file, or append to an existing dmp file. The default file location is c:\tetra\PT3000ed.
__________________________
Page 41
Specifying Ethernet Configuration Settings
This section has been incorporated into the Ethernet Config Button section of the manual.
This section has been incorporated into the Ethernet Config Button section of the manual.
__________________________
Page 45
Protocol Field:
New: Custom Protocol: If you click CUSTOM from the scroll bar, another scroll field appears at the bottom of the Protocol field. Use the scroll arrow and select from the listed custom scripts. The custom scripts listed are the port scripts previously defined and available for any PT3000 (those on the global list).
New: Custom Protocol: If you click CUSTOM from the scroll bar, another scroll field appears at the bottom of the Protocol field. Use the scroll arrow and select from the listed custom scripts. The custom scripts listed are the port scripts previously defined and available for any PT3000 (those on the global list).
tip: To delete a previously selected protocol, go to the Define Protocol window, delete the stations, then return to the Port Description window and select NONE as the protocol for the port.
RTS Line: This field allows you to select which line on this serial port (either DTR (Data Terminal Ready) or RTS (Request To Send)) the PT3000 Unit will monitor to determine the carrier detect status. Note: For a Terminal port on port 1, select DTR as the RTS line. For other ports initialized as a terminal port, the RTS line can be either DTR or RTS.
Dial Up:
Check this box to indicate that this serial port will use a telephone dial-up connection. Only certain protocols require this selection. If the protocol does not require this selection, the field will be grayed out. Refer to individual protocol descriptions for more information. When you click the Dial Up box, the # of Rings button below it becomes active. See # of Rings.
Check this box to indicate that this serial port will use a telephone dial-up connection. Only certain protocols require this selection. If the protocol does not require this selection, the field will be grayed out. Refer to individual protocol descriptions for more information. When you click the Dial Up box, the # of Rings button below it becomes active. See # of Rings.
# of Rings:
When you check Dial Up, click this button to specify the number of rings before the modem picks up.
__________________________
Page 48
New CSV Report option on the various defining protocol parameters windows.
CSV: Generates a CSV report to the destination you specify. Generate a CSV report exactly as if you would a regular report. The Report Name is saved with a .CSV extension. Refer to Report (in the manual) previously. You can import CSV reports into other database programs to manipulate the data.
__________________________
Page 49
The list of standard or base PT3000 port protocols and features includes the following:
Standard Port Protocols and Features
- Custom Scripting (create your own protocol scripts)
- Modbus RTU Host Protocol
- Terminal Port protocol (download and view database information)
- Pass_Thru Port
- Printer capabilities
- WWVB Clock Receiver
- Network/Internet Capabilities
The PT3000 also contains network and Internet capabilities.
- TCP/IP
- HTTP Homepage
- FTP (File Transfer Protocol)
- Telnet
__________________________
Working with Custom Scripts
The Using Custom Protocol section has been expanded to include the new custom scripting features.
Adding Custom Script Files to the PT3000 Editor
The steps below describe the different ways to add and use custom scripts.
The steps below describe the different ways to add and use custom scripts.
1. Main Menu Select Bar. File>Custom Scripts. A list appears of previously added port and non-port (Control and Startup) scripts. This is a global list that contains scripts available to all the PT3000 databases.
- Select Add to add a new script file to this list. A pop-up window allows you to select the type of script (port, control, startup).
- Select the type and click OK. Another window appears that allows you to add the descriptive script name and filename. You can specify the name of an existing file located in the default installation directory (created with any text editor) or the name of a new file. If you specify a new file name, the PT3000 Editor will create a template script file with that name.
- Type the information and click OK. The filename appears on the global list.
2. PT3000 Editing Window Toolbar. Custom Script Button (for new non port scripts)
- On the PT3000 Editing Window Toolbar, click the Custom Script Button. The Custom Non-Port Window appears.
- On the window Toolbar, select File>New. Another window appears that allows you to add the descriptive script name and filename.
- Add the information and click OK. The filename appears in the Custom Script box. This script file will also be added to the global protocol list.
3. PT3000 Editing Window Toolbar, Custom Script Button (for existing non-port script files not previously added with the PT3000 Editor to the current PT3000 database)
- On the PT3000 Editing Window Toolbar, click the Custom Script Button. The Custom Non-Port Window appears.
- On the window toolbar, select File>Import. Another window appears that allows you to browse to .scp files that have not been added previously to this PT3000 database.
- Select the file and click OK. The filename appears in the Custom Script box. This script file is added to the list displayed when you select File>Open and also to the global protocol list.
4. Custom Port Window Toolbar, File>New (for port scripts)
- From the PT3000 Editing Window, select a port. The Port Description Window appears.
- From the Port Description Protocol list, select Custom as the protocol.
- Click the Define Protocol button. The Custom Port Window appears.
- On the toolbar, select File>New. Another window appears that allows you to add the script descriptive name and filename. The filename extension must be .scp.
- Type the information and click OK. The filename appears in the Protocol box. This script file will also be added to the global protocol list.
5. Custom Port Window Toolbar. File>Import (existing script files not previously added with the PT3000 Editor)
- From the PT3000 Editing Window, select a port. The Port Description Window appears.
- From the Port Description Protocol list, select Custom as the protocol.
- Click the Define Protocol button. The Custom Port Window appears.
- On the toolbar, select File>Import. Another window appears that allows you to browse to .scp files that have not been added previously.
- Select the filename and click OK. The filename appears in the Protocol box. This script file will also be added to the global protocol list.
Selecting a Custom Port Script for a Specific Port for the current PT3000 database
1. From the PT3000 Editing Window, select the port to which you want to assign the protocol. The Port Description Window appears.
2. From the Port Description Protocol list, select Custom. A scroll bar appears at the bottom of the Protocol List showing all the available custom port script files. The list does not show non-port files.
3. Scroll and select the custom script you want for this port (these are previously defined and globally available to all PT3000 databases).
4. Select the Define Protocol button to add a station(s) to the protocol and access the script file.
Editing Custom Scripts
Editing Port Scripts:
- From the PT3000 Editing Window, select the port to which you assigned a script (if you move the cursor over the port number, a name appears over the port showing the protocol/script for that port). The Port Description Window appears.
- Click the Define Protocol button. The Custom Port Window appears.
- From the Custom Port Window Toolbar, select Edit>Edit Script. The Script File Editor appears.
- In the Script File Editor, make changes, save or abandon them. If you want the changes you make to be available globally, click Edit>Update Original. This updates (overwrites) the global .scp file in the default installation directory (for example, c:\tetra\pt3000ed).
Editing Non-Port Scripts (Start Up and Control Activated)
- On the PT3000 Editing Window Toolbar, click the Custom Script button. The Custom Non-Port Window appears.
- From the Custom Non-Port Window toolbar, click File>Open. A list appears of current non-port scripts for this PT3000 database.
- Select the script you want to edit and click OK. The window disappears.
- From the Toolbar, click Edit>Edit Script. The selected script appears in the Script File Editor.
- Make the changes, save or abandon them. If you want the changes you make to be available globally, click Edit>Update Original. This updates (overwrites) the global .scp file in the default installation directory (for example, c:\tetra\pt3000ed).
Specifying a Different Script for a Port (from the Custom Non-Port Window or the Custom Port Window Toolbar)
To select a different script (or add a new script) for the current port, from the Custom Non-Port Window toolbar (for non port scripts) or the Custom Port Window toolbar (for port scripts), select File. From the File menu, select either New, Open, or Import. Refer to Options on the Custom Script Toolbar (for both port and non-port scripts). Once you select another script, it becomes the script for the current port.
Options on Custom Script Toolbar (for both port and non-port scripts)
File
- New: Adds a new script file to the current PT3000 and to the global list that is available to all PT3000s in the database.
- Open:
Port: Displays the global list of available port scripts.
Non-Port: Displays the list of non-port scripts you added using the Import or New commands (for the current PT3000 database).
- Import:
Port: Allows you browse through all the .scp files in the selected directories and select specific files to import for the current PT3000 database. When you browse current PT3000 Editor directories, only the .scp files not previously added to the current PT3000 database appear.
Non-Port: Allows you browse through all the .scp files in the selected directories and select specific files to import for the current PT3000 database.
- Save: Saves the changes you've made so far without exiting the window.
- Save as: Copies the current script file to another name. A window will ask you to enter the new file name and description.
- Edit Scripts: Lets you edit the script filename and description (not the actual script file).
- Delete Scripts: Deletes scripts. When you click this option, a list appears of the current scripts. Select the one you want to delete and click DELETE. A prompt asks you to confirm your request.
WARNING: If you delete the script in this window, it is deleted from the current PT3000 database, any PT3000 database using this script, and the global list available to all PT3000s. DO NOT DELETE SCRIPTS WITH THIS OPTION UNLESS YOU WANT TO DELETE THEM FROM ALL THE LISTS.
- Exit: Exits the window and saves the changes you made.
Edit
- Edit Script: Opens the Script File Editor and lets you modify the current script.
- Update Original: Updates (overwrites) the global .scp file in the default installation directory (for example, c:\tetra\pt3000ed) with the currently open file of the same name.
Reports
This option lets you print reports. A window appears letting you specify the type and destination of the report. Refer to Creating Reports in the manual.
__________________________
Page 83
Serial Port Data Transfer Indicators
The transmit data (TX) LEDs show the state of the serial port's transmit data line. The red LED lights when a binary 0 state (space) is being transmitted. The green LED lights when a binary 1 state (mark) is being transmitted.
The transmit data (TX) LEDs show the state of the serial port's transmit data line. The red LED lights when a binary 0 state (space) is being transmitted. The green LED lights when a binary 1 state (mark) is being transmitted.
__________________________
Page 94
Telephone Dial Modem
The last paragraph on this pages has been modified to read:
There are no jumpers or switch settings for the telephone dial modem. You can select the number of rings for the modem from the Port Description window.
__________________________
Page 116
Appendix H. PT3000 Unit Boot Up Process
Stage 1 paragraph changes:
If you do not interrupt the program by pressing Esc (this is the normal situation), the Stage 1 program will terminate, and the PT3000 program (Stage 2) will start. If you do interrupt the Stage 1 program, Stage 2 will not start. You will see a prompt (C:\pt3000\ >). Type Help or ? for a list of available commands.
- Copy = Copy a file (no wildcards)
- Del = Delete a file (no wildcards)
- Dir = Directory (can use wild cards)
- Exit = Debug only. Exit from startup. If you use this command you must reboot the PT3000
- from a power fail.
- Go = Go and run the program
- Help or ? = Display the help menu
- Ren = Rename a file (no wildcards)
The Stage 1 program allows you to perform several operations including transmit a file or several files and terminate operation of the Stage 1 program to initiate State 2 (the GO command). There is no login requirement for Stage 1. Once the decision has been made to transmit one or more files, you run the PT3000 Editor and access the Terminal Window. You must use a serial port on the PT3000 Edit Station; you cannot use the Ethernet/Telnet protocol. Once you have the file names, click the Transmit or Send button and specify the particular file names.
__________________________
Page 117
Stage 2 changes
If you do not interrupt the program by pressing the space bar (this is the normal situation), the Stage 2 program will terminate, and the PT3000 program will run. If you do interrupt the Stage 2 program, the PT3000 Program does not start. You will see a prompt, for example c: command? Type help or ? for a help list. There are several commands available at this point. You can issue the commands form the PT3000 Terminal Window.
If you do not interrupt the program by pressing the space bar (this is the normal situation), the Stage 2 program will terminate, and the PT3000 program will run. If you do interrupt the Stage 2 program, the PT3000 Program does not start. You will see a prompt, for example c: command? Type help or ? for a help list. There are several commands available at this point. You can issue the commands form the PT3000 Terminal Window.
One command added to the help list:
Mem: This command tests extended memory in megabytes.
____________________________________________________
Copyright 1998 Tetragenics Company. All rights reserved.
Tetragenics is a registered trademark of Tetragenics Company
10/1998:PT3000 for Windows