altus

electrical & safety · industrial connectivty · software & electronics · advanced connectivity

WoodheadWoodhead

Altus.doc 06/05/2004

Copyright © 2004 Woodhead Software & Electronics. All rights reserved.

http://www.applicom-int.com

Protocol manual

ALNET II on Ethernet TCP/IP

applicom® 3.8

a product of Woodhead Software & Electronics


WoodheadWoodhead

Altus.doc 06/05/2004 Copyright © 2004 Woodhead Software & Electronics. All rights reserved. applicom®, Direct-LinkTM, RJ-LnxxTM, SSTTM are registered trademarks of Woodhead Software & Electronics. Other product names are trademarks of their respective owners.

http://www.applicom-int.com


WoodheadWoodhead

ALNET II on Ethernet TCP/IP • i • Table of contents

Table of contents

1. - General .........................................................................................1 - OSI model .............................................................................................................1 - Functionality ..........................................................................................................3 - Client multi-request management .........................................................................4 - Request processing. .............................................................................................5

2. - ALNET II on TCP/IP functionality................................................6 - ALNET II client to a « AL 3405» type server........................................................6 - ALNET II server.....................................................................................................8 - Configuration : Choice of protocol.........................................................................9 - Description of the ALNET II configurator on TCP/IP...........................................11 - Node characteristics............................................................................................12 - Channel properties : General..............................................................................13 - Channel properties: Ethernet ..............................................................................16 - Alnet II properties: ...............................................................................................18 - Properties of the TCP/IP protocol .......................................................................19 - Inserting an equipment........................................................................................21 - Equipment properties ..........................................................................................22 - Properties of a « AL 2003 » server equipment ...................................................23 - ALNET II client equipment properties .................................................................25 - Deleting an equipment ........................................................................................26 - Duplicating an equipment ...................................................................................26 - Moving an equipment..........................................................................................26

3. - Functions which can be used on the master channel............27 - In wait mode........................................................................................................27 - In deferred mode.................................................................................................27 - In cyclic mode .....................................................................................................27

4. - Image variable item ...................................................................28 - Presentation ........................................................................................................28 - Standard descriptor.............................................................................................29 -"ALNET II ALTUS descriptor"...............................................................................32

5. - Appendices ................................................................................36 - List of additional files for ALNET II on TCP.........................................................36 - Evolution / compatibility.......................................................................................36 - Function return statuses......................................................................................37 - TCP/IP appendix .................................................................................................39

6. - Glossary .....................................................................................44

7. - Index ...........................................................................................46


WoodheadWoodhead

ALNET II on Ethernet TCP/IP • 1 • - General

1. - General

- OSI model The ALNET II on TCP/IP protocol by manufacturer ALTUS, is available on the applicom®

PCI2000ETH interface and SW1000ETH. The ALNET II on TCP/IP protocol uses ALNET II messaging for the application layer and TCP/IP

for communication on Ethernet. All layers produced for ALNET II on TCP can therefore be represented according to the following OSI model :

Figure 1 : applicom® TCP/IP functionality faced with the OSI model

applicom® uses the following specifications :


WoodheadWoodhead


All TCP/IP protocols are made according to the RFCs (Request For Comments):

TCP/IP

Layer 4 TCP : RFC 793UDP : RFC 768

Layer 3ICMP : RFC 792

IP : RFC 791ARP : RFC 826

Layer 2 b Ethernet IILayer 2 a IEEE 802.3 CSMA/CD

Layer 5 and 6 are not used. ALNET II messaging (layer 7) is carried out according to ALTUS specifications :


WoodheadWoodhead


- Functionality The TCP/IP solution on applicom® supplies the following functionality :

Figure 2 : applicom® client/server functionality Multi-request client mode on Ethernet TCP/IP :

Reading and writing variables in the various PLC memory areas.

Server mode for ALNET II client PLCs, access to the applicom® database and equipment monitoring.

Redundancy of equipment: enables the application to dynamically change the target

equipment. (see chapter Functions for Redundancy of Equipment).


WoodheadWoodhead


- Client multi-request management The applicom® client mode can be used to send several requests simultaneously to an equipment

before having received the first response : this operation is called multi-request. A request is sent on a virtual communication channel. Each virtual channel corresponds to a TCP

connection to an equipment. To send several requests simultaneously, several connections are used.

Figure 3 : Multiple connections and multi-request The connections are created according to needs, and existing connections are reused whenever

possible. For example: a request is sent to an equipment for the first time. The connection No. 1 is created.

Some time later, 2 requests must be sent to the equipment: connection No. 1 is reused and connection No. 2 is created.

The applicom® interface manages 128 connections. Only 30 of them can be used

simultaneously for all equipments. The maximum number of connections which can be used simultaneously for this equipment is set in

the configuration for each equipment. For equipments which do not accept several connections, this number is set at 1 and cannot be modified.

A connection remains open as long as data is travelling or a connection servicing process is active.


WoodheadWoodhead


- Request processing.

A request being processed is a request for which a frame has been sent on the network and for

which a response is expected. Each request being processed uses a virtual communication channel. A request is placed (temporarily) on hold when there are no more virtual channels available. When

virtual channels are released, the list of requests on hold is progressively emptied.


WoodheadWoodhead

ALNET II on Ethernet TCP/IP • 6 • - ALNET II on TCP/IP functionality

2. - ALNET II on TCP/IP functionality

- ALNET II client to a « AL 3405» type server

- PLC/Ethernet coupler reference AL 2003 processor : Ethernet driver :

Ref. : AL 3405 (10 BaseT connection / AUI)

- Addressing mode The functions managed by choosing a « ALTUS» type server equipment provide access to the

