sinec...cp 2413 and as-i 2413 ms-dos/windows b8976-c084 1-2 1.1 general 1.1.1 overview of the...

C79000-G8976-C061

Release 01Volume 1 of 1

SINEC is a trademark of SIEMENS

Siemens Aktiengesellschaft

SINEC

SINEC S1 Master Module CP 2413

Introduction

Master module CP 2413 and AS-I MS-DOS/Windows

Appendix

PICS

Abbreviations / Terms

Further reading

Notes on the CE Marking

A

B

1

C

2

D

Siemens Aktiengesellschaft Elektronikwerk Karlsruhe

Printed in the Federal Republic of Germany

Wir haben den Inhalt der Druckschrift auf Übereinstimmungmit der beschriebenen Hard- und Software geprüft. Den-noch können Abweichungen nicht ausgeschlossen werden,so daß wir für die vollständige Übereinstimmung keineGewähr übernehmen. Die Angaben in der Druckschrift wer-den jedoch regelmäßig überprüft. Notwendige Korrekturensind in den nachfolgenden Auflagen enthalten. Für Verbes-serungsvorschläge sind wir dankbar.

Technische Änderungen vorbehalten.

Weitergabe sowie Vervielfältigung dieser Unterlage, Ver-wertung und Mitteilung ihres Inhalts nicht gestattet, soweitnicht ausdrücklich zugestanden. Zuwiderhandlungen ver-pflichten zu Schadenersatz. Alle Rechte vorbehalten, insbe-so ndere für den Fal l der Patenter te ilung oderGM-Eintragung.

We have checked the contents of this manual for agreementwith the hardware described. Since deviations cannot beprecluded entirely, we cannot guarantee full agreement.However, the data in this manual are reviewed regularly andany necessary corrections included in subsequent editions.Suggestions for improvement are welcome.

Technical data subject to change.

The reproduction, transmission or use of this document orits contents is not permitted without express written autho-rity. Offenders will be liable for damages. All rights, includingrights created by patent grant or registration of a utility ordesign, are reserved.

Nous avons vérifié la conformité du contenu du présentmanuel avec le matériel et le logiciel qui y sont décrits. Or,des divergences n’étant pas exclues, nous ne pouvons pasnous porter garants pour la conformité intégrale. Si l’usagedu manuel devait révéler des erreurs, nous en tiendronscompte et apporterons les corrections nécessaires dès laprochaine édition. Veuillez nous faire part de vos suggesti-ons.Nous nous réservons le droit de modifier les caractéristi-ques techniques.

Toute communication ou reproduction de ce support d’in-formations, toute exploitation ou communication de soncontenu sont interdites, sauf autorisation expresse. Toutmanquement à cette règle est illicite et expose son auteurau versement de dommages et intérêts. Tous nos droitssont réservés, notamment pour le cas de la délivrance d’unbrevet ou celui de l’enregistrement d’un modèle d’utilité.

Copyright © Siemens AG 1995 All Rights Reserved

SINEC

SINEC S1 Master module CP 2413

Manual C79000-B8976-C084

Note

We would point out that the contents of this product documentation shall not become a part of ormodify any prior or existing agreement, commitment or legal relationship. The Purchase Agreementcontains the complete and exclusive obligations of Siemens. Any statements contained in thisdocumentation do not create new warranties or restrict the existing warranty.

We would further point out that, for reasons of clarity, these operating instructions cannot deal withevery possible problem arising from the use of this device. Should you require further informationor if any special problems arise which are not sufficiently dealt with in the operating instructions,please contact your local Siemens representative.

GeneralThis device is electrically operated. In operation, certain parts of this device carry adangerously high voltage.

Failure to heed warnings may result in serious physical injury and/or material damage.

Only appropriately qualified personnel may operate this equipment or work in itsvicinity. Personnel must be thoroughly familiar with all warnings and maintenancemeasures in accordance with these operating instructions.

Correct and safe operation of this equipment requires proper transport, storage andassembly as well as careful operator control and maintenance.

Personnel qualification requirements

Qualified personnel as referred to in the operating instructions or in the warning notes are definedas persons who are familiar with the installation, assembly, startup and operation of this productand who posses the relevant qualifications for their work, e.g.:

- Training in or authorization for connecting up, grounding or labelling circuits and devices orsystems in accordance with current standards in saftey technology;

- Training in or authorization for the maintenance and use of suitable saftey equipment inaccordance with current standards in safety technology;

- First Aid qualification.

WARNING !

!

B8976-C084 Contents

I-1

CONTENTS

1 INTRODUCTION 1-1

1.1 General 1-21.1.1 Overview of the Chapters 1-21.1.2 Conventions used in the Text 1-21.1.3 Requirements 1-21.1.4 Further Information 1-21.1.5 Hotline 1-2

2 MASTER MODULE CP 2413 AND AS-I 2413 MS-DOS/WINDOWS 2-1

2.1 Overview of AS-I 2413 MS-DOS/Windows 2-2

2.2 Environment and Requirements 2-32.2.1 Hardware Requirements 2-32.2.2 Software Requirements 2-3

2.3 Overview of the CP 2413 2-42.3.1 Hardware Installation 2-42.3.2 Technical Data 2-52.3.3 Connecting the AS-I Cable 2-6

2.4 Software Installation 2-72.4.1 What do You Need for Installation? 2-72.4.2 What You Have to Do 2-82.4.3 What You Should Keep in Mind 2-102.4.4 What You Can Do after Installation 2-11

2.4.4.1 SINEC-Setup 2-112.4.4.2 Transferring and Checking the Authorization 2-122.4.4.3 Configuration of the CP 2413 2-13

2.4.5 Directory Structure 2-152.4.6 Initializing the CP 2413, the Start Batch File 2-152.4.7 AS-I driver 2-152.4.8 Installing the AS-I Monitor 2-162.4.9 The AS-I Library 2-172.4.10 Example Programs 2-17

2.5 The AS-I User Interface 2-182.5.1 How Jobs Function 2-182.5.2 Overview of the Functions 2-23

2.5.2.1 asi_init 2-262.5.2.2 asi_shut 2-272.5.2.3 asi_read_idi (Read Input Data Image) 2-282.5.2.4 asi_write_odi (Write Output Data Image) 2-302.5.2.5 asi_set_permanent_parameter 2-322.5.2.6 asi_get_permanent_parameter 2-342.5.2.7 asi_write_parameter 2-362.5.2.8 asi_read_parameter 2-382.5.2.9 asi_store_actual_parameters 2-402.5.2.10 asi_set_permanent_configuration 2-412.5.2.11 asi_get_permanent_configuration 2-432.5.2.12 asi_store_actual_configuration 2-452.5.2.13 asi_read_actual_configuration 2-462.5.2.14 asi_set_lps 2-482.5.2.15 asi_get_lps 2-49

Contents B8976-C084

I-2

2.5.2.16 asi_get_las 2-502.5.2.17 asi_get_lds 2-512.5.2.18 asi_get_flags 2-522.5.2.19 asi_set_operation_mode 2-542.5.2.20 asi_set_offline_mode 2-552.5.2.21 asi_change_slave_address 2-562.5.2.22 asi_reset 2-582.5.2.23 asi_execute_command 2-592.5.2.24 asi_version 2-612.5.2.25 asi_dia 2-622.5.2.26 asi_dia_reset 2-642.5.2.27 asi_device_info 2-652.5.2.28 asi_cfg_in 2-662.5.2.29 asi_cfg_out 2-672.5.2.30 asi_in_all 2-682.5.2.31 asi_wd 2-69

2.6 Details of the System under MS-DOS and Windows 2-702.6.1 General Information 2-702.6.2 Storage of Variables 2-702.6.3 Drive and Path Information 2-712.6.4 Logging User Programs On and Off 2-71

2.7 Translating and Linking for MS-DOS 2-72

2.8 Translating and Linking for Windows 2-74

2.9 Special Features for Windows 2-76

2.10 Notes and Error Messages 2-792.10.1 The DPRAM 2-792.10.2 Status and Error Messages of the AS-I Driver 2-802.10.3 Status and Error Messages of the AS-I Monitor 2-812.10.4 Return Values of the AS-I Calls 2-83

A ASI PROTOCOL IMPLEMENTATION CONFORMANCE STATEMENT(PICS) A-1

A.1 PICS for CP 2413 A-1

B ABBREVIATIONS / TERMS B-1

C FURTHER READING C-1

B8976-C084 CP 2413 and AS-I 2413 MS-DOS/Windows

1-1

1 Introduction

This chapter contains basic information and an introduction to the SINEC S1 system conceptand SINEC S1 components. The main aim of the manual is to describe the SINEC S1 mastercomponents.

We recommend the following procedure when ...

...You want an overall picture of SINEC S1. å Read the manual ‘SINEC S1/AS-IIntroduction and basic Information’.Here, you will find general informationabout SINEC S1.

...You want to know how CP 2313 programsare created.

å Read in the manaul ‘SINEC S1/AS-IIntroduction and basic Information’Section 1.5 ‘The Master Mode’ inChapter 1. Also read Chapter 2 in thismanual.

...You want to start up the PLC mastermodule CP 2413.

å Sections 2.3 ‘Overview of the CP 2413’and 2.4 ‘Software Installation’ inChapter 2 contain the requiredinformation.

CP 2413 and AS-I 2413 MS-DOS/Windows B8976-C084

1-2

1.1 General

1.1.1 Overview of the Chapters

Chapter 1 SINEC S1/AS-I Introduction and Basic Information

This chapter contains basic information for the effective use of this manual.

Chapter 2 SINEC S1 Master Module CP 2413

In this chapter the use of the CP 2413 in a PC AT is described and also the range of functionsof the CP 2413.

1.1.2 Conventions used in the Text

General symbols in the text:

4 This character indicates an action for you to perform.

+ This character indicates special features and danger.

1.1.3 Requirements

Requirements for Understanding the Manual:

â knowledge of the manual ‘SINEC S1/AS-I Introduction and basic information’

1.1.4 Further Information

You can obtain more detailed information from your local Siemens office, particularly aboutthe SINEC S1 components and other AS-I modules mentioned in this manual.

The order numbers for the products mentioned in this manual can be found in the currentcatalogs.

1.1.5 Hotline

If you have technical questions, please use our hotline on the following numbers:

xx49-9131-7-43147

xx49-9131-7-43157


2-1

2 Master Module CP 2413 andAS-I 2413 MS-DOS/Windows

This chapter explains the functions of the SINEC S1 master module CP 2413 and familiarizesyou with handling the module and the interface AS-I 2413 MS-DOS/Windows.

The chapter deals with the following points:

â How to install the module

â How to install the software on your PC

â How to implement the sequences in the user program

â Which function calls are available

â How to deal with errors

The purpose of the product

With the CP 2413 module and corresponding C interface AS-I 2413 MS-DOS/Windows, aPC-AT has a connection to SINEC S1 in the role of the AS-I master. As shown in thefollowing diagram, in connection with other CP modules there is full integration into SINECnetworks.

SINEC L2 orSINEC H1

CP 2413

PC-AT

SINEC S1

User programwithAS-I-2413 MS-DOS/Windows interface

Fig. 2-1: Arrangement of the PC-AT with the CP 2413 Module


2-2

2.1 Overview of AS-I 2413 MS-DOS/Windows

The interface software functions as follows:

User programs (AS-I applications) call the AS-I library functions. These use operating systemcalls to communicate with the AS-I driver. The communications processor is addressed viaI/O addresses, data is exchanged using the dual-port RAM (DPRAM).

The following diagram illustrates the components of “AS-I 2413 MS-DOS/Windows”.

Fig. 2-2 Components of "AS-I-2413 MS-DOS/Windows"

Ø The AS-I driver:

The driver passes the data from the user program to the CP and vice-versa. It does notprovide a direct interface to the user program.

Ø The AS-I monitor:

The AS-I monitor is used to configure the driver and handles other administrative tasks.

Ø The AS-I library:

The AS-I library contains the AS-I interface and implements the data exchangebetween the user applications and the AS-I driver. User applications make use of theAS-I library for communication.

Ø The pre-loader:

The pre-loader is loaded on the module by the AS-I monitor and with the aid of themonitor copies the firmware required for operation to the communications processor.

Ø The firmware:

The firmware on the CP 2413 handles data exchange with the slaves.

AS-I driver

AS-I lib rary

Supplied with "AS-I-2413 MS-DO S/W indows"

AS-I

AS -I m aster m odule C P 2413

m onitor

AS-Iapplication

DPRAM

Firm -ware

Pre-loader


2-3

2.2 Environment and Requirements

Now that you know the areas of application, interfaces and components of the “AS-I 2413MS-DOS/Windows” package, this section explains what is required of your computer to beable to use this product.

Apart from the SINEC components described in this manual (CP 2413 communicationsprocessor and SINEC software module), a SINEC S1 network must also be available forcommunication.

To be able to install the CP 2413 on your computer, the computer must meet the followinghardware and software requirements (see also the product information and the “readme.txt”file on the first installation diskette).

2.2.1 Hardware Requirements

You require an AT-compatible computer with a 2Kb address area which is freely available inthe main memory (start address: C8000h, C8800h, C9000h ... EF800h) and free I/O ports forthe configuration registers of the CP. These configuration registers can be set using DILswitches (basic values: 200h, 208h, 280h, 288h, 290h, 320h, 3e0h, 3e8h).

If enough address areas and I/O ports are free, it is possible to operate up to four CP 2413modules. If the requirements for operating a CP 1413 or a CP 5412 are fulfilled, it is alsopossible to operate these modules with AS-I master communications processors at the sametime.

