HELP FILE

Configuring the Johnson IO Server

After the Johnson IO Server (i.e. CSTJDX9132.EXE)  is installed, a small amount of  configuration is required. Configuring the Server automatically creates a CSTJDX9132.CFG file which holds all of the topic definitions, as well as the communication port configurations. This file will automatically be placed in the directory which is specified via the "Configuration File Path".

 To perform the required configurations, start up the  program. 

The application windows to the IO Server consists of a menu line with 3 main menus . Each main menu will be as follows:
 
 

Main menu	Sub menu
Configure	Com Port Settings
	Topic Definition
	Server Settings
Help	Browse Help File
	About  CSTJDX9132

Each of the configuration menu items are explained in the following chapters.

Configure Serial Communication Port

To configure the communication ports, invoke the /Configure/Comm Port  Settings command. The "Communications Port Settings" dialogue box will appear:

The following describes each field in this dialogue box:

Com Port

 This field will display the communication port for this configuration.

 Reply Time-out

This field is used to enter the amount of time (in seconds) the Johnson Controls network using the selected communication port will be given to reply to commands from the Johnson IO Server This time-out is sustained only when a Johnson Controls networks fails to respond. When the Johnson Controls networks is responding normally, there is no penalty.Note: the default value of  3  seconds should be sufficient for most configurations.

Parity

Parity for Johnson controllers DC9100 and DX9100 must be "None" and cannot be changed.

Stop Bits

Stop bits for Johnson controllers DC9100 and DX9100 must be "1" and cannot be changed.

Byte Size

Byte size for Johnson controllers DC9100 and DX9100 must be "8" and cannot be changed.

Baud Rate

Baud rate for Johnson controllers DC9100 and DX9100 must be "9600" and cannot be changed.

Once all entries have been made, select 0K to process the configuration for the communication port.

Topic Definition (Johnson Controls Network)

The user provides each Johnson Controller node  with an arbitrary name which is used as the DDE topic name for all references to that network.

To define the Topics (nodes), invoke the /Configurationf/Topic Definition command. The topic list dialogue box will appear:

To modify an existing topic, select the topic name and click on Modify.
To define a new topic, click on Add. It's also possible to double click
on the topic name instead of using Modify.The "Topic Definition" dialogue box will appear:

The following describes the field in this dialogue box:

 Topic Name

 This field is used to enter a Topic Name. (The same DDE Topic Name is  entered in the InTouch "DDE Access Name definition" dialogue box described in the section "Using the DDE Server with InTouch The topic must be a unique name that is matched by the DDE clients (for example InTouch).

Poll Rate

This field tells the server how often it will try to update all the items defined under this topic. Please note that the DDE server is always doing its best. The IO server is able to process about 10 messages per second using 9600 baud serial link. If the pollrate is too low the IO server will still only manage 10 messages per second.

Address

The address (written as a decimal integer value) of the node in the Johnson Controls network we want to communicate with. This is usually defined by a dip switch setting on the controller node.

Topic Type

This IO server supports two topic types DX9100 (ver1 and ver2) and DC9100. It is possible for both topic types to communicate on the same serial link.

Comm Port...

If a communication port was previously defined for this node, its identification will appear to the right of this button .If no communication port has been defined, click on this button to associate the topic with a communication port (additional topics may be associated with this same port at a later time).

Configure Server Parameters Command

A number of parameters which controls the internal operation of the  Server can be set. In most cases, the default settings for these parameters provide good performance and do not require changing.

However, they can be changed to fine-tune the Server for a specific  environment.

To change the Server's internal parameters, invoke the /Configure/5erver Settings command. The " Server Operational Parameters" dialogue box will appear:

The following describes each field in this dialogue box:

Configuration File Path

This field is used to specify the path (disk drive and directory) in which the Johnson server will save its configuration file. IO Server will use this path to load the configuration file the next time it is started. Note: Only the path may be modified with this field .The configuration file is always named CSTJDX9132.CFG .

Note: There is no limit to the number of configuration files created although each must be in a separate directory. When using the Johnson IO Server with InTouch it is good practice to place the configuration file in the application dIrectory.

Note: Each time the CSTJDX9132.CFG  file is saved the old configuration file is saved as CSTJDX9132.CBK .

Protocol Timer Tick

This field is used to change the frequency, where the Server checks for work to do. This should take approximately 2 to 4 times the fastest rate desired to update data from the Johnson Controls Node. The default setting is 50 msec which is the shortest period that  can be configured.
 

NetDDE being used

Default value is unchecked. Must only be selected  if  DDE clients and IO servers are communicating over a LAN.

Start automatically as a Windows NT service

(Windows NT only) Default value is unchecked. Selecting this option will enable IO server to start up automatically as an NT service.

WW logger messages/ Debuginformation

The Wonderware logger program is primarily used for receiving error messages (default behavior), but can also be used in a debugging situation to find out what is really happening inside the IO server.

The Wonderware logger will log messages according to the options selected by right clicking the mouse button when the IO server  icon appears in the Windows status bar.

Please note that when messages are written to the Wonder Logger program this will slow down the performance of the IO server.

Saving the Configuration File Directory

If the configuration file does not currently exist, or there has been a change in the configuration of the Server, the Server will display the "Save Configuration" dialogue box:

This dialogue box displays the path where the Server is going to save the current configuration file. The path may be changed if necessary. Also, the path can optionally be recorded in the WlN.INI file by selecting the "Make this file default configuration" option. Doing so will allow the Johnson IO Server to find the configuration file automatically each time it is started.

Configuration File Location

 Note: There is no limit to the number of configuration files that may be created, although each must be in a separate directory.

View IO Server status windows

The IO server will display the status of messages configured for active points in its status window ( main window) The window will display the status of active messages as "DUE" until the message has been serviced  during the current polling cycle.

Using the IO Server with InTouch

Defining the DDE link

Click on Add. The "DDE Access Name Definition" Dialogue Box will appear:

Note: When New is selected, this dialogue box will be blank when it initially appears. Data has been entered here to illustrate the entries which are made.

The following fields are required entries when entering a DDE Access Name Definition:

DDE Access Name

Enter an arbitrary name which will be used in InTouch tagname definitions to refer to the topic (Johnson Controls Node). (It is generally advisable that the same name defined for the Johnson topic is used here.)

IO Application/Server Name

Enter the application name, CSTJDX9132.

DDE Topic Name

Enter the name defined for the topic in the Johnson IO Server to  identify the Johnson Controls node the IO Server will be accessing.

 Note: This will usually be the same as the "DDE Access Name" although  if desired, they may be different. However, the "DDE TopIc Name" must be the same name used when the topics were configured in the Johnson IO Server program. (Refer "configure topic" section for further details.)

Request Initial Data

This option should not be selected when the DDE application is a Wonderware IO Server (CSTJDX9132 is based on the Wonderware DDE Server Toolkit and is hence a Wonderware IO Server). With nonWonderware DDE Servers, this option may be need to be selected if the server does not send data immediately when a window appears on the screen.

Wait for Change

This option should be selected when the DDE application is a Wonderware IO Server.

Advise All Items

 Selecting this option will cause the Johnson IO server to poll for all  Johnson points that are defined in the tagname database, regardless of whether they are visible. Use of this option is not recommended and will cause long delays in updates if a large amount of points has been configured.

Advise only active items

 Selecting this option will cause the Johnson IO Server to poll only  points in open windows and points that are alarmed, logged, or trended. It is recommended that  points  configured for alarms and trends are carefully selected and not enabled by default in  order  to minimise network traffic.

Defining the tagnames

To define the tagnames associated with the new "DDE Access Name", invoke the /Special/Tag Name Dictionary...command (In WindowMaker).

Click on New and enter the Tagname.(The tagname defined here is the name InTouch will use. The Johnson Server does not see this name.)

Select a tag type by clicking on the Type button. The "Choose tag type"
dialogue box will appear:

To access Johnson items, the type must be DDE discrete, DDE Integer,
DDE Real or DDE Message. Select the DDE type.

The "Details" box for the tagname will appear:

Select the Johnson topic (Johnson network node) by clicking on the DDE Access Name:...button. The "Select a DDE Access Name dialogue box will appear:

Select the appropriate topic name and click OK. (If the DDE Access Name has not been defined as previously described, click on New and then define the DDE topic now.)

The "Details" dialogue box will appear displaying the selected DDE Access Name:

For integers and reals fill in the Min EU, Max EU, Min Raw and Max Raw fields. These fields control the range of values which will be accepted from the Server and how the values are scaled. If no scaling is desired, Min EU should be equal to Min Raw and Max EU should be equal to Max Raw.

Enter the Johnson item/point name to be associated with this tagname in the Item field in the "Details" box:

(Refer to the Item (Point) Naming section below for complete details.)

Where applicable, the Use Tagname as Item Name option may be selected
to automatically enter the tagname in this field.

Note: The tagname can only be used if it follows the conventions listed
in the "Item (Point) Naming " section in this document.

Once all entries have been made, click on the Save button, (in the top of the dialogue box) to accept the new tagname. To define additional tagnames click on the New button. To return to the WindowMaker main screen, select Done.

Item (Point) Naming

The Johnson IO Server supports two groups of item (point) names.
Items for the DX9100 topic ( ver. 1 and ver. 2) and items for the DC9100 topic.

Recommended polling cycle periods (in seconds) are indicated in the R/Sc column where "x = none " is used to indicate that polling of  that specific point is not recommended.  

R/W indictes that a point can be written to inside the controller node and R indicates read-only points inside controllers.

Discrete points within a controller word or byte are specified by using a ":" separator character after the tag name and specifing the specific bit "b" that needs to be reported  or changed.

Tag names are in accordance with the following Johnson Controls publications:

•  Metasys DC-9100 Configuration Manual - Issue 11/91  MN-9100-4101 
• Metasys DX-9100 Configuration Guide - Issue 12/93 MN-9100-4103

Writing to points in Johnson devices requires that the appropiate bits are set before writes are allowed. The Supervisory system active bit SUP:16 must be set for all writes. CMP and HLD bits must be set for other write operations. Consult the relevant Configuration manuals for the correct procedure for write operations.

Item used in the DX9100 topic

General Control Module Items Structure
  

AnalogInput modules items structure

Analog Outputmodules items structure

Digital Outputmodules items structure

Every item in this group end with the postfix << n >> where n describes the module number (3..8)
 
  

Extension modulesdatabases structure

Every item in this group start with a pretfix <<XTn >> where n describes the module number (1..8)
 
  

Items used in the DC100 topic

In the table below the number n is used for the controller number (1...8)
 
 

Name	Type	R/W	R/Sc	Description
MODL	Integer	R	x	Device Model No
AIn	Real	R	2	1<=n<=8,Analog Input
NCMn	Real	R	2	1<=n<=4,Numerical Calculation Modules
ACOn	Real	R/W	2	1<=n<=4, Analog Constant
OCMn	Real	R/W	120	1<=n<=8,Output Control Modules
WSPn	Real	R/W	120	1<=n<=8,Working Setpoint Modules
STW1:b	Discrete	R	2	1<=b<=16, Digital Inputs Active
STWn:b	Discrete	R	2	2<=n<=8,1<=b<=16, Status Words
SUP:b	Discrete	R/W	2	Supervisory central control
HLD:b	Discrete	R/W	5	Control modules hold mode control
CMP:b	Discrete	R/W	5	Control module computer mode
MNT:b	Discrete	R/W	5	Maintenance mode
PV@n	Real	R/W	x	Process variable connection
RS@n	Real	R/W	x	Remote set point connection
RV@n	Real	R/W	x	Reference variable connection
PB@n	Real	R/W	x	Prpprtional band connection
OF@n	Real	R/W	x	OFF mode logic control connection
SB@n	Real	R/W	x	Stand-by mode logic control connection
RA@n	Real	R/W	x	Reverse act. logic control connection
EF@n	Real	R/W	x	Ext.forcing  logic control connection
TYPn	Discrete	R/W	x	Controller type
LSPn	Real	R/W	300	Local set point
PBn	Real	R/W	300	Proportional band
TIn	Real	R/W	300	Reset action
TDn	Real	R/W	300	Rate action
HILn	Real	R/W	300	Upper limit of the control output
LOLn	Real	R/W	300	Lower limit of the control  output
BSBn	Real	R/W	300	Change of set point during stand-by
BOFn	Real	R/W	300	Change of set point during off
DAn	Real	R/W	300	Deviation alarm
AIR1	Discrete	R/W	x	Range analog input 1
HIA1	Real	R/W	120	High alarm input 1
LOA1	Real	R/W	120	Filter time input 1
FTC1	Real	R/W	120	Filter time input 1
AIR2	Discrete	R/W	x	Range analog input 2
HIA2	Real	R/W	120	High alarm  input 2
LOA2	Real	R/W	120	Low alarm input 2
FTC2	Real	R/W	120	Filter time input 2
AIR3	Discrete	R/W	x	Range analog input 3
HIA3	Real	R/W	120	High alarm input 3
LOA3	Real	R/W	120	Low alarm input 3
FTC3	Real	R/W	120	Filter time input 3
AIR4	Discrete	R/W	x	Range analog input 4
HIA4	Real	R/W	120	High alarm input 4
LOA4	Real	R/W	120	Low alarm input 4
FTC4	Real	R/W	120	Filter time input 4
AIR5	Discrete	R/W	x	Range analog input 5
HIA5	Real	R/W	120	High alarm input 5
LOA5	Real	R/W	120	Low alarm input 5
FTC5	Real	R/W	120	Filter time input 5
AIR6	Discrete	R/W	x	Range analog input 6
HIA6	Real	R/W	120	High alarm input 6
LOA6	Real	R/W	120	Low alarm input 6
FTC6	Real	R/W	120	Filter time input 6
AIR7	Discrete	R/W	x	Range analog input 7
HIA7	Real	R/W	120	High alarm input 7
LOA7	Real	R/W	120	Low alarm input 7
FTC7	Real	R/W	120	Filter time input 7
AIR8	Discrete	R/W	x	Range analog input 8
HIA8	Real	R/W	120	High alarm input 8
LOA8	Real	R/W	120	Low alarm input 8
FTC8	Real	R/W	120	Filter time input 8
HRO1	Real	R/W	x	Output 1 high range
LRO1	Real	R/W	x	Output 1 low range
AO@1	Real	R/W	x	Source of analog output 1
HRO2	Real	R/W	x	Output 2 high range
LRO2	Real	R/W	x	Output 2 low range
AO@2	Real	R/W	x	Source of analog output 2
HRO3	Real	R/W	x	Output 3 high range
LRO3	Real	R/W	x	Output 3 low range
DO@3	Real	R/W	x	Source of logic output 3
DO@4	Real	R/W	x	Source of logic output 4
OMT3	Discrete	R/W	x	Output module type
FST3	Real	R/W	x	PAT/DAT output 3 timing
DB3	Real	R/W	x	Dead band PAT output 3
HRO5	Real	R/W	x	Output 5 high range
LRO5	Real	R/W	x	Output 5 low range
DO@5	Real	R/W	x	Source of logic output 5
DO@6	Real	R/W	x	Source of logic output 6
OMT5	Discrete	R/W	x	Output module type
FST5	Real	R/W	x	PAT/DAT output 5 timing
DB5	Real	R/W	x	Dead band PAT output 5
HRO7	Real	R/W	x	Output 7 high range
LRO7	Real	R/W	x	Output 7 low range
DO@7	Real	R/W	x	Source of logic output 7
DO@8	Real	R/W	x	Source of logic output 8
OMT7	Discrete	R/W	x	Output module type
FST7	Real	R/W	x	PAT/DAT output 7 timing
DB7	Real	R/W	x	Dead band PAT output 7
SBC5	Real	R/W	x	Symmetry band C.M. 5
SBC6	Real	R/W	x	Symmetry band C.M. 6
AL@D	Real	R/W	x	Alarm disable condition source
DCS1	Discrete	R/W	x	DC9100 type settings
ALG	Real	R/W	x	Standard algorithm type
ACO5	Real	R/W	5	Spare constant
ACO6	Real	R/W	5	Spare constant
HRIn	Real	R/W	x	1<=n<=8, High Special Range Analog Input n
LRIn	Real	R/W	x	1<=n<=8, Low Special Range Analog Input n
OUTn	Real	R/W	2	1<=n<=8, Value of Output n in %
OUTH	Discrete	R	120	Output Modules Hold Condition
ADCn	Integer	R	5	1<=n<=8,Analog to Digital Counter AIn
OMT1	Integer	R/W	x	Output Module 1 Type
OMT2	Integer	R/W	x	Output Module 2 Type

Johnson Controls node "STATUS" Item

From InTouch the state of the Johnson Controls node may be read by defining a tagname and associating it with the topic configured for the Johnson Controls node and using Status as the Item name.

From Excel, the status of the Johnson Controls node communications may be read by entering the following formula in a cell:
                              =Johnson/topic/STATUS

Where topic is the topic name which you would like to monitor the status of.