variables defined in the following table. When using the applicom® library, the address of the variable accessed must be converted by

referring to the « Adressing » column in the following table. Note the difference of 1 between the addresses of ALTUS variables and applicom® addresses.

Function code PLC variable Item (DDE/ OPC)

Use by the applicom® library/DLL

Addresses Exchange type Function name 9 %A0 - %A254 0 – 254 Read byte READPACKBYTE 9 %A0 - %A254 0 – 254 Write byte WRITEPACKBYTE 8 %E0 - %E254 0 – 254 Read input byte READPACKIBYTE 8 %S0 - %S254 0 – 254 Write output byte WRITEPACKIBYTE 0 %M0 - %M9998 0 – 9999 Read word READWORD 0 %M0 - %M9998 0 – 9999 Write word WRITEWORD

20 %TM0 - %TM254 10000 – 65535* Read table word READWORD 20 %TM0 - %TM254 10000 – 65535* Write table word WRITEWORD 02 %D0 - %D9998 0 – 9999 Read double word READDWORD 02 %D0 - %D9998 0 – 9999 Write double word WRITEDWORD 22 %TD0 - %TD254 10000 – 65535* Read table word READDWORD 22 %TD0 - %TD254 10000 – 65535* Write table word WRITEDWORD

* : TM & TD applicomâ address calculation TMx.y = (x * 255) + 10000 + y example : TM10.120, address = (10 * 255) + 10000 + 120 = 12670 TDx.y = (x * 255) + 10000 + y example : TD10.120, address = (10 * 255) + 10000 + 120 = 12670


WoodheadWoodhead


- Maximum numbers of variables per exchange with the library

Object Maximum quantity Read Write

Bit 1840 1840 Word 115 115

Double 57 57

- Maximum numbers of variables per exchange with PCDDE


Bit 1840 1 Word 115 1

Double 57 1

The number given for read frames corresponds to the maximum number of points (as imposed by

the server and/or the protocol) which can be grouped together during dynamic optimization of the frames carried out by the server. However, this number can be reduced to suit a specific item of equipment by configuring the length of frames in the topic (see chapter "Implementation/Topics configuration/Advanced options").

Where write operations are concerned, a variable automatically entails the formation of a frame.

- Maximum numbers of variables per exchange with the OPC server


Bit 1840 1840 Word 115 115

Double 57 57

The number given for read frames corresponds to the maximum number of points (as imposed by

the server and/or the protocol) which can be grouped together during dynamic optimization of the frames carried out by the server. However, this number can be reduced to suit a specific item of equipment by configuring the length of frames in the topic (see chapter "Implementation/Topics configuration/Advanced options").

For the write frames, see chapter "OPC Server/Optimization of synchronous and asynchronous requests".


WoodheadWoodhead


- ALNET II server The ALNET II server on applicom® interface makes a database of 32 kwords available to ALNET

II clients. Without any prior configuration, Alnet II clients can access the applicom® database directly by

targeting the port number 1 to 65535 (port TCP) of the applicom® Alnet station. The access mode is identical to that of a ALUS.

Supported Request

Data type in the DATA-BASE

Addresses in the DATA-BASE

Corresponding ALNET II variables

Read /write auxiliary word area 25000 – 25127 0 – 512 Read /write memory word area 0 – 9999 0 – 9999 Read /write decimal word area 10000 – 19999 0 – 4999 Read /write tab memory word area 26000 – 28816 0 – 10 Read /write tab decimal word area 28817 - 31633 0 – 6

Maximum number of variables per exchange: 230 bytes 115 words 57 double words The ALNET II server functionality on the applicom® database can be used to optimise information feedback. Rather than permanently polling the equipments to monitor variables which change status occasionally, the equipments can store the information to be fed back in the applicom® database only on status changes (alarm feedback). This operating mode results in:

• PLC processors less solicited. • Network architecture less heavily loaded. • Minimized information feedback time. This principle can be made reliable on the ALNET II server on applicom® interface to avoid

working « blind ». For example, the variables in the applicom® database do not change since the transmitting equipment is disconnected. To do this:

• You can define in the configurator a global maximum time between the accesses of the client equipment to the applicom® ALNET server. After this interval, the absence is indicated to the application by a « ACCESS STATUS WORD » in the applicom® database. The address of this status is defined by you using the channel configuration utility.

• The application is informed of the write access by each equipment to the applicom® ALNET

II server by incrementing an « ACCESS INDICATOR WORD » in the applicom® database. The application can consult the variables of this equipment in the applicom® database and reset the « ACCESS INDICATOR WORD » to be informed about the next access (or even to inform the transmitting equipment of this acknowledgment).


WoodheadWoodhead


- Configuration : Choice of protocol

The ALNET II on TCP/IP protocol can only be configured on channel 0 of the applicom® PCI2000ETH interface and SW1000ETH.

Figure 4 : Choice of protocol

Choose the “Alnet II TCP/IP (Altus)” messaging (protocol) and press the « OK ...» button to configure the channel and the equipments.


WoodheadWoodhead


After your configuration, the following files will be generated : CNFMAST.0xy : contains the configurations of the Ethernet channel, the TCP transport layers

and the Client mode. CNFSERV.0xy : contains the configuration of the Server mode and the client equipments. CNFCMNT.Sxy : contains the comments on each equipment APPCNFGy.LST : contains a summary of the ALNET II on TCP configuration in ASCII format. CNFSCH01.1xy : contains the configuration of the ALNET II server equipments. x represents the channel number ( 0 to 3 ) and y represents the board number ( 1 to 8 ).


WoodheadWoodhead