+ + Read the information about the CP 1413 and CP 5412 products as well as"TF-NET1413/MSDOS, Windows","MAP-NET1413/MSDOS, Windows" and"TF-NET5412/MSDOS, Windows".

A list of the computers in which the CP 2413 can be operated can be found inthe “readme.txt” file on the first installation diskette.

2.2.2 Software Requirements

The product information and the “readme.txt” file lists the operating system versions of MS-DOS and Windows required to operate the CP 2413.


2-4

2.3 Overview of the CP 2413

You now know the requirements of the "AS-I-2413 MS-DOS/Windows" package for running iton your computer. This section explains how to make setting for the CP 2413 module andinstall it on your computer.

2.3.1 Hardware Installation

The CP 2413 requires an AT slot. The only settings necessary on the module are the baseconfiguration register which is set with a DIL switch. The location of this switch can be seen inFig. 2-3. The default value of the base configuration register is 0x0320.

Apart from the default value, the switch settings shown in the figure below are also possible.

DIL switch for the basic configuration register

Off (0)

On (1)S0S1S2

124

S3

8

Fig. 2-3 Layout of the CP 2413

Using an 8 byte I/O address space, beginning with one of the base configuration registersshown in Fig. 2-4, all the values required for operating the module can be loaded on the CPby the software. With the basic setting, the I/O ports 320h to 327h are used.

S2 S1 S0 Conf. reg.

0 0 0 0200H

0 0 1 0208H

0 1 0 0320H

0 1 1 03E0H

1 0 0 03E8H

1 0 1 0280H

1 1 0 0288H

1 1 1 0290H

S3

-

-

-

-

-

-

-

-

Fig. 2-4 Basic Configuration Register


2-5

Notes on installation

+ + The module must only be installed in the computer when the power supply isswitched off. When handling the module, follow the normal guidelines forhandling electrostatically sensitive devices.

Information about opening the device you are using, selecting the slot for theinterface module and installing modules in this format can be found in thedocumentation for your PG or PC.

2.3.2 Technical Data

The most important technical data can be found in the following diagram and table.

Fig. 2-5 Scale Drawing CP 2413

mm


2-6

Bus cycle time 5 ms with 31 Slaves

Data transfer PC - CP 2413 via 2 Kbyte dual-port RAM

Interfaces

• AS-I connection using connector with terminal connector to AS-I-section cable

Power supply DC 5V via backplane busVoltage permitted on the AS-I cable

Environmental conditions

• Operating temperature 0 to 55°C

• Transport and storage temperature -40°C to +70°C

• Relative humidity 95% at +25°C

Current input typically 720 mA

Construction

• Module format board, short AT format

• Dimensions (W x H x D) in mm 107 x 152

• Weight approx. 110g

• Space required 1 standard slot (15.24 mm)Table 2-1 Technical Data

2.3.3 Connecting the AS-I Cable

The AS-I cable is connected using the supplied connector which has 2 jumpered pairs ofterminals within the CP 2413.

Fig. 2-6 Connector for the AS-I Cable

The second pair of terminals is for connecting the AS-I power supply unit or for a branch ofthe AS-I cable. The AS-I power supply unit can, however, be connected to any other point onthe AS-I cable.

CP 2413 Terminal block

7

8

9

10

Connections jumpered by CP 2413

brown blue brown blue


2-7

2.4 Software Installation

The previous chapter explained how to make settings on the CP 2413 for “AS-I 2413 MS-DOS/Windows” and how to install it in your computer. You will now learn what is required toinstall the software required for operation.

+ + Before installation, please read the product information and the “readme.txt” fileon the first diskette of the package.

2.4.1 What do You Need for Installation?

Computer

This product can be run on the PG 770 and PG 740 programming devices and on compatiblePCs.

Operating System

The product can be run under MS-DOS Version 5.0 and higher, and under Windows 3.x in theenhanced mode.

CP 2413

To run the software, you require a SINEC communications processor CP 2413. Theseinstructions assume that you have set the CP according to the instructions and have alreadyinstalled it in your computer. If you have installed more than one module, make sure that adifferent I/O address is set on each CP. When you install the CP 2413, remember to followthe instructions in Section 2.3.1.

I/O Port

Every CP 2413 requires eight consecutive port addresses starting at a selectable baseaddress. The following base addresses are available:

0x200, 0x208, 0x280, 0x288,0x290, 0x320, 0x3E0, 0x3E8.

Make sure that the port addresses you select are not used for other purposes in your system.

Address Area (dual-port RAM)

During operation, every CP 2413 uses a memory area of 2 Kbytes, with a start address in therange C8000 to EF800.

Make sure that the memory area you have selected is not used by any other component inyour computer.

Installation Diskettes

This product is supplied on 3.5” diskettes.

Ø The software diskettes are read-only.

Ø The key diskette contains only the authorization and is not read-only.


2-8

2.4.2 What You Have to Do

Preparing for Software Installation

Prepare for software installation by following these steps:

Ø Read the README.TXT file on the first diskette of the package.

Ø Read the installation instructions carefully.

Ø Read the instructions in Section 2.3.1 about the CP 2413 and install the module asexplained.

Installing the Software

You can install the software under MS-DOS and Windows. Follow these steps to install thesoftware under MS-DOS:

Ø Boot your computer so that you obtain the system prompt under MS-DOS.

Ø Insert the first diskette of the package in the disk drive (in this manual, drive a: isassumed).

Ø Change to the drive with the first diskette of the package, for example by typing

a:

Ø Change to the root of the drive by typing ‘cd\’

Ø Start the installation program by typing:

install

Ø Now follow the instructions displayed by the installation program. Note: you can installASI-2413 MS-DOS/Windows without authorization. In this case you cannot use thesoftware. It is however possible to install the authorization later.

To install the software under Windows, follow these steps:

Ø Select File/Run in your Windows program manager

Ø Insert the first diskette of the package in the disk drive (in this manual, drive a: isassumed).

Ø Start the installation program by typing in the following:

a: setup

Ø Now follow the instructions displayed by the installation program. Note: you can installASI-2413 MS-DOS/Windows without authorization. In this case you cannot use thesoftware. It is however possible to install the authorization later.


2-9

Configuring the Software

Once you have copied the software to your hard disk, SINEC Setup starts automatically andyou can configure the CP 2413.

Ø In the hardware selection list (the lower list) select an entry for the CP type “CP 2413”.

Ø Select the menu item “Edit / Change Parameter“ to invoke the configuration program.

Ø Make the necessary settings. Remember the instructions and information in thesections ”Hardware Installation“ and ”What do You Need for Installation?“

Ø Quit the configuration program and save your configuration.

Ø Quit SINEC Setup.


2-10

2.4.3 What You Should Keep in Mind

Authorization

This product is supplied with a key or authorization diskette. This containsan authorization key that is required to run the product. During installation,this key is saved on your hard disk. It is then no longer possible to run thepackage without the key.

Using the menu item “authorization/install“, you can also install theauthorization information with SINEC Setup at a later time.

The authorization information is saved in the hidden directory “\ax nf zz“on the drive on which you installed the product.

Please do not delete the directory “\ax nf zz“ or any of the files itcontains!

If you want to reformat your hard disk, you must first transfer theauthorization information back to the key diskette using the“authorization/deinstall“ menu item of SINEC Setup. If you do not dothis, the authorization information is lost and you will no longer beable to use the product. When you transfer the information off thehard disk, make sure that you insert the diskette from which youinstalled the installation information.

It is not possible to simply copy the authorization information from harddisk to diskette or vice versa.


2-11

2.4.4 What You Can Do after Installation

2.4.4.1 SINEC-Setup

The SINEC Setup program

The SINEC Setup program is a single user interface that includes all the options open to youwith the SINEC products you have installed.

The SINEC Setup User Interface

The SINEC Setup user interface appears in four parts:

Ø the menu bar,

Ø the list of installed software packages,

Ø the list of installed hardware components (communications processors) and

Ø the assignment matrix of the installed software packages and hardware components.

The Menu Bar

The SINEC Setup menu bar contains the following options:

Ø Filewith the Quit function to exit SINEC Setup,

Ø Editwith all the functions available for the selected hardware or software,

Ø Extraswith the possible language settings and

Ø Helpproviding access to the online help system.

The List of Installed Software Packages

The list of installed software packages contains all the new SINEC software packagesinstalled on the same drive.

The List of Installed Hardware Components

The list of installed hardware components contains all the SINEC CPs whose configurationdata are installed on the same drive.

This also includes CPs that were installed without SINEC Setup (with the exception of theCP2413). For these modules, you can call the netinst.exe program using the “Edit” menu.

The Assignment Matrix

The assignment matrix provides you with a quick overview that shows which softwarepackage can be used with which hardware and which software you are currently using onwhich hardware.

If the combination of a software package and a hardware component is possible, this ismarked by “-“ .

A software package currently active on a component is marked “x“.


2-12

2.4.4.2 Transferring and Checking the Authorization

Authorization

Each software package has an authorization that allows you to operate the software.

When you have selected a software package, the “Edit“ menu provides the “Authorization”option with the commands “Install“, “Deinstall“ and “Check”.

Install

If you select this function, you are asked to name the drive from which you want to transferthe authorization information. The information is always transferred from the key diskette tohard disk.

Please do not interrupt the transfer, you might lose the authorization information.

Deinstall

When you use this function, you are asked to name the drive from which you want toretransfer the authorization information. The information is always transferred from the harddisk to the key diskette.

Please do not interrupt the transfer, you might lose the authorization information.

Check

When you use this function, you are asked to name the drive on which you want to check theexistence of authorization information for the selected product.

You can use the function to check for authorization information both on your hard disk or on adiskette.


2-13

2.4.4.3 Configuration of the CP 2413

Selecting the Configuration Function

You configure a CP 2413 by following the steps explained below:

Select the CP 2413 in Setup by clicking the appropriate line n the displayed list.

If you select the menu item “Edit/Change Parameters“ (to modify the parameters of the CP)or “Edit/Configure New CP” (to create a set of configuration parameters for a further CP), theinput screen for configuring the CP is displayed.

To delete a set of configuration parameters again, select the menu item “Edit/Delete CP“.

You can make the following entries in the Parameter change screen:

Device name

By this name a user application identifies the CP 2413 which is being used (see for examplechapter 2.5.2.1).

Up to four CP 2413 modules can be operated at the same time as ASI masters. These CPsmust all have different device names, I/O ports and dual-port-RAM addresses.

I/O Port

Here, you select the I/O address set on the CP 2413. The value you select must match theswitch setting on the CP 2413 (see also the Product Information leaflet CP 2413). Make surethat this I/O address is not already being used by a different PC card.

Dual-Port RAM

When you enter the dual-port RAM address, you select the memory area the CP 2413 usesto communicate with your PC. The CP 2413 requires 2 Kbytes in the address area of yourPC. Once again, make sure that this address area is not being used already, either by the PCor another PC card.

Selection Box

If you click ASI-2413 in the selection box, you specify that the CP 2413 will be used as anAS-I master. If you click again, the CP 2413 is deactivated for ASI-2413 and can, forexample, be used for the SCOPE S1 application.


2-14

Exiting the configuration program

If, after exiting the configuration program, the message "Reboot your PC after leaving setupto activate all indicated CP's/devices", appears, then the PC must be rebooted so that thelatest changes will be executed.

A CP 2413 is only then compatible for ASI-2413 MS-DOS/Windows when it has beenpriorly configurated as described in the following.

The autoexec.bat file

The installation program amends the autoexec.bat file of the PC with the entry "call<lw:>\sinec\sinecini.bat". This entry is necessary for the initialization of the CP 2413 modulesin the PC. The original autoexec.bat file is saved as autoexec.bak.

Changing the configuration

Changes in the configuration can be made when starting SINEC setup. Setup is availableunder MS-DOS as well as under Windows if the installatiion was performed under Windows.

Setup under DOS i.e. under Windows is called-up with setup.exe. This programis located inthe directory <lw:>\SINEC ; <lw:> is that drive on which AS-I-2413 MS-DOS/Windows hadbeen installed.

The installation program under windows makes a default-setting in a SINEC program groupwhich contains an icon for SINEC setup. SINEC setup can be started with a double-click onthe icon.


2-15

2.4.5 Directory Structure

The files for AS-I-2413 MS-DOS/Windows are saved in the directory

<dr:> SINEC

(“dr” is the drive you specified during installation)

2.4.6 Initializing the CP 2413, the Start Batch File

During installation of ASI-2413 MS-DOS/Windows, the installation program changes theautoexec.bat. It makes the entry call \sinec\sinecini.bat. By calling the batch file “sinecini.bat”in the SINEC directory, the CP 2413 masters are ready for operation.

The sinecini.bat file is updated by the configuration program in Setup. This in turn calls batchfiles that initialize the individual SINEC CPs (The file ini2413.bat initializes CP2413 moduleson your computer).

2.4.7 AS-I driver

During installation, the AS-I driver is copied to the directory “\sinec\cp2413.dw\bin” on yourcomputer. This is implemented as a memory-resident program that inserts an interrupt routineinto the interrupt jump table allowing a complete handshake with up to 4 AS-I mastermodules.

The AS-I driver is called automatically by the batch files sinecini.bat with ini2413.batso that you do not need additional calls for driver initialization. The call syntax of thedriver is explained simply to complete the picture.

To call the AS-I driver, the following Syntax is required:

asidrv.exe x This installs the driver; “x” is interpreted as a hexadecimal value andrepresents the interrupt number. All even hexadecimal numbersfrom 80h up to and including C0h are permitted. For example withthe call “asimon 80” the AS-I driver is installed and uses interruptnumber 80h.

asidrv.exe This searches for a free interrupt in the upper area and installs thedriver.

The status and error messages of the AS-I driver are explained in Chapter 2.10.2 includingsome proposed solutions for possible problems.