- Description of the ALNET II configurator on TCP/IP

Figure 5 : Alnet II configurator on applicom® TCP/IP

The configuration is represented in a tree structure. The first node (symbolized by a board) designates the Ethernet channel. The TCP/IP transport nodes and then the server and client equipments are found below.

This interface can be operated by : • the main menu • the tool bar • the popup menus • the short keys


WoodheadWoodhead


- Node characteristics

Select a node and click on the right button to display the following contextual menu :

Figure 6 : Contextual menu Depending on the type of node (channel, TCP/IP or equipment) certain lines in the menu will not be

accessible (grayed). Remark : The properties of a node can also be accessed directly with the key « F2 », « Enter » or

by double-clicking on the node.


WoodheadWoodhead


- Channel properties : General

Figure 7 : Channel properties : General parameters DATA-BASE : check words of client equipments

Access status address

Check the « Active functionality » box to validate operation and specify the storage address of the 60 « access status words » in the applicom® database. Value from 0 to 31935, default value 0. This option is used to monitor the access interval of the client equipment to the applicom® server mode. If the « Access monitoring time-out » configured in the equipment (see configuration of client equipment) is exceeded, the applicom® interface will indicate its absence in the word corresponding to the client equipment number.

1st word Client equipment number 0 .. 60th word Client equipment number 59

Value of the access status word : 0 : the equipment accesses the applicom® server in the defined time, 4 : the client equipment accesses inaccessible data in the applicom® server, 33 : the client equipment does not access the applicom® server within the defined time, 36 : the targeted equipment is not configured


WoodheadWoodhead


Access indicator address

Check the « Active functionality » box to validate operation and specify the storage address of the 60 « access indicator words » in the applicom® database. Value from 0 to 31935, default value 0. All write access by a client equipment to the applicom® server will be indicated by incrementing the word corresponding to the number of the client equipment configured.

1st word Client equipment number 0 .. 60th word Client equipment number 59

This word has a maximum value of 65535; you must reset this value so that the word can count the accesses again .


WoodheadWoodhead


Requests being processed

Time-out Maximum time separating the transmission of a request by the applicom® client from the response by the server. When the equipment does not answer within this time-out, the current request returns status 55 « Message lost » Value in seconds, from 2 to 255, default value 10.

Maximum number

Sets the maximum number of requests being processed. Above this figure, the requests are placed on a waiting list until a request being processed is released. The number of requests being processed indicates a number of requests sent simultaneously on the network. These requests contribute to the network load. By modifying the maximum number of requests being processed, this load can be regulated. Two possible cases may then arise for applications including an applicom® interface and PLCs : dedicated network : the maximum number of requests being processed proposed by default

optimises the performance of the communication support. network shared with workstations : in case of network overload (>30%), the maximum

number of requests pending must be reduced. This is done to preserve the pass band for the other stations. Value from 1 to 32, default value 12 (default value 16 in multi-messaging).


WoodheadWoodhead


- Channel properties: Ethernet

Figure 8 : Channel properties : ethernet

Connection type This choice determines which type of physical interface is used (DB15 or RJ45 connector) : AUI (Attachment Unit Interface) : DB15 connector to connect a transceiver (drop cable or direct transceiver), 10 Base T/RJ-45 : integrated transceiver, star topology, double twisted pairs RJ45 connector,

Baud rate (PCI2000ETH version B only)

Allow you to select the baud rate if the connection type is RJ45. The choice « auto 10/100Mb » squares with an automatic detection of the baud rate. Default baud rate: 10Mb with the AUI connection type and « auto 10/100Mb » with the RJ45 connection type.

Connection lifetime

Maximum inactivity time for a TCP connection. A connection is active when data is transiting or when it is being serviced (configurable procedure in TCP). After this time, the connection is closed, in order to avoid overloading connections (max. 128) when the partner is absent. Value in minutes, from 2 to 60, default value 3.


WoodheadWoodhead


Channel Ethernet address

Address on 6 bytes defining the Ethernet channel uniquely on the network. Manual input (« Automatic calculation » not checked ): Enter the Ethernet address in hexadecimal. if you enter an address, then the address which will be used is the one you entered. Automatic address calculation : This address can be calculated automatically from the applicom® IEEE address and the board serial number : The serial number is indicated by labels on the applicom® interface (on the rear plate and on the copper) or visible when initialising the interface (« applicom initialisation »). Example: Ethernet address of an applicom® interface bearing serial number 20100 i.e. 4E84 Hexadecimal.


WoodheadWoodhead


- Alnet II properties:

Figure 9.1 Alnet II properties

Parameter: Node Number: network address of applicom® station.


WoodheadWoodhead


- Properties of the TCP/IP protocol

See "- TCP/IP appendix" on page 39 for further details. IP parameters

Figure 10 : TCP/IP properties

applicom channel IP address Zone of 4 bytes entered in pointed decimal notation representing the Internet address or IP address of the applicom® board channel.

Gateway IP address

IP address of a machine likely to perform a routing to another network (internal or external).

Sub-network mask Used to define the addresses to be routed by the gateway. Value « 0.0.0.0 » to « 255.255.255.255 », « 255.255.255.0 » by default.

The « Advanced parameters » button provides access to expert settings for TCP/IP.


WoodheadWoodhead


- Advanced parameters

For further details, consult "- Time-out TCP" on page 42

Figure 11 : TCP/IP advanced parameters

Number of retries Number of times that the applicom® board attempts to retransmit a non-acknowledged TCP packet. Value from 1 to 12, default value 2.

Interval between retries