2-16

2.4.8 Installing the AS-I Monitor

During the installation, the AS-I monitor is copied to the directory ‘\sinec\cp2413.dw\bin’ onyour computer. It is used to configure the AS-I driver, to handle administrative jobs such asthe loading of the firmware on the module and to bring the AS-I master module to anoperational status. In contrast to the AS-I driver that supports up to 4 modulessimultaneously, the AS-I monitor must be called once for each AS-I master module with thecurrent parameters for the communications processor.

The AS-I monitor is called automatically by the batch files sinecini.bat with ini2413.batso that you do not need additional calls for driver initialization. The call syntax of thedriver is explained simply to complete the picture.

The following Syntax applies when calling the AS-I monitor:

asimon <option>

For <option> the following values are defined:

-? An overview of the possible options and their significance isdisplayed on the screen.

-h Communication via all the AS-I master communications processorsis terminated. The modules are reset, the AS-I driver is removedfrom memory and the interrupt it uses is released.

-Dw -cx -dy -ez With these options, the AS-I CP is given the name ‘w’. This name isused to identify the AS-I master communications processor and canbe up to a maximum of 8 characters long. The driver is configured,the firmware stored in the file '\sinec\cp2413.hw\fw2413' on the driveindicated by ‘x’ is loaded on the communications processor and theCP started. The communications processor occupies the DPRAMwith the base segment address ‘y’ and the base configurationregister with the value ‘z’. The options must be specified in thisorder.

Example:

-DCP_ASI1: -cc: -dd000 -e0320

If the monitor is called with these options in this order, an AS-I master communicationsprocessor is selected and is addressed with the name ‘CP_ASI1:’. The firmware file'\sinec\cp2413.hw\fw2413' on drive ‘c:’ is loaded on the communications processor. Themodule uses the DPRAM from address d000:0 onwards and the I/O address area from 0320hto 0327h.

The status and error messages of the AS-I monitor are summarized in Section 2.10.3,including certain proposed solutions for problems.


2-17

2.4.9 The AS-I Library

During installation, the AS-I library is copied to the directory '\sinec\cp2413.dw\lib' on yourcomputer. This is available for various memory types, compilers and operating systems and isrequired for applications communicating with the AS-I master communications processor orwith slaves via the module.

For more information about the interface, refer to Section 2.5, rules for binding yourapplications in Section 2.7 to 2.9.

2.4.10 Example Programs

During installation, example programs are copied to the directory '\sinec\cp2413.dw\samples'on your computer. These are in the form of source code and can be translated and integratedwith the supplied compilation instructions. It may be necessary to adapt the compilationinstructions to your system environment. More information about this and how the examplesfunction can be found in the help texts.


2-18

2.5 The AS-I User Interface

2.5.1 How Jobs Function

To provide you with a better understanding of the individual library functions, the followingsections are a brief introduction to the way in which the AS-I master/slave arrangementfunctions with the CP 2413 master. The following diagram illustrates a master-slavearrangement and serves as a basis for the subsequent explanations.

User program

AS-I library

AS-I driver

DPRAM

SlaveI/O data

Data images Config. data- Configuration data- Parameters

AS-I master CP

SINEC S1

PC/PG

I/O data

Parameters

Configuration

data

Slave

I/O data

Parameters

Configuration

data

Slave

Fig. 2-7 Data Organization Master-Slave


2-19

Start-up

During the start-up, the AS-I master attempts to find all the operational ASI slaves connectedto the AS-I cable (detection phase). The master reads the I/O configuration and theidentification code of all the slaves (i.e. by sending appropriate frames to the permittedaddresses 0 to 31). An AS-I slave is only recognized and entered in the list of detected slaveswhen both calls were successful. This list (LDS) can be read out with the library function'asi_get_lds() '.

Activation phase

Following this, the AS-I master attempts to include the detected slaves in the cyclic dataexchange and therefore in the list of active slaves (LAS), by writing to the parameter outputsto activate the slaves (activation phase).

Normal operation

This is followed by normal operation of the AS-I master that can be divided into the following 3phases which are cyclically repeated:

â Data exchange phase:

During the data exchange, the output data are transferred to all slaves in the list ofactive slaves. If transmission is free of errors, the addressed slaves transfer the valuesof the slave inputs. The output data for the slaves are taken from an image in theDPRAM that can be adapted at any time to the current requirements by the controlapplication using the function 'asi_write_odi() '. The values of the slave inputs arestored in an image in the DPRAM that can be read using the function 'asi_read_idi() '.

â Management phase:

During this phase, jobs for the activated slaves connected to the bus from the controlapplication are processed.

â Inclusion phase:

During the inclusion phase, newly added slaves are included in the list of detected andactive slaves. The functions carried out here are the same as those during start-up.Slaves that dropped out temporarily can also be included again.

The AS-I master is capable of 2 modes that can be set with the function'asi_set_operation_mode()':

â The configuration mode

In the ‘configuration mode’, all the AS-I slaves detected by the AS-I master on the busare included in cyclic data exchange. This mode is intended for initial installation andstart-up of the AS-I master or for re-configuration. In this mode, you can test thefunctions of the individual components and change them if necessary. The slaves aresupplied with parameter values using the function 'asi_write_parameter() '. Oncompletion of the re-configuration and tests, the values set can be ‘frozen’ i.e.configured. This is achieved by non-volatile storage on the AS-I mastercommunications processor.

â The protected mode

In the ‘protected mode’, the AS-I master searches for all AS-I slaves on the bus. Onlywhen the configuration data of the slaves match the configured data, cyclic dataexchange can be started.


2-20

The configuration data include the following:

â The list of configured slaves (LPS)

This specifies which AS-I slaves should be connected to the AS-I bus and is stored onthe AS-I master communications processor with the function 'asi_set_lps()'.

â The I/O configuration and the identification codes of the AS-I slaves

These values are saved on the AS-I master communications processor with thefunction call 'asi_set_permanent_configuration() '.

â Parameters to be transferred to the AS-I slaves when the AS-I master is started up

These parameters are set using the function 'asi_set_permanent_parameter() '.

â Various flags

Apart from the ‘mode’ flag, a further flag can be set or re-set. Using the call'asi_set_offline_mode()' you can switch over between the online and offline mode. Inthe online mode, the normal mode of the AS-I master communications processor isdivided into the 3 phases described above, the data exchange phase, the managementphase and the inclusion phase. In the offline mode, only jobs from the controllingapplication are accepted. Cyclic data exchange and inclusion of new slaves no longertakes place.

Apart from these functions required for configuration, the AS-I library provides 2 furtherfunctions:

â Configure current parameters

Using the function 'asi_store_actual_parameters() ', parameters can also beconfigured. However, the parameters to be configured are not transferred by the callerto the AS-I master, but rather the current parameters are used.

â Configure current configuration

Using the function 'asi_store_actual_configuration() ', the configured configurationdata and identification codes are overwritten with the current values of the slaves onthe AS-I cable.

Reading out the Parameter and Configuration Data

The configured parameters and Configuration data as well as the current parameters can beread out of an image in the DPRAM. This is supported by the AS-I library with the followingfunctions:

â The functions 'asi_get_lps()', 'asi_get_permanent_parameter() ','asi_get_permanent_configuration() ' and 'asi_read_parameter() ' transfer the list ofconfigured slaves, the configured parameters, the configuration data and identificationcodes or current parameters to the caller.

â The function 'asi_get_flags() ' reads all the flags.

To distinguish the AS-I slaves on the bus, each slave has an address within the range from 0to 31 with which the AS-I master can address it.


2-21

The AS-I master can assign a new address to each AS-I slave using the function'asi_change_slave_address()'. The AS-I slave with address 0 has a special role since it isthe only slave that can be assigned an address other than 0 by the AS-I master, i.e. a newslave address always take two steps. First the old address of an AS-I slave is deleted andthen the AS-I slave with address 0 has the new address assigned to it.

To complete this brief overview, Fig. 2-8 on the following page demonstrates a possibleinstallation procedure. The control application first opens up communication with the AS-Idriver using 'asi_init()' and on completion of the communication closes with 'asi_shut()'. Thecall sequence is however simply intended as an example.

+ + Recommendations for application

To take your first steps with AS-I, and to get to know how to handle the AS-Ilibrary, the calls 'asi_init()', 'asi_read_idi()', 'asi_write_odi()' and 'asi_shut()' aresufficient. A ‘normal mode’ can be executed with these calls.

For more complex implementations, the AS-I calls complying with the AS-Imaster specification (/1/) including administrative jobs such as'asi_device_info()', 'asi_dia()', 'asi_dia_reset()' etc. are available.

Additional information about the AS-I functions can be found in /1/.

+ + Demonstration program

A demonstration program is also available in the directory'<dr:>\sinec\cp2413.dw\samples'


2-22

Controller AS-I library/AS-I driver ASI master CP AS-I slave

Log on withcommunicationsystem

asi_init()

Read list ofactive slaves

asi_get_las()

Read current parameters

Modify parametersand transfer toslave

asi_write_parameter()

Switch to configurationmode

asi_set_operation_mode()

Configure parameters

asi_set_permanent_parameter()

Store currentconfiguration

asi_store_actual_configuration()

Configureslaves

asi_set_lps()

Switch to protected mode

asi_set_operation_mode()

Log off withcommunicationsystem

asi_shut()

Cyclic

data exchange

Cyclic

data exchange

Parameter transfer inmanagement phase

Transition from online tooffline and back





asi_read_parameter()

Fig. 2-8 Installation (example)

Communication between a user process and the slaves makes use of the individual libraryfunctions of the AS-I library described in the following sections.

The incorrect processing of a job is indicated by a return value other than'ASI_OK_RESPONSE'. The return values themselves and their significance are listed inSection 2.10.4.


2-23

2.5.2 Overview of the Functions

Table 2-2 below provides you with an overview of the functions available with "AS-I-2413 MS-DOS/Windows" complying with class M1 (refer to the PICS in the appendix).

No. Function or call to the host interface(symbolic representation)

M1 AS-I library call / Section

1 Image, Status = Read_IDI() X asi_read_idi() / 2.5.2.3

2 Status = Write_ODI(Image) X asi_write_odi() / 2.5.2.4

3 Status = Set_Permanent_Parameter(Addr, Param) X asi_set_permanent_parameter() /2.5.2.5

4 Param, Status = Get_Permanent_Parameter(Addr) X asi_get_permanent_parameter() /2.5.2.6

5 Status, GParam = Write_Parameter(Addr, Param) X asi_write_parameter() / 2.5.2.7

6 Status, Param = Read_Parameter(Addr) X asi_read_parameter() / 2.5.2.8

7 Status = Store_Actual_Parameters() X asi_store_actual_parameters() /2.5.2.9

8Status = Set_Permanent_Configuration(Addr, Config)

X asi_set_permanent_configuration()/ 2.5.2.10

9Status, Config =Get_Permanent_Configuration(Addr) X asi_get_permanent_configuration()

/ 2.5.2.11

10 Status = Store_Actual_Configuration() X asi_store_actual_configration() /2.5.2.12

11 Status, Config = Read_Actual_Configuration(Addr) X asi_read_actual_configuration() /2.5.2.13

12 Status = Set_LPS(List31) X asi_set_lps() / 2.5.2.14

13 Status, List31 = Get_LPS() X asi_get_lps() / 2.5.2.15

14 Status, List31 = Get_LAS() X asi_get_las() / 2.5.2.16

15 Status, List32 = Get_LDS() X asi_get_lds() / 2.5.2.17

16.0 Status = Get_Flags() X asi_get_flags() / 2.5.2.18

16.1 Status, Flag = Get_Flag_Config_OK() X asi_get_flags() / 2.5.2.18

16.2 Status, Flag = Get_Flag_LDS.0() X asi_get_flags() / 2.5.2.18


2-24

No. Function or Call to the host interface(symbolic representation)

M1 ASI library call / Section

16.3 Status, Flag = Get_Flag_Auto_Address_Assign() X asi_get_flags() / 2.5.2.18

16.4 Status, Flag = Get_Flag_Auto_Prog_Available() X asi_get_flags() / 2.5.2.18

16.5 Status, Flag = Get_Flag_Configuration_Active() X asi_get_flags() / 2.5.2.18

16.6 Status, Flag = Get_Flag_Normal_Operation_Active() X asi_get_flags() / 2.5.2.18

16.7 Status, Flag = Get_Flag_APF() X asi_get_flags() / 2.5.2.18

16.8 Status, Flag = Get_Flag_Offline_Ready() X asi_get_flags() / 2.5.2.18

17 Status = Set_Operation_Mode(Mode) X asi_set_operation_mode() / 2.5.2.19

18 Status = Set_Offline_Mode(Mode) X asi_set_offline_mode() / 2.5.2.20

20 Status = Change_Slave_Address(Addr1, Addr2) X asi_change_slave_address() /2.5.2.21

Table 2-2 Functions of the AS-I Library Complying with Class M1

Table 2-3 lists the functions implemented additionally in the AS-I library.

Function or Call to the host interface(symbolic representation)

AS-I library call / Section

Command calls

Status, Resp = Cmd_Reset_ASI_Slave(Addr, RESET) asi_execute_command() / 2.5.2.23

Status, Resp = Cmd_Read_IO_Configuration(Addr, CONF) asi_execute_command() / 2.5.2.23

Status, Resp = Cmd_Read_Identification_Code(Addr,IDCOD)

asi_execute_command() / 2.5.2.23

Status, Resp = Cmd_Read_Status(Addr, STAT) asi_execute_command() / 2.5.2.23

Status, Resp = Cmd_Read_Reset_Status(Addr, STATRES) asi_execute_command() /2.5.2.23