Maximum time between two retries. The time between retries increases on every attempt. This parameter related to the number of retries, can therefore be used to determine a global time-out for transmission of a TCP packet. Value in seconds, from 1 to 5, default value 1. If a TCP packet is not acknowledged and terminates in time-out, the connection is closed and the function then returns a status 33 « Time-out ».

Connection servicing Activation of the TCP/IP « keep alive » function used to keep the TCP connections open with a periodic check that the partner is present.


WoodheadWoodhead


- Inserting an equipment

• From a « Server equipment » or « Client equipment » node : o Press the « INS. » key or choose the command Add an equipment in the popup menu.

The « Insert new equipment » dialog box is displayed. o Then follow the instructions in chapter "- Equipment properties" on page 22.

• From an equipment which is already configured : o Press the « INS. » key or choose the command Add an equipment in the popup menu. o The dialog box described in chapter "- Equipment properties" on page 22 is opened

directly.


WoodheadWoodhead


- Equipment properties Generally, all server or client equipments will be composed of a common « applicom®

description » for all equipment types, a « Network parameters » zone to enter the equipment address, and lastly a « Messaging parameters » zone specific to each equipment type.

applicom description

Equipment number applicom® equipment number to be chosen from the list of non-configured equipments. Value: 000 to 127 for server equipments, 000 to 59 for client equipments,

Active configuration Check box to activate the equipment configuration in the applicom® interface : used to delete an equipment from the applicom® interface whilst keeping its configuration in applicom console.

Link parameters Check box to automatically link the last byte of the IP address, and the node number of the station.

Symbolic name The symbolic name is used as TOPIC, for OPC or the DDE server, PCDDE.

Comment Free text about an equipment. The maximum number of characters is 80.

Network parameters

IP address of the equipment. IP address of the partner equipment. The complete address in TCP/IP includes an IP address and a port number (Port TCP), which is used to identify the application using the connection. Generally the port number is predefined by the PLC manufacturer. However, certain types of equipment offer the possibility of modifying this port. In this case a « Equipment TCP port » entry zone will be displayed in the "Network parameters" box.


WoodheadWoodhead


- Properties of a « AL 2003 » server equipment After selecting the « Altus» equipment, choosing the equipment number and entering the network

parameters, you must define the « messaging parameters » zone:

Figure 12 : Properties of a AL 2003 server equipment


WoodheadWoodhead


Figure 14 : Properties of a AL 2003 server equipment

applicom description See chapter "- Equipment properties" on page 22. Network parameters See chapter "- Equipment properties" on page 22. Messaging parameters:

Node Number : Node number of Altus station


WoodheadWoodhead


- ALNET II client equipment properties Remark : Access to the server functionality of the applicom® interface requires no configuration. The

client must simply target the applicom® IP address on the port TCP number 405 (access identical to that of a PLC).

This configuration is only required to use the functionality of monitoring clients to the applicom® server (Access time-out and detection of writing in the applicom® database). See chapter "- ALNET II server" on page 8.

After choosing the equipment number and entering the network parameters, you must define the

« messaging parameters » zone:

Figure 13 : Alnet II client equipment properties

applicom description See chapter "- Equipment properties" on page 22. Network parameters See chapter "- Equipment properties" on page 22. Messaging parameters

Access time-out Definition of the access time-out to the applicom® ALNET II server. Value from 0 to 65535, default value 5. This value determines the maximum time interval between the accesses of the client to the applicom® server. After this delay, its absence will be automatically indicated in the « Access status words » of the applicom® database, see "- Channel properties : General" on page 13.


WoodheadWoodhead


- Deleting an equipment 1. Select the equipment to be deleted. 2. Click on the right button to display the popup menu. 3. Choose the Delete command.

You can also use the keyboard shortcut « Del. ». This command is irreversible.

- Duplicating an equipment 1. Select the equipment to be duplicated. 2. Choose the Copy (Ctrl+C) command. 3. Select the insertion position 4. Choose the Paste(Ctrl+C) command.V

- Moving an equipment 1. Select the equipment to be moved. 2. Choose the Cut (Ctrl+X) command. 3. Select the insertion position 4. Choose the Paste(Ctrl+C) command.V


WoodheadWoodhead

ALNET II on Ethernet TCP/IP • 27 • - Functions which can be used on the master channel

3. - Functions which can be used on the master channel

- In wait mode

readpackbyte Writepackbyte readpackibyte readword writeword readdword writedword

- In deferred mode

readdifbit writedifpackbit readdifibit readdifword writedifword readdifiword readdifdword writedifdword readdiffword writediffword testtransdif transdif transdifpack

- In cyclic mode

createcyc startcyc stopcyc actcyc transcyc transcycpack

Variable in the Function type equipment Read Write

Packed bytes X X Packed input bytes X Words X X BCD words X X Input words X Double words 32 bits X X


WoodheadWoodhead

ALNET II on Ethernet TCP/IP • 28 • - Image variable item

4. - Image variable item

- Presentation The "image variable items" are all syntaxes which can be used to access variables via the

"PCDDE" DDE server or the OPC server

- With the DDE server, the item corresponds to the "item name" part of the DDE connection defined by: - application name - topic name - item name

For further details, refer to the chapter "Principle of the DDE protocol" in the "DDE and OPC servers" manual.

- With the OPC server, the item represents the last part of the "ItemId" parameter. For further details, refer to the chapter "Access to an OPC variable" in the "DDE and OPC servers" manual.

Depending on the configuration of each equipment, the most adapted descriptor is by default

automatically determined by the server. With the ALNET II protocol on TCP/IP, the default descriptors are :

the « ALNET II descriptor » for the AL 2003 equipments, You can, however, force the use of another descriptor (especially the applicom® standard

descriptor) by using the advanced options


WoodheadWoodhead


- Standard descriptor The standard descriptor is used to access the equipment which does not have a specific descriptor.

The address field in the « item » name can go up to 10 digits. A linear address can therefore be composed ranging from 0 to 4 giga.

Unitary mode Table Mode, Matrix Mode

Internal bits Bx Bx_n, Bx_n_l Input bits BIx BIx_n, BIx_n_l Internal words Wx Wx_n, Wx_n_l Bits in the internal words Wx.b Input words WIx WIx_n, WIx_n_l ASCII string in the internal words M_Wx_n Internal double words Dx Dx_n, Dx_n_l Internal floating words Fx Fx_n, Fx_n_l

Remark : The limiting values of parameters n and 1 depend on the protocol. However, for PCDDE,

they cannot be greater than 128 for bits and bytes, 64 for words, 32 for double words and floating words. To consult the read and write limits, refer to the sections: AL 2003 type server - Maximum numbers of variables per exchange with PCDDE - Maximum numbers of variables per exchange with the OPC server

- Internal bits Bx (type : BIT) x : Number of the first bit. Example: B4

- Internal bits Bx_n, Bx_n_l n: Number of bits. l: Number of bits per line (Matrix mode only). Examples : B4_10, B4_10_5

- Input bits BIx (type : BIT) x : Number of the first bit. Example: BI4

- Input bits BIx_n, BIx_n_l n: Number of bits. l: Number of bits per line (Matrix mode only). Examples : BI4_10, BI4_10_5


WoodheadWoodhead


- Internal words Wx (type : 16 bit WORD) x: Number of the first word. Example: W4

- Internal words Wx_n, Wx_n_l

n : Number of words. l: Number of words per line (Matrix mode only). Examples : W4_10, W4_10_5

- Bits in the internal words Wx.b (type : BIT) For this syntax, the maximum numbers of variables per frame are:

in read: 128*16 in write: 1

x: Number of the first word. b: Rank of the bit in the word (0 to 15). Example : W4.5

- Input words WIx (type : 16 bit WORD) x: Number of the first word. Example: WI4

- Input words WIx_n, WIx_n_l n: Number of words. l: Number of words per line (Matrix mode only). Examples : WI4_10, WI4_10_5


WoodheadWoodhead


- ASCII string in the internal words M_Wx_n (type : 16 bit WORD) For further information on the use of ASCII strings, you can consult chapter "Use of message

mode". x: Number of the first word containing the string n: Number of potential words that could contain the ASCII string (1 to 65). Example: M_W100_30 In the example, the word array W100 to W129 can contain the string.

- Internal double words Dx (type : 32 bit WORD) x: Number of the first double word. Example: D4

- Internal double words Dx_n, Dx_n_l n: Number of double words. l: Number of double words per line (Matrix mode only). Examples : D4_10, D4_10_5

- Internal floating words Fx (type : REAL IEEE 32 bits) x : Number of the first floating word. Example: F4

- Internal floating words Fx_n, Fx_n_l n: Number of floating words. l: Number of floating words per line (Matrix mode only). Examples : F4_10, F4_10_5


WoodheadWoodhead


-"ALNET II ALTUS descriptor" This descriptor can only be used for access to ALTUS 2xxx via OPC applicom® interfaces.

Unitary mode Table Mode, Matrix Mode

Internal bytes Ax Ax_n Bits in internal bytes Ax.b Input bytes Ex Ex_n Bits in input bytes Ex.b Output bytes Sx Sx_n Bits in output bytes Sx.b Internal words Mx Mx_n Bits in the internal words Mx.b Internal double words Dx Dx_n Bits in Internal double words Dx.b Internal table words TMx.y TMx.y_n Internal table double words TDx.y TDx.y_n Bit in internal table word TMx.y.b Bit in internal table double word TDx.y.b ASCII string in the internal bytes M_Ax_n ASCII string in the internal words M_Mx_n

Remark : the limiting values of parameters n and 1 depend on the protocol. However, for PCDDE,

they cannot be greater than 128 for bits and bytes, 64 for words, 32 for double words and floating words. To consult the read and write limits, refer to the sections: ALNET II server - Maximum numbers of variables per exchange with PCDDE - Maximum numbers of variables per exchange with the OPC server For addressing of variables, refer to the chapter - Addressing mode.

- Internal byte => Ax (type : 8 bit BYTE) x : Number of the first byte (0 to 254). Example: A4

- Bit in internal byte => Ax.b (type : 1 BIT ) x : Number of the first byte (0 to 254). b :Rank of the bit in the word (0 to 7). Example: A4.2


WoodheadWoodhead


- Input byte => Ex (type : 8 bit BYTE) x : Number of the first byte (0 to 254). Example: E4

- Bit in input byte => Ex.b (type : 1 BIT ) x : Number of the first byte (0 to 254). b :Rank of the bit in the word (0 to 7). Example: E4.2

- Output byte => Sx (type : 8 bit BYTE) x : Number of the first byte (0 to 254). Example: S4

- Bit in output byte => Sx.b (type : 1 BIT ) x : Number of the first byte (0 to 254). b :Rank of the bit in the word (0 to 7). Example: S4.2

- Internal words => Mx (type : 16 bit WORD) x : Number of the first word (0 to 32767). Example: M4

- Internal words =>Mx_n (type : 16 bit WORD) x : Number of the first word (0 to 9998). n : Number of words. Examples : M4_10

- Bits in the internal words => Mx.b (type : BIT) x : Number of the word (0 to 9998). b: Rank of the bit in the word (0 to 15). Example : M4.5