Status, Resp = Cmd_Write_Read_Data(Addr, DATA) asi_execute_command() / 2.5.2.23

Status, Resp = Cmd_Write_Read_Parameter(Addr, PARA) asi_execute_command() / 2.5.2.23


2-25

Function or Call to the host interface(symbolic representation)

AS-I library call / Section

Administrative and other calls

Resp = Initialize asi_init() / 2.5.2.1

Resp = Shut asi_shut() / 2.5.2.2

Resp = Reset asi_reset() / 2.5.2.22

Resp = Version_Read asi_version() / 2.5.2.24

Resp = Diagnosis_Read asi_dia() / 2.5.2.25

Resp = Diagnosis_Reset asi_dia_reset() / 2.5.2.26

Resp = Device_Info_Read asi_device_info() / 2.5.2.27

Resp = Board_Configuration_Read asi_cfg_in() / 2.5.2.28

Resp = Board_Configuration_Write asi_cfg_out() / 2.5.2.29

Resp = Read_All asi_in_all() / 2.5.2.30

Resp = Watchdog asi_wd() / 2.5.2.31

Table 2-3 Additional Functions of the AS-I Library


2-26

2.5.2.1 asi_init

Meaning

With this call, the user application logs on with the AS-I library and AS-I driver forcommunication via a selected AS-I master communications processor. The procedureproduces a handle as the return value that identifies the AS-I master communicationsprocessor and must be used with further calls.

Declaration of the function:

void *asi_init(dev_name,error)

int8 *dev_name;

ord16 *error;

Description of the parameters:

dev_name The parameter specifies the name of the CP (e.g. "CP_ASI1:"). Itmust be identical to one of the names of the individual AS-I CPsused during installation.

error This parameter contains the calls of an error if the function wasterminated. It is only relevant if an error was detected and theZERO pointer was returned.

Returned values:

!=ZERO Handle that must be used for further communication via theselected communications processor.

ZERO Error (the cause of the error is entered in the ‘error’ parameter).

Example:

void *handle;

ord16 error;

handle = asi_init((int8 *)"CP_ASI1:",(ord16 *)&error);


2-27

2.5.2.2 asi_shut

Meaning

With this call, the user logs off at the AS-I driver. All the resources of the calling processassigned to the transferred handle are returned to their initial state.

If this function is successful, the handle is no longer valid and must no longer be used.


ord16 asi_shut(handle)

void *handle;


handle Handle as return value of the 'asi_init()'.

Returned values:

ASI_OK_RESPONSE Successful

otherwise Error occurred

Example:

void *handle;

ord16 ret;

ret = asi_shut(handle);


2-28

2.5.2.3 asi_read_idi (Read Input Data Image)

Meaning

With this call, the input data of the AS-I slaves are read from the input data image in theDPRAM of the AS-I master CP and transferred to a buffer prepared by the user.


ord16 asi_read_idi(handle,stat_no,buf_len,buffer)

void *handle;

ord16 stat_no;

ord16 buf_len;

ord8 *buffer;


handle Handle as return value of the 'asi_init()’ call.

stat_no This parameter controls access to the input data image. If bit 7 isset, the input data of all slaves are read out (input data list),otherwise only the input data of the slave, whose address is codedin the lower five bits.

Parameter 'stat_no':

Bit 7

1

0

Bit 6-5

0

0

Bit 4-0

0

Slave address

Bit 15-8

0

0

buf_len This parameter specifies the length of the transferred buffer. Whenreading the input data list, the buffer must be at least 32 bytes long(max. 32 slaves can be addressed on the network). Otherwise, onebyte is sufficient as user buffer.


2-29

buffer Pointer to the buffer provided by the user. The data are stored asshown below (specifying the offset to the start of the buffer):

Single slave:

Input data list:

Offset

0

Bit 7-4

0

Bit 3-0

Input data for slave

Offset

0

Bit 7-4

0

Bit 3-0

irrelevant

31 0 Input data for slave 31

: ::

1 0 Input data for slave 1

Returned values:



Example:

void *handle;

ord16 ret;

ord8 buffer[ASI_MAX_NO_SLAVES];

ret = asi_read_idi(handle,ASI_LIST,ASI_MAX_NO_SLAVES,buffer);


2-30

2.5.2.4 asi_write_odi (Write Output Data Image)

Meaning

With this call, the output data are transferred from a buffer provided by the user to the outputdata image in the DPRAM of the AS-I master CP.


ord16 asi_write_odi(handle,stat_no,buf_len,buffer)

void *handle;

ord16 stat_no;

ord16 buf_len;

ord8 *buffer;


handle Handle as return value of the 'asi_init’ call.

stat_no This parameter controls access to the output data image. If bit 7 isset, the output data of all slaves is written (output data list),otherwise only the output data of the slave, whose address is codedin the lower five bits.


Bit 7

1

0

Bit 6-5

0

0

Bit 4-0

0

Slave address

Bit 15-8

0

0

buf_len This parameter specifies the length of the transferred buffer. Whenwriting the output data list, the buffer must be at least 32 bytes long,(max. 32 slaves can be addressed on the network). Otherwise, onebyte is sufficient as user buffer.


2-31


Single slave:

Output data list:

Offset

0

Bit 7-4

0

Bit 3-0

Output data for slave

Offset

0

Bit 7-4

0

Bit 3-0

irrelevant

31 0 Output data for Slave 31

: ::

1 0 Output data for Slave 1

Returned values:



Example:

void *handle;

ord16 ret;


ret = asi_write_odi(handle,ASI_LIST,ASI_MAX_NO_SLAVES,buffer);


2-32

2.5.2.5 asi_set_permanent_parameter

Meaning

With this call, parameter data for the AS-I slaves are configured. The data are storedpermanently on the AS-I master communications processor and written to the image of theconfiguration parameters in the DPRAM. Storing the data can take up to 640 ms.


ord16asi_set_permanent_parameter(handle,stat_no,buf_len,buffer)

void *handle;

ord16 stat_no;

ord16 buf_len;

ord8 *buffer;



stat_no This parameter controls access to the configured parameters. If bit7 is set, the parameters of all slaves are written (parameter list),otherwise only the parameters of the slave, whose address is codedin the lower five bits.


Bit 7

1

0

Bit 6-5

0

0

Bit 4-0

0

Slave address

Bit 15-8

0

0

buf_len This parameter specifies the length of the transferred buffer. Whenwriting the parameter list, the buffer must be at least 32 bytes long,(max. 32 slaves can be addressed on the network). Otherwise, onebyte is sufficient as user buffer.


2-33


Single

Parameter list:

Offset

0

Bit 7-4

0

Bit 3-0

Parameter for slave

Offset

0

Bit 7-4

0

Bit 3-0

irrelevant

31 0 Parameter for slave 31

: ::


Returned values:



Example:

void *handle;

ord16 ret;


ret = asi_set_permanent_parameter( handle,ASI_LIST,

ASI_MAX_NO_SLAVES,buffer);


2-34

2.5.2.6 asi_get_permanent_parameter

Meaning

With this call, the configured parameter data of the AS-I slaves are read from the image of theconfiguration parameters in the DPRAM of the AS-I master communications processor andtransferred to a buffer provided by the user.


ord16 asi_get_permanent_parameter(handle,stat_no,buf_len,buffer)

void *handle;

ord16 stat_no;

ord16 buf_len;

ord8 *buffer;



stat_no This parameter controls access to the configured parameters. If bit7 is set, the parameters of all slaves are read (parameter list),otherwise only the parameters of the slave, whose address is codedin the lower five bits.


Bit 7

1

0

Bit 6-5

0

0

Bit 4-0

0

Slave address

Bit 15-8

0

0

buf_len This parameter specifies the length of the transferred buffer. Whenthe parameter list is read, the buffer must be at least 32 bytes long,(max. 32 slaves can be addressed on the network). Otherwise, onebyte is sufficient as user buffer.


2-35


Single slave:

Parameter list:

Offset

0

Bit 7-4

0

Bit 3-0

Parameter for slave

Offset

0

Bit 7-4

0

Bit 3-0

irrelevant


: ::


Returned values:



Example:

void *handle;

ord16 ret;