- Internal doubles words => Dx (type : 32 bit WORD) x : Number of the first double word (0 to 9998). Example: D4


WoodheadWoodhead


- Internal double words => Dx_n (type : 32 bit WORD) x : Number of the first double word (0 to 9998). n: Number of double words. Examples: D4_10

- Bit in internal double words => Dx.b(type : 32 bit WORD) x : Number of the first double word (0 to 9998). b :Rank of the bit in the word (0 to 31). Example: D4.2

- Internal table word => TMx.y (type : 16 bit WORD) x : Number of the table (0 to 255). y : Index of the table (1 to 254) Example: TM4.1

- Internal table words => TMx.y_n (type : 16 bit WORD) x : Number of the table (0 to 255). y : Index of the table (1 to 254) n : Number of the words (1 to 115) Example: TM4.1_2

- Bit in Internal table words => TMx.y.b (type : 1 BIT) x : Number of the table (0 to 255). y : Index of the table (1 to 254) b :Rank of the bit in the word (0 to 15). Example: TM4.1_2

- Internal table double word => TDx.y (type : 32 bit WORD) x : Number of the table (0 to 255). y : Index of the table (1 to 254) Example: TM4.1

- Internal table double words => TDx.y_n (type : 32 bit WORD) x : Number of the table (0 to 255). y : Index of the table (1 to 254) n : Number of the words (1 to 57) Example: TM4.1_2


WoodheadWoodhead


- Bit in Internal table double words => TMx.y.b (type : 1 BIT) x : Number of the table (0 to 255). y : Index of the table (1 to 254) b :Rank of the bit in the word (0 to 31). Example: TM

- ASCII string in the internal bytes => M_Ax_n (type : 8 bit WORD) For further information on the use of ASCII strings, you can consult chapter "Use of message

mode". x: Number of the first byte containing the string n: Number of potential words that could contain the ASCII string (1 to 65). Example: M_M100_30

- ASCII string in the internal words => M_Mx_n (type : 16 bit WORD) For further information on the use of ASCII strings, you can consult chapter "Use of message

mode". x: Number of the first word containing the string n: Number of potential words that could contain the ASCII string (1 to 65). Example: M_M100_30


WoodheadWoodhead

ALNET II on Ethernet TCP/IP • 36 • - Appendices

5. - Appendices

- List of additional files for ALNET II on TCP

CLIMETH. Multi-messaging TCP/IP client task SERVMETH. Multi-messaging TCP/IP server task NETMETH. Multi-messaging TCP/IP network management task ISOL4. Layer for ISO transport task TCP. TCP transport task IPTCP. IP communication task ARPTCP. ARP communication task READMETH. Ethernet channel read task WRITMETH. Ethernet channel write task APDIAG.EXE Diagnostics utility APPFBOLE.DLL DLL used by APDIAG.EXE

- Evolution / compatibility This protocol is only available on the applicom® PCI2000ETH interfaces; EPROMs version 3.7 or

greater are required. Compatibility : Evolutions :


WoodheadWoodhead


- Function return statuses The various applicom® functions return a status word to: - Guarantee the quality of the request. - Diagnose the cause of a failure. The meaning of the status word value is detailed in the following tables. As well as the general

meaning, « Additional Information » will enable you to orient your diagnosis according to the protocol used.

- General applicom® statuses

-6 The function TRANSCYC (or TRANSCYCPACK) is used with a cyclic function number which was activated but is no longer.

-5 The user program is attempting to make a deferred transfer TRANSDIF (or TRANSDIFPACK) although the current deferred request is not finished.

-1 Deferred transfer request TRANSDIF (or TRANSDIFPACK) concerning a write which took place correctly. 0 No anomaly detected. The function was executed correctly. 1 Unknown function.

The function requested is not supported. 2 Bad address.

The address of the variable that you are soliciting is bad. 3 Bad data.

Additional information : Function : BINBCD, BCDBIN. - At least one of the values accessed is not in BCD format (0<= value <= 9999).

4 Inaccessible data. 32 Bad parameter passed to the function.

Bad number of variables. 35 Data not available in cyclic read.

Attempt to transfer data by TRANSCYC (or TRANSCYCPACK) before reading the data in the equipment.

40 Deferred read or write attempt by a task when the maximum number of tasks which can use deferred mode simultaneously has been reached. Another task must release resources by performing an exitbus.

41 Deferred read or write attempt when the deferred request register is full. Perform deferred request transfers with TRANSDIF (or TRANSDIFPACK) to release the register (64 positions).

42 Deferred request transfer attempt with TRANSDIF (or TRANSDIFPACK) when it is empty (no deferred requests to do).

45 Communication program not resident. Initialze the applicom® interface before using it by entering the command applicom (or PCINIT under Windows ).

46 Board number not configured, or applicom® master/client function targeting a channel configured as slave/server or vice versa.

47 No applicom® interface. 51 Driver system problem. 59 - Protection key missing on the applicom® interface.

- Use of applicom® functions without calling the function INITBUS beforehand. 66 Not enough applicom® interface memory. 255 Used by the MS-Windows server « PCDDE ». Initial value of the items « STATUS_READ » and

« STATUS_WRITE ». This value indicates that no transaction was carried out between « PCDDE » and the applicom® interface.

Remark : negative statuses are information codes.


WoodheadWoodhead


- Statuses relating to the protocol

0 No anomaly detected. The function was executed correctly. 2 Bad address.

The address of the variable that you are soliciting is bad. Additional information : Messaging on TCP/IP Ethernet : - Returned by the coupler of the destination equipment. Access to a variable with a bad address or a number exceeding the PLC zone.

3 Bad data. Additional information : - Incoherent frame content.

4 Inaccessible data. Additional information : - The physical address does not exist, non existent module or protected data.

33 Time-out fault. Additional information : - Equipment configured but not connected on the network. Wiring problem, the CPU does not run the communication blocks, connection not declared or badly declared in the CPU. - Bad IP address of the equipment or the gateway. - To verify that the format of field Ethernet configured in the distant equipment is « ETHERNET II ».

36 Equipment not configured. Define the equipment configuration with PCCONF and reinitialize the applicom® product.

49 Queue time-out fault The request could not be sent due to lack of resources (no communication channels available). This time corresponds to 4 times the value of the time-out for the requests being processed. Increase the value of the « time-out for requests being processed » Increase the maximum number of simultaneous requests on the targeted equipment.

55 Response time-out exceeded, message lost. Additional information : - Time-out exceeding the value of the « time-out of requests being processed », connection established, question acknowledged but no response.

66 Not enough applicom® interface memory. Additional information : - Insufficient resources for additional connection.

70 Connection terminated by the remote equipment Additional information : - Connection aborted following a connection problem. Wiring problem, CPU in stop, the CPU does not run the communication blocks. - The aimed equipment does not support this messaging.


WoodheadWoodhead


- TCP/IP appendix

- IP address Each interface on a TCP/IP network or sub-network must have a unique IP address. Determination of this address depends on the network type :

open type network (e.g. : Connected to the worldwide Internet), the address or set of addresses must be issued by an authorized organization in the country where the network is installed, closed type network (network internal to the company), the addresses are issued by the

network administrator.

An IP address is represented on 4 bytes (or 32 bits. It is composed of : a network identifier, a machine identifier.

Using these two identifiers, the IP addresses can be divided into 5 different classes:

Class A : 128 networks and 16777216 stations

0 network id 7 bits station id 24 bits

Class B : 16384 networks and 65536 stations

1 0 network id 14 bits station id 16 bits

Class C : 2097152 networks and 256 stations

1 1 0 network id 21 bits station id 8 bits

Class D :

1 1 1 0 multicast group id 28 bits

Class E :

1 1 1 1 0 reserved for future use 27 bits

Which gives us in pointed decimal notation :

Class RangeA 0.0.0.0 to 127.255.255.255B 128.0.0.0 to 191.255.255.255C 192.0.0.0 to 223.255.255.255D 224.0.0.0 to 239.255.255.255E 240.0.0.0 to 255.255.255.255

The choice of an internal address will therefore depend on the number of stations on this network; a

class C address is generally sufficient. Special case : « loopback » destination address 127.0.0.1, this address can be used to test the

TCP/IP layer. A packet with destination address 127.0.0.1 will not leave on the network, the packet drops down to the IP layer then goes straight back to TCP.


WoodheadWoodhead


- Sub-network mask Class A and B addresses include a large number of machines which are represented respectively

on 24 and 16 bits. It is therefore recommended to divide the machine identifier into sub-network identifier and machine identifier.

For example, for a class B address :

1 0 network id 14 bits sub-network id 8 bits station id 8 bits This breakdown authorizes 254 sub-networks, with 254 machines per sub-network. The network mask can be used to specify the bits forming the sub-network mask. This mask is a 32 bit word containing bits set to 1 for the network and sub-network identifiers, and

bits set to 0 for the machine identifier. Example for a sub-network mask with class B address :

network id sub-network id machine id16 bits 8 bits 8 bits

11111111 11111111 11111111 00000000 I.e. a sub-network mask of 255.255.255.0 Using its IP address and the sub-network mask, a machine can determine whether a packet is

intended for : a machine on its own sub-network, a machine on another sub-network (use of the gateway IP address), a machine on a different network (use of the gateway IP address).

Example :

The applicom® board at IP address 140.152.3.25 with a sub-network mask of 255.255.255.0. The address is therefore class B with a network ID of 140.152, a sub-network id of 3, and a machine id of 25. The following equipments must be polled :

• Equipment 1 with address 140.152.7.10 : identical network id (140.152), different sub-network id (7) => use of the gateway.

• Equipment 2 with address 140.152.3.20 : identical network id (140.152), identical sub-network id (3), different machine id (20) => sent directly to the equipment.

• Equipment 3 with address 194.204.26.43 : different network id (class C) => use of the gateway.


WoodheadWoodhead


- Gateway The TCP/IP IP layer (layer 3) can be used to change network or sub-network via a dedicated machine called a gateway or router. This machine must have at least two links on two different networks. When the destination address is on a different network, IP therefore uses the gateway IP address to send the packet. This gateway handles this packet completely and returns it on the destination network. Example, transfer to an internal sub-network :

��

��

��

��

��

��!

��!��

��!��

��

��

��

��"�� #��#$�"�� %�&'��#(��"��

��"��!��#��#$�"��!��%�&'��#(��"��

��

��

��

)��

)��

Figure 14 : IP gateway

The request intended for equipment 2 with address 140.152.7.10, is sent to the gateway 140.152.3.1 (transfer from network 140.152.3 to 140.152.7). The gateway returns the request to equipment 2, which answers using gateway 140.152.7.1.


WoodheadWoodhead


- Time-out TCP The TCP/IP protocol supplies a reliable transport layer, i.e. it manages the time-out and retry

procedures for packet acknowledgment. The maximum number of retries is 12, and the time-out between each retry is variable. Initially, this

time is calculated using an estimation of the « d’return » time of a packet on the connection then increases with the number of attempts exponentially up to a limit of 64 seconds, which generally produces :

* ��

�� + *� *�

��

�*�� ,�� +��

� � �

� * ! + �

-�(��.

/��$��0#-

1(�2��3(4

��(�2��3(

�

�*� *� *� *� *�

�+*�� !+��

Figure 15 : TCP time-out

We soon see that the wait time to know that a packet has not been acknowledged can be very long : 542.5 seconds, i.e. over 9 minutes. The applicom® interface allows you to configure :

The number of retries, The maximum interval between two retries.

To simplify the time-out calculation, it is easier to set the maximum interval between two retries to 1

second and then adjust the number of retries, by default the applicom® interface uses 2 retries, which gives you a time-out of about 3 seconds.

On very disturbed or very saturated networks (load greater than 30 %), it is recommended to set 4 retries.

- Connection servicing The TCP connections can be serviced with the « connection servicing » function in TCP/IP

« Advanced parameters » of (generally called « keep alive »). This servicing is used to keep the connection alive even if there is no data circulating. Also, if the partner equipment no longer responds to this servicing, the connection is automatically deleted.

The applicom® interface can be used to validate or not this operating mode. The operating mode

characteristics (which cannot be modified) are : Servicing frequency : 30 seconds Retry frequency : 20 seconds number of tries if no response : 8


WoodheadWoodhead


- TCP/IP extended statuses The extended statuses for TCP/IP are used to refine the statuses related to the protocol, they can

be accessed with the utility « Diagnostics TCP-IP & ISO » by validating « Expert mode ».

1035 Ressource temporarily unavailable1036 Operation now in progress1037 Operation already in progress1038 Socket default1039 Destination address required1040 Message too long1041 Protocol wrong type for socket1042 Protocol not available1043 Protocol not supported1044 Socket type not supported1045 Operation not supported1046 Protocol family not supported1047 Address family not supported by protocol family1048 Address already in use1049 Impossible address1050 No network1051 Network is unreachable1052 Network dropped connection on reset1053 Software caused connection abort1054 Connection reset by peer1055 No buffer space available1056 Socket is already connected1057 Socket is not connected1058 Can't send after socket shutdown1061 Connection refused1064 Host is down1065 Host is unreachable


WoodheadWoodhead

ALNET II on Ethernet TCP/IP • 44 • - Glossary

6. - Glossary

ARP

Address Resolution Protocol : address resolution protocol

ASCII American Standard Code for Information Interchange

AUI Attachment Unit Interface : interface between coupler and transceiver

Channel Physical output of an applicom® board

Client Equipment which takes the communication initiative

Coupler Communication interface

CSMA/CD Carrier Sense Multiple Access with Collision Detect : Multiple access with listening to the carrier

and collision detection

DATA-BASE applicom® database of 32 kbits and 32 kwords

EPROM Electronic component installed on the applicom® interface where non-erasable computer programs

are stored

ICMP Internet Control Message Protocol : control message protocol using IP

applicom® interface Communication board of type ISA or PCI, equipped with the applicom® real time multi-task kernel

(PC1000, PC2000, PC4000, PC1500PFB, etc.)

IP Internet Protocol : inter-network protocol

Item Defines a unit article or element

ITP Industrial Twisted Pair : double industrial twisted pair developed by Siemens

LLC Logical Link Control

OPC Ole for Process Control


WoodheadWoodhead

ALNET II on Ethernet TCP/IP • 45 • - Glossary

OSI Open Systems Interconnection

PCDDE applicom® DDE server

TCP port Number which, associated with the IP address, enables TCP to identify the application using the

connection

RFC Request For Comment : set of specifications describing amongst other things all TCP/IP protocols

TCP Transmission Control Protocol

UDP User Datagram Protocol : simple packet transmission protocol, not made reliable (no connection

nor retry).


WoodheadWoodhead

ALNET II on Ethernet TCP/IP • 46 • - Index

7. - Index

accessible variables, 6 addresses, 6 ALNET II

Client equipment properties, 25 Functionality, 6 Server, 8

Channel properties, 13, 16 Client equipment properties

ALNET II, 25 Configurator

Commands, 11 Configurator commands, 11 EPROM, 37 Equipment

Deleting, 27 Duplication, 27 Insertion, 20 Modification of properties, 12 Moving, 27 properties, 22

Error, 38 Ethernet, 16 Evolution, 37 Function return, 38 Functionality, 3, 6 Functions which can be used

Cyclic mode, 28 Deferred mode, 28 Wait mode, 28

Insertion rules, 20 IP

address, 40 gateway, 43 Sub-network mask, 42

IP addressing, 40 IP gateway, 43 IP Sub-network mask, 42 Item descriptor

Presentation, 29 Standard descriptor, 30 Telemecanique TSX/PMX descriptor, 32

Items Standard descriptor, 30 Telemecanique TSX/PMX descriptor, 32

Maximum number of variables per TSX QUANTUM exchange PCDDE, 7

Maximum number of variables TSX QUANTUM per exchange OPC server, 7

Maximum numbers of variables per TSX QUANTUM exchange Library, 7

Modbus client, 6 Multi-request, 4


WoodheadWoodhead

ALNET II on Ethernet TCP/IP • 47 • - Index

Network parameters, 22 OSI, 1 Requests, 13 Server equipment properties

TSX QUANTUM, 23 Status, 38, 39 TCP

status, 45 TCP

servicing, 44 time-out, 44

TCP servicing, 44 TCP status, 45 TCP/IP

Properties, 19 TCP/IP properties, 19 Time-out TCP, 44 TSX QUANTUM

Server equipment properties, 23 TSX QUANTUM limits

Library, 7 OPC server, 7 PCDDE, 7

altus

Documents