ret = asi_get_permanent_parameter( handle,ASI_LIST,



2-36

2.5.2.7 asi_write_parameter

Meaning

With this call, parameter data for the AS-I slaves on the segment are written and the settingsof the slaves modified during operation. The slave transfers the current parameter values inthe response, which, according to the AS-I master specification (/2/), can deviate from thevalues just written. These data are kept in the parameter data image in the DPRAM of theAS-I master communications processor and copied to the user buffer provided with the call.The job takes up to two cycles (approx. 10 ms) per slave addressed.


ord16 asi_write_parameter(handle,stat_no,buf_len,buffer)

void *handle;

ord16 stat_no;

ord16 buf_len;

ord8 *buffer;



stat_no This parameter controls access to the parameters to be written. Ifbit 7 is set, the parameters of all the slaves are written (parameterlist), otherwise only the parameters of the slave, whose address iscoded in the lower five bits.


Bit 7

1

0

Bit 6-5

0

0

Bit 4-0

0

Slave address

Bit 15-8

0

0

buf_len This parameter specifies the length of the transferred buffer. Whenwriting the parameter list, the buffer must be at least 32 bytes long(max. 32 slaves can be addressed on the network). Otherwise, onebyte is sufficient as user buffer.


2-37

buffer Pointer to the buffer provided by the user. The data are stored orare stored in the responses shown below (specifying the offset tothe start of the buffer):

Single slave:

Parameter list:

Offset

0

Bit 7-4

0

Bit 3-0

Parameter for slave

Offset

0

Bit 7-4

0

Bit 3-0

irrelevant


: ::


Returned values:



Example:

void *handle;

ord16 ret;


ret = asi_write_parameter(handle,ASI_LIST,ASI_MAX_NO_SLAVES,buffer);


2-38

2.5.2.8 asi_read_parameter

Meaning

With this call, the current parameter data of the AS-I slaves are read from the parameter dataimage of the AS-I master communications processor and transferred to a buffer provided bythe user.


ord16 asi_read_parameter(handle,stat_no,buf_len,buffer)

void *handle;

ord16 stat_no;

ord16 buf_len;

ord8 *buffer;



stat_no This parameter controls access to the current data. If bit 7 is set,the parameters of all slaves are read (parameter list), otherwise onlythe parameters of the slave, whose address is coded in the lowerfive bits.


Bit 7

1

0

Bit 6-5

0

0

Bit 4-0

0

Slave address

Bit 15-8

0

0

buf_len This parameter specifies the length of the transferred buffer. Whenreading the parameter list the buffer must be at least 32 bytes long(max. 32 slaves can be addressed on the network). Otherwise, onebyte is sufficient as user buffer.


2-39


Single slave:

Parameter list:

Offset

0

Bit 7-4

0

Bit 3-0

Parameter for slave

Offset

0

Bit 7-4

0

Bit 3-0

irrelevant


: ::


Returned values:



Example:

void *handle;

ord16 ret;


ret = asi_read_parameter(handle,ASI_LIST,ASI_MAX_NO_SLAVES,buffer);


2-40

2.5.2.9 asi_store_actual_parameters

Meaning

With this call, the configured parameters are overwritten by the current parameters, i.e. theparameters are configured with the current values of the AS-I slaves. Storage (non-volatile)can take up to 640 ms.


ord16 asi_store_actual_parameters(handle);

void *handle;



Returned values:



Example:

void *handle;

ord16 ret;

ret = asi_store_actual_parameters(handle);


2-41

2.5.2.10 asi_set_permanent_configuration

Meaning

With this call, the I/O configuration data and the ID codes for the AS-I slaves are configured.The data are stored in permanent storage on the AS-I master communications processor andwritten to the image of the configuration data. The job can take up to 640 ms.


ord16 asi_set_permanent_configuration(handle,stat_no,buf_len,buffer)

void *handle;

ord16 stat_no;

ord16 buf_len;

ord8 *buffer;



stat_no This parameter controls access to the data to be configured. If bit 7is set, the data of all slaves is written (configuration list), otherwiseonly the data of the slave, whose address is coded in the lower fivebits.


Bit 7

1

0

Bit 6-5

0

0

Bit 4-0

0

Slave address

Bit 15-8

0

0

buf_len This parameter specifies the length of the transferred buffer. Whenwriting the configuration list, the buffer must be at least 32 byteslong (for the I/O configuration data and ID codes of a maximum of32 slaves that can be addressed on the network). Otherwise, onebyte is sufficient as user buffer.


2-42


Single slave:

Configuration list:

Offset

0

Bit 7-4

ID-Code für Slave

Bit 3-0

I/O config. parameters for slave

Offset

0

Bit 7-4 Bit 3-0

31

: ::

I/O config. parameters for slave 0ID code for slave 0


1 I/O config. parameters for slave 1ID code for slave 1

Returned values:



Example:

void *handle;

ord16 ret;


ret = asi_set_permanent_configuration(handle,ASI_LIST,



2-43

2.5.2.11 asi_get_permanent_configuration

Meaning

With this call, the configured I/O configuration data and the ID codes of the AS-I slaves areread from the image of the configuration data in the DPRAM and transferred to a bufferprovided by the user.


ord16 asi_get_permanent_configuration(handle,stat_no,buf_len,buffer)

void *handle;

ord16 stat_no;

ord16 buf_len;

ord8 *buffer;



stat_no This parameter controls access to the configured I/O data. If bit 7 isset, the data of all slaves are read (configuration list), otherwise onlythe data of the slave, whose address is coded in the lower five bits.


Bit 7

1

0

Bit 6-5

0

0

Bit 4-0

0

Slave address

Bit 15-8

0

0

buf_len This parameter specifies the length of the transferred buffer. Whenreading the configuration list, the buffer must be at least 32 byteslong (for the I/O configuration data and ID codes of a maximum of32 slaves that can be addressed on the network). Otherwise, onebyte is sufficient as user buffer.


2-44


Single slave:

Configuration list:

Offset

0

Bit 7-4

ID code for slave

Bit 3-0


Offset

0

Bit 7-4 Bit 3-0

31

: ::

irrelevantirrelevant



Returned values:



Example:

void *handle;

ord16 ret;


ret = asi_get_permanent_configuration(handle,ASI_LIST,



2-45

2.5.2.12 asi_store_actual_configuration

MeaningWith this call, the actual I/O configuration data and actual ID codes detected on the AS-I arestored permanently in the EEPROM. The list of active slaves (LAS) is stored permanently aslist of configured slaves (LPS). The job can take up to 640 ms.

+ + When executing this command, the CP changes to the offline phase and thenswitches to the normal mode (cold restart on the CP).

In protected mode this call will not be executed.


ord16 asi_store_actual_configuration(handle);

void *handle;



Returned values:



Example:

void *handle;

ord16 ret;

ret = asi_store_actual_configuration(handle);


2-46

2.5.2.13 asi_read_actual_configuration

With this call, the current I/O configuration data and ID codes of the AS-I slaves are read outof the image of the configuration data in the DPRAM and transferred to a buffer provided bythe user.


ord16 asi_read_actual_configuration(handle,stat_no,buf_len_buffer)

void *handle;

ord16 stat_no;

ord16 buf_len;

ord8 *buffer;



stat_no This parameter controls access to the current configuration data. Ifbit 7 is set, the data of all the slaves are read (configuration list),otherwise only the data of the slave, whose address is coded in thelower five bits.


Bit 7

1

0

Bit 6-5

0

0

Bit 4-0

0

Slave address

Bit 15-8

0

0

buf_len This parameter specifies the length of the transferred buffer. Whenreading the configuration, the buffer must be at least 32 bytes long(for the I/O configuration data and ID codes of a maximum 32slaves that can be addressed on the network). Otherwise, one byteis sufficient as user buffer.


2-47


Single slave:

Configuration list:

Offset

0

Bit 7-4

ID code for slave

Bit 3-0


Offset

0

Bit 7-4 Bit 3-0

31

: ::

irrelevantirrelevant



Returned values:



Example:

void *handle;

ord16 ret;


ret = asi_read_actual_configuration( handle,ASI_LIST,



2-48

2.5.2.14 asi_set_lps

Meaning

With this call, the list of configured slaves is transferred. The data are stored permanently onthe AS-I master communications processor and written to the image of the LPS in theDPRAM. The job can take up to 70 ms.

+ + When executing this command, the CP changes to the offline phase and thenswitches to the normal mode (cold restart on the CP).

In protected mode this call will not be executed.


ord16 asi_set_lps(handle,buf_len,buffer)

void *handle;

ord16 buf_len;

ord8 *buffer;



buf_len This parameter specifies the length of the transferred buffer. Asuser buffer, at least 4 bytes are required for bit coding of up to 32slaves.

buffer Pointer to the buffer provided by the user. The data are stored asshown below (specifying the offset to the start of the buffer). The bitreserved for slave x must be set if the slave is to be configured.

List of configured slaves (LPS):

Offset Bit 0Bit 1Bit 2Bit 3Bit 4Bit 5Bit 6Bit 7

0

1

2

3

0

Slave8

Slave16

Slave24

Slave1

Slave9

Slave17

Slave25

Slave2

Slave10

Slave18

Slave26

Slave3

Slave11

Slave19

Slave27

Slave4

Slave12

Slave20

Slave28

Slave5

Slave13

Slave21

Slave29

Slave6

Slave14

Slave22

Slave30

Slave7

Slave15

Slave23

Slave31

Returned values:



Example:

void *handle;

ord16 ret;

ord32 lps;

ret = asi_set_lps(handle,sizeof(ord32),(ord8 *)&lps);


2-49

2.5.2.15 asi_get_lps

Meaning

With this call, the list of configured slaves is read out of the image of the LPS in the DPRAM.


ord16 asi_get_lps(handle,buf_len,buffer)

void *handle;

ord16 buf_len;

ord8 *buffer;




buffer Pointer to the buffer provided by the user. The data are stored asshown below (specifying the offset to the start of the buffer). The bitreserved for slave x must be set if the slave was previouslyconfigured.

List of configured slaves (LPS):


0

1

2

3

Slave0

Slave8

Slave16

Slave24

Slave1

Slave9

Slave17

Slave25

Slave2

Slave10

Slave18

Slave26

Slave3

Slave11

Slave19

Slave27

Slave4

Slave12

Slave20

Slave28

Slave5

Slave13

Slave21

Slave29

Slave6

Slave14

Slave22

Slave30

Slave7

Slave15

Slave23

Slave31

Returned values:



Example:

void *handle;

ord16 ret;

ord32 lps;

ret = asi_get_lps(handle,sizeof(ord32),(ord8 *)&lps);


2-50

2.5.2.16 asi_get_las

Meaning

With this call, the list of active slaves is read out of the image of the LAS in the DPRAM.


ord16 asi_get_las(handle,buf_len,buffer)

void *handle;

ord16 buf_len;

ord8 *buffer;




buffer Pointer to the buffer provided by the user. The data are stored asshown below (specifying the offset to the start of the buffer). The bitreserved for slave x must be set if the slave could be activated.

List of active slaves (LAS):


0

1

2

3

Slave0

Slave8

Slave16

Slave24

Slave1

Slave9

Slave17

Slave25

Slave2

Slave10

Slave18

Slave26

Slave3

Slave11

Slave19

Slave27

Slave4

Slave12

Slave20

Slave28

Slave5

Slave13

Slave21

Slave29

Slave6

Slave14

Slave22

Slave30

Slave7

Slave15

Slave23

Slave31

Returned values:



Example:

void *handle;

ord16 ret;

ord32 las;

ret = asi_get_las(handle,sizeof(ord32),(ord8 *)&las);


2-51

2.5.2.17 asi_get_lds

Meaning

With this call, the list of detected slaves is read out of the image of the LDS in the DPRAM.


ord16 asi_get_lds(handle,buf_len,buffer)

void *handle;

ord16 buf_len;

ord8 *buffer;




buffer Pointer to the buffer provided by the user. The data are stored asshown below (specifying the offset to the start of the buffer). The bitreserved for slave x must be set if the slave could be detected.

List of detected slaves (LDS):


0

1

2

3

Slave0

Slave8

Slave16

Slave24

Slave1

Slave9

Slave17

Slave25

Slave2

Slave10

Slave18

Slave26

Slave3

Slave11

Slave19

Slave27

Slave4

Slave12

Slave20

Slave28

Slave5

Slave13

Slave21

Slave29

Slave6

Slave14

Slave22

Slave30

Slave7

Slave15

Slave23

Slave31

Returned values:



Example:

void *handle;

ord16 ret;

ord32 lds;

ret = asi_get_lds(handle,sizeof(ord32),(ord8 *)&lds);


2-52

2.5.2.18 asi_get_flags

Meaning

With this call, the flags are read out of the image in the DPRAM.


ord16 asi_get_flags(handle,buf_len,buffer)

void *handle;

ord16 buf_len;

ord8 *buffer;



buf_len This parameter specifies the length of the transferred buffer. Asuser buffer, at least 2 bytes are required for the flags.

buffer Pointer to the buffer provided by the user. The data are stored asshown below (specifying the offset to the start of the buffer). Theindividual bits (flags) are as follows:

Flag

ASI_OFFLINE_READY_FLAG

ASI_APF_FLAG

ASI_NORMAL_OPERATION_ACTIVE_FLAG

ASI_CONFIGURATION_ACTIVE_FLAG

ASI_AUTO_PROG_AVAILABLE_FLAG

ASI_AUTO_ADDRESS_ASSIGN_FLAG

ASI_LDS_0_FLAG

ASI_CONFIG_OK_FLAG

ASI_OFFLINE_FLAG

ASI_EEP_OK_FLAG

ASI_WATCHDOG_FLAG


2-53

The EEPROM_Ok flag remains set as long as no error occurs whenstoring during configuration.

The Watchdog flag is set when the watchdog has reset the AS-I mastermodule (see also 'asi_wd()' for sign of life monitoring).

The significance of the remaining flags can be found in the AS-I masterspecification (/2/).

Returned values:



Example:

void *handle;

ord16 ret,flag;

ret = asi_get_flags(handle,sizeof(ord16),(ord8 *)&flag);


2-54

2.5.2.19 asi_set_operation_mode

Meaning

This call switches to one of the two permitted modes.

When changing from the configuration mode to the protected mode, the CP goes through acold restart (change to offline phase and then switch to the online mode).

In the protected mode, only slaves entered in the LPS and whose desired and actualconfiguration match are activated, i.e. when the I/O configuration and the ID codes of theslaves in the LDS are identical to the configured values.

In the configuration mode, all detected slaves are activated even if there are differences in thedesired and actual configuration.


ord16 asi_set_operation_mode(handle,value)

void *handle;

ord16 value;



value The value of this parameter decides which mode is set:

Possible values:

MeaningValue

ASI_SET_PROTECTED_MODE

ASI_SET_CONFIGURATION_MODE

Switch to protected mode

Switch to configuration mode

Returned values:



Example:

void *handle;

ord16 ret;

ret = asi_set_operation_mode(handle,ASI_SET_CONFIGURATION_MODE);


2-55

2.5.2.20 asi_set_offline_mode

Meaning

This call switches between the online and offline modes and takes up to 2 AS-I cycles.

The online mode is the normal situation with the AS-I master. Here, the following jobs areprocessed cyclically:

â During the data exchange phase, the fields of the output data are transferred to theslave outputs for all slaves in the LAS. The addressed slaves transfer the values of theslave inputs to the master when the transfer was free of errors.

â This is followed by the inclusion phase in which there is a search for the slavesconnected to the AS-I and newly added slaves are entered in the LDS or LAS.

â In the management phase, jobs from the user such as writing parameters areexecuted.

In the offline mode, only jobs from the user are processed.


ord16 asi_set_offline_mode(handle,value)

void *handle;

ord16 value;



value The value of this parameter decides which mode is set:

Possible values:

MeaningValue

ASI_SET_OFFLINE

ASI_SET_ONLINE

Switch to the offline mode

Switch to the online mode

Returned values:



Example:

void *handle;

ord16 ret;

ret = asi_set_offline_mode(handle,ASI_SET_ONLINE);


2-56

2.5.2.21 asi_change_slave_address

Meaning

This call is mainly used to add a new AS-I slave with the default address 0 to the SINEC S1system. In this case the address is changed from the old slave address (0) to the new slaveaddress.

This change can only be made when the following conditions are fulfilled.

1. A slave with the old address exists.

2. If the old slave address is not equal to 0, then a slave with address 0 cannot beconnected at the same time.

3. The new slave address must have a valid value.

4. There is no slave with the new slave address.

The status bits in the return value indicate whether the command could be executed correctly.

Note: When changing the slave address, the slave is not reset, i.e. data are retained until newdata arrive for the new address. With this call, the slave address can be changed.


ord16 asi_change_slave_address(handle,

old_address,new_address)

void *handle;

ord16 old_address;

ord16 new_address;



old_address Here, the address of the slave whose address is to be changed isspecified.

new_address The new slave address is transferred here.

Slave address:

0 5-bit address

Bit 4-0Bit 15-5

Returned values:




2-57

Example:

void *handle;

ord16 ret,old_address,new_address;

ret = asi_change_slave_address(handle,old_address,new_address);


2-58

2.5.2.22 asi_reset

Meaning

With this call, all the slaves are reset as follows:

â the CP switches to the offline mode if this mode was not already active

â it then switches back to the online mode if this was set before the reset call.


ord16 asi_reset(handle)

void *handle;



Returned values:



Example:

void *handle;

ord16 ret;

ret = asi_reset(handle);


2-59

2.5.2.23 asi_execute_command

Meaning

With this call, direct commands can be sent to the AS-I slaves. The commands fall into thefollowing groups:

â Data call,

â Parameter call,

â Configuration call.

The configuration call is further divided into the following:

â Reset slave,

â Read I/O configuration,

â Read ID code,

â Read status and

â Read and delete status.

The job can take up to two AS-I cycles (10 ms).


ord16 asi_execute_command(handle,cmd,address,data)

void *handle;

ord16 cmd;

ord16 address;

ord8 *data;



cmd An ID for the call is transferred here.

Possible values for 'cmd':

MeaningValue

ASI_CMD_DATA

ASI_CMD_PARA

Data call

ASI_CMD_RESET

ASI_CMD_READ_CONFIG

ASI_CMD_READ_ID

ASI_CMD_READ_STATE

ASI_CMD_DEL_STATE

Parameter call

Reset slave

Read I/O configuration

Read ID code

Read status

Read and delete status


2-60

address This parameter selects the slave to be addressed by the call.

Slave address:

0 5-bit address

Bit 4-0Bit 15-5

data With a data or parameter call, the bit patterns for the outputs or theparameters of the selected slave are transferred to the library. Withall jobs, the AS-I library enters the response of the slave in this field.

Data / parameters or slave response

0 4-bit data / parameters or

Bit 3-0Bit 7-4

slave response

Returned values:



Example:

void *handle;

ord16 ret,address;

ord8 data;

ret = asi_execute_command(handle,ASI_CMD_DATA,address,&data);


2-61

2.5.2.24 asi_version

Meaning

With this call, the version ID of the AS-I master software is read out and transferred to theuser.


ord16 asi_version(handle,buf_len,buffer)

void *handle;

ord16 buf_len;

ord8 *buffer;



buf_len This parameter specifies the length of the transferred buffer, thatmust have at least the length of one of the variables in the followingstructure:

typedef struct asi_version_s

{

ord8 serial_number[ASI_SER_NO_LEN];

ord8 vendor[ASI_VENDOR_LEN];

ord8 model[ASI_MODEL_LEN];

ord8 revision[ASI_REVISION_LEN];

ord16 ser_no_len;

ord16 vendor_len;

ord16 model_len;

ord16 revision_len;

} asi_version_t;

buffer Pointer to the buffer provided by the user. The data are stored withthe structure shown above; i.e. the serial number, the vendor name,the model and the version of the AS-I master software. The namesare all completed with ‘\0’, the lengths of the names are also storedin the next words.

Returned values:



Example:

void *handle;

ord16 ret;

asi_version_t asi_version_var;

ret = asi_version(handle,sizeof(asi_version_t),(ord8 *)&asi_version_var);


2-62

2.5.2.25 asi_dia

Meaning

With this call, all the diagnostic information from the AS-I master communications processoris read out. The diagnostic information consists of the number of errors that occurred incommunication with a slave.

The value of the error counter is incremented in the following situations:

â When a slave does not reply correctly during the data exchange phase despite repeatingthe master frame (i.e. missing or incorrect slave frame).

â With slaves that have not been activated, the error counter is incremented when a slavehas already been detected (i.e. it exists in the LDS) but then no longer correctly replies.

The error counter is incremented to a maximum value of 255 and then remains at this valueuntil deleted.


ord16 asi_dia(handle,stat_no,buf_len,buffer)

void *handle;

ord16 stat_no;

ord16 buf_len;

ord8 *buffer;



stat_no This parameter controls access to the current data. If bit 7 is set,the errors of all slaves are read (error list), otherwise only thenumber of errors of the slave, whose address is coded in the lowerfive bits.


Bit 7

1

0

Bit 6-5

0

0

Bit 4-0

0

Slave address

Bit 15-8

0

0

buf_len This parameter specifies the length of the transferred buffer. Whenreading the error list, the buffer must be at least 32 bytes long (thenumber of errors per slave is counted in one byte). Otherwise, onebyte is sufficient as user buffer.


2-63


Single slave:

Error list:

Offset

0

Bit 7-0

Offset

0

31

:

Number of errors for the slave

Bit 7-0

Number of errors for slave 0

:Number of errors for slave 31

Returned values:



Example:

void *handle;

ord16 ret;


ret = asi_dia(handle,ASI_LIST,ASI_MAX_NO_SLAVES,buffer);


2-64

2.5.2.26 asi_dia_reset

Meaning

With this call, the error list is reset.


ord16 asi_dia_reset(handle);

void *handle;



Returned values:



Example:

void *handle;

ord16 ret;

ret = asi_dia_reset(handle);


2-65

2.5.2.27 asi_device_info

Meaning

With this call, the driver indicates the number of available AS-I master communicationsprocessors and the names with which they can be addressed. All the hardware-dependentparameters are also indicated.


ord16 asi_device_info(buf_len,buffer)

ord16 buf_len;

ord8 *buffer;


buf_len This parameter specifies the length of the transferred buffer, thatmust have at least the length of a variable in the structure below.

typedef struct asi_device_info_s

{ ord16 num_boards;

asi_device_t device[ASI_MAX_NO_BOARDS];

} asi_device_info_t;

with

typedef struct asi_device_s

{

ord16 dpram_seg;

ord16 name_len;

int8 name[ASI_MAX_DRV_NAME_LEN+2];

ord16 io_port;

} asi_device_t;

buffer Pointer to the buffer provided by the user. The data are stored withthe structure shown above; i.e. the number of available AS-I mastercommunications processors, the names, the segment addresses ofthe DPRAMs an the values of the base configuration registers.

Returned values:



Example:

ord16 ret;

asi_device_info_t asi_dev_info_var;

ret = asi_device_info(sizeof(asi_device_info_t),(ord8 *)&asi_dev_info_var);

Note:Since this call does not refer to one AS-I master communications processor but rather theconfiguration data maintained on the AS-I driver are read out, it is not necessary to specify ahandle. The call can be made before the first 'asi_init()' and after the last 'asi_shut()' call!


2-66

2.5.2.28 asi_cfg_in

Meaning

With this call, all the configuration data are read from the AS-I master communicationsprocessor and stored in a file. The functions 'asi_get_permanent_parameter()','asi_get_permanent_configuration()', 'asi_get_lps()' and 'asi_get_flags()' described earlier areused.


ord16 asi_cfg_in(handle,filename)

void *handle;

int8 *filename;


handle Handle as return value of the 'asi_init()' call.

filename Name of the file in which the configuration data will be stored. Thisfile can be re-used with the 'asi_cfg_out()' call.

Returned values:



Example:

void *handle;

ord16 ret;

ret = asi_cfg_in(handle,(int8 *)"c:\sinec\cp2413.dw\data\asi_cfg1.dat");


2-67

2.5.2.29 asi_cfg_out

Meaning

With this call, all the configuration data are read from a file and transferred to the AS-I mastercommunications processor. The functions 'asi_set_permanent_parameter()','asi_set_permanent_configuration()', 'asi_set_lps()' and 'asi_set_operation_mode()' describedearlier are used. The flags stored in the file only set the mode.


ord16 asi_cfg_out(handle,filename)

void *handle;

int8 *filename;



filename Name of the file from which the configuration data will be read.

Returned values:



Example:

void *handle;

ord16 ret;

ret = asi_cfg_out(handle,(int8 *)"c:\sinec\cp2413.dw\data\asi_cfg1.dat");


2-68

2.5.2.30 asi_in_all

Meaning

With this job, all the readable AS-I data and lists are read out in one call. Within the AS-Ilibrary, the following calls are used to obtain the data from the communications processor.

'asi_read_idi()', 'asi_get_permanent_parameter()', 'asi_read_parameter()','asi_get_permanent_configuration()', 'asi_read_actual_configuration()', 'asi_get_lps()','asi_get_las()', 'asi_get_lds()' and 'asi_get_flags()'.


ord16 asi_in_all(handle,buf_len,buffer)

void *handle;

ord16 buf_len;

ord8 *buffer;



buf_len This parameter specifies the length of the transferred buffer, thatmust have at least the length of one of the variables in the followingstructure:

typedef struct asi_in_all_s

{ ord8 idi[ASI_MAX_NO_SLAVES];

ord8 per_par[ASI_MAX_NO_SLAVES];

ord8 actual_par[ASI_MAX_NO_SLAVES];

ord8 per_conf[ASI_MAX_NO_SLAVES];

ord8 actual_conf[ASI_MAX_NO_SLAVES];

ord32 lps;

ord32 las;

ord32 lds;

ord16 flag;

} asi_in_all_t;

The data are stored according to the calls used in the defined structure.

buffer Pointer to the buffer provided by the user. The data are stored inaccordance with the structure shown above;

Returned values:



Example:

void *handle;

ord16 ret;

asi_in_all_t asi_in_all_var;

ret = asi_in_all(handle,sizeof(asi_in_all_t),(ord8 *)&asi_in_all_var);


2-69

2.5.2.31 asi_wd

Meaning

This job starts a watchdog on the AS-I master communications processor. The user canselect the monitoring time. As default, the watchdog is switched off.

Without the watchdog, dangerous situations can occur in the plant when

â the user program no longer runs correctly.

â the computer is reset with '<CTRL><ALT><DEL>'.

To avoid such situations arising, critical applications should make use of the watchdog andsend jobs to the CP 2413 within the selected time. All the functions of the AS-I library can beused with the exception of 'asi_init()', 'asi_shut()' and 'asi_device_info()'. If the timer elapses,the module resets all the slaves. The watchdog should then be deactivated to allow furtherjobs to be sent.

The AS-I driver makes sure that per AS-I master communications processor only one processcan ever use the watchdog of an AS-I master communications processor at any one time.Otherwise a process could trigger the watchdog while another is functioning incorrectly andlead to a dangerous plant status.


ord16 asi_wd(handle,timeout)

void *handle;

ord16 timeout;



timeout The watchdog is deactivated with the value 0. It is activated withvalues between 1 and 255. Other values are not permitted.

Possible values:

MeaningValue

0 Deactivates the watchdog

Monitoring time in seconds

Other values

1-255

Invalid

Returned values:



Example:

void *handle;

ord16 ret;

ret = asi_wd(handle,5);


2-70

2.6 Details of the System under MS-DOS and Windows

In this section, you will be informed about special features of the AS-I interface under MS-DOS and Windows. You will learn how to translate your own AS-I applications and link theminto your program.

2.6.1 General Information

The AS-I interface is made available to the user in the form of libraries. These are supplied forthe memory models 'large' and 'huge' and stored in the following directory:

â '<dr:>\sinec\cp2413.dw\lib' ('<dr:>' stands for the drive on which you installed the package).

The definitions required for the user interface are stored in the following file:

â '<dr:>\sinec\cp2413.dw\inc\asi.h'

Libraries are available both for MS-DOS and for Windows, in each case for differentcompilers.

The names of these libraries are composed as follows:

<memory model><operating system>asi<compiler>

where

<memory model>: l Large Modelh Huge Model

<operating system>: d MS-DOSw Windows

<compiler>: msc MSC-Compiler 7.0tc Turbo-C-Compiler 1.0bc Borland-C-Compiler 3.1

2.6.2 Storage of VariablesNormally, the compiler stores variables in memory in the form which the compiler itselfconsiders most sensible. This means that gaps can occur between the components of avariable (padding bytes).

+ + The structures available on the AS-I interface are designed so that userprograms translated with byte or word alignment can access the individualcomponents without problems. Double word alignment is not supported by theAS-I library.

The following sections show examples of compiling intended to illustrate therequired compiler and linker options for your applications.


2-71

2.6.3 Drive and Path Information

+ + The absolute drive and path specifications valid on your computer must beincluded in the compilation instruction or in the search path.

2.6.4 Logging User Programs On and OffTo allow communication, user programs must log on with the AS-I driver that occupiesresources for management purposes. A total of 16 log-ons are possible at the same time. Ifan application is interrupted by the key combination '<CTRL>C', the resources are reservedfor the process and the log-on remains valid. To avoid this, a '<CTRL>C' handler should beimplemented in the user program that handles all the required log-offs at the AS-I driver whenthe program is aborted.

+ + Problems with aborting programs using the key combination '<CTRL>C' shouldbe avoided with a '<CTRL>C' handler.


2-72

2.7 Translating and Linking for MS-DOS

Working with the MSC compiler 7.0

The AS-I library for the MSC compiler 7.0 has the name 'ldasimsc.lib' under MS-DOS. Thefollowing example shows how a test program ‘test.c’ can be translated and linked with thememory model ‘large’ for MS-DOS:

cl /c /AL /Os /I\sinec\cp2413.dw\inc test.c

link @test.lnk

The instructions for the linker are in the file 'test.lnk':

test.obj,

test.exe,

test.map,

\sinec\cp2413.dw\lib\ldasimsc.lib+

\msc70\lib\oldnames.lib+

\msc70\lib\llibce.lib

;

Working with MS Visual C++ Compiler 1.0

If you want to use the MS visual C++ compiler 1.0 for your MS-DOS applications you can usethe same AS-I library as for the MSC compiler 7.0. The compilation instructions for thememory model ‘large’ appear under MS-DOS as follows:


link @test.lnk


test.obj,

test.exe,

test.map,

\sinec\cp2413.dw\lib\ldasimsc.lib+

\msvc\lib\oldnames.lib+

\msvc\lib\llibce.lib

;


2-73

Working with the Turbo C Compiler 1.0

For the turbo C compiler 1.0, there are two versions of the AS-I library for MS-DOS:'ldasitc.lib' for the memory model ‘large’ and 'hdasitc.lib' for the memory model ‘huge’. Thefollowing example shows how a test program ‘test.c’ can be translated and linked with thememory model ‘large’ for MS-DOS.

tcc -c -ml -I\sinec\cp2413.dw\inc test.c

tlink @test.lnk.


\tc10\lib\c0l.obj test.obj

test.exe

test.map

\tc10\lib\emu.lib \tc10\lib\mathl.lib \tc10\lib\cl.lib \sinec\cp2413.dw\lib\ldasitc.lib


2-74

2.8 Translating and Linking for Windows

Working the MSC Compiler 7.0

The AS-I library for the MSC compiler 7.0 has the name 'lwasimsc.lib' under Windows. Thefollowing example shows how a test program ‘test.c’ can be translated and linked for Windowswith the memory model ‘large’:


link @test.lnk

The instructions for the linker are in the file 'test.lnk'.

test.obj,

test.exe,

test.map,

\sinec\cp2413.dw\lib\lwasimsc.lib+

\msc70\lib\oldnames.lib +

\msc70\lib\llibcew.lib +

\msc70\lib\libw.lib

;

Working with MS Visual C++ Compiler 1.0

If you want to use the MS visual C++ compiler 1.0 for your Windows applications, you canuse the same AS-I library as for the MSC compiler 7.0. The compilation instructions for thememory model ‘large’ then appear as following under Windows:


link @test.lnk


test.obj,

test.exe,

test.map,

\sinec\cp2413.dw\lib\lwasimsc.lib+

\msvc\lib\oldnames.lib +

\msvc\lib\llibcew.lib +

\msvc\lib\libw.lib

;


2-75

Working with the Borland C Compiler 3.1

The AS-I library for the Borland C compiler 3.1 has the name 'lwasibc.lib' under Windows. Thefollowing example shows how a test program ‘test.c’, is translated and linked for Windowswith the memory model ‘large’:

bcc -c -ml -Os -I\sinec\cp2413.dw\inc test.c

tlink /Twe @test.lnk


\bc31\lib\c0wl.obj test.obj

test.exe

test.map

\sinec\cp2413.dw\lib\lwasibc.lib \bc31\lib\mathwl.lib \bc31\lib\import.lib \bc31\lib\cwl.lib


2-76

2.9 Special Features for Windows

The AS-I library is also available for Windows applications in a DLL version (dynamic linklibrary). This makes the AS-I functions useful for

â Programs of the widest range of memory models and

â ‘Visual Basic' users

The ASI-DLL is only loaded once in the main memory regardless of how many user programsaccess it.

When using the DLL version of the AS-I library, note the following points:

â The ‘PASCAL’ call convention is valid for the AS-I functions.

â Both ‘far’ calls and ‘far’ data must be used.

In the prototypes of the AS-I functions in the header file '\sinec\cp2413.dw\inc\asi.h' thisadaptation has already been taken into account with the aid of the defines'ASI_FAR_DATA' and 'ASI_FAR_PASCAL' and can be activated using the define'ASI_DLL'.

+ + When using the ASI-DLL in ‘C’ programs, make sure that all modules that callthe AS-I functions are translated with the define ‘ASI_DLL’ and that theappropriate import libraries are linked to the application. All ASI-DLL calls are‘far’ calls the pointers are ‘far’ data pointers (important for the handle of the type‘void ASI_FAR_DATA *'). The ASI-DLL must be copied into the current workingdirectory or into the Windows system directory.

Working with Visual Basic 2.0

The AS-I calls appear slightly differently for 'Visual Basic' users:

â The type of handle is 'LONG' (instead of 'void far *');

â Transfer parameters are of the type 'Pointer' take the form of 'As Any'.

These adaptations are necessary since these basic types from the ‘C’ programming languageare not supported by ‘Visual Basic’.

The AS-I functions are declared on your computer in the file'\sinec\cp2413.dw\inc\asidec.bas'. These declarations can also be used as prototypes. Thedefinitions required for ‘Visual Basic’ applications are contained in the files'\sinec\cp2413.dw\inc\asiconst.bas' and '\sinec\cp2413.dw\inc\asitypes.bas'.

+ + The files 'asidec.bas', 'asiconst.bas' and 'asitypes.bas' should be components ofyour project under 'Visual Basic'.


2-77

Working with the MSC Compiler 7.0

The import library of the ASI-DLL for the MSC compiler 7.0 has the name 'asimsc.lib' underWindows. The following example shows how a test program ‘test.c’ is translated and linkedfor Windows with the memory model ‘small’.

cl /c /AS /Os /I\sinec\cp2413.dw\inc test.c -DASI_DLL

link /NOD @test.lnk


test.obj,

test.exe,

test.map,

\sinec\cp2413.dw\lib\asimsc.lib+

\msc70\lib\oldnames.lib +

\msc70\lib\slibcew.lib +

\msc70\lib\libw.lib

test.def;

The module definition file 'test.def' has the following structure:

NAME TEST

EXETYPE WINDOWS

CODE PRELOAD MOVEABLE DISCARDABLE

DATA PRELOAD MOVEABLE MULTIPLE

HEAPSIZE 1024

EXPORTS

;===List your explicitly exported functions here ===


2-78

Working with the MS Visual C++ Compiler 1.0

If you want to use the MS Visual C++ Compiler 1.0 for your MS-DOS applications, you canuse the same import library as for the MSC compiler 7.0. The following example shows how atest program ‘test.c’ is translated and linked for Windows with the memory model ‘small’:

cl /c /AS /Os /I\sinec\cp2413.dw\inc test.c -DASI_DLL

link /NOD @test.lnk


test.obj,

test.exe,

test.map,

\msvc\lib\oldnames.lib +

\msvc\lib\libw.lib+

\msvc\lib\slibcew.lib +

\sinec\cp2413.dw\lib\asimsc.lib

test.def;

The module definition file 'test.def' has the following structure:

NAME TEST

EXETYPE WINDOWS

CODE PRELOAD MOVEABLE DISCARDABLE

DATA PRELOAD MOVEABLE MULTIPLE

HEAPSIZE 1024

EXPORTS

;===List your explicitly exported functions here ===

Working with the Borland C Compiler 3.1

The import library of the ASI-DLL for the Borland C compiler 3.1 has the name ‘asibc.lib’under Windows. The following example shows how a test program ‘test.c’ is translated andlinked with the memory model ‘large’ for Windows:

bcc -c -ml -Os -I\sinec\cp2413.dw\inc -DASI_DLL

tlink /Twe @test.lnk


\bc31\lib\c0wl.obj test.obj

test.exe

test.map

\sinec\cp2413.dw\lib\asibc.lib \bc31\lib\mathwl.lib \bc31\lib\import.lib \bc31\lib\cwl.lib


2-79

2.10 Notes and Error Messages

You now know "AS-I-2413 MS-DOS/Windows". You have learned how to install and configurethe hardware and software and how to link the AS-I library to your applications. In all theseactivities, however, you may encounter minor problems. This section is intended to help youto deal with difficulties occurring when handling "AS-I-2413 MS-DOS/Windows".

The components of "AS-I-2413 MS-DOS/Windows" provide error messages indicating thecause of the problem. The following sections describe what to do to solve a problem.

2.10.1 The DPRAM

The CP 2413 requires a DPRAM of 2K bytes in size which must be located in the memoryarea from C8000h to EFFFFh and must meet the conditions explained in Section 2.4.3. Onsome computers, the shadow RAM or the cache is located at the area E0000h. You can usethis area for the CP 2413 if you disable the cache and shadow RAM in the system setup.

The memory area used by the CP 2413 must not be used by expanded memory managerse.g. EMM386, QUEM or 386MAX. When you start these managers, you must then specifyexplicitly that this area must not be used.

Example for EMM386:

device=emm386.sys ..... X=C800-C87F

This means that EMM386 must not use the area from C8000h to C87FFh.


2-80

2.10.2 Status and Error Messages of the AS-I Driver

During installation the AS-I driver can display the following error and status messages on thescreen.

ASI driver already loaded.

The AS-I driver is already loaded and supports up to 4 AS-I master communicationsprocessors. It is not possible to load the driver more than once. Please check whether or notyour requirements can be fulfilled by the AS-I driver that has already been installed.

ASI driver Vx.yy dd.mm.yy installed. (c) Siemens AG.

The AS-I driver with version x.yy and the data dd.mm.yy was installed successfully. Using theAS-I monitor, you can make your AS-I master communications processor(s) operational.

Given interrupt number not valid or syntax error.

The parameter transferred when the driver was called could not be interpreted as an interruptnumber, is not in the area from 80h to c0h or is not an even number. Please check the valuetransferred to make sure that is correct and permitted.

Interrupt can't be used.

The interrupt number transferred when the driver was called is already occupied. Pleasecheck whether you have a different interrupt available.

There is no free interrupt vector.

All the interrupts from 80h to c0h are occupied. Please remove other programs or drivers thatoccupy one of these interrupts.


2-81

2.10.3 Status and Error Messages of the AS-I Monitor

The AS-I monitor displays the following status and error messages on the screen.

ASI driver not found.

The AS-I monitor could not find the AS-I driver. Please start the AS-I driver taking intoaccount the error and status messages described in Section 2.10.2.

ASI driver not removed, error code = x.

The AS-I driver could not be terminated or the memory occupied by the AS-I driver could notbe released. ‘x’ specifies the error code that is identical to one of the return values of the AS-Ilibrary as described in Section 2.10.4.

ASI driver removed.

The configured AS-I master communications processors were switched to the offline modeand the AS-I driver was removed from main memory. This means that no communicationwhatsoever is possible via the AS-I modules until the AS-I driver is loaded again.

DPRAM already used.

The DPRAM you want to use is already occupied by a different AS-I master communicationsprocessor. Please select a different memory area taking into account the DPRAMs of otherAS-I master communications processors and other SINEC modules or modules of othermanufacturers.

Error converting preloader in file x.

When converting the preloader in file ‘x’ an error occurred. Please re-install the preloader fromthe installation diskette.

Error reading file x.

When reading from file ‘x’ an error occurred. Make sure that the file can be read or install itagain from the installation diskette.

File x not found.

The file with the name ‘x’ could not be found. The AS-I monitor accesses the preloader fileand the firmware file copied to your computer during installation. Please check that thespecified drive is correct or install the files again from the installation diskette.

Firmware loaded.

The firmware was loaded on the AS-I master communications processors. The module is nowoperational and user programs can now issue jobs to the communications processor via theAS-I library.

Firmware not loaded, error code = x.

The firmware could not be loaded. ‘x’ specifies the error code that is identical with the returnvalue of the AS-I library as explained in Section 2.10.4.

I/O port already used.

The I/O address area to be used is already occupied by a different AS-I mastercommunications processor. Please select a different I/O port taking into account the I/O portsboth of other AS-I master communications processors and other SINEC modules or modulesof other manufacturers.


2-82

Status and Error Messages of the AS-I Monitor (Continued)

Max. number of boards configured.

The maximum number of AS-I master communications processors has already beenconfigured. The AS-I driver supports up to 4 communications processors.

Name too long.

The name used to address the AS-I master communications processor is too long. Pleasemake sure that the name is not longer than 8 characters.

Not enough memory.

The AS-I monitor could not allocate enough memory. Please remove unnecessary drivers ormemory-resident programs from the main memory.

No ok. from board.

The firmware was not loaded correctly on the communications processor or could not log-oncorrectly at the AS-I monitor. Please check the hardware relationships such as DPRAM andconfiguration register once again. Re-installation may be necessary in some circumstances.

Preloader in file x too long.

The preloader file ‘x’ is too long. Please re-install it from the installation diskette.

Value of DPRAM unknown.

The parameters specified as the value for the start segment of the DPRAM is not permitted.Remember that only values from c800 to ef80 in steps of 80 are possible.

Value of I/O port unknown.

The parameters specified as the value for the base configuration register is not permitted.Please check which of the base configuration registers 0x0200, 0x0208, 0x0280, 0x0288,0x0290, 0x0320, 0x03E0 or 0x03E8 you can use.

Apart from these error and status messages, the AS-I monitor also displays a usage messageon the screen if you do not keep to the call syntax. In this case it is advisable to re-read thenotes on software installation in Section 2.4 of this manual.


2-83

2.10.4 Return Values of the AS-I CallsThe following sections explain the return values of the AS-I calls and their significance basedon the defines. The constants are defined in the file ‘asi.h’ that is located in the directory'<dr:>\sinec\cp2413.dw\inc' on your computer. '<dr:>' stands for the drive on which youinstalled the software.

ASI_COMMAND_NOT_ALLOWED

The AS-I master call you sent is not permitted with the firmware in the current status. Pleaseswitch to the required operating mode or offline mode necessary for your job according to /1/.

ASI_DATA_NOT_VALID

The data supplied by the addressed slave are not valid. This error can only occur with the call'asi_execute_command()'. Please check that the slave exists and is functioning correctly.

The function returns one of the following error causes as data (refer also to /1/):

ASI_I0_BIT_ERROR

The transfer of the I0 bit was not correct.

ASI_I1_BIT_ERROR


ASI_I2_BIT_ERROR


ASI_I3_BIT_ERROR


ASI_PARITY_BIT_ERROR

The transfer of the parity bit was not correct.

ASI_PARITY_ERROR

A parity error was detected in the transmission.

ASI_SLAVE_TIMEOUT

The addressed slave has not responded within three AS-I cycles.

ASI_START_BIT_ERROR

The transfer of the start bit was not correct.

ASI_STOP_BIT_ERROR

The transfer of the stop bit was not correct.

ASI_TRANSMISSION_GAP_ERROR

The master transmission gap was not correct.

ASI_DRIVER_NOT_FOUND

The AS-I driver could not be found. Please make your communications processor(s)operational using the batch file '<dr:>\sinec\cp2413.dw\bin\startasi.bat' taking into account theerror and status messages of the AS-I driver and the AS-I monitor.


2-84

Return Values of the AS-I Calls (Continued)

ASI_DRV_INIT_MAX

The maximum number of log-ons with communications systems (the AS-I driver supports upto 16 log-ons simultaneously) has already been executed successfully and is still valid. Pleasecheck whether you cannot use a handle that has already been assigned for your applicationor whether you can log-off another process with the communications system.

ASI_ERROR_DELETING_ADDRESS

An error has occurred deleting the address of one of the slaves. Please check whether theslave is functional.

ASI_ERROR_FILE_READ

The specified file could not be read out. Please check the access rights and access conflictoccurring with other processes.

ASI_ERROR_FILE_WRITE

The specified file could not be written. Please check the file attributes and access rights andany access conflicts with other processes.

ASI_ERROR_SETTING_ADDRESS

An error has occurred setting the address of the slave. Please check that the slave isfunctioning correctly.

ASI_ERROR_STORING_ADDRESS

The slave you have addressed could not save the new address. Please check that the slaveis functioning correctly.

ASI_FILE_INCONSISTENT

The specified file is not consistent. This error only occurs with the AS-I call 'asi_cfg_out()'.Make sure that the specified file was created with the 'asi_cfg_in()' call and was notmanipulated afterwards.

ASI_FILE_NOT_FOUND

The file specified in the AS-I call was not found. Please check the specified drive, the filename and the file attributes (this may possibly be a hidden file).

ASI_LIST_EMPTY

The list (LPS) of configured slaves is empty. Please select at least one slave you would like toconfigure.

ASI_MEM

The AS-I library could not allocate enough temporary memory. Please remove unnecessarydrivers, memory-resident programs or applications from the main memory.

ASI_NOCONFIG

The selected communications processor is not configured. Please make the communicationsprocessor operational using the AS-I monitor.

ASI_OK_RESPONSE

The job was successfully completed.


2-85


ASI_PARAM_ADDRESS

The address transferred in the call is not valid. Only values from 0 to 31 (inclusive) and thevalue for the listen mode (ASI_LIST) can be transferred.

ASI_PARAM_CMD

The value transferred as a command in the 'asi_execute_command()' call is not permitted.Please, use only the definitions from the header file 'asi.h'.

ASI_PARAM_DATA

The specified data are invalid. Please check the data according to the selected AS-I call. Withconfiguration data, for example, bits 4 to 7 must be assigned a value 0.

ASI_PARAM_HANDLE

The handle transferred in the AS-I call could not be identified as an AS-I handle. Pleasecompare this parameter with the return value of the log-on function 'asi_init()'.

ASI_PARAM_MODE

The value specified for the mode for the functions 'asi_set_operation_mode()' or'asi_set_offline_mode()' is not permitted. The module can only switch between the protectedmode and the configuration mode or between online and offline. Suitable definitions areavailable in the head file ‘asi.h’ for the individual modes.

ASI_PARAM_NAME

The name specified for the selected CP in the ‘asi_init()’ call is unknown. This must be amaximum of 8 characters long and must match a name entered in the ‘startasi.bat' file duringinstallation.

ASI_PARAM_TIMEOUT

The selected monitoring time for checking activity is permitted. Only a value within the rangefrom 0 up to and including 255 can be used.

ASI_SLAVE0_ALREADY_EXISTS

You have attempted to change the address of a slave although slave 0 exists. Assign a validaddress to this slave (note: address modifications are always made using the slave 0 (/1/)).

ASI_SLAVE0_EXISTS

It is not possible to switch over to the protected mode when slave 0 exists. Please assign avalid address to this slave.

ASI_SLAVE_ADDRESS1_NOT_FOUND

You have attempted to change the address of a non-existent slave. Please check the addressspecifications in the AS-I call.

ASI_SLAVE_ADDRESS1_NOT_VALID

You have attempted to configure parameters or data for slave 0 or to transfer parameters toslave 0. This is not permitted. Please check the selected slave address.


2-86


ASI_SLAVE_ADDRESS2_ALREADY_EXISTS

You have attempted to assign an existing address to a slave. Please check the addressassignment in the AS-I call.

ASI_SLAVE_ADDRESS2_NOT_VALID

The address transferred in the call is not valid. Only values from 0 up to and including 31 canbe transferred.

ASI_SLAVE_NOT_IN_LAS

The job was rejected because the selected slave was not included in the LAS at the time thejob was processed. Please check that the slave you have addressed exists and that it isfunctioning correctly.

ASI_TIMEOUT

The AS-I master communications processor does not react within one second. In this case,you should terminate communication, remove the AS-I driver from the memory, re-load it andmake the communications processor(s) operational.

ASI_TRANSMISSION_ERROR

A transmission error has occurred with an AS-I message. Please check the existence of theslave you have addressed and that it is functioning correctly.

ASI_USERMEM

The memory transferred with the AS-I call is not long enough. Please make enough buffermemory available for the job and repeat the job. Information about the buffer requirement canbe found in the sections describing the AS-I calls in Section 2.5.

ASI_WATCHDOG_TIMER_RESET

The watchdog of the selected module was activated, however no jobs were transferred to thefirmware during the selected monitoring time. The firmware has switched to the online mode.Please re-establish the original status of the firmware using the appropriate AS-I calls.

ASI_WD_IN_USE

The watchdog of the selected communications processor has already been activated by thesame process or by a different application. Please remember that the watchdog of acommunications processor must not be activated more than once.

ASI_WD_NOT_USED

The watchdog of the selected communications processor was not activated or has alreadybeen deactivated successfully. The communications processor is not (no longer) monitoredfor activity.

qq

B8976-C084 PICS

A-1

A ASI Protocol Implementation Conformance Statement (PICS)

A.1 PICS for CP 2413

Vendor Siemens AG

Product Name CP 2413 - SINEC S1 master module for AT-PCs

Order Number 6GK1241-3SA00

Version 1

Master Profile M1

Date 27.9.94

List of Master Functions Available

No. Function or Call to the Host Interface(symbolic representation)

M1 Comment / Function implemented by /Section

1 Image, Status = Read_IDI() X asi_read_idi() / 2.5.2.3

2 Status = Write_ODI(Image) X asi_write_odi() / 2.5.2.4

3 Status = Set_Permanent_Parameter(Addr, Param) X asi_set_permanent_parameter / 2.5.2.5

4 Param, Status = Get_Permanent_Parameter(Addr) X asi_get_permanent_parameter / 2.5.2.6

5 Status, GParam = Write_Parameter(Addr, Param) X asi_write_parameter() / 2.5.2.7

6 Status, Param = Read_Parameter(Addr) X asi_read_parameter() / 2.5.2.8

7 Status = Store_Actual_Parameters() X asi_store_actual_parameters() / 2.5.2.9

8 Status = Set_Permanent_Configuration(Addr, Config) X asi_set_permanent_configuration /2.5.2.10

9 Status, Config = Get_Permanent_Configuration(Addr) X asi_get_permanent_configuration /2.5.2.11

10 Status = Store_Actual_Configuration() X asi_store_actual_configuration / 2.5.2.12This command also triggers a cold restarton the CP

11 Status, Config = Read_Actual_Configuration(Addr) X asi_read_actual_configuration / 2.5.2.13

12 Status = Set_LPS(List31) X asi_set_lps() / 2.5.2.14

13 Status, List31 = Get_LPS() X asi_get_lps() / 2.5.2.15

14 Status, List31 = Get_LAS() X asi_get_las() / 2.5.2.16

15 Status, List32 = Get_LDS() X asi_get_lds() / 2.5.2.17

16.0 Status = Get_Flags() X asi_get_flags() / 2.5.2.18

B8976-C084 PICS

A-2

16.1 Status, Flag = Get_Flag_Config_OK() X asi_get_flags() / 2.5.2.18

16.2 Status, Flag = Get_Flag_LDS.0() X asi_get_flags() / 2.5.2.18

16.3 Status, Flag = Get_Flag_Auto_Address_Assign() X asi_get_flags() / 2.5.2.18

16.4 Status, Flag = Get_Flag_Auto_Prog_Available() X asi_get_flags() / 2.5.2.18

16.5 Status, Flag = Get_Flag_Configuration_Active() X asi_get_flags() / 2.5.2.18

16.6 Status, Flag = Get_Flag_Normal_Operation_Active() X asi_get_flags() / 2.5.2.18

16.7 Status, Flag = Get_Flag_APF() X asi_get_flags() / 2.5.2.18

16.8 Status, Flag = Get_Flag_Offline_Ready() X asi_get_flags() / 2.5.2.18

17 Status = Set_Operation_Mode(Mode) X asi_set_operation_mode() / 2.5.2.19

18 Status = Set_Offline_Mode(Mode) X asi_set_offline_mode() / 2.5.2.20

19 Status = Activate_Data_Exchange(Mode) - not implemented

20 Status = Change_Slave_Address(Addr1, Addr2) X asi_change_slave_address() / 2.5.2.21

21.1 Status, Resp = Cmd_Reset_ASI_Slave(Addr, RESET) X asi_execute_command() / 2.5.2.23

21.2 Status, Resp = Cmd_Read_IO_Configuration(Addr,CONF)

X asi_execute_command() / 2.5.2.23

21.3 Status, Resp = Cmd_Read_Identification_Code(Addr,IDCOD)


21.4 Status, Resp = Cmd_Read_Status(Addr, STAT) X asi_execute_command() / 2.5.2.23

21.5 Status, Resp = Cmd_Read_Reset_Status(Addr,STATRES)


Key to column 3

Character Meaning

X Function exists

- Function does not exist

ASI Cycle Time Related to the Number of Connected Slaves

The maximum cycle time is <= 5 ms for 31 Slaves. This maximum time is not reduced if lessslaves are connected.

B8976-C084 Abbreviations / Terms

B-1

B Abbreviations / TermsAS-I Actuator-Sensor-InterfaceAS-I library Library with which user programs can communicate with the AS-I

driver.AS-I driver Driver that makes the functions of the CP 2413 available to user

programsAPF ASI power fail. Flag or LED that indicates that the voltage on the

AS-I-line is too low. (e.g. failure of the AS-I power supply)CP Communications processor: module for installation in computers

and programmable logic controllers.CP 2433 Communications processor for SIMATIC S5 and ET 200 on SINEC

S1.CP 1413 Communications processor for PCs and PGs on SINEC H1CP 2413 Communications processor for PCs and PGs on SINEC S1CP 5412 Communications processor for PCs and PGs on SINEC L2FW Firmware, here software running on the CP 2413LAS List of activated slavesLDS List of detected slavesLPS List of configured (permanent) slavesPG Programmer (programming unit)PLC Programmable logic controller; e.g. SIMATIC S5 PLCSINEC 'Siemens Network Architecture for Automation and Engineering',

Range of Siemens products for industrial communication.q

B8976-C084 Abbreviations / Terms

B-2

B8976-C084 Further Reading

C-1

C Further Reading

/1/ ASI Das Aktuator-Sensor-Interface für die Automation

Werner Kriesel, O.W. Madelung, Carl Hanser Verlag München Wien 1994

(only available in German)

/2/ ASI Complete Specification

can be ordered from the ASI association e.V.

Address : ASI-Verein e.V.Auf den Broich 4A51519 OdenthalGermany

Tel.: 02174 / 40756Fax.:02174 / 41571

(The AS-I technology is promoted by the ASI association e.V.)

/3/ SINEC Industrial Communications Networks

Catalog IK 10 1994

B8976-C084 Further Reading

C-2

B8976-C084 Notes on CE Marking

D-1

D Notes on the CE Marking of SINEC Products

Product Name CP 2413 6GK1 241-3SA00

EC EMC Directive89/336/EEC

The SINEC products listed above meet the requirements of the EC Directice89/336/EEC “Electromagnetic Compatibility“

The EC conformity certificates are kept for the authorities responsibleaccording to the EC directives listed above at the following address:

Siemens AktiengesellschaftBereich AutomatisierungstechnikIndustrielle Kommunikation (AUT 93)Postfach 4848D-90327 NürnbergFederal Republic of Germany

Area of ApplicationEMC

The product meets the following requirements:

Area of application RequirementsEmission Immunity

Industry EN 50081-2 : 1993 EN 50082-2 : 1995

The product can also be used in the residential environment (residential,commercial and light industry).

Area of application RequirementsEmission Immunity

Residential Individual approval EN 50082-1 : 1992

You must acquire the individual approval from the respective nationalauthority or testing body.

InstallationGuidelines

This product meets the requirements providing you adhere to the installationguidelines1. Manual of the CP2413 Master Module;2. System Manual of your PC or PG

Working with theProduct

To protect the product from electrostatic discharge, personnel must firstneutralize any charges on their person before touching the modules.

Note The module was tested in a device that complies with the standards listedabove. If the module is operated in a device that does not comply with thesestandards, there is no guarantee that the module will comply with the valuesstipulated in the pertinent standards.

B8976-C084 Notes on CE Marking

D-2

KorrekturenCorrections

Für Druckschrift bzw. HandbuchFor instruction or manual

Titel/title

SIEMENS AGAUT 933Siemensallee 84

76187 KarlsruheFederal Republic of Germany

Firma/Dienststelle - Company/Department

Anschrift/Address

Vorschläge und/oder KorrekturenSuggestions/Corrections

Bestell-Nr./Order No.

Telefon/Telephone

Sollten Sie beim Lesen dieser Un-terlage auf Druckfehler gestoßensein, so bitten wir Sie, uns diese mit-zuteilen. Ebenso sind wir für Anre-gungen, Hinweise und Verbesse-rungsvorschläge dankbar.

Bitte die Bestell-Nr. der betreffen-den Druckschrift oder des Hand-buches oben eintragen!

Should you come across any printingerrors when reading this publication,we would ask you to inform us usingthis form. We would also welcomeany suggestions you may have forimprovement.

Please fill in the order no. of the af-fected document!

VorschlägeSuggetions

Absender/From - Name/Name

SINEC S1 Master module 2413

6GK 1971-2SA01-0AA1

CorrectionsCorrecciones

Pour l’imprimé ou le manuelPara folleto o manual

Titre/titulo

N° de ref./N° de ped.

Société/Service - Empresa/Seccion

Adresse/Direction Téléphone/Téléphono

Propositions ou correctionsPropuestas y/o correcciones

Si, lors de la lecture de ce docu-ment, vous trouvez des fautes d’im-primerie, nous vous prions de nousen faiire part dans ce formulaire.Nous recevrons aussi avec recon-naissance vos suggestions, remarqu-es et propositions d’amélioration.

Indiquez s.v.p. le n° de référencede l’imprimé ou de manuel concer-ne !

Si encuentra Usted erratas de im-prenta, por favor, infórmenos utili-zando este formulario. Le rogamosque nos communique también lasreclamaciones, indicaciones, y propu-estas de mejoramiento.

Indique por favor el N° de pedidodel folleto o del manual respecti-vo!

SIEMENS AGAUT 933Siemensallee 84

76187 KarlsruheFederal Republic of Germany

Expediteur/Expeditor - Nom/Nombre y apelido

SINEC S1 Master module 2413

6GK 1971-2SA01-0AA1

sinec...cp 2413 and as-i 2413 ms-dos/windows b8976-c084 1-2 1.1 general 1.1.1 overview of the...

Documents