Пакет ISaGRAF C Tools. Руководство пользователя. (англ.)

Пакет ISaGRAF C Tools. Руководство пользователя. (англ.)

IEC 61131-3 C Tools

User and Reference Manual

4/4/2011

Safety Information

The information provided in this documentation contains general descriptions and/or technical characteristics of the performance of the products contained herein. This documentation is not intended as a substitute for and is not to be used for determining suitability or reliability of these products for specific user applications. It is the duty of any such user or integrator to perform the appropriate and complete risk analysis, evaluation and testing of the products with respect to the relevant specific application or use thereof. Neither Schneider

Electric nor any of its affiliates or subsidiaries shall be responsible or liable for misuse of the information contained herein. If you have any suggestions for improvements or amendments or have found errors in this publication, please notify us.

No part of this document may be reproduced in any form or by any means, electronic or mechanical, including photocopying, without express written permission of Schneider Electric.

All pertinent state, regional, and local safety regulations must be observed when installing and using this product. For reasons of safety and to help ensure compliance with documented system data, only the manufacturer should perform repairs to components.

When devices are used for applications with technical safety requirements, the relevant instructions must be followed. Failure to use Schneider Electric software or approved software with our hardware products may result in injury, harm, or improper operating results.

Failure to observe this information can result in injury or equipment damage.

© 2010 Schneider Electric. All rights reserved.

Document (Version 2.51) 4/4/2011 2

Table of Contents

Safety Information

Safety Information ....................................................................... 12

About The Book ........................................................................... 15

At a Glance .......................................................................................................... 15

IEC 61131-3 C Tools Overview .................................................... 16

Supported Language Features ............................................................................ 17

Getting Started ............................................................................. 20

System Requirements .......................................................................................... 20

Program Development Tutorial ............................................................................ 21

C Program Development ............................................................. 25

Program Architecture ........................................................................................... 25

Compiling Source Code ....................................................................................... 29

Linking Object Files .............................................................................................. 30

Controller Initialization .......................................................................................... 33

Loading Programs into RAM ................................................................................ 33

Executing Programs ............................................................................................. 34

Real Time Operating System ...................................................... 35

Task Management ............................................................................................... 35

Resource Management ........................................................................................ 37

Inter-task Communication .................................................................................... 38

Event Notification ................................................................................................. 39

Error Reporting ..................................................................................................... 40

SCADAPack Task Architecture ............................................................................ 41

RTOS Example Application Program................................................................... 42

Overview of Programming Functions ........................................ 50

Controller Operation ............................................................................................. 50

Controller I/O Hardware ....................................................................................... 56

Serial Communication .......................................................................................... 67

Communication Protocols .................................................................................... 74

Modbus Database ................................................................................................ 78

Modbus Addressing ............................................................................................. 80

DNP Communication Protocol ............................................................................. 82

IEC 61131-3 Variable Access Functions ............................................................. 85

Document (Version 2.51) 4/4/2011 3

Safety Information

HART Communication ......................................................................................... 85

IEC 61131-3 C Tools Function Specifications ........................... 87

alarmIn ................................................................................................................. 88

allocate_envelope ................................................................................................ 90

check_error .......................................................................................................... 91

checksum ............................................................................................................. 92

checkSFTranslationTable .................................................................................... 93

clear_errors .......................................................................................................... 94

clear_protocol_status ........................................................................................... 95

clearSFTranslationTable ...................................................................................... 96

clearStatusBit ....................................................................................................... 97

clear_tx ................................................................................................................. 98

configurationRegisterMapping ............................................................................. 99

configurationSetApplicationID ............................................................................ 100

crc_reverse ........................................................................................................ 104

createRoutingTable ............................................................................................ 105

create_task ......................................................................................................... 106

databaseRead .................................................................................................... 109

databaseWrite .................................................................................................... 111

datalogCreate ..................................................................................................... 113

datalogDelete ..................................................................................................... 116

datalogPurge ...................................................................................................... 118

datalogReadNext ............................................................................................... 120

datalogReadStart ............................................................................................... 122

datalogRecordSize ............................................................................................. 124

datalogSettings .................................................................................................. 125

datalogWrite ....................................................................................................... 126

dbase ................................................................................................................. 127

deallocate_envelope .......................................................................................... 129

dnpInstallConnectionHandler ............................................................................. 130

dnpClearEventLog ............................................................................................. 135

dnpConnectionEvent .......................................................................................... 136

dnpCreateRoutingTable ..................................................................................... 137

dnpGenerateEventLog ....................................................................................... 138

dnpGetAI16Config.............................................................................................. 139

dnpGetAI32Config.............................................................................................. 140

dnpGetAISFConfig ............................................................................................. 141

dnpGetAO16Config ............................................................................................ 142

dnpGetAO32Config ............................................................................................ 143

dnpGetAOSFConfig ........................................................................................... 144

dnpGetBIConfig .................................................................................................. 145

dnpGetBIConfigEx ............................................................................................. 146

dnpGetBOConfig ................................................................................................ 147

dnpGetCI16Config ............................................................................................. 148

dnpGetCI32Config ............................................................................................. 149

dnpGetConfiguration .......................................................................................... 150

dnpGetConfigurationEx ...................................................................................... 154

dnpGetRuntimeStatus ........................................................................................ 155

Document (Version 2.51) 4/4/2011 4

Safety Information

dnpGetUnsolicitedBackoffTime .......................................................................... 156

dnpReadRoutingTableDialStrings ...................................................................... 157

dnpReadRoutingTableEntry ............................................................................... 158

dnpReadRoutingTableSize ................................................................................ 159

dnpSaveAI16Config ........................................................................................... 160

dnpSaveAI32Config ........................................................................................... 161

dnpSaveAISFConfig........................................................................................... 162

dnpSaveAO16Config ......................................................................................... 163

dnpSaveAO32Config ......................................................................................... 164

dnpSaveAOSFConfig ......................................................................................... 165

dnpSaveBIConfig ............................................................................................... 166

dnpSaveBIConfigEx ........................................................................................... 167

dnpSaveBOConfig ............................................................................................. 168

dnpSaveCI16Config ........................................................................................... 169

dnpSaveCI32Config ........................................................................................... 170

dnpSaveConfiguration ....................................................................................... 171

dnpSaveConfigurationEx ................................................................................... 173

dnpSaveUnsolicitedBackoffTime ....................................................................... 174

dnpSendUnsolicited ........................................................................................... 175

dnpSendUnsolicitedResponse ........................................................................... 181

dnpWriteRoutingTableEntry ............................................................................... 182

dnpWriteRoutingTableDialStrings ...................................................................... 183

end_application .................................................................................................. 184

end_task ............................................................................................................. 185

endTimedEvent .................................................................................................. 186

enronInstallCommandHandler ........................................................................... 187

forceLed ............................................................................................................. 191

getABConfiguration ............................................................................................ 192

getBootType ....................................................................................................... 193

getclock .............................................................................................................. 194

getClockAlarm .................................................................................................... 195

getClockTime ..................................................................................................... 196

getControllerID ................................................................................................... 197

getIOErrorIndication ........................................................................................... 198

getPortCharacteristics ........................................................................................ 199

getPowerMode ................................................................................................... 200

get_port .............................................................................................................. 201

getProgramStatus .............................................................................................. 202

get_protocol ....................................................................................................... 204

getProtocolSettings ............................................................................................ 205

getProtocolSettingsEx ........................................................................................ 207

get_protocol_status ............................................................................................ 209

getSFTranslation ................................................................................................ 210

get_status ........................................................................................................... 211

getStatusBit ........................................................................................................ 212

getTaskInfo ........................................................................................................ 213

getVersion .......................................................................................................... 215

getWakeSource .................................................................................................. 216

hartIO ................................................................................................................. 217

hartCommand .................................................................................................... 218

Document (Version 2.51) 4/4/2011 5

Safety Information

hartCommand0 .................................................................................................. 220

hartCommand1 .................................................................................................. 221

hartCommand2 .................................................................................................. 222

hartCommand3 .................................................................................................. 223

hartCommand11 ................................................................................................ 225

hartCommand33 ................................................................................................ 226

hartStatus ........................................................................................................... 228

hartGetConfiguration .......................................................................................... 230

hartSetConfiguration .......................................................................................... 231

hartPackString .................................................................................................... 232

hartUnpackString ............................................................................................... 233

install_handler .................................................................................................... 234

installClockHandler ............................................................................................ 236

installDbaseHandler ........................................................................................... 238

installSetdbaseHandler ...................................................................................... 240

Dbase Handler Function .................................................................................... 242

Setdbase Handler Function ............................................................................... 246

installExitHandler ............................................................................................... 247

installModbusHandler......................................................................................... 248

Handler Function ................................................................................................ 249

installRTCHandler .............................................................................................. 254

RTCHandler Function ........................................................................................ 255

interruptCounter ................................................................................................. 256

interruptInput ...................................................................................................... 257

interrupt_signal_event ........................................................................................ 258

interval ................................................................................................................ 259

ioBusReadByte .................................................................................................. 260

ioBusReadLastByte............................................................................................ 261

ioBusReadMessage ........................................................................................... 262

ioBusSelectForRead .......................................................................................... 264

ioBusSelectForWrite .......................................................................................... 265

ioBusStart ........................................................................................................... 266

ioBusStop ........................................................................................................... 267

ioBusWriteByte ................................................................................................... 268

ioBusWriteMessage ........................................................................................... 269

ioClear ................................................................................................................ 271

ioDatabaseReset ................................................................................................ 272

ioRefresh ............................................................................................................ 274

ioReset ............................................................................................................... 275

isaRead16Din ..................................................................................................... 276

isaRead32Din ..................................................................................................... 277

isaRead4Ain ....................................................................................................... 278

isaRead4Counter ............................................................................................... 279

isaRead4202Inputs ............................................................................................ 280

isaRead4202DSInputs ....................................................................................... 282

isaRead5505Inputs ............................................................................................ 284

isaRead5506Inputs ............................................................................................ 287

isaRead5601Inputs ............................................................................................ 289

isaRead5602Inputs ............................................................................................ 291

isaRead5604Inputs ............................................................................................ 293

Document (Version 2.51) 4/4/2011 6

Safety Information

isaRead5606Inputs ............................................................................................ 295

isaRead8Ain ....................................................................................................... 297

isaRead8Din ....................................................................................................... 298

isaReadLPInputs ................................................................................................ 299

isaReadSP100Inputs ......................................................................................... 301

isaWrite16Dout ................................................................................................... 303

isaWrite2Aout ..................................................................................................... 304

isaWrite32Dout ................................................................................................... 305

isaWrite4Aout ..................................................................................................... 306

isaWrite4AoutChecksum .................................................................................... 307

isaWrite4202Outputs.......................................................................................... 309

isaWrite4202OutputsEx ..................................................................................... 310

isaWrite4202DSOutputs .................................................................................... 312

isaWrite5303Aout ............................................................................................... 313

isaWrite5505Outputs.......................................................................................... 314

isaWrite5506Outputs.......................................................................................... 316

isaWrite5601Outputs.......................................................................................... 318

isaWrite5602Outputs.......................................................................................... 319

isaWrite5604Outputs.......................................................................................... 320

isaWrite5606Outputs.......................................................................................... 322

isaWrite8Dout ..................................................................................................... 325

isaWriteAout ....................................................................................................... 326

isaWriteLPOutputs ............................................................................................. 328

isaWriteSP100Outputs ....................................................................................... 330

ledGetDefault ..................................................................................................... 331

ledPower ............................................................................................................ 332

ledPowerSwitch .................................................................................................. 333

ledSetDefault ...................................................................................................... 334

load .................................................................................................................... 335

master_message ................................................................................................ 336

modbusExceptionStatus .................................................................................... 342

modbusSlaveID .................................................................................................. 343

modbusProcessCommand Function .................................................................. 344

modemAbort ....................................................................................................... 346

modemAbortAll ................................................................................................... 347

modemDial ......................................................................................................... 349

modemDialEnd ................................................................................................... 351

modemDialStatus ............................................................................................... 352

modemInit .......................................................................................................... 353

modemInitEnd .................................................................................................... 355

modemInitStatus ................................................................................................ 356

modemNotification ............................................................................................. 357

optionSwitch ....................................................................................................... 358

pidExecute ......................................................................................................... 359

pidInitialize ......................................................................................................... 361

pollABSlave ........................................................................................................ 362

poll_event ........................................................................................................... 363

poll_message ..................................................................................................... 364

poll_resource ...................................................................................................... 365

portConfiguration ................................................................................................ 366

Document (Version 2.51) 4/4/2011 7

Safety Information

portIndex ............................................................................................................ 367

portStream ......................................................................................................... 368

processModbusCommand ................................................................................. 369

queue_mode ...................................................................................................... 371

readBoolVariable ................................................................................................ 372

readCounter ....................................................................................................... 374

readCounterInput ............................................................................................... 375

readBattery ......................................................................................................... 376

readInternalAD ................................................................................................... 377

readIntVariable ................................................................................................... 378

readMsgVariable ................................................................................................ 380

readRealVariable ............................................................................................... 382

readRoutingTableEntry ...................................................................................... 384

readRoutingTableSize ....................................................................................... 385

readStopwatch ................................................................................................... 386

readThermistor ................................................................................................... 387

readTimerVariable.............................................................................................. 388

read_timer_info .................................................................................................. 390

receive_message ............................................................................................... 391

release_processor.............................................................................................. 392

release_resource ............................................................................................... 393

report_error ........................................................................................................ 394

request_resource ............................................................................................... 395

resetAllABSlaves ................................................................................................ 396

resetClockAlarm ................................................................................................. 397

route ................................................................................................................... 398

runLed ................................................................................................................ 399

save .................................................................................................................... 400

searchRoutingTable ........................................................................................... 401

send_message ................................................................................................... 402

setABConfiguration ............................................................................................ 404

setBootType ....................................................................................................... 405

setclock .............................................................................................................. 406

setClockAlarm .................................................................................................... 407

setdbase ............................................................................................................. 409

setDTR ............................................................................................................... 411

setIOErrorIndication ........................................................................................... 412

setPowerMode ................................................................................................... 413

set_port .............................................................................................................. 414

setProgramStatus .............................................................................................. 416

set_protocol ........................................................................................................ 417

setProtocolSettings ............................................................................................ 418

setProtocolSettingsEx ........................................................................................ 420

setSFTranslation ................................................................................................ 422

setStatus ............................................................................................................ 426

setStatusBit ........................................................................................................ 427

settimer .............................................................................................................. 428

setWakeSource .................................................................................................. 429

signal_event ....................................................................................................... 430

sleep ................................................................................................................... 432

Document (Version 2.51) 4/4/2011 8

Safety Information

start_protocol ..................................................................................................... 434

startup_task ........................................................................................................ 435

startTimedEvent ................................................................................................. 436

timer ................................................................................................................... 438

timeoutCancel .................................................................................................... 439

timeoutRequest .................................................................................................. 440

wait_event .......................................................................................................... 443

wd_auto .............................................................................................................. 444

wd_manual ......................................................................................................... 445

wd_pulse ............................................................................................................ 446

writeBoolVariable ............................................................................................... 447

writeIntVariable .................................................................................................. 448

writeRealVariable ............................................................................................... 450

writeMsgVariable ................................................................................................ 451

writeTimerVariable ............................................................................................. 453

writeRoutingTableEntry ...................................................................................... 455

IEC 61131-3 C Tools Macro Definitions .................................... 456

A ......................................................................................................................... 456

B ......................................................................................................................... 457

C ......................................................................................................................... 457

D ......................................................................................................................... 459

E ......................................................................................................................... 460

F ......................................................................................................................... 461

G......................................................................................................................... 461

H ......................................................................................................................... 461

I .......................................................................................................................... 461

L ......................................................................................................................... 462

M ........................................................................................................................ 462

N ......................................................................................................................... 463

O......................................................................................................................... 464

P ......................................................................................................................... 464

R ......................................................................................................................... 465

S ......................................................................................................................... 465

T ......................................................................................................................... 467

V ......................................................................................................................... 468

W ........................................................................................................................ 468

IEC 61131-3 C Tools Structures and Types ............................. 469

ABConfiguration ................................................................................................. 469

ADDRESS_MODE ............................................................................................. 469

ALARM_SETTING ............................................................................................. 469

clock ................................................................................................................... 470

DATALOG_CONFIGURATION .......................................................................... 470

DATALOG_STATUS .......................................................................................... 470

DATALOG_VARIABLE ...................................................................................... 471

DialError ............................................................................................................. 471

DialState ............................................................................................................. 472

Document (Version 2.51) 4/4/2011 9

Safety Information

dnpAnalogInput .................................................................................................. 472

dnpAnalogOutput ............................................................................................... 473 dnpBinaryInput ................................................................................................... 473 dnpBinaryInputEx_type ...................................................................................... 473 dnpBinaryOutput ................................................................................................ 473

DNP_CONNECTION_EVENT Type .................................................................. 474

dnpConfiguration ................................................................................................ 475

dnpConfigurationEx............................................................................................ 479

dnpCounterInput ................................................................................................ 484 dnpPointType ..................................................................................................... 484

DNP_RUNTIME_STATUS ................................................................................. 484

envelope ............................................................................................................. 485

HART_COMMAND ............................................................................................ 486

HART_DEVICE .................................................................................................. 486

HART_RESPONSE ........................................................................................... 487

HART_RESULT ................................................................................................. 487

HART_SETTINGS ............................................................................................. 487

HART_VARIABLE .............................................................................................. 488 ledControl_tag .................................................................................................... 488

ModemInit .......................................................................................................... 489

ModemSetup ...................................................................................................... 489

PROTOCOL_SETTINGS ................................................................................... 490

PROTOCOL_SETTINGS_EX Type ................................................................... 490

prot_settings ....................................................................................................... 491 prot_status ......................................................................................................... 491

pconfig ................................................................................................................ 492

PORT_CHARACTERISTICS ............................................................................. 493

pstatus ................................................................................................................ 494

READSTATUS ................................................................................................... 494

routingTable ....................................................................................................... 495

SFTranslation ..................................................................................................... 495

SFTranslationStatus........................................................................................... 495

TASKINFO ......................................................................................................... 496 taskInfo_tag ........................................................................................................ 496

timer_info ........................................................................................................... 497

VERSION ........................................................................................................... 497

WRITESTATUS ................................................................................................. 498

C Compiler Known Problems ................................................... 499

Use of Initialized Static Local Variables ............................................................. 499

Document (Version 2.51) 4/4/2011 10

Index of Figures

Safety Information

Figure 1: Queue Status before Execution of main Task ............................... 46

Figure 2: Queue Status at Start of main Task ................................................ 46

Figure 3: Queue Status after Creation of echoData Task ............................. 47

Figure 4: Queue Status After echoData Task Waits for Event ...................... 47

Figure 5 Queue Status after Creation of auxiliary Task ................................ 48

Figure 6: Queue Status After main Task Releases Processor ..................... 48

Figure 7: Queue Status at Start of auxiliary Task .......................................... 48

Figure 8: Queue Status after Character Received ......................................... 49

Figure 9: Queue Status after echoData Waits for Event ............................... 49

Document (Version 2.51) 4/4/2011 11

Safety Information

Safety Information

Read these instructions carefully, and look at the equipment to become familiar with the device before trying to install, operate, or maintain it. The following special messages may appear throughout this documentation or on the equipment to warn of potential hazards or to call attention to information that clarifies or simplifies a procedure.

The addition of this symbol to a Danger or Warning safety label indicates that an electrical hazard exists, which will result in personal injury if the instructions are not followed.

This is the safety alert symbol. It is used to alert you to potential personal injury hazards. Obey all safety messages that follow this symbol to avoid possible injury or death.

DANGER

DANGER indicates an imminently hazardous situation which, if not avoided,

will result in death or serious injury.

WARNING

WARNING indicates a potentially hazardous situation which, if not avoided,

can result in death or serious injury.

CAUTION

CAUTION indicates a potentially hazardous situation which, if not avoided, can

result in minor or moderate.

CAUTION

CAUTION used without the safety alert symbol, indicates a potentially hazardous situation which, if not avoided, can result in equipment damage..

Document (Version 2.51) 4/4/2011 12

Safety Information

PLEASE NOTE

Electrical equipment should be installed, operated, serviced, and maintained only by qualified personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of the use of this material.

A qualified person is one who has skills and knowledge related to the construction and operation of electrical equipment and the installation, and has received safety training to recognize and avoid the hazards involved.

BEFORE YOU BEGIN

Do not use this product on machinery lacking effective point-of-operation guarding. Lack of effective point-of-operation guarding on a machine can result in serious injury to the operator of that machine.

CAUTION

UNINTENDED EQUIPMENT OPERATION

• Verify that all installation and set up procedures have been completed.

• Before operational tests are performed, remove all blocks or other temporary holding means used for shipment from all component devices.

• Remove tools, meters, and debris from equipment

Failure to follow these instructions can result in death, serious injury or equipment damage.

Follow all start-up tests recommended in the equipment documentation. Store all equipment documentation for future references.

Software testing must be done in both simulated and real environments.

Verify that the completed system is free from all short circuits and grounds, except those grounds installed according to local regulations (according to the

National Electrical Code in the U.S.A, for instance). If high-potential voltage testing is necessary, follow recommendations in equipment documentation to prevent accidental equipment damage.

Before energizing equipment:

• Remove tools, meters, and debris from equipment.

• Close the equipment enclosure door.

• Remove ground from incoming power lines.

• Perform all start-up tests recommended by the manufacturer.

OPERATION AND ADJUSTMENTS

The following precautions are from the NEMA Standards Publication ICS 7.1-

1995 (English version prevails):

Document (Version 2.51) 4/4/2011 13

Safety Information

• Regardless of the care exercised in the design and manufacture of equipment or in the selection and ratings of components, there are hazards that can be encountered if such equipment is improperly operated.

• It is sometimes possible to misadjust the equipment and thus produce unsatisfactory or unsafe operation. Always use the manufacturer’s instructions as a guide for functional adjustments. Personnel who have access to these adjustments should be familiar with the equipment manufacturer’s instructions and the machinery used with the electrical equipment.

• Only those operational adjustments actually required by the operator should be accessible to the operator. Access to other controls should be restricted to prevent unauthorized changes in operating characteristics.

Document (Version 2.51) 4/4/2011 14

About The Book

About The Book

At a Glance

Document Scope

This manual describes the use of the IEC 61131-3 C Tools.

Validity Notes

This document is valid for all versions of IEC 61131-3 C Tools.

Product Related Information

WARNING

UNINTENDED EQUIPMENT OPERATION

The application of this product requires expertise in the design and programming of control systems. Only persons with such expertise should be allowed to program, install, alter and apply this product.

Follow all local and national safety codes and standards.

Failure to follow these instructions can result in death, serious injury or equipment damage.

User Comments

We welcome your comments about this document. You can reach us by e-mail at [email protected]

Document (Version 2.51) 4/4/2011 15

IEC 61131-3 C Tools Overview

IEC 61131-3 C Tools Overview

The IEC 61131-3 C Tools are ideal for engineers and programmers who require advanced programming tools for SCADA applications and process control. The

SCADAPack and Micro16 families of controllers execute IEC 61131-3 and C application programs simultaneously, providing you with maximum flexibility in implementing your control strategy.

This manual provides documentation on the IEC 61131-3 C program loader and the library of C language process control and SCADA functions. We strongly encourage you to read it, and to notify us if you find any errors or additional items you feel should be included in our documentation.

We sincerely hope that the reliability and flexibility afforded by this fully programmable controller enable you and your company to solve your automation applications in a cost effective and efficient manner.

The IEC 61131-3 C Tools include an ANSI C cross compiler; a customized library of functions for industrial automation and data acquisition; a real time operating system; and the IEC 61131-3 C program loader. The C function library is similar to many other C implementations, but contains additional features for real time control, digital and analog I/O. An overview of the application development environment and its features follows.

Program Development

C programs are written using any text editor. The MCCM77 compiler is used to compile, assemble and link the programs on a personal computer.

The memory image, which results from this process may then be, loaded either into the RAM, committed to an EPROM, or both may be used together. Programs may be executed either manually or automatically at power up.

Modularity

Programs written in IEC 61131-3 C may be split into many separately compiled modules. These modules may be tested individually before being linked together in the final program. Command files specify how the various files are to be linked.

Assembly Language Code

Assembly language source code may be included directly within C programs.

The #asm and #endasm statements are used to enclose in-line assembly language code, which is then assembled without passing through the compiler.

C programs are converted to assembly language by the MCCM77 compiler, and this code may be viewed and modified. The resulting code may also be combined with programs written directly in assembler.

Document (Version 2.51) 4/4/2011 16

Program Options

IEC 61131-3 C Tools Overview

A C application program may reside in RAM or ROM. The normal method of program development has the program in RAM. The program may call library routines in the operating system ROM. The RAM is nonvolatile (battery backed), so the program may remain in RAM once development is completed and the unit is installed.

Application programs may also be committed to EPROM. The RAM is used for data storage in this case.

Supported Language Features

The IEC 61131-3 C Tools use the Microtec® MCCM77 C compiler. The compiler is ANSI C compliant, and provides a code optimizer and assembler.

In addition to the standard C operators, data types and library functions, the C tools provide a set of routines specifically designed for control applications. Some applications and the descriptions of these functions may be found on the following pages.

Serial Communication

An extensive serial communication library supports simple ASCII communication, communication protocols and serial port configuration. The default communication mode uses the TeleBUS RTU communication protocol. It supports access to the I/O database, serial port reconfiguration and program loading.

The application program can disable the TeleBUS protocol, and use the serial ports for other purposes.

TeleBUS protocols are compatible with the widely supported, Modbus ASCII and

RTU protocols.

Clock/Calendar

The processor's hardware clock calendar is supported by the C Tools. The time, date and day of week can be read and set by the application software.

Timers

The controller provides 32 software timers. They are individually programmable for tick rates from ten per second to once every 25.5 seconds. Timers may be linked to digital outputs to cause external devices to turn on/off after a specified period. Timers operate in the background from a hardware interrupt generated by the main system clock.

Duty Cycle and Pulse Outputs

The digital I/O driver provides duty cycle and pulse train outputs. Duty cycle outputs generate continuous square waves. Pulse train outputs generate finite sequences of pulses. Outputs are generated independent of the application program.

Document (Version 2.51) 4/4/2011 17

Watchdog Timer

IEC 61131-3 C Tools Overview

The controller supports a hardware watchdog timer to detect and respond to hardware or software failures. Watchdog timer trigger pulses may be generated by the user program or by the system clock.

Checksums

To simplify the implementation of self-checking communication algorithms, the C

Tools provide four types of checksums: additive, CRC-16, CRC-CCITT, and bytewise exclusive-OR. The CRC algorithms are particularly robust, employing various polynomial methods to detect communication errors. Additional types of checksums are easily implemented using library functions.

Standard I/O Functions

The IEC 61131-3 C Tools are an enhanced version of standard C libraries. The usual C programming techniques apply. However, with respect to I/O, there are some differences.

The C Tools function library supports the standard I/O functions. There are no disk drives or peripherals associated with the controller. Thus many file handling functions return fixed responses, indicating that the operation could not be performed.

Standard devices are opened automatically by the operating system and cannot be closed. The route function may be used to redirect stdin, stdout and stderr.

The IEC 61131-3 Workbench

Control Microsystems IEC 1131-3 implementation enables the programming of

SCADAPack and Micro16 controllers using the IEC 1131-3 programming languages. The programming environment uses the IEC 61131-3 Workbench to create, load and debug IEC 1131-3 application programs.

The IEC 61131-3 Workbench is a powerful programming environment providing, among several other features, a C Program Loader. On-line help provides a reference to the features of the IEC 61131-3 Workbench. IEC 61131-3 runs on the Microsoft Windows operating system.

This manual references only those features of the IEC 61131-3 Workbench pertaining to the C Program Loader dialog. Please refer to the chapter Controller

Commands and Options of the IEC1131 Reference and User Manual for a complete description of the following IEC 61131-3 Workbench menus, which will be useful during C Program development.

Additional Documentation

Additional documentation on IEC 61131-3 IEC 61131-3 and the TeleSAFE

Micro16 and SCADAPack controllers is found in the following documents.

The on-line help for the IEC 61131-3 C program loader contains a complete reference to the operation of the loader. To display on-line help, select Contents from the Help menu.

Document (Version 2.51) 4/4/2011 18

IEC 61131-3 C Tools Overview

The SCADAPack & Micro16 System Manual is a complete reference to controller and I/O modules used with SCADAPack and Micro16 controllers. It contains the SCADAPack Controller Hardware Manuals, the TeleSAFE

Micro16 System Manual and hardware manuals for 5000 I/O modules.

The TeleBUS Protocols User Manual describes communication using Modbus compatible protocols.

Document (Version 2.51) 4/4/2011 19

Getting Started

Getting Started

This section of the C Tools User Manual describes the installation of C Tools and includes a Program Development Tutorial. The Program Development Tutorial leads the user through the steps involved in writing, compiling, linking and loading a C application program.

System Requirements

IEC 61131-3 C Tools requires the following minimum system configuration.

• Personal computer using 80386 or higher microprocessor.

• Microsoft Windows operating system versions including Windows 2000, NT and XP.

• Minimum 4 MB of memory.

• Mouse or compatible pointing device.

• Hard disk with approximately 2.5 Mbytes of free disk space.

Making Backup Disks

You should make a backup copy of the Microtec C compiler disks before using the software. A backup copy protects you against damage to the disk. Always work with the backup copy. Store the original disk in a safe location.

To make a backup off a floppy disk on Microsoft Windows XP

:

• Start Windows Explorer. (Right click on Windows Start and select Explore).

• Right click on the floppy disk and select Copy Disk.

• Select the source and destination disk drives. Click on the OK button.

Installation of C Compiler

Install the Microtec C compiler as described in the installation manuals supplied with the system. Add the required variables to the DOS environment.

Installation of IEC 61131-3

Install IEC 61131-3 as described in the installation section of the IEC 61131-3

Reference and User Manual.

Some virus checking software may interfere with Setup. If you experience problems with the Setup, disable your virus checker and run Setup again.

Document (Version 2.51) 4/4/2011 20

Getting Started

Program Development Tutorial

Program development consists of three stages: writing and editing; compiling and linking; and loading the program into the controller. Each uses separate tools. To demonstrate these steps a sample program will be prepared.

Refer to the C Program Development section for a description of the program development process.

Traditionally, the first program that is run on a new C compiler is the hello, world program. It prints the message “hello, world”.

Writing and Editing

A controller C program is written using any text editor or word processor in text mode. The syntax should correspond to that described in the Microtec MCCM77

Documentation Set, and the C Program Development section of this manual.

This chapter describes non-standard functions, which are unique to the controller. It should be read carefully to make use of the special purpose routines available.

Using your text editor, open the file hello.c file. It is located in the telepace\ctools\520x directory. The program looks a little different from the traditional hello, world program.

}

/* -----------------------------------------------

hello.c

SCADAPack and TeleSAFE Micro16 Test Program

The infamous hello, world program.

-------------------------------------------- */

#include <ctools.h> void main(void)

{

PROTOCOL_SETTINGS settings;

/* Disable the protocol on serial port 1 */ settings.type = NO_PROTOCOL; settings.station = 1; settings.mode = AM_standard; settings.priority = 3; settings.SFMessaging = FALSE; setProtocolSettings(com1, &settings);

/* Print the message */ fprintf(com1, "hello, world\r\n");

/* Wait here forever */ while (TRUE)

{

}

NULL;

Document (Version 2.51) 4/4/2011 21

Getting Started

The “hello, world” message will be output to the com1 serial port of the controller.

A terminal connected to the port will display the message.

The controller normally communicates on ports using the TeleBUS communication protocol. The first section of the program disables the com1 protocol so the serial port can be used as a normal RS-232 port.

The fprintf function prints the message to the com1 serial port.

When you have completed examining the program, close the hello.c file. It is now ready to be compiled and linked.

Compiling and Linking

Compiling and linking convert the source code into executable code for the controller. The IEC 61131-3 C Tools use a C cross compiler and linker from

Microtec, a respected supplier of embedded system tools. The compiler produces tight, well-optimized code. The compiler and linker run under the

Microsoft MS-DOS operating system.

The compiler has many command line options. The basic command line and options required to compile code for the controller are: mccm77 -v -nQ -Ml -c filename.c

This should be repeated for each file in the application. Command line options are case sensitive. The character following the M is a lower case l (ell).

Files are linked together using linker command files. To link a program execute the command: lnkm77 -c filename.cmd

Sample command files for RAM and ROM based applications are located in the telepace\ctools\IEC 61131-3 directory.

Example

The hello.c program is found in the telepace\ctools\IEC 61131-3 directory. To compile and link the program:

• switch to the telepace\ctools\IEC 61131-3 directory;

• enter the commands mccm77 -v -nQ -Ml -c hello.c lnkm77 -c hello.cmd

The file hello.abs contains the executable code in a format ready to load into the controller.

Document (Version 2.51) 4/4/2011 22

Getting Started

Loading and Executing

The IEC 61131-3 C Program Loader transfers executable files from a PC to the controller and controls execution of programs in the controller. The loader can also initialize program memory and serial port configuration.

Controller Initialization

The memory of the controller has to be initialized when beginning a new programming project or when it is desired to start from default conditions. It is not necessary to initialize the controller before every program load.

To initialize the controller, first perform a SERVICE boot. A SERVICE boot preserves programs and data in nonvolatile RAM, but does not start the programs running. Default communication parameters are used.

To perform a service boot:

• Remove power from the controller.

• Press and hold the LED POWER switch.

• Apply power to the controller.

• Wait until the STAT LED on the top of the board turns on.

• Release the LED POWER switch.

Second, initialize the program and data memory in the controller. A new controller will require all initializations to be performed. Selected initializations can be performed on a controller that is in use.

• Run the IEC 61131-3 program under Microsoft Windows.

• Connect the PC to the controller with the appropriate serial cable. The hello,

world program will print data on the com1 serial port. Therefore connect to the com2 serial port on the controller. (All communication ports work the same. We use com2 here because the sample program is using com1.)

• From the Tools, Controller menu, select the Initialize command.

• Select all options: Erase IEC 1131 Application, Erase C Program, and

Initialize Controller.

• Click on the OK button.

The controller is now ready for a program.

Loading the Program

To load the hello, world program into the controller:

To load the hello, world program into the controller:

• Run the IEC 61131-3 program.

• From the Tools menu select Controller and then select the C Program

Loader command.

Document (Version 2.51) 4/4/2011 23

• Enter hello.abs in the edit box for the C Program file name.

• Click on the Write button. The file will be downloaded.

Getting Started

Executing the Program

• Connect a terminal to com1 on the controller. It will display the output of the program. Set the communication parameters to 9600 baud, 8 data bits, 1 stop bit, and no parity.

• From the C Program Loader dialog, click on the Run button to execute the program. The “hello, world” message will be displayed on the terminal.

Serial Communication Parameters

When the controller is powered up in the SERVICE mode the serial ports are configured as:

• 9600 baud

• 8 data bits

• 1 stop bit

• no parity

• Modbus RTU protocol emulation

• station address = 1

A program may change these settings with the set_port function. When the controller is powered up in RUN position, the custom parameters, as stored by the most recent save function, are used.

Document (Version 2.51) 4/4/2011 24

C Program Development

C Program Development

Program Architecture

A C application program may be contained in a single file or in a number of separate files, called modules. A single file is simple to compile and link. It can become cumbersome to edit and time-consuming to compile as the file grows in size.

An application stored in separate modules by function is easier to edit, promotes function re-use, and is quicker to compile when only a few modules are changed.

Compiled modules can be combined into object libraries and shared among users.

The IEC 61131-3 C Tools support both single file and multiple module programs.

A C application program consists of support functions provided by the C Tools and the main() and other functions written by the user.

Main Function Structure

The program sample below shows a typical structure for the main() function.

} void main(void)

{

/* Perform initialization actions */

/* Start support tasks */

/* Main Loop*/ while (TRUE)

{

}

/* Perform application functions */

Initialization actions typically consist of variable declarations, variable initialization and one-time actions that need to be performed when the program starts running.

Supporting tasks (see Real Time Operating System section) are typically created before the main loop of the program. Tasks can be created and ended dynamically during the execution of a program as well.

The main loop of a program is an infinite loop that continually performs the actions required by the program. The main() function normally never returns.

Example

The following is an example of a three-module program. Each function is stored in a separate file. This program will be used in subsequent examples.

Document (Version 2.51) 4/4/2011 25

File: func1.c

#include <ctools.h> void func1(void)

{ fputs("This is function 1\r\n", com1);

}

File: func2.c

#include <ctools.h> void func2(void)

{

}

} fputs("This is function 2\r\n ", com1);

File: main.c

#include <ctools.h> extern void func1(void); extern void func2(void); void main(void)

{ func1(); while (TRUE)

{

} func2();

C Program Development

Start-Up Function Structure

The user’s main() function is called from the appstart function of the C Tools. It is not necessary to understand the appstart function to write programs. However it performs a number of useful functions that can be modified by the user.

The start-up code has five major functions:

• create and initialize the application program heap (for dynamic memory allocation);

• specify the number of stack blocks allocated to the main task;

• initialize application program variables;

• control execution of the protocol, ladder logic and background I/O tasks;

• execute the main function.

Source code for the function is supplied with the C Tools. The following discussion refers to statements found in the file appstart.c.

The heap is a section of memory used by dynamic memory allocation functions such as malloc. The heap starts at the end of RAM used by the program and continues to the end of physical RAM. The limit is set by the statement:

Document (Version 2.51) 4/4/2011 26

C Program Development end_of_heap .EQU 41ffffh

The limit is set by default to the smallest memory option available for the controller. If your controller has more memory, change the value of the constant according to the following table.

RAM Installed C Application Program RAM

Addresses

128 Kbytes

256 Kbytes

640 Kbytes

1024 Kbytes none (ladder logic only)

400000h – 41FFFFh

400000h – 47FFFFh

388000h – 3E7FFFh

400000h – 47FFFFh

The application program signature section of the file contains a constant that determines the size of the stack allocated to the main task. The stack size is sufficient for most applications. It can be changed by modifying the statement:

.WORD 4 ;stack size in blocks

Refer to the Real Time Operating System section for more information on the stack required by tasks.

The appstart function begins by initializing the heap pointers, setting all noninitialized variables to zero, and initializing system variables.

It then starts the communication protocols for each serial port, according to the stored values in the EEPROM (or the standard values on a SERVICE boot). If your application program never uses the communication protocols, some or all of the following commands can be removed, to free the stack space used by the protocol tasks.

1

start_protocol(com1); start_protocol(com2); start_protocol(com3);

2

start_protocol(com4);

3

The background I/O task is required for the timer functions, dial-up modem communications, and PID controller functions to operate. If you are not using these functions, you can reduce the CPU load by changing TRUE to FALSE in the following statement: runBackgroundIO(TRUE);

1

Stack space is required to create additional tasks. Refer to the create_task function for more information.

2

com3 is used only in the SCADAPack and SCADAPack PLUS controllers.

3

com4 is used only in the SCADAPack LIGHT and SCADAPack PLUS controllers.

Document (Version 2.51) 4/4/2011 27

C Program Development

The ladder logic interpreter is required for ladder logic programs. If you are not using ladder logic, you can reduce the CPU load by changing TRUE to FALSE in the following statement:

RunTarget(TRUE);

The final operation is execution of the main function. The _initcopy function copies the initial values for initialized variables from the __INITDATA section in the program to the variables. If there are no errors in the data then the user’s application program runs. (An error is likely only if the program in RAM has been damaged or improperly linked.) if (_initcopy() == 0)

{

} main();

If the main function returns, the task is ended. First, any modem control sessions started by the application are terminated. abortAllDialupApps();

Then the task is ended. This will cause all other APPLICATION tasks created by main to be stopped as well. taskStatus = getTaskInfo(0); end_task(taskStatus.taskID);

Data Storage

All non-initialized variables (local and global) are initialized to zero on program startup by the Microtec C Compiler. The I/O database is the only section of memory that is not initialized to zero on startup. Data stored in the I/O database is maintained when power to the controller is lost, and remains until the controller is initialized from the IEC 61131-3 program.

In most cases the I/O database provides adequate space for data storage.

However, if additional non-initialized memory is required, for example for an array of custom data structures, an non-initialized section of memory can be created as shown in the example below.

/* ---------------------------------------------------------------

- datalog.c

This file contains the global variable definitions for a datalogger database.

These global variables are placed in a non-initialized section called "savedata". All data in these variables will be maintained over powerup.

------------------------------------------------------------------

*/

#include <datalog.h>

/* define a non-initialized section called savedata */

Document (Version 2.51) 4/4/2011 28

C Program Development

#pragma option -NZsavedata

#pragma option -Xp

/* Global variable definitions */

/* log index */ unsigned logIndex;

/* log database */ struct dataLog logData[DATA_LOG_SIZE];

Any variable defined in this file datalog.c will be placed in the non-initialized section arbitrarily named savedata. Code operating on these variables should be placed in a separate file, which references these global variables through external definitions placed in a header file (e.g. datalog.h).

The #pragma option directive is documented in the Microtec MCCM77

Documentation Set.

Compiling Source Code

The C Compiler converts source code into object files. The basic command line and options required to compile code for the controller are: mccm77 -v -nQ -Ml -c filename.c

A complete description of the command line options is given in the Microtec

MCCM77 User’s Guide. The options used here are:

Option Description

-v

-nQ

-Ml

-c

Issue warnings for features in source file. This option allows you to detect potential errors in your source code before running the program.

Do not suppress diagnostic messages. This option provides additional warnings that allow you to detect potential errors in your source code before running the program.

Compile for large memory model (note that the character following the M is a lower case ell).

Compiler output is an object file.

The following options may be useful.

Option Description

-Jdir

-O

Specify the directory containing the standard include files. Adding -

Jc:\telepace\ctools\520x to the command line allows you to locate your application program files in a different directory. This helps in organizing your files if you have more than one application program.

Enable standard optimizations. This produces smaller and faster

Document (Version 2.51) 4/4/2011 29

C Program Development

Option Description

-Ot

-nOc executable code.

Optimize in favor of execution time rather than code size where a choice can be made.

Pop the stack after each function call. This increases code size and execution time. This option should only be used if there is a large number of consecutive function calls in your program.

A large number of consecutive calls requires a large stack allocation for a task. Since the number of stack blocks is limited, using this option can reduce the stack requirements for a task. See the description for the create_task function for more information.

Each module in an application should be compiled to produce an object file. The object files are then linked together to form an executable program.

Example

The following commands are required to compile the program described in the previous sections. mccm77 -v -nQ -Ml -c main.c mccm77 -v -nQ -Ml -c func1.c mccm77 -v -nQ -Ml -c func2.c

This produces three output files: main.obj; func1.obj and func2.obj. In the next section these object files will be combined into an executable program.

Linking Object Files

The linker converts object files and object file libraries into an executable program. The basic command line and options to link a program are: lnkm77 -c filename.cmd

Controller programs can execute from RAM, Flash or ROM. The linker command file determines the location of the program.

RAM Based Applications

A sample linker command file for a RAM based program is appram.cmd located in the telepace\ctools\520x directory.

The file begins by specifying the location and order of memory sections. The far_appcode section is the first section in all controller C programs. It contains the start-up code that calls the main() function. In a RAM based program, the start-up code is located at the start of C application program RAM. This address is fixed at 00400000h.

The order commands specify the order of the sections. The sections are grouped so all the code and static data sections are first. The variable data sections follow. The heap is the last section. It is allowed to grow from the end of the

Document (Version 2.51) 4/4/2011 30

C Program Development program data to the end of memory (see Start Up Function Structure section for more information).

The sections may be rearranged, and new sections added, according to the following rules:

• The far_appcode section needs to be first in the order listing.

• All code sections needs to follow the far_appcode section.

• The far_endcode section needs to be the last code section.

• All data sections needs to follow the code sections.

• The heap section needs to be last in the order listing.

; ----------------------------------------------

; Specify location and order of memory sections

; ---------------------------------------------- sect far_appcode = 00400000h order far_appcode, far_code, (CODE), const order strings, literals, __INITDATA, far_endcode order far_zerovars, far_initvars, (DATA), heap

The next section of the command file creates initialized data sections. All variables in the specified section are initialized at start-up of the program. The linker creates a copy of the data in these sections and stores it in the

__INITDATA section.

; ----------------------------------------------

; Create initialized variables section

; ---------------------------------------------- initdata far_initvars

The next section of the command file lists the application program object modules (files) to be included in the program. You may also include libraries of functions you create here. The sample command file includes one object module: app.obj.

; ----------------------------------------------

; Load application program object modules

; ---------------------------------------------- load app

The next section of the command file lists the start-up routines and standard libraries to be included. There are three object modules and two libraries:

Module

Appstart.obj

Romfunc.obj

Description

This file contains the application program start up routine

(see Program Architecture section above). If you modify the start-up routine for a particular application, specify the path to the modified routine.

This file contains addresses of the jump table for calling

Document (Version 2.51) 4/4/2011 31

Example

C Program Development

Ctools.lib cm77islf.lib cm77islc.lib functions in the operating system ROM. Only the symbols are loaded as only the addresses are needed.

This is the C Tools library, which contains C Tools functions not found in the operating system ROM.

This is the standard Microtec floating point library.

This is the standard Microtec function library.

; ----------------------------------------------

; Load start up and library routines

; ---------------------------------------------- load c:\telepace\ctools\520x\appstart load_symbols c:\telepace\ctools\520x\romfunc load c:\telepace\ctools\520x\ctools.lib load c:\mccm77\cm77islf.lib load c:\mccm77\cm77islc.lib

The final section of the command file specifies the output file format. The listmap command specifies what information is to be included in the map file. Refer to the Microtec manuals for more information on map files.

The format command specifies the executable output will be in

Motorola S2 record format. The IEC 61131-3 C Program Loader requires this format.

; ----------------------------------------------

; Specify output file formats and options

; ---------------------------------------------- listmap nopublics, nointernals, nocrossref format S2

The standard command file needs to be modified to link the application described in the previous example. Copy the appram.cmd file to myapp.cmd. Modify the application object modules section to read:

; ----------------------------------------------

; Load application program object modules

; ---------------------------------------------- load main load func1 load func2

Link the file with the command lnkm77 -c myapp.cmd

This will produce one output file: myapp.abs. The next step is to load it into the controller using the IEC 61131-3 C Program Loader.

Document (Version 2.51) 4/4/2011 32

C Program Development

Controller Initialization

You should initialize the memory of the controller when beginning a new programming project or when you wish to start from default conditions. It is not necessary to initialize the controller before every program load.

To initialize the controller, first perform a SERVICE boot. A SERVICE boot preserves programs and data in nonvolatile RAM, but does not start the programs running. Default communication parameters are used.

To perform a service boot:

• Remove power from the controller.

• Press and hold the LED POWER switch.

• Apply power to the controller.

• Wait until the STAT LED on the top of the board turns on.

• Release the LED POWER switch.

Second, initialize the program and data memory in the controller. A new controller will require all initializations be performed. Selected initializations can be performed on a controller that is in use.

• Run the IEC 61131-3 program under Microsoft Windows.

• Connect the PC to the controller with the appropriate serial cable (null modem).

• From the Tools, Controller menu, select the Initialize command.

• Select all options: Erase IEC 1131 Application, Erase C Program, Initialize

Controller.

• Click on the OK button.

Loading Programs into RAM

The C Program Loader dialog transfers executable files from a PC to the controller.

To load a program into RAM:

• Initialize the controller (see Controller Initialization section above).

• Load the program into the controller:

• Run the IEC 61131-3 program.

• From the Controller menu, select the C Program Loader command.

• Enter the executable (.abs) file in the edit box for the C Program file name.

• Select the C Program write option and any other write options desired.

• Click on the Write button. The file will be downloaded.

Document (Version 2.51) 4/4/2011 33

C Program Development

A checksum is calculated for the complete C program. The checksum is verified each time the program is run. This prevents a damaged program from running.

Executing Programs

C application programs are executed when a run program command is received from the IEC 61131-3 C Program Loader; or power is applied to the controller

(except when a SERVICE boot is performed).

To start a program from the program loader:

• Run the IEC 61131-3 program.

• From the C Program Loader dialog, click on the Run button to execute the program.

The controller will execute either the program in RAM or the program in ROM. It chooses the program to execute in the following order:

• C application program in RAM;

• C application program in ROM;

• no C application (standard start-up sequence for other components).

Document (Version 2.51) 4/4/2011 34

Real Time Operating System

Real Time Operating System

The real time operating system (RTOS) provides the programmer with tools for building sophisticated applications. The RTOS allows pre-emptive scheduling of event driven tasks to provide quick response to real-world events. Tasks multitask cooperatively. Inter-task communication and event notification functions pass information between tasks. Resource functions facilitate management of non-sharable resources.

Task Management

The task management functions provide for the creation and termination of tasks.

Tasks are independently executing routines. The RTOS uses a cooperative multi-tasking scheme, with pre-emptive scheduling of event driven tasks.

The initial task (the main function) may create additional tasks. The RTOS supports up to 16 tasks. There are 5 task priority levels to aid in scheduling of task execution.

Task Execution

SCADAPack controllers can execute one task at a time. The RTOS switches between the tasks to provide parallel execution of multiple tasks. The application program can be event driven, or tasks can execute round-robin (one after another).

Task execution is based upon the priority of tasks. There are 5 priority levels.

Level 0 is reserved for the null task. This task runs when there are no other tasks available for execution. Application programs can use levels 1 to 4. The main task is created at priority level 1.

Tasks that are not running are held in queues. The Ready Queue holds tasks that are ready to run. Event queues hold tasks that are waiting for events.

Message queues hold tasks waiting for messages. Resource queues hold tasks that are waiting for resources. The envelope queue holds tasks that are waiting for envelopes.

Priority Inversion Prevention

When a higher priority task, Task H, requests a resource, which is already obtained by a lower priority task, Task L, the higher priority task, is blocked until

Task L releases the resource. If Task L is unable to execute to the point where its releases the resource, Task H will remain blocked. This is called a Priority

Inversion.

To keep this from occurring, the prevention method known as Priority Inheritance has been implemented. In the example already described, the lower priority task,

Task L, is promoted to the priority of Task H until it releases the needed

Document (Version 2.51) 4/4/2011 35

Real Time Operating System resource. At this point Task L is returned to its original priority. Task H will obtain the resource now that it is available.

This does not prevent deadlocks that occur when each task requests a resource that the other has already obtained. This “deadly embrace” is a design error in the application program.

Task Management Functions

There are five RTOS functions for task management. Refer to the Function

Specification section for details on each function listed.

create_task

end_task

Create a task and make it ready to execute.

Terminate a task and free the resources and envelopes allocated to it.

end_application

installExitHandler

getTaskInfo

Terminate all application program type tasks. This function is used by communication protocols to stop the application program prior to loading new code.

Specify a function that is called when a task is ended with the end_task or end_application functions.

Return information about a task.

Task Management Macros

The ctools.h file defines the following macros used for task management. Refer to the C Tools Macros section for details on each macro listed.

RTOS_PRIORITIES Number of RTOS task priorities.

RTOS_TASKS Number of RTOS tasks.

STACK_SIZE

TS_EXECUTING

Size of the machine stack.

Task status indicating task is executing

TS_READY Task status indicating task is ready to execute

TS_WAIT_RESOURCE Task status indicating task is blocked waiting for a resource

TS_WAIT_ENVELOPE Task status indicating task is blocked waiting for an envelope

TS_WAIT_EVENT Task status indicating task is blocked waiting for an event

TS_WAIT_MESSAGE Task status indicating task is blocked waiting for a message

Task Management Structures

The ctools.h file defines the structure Task Information Structure for task management information. Refer to the C Tools Structures and Types section for complete information on structures and enumeration types.

Document (Version 2.51) 4/4/2011 36

Real Time Operating System

Resource Management

The resource management functions arbitrate access to non-sharable resources.

These resources include physical devices such as serial ports, and software that is not re-entrant.

The RTOS defines nine system resources, which are used by components of the

I/O drivers, memory allocation functions and communication protocols.

An application program may define other resources as required. Care needs to be taken not to duplicate any of the resource numbers declared in ctools.h as system resources.

Resource Management Functions

There are three RTOS functions for resource management. Refer to the

Function Specification section for details on each function listed.

request_resource

Request access to a resource and wait if the resource is not available.

poll_resource

release_resource

Request access to a resource. Continue execution if the resource is not available

Free a resource for use by other tasks.

IO_SYSTEM Resource

The IO_SYSTEM resource regulates access to all functions using the I/O system. C application programs, ladder logic programs, communication protocols and background I/O operations share the I/O system. It is imperative the resource is obtained to prevent a conflict, as protocols and background operations are interrupt driven. Retaining control of the resource for more that 0.1 seconds will cause background operations to not execute properly.

DYNAMIC_MEMORY Resource

The DYNAMIC_MEMORY resource regulates access to all memory allocation functions. These functions allocate memory from the system heap. The heap is shared amongst all tasks. The allocation functions are non-reentrant.

The DYNAMIC_MEMORY resource needs to be obtained before using any of the following functions.

calloc

free

malloc allocates data space dynamically frees dynamically allocated memory allocates data space dynamically

realloc changes the size of dynamically allocated space

AB_PARSER Resource

This resource is used by the DF1 communication protocol tasks to allocate access to the common message parser for each serial port. This resource is of

Document (Version 2.51) 4/4/2011 37

Real Time Operating System no interest to an application program. However, an application program may not use the resource number assigned to it.

MODBUS_PARSER Resource

This resource is used by Modbus communication protocol drivers to allocate access to the common message parser by tasks for each serial port. This resource is of no interest to an application program.

Resource Management Macros

The ctools.h file defines the following macros used for resource management.

Refer to the C Tools Macros section for details on each macro listed.

AB_PARSER

COM1_DIALUP

COM2_DIALUP

COM3_DIALUP

DF1 protocol message parser.

Resource for dialing functions on com1.

Resource for dialing functions on com2.

Resource for dialing functions on com3.

COM4_DIALUP Resource for dialing functions on com4.

DYNAMIC_MEMORY Memory allocation functions.

HART

IO_SYSTEM

HART modem resource.

I/O system hardware functions.

MODBUS_PARSER Modbus protocol message parser.

RTOS_RESOURCES Number of RTOS resource flags.

Inter-task Communication

The inter-task communication functions pass information between tasks. These functions can be used for data exchange and task synchronization. Messages are queued by the RTOS until the receiving task is ready to process the data.

Inter-task Communication Functions

There are five RTOS functions for inter-task communication. Refer to the

Function Specification section for details on each function listed.

send_message

receive_message

Send a message envelope to another task.

Read a received message from the task's message queue or wait if the queue is empty.

poll_message Read a received message from the task's message queue. Continue execution of the task if the queue is empty.

allocate_envelope Obtain a message envelope from free pool maintained by the RTOS, or wait if none is available.

deallocate_envelope Return a message envelope to the free pool maintained by the RTOS.

Document (Version 2.51) 4/4/2011 38

Real Time Operating System

Inter-task Communication Macros

The ctools.h file defines the following macros used for inter-task communication.

Refer to the C Tools Macros section for details on each macro listed.

MSG_DATA Specifies the data field in an envelope contains a data value.

MSG_POINTER Specifies the data field in an envelope contains a pointer.

RTOS_ENVELOPES Number of RTOS envelopes.

Inter-task Communication Structures

The ctools.h file defines the structure Message Envelope Structure for intertask communication information. Refer to the C Tools Structures and Types section for complete information on structures and enumeration types.

Event Notification

The event notification functions provide a mechanism for communicating the occurrence events without specifying the task that will act upon the event. This is different from inter-task communication, which communicates to a specific task.

Multiple occurrences of a single type of event are queued by the RTOS until a task waits for or polls the event.

Event Notification Functions

There are four RTOS functions for event notification. Refer to the Function

Specification section for details on each function listed.

wait_event Wait for an event to occur.

poll_event Check if an event has occurred. Continue execution if one has not occurred.

Signal that an event has occurred. signal_event

interrupt_signal_event Signal that an event has occurred from an interrupt handler. This function can only be called from within an interrupt handler.

There are two support functions, which are not part of the RTOS that may be used with events.

startTimedEvent

endTimedEvent

Enables signaling of an event at regular intervals.

Terminates signaling of a regular event.

Event Notification Macros

The ctools.h file defines the following macro used for event notification. Refer to the C Tools Macros section for details.

RTOS_EVENTS Defines the number of available RTOS events.

Document (Version 2.51) 4/4/2011 39

System Events

Real Time Operating System

The RTOS defines events for communication port management and background

I/O operations. An application program may define other events as required.

Care needs to be taken not to duplicate any of the event numbers declared in

ctools.h as system events.

BACKGROUND

COM1_FREE

This event triggers execution of the background I/O routines. An application program cannot use it.

This event is used by the serial timeout routine for the com1 port. An application program cannot use it.

COM1_RCVR

COM2_FREE

This event is used by communication protocols to signal a character or message received on com1. It can be used in a custom character handler (see

install_handler).

This event is used by the serial timeout routine for the com2 port. An application program cannot use it.

COM2_RCVR

COM3_RCVR

This event is used by communication protocols to signal a character or message received on com2. It can be used in a custom character handler (see

install_handler).

This event is used by communication protocols to signal a character or message received on com3. It can be used in a custom character handler (see

install_handler).

COM4_RCVR

NEVER

This event is used by communication protocols to signal a character or message received on com4. It can be used in a custom character handler (see

install_handler).

This event will never occur. It can be used to disable a task by waiting for it to occur. However, to end a task it is better to use end_task. This frees all resources and stack space allocated to the task.

Error Reporting

Sharable I/O drivers to return error information to the calling task use the error reporting functions. These functions provide that an error code generated by one task is not reported in another task. The errno global variable used by some functions may be modified by another task, before the current task can read it.

Error Reporting Functions

There are two RTOS functions for error reporting. Refer to the Function

Specification section for details on each function listed.

check_error

report_error

Check the error code for the current task.

Set the error code for the current task.

Document (Version 2.51) 4/4/2011 40

Real Time Operating System

Error Reporting Macros

The ctools.h file defines the following macro used for error reporting. Refer to the C Tools Macros section for details.

NO_ERROR Error code indicating no error has occurred.

SCADAPack Task Architecture

The diagram shows the tasks present in the SCADAPack controller.

Background I/O Task

Executes every 0.1 s

Processes:

• software timers

• dialup modem

• PID controllers

Priority = 4

Timer Interrupt

240 Hz Interrupt

Processes:

• Ladders timers

• jiffy timer

• watchdog timer

• timed events

Priority = h/w interrupt

Optional User Tasks

Created by user from the Main Task.

Priority = 1 to 4

Com1 Protocol Task

Executes when message event occurs

Processes:

• message

Priority = 3

Com2 Protocol Task

Executes when message event occurs

Processes:

• message

Priority = 3

Com3 Protocol Task

Executes when message event occurs

Processes:

• message

Priority = 3

Com4 Protocol Task

Executes when message event occurs

Processes:

• message

Priority = 3

Ladders & I/O Scan Task

Task loop runs continuously: while (TRUE)

{

request_resource(IO_SYSTEM);

read data from input modules to I/O database

(Register Assignment)

if program is in RUN mode execute ladder logic program

Main Task (typical)

Task loop runs continuously: while (TRUE)

{

request_resource(IO_SYSTEM);

functions requiring IO_SYSTEM resource

release_resource(IO_SYSTEM);

functions not requiring IO_SYSTEM resource

write data from I/O database to output modules

(Register Assignment)

}

release_resource(IO_SYSTEM);

release_processor();

}

release_processor();

Priority = 1 Priority = 1

The highest priority routines that execute are hardware interrupt handlers.

Hardware interrupt handlers perform their functions transparently. The Timer

Interrupt handler is required by application programs, because it updates several timers that can be used in application programs. It also triggers the background

I/O task.

Document (Version 2.51) 4/4/2011 41

Real Time Operating System

The background I/O task is the highest priority task in the system. It processes software timers, PID controllers and dialup modem control routines.

There is one protocol task for each serial port where a protocol is enabled. The protocol tasks wait for an event signaled by an interrupt handler. This event is signaled when a complete message is received. The protocol tasks process the received message and transmit a response when needed. Protocol tasks may be disabled and replaced with protocol tasks from the application program.

The Ladder Logic and I/O Scan task executes the Ladder Logic program and performs an I/O scan based on the register assignment. This task is the same priority as the main user application task.

The main task is the central task of the user application. It performs the functions required by the user. Typically, it executes at the same priority as the Ladder

Logic and I/O Scan task. It may start other user tasks if needed.

RTOS Example Application Program

The following program is used in the explanation of the RTOS functions. It creates several simple tasks that demonstrate how tasks execute. A task is a C language function that has as its body an infinite loop so it continues to execute forever.

The main task creates two tasks. The echoData task is higher priority than main.

The auxiliary task is the same priority as main. The main task then executes round robin with other tasks of the same priority.

The auxiliary task is a simple task that executes round robin with the other tasks of its priority. Only the code necessary for task switching is shown to simplify the example.

The echoData task waits for a character to be received on a serial port, then echoes it back out the port. It waits for the event of the character being received to allow lower priority tasks to execute. It installs a character handler function – signalCharacter – that signals an event each time a character is received. This function is hooked into the receiver interrupt handler for the serial port.

The execution of this program is explained in the Explanation of Task

Execution section.

/* ---------------------------------------------------------------

-----

SCADAPack Real Time Operating System Sample

Copyright (c) 1998, Control Microsystems Inc.

Version History version 1.00 Wayne Johnston November 10, 1998

---------------------------------------------------------------

----- */

/* ---- Version 1.00 ---------------------------------------------

-----

This program creates several simple tasks for demonstration of the

Document (Version 2.51) 4/4/2011 42

Real Time Operating System

functionality of the real time operation system.

---------------------------------------------------------------

----- */

#include <mriext.h>

#include <stdio.h>

#include "ctools,h"

/* ---------------------------------------------------------------

-----

Constants

---------------------------------------------------------------

----- */

#define CHARACTER_RECEIVED 10

/* ---------------------------------------------------------------

-----

signalCharacter

The signalCharacter function signals an event when a character is

received. This function must be called from an interrupt handler.

---------------------------------------------------------------

----- */ void signalCharacter(unsigned character, unsigned error)

{

/* If there was no error, signal that a character was received */ if (error == 0)

{ interrupt_signal_event(CHARACTER_RECEIVED);

}

/* Prevent compiler unused variables warning (generates no code) */ character;

}

/* ---------------------------------------------------------------

-----

echoData

The echoData function is a task that waits for a character

to be received on com6 and echoes the character back. It installs

a character handler for com6 to generate events on the reception

of characters.

---------------------------------------------------------------

----- */

3

Document (Version 2.51) 4/4/2011 43

Real Time Operating System void echoData(void)

{ struct prot_settings protocolSettings; struct pconfig portSettings; int character;

/* Disable communication protocol */ get_protocol(com6, &protocolSettings); protocolSettings.type = NO_PROTOCOL; set_protocol(com6, &protocolSettings);

/* Set serial communication parameters */ portSettings.baud = BAUD9600; portSettings.duplex = FULL; portSettings.parity = NONE; portSettings.data_bits = DATA8; portSettings.stop_bits = STOP1; portSettings.flow_rx = DISABLE; portSettings.flow_tx = DISABLE; portSettings.type = RS232; portSettings.timeout = 600; set_port(com6, &portSettings);

/* Install handler for received character */ install_handler(com6, signalCharacter); while (TRUE)

{

/* Wait for a character to be received */ wait_event(CHARACTER_RECEIVED);

}

8

/* Echo the character back */ character = fgetc(com6); fputc(character, com6);

}

/* ---------------------------------------------------------------

-----

auxiliary

The auxiliary function is a task that performs some action

required by the program. It does not have specific function so

that the real time operating system features are clearer.

---------------------------------------------------------------

----- */ void auxiliary(void)

{

Document (Version 2.51) 4/4/2011 44

Real Time Operating System while (TRUE)

{

/* ... add application specific code here ... */

/* Allow other tasks of this priority to run */ release_processor();

}

}

/* ---------------------------------------------------------------

-----

main

This function creates two tasks: one at priority three and one at

priority 1 to demonstrate the functions of the RTOS.

---------------------------------------------------------------

----- */

{ void main(void)

2

/* Create serial communication task */ create_task(echoData, 3, APPLICATION, 3);

/* Create a task - same priority as main() task */ create_task(auxiliary, 1, APPLICATION, 2); while (TRUE)

{

/* ... add application specific code here ... */

/* Allow other tasks of this priority to execute */

} release_processor();

}

Explanation of Task Execution

SCADAPack controllers can execute one task at a time. The Real Time

Operating System (RTOS) switches between the tasks to provide parallel execution of multiple tasks. The application program can be event driven, or tasks can execute round-robin (one after another). This program illustrates both types of execution.

Task execution is based upon the priority of tasks. There are 5 priority levels.

Level 0 is reserved for the null task. This task runs when there are no other tasks available for execution. Application programs can use levels 1 to 4. The main task is created at priority level 1.

Document (Version 2.51) 4/4/2011 45

Real Time Operating System

Tasks that are not running are held in queues. The Ready Queue holds tasks that are ready to run. Event queues hold tasks that are waiting for events.

Message queues hold tasks waiting for messages. Resource queues hold tasks that are waiting for resources. The envelope queue holds tasks that are waiting for envelopes.

The execution of the tasks is illustrated by examining the state of the queues at various points in the program. These points are indicated on the program listing above. The examples show only the Ready queue, the Event 10 queue and the executing task. These are the only queues relevant to the example.

Execution Point 1

This point occurs just before the main task begins. The main task has not been created by the RTOS. The null task has been created, but is not running. No task is executing.

2

1

0

Ready Queue

4

3 null()

2

1

0

Event 10 Queue

4

3

Running Task none

Figure 1: Queue Status before Execution of main Task

Execution Point 2

This point occurs just after the creation of the main task. It is the running task. On the next instruction it will create the echoData task.

Ready Queue

4

3

2

1

0 null()

1

0

Event 10 Queue

4

3

2

Figure 2: Queue Status at Start of main Task

Running Task main()

Execution Point 3

This point occurs just after the echoData task is created. The echoData task is higher priority than the main task so it is made the running task. The main task is placed into the ready queue. It will execute when it becomes the highest priority task.

Document (Version 2.51) 4/4/2011 46

Real Time Operating System

The echoData task initializes the serial port and installs the serial port handler function signalCharacter. It will then wait for an event. This will suspend the task until the event occurs.

The signalCharacter function will generate an event each time a character is received without an error.

Running Task echoData()

Ready Queue

4

3

2

1 main()

0 null()

Event 10 Queue

4

3

2

1

0

Figure 3: Queue Status after Creation of echoData Task

Execution Point 4

This point occurs just after the echoData task waits for event 10. It has been placed on the event queue for event 10.

2

1

0

The highest priority task on the ready queue was the main task. It is now running.

On the next instruction it will create another task at the same priority as main.

Ready Queue

4

3

Event 10 Queue

4

3 echoData()

Running Task main() null()

2

1

0

Figure 4: Queue Status After echoData Task Waits for Event

Execution Point 5

This point occurs just after the creation of the auxiliary task. This task is the same priority as the main task. Therefore the main task remains the running task. The auxiliary task is ready to run and it is placed on the Ready queue.

Document (Version 2.51) 4/4/2011 47

Real Time Operating System

Ready Queue

4

3

2

1

0 auxiliary() null()

3

2

1

Event 10 Queue

4 echoData()

0

Figure 5 Queue Status after Creation of auxiliary Task

Running Task main()

Execution Point 6

This point occurs just after the main task releases the processor, but before the next task is selected to run. The main task is added to the end of the priority 1 list in the Ready queue.

On the next instruction the RTOS will select the highest priority task in the Ready queue.

Running Task none

Ready Queue

4

3

Event 10 Queue

4

3 echoData()

2

1 auxiliary() main()

2

1

0 null()

0

Figure 6: Queue Status After main Task Releases Processor

Execution Point 7

This point is just after the auxiliary task has started to run. The main and auxiliary tasks will continue to alternate execution, as each task releases the processor to the other.

Ready Queue

4

Event 10 Queue

4

3 echoData()

3

2 2

1 main()

1

0 nullTask()

0

Figure 7: Queue Status at Start of auxiliary Task

Running Task auxiliary()

Document (Version 2.51) 4/4/2011 48

Execution Point 8

Real Time Operating System

This point occurs just after a character has been received. The signalCharacter function executes and signals an event. The RTOS checks the event queue for the event, and makes the highest priority task ready to execute. In this case the echoData task is made ready.

The RTOS then determines if the new task is higher priority than the executing task. Since the echoData task is higher priority than the auxiliary task, a task switch occurs. The auxiliary task is placed on the Ready queue. The echoData task executes.

Observe the position of auxiliary in the Ready queue. The main task will execute before it at the next task switch.

Running Task echoData()

Ready Queue

4

Event 10 Queue

4

3

2

1

main() auxiliary()

3

2

1

0 null()

0

Figure 8: Queue Status after Character Received

Execution Point 9

This point occurs just after the echoData task waits for the character-received event. It is placed on the event 10 queue. The highest priority task on the ready queue – main – is given the processor and executes.

Ready Queue

4

3

Event 10 Queue

4

3 echoData()

2

1 auxiliary()

2

1

0 null()

0

Figure 9: Queue Status after echoData Waits for Event

Running Task main()

Document (Version 2.51) 4/4/2011 49

Overview of Programming Functions

Overview of Programming Functions

This section of the User Manual provides and overview of the Functions, Macros,

Structure and Types available to the user. The Functions, Macros, Structure and

Types overview is separated into sections of related functions. Refer to the

Function Specification, C Tools Macros and C Tools Structures and Types section of this manual for detailed explanations of the Functions, Macros,

Structure and Types described here.

Controller Operation

This section of the manual provides an overview of the IEC 61131-3 functions relating to controller operation. These functions are provided in addition to the run-time library supplied with the Microtec C compiler.

Start Up Functions

There are two library functions related to the system or application start up task.

Refer to the Function Specification section for details on each function listed.

startup_task Returns the address of the system start up routine.

system_start The default start up routine.

Start Up Macros

The ctools.h file defines the following macros for use with the start up task.

Refer to the C Tools Macros section for details on each macro listed.

STARTUP_APPLICATION Specifies the application start up task.

STARTUP_SYSTEM Specifies the system start up task.

Start Up Task Info Structure

The ctools.h file defines the structure Start Up Information Structure for use with the startup_task function. Refer to the C Tools Structures and Types section for complete information on structures and enumeration types.

Program Status Information Functions

There are five library functions related to controller program status information.

Refer to the Function Specification section for details on each function listed.

applicationChecksum Returns the application program checksum.

getBootType Returns the controller boot up status.

getProgramStatus

setBootType

Returns the application program execution status.

Sets the controller boot up status.

Document (Version 2.51) 4/4/2011 50

setProgramStatus

Overview of Programming Functions

Sets the application program execution status.

Program Status Information Macros

The ctools.h file defines the following macros for use with controller program information. Refer to the C Tools Macros section for details on each macro listed.

NEW_PROGRAM

PROGRAM_EXECUTED

Application program is newly loaded.

Application program has been executed.

COLD_BOOT

RUN

SERVICE

REENTRY_BOOT

Controller started in COLD BOOT mode.

Controller started in RUN mode.

Controller started in SERVICE mode.

Controller Information Functions

There is one library function related to controller information. Refer to the

Function Specification section for details on the function listed.

getControllerID

Returns the controller ID string.

Controller Information Macros

The ctools.h file defines the following macros for use with controller information.

Refer to the Function Specification section for details on each macro listed.

AB_PROTOCOL DF1 protocol firmware option

BASE_TYPE_MASK Controller type bit mask

FT_NONE

FT_TELEPACE

FT_IEC 61131-3

GASFLOW

Unknown firmware type

TelePACE firmware type

IEC 61131-3 firmware type

Gas Flow calculation firmware option

RUNS_2

SCADAPACK

Set if Gas Flow supports two meter runs

SCADAPack controller

SCADAPACK_LIGHT SCADAPack LIGHT controller

SCADAPACK_PLUS SCADAPack PLUS controller

UNKNOWN_CONTOLLER Unknown controller type

Firmware Version Information Functions

There is one function related to the controller firmware version. Refer to the

Function Specification section for details.

getVersion Returns controller firmware version information.

Document (Version 2.51) 4/4/2011 51

Overview of Programming Functions

Firmware Version Information Macros

The ctools.h file defines the following macros for use with the firmware version function. Refer to the C Tools Macros section for details on each macro listed.

VI_DATE_SIZE Number of characters in the version information date field.

VI_STRING_SIZE Number of characters in the version information copyright field.

Firmware Version Information Structure

The ctools.h file defines the structure Version Information Structure for controller firmware version information. Refer to the C Tools Structures and

Types section for complete information on structures and enumeration types.

Sleep Mode Functions

SCADAPack controllers are capable of extremely low power operation when in sleep mode. SCADAPack controllers enter the sleep mode under control of the application program. Refer to the SCADAPack System Hardware Manual for further information on controller sleep mode.

There are three library functions related to sleep mode. Refer to the Function

Specification section for details on each function listed.

getWakeSource

setWakeSource

Gets wake up sources

Sets wake up sources

sleep Put controller into sleep mode

Sleep Mode Macros

The ctools.h file defines the following macros for use in sleep mode functions.

Refer to the C Tools Macros section for details on each macro listed.

SLEEP_MODE_SUPPORTED

WS_ALL

Defined if sleep function is supported

All wake up sources enabled

WS_COUNTER_0_OVERFLOW Bit mask to enable counter 0 overflow as wake up source

WS_COUNTER_1_OVERFLOW Bit mask to enable counter 1 overflow as wake up source

WS_COUNTER_2_OVERFLOW Bit mask to enable counter 2 overflow as wake up source

WS_INTERRUPT_INPUT source

Bit mask to enable interrupt input as wake up

WS_LED_POWER_SWITCH Bit mask to enable LED power switch as wake up source

WS_NONE No wake up source enabled

Document (Version 2.51) 4/4/2011 52

Overview of Programming Functions

WS_REAL_TIME_CLOCK source

Bit mask to enable real time clock as wake up

WS_UNDEFINED Undefined wake up source

Power Management Functions

Under normal operation, the SCADAPack 350 operates on a CPU clock frequency of 32 MHz. However, the SCADAPack 350 controller is capable of operating on a reduced CPU clock frequency of 8 MHz, known as Reduced

Power Mode.

Further power savings can be realized on the SCADAPack 350 controller by disabling the LAN or USB peripheral and host ports. Activation of Reduced

Power mode as well as the deactivation of the communication ports can be performed by the application program.

The library functions associated with the aforementioned power management allows for the following:

• The CPU speed can be changed from full speed (32 MHz) to reduced speed

(8 MHz).

• The LAN port can be enabled or disabled

• The USB peripheral port can be enabled or disabled

• The USB host port can be enabled or disabled.

The Power Mode LED blinks once a second when the controller is operating in

Reduced Power Mode.

The library functions associated with the power management features are listed below. Refer to the Function Specification section for details on each function listed.

getPowerMode

setPowerMode

Gets the current power mode

Sets the power mode

Power Management Macros

The ctools.h file defines the following macros for use in the power management functions. Refer to the C Tools Macros section for details on each macro listed.

PM_CPU_FULL

PM_CPU_REDUCED

PM_CPU_SLEEP

The CPU is set to run at full speed

The CPU is set to run at a reduced speed

The CPU is set to sleep mode

PM_LAN_ENABLED

PM_LAN_DISABLED

The LAN is enabled

The LAN is disabled

PM_USB_PERIPHERAL_ENABLED enabled

The USB peripheral port is

Document (Version 2.51) 4/4/2011 53

Overview of Programming Functions

PM_USB_PERIPHERAL_DISABLED disabled

PM_USB_HOST_ENABLED

The USB peripheral port is

The USB host port is enabled

PM_USB_HOST_DISABLED

PM_UNAVAILABLE

The USB host port is disabled

The status of the device could not be read

Configuration Data EEPROM Functions

The EEPROM is nonvolatile memory used to store configuration parameters. The application program cannot store application data into this memory. It can cause the system configuration parameters to be written, using the save function.

The contents of the EEPROM are copied to RAM under two conditions: during a

RUN boot of the controller; and when the application program executes the load function.

The following data is loaded on a RUN boot; otherwise default information is used:

• serial port configuration tables

• protocol configuration tables

• enable store and forward settings

• LED power settings

• mask for wake-up sources

• execution period on power-up for each PID

There are two library functions related to the configuration data EEPROM. Refer to the Function Specification section for details on each function listed.

Save

load

Writes configuration data from RAM to EEPROM

Reads configuration data from EEPROM into RAM

Configuration Data EEPROM Macros

The ctools.h file defines the following macros for use with the configuration data

EEPROM. Refer to the C Tools Macros section for details on each macro listed.

EEPROM_EVERY

EEPROM_RUN reboot.

EEPROM section loaded to RAM on every CPU

EEPROM section loaded to RAM on RUN type boots only.

EEPROM_SUPPORTED If defined, indicates that there is an

EEPROM in the controller.

Document (Version 2.51) 4/4/2011 54

Overview of Programming Functions

I/O Bus Communication Functions

The ctools.h file defines the following functions that access the I/O bus. The I/O bus is I

2

C compatible. Refer to the Function Specification section for details on each function listed.

ioBusReadByte Reads one byte from an I

2

C slave device

ioBusReadLastByte Reads one byte from an I

2

C slave device and terminates read

ioBusReadMessage Reads a message from an I

2

C slave device

ioBusSelectForRead Selects an I

2

C slave device for reading

ioBusSelectForWrite Selects an I

2

C slave device for writing

ioBusStart Issues an I

2

C bus START condition

ioBusStop Issues an I

2

C bus STOP condition

ioBusWriteByte Writes one byte to an I

2

C slave device

ioBusWriteMessage Writes a message to an I

2

C slave device

I/O Bus Communication Macros

The ctools.h file defines the following macros for use with I/O Bus

Communication. Refer to the C Tools Macros section for details on each macro listed.

The ctools.h file defines the following macros.

READSTATUS enumeration type ReadStatus

WRITESTATUS enumeration type WriteStatus

I/O Bus Communication Types

The ctools.h file defines the enumeration types ReadStatus and WriteStatus.

Refer to the C Tools Structures and Types section for complete information on structures and enumeration types.

System Functions

The ctools.h file defines the following functions for system initialization and for retrieving system information. Some of these functions are primarily used in the

appstart.c routine, having limited use in an application program.

Refer to the Function Specification section for details on each function listed.

applicationChecksum Returns the application program checksum.

ioClear

ioDatabaseReset

Clears all I/O points

Resets the controller to default settings.

ioRefresh

ioReset

Refresh outputs with internal data

Reset all I/O modules

Document (Version 2.51) 4/4/2011 55

Overview of Programming Functions

Controller I/O Hardware

This section of the manual provides an overview of the IEC 61131-3 C Tools functions relating to controller signal input and output (I/O). These functions are provided in addition to the run-time library supplied with the Microtec C compiler.

Analog Input Functions

The controller supports internal analog inputs and external analog input modules.

Refer to the SCADAPack System Hardware Manual for further information on controller analog inputs and analog input modules.

There are several library functions related to internal analog inputs and analog input modules. Refer to the Function Specification section for details on each function listed.

readBattery

readThermistor

readInternalAD

Read the controller RAM battery voltage.

Read the controller ambient temperature sensor.

Read the controller internal AD converter.

ioRead4Ain ioRead8Ain

read 4 analog inputs into I/O database. read 8 analog inputs into I/O database.

IsaRead4202Inputs

Read the digital and analog inputs from a SCADAPack

DR.

IsaRead4202DSInputs Read the digital and analog inputs from a SCADAPack

DS.

isaRead5505Inputs Read the digital and analog inputs from a 5505 I/O

Module.

isaRead5506Inputs Read the digital and analog inputs from a 5506 I/O

Module.

isaRead5601Inputs Read the digital and analog inputs from a 5601 I/O

Module.

isaRead5602Inputs Read the digital and analog inputs from a 5602 I/O

Module.

isaRead5604Inputs module.

Read the digital and analog inputs from 5604 I/O

isaRead5606Inputs module.

Read the digital and analog inputs from 5606 I/O

isaReadLPInputs Read the digital and analog inputs from SCADAPack LP

I/O.

isaReadSP100Inputs Read the digital and analog inputs from SCADAPack

100 I/O.

Document (Version 2.51) 4/4/2011 56

Analog Input Macros

Overview of Programming Functions

The ctools.h file defines the following macros for use with controller analog inputs. Refer to the C Tools Macros section for details on each macro listed.

AD_BATTERY

AD_THERMISTOR

Internal AD channel connected to lithium battery.

Internal AD channel connected to thermistor.

T_CELSIUS

T_FAHRENHEIT

Specifies temperatures in degrees Celsius.

Specifies temperatures in degrees Fahrenheit.

T_KELVIN

T_RANKINE

Specifies temperatures in degrees Kelvin.

Specifies temperatures in degrees Rankine.

Analog Output Functions

The controller supports external analog output modules. Refer to the

SCADAPack System Hardware Manual for further information on these modules.

There are three library functions related to analog output modules. Refer to the

Function Specification section for details on each function listed.

isaWriteAout Writes data to an analog output module.

isaWrite2Aout isaWrite4Aout

Write data to any 2 point analog output module.

Write data to any 4 point analog output module.

IsaWrite4202Outputs Write data to the digital and analog outputs of the

SCADAPack of controllers.

isaWrite5505Outputs Write configuration data to the 5505 module.

isaWrite5506Outputs Write configuration data to the 5506 module.

isaWrite5606Outputs Write data to the digital and analog outputs of the 5606 module.

isaWrite5303Aout

Write data to the two points of the 5303 module.

isaWriteLPOutputs

Write data to the digital and analog outputs of the

SCADAPack LP I/O.

isaWriteSP100Outputs Write data to the digital and analog outputs of the

SCADAPack 100 I/O.

Digital Input Functions

The controller supports internal digital inputs and external digital input modules.

Refer to the SCADAPack System Hardware Manual for further information on controller digital inputs and digital input modules.

There are several library functions related to digital inputs and external digital input modules. Refer to the Function Specification section for details on each function listed.

Document (Version 2.51) 4/4/2011 57

Overview of Programming Functions

interruptInput

readCounterInput

isaRead16Din

isaRead32Din

Read the controller interrupt input.

Read the status of the counter input points on the controller board.

Read any 16 point Digital input module.

Read any 32 point Digital Input Module.

IsaRead4202Inputs

Read the digital and analog inputs from a SCADAPack

4202 DR

IsaRead4202DSInputs Read the digital and analog inputs from a SCADAPack

4202 DS

isaRead5505Inputs Read the digital and analog inputs from a 5505 I/O

Module.

isaRead5506Inputs Read the digital and analog inputs from a 5506 I/O

Module.

isaRead5601Inputs Read the digital and analog inputs from a 5601 I/O

Module.

isaRead5602Inputs Read the digital and analog inputs from a 5602 I/O

Module.

isaRead5604Inputs Read the digital and analog inputs from 5604 I/O

Module.

isaRead5606Inputs Read the digital and analog inputs from a 5606 I/O

Module.

isaRead8Din

isaReadLPInputs

Read any 8 point analog input module.

Read the digital and analog inputs from SCADAPack LP

I/O.

isaReadSP100Inputs Read the digital and analog inputs from SCADAPack

100 I/O.

Digital Output Functions

The controller supports external digital output modules. Refer to the

SCADAPack System Hardware Manual for further information on controller digital output modules.

There are several library functions related to digital output modules. Refer to the

Function Specification section for details on each function listed.

isaWrite16Dout

isaWrite32Dout

Write data to any 16 point Digital output module.

Writes data to any 32-point Digital Output Module at the specified moduleAddress.

IsaWrite4202OutputsEx Write the digital output of a SCADAPack 4301 DR or

4202 DR with a digital output (Extended I/O).

Document (Version 2.51) 4/4/2011 58

Overview of Programming Functions

IsaWrite4202DSOutputs Write the digital outputs of a SCADAPack 4202 or

4301 DS.

isaWrite5601Outputs Write data to the digital outputs of a 5601 I/O Module.

isaWrite5602Outputs Write data to the digital outputs of a 5601 I/O Module.

isaWrite5604Outputs Writes data to the digital and analog outputs of the 5604

I/O module.

isaWrite5606Outputs Writes data to the digital and analog outputs of the 5606

I/O module.

isaWrite8Dout

Write data to any 8 point Digital output module.

isaWriteLPOutputs

Write data to the digital and analog outputs of the

SCADAPack LP I/O.

isaWriteSP100Outputs Write data to the digital and analog outputs of the

SCADAPack 100 I/O.

Counter Input Functions

The controller supports internal counters and external counter modules. The counter registers are 32 bits, for a maximum count of 4,294,967,295. They roll over to 0 on the next count. The counter inputs measure the number of rising inputs. Refer to the SCADAPack System Hardware Manual for further information on controller counter inputs and counter input modules.

There are three library functions related to counters. Refer to the Function

Specification section for details on each function listed.

readCounter Read a controller counter with or without automatic clearing of the counter register.

interruptCounter

ioRead4Counter

Read the controller interrupt input as a counter with or without automatic clearing of the counter value.

Read any 4 point Counter input module.

Counter Input Macros

The ctools.h file defines the following macro for use with counter inputs. Refer to the C Tools Macros section for details.

LOCAL_COUNTERS Number of controller counter inputs.

Status LED and Output Functions

The status LED and output indicate alarm conditions. The STAT LED blinks and the STATUS output opens when an alarm occurs. The STAT LED turns off and the STATUS output closes when all alarms clear.

The STAT LED blinks a binary sequence indicating alarm codes. The sequences consist of long and short flashes, followed by an off delay of 1 second. The sequence then repeats. The sequence may be read as the Controller Status

Code.

Document (Version 2.51) 4/4/2011 59

Overview of Programming Functions

Refer to the SCADAPack System Hardware Manual for further information on the status LED and digital output.

There are two library functions related to the status LED and digital output. Refer to the Function Specification section for details on each function listed.

clearStatusBit

clearStatusBit

Clears bits in controller status code.

Clears bits in controller status code.

Status LED and Output Macros

The ctools.h file defines the following macros for use with the status LED and digital output. Refer to the C Tools Macros section for details on each macro listed.

S_MODULE_FAILURE Status LED code for I/O module communication failure

S_NORMAL Status LED code for normal status

Options Switches Functions

The controller has three option switches located under the cover of the controller module. These switches are labeled OPTION 1,2 and 3. The option switches are user defined except when a SCADAPack I/O module or SCADAPack AOUT module used. In this case option switches 1 and 2 select the analog ranges.

Refer to the SCADAPack System Hardware Manual for further information on option switches.

There is one library function related to the controller option switches. Refer to the

Function Specification section for details.

optionSwitch Read option switch states.

Option Switches Macros

The ctools.h file defines the following macros for use with option switches. Refer to the C Tools Macros section for details on each macro listed.

CLOSED

OPEN

Specifies switch is in closed position

Specifies switch is in open position

LED Indicators Functions

An application program can control three LED indicators.

The RUN LED (green) indicates the execution status of the program. The LED can be on or off. It remains in the last state until changed.

The STAT LED indicates error conditions. It outputs an error code as a binary sequence. The sequence repeats until a new error code is output. If the error code is zero, the status LED turns off.

The FORCE LED indicates locked I/O variables. Use this function with caution in application programs.

Document (Version 2.51) 4/4/2011 60

Overview of Programming Functions

There are three library functions related to the LED indicators. Refer to the

Function Specification section for details on each function listed.

runLed

setStatus

forceLed

Controls the RUN LED status.

Sets controller status code.

Sets state of the force LED.

LED Indicators Macros

The ctools.h file defines the following macros for use with LED power control.

Refer to the C Tools Macros section for details on each macro listed.

LED_OFF

LED_ON

Specifies LED is to be turned off.

Specifies LED is to be turned on.

LED Power Control Functions

The controller board can disable the LEDs on the controller board, the upper and lower I/O modules and the 5000 I/O modules to conserve power. This is particularly useful in solar powered or unattended installations. Refer to the

SCADAPack System Hardware Manual for further information on LED power control.

There are four library functions related to LED power control. Refer to the

Function Specification section for details on each function listed.

ledGetDefault

ledPower

Get default LED power state

Set LED power state

ledPowerSwitch

ledSetDefault

Read LED power switch

Set default LED power state

LED Power Control Macros

The ctools.h file defines the following macros for use with LED power control.

Refer to the C Tools Macros section for details on each macro listed.

LED_OFF

LED_ON

Specifies LED is to be turned off.

Specifies LED is to be turned on.

LED Power Control Structure

The ctools.h file defines the structure LED Power Control Structure for LED power control information. Refer to the C Tools Structures and Types section for complete information on structures and enumeration types.

Software Timer Functions

The controller provides 32 powerful software timers, which greatly simplify the task of programming time-related functions. Uses include:

• generation of time delays

Document (Version 2.51) 4/4/2011 61

Overview of Programming Functions

• timing of process events such as tank fill times

• generation of time-based interrupts to schedule regular activities

• control of digital outputs by time periods

The 32 timers are individually programmable for tick rates from ten per second to once every 25.5 seconds. Time periods from 0.1 second to greater than nineteen days can be measured and controlled.

Timers operate in the background from a hardware interrupt generated by the main system clock. Once loaded, they count without intervention from the main program.

There are four library functions related to timers. Refer to the Function

Specification section for details on each function listed.

interval

settimer zero.

Set timer tick interval in tenths of seconds.

Set a timer. Timers count down from the set value to

timer

Read the time period remaining in a timer.

read_timer_info

Read information about a software timer.

Software Timer Macros

The ctools.h file defines the following macros for use with timers. Refer to the C

Tools Macros section for details on each macro listed.

NORMAL S pecifies normal count down timer.

TIMED_OUT

Specifies timer is has reached zero.

TIMER_BADINTERVAL

Error code indicating invalid timer interval.

TIMER_BADTIMER

Error code indicating invalid timer.

TIMER_BADVALUE

TIMER_MAX

Error code indicating invalid time value.

Number of last valid software timer.

Timer Information Structure

The ctools.h file defines the structure Timer Information for timer information.

Refer to the C Tools Structures and Types section for complete information on structures and enumeration types.

Timer Example Programs

Example 1: Turn on a digital output assigned to coil register 1 and wait 5 seconds before turning it off.

interval(0,10); /* timer 0 tick rate = 1 second */ request_resource(IO_SYSTEM); setdbase(MODBUS, 1, 1); /* turn on output */ release_resource(IO_SYSTEM); settimer(0,5); /* load timer 0 with 5 seconds */

Document (Version 2.51) 4/4/2011 62

Overview of Programming Functions while(timer(0))

{

/* wait until time expires */

/* Allow other tasks to execute */

} release_processor(); request_resource(IO_SYSTEM); setdbase(MODBUS, 1, 0); /* shut off output */ release_resource(IO_SYSTEM);

Example 2: Time the duration a contact is on but wait in loop to measure time. Contact is assigned to status register 10001.

interval(0,1); /* tick rate = 0.1 second */ request_resource(IO_SYSTEM); if (dbase(MODBUS, 10001)) /* test if contact is on */

{ settimer(0,63000); /* start timer */ while(dbase(MODBUS, 10001)) /* wait for turn off */

{

}

/* Allow other tasks to execute */ release_resource(IO_SYSTEM); release_processor(); request_resource(IO_SYSTEM); printf("time period = %u\r\n",63000-timer(0));

} release_resource(IO_SYSTEM);

Example 3: Open valve to fill tank and print alarm message if not full in 1 minute. Contact is assigned to status register 10001. Valve is controlled by coil register 1.

interval(0,10); /* timer 0 tick rate = 1 second */ request_resource(IO_SYSTEM); setdbase(MODBUS, 1, 1); settimer(0,60);

/* open valve */

/* set timer for 1 minute */

/* tank not full if contact is off */ while((dbase(MODBUS, 10001)== 0) && timer(0))

{

/* Allow other tasks to execute */ release_resource(IO_SYSTEM); release_processor(); request_resource(IO_SYSTEM);

} if (dbase(MODBUS, 10001)== 0) puts("tank is not filling!!\r\n"); else puts("tank full\r\n"); setdbase(MODBUS, 1, 0); /* close valve */ release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 63

Overview of Programming Functions

Real Time Clock Functions

The controller is provided with a hardware based real time clock that independently maintains the time and date for the operating system. The time and date remain accurate during power-off. This allows the controller to be synchronized to time of day for such functions as shift production reports, automatic instrument calibration, energy logging, etc. The calendar can be used to automatically take the controller off-line during weekends and holidays. The calendar automatically handles leap years.

There are eight library functions, which access the real-time clock. Refer to the

Function Specification section for details on each function listed.

alarmIn Returns absolute time of alarm given elapsed time

getclock

getClockAlarm

Read the real time clock.

Reads the real time clock alarm settings.

getClockTime Read the real time clock.

installClockHandler Installs a handler for real time clock alarms.

resetClockAlarm Resets the real time clock alarm so it will recur at the same time next day.

setclock

setClockAlarm

Set the real time clock.

Sets real time clock alarm.

Real Time Clock Macros

The ctools.h file defines the following macros for real time clock alarms. Refer to the C Tools Macros section for details on each macro listed.

AT_ABSOLUTE

AT_NONE

Specifies a fixed time of day alarm.

Disables alarms

Real Time Clock Structures

The ctools.h file defines the structures Real Time Clock Structure and Alarm

Settings Structure for real time clock information. Refer to the C Tools

Structures and Types section for complete information on structures and enumeration types.

Real Time Clock Program Example

The following program illustrates how the date and time can be set and displayed. All fields of the clock structure need to be set with valid values for the clock to operate properly.

#include <ctools.h> void main(void)

{ struct clock now;

Document (Version 2.51) 4/4/2011 64

}

Overview of Programming Functions

/* Set to 12:01:00 on January 1, 1994 */ now.hour = 12; now.minute = 1; now.second = 0; now.day = 1;

/* set the time */

/* set the date */ now.month = 1; now.year = 94; now.dayofweek = 6; /* day is Sat. */ request_resource(IO_SYSTEM); setclock(&now); now = getclock(); release_resource(IO_SYSTEM);

/* Display current hour, minute and second */ printf("%2d:%2d:%2d", now.hour, now.minute, now.second);

Stopwatch Timer Functions

The stopwatch is a counter that increments every 10 ms. The stopwatch is useful for measuring execution times or generating delays where a fine time base is required. The stopwatch time rolls over to 0 when it reaches the maximum value for an unsigned long integer: 4,294,967,295 ms (or about 497 days).

There is one library function to access the stopwatch time. Refer to the

readStopwatch section for details.

readStopwatch

reads the stopwatch timer.

Watchdog Timer Functions

A watchdog timer is a hardware device, which enables rapid detection of computer hardware or software problems. In the event of a major problem, the

CPU resets and the application program restarts.

The controller provides an integral watchdog timer to ensure reliable operation.

The watchdog timer resets the CPU if it detects a problem in either the hardware or system firmware. A user program can take control of the watchdog timer, so it will detect abnormal execution of the program.

A watchdog timer is a retriggerable, time delay timer. It begins a timing sequence every time it receives a reset pulse. The time delay is adjusted so that regular reset pulses prevent the timer from expiring. If the reset pulses cease, the watchdog timer expires and turns on its output, signifying a malfunction. The timer output in the controller resets the CPU and turns off all outputs at the I/O system.

The watchdog timer is normally reset by the operating system. This is transparent to the application program. Operating in such a fashion, the watchdog timer detects any hardware or firmware problems.

Document (Version 2.51) 4/4/2011 65

Overview of Programming Functions

The watchdog timer can detect failure of an application program. The program takes control of the timer, and resets it regularly. If unexpected operation of the program occurs, the reset pulses cease, and the watchdog timer resets the CPU.

The program restarts from the beginning.

There are three library functions related to the watchdog timer. Refer to the

Function Specification section for details on each function listed.

wd_auto Gives control of the watchdog timer to the operating system (default).

wd_manual

wd_pulse

Gives control of the watchdog timer to an application program.

Generates a watchdog reset pulse.

A watchdog reset pulse needs to be generated at least every 500 ms. The CPU resets, and program execution starts from the beginning of the program, if the watchdog timer is not reset.

Watchdog Timer Program Example

The following program segment shows how the watchdog timer could be used to detect the failure of a section of a program. wd_manual(); /* take control of watchdog timer */ do {

/* program code */ wd_pulse();

} while (condition) wd_auto();

/* reset the watchdog timer */

/* return control to OS */

Pass control of the watchdog timer back to the operating system before stopping a program, or switching to another task that expects the operating system to reset the timer.

Checksum Functions

To simplify the implementation of self-checking communication algorithms, the C

Tools provide four types of checksums: additive, CRC-16, CRC-CCITT, and bytewise exclusive-OR. The CRC algorithms are particularly reliable, employing various polynomial methods to detect nearly all communication errors. Additional types of checksums are easily implemented using library functions.

There are two library functions related to checksums. Refer to the Function

Specification section for details on each function listed.

checksum Calculates additive, CRC-16, CRC-CCITT and exclusive-OR type checksums

crc_reverse Calculates custom CRC type checksum using reverse

CRC algorithm.

Document (Version 2.51) 4/4/2011 66

Checksum Macros

Overview of Programming Functions

The ctools.h file defines macros for specifying checksum types. Refer to the C

Tools Macros section for details on each macro listed.

ADDITIVE

BYTE_EOR

Additive checksum

Byte-wise exclusive OR checksum

CRC_16

CRC_CCITT

CRC-16 type CRC checksum (reverse algorithm)

CCITT type CRC checksum (reverse algorithm)

Serial Communication

The SCADAPack family of controllers offers three or four RS-232 serial ports.

The TeleSAFE Micro16 has two RS-232 serial communication ports. (com1 on all controllers is also available as an RS-485 port.) The ports are configurable for baud rate, data bits, stop bits, parity and communication protocol.

To optimize performance, minimize the length of messages on com3 and com4.

Examples of recommended uses for com3 and com4 are for local operator display terminals, and for programming and diagnostics using the IEC 61131-3 program.

Default Serial Parameters

All ports are configured at reset with default parameters when the controller is powered up in SERVICE mode. The ports use stored parameters when the controller is reset in the RUN mode. The default parameters are listed below.

Parameter com1 com2 Com3 Com4

Baud rate

Parity

Data bits

Stop bits

9600 none

8

1

9600 none

8

1

9600

None

8

1

9600

None

8

1

Duplex

Protocol full full Half Half

Modbus RTU Modbus RTU Modbus RTU Modbus

RTU

Station 1

Rx flow control off

Tx flow control off

Serial time out 60 s

Type RS-232

1 off off

60 s

RS-232

1

Rx disable

Off

60 s

RS-232

1

Rx disable

Off

60 s

RS-232

Serial Communication Time Out

When the controller is transmitting data on the communication ports, the transmit buffer may become full due to receipt of an XOFF character, a slow baud rate, or hardware handshaking.

Document (Version 2.51) 4/4/2011 67

Overview of Programming Functions

If the transmit buffers become full, the task transmitting data is blocked until space is available or the serial time out period expires. If no space is available at the conclusion of this time period, the transmit buffer is emptied. The task then continues execution.

Debugging Serial Communication

Serial communication can be difficult to debug. This section describes the most common causes of communication failures.

• To communicate, the controller and an external device need to use the same communication parameters. Check the parameters in both units.

• If some but not all characters transmit properly, you probably have a parity or stop bit mismatch between the devices.

The connection between two RS-232 Data Terminal Equipment (DTE) devices is made with a null-modem cable. This cable connects the transmit data output of one device to the receive data input of the other device – and vice versa. The controller is a DTE device. This cable is described in the System Hardware

Manual for your controller.

The connection between a DTE device and a Data Communication Equipment

(DCE) device is made with a straight cable. The transmit data output of the DTE device is connected to the transmit data input of the DCE device. The receive data input of the DTE device is connected to the receive data output of the DCE device. Modems are usually DCE devices. This cable is described in the System

Hardware Manual for your controller.

Many RS-232 devices require specific signal levels on certain pins.

Communication is not possible unless the required signals are present. In the controller the CTS line needs to be at the proper level. The controller will not transmit if CTS is OFF. If the CTS line is not connected, the controller will force it to the proper value. If an external device controls this line, it needs to turn it ON for the controller to transmit.

Serial Communication Functions

The ctools.h file defines the following serial communication related functions.

Refer to the Function Specification section for details on each function listed.

Additional serial communication functions are included in the Microtec run-time library.

clear_errors

clear_tx

Clear serial port error counters.

Clear serial port transmit buffer.

get_port Read serial port communication parameters.

getPortCharacteristics Read information about features supported by a serial port.

get_status

install_handler

Read serial port status and error counters.

Install serial port character received handler.

Document (Version 2.51) 4/4/2011 68

portConfiguration

portIndex

portStream

queue_mode

route

setDTR

set_port

Overview of Programming Functions

Get pointer to port configuration table

Get array index for serial port

Get serial port corresponding to index

Set serial port transmitter mode.

Redirect standard I/O streams.

Control RS232 port DTR signal.

Set serial port communication parameters.

Serial Communication Macros

The ctools.h file defines macros for specifying serial communication parameters.

Refer to the C Tools Macros section for details on each macro listed.

BAUD75

BAUD110

BAUD150

BAUD300

BAUD600

Specifies 75-baud port speed.

Specifies 110-baud port speed.

Specifies 150-baud port speed.

Specifies 300-baud port speed.

Specifies 600-baud port speed.

BAUD1200

BAUD2400

BAUD4800

BAUD9600

BAUD19200

BAUD38400

BAUD57600

BAUD115200

Specifies 1200-baud port speed.

Specifies 2400-baud port speed.

Specifies 4800-baud port speed.

Specifies 9600-baud port speed.

Specifies 19200-baud port speed.

Specifies 38400-baud port speed.

Specifies 57600-baud port speed.

Specifies 115200-baud port speed.

com1

com2

com3

com4

DATA7

DATA8

DISABLE

ENABLE

EVEN

FULL

Points to a file object for com1 serial port.

Points to a file object for com2 serial port.

Points to a file object for com3 serial port.

Points to a file object for com4 serial port.

Specifies 7 bit world length.

Specifies 8 bit word length.

Specifies flow control is disabled.

Specifies flow control is enabled.

Specifies even parity.

Specifies full duplex.

Document (Version 2.51) 4/4/2011 69

Overview of Programming Functions

FOPEN_MAX

HALF

NONE

NOTYPE

Specifies no parity.

Specifies serial port type is not known.

ODD Specifies odd parity.

PC_FLOW_RX_RECEIVE_STOP

message.

Receiver disabled after receipt of a

PC_FLOW_RX_XON_XOFF Receiver Xon/Xoff flow control.

PC_FLOW_TX_IGNORE_CTS Transmitter flow control ignores CTS.

PC_FLOW_TX_XON_XOFF

RS232

Transmitter Xon/Xoff flow control.

Specifies serial port is an RS-232 port.

RS232_MODEM

Redefinition of macro from stdio.h

Specifies half duplex.

RS485_4WIRE

SERIAL_PORTS

SIGNAL_CTS

SIGNAL_DCD

SIGNAL_OFF

SIGNAL_OH modem.

Specifies serial port is an RS-232 dial-up

Specifies serial port is a 4 wire RS-485 port.

Number of serial ports.

I/O line bit mask: clear to send signal

I/O line bit mask: carrier detect signal

Specifies a signal is de-asserted

I/O line bit mask: off hook signal

SIGNAL_ON

SIGNAL_RING

SIGNAL_VOICE

STOP1

STOP2

Specifies a signal is asserted

I/O line bit mask: ring signal

I/O line bit mask: voice/data switch signal

Specifies 1 stop bit.

Specifies 2 stop bits.

Serial Communication Structures

The ctools.h file defines the structures Serial Port Configuration, Serial Port

Status and Serial Port Characteristics for serial port configuration and information. Refer to the C Tools Structures and Types section for complete information on structures and enumeration types.

Microtec Serial I/O Functions

These library functions are related to serial communication. They are documented in the Microtec MCCM77 Documentation Set.

fgetc

fgets reads a character from a stream reads a string from a stream

Document (Version 2.51) 4/4/2011 70

fputc

fputs

fread

fwrite

getc

getchar

gets

initport

printf

putc

putchar

puts

scanf

Overview of Programming Functions writes a character to a stream writes a string to a stream reads from a stream writes to a stream reads a character from a stream reads a character from standard input device reads a string from a stream re-initializes serial port formatted output to a stream writes a character to a stream reads a character to standard output device writes a string to a stream formatted input from a stream

Dial-Up Modem Functions

These library functions provide control of dial-up modems. They are used with external modems connected to a serial port. An external modem normally connects to the RS-232 port with a DTE to DCE cable. Consult the System

Hardware Manual for your controller for details. Refer to the Function

Specification section for details on each function listed.

modemInit send initialization string to dial-up modem.

modemInitStatus

modemInitEnd

modemDial

modemDialStatus read status of modem initialization operation. terminate modem initialization operation. modem. connect with an external device using a dial-up read status of connection with external device using a dial-up modem.

modemDialEnd

modemAbort terminate connection with external device using a dial-up modem. unconditionally terminate connection with external device or modem initialization (used in task exit handler).

modemAbortAll unconditionally terminate connections with external device or modem initializations (used in task exit handler).

modemNotification notify the dial-up modem handler that an interesting event has occurred. This function is usually called whenever a message is received by a protocol.

Document (Version 2.51) 4/4/2011 71

Overview of Programming Functions

Dial-Up Modem Macros

The ctools.h file defines the following macros of interest to a C application program. Refer to the C Tools Macros section for details on each macro listed.

MODEM_CMD_MAX_LEN Maximum length of the modem initialization command string

PHONE_NUM_MAX_LEN Maximum length of the phone number string

Dial-Up Modem Enumeration Types

The ctools.h file defines the enumerated types DialError and DialState. Refer to the C Tools Structures and Types section for complete information on structures and enumeration types.

Dial-up Modem Structures

The ctools.h file defines the structures ModemInit and ModemSetup. Refer to the

C Tools Structures and Types section for complete information on structures and enumeration types.

Modem Initialization Example

The following code shows how to initialize a modem. Typically, the modem initialization is used to prepare a modem to answer calls. The example sets up a

Hayes modem to answer incoming calls.

#include <ctools.h> void main(void)

{ struct ModemInit initSettings; reserve_id portID; enum DialError status; enum DialState state; struct pconfig portSettings;

/* Configure serial port 1 */ portSettings.baud = BAUD1200; portSettings.duplex = FULL; portSettings.parity = NONE; portSettings.data_bits = DATA8; portSettings.stop_bits = STOP1; portSettings.flow_rx = DISABLE; portSettings.flow_tx = DISABLE; portSettings.type = RS232_MODEM; portSettings.timeout = 600; request_resource(IO_SYSTEM); set_port(com1, &portSettings); release_resource(IO_SYSTEM);

/* Initialize Hayes modem to answer incoming calls */ initSettings.port = com1; strcpy(initSettings.modemCommand, " F1Q0V1X1 S0=1"); if (modemInit(&initSettings, &portID) == DE_NoError)

{

Document (Version 2.51) 4/4/2011 72

}

}

Overview of Programming Functions do

{

/* Allow other tasks to execute */ release_processor();

/* Wait for the initialization to complete */

} modemInitStatus(com1, portID, &status, &state); while (state == DS_Calling);

/* Terminate the initialization */ modemInitEnd(com1, portID, &status);

Connecting with a Remote Controller Example

The following code shows how to connect to a remote controller using a modem.

The example uses a US Robotics modem. It also demonstrates the use of the modemAbort function in an exit handler.

#include <ctools.h>

/* --------------------------------------------

The shutdown function aborts any active

modem connections when the task is ended.

-------------------------------------------- */ void shutdown(void)

{

} modemAbort(com1); void main(void)

{ struct ModemSetup dialSettings; reserve_id portID; enum DialError status; enum DialState state; struct pconfig portSettings;

TASKINFO taskStatus;

/* Configure serial port 1 */ portSettings.baud = BAUD19200; portSettings.duplex = FULL; portSettings.parity = NONE; portSettings.data_bits = DATA8; portSettings.stop_bits = STOP1; portSettings.flow_rx = DISABLE; portSettings.flow_tx = DISABLE; portSettings.type = RS232_MODEM; portSettings.timeout = 600; request_resource(IO_SYSTEM); set_port(com1, &portSettings); release_resource(IO_SYSTEM);

/* Configure US Robotics modem */

Document (Version 2.51) 4/4/2011 73

Overview of Programming Functions

}

} dialSettings.port = com1; dialSettings.dialAttempts = 3; dialSettings.detectTime = 60; dialSettings.pauseTime = 30; dialSettings.dialmethod = 0; strcpy(dialSettings.modemCommand, "&F1 &A0 &K0 &M0 &B1"); strcpy(dialSettings.phoneNumber, "555-1212");

/* set up exit handler for this task */ taskStatus = getTaskInfo(0); installExitHandler(taskStatus.taskID, shutdown);

/* Connect to the remote controller */ if (modemDial(&dialSettings, &portID) == DE_NoError)

{ do

{

/* Allow other tasks to execute */ release_processor();

}

/* Wait for initialization to complete */ modemDialStatus(com1, portID, &status, &state); while (state == DS_Calling);

/* If the remote controller connected */ if (state == DS_Connected)

{

}

/* Talk to remote controller here */

/* Terminate the connection */ modemDialEnd(com1, portID, &status);

A pause of a few seconds is required between terminating a connection and initiating a new call. This pause allows the external modem time to hang up.

Communication Protocols

The TeleBUS protocols are compatible with the widely used Modbus RTU and

ASCII protocols. The TeleBUS communication protocols provide a standard communication interface to SCADAPack controllers. Additional TeleBUS commands provide remote programming and diagnostics capability.

The TeleBUS protocols provide access to the I/O database in the controller. The

I/O database contains user-assigned registers and general purpose registers.

Assigned registers map directly to the I/O hardware or system parameter in the controller. General purpose registers can be used by ladder logic and C application programs to store processed information, and to receive information from a remote device.

The TeleBUS protocols operate on a wide variety of serial data links. These include RS-232 serial ports, RS-485 serial ports, radios, leased line modems,

Document (Version 2.51) 4/4/2011 74

Overview of Programming Functions and dial up modems. The protocols are generally independent of the communication parameters of the link, with a few exceptions.

Application programs can initiate communication with remote devices. A multiple port controller can be a data concentrator for remote devices, by polling remote devices on one port(s) and responding as a slave on another port(s).

The protocol type, communication parameters and station address are configured separately for each serial port on a controller. One controller can appear as different stations on different communication networks. The port configuration can be set from an application program, from the IEC 61131-3 programming software, or from another Modbus or DF1 compatible device.

Protocol Type

The protocol type may be set to emulate the Modbus ASCII and Modbus RTU protocols, or it may be disabled. When the protocol is disabled, the port functions as a normal serial port.

The DF1 option enables the emulation of the DF1 protocols.

Station Number

The TeleBUS protocol allows up to 254 devices on a network using standard addressing and up to 65534 devices using extended addressing. Station numbers identify each device. A device responds to commands addressed to it, or to commands broadcast to all stations.

The station number is in the range 1 to 254 for standard addressing and 1 to

65534 for extended addressing. Address 0 indicates a command broadcast to all stations, and cannot be used as a station number. Each serial port may have a unique station number.

The TeleBUS DF1 protocols allow up to 255 devices on a network. Station numbers identify each device. A device responds to commands addressed to it, or to commands broadcast to all stations. The station number is in the range 0 to

254. Address 255 indicates a command broadcast to all stations, and cannot be used as a station number. Each serial port may have a unique station number.

Store and Forward Messaging

Store and forward messaging re-transmits messages received by a controller.

Messages may be re-transmitted on any serial port, with or without station address translation. A user-defined translation table determines actions performed for each message. Store and forward messaging may be enabled or disabled on each port. It is disabled by default.

Store and forward messaging is not supported by TeleBUS DF1 protocol.

Communication Protocols Functions

There are several library functions related to TeleBUS communication protocol.

Refer to the Function Specification section for details on each function listed.

checkSFTranslationTable

Check translation table for invalid entries.

Document (Version 2.51) 4/4/2011 75

Overview of Programming Functions

clear_protocol_status Clears protocol message and error counters.

clearSFTranslationTable entries.

Clear all store and forward translation table

enronInstallCommandHandler Installs handler for Enron Modbus commands.

getABConfiguration Reads DF1 protocol configuration parameters.

get_protocol Reads protocol parameters.

getProtocolSettings Reads extended addressing protocol parameters for a serial port.

getProtocolSettingsEx Reads extended addressing and Enron Modbus protocol parameters for a serial port.

get_protocol_status Reads protocol message and error counters.

getSFMapping

getSFTranslation

This function is a stub and no longer performs a necessary operation.

Read store and forward translation table entry.

installModbusHandler This function allows user-defined extensions to standard

Modbus protocol.

master_message Sends a protocol message to another device.

modbusExceptionStatus Sets response for the read exception status function.

modbusSlaveID

pollABSlave

Sets response for the read slave ID function.

Requests a response from a slave controller using the half-duplex version of the protocol.

resetAllABSlaves

setABConfiguration

set_protocol

Clears responses from the response buffers of halfduplex slave controllers.

Defines DF1 protocol configuration parameters.

Sets protocol parameters and starts protocol.

setProtocolSettings Sets extended addressing protocol parameters for a serial port.

setProtocolSettingsEx Sets extended addressing and Enron Modbus protocol parameters for a serial port

setSFMapping

setSFTranslation

start_protocol

This function is a stub and no longer performs a necessary operation.

Write store and forward translation table entry.

Starts protocol execution based on stored parameters.

Document (Version 2.51) 4/4/2011 76

Overview of Programming Functions

Communication Protocols Macros

The ctools.h file defines macros for specifying communication protocol parameters. Refer to the C Tools Macros section for details on each macro listed.

AB_FULL_BCC

AB_FULL_CRC

AB_HALF_BCC

Specifies the DF1 Full Duplex protocol emulation for the serial port. (BCC checksum)

Specifies the DF1 Full Duplex protocol emulation for the serial port. (CRC checksum)

Specifies the DF1 Half Duplex protocol emulation for the serial port. (BCC checksum)

AB_HALF_CRC Specifies the DF1 Half Duplex protocol emulation for the serial port. (CRC checksum)

FORCE_MULTIPLE_COILS Modbus function code

FORCE_SINGLE_COIL Modbus function code

LOAD_MULTIPLE_REGISTERS Modbus function code

LOAD_SINGLE_REGISTER Modbus function code

MM_BAD_ADDRESS Master message status: invalid database address

MM_BAD_FUNCTION Master message status: invalid function code

MM_BAD_LENGTH Master message status: invalid message length

MM_BAD_SLAVE Master message status: invalid slave station address

MM_NO_MESSAGE Master message status: no message was sent.

MM_PROTOCOL_NOT_SUPPORTED Master message status: selected protocol is not supported.

MM_RECEIVED Master message status: response was received.

MM_RECEIVED_BAD_LENGTH Master message status: response received with incorrect amount of data.

MM_SENT Master message status: message was sent.

MM_EOT

MM_WRONG_RSP Master message status: AB slave response did not match command sent

MM_CMD_ACKED

Master message status: AB slave response was an EOT message

Master message status: AB half duplex command has been acknowledged by slave – Master may now send poll command

MM_EXCEPTION_FUNCTION Master message status: Modbus slave returned a function exception

MM_EXCEPTION_ADDRESS Master message status: Modbus slave returned an address exception

Document (Version 2.51) 4/4/2011 77

Overview of Programming Functions

MM_EXCEPTION_VALUE Master message status: Modbus slave returned a value exception

MODBUS_ASCII

MODBUS_RTU

NO_PROTOCOL

Specifies the Modbus ASCII protocol emulation for the serial port.

Specifies the Modbus RTU protocol emulation for the serial port.

Specifies no communication protocol for the serial port.

READ_COIL_STATUS Modbus function code

READ_EXCEPTION_STATUS Modbus function code

READ_HOLDING_REGISTER Modbus function code

READ_INPUT_REGISTER Modbus function code

READ_INPUT_STATUS Modbus function code

REPORT_SLAVE_ID Modbus function code

SF_ALREADY_DEFINED table

Result code: translation is already defined in the

SF_INDEX_OUT_OF_RANGE Result code: invalid translation table index

SF_NO_TRANSLATION Result code: entry does not define a translation

SF_PORT_OUT_OF_RANGE Result code: serial port is not valid

SF_STATION_OUT_OF_RANGE Result code: station number is not valid

SF_TABLE_SIZE

SF_VALID

Number of entries in the store and forward table

Result code: translation is valid

Communication Protocols Enumeration Types

The ctools.h file defines the enumeration type ADDRESS_MODE. Refer to the

C Tools Structures and Types section for complete information on structures and enumeration types.

Communication Protocols Structures

The ctools.h file defines the structures Protocol Status Information, Protocol

Settings, Extended Protocol Settings, Store and Forward Message and

Store and Forward Status. Refer to the C Tools Structures and Types section for complete information on structures and enumeration types.

Modbus Database

The Modbus database is a user-defined database that allows data to be shared between IEC 61131-3 C programs, IEC 61131-3 programs and communication protocols.

Two modes of addressing are supported for the database, Modbus and Linear.

The following table shows the addresses available for each type of addressing.

Document (Version 2.51) 4/4/2011 78

Overview of Programming Functions

Modbus Address Data Type

00001 to 09999

10001 to 19999

30001 to 39999

40001 to 49999 boolean

1 returned if any variable is non-zero;

0 returned if variable is 0 boolean

1 returned if any variable is non-zero;

0 returned if variable is 0 word (16 bits) word (16 bits)

Linear Word Address

0 to 624

625 to 1249

1250 to 11248

11249 to 21247

Modbus Database Functions

There are several library functions related to the Modbus database. Refer to the

IEC 61131-3 C Tools Function Specifications section for details on each

function listed.

dbase

Reads a value from the database.

installDbaseHandler Allows an extension to be defined for the dbase function.

installSetdbaseHandler

Allows an extension to be defined for the

setdbase function.

Dbase Handler Function

User-defined function that handles reading of

Modbus addresses not assigned in the IEC 61131-3

Dictionary.

setdbase

Writes a value to the database.

Setdbase Handler Function

User-defined function that handles writing to

Modbus addresses not assigned in the IEC 61131-3

Dictionary.

Database Macros

The ctools.h file defines library functions for the I/O database. Refer to the C

Tools Macros section for details on each macro listed.

AB Specifies Allan-Bradley database addressing.

DB_BADSIZE

DB_BADTYPE

DB_OK

LINEAR

Error code: out of range address specified

Error code: bad database addressing type specified

Error code: no error occurred

Specifies linear database addressing.

MODBUS

NUMAB

NUMCOIL

Specifies Modbus database addressing.

Number of registers in the Allan-Bradley database.

Number of registers in the Modbus coil section.

Document (Version 2.51) 4/4/2011 79

Overview of Programming Functions

NUMCOIL_PERMANENT Number of coil registers in the Permanent Non-

Volatile Modbus Registers section.

NUMHOLDING Number of registers in the Modbus holding register section.

NUMHOLDING_PERMANENT Number of holding registers in the Permanent

Non-Volatile Modbus Registers section

NUMINPUT Number of registers in the Modbus input registers section.

NUMLINEAR

NUMSTATUS

START_COIL

Number of registers in the linear database.

Number of registers in the Modbus status section.

Start of the coil section in the linear database.

START_HOLDING

START_INPUT

START_STATUS

Start of the holding registers section in the linear database.

Start of the input register section in the linear database.

Start of the status section in the linear database.

Modbus Addressing

When a Modbus protocol accesses a Modbus register in the controller, the register address is searched for under three categories, in the order listed below, until the address is found.

Search

Order

Category

1

2

3

IEC 61131-3

Dictionary

Variables

C/C++

Application

Database

Handler

Permanent

Non-Volatile

Modbus

Registers

Address

Range

Available

00001 to 09999

10001 to 19999

30001 to 39999

40001 to 49999

00001 to 09999

10001 to 19999

30001 to 39999

40001 to 49999

00001 to 00128

40001 to 40200

Search Algorithm

If the address is not assigned to a variable in the IEC 61131-

3 Dictionary, then search next category.

If the address is not assigned to a register in a database handler (by a C/C++ application, e.g. Flow

Computer), then search next category.

If the address is not in the range of Permanent Nonvolatile Modbus Registers, then a Modbus Exception response may be returned.

The setResp function is used to control the exception response.

Document (Version 2.51) 4/4/2011 80

Overview of Programming Functions

If the address is not found in the IEC 61131-3 dictionary or the C/C++ Application

Database Handler, a Modbus Exception response may be returned. An address is not found when it has not been defined with one of the above listed categories.

If the address is defined in more than one category, the first occurrence of the address in the order listed is used. The user can configure the setResp function to do one of the following.

• An exception is sent when an unavailable register is read or written.

• A zero is returned when an unavailable register is read and writing an unavailable register has no effect

Each category is described in the following sections.

IEC 61131-3 Dictionary Variables

When an IEC 61131-3 application is being downloaded or re-started, the

Dictionary variables are temporarily undefined. If a protocol accesses the controller while the Dictionary is undefined, the protocol will return a Modbus

Exception. Most polling masters will simply log this as a command error and retry the protocol command until the Dictionary is no longer undefined.

When an address from the range of Permanent Non-Volatile Registers is used as the Network Address for a variable in the IEC 61131-3 Dictionary, Modbus protocols will access this address from the Dictionary instead of from the

Permanent Registers. However, when the IEC 61131-3 application is being downloaded or re-started, the Dictionary will be temporarily undefined. If a protocol accesses the controller while the Dictionary is undefined, the protocol will search and find a different value for the register under the Permanent Non-

Volatile Registers. If this scenario is expected, assign Dictionary network addresses outside the range of Permanent Registers.

C/C++ Application Database Handler

A C/C++ application may install a Database Handler to define Modbus registers.

This creates registers without having to create an IEC 61131-3 Dictionary of variables.

When a C/C++ application is being downloaded or is stopped, the database handler is temporarily uninstalled. If a protocol accesses the controller while the handler is uninstalled, the protocol will return a Modbus Exception. Most polling masters will simply log this as a command error and retry the protocol command until the database handler is installed.

When an address from the range of Permanent Non-Volatile Registers is also defined in a database handler in a C/C++ application, Modbus protocols will access this address from the database handler instead of from the Permanent

Registers. However, when the C/C++ application is being downloaded or is stopped, the database handler will be temporarily uninstalled. If a protocol accesses the controller while the handler is uninstalled, the protocol will search and find a different value for the register under the Permanent Non-Volatile

Registers. If this scenario is expected, only define registers in a database handler for addresses outside the range of Permanent Registers.

Document (Version 2.51) 4/4/2011 81

Overview of Programming Functions

Permanent Non-Volatile Modbus Registers

By default, the controller has a selection of Modbus registers already defined.

These are the Permanent Non-volatile Modbus Registers and consist of the following:

Register Type Address Range

Coil Registers

Holding Registers

00001 to 10128

40001 to 40200

These registers reside in non-volatile memory so they retain their values when the controller is reset or while an IEC 61131-3 application or C/C++ application is being downloaded. These registers may be used to store data during application downloads.

To initialize all Permanent Registers to zero, select Initialize Controller from the

Initialize Controller dialog. This dialog is selected using the Controller | Initialize command from the Tools menu on the Programs window. The Permanent

Registers are also set to zero on a Cold Boot.

DNP Communication Protocol

DNP, the Distributed Network Protocol, is a standards-based communications protocol developed to achieve interoperability among systems in the electric utility, oil & gas, water/waste water and security industries. This robust, flexible non-proprietary protocol is based on existing open standards to work within a variety of networks. The IEEE has recommended DNP for remote terminal unit to intelligent electronic device messaging. DNP can also be implemented in any

SCADA system for efficient and reliable communications between substation computers, RTUs, IEDs and master stations; over serial or LAN-based systems.

DNP offers flexibility and functionality that go far beyond conventional communications protocols. Among its robust and flexible features DNP 3.0 includes:

• Output options

• Addressing for over 65,000 devices on a single link

• Time synchronization and time-stamped events

• Broadcast messages

• Data link and application layer confirmation

DNP 3.0 was originally designed based on three layers of the OSI seven-layer model: application layer, data link layer and physical layer. The application layer is object-based with objects provided for most generic data formats. The data link layer provides for several methods of retrieving data such as polling for classes and object variations. The physical layer defines most commonly a simple RS-

232 or RS-485 interface.

Refer to the DNP User Manual for complete information on DNP protocol, including the Device Profile Document.

Document (Version 2.51) 4/4/2011 82

Overview of Programming Functions

DNP Communication Protocols Functions

There are several library functions related to DNP communication protocol. Refer to the Function Specification section for details on each function listed.

dnpInstallConnectionHandler Configures the connection handler for DNP.

dnpClearEventLog

Deletes all change events from the DNP change event buffers.

dnpConnectionEvent Report a DNP connection event

dnpCreateRoutingTable

Allocates memory for a new routing table.

dnpGenerateEventLog Generates a change event for the DNP point.

dnpGetConfiguration Reads the DNP protocol configuration.

dnpGetConfigurationEx

Reads the extended DNP configuration parameters.

dnpSaveConfiguration Writes the DNP protocol configuration parameters.

dnpSaveConfigurationEx

Writes the extended DNP configuration parameters

dnpGetBIConfig Reads the configuration of a DNP binary input point.

dnpSaveBIConfig Writes the configuration of a DNP binary input point.

dnpSaveBIConfigEx Writes the configuration of an extended DNP Binary

Input point

dnpGetBOConfig Reads the configuration of a DNP binary output point.

dnpGetBIConfigEx Reads the configuration of an extended DNP Binary

Input point.

dnpSaveBOConfig Sets the configuration of a DNP binary output point.

dnpGetAI16Config Reads the configuration of a DNP 16-bit analog input point.

dnpSaveAI16Config Sets the configuration of a DNP 16-bit analog input point.

dnpGetAI32Config Reads the configuration of a DNP 32-bit analog input point.

dnpSaveAISFConfig Sets the configuration of a DNP 32-bit short floating analog input point

dnpGetAISFConfig

Reads the configuration of a DNP 32-bit short floating analog input point.

dnpSaveAI32Config Sets the configuration of a DNP 32-bit analog input point.

dnpGetAO16Config Reads the configuration of a DNP 16-bit analog output point.

Document (Version 2.51) 4/4/2011 83

Overview of Programming Functions

dnpSaveAO16Config Sets the configuration of a DNP 32-bit analog output point.

dnpGetAO32Config Reads the configuration of a DNP 32-bit analog output point.

dnpSaveAO32Config Sets the configuration of a DNP 32-bit analog output point.

dnpSaveAOSFConfig Sets the configuration of a DNP 32-bit short floating analog output point.

dnpGetAOSFConfig

Sets the configuration of a DNP 32-bit short floating analog output point.

dnpGetCI16Config Reads the configuration of a DNP 16-bit counter input point.

dnpSaveCI16Config Sets the configuration of a DNP 16-bit counter input point.

dnpGetCI32Config Reads the configuration of a DNP 32-bit counter input point.

dnpSaveCI32Config Sets the configuration of a DNP 32-bit counter input point.

dnpGetRuntimeStatus Reads the current status of all DNP change event buffers.

dnpSendUnsolicited Sends an ‘Unsolicited Response’ message in DNP protocol.

dnpSendUnsolicitedResponse Sends an Unsolicited Response message in DNP, with data from the specified classes.

dnpWriteRoutingTableEntry Wwrites an entry in the DNP routing table.

dnpReadRoutingTableEntry Reads an entry from the routing table.

dnpReadRoutingTableSize

Reads the total number of entries in the routing table.

dnpSearchRoutingTable

Searches the routing table for a specific DNP address.

dnpWriteRoutingTableDialStrings Writes a primary and secondary dial string into an entry in the DNP routing table.

dnpReadRoutingTableDialStrings Reads a primary and secondary dial string from an entry in the DNP routing table.

DNP Communication Protocol Structures and Types

The ctools.h file defines the structures DNP Configuration, Binary Input Point,

Binary Output Point, Analog Input Point, Analog Output Point and Counter Input

Point. Refer to the C Tools Structures and Types section for complete information on structures and enumeration types.

Document (Version 2.51) 4/4/2011 84

Overview of Programming Functions

IEC 61131-3 Variable Access Functions

Variables declared in an IEC 61131-3 application are accessed from a C application using the IEC 61131-3 variable access functions listed below. Refer

to the IEC 61131-3 C Tools Function Specifications section for details on each

function listed.

readBoolVariable readIntVariable

Returns the current value of the specified boolean variable.

Returns the current value of the specified integer variable.

readRealVariable readMsgVariable readTimerVariable

Returns the current value of the specified real variable.

Returns the current value of the specified message variable.

Returns the current value of the specified timer variable.

writeBoolVariable writeIntVariable writeRealVariable writeMsgVariable

Writes to the specified boolean variable.

Writes to the specified integer variable.

Writes to the specified real variable.

Writes to the specified message variable.

writeTimerVariable

Writes to the specified timer variable.

HART Communication

The HART ® protocol is a field bus protocol for communication with smart transmitters.

The HART protocol driver provides communication between TeleSAFE Micro16 and SCADAPack controllers and HART devices. The protocol driver uses the model 5904 HART modem for communication. Four HART modem modules are supported per controller.

The driver allows HART transmitters to be used with C application programs and with Realflo. The driver can read data from HART devices.

HART Command Functions

The ctools.h file defines the following HART command related functions. Refer to the Function Specification section for details on each function listed.

hartIO Reads data from the 5904 interface module, processes

HART responses, processes HART commands, and writes commands and configuration data to the 5904 interface module.

hartCommand send a HART command string and specify a function to handle the response

hartCommand0 read unique identifier using short-address algorithm

Document (Version 2.51) 4/4/2011 85

Overview of Programming Functions

hartCommand1

hartCommand2 read primary variable read primary variable current and percent of span

hartCommand3

hartCommand11

hartCommand33

hartStatus read primary variable current and dynamic variables read unique identifier associated with tag read specified transmitter variables return status of last HART command sent

hartGetConfiguration read HART module settings

hartSetConfiguration write HART module settings

hartPackString convert string to HART packed string

hartUnpackString convert HART packed string to string

HART Command Macros

The ctools.h file defines the following macro of interest to a C application program. Refer to the C Tools Macros section for details.

DATA_SIZE Maximum length of the HART command or response field.

HART Command Enumeration Types

The ctools.h file defines one enumeration type. The HART_RESULT enumeration type defines a list of results of sending a command. Refer to the C

Tools Structures and Types section for complete information on structures and enumeration types.

HART Command Structures

The ctools.h file defines five structures. Refer to the C Tools Structures and

Types section for complete information on structures and enumeration types.

The HART_DEVICE type is a structure containing information about the HART device.

The HART_VARIABLE type is a structure containing a variable read from a

HART device.

The HART_SETTINGS type is a structure containing the configuration for the

HART modem module.

The HART_COMMAND type is a structure containing a command to be sent to a

HART slave device.

The HART_RESPONSE type is a structure containing a response from a HART slave device.

Document (Version 2.51) 4/4/2011 86

IEC 61131-3 C Tools Function Specifications

IEC 61131-3 C Tools Function Specifications

The controller C function specifications are formatted as follows. The functions are listed alphabetically.

Name Each specification begins with the name of the function and a brief description.

Syntax The syntax shows a prototype for the function, indicating the return type and the types of its arguments. Any necessary header files are listed.

Description This defines the calling parameters for the function and its return values.

Notes This section contains additional information on the function, and considerations for its use.

See Also This section lists related functions.

Example The example gives a brief sample of the use of the function.

Document (Version 2.51) 4/4/2011 87

IEC 61131-3 C Tools Function Specifications

alarmIn

Determine Alarm Time from Elapsed Time

Syntax

#include <ctools.h>

ALARM_SETTING alarmIn(unsigned hours, unsigned minutes, unsigned

seconds);

Description

The alarmIn function calculates the alarm settings to configure a real time clock alarm to occur in hours, minutes and seconds from the current time.

The function returns an ALARM_SETTING structure suitable for passing to the

setClockAlarm function. The structure specifies an absolute time alarm at the time offset specified by the call to alarmIn. Refer to the Structures and Types section for a description of the fields in the ALARM_SETTING structure.

Notes

If second is greater than 60 seconds, the additional time is rolled into the minutes. If minute is greater than 60 minutes, the additional time is rolled into the hours.

If the offset time is greater that one day, then the alarm time will roll over within the current day.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

getClockAlarm, setClockAlarm,

Example

#include <ctools.h>

/* --------------------------------------------

conservePower

The conservePower function places the

controller into sleep mode for 10 minutes.

-------------------------------------------- */ void conservePower(void)

{

ALARM_SETTING alarm; request_resource(IO_SYSTEM);

/* Alarm in 10 minutes */ alarm = alarmIn(0, 10, 0); setClockAlarm(alarm)

/* Put controller in low power mode */

Document (Version 2.51) 4/4/2011 88

}

IEC 61131-3 C Tools Function Specifications sleep(); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 89

IEC 61131-3 C Tools Function Specifications

allocate_envelope

Obtain an Envelope from the RTOS

Syntax

#include <ctools.h>envelope *allocate_envelope(void);

Description

The allocate_envelope function obtains an envelope from the operating system.

If no envelope is available, the task is blocked until one becomes available.

The allocate_envelope function returns a pointer to the envelope.

Notes

Envelopes are used to send messages between tasks. The RTOS allocates envelopes from a pool of free envelopes. It returns envelopes to the pool when they are de-allocated.

An application program needs to ensure that unneeded envelopes are deallocated. Envelopes may be reused.

See Also

deallocate_envelope

}

Example

#include <ctools.h> extern unsigned other_task_id; void task1(void)

{ envelope *letter;

/* send a message to another task */

/* assume it will deallocate the envelope */ letter = allocate_envelope(); letter->destination = other_task_id; letter->type = MSG_DATA; letter->data = 5; send_message(letter);

/* receive a message from any other task */ letter = receive_message();

/* ... process the data here */ deallocate_envelope(letter);

/* ... the rest of the task */

Document (Version 2.51) 4/4/2011 90

IEC 61131-3 C Tools Function Specifications

check_error

Get Error Code for Current Task

Syntax

#include <ctools.h> int check_error(void);

Description

The check_error function returns the error code for the current task. The error code is set by various I/O routines, when errors occur. A separate error code is maintained for each task.

Notes

Some routines in the standard C library, return errors in the global variable errno.

This variable is not unique to a task, and may be modified by another task, before it can be read.

See Also

report_error

Document (Version 2.51) 4/4/2011 91

IEC 61131-3 C Tools Function Specifications

checksum

Calculate a Checksum

Syntax

#include <ctools.h> unsigned checksum(unsigned char *start, unsigned char *end, unsigned algorithm);

Description

The checksum function calculates a checksum on memory. The memory starts at the byte pointed to by start, and ends with the byte pointed to by end. The

algorithm may be one of:

ADDITIVE

CRC_16

16 bit byte-wise sum

CRC-16 polynomial checksum

CRC_CCITT CRC-CCITT polynomial checksum

BYTE_EOR 8 bit byte-wise exclusive OR

The CRC checksums use the crc_reverse function.

See Also

crc_reverse

Example

This function displays two types of checksums.

#include <ctools.h> void checksumExample(void)

{ char str[] = "This is a test"; unsigned sum;

/* Display additive checksum */ sum = checksum(str, str+strlen(str), ADDITIVE); printf("Additive checksum: %u\r\n", sum);

/* Display CRC-16 checksum */ sum = checksum(str, str+strlen(str), CRC_16); printf("CRC-16 checksum: %u\r\n", sum);

}

Document (Version 2.51) 4/4/2011 92

IEC 61131-3 C Tools Function Specifications

checkSFTranslationTable

Test for Store and Forward Configuration Errors

Syntax

#include <ctools.h> struct SFTranslationStatus checkSFTranslationTable(void);

Description

The checkSFTranslationTable function checks all entries in the address translation table for validity. It detects the following errors:

The function returns a SFTranslationStatus structure. Refer to the Structures

and Types section for a description of the fields in the SFTranslationStatus structure. The code field of the structure is set to one of the following. If there is an error, the index field is set to the location of the translation that is not valid.

Result code Meaning

SF_VALID

SF_STATION_OUT_OF_

RANGE

All translations are valid

SF_NO_TRANSLATION The entry defines re-transmission of the same message on the same port

SF_PORT_OUT_OF_RA

NGE

One or both of the serial port indexes is not valid

One or both of the stations is not valid

Notes

The TeleBUS Protocols User Manual describes store and forward messaging mode.

See Also

getSFTranslation, checkSFTranslationTable

Example

See the example for the setSFTranslation function.

Document (Version 2.51) 4/4/2011 93

IEC 61131-3 C Tools Function Specifications

clear_errors

Clear Serial Port Error Counters

Syntax

#include <ctools.h> void clear_errors(FILE *stream);

Description

The clear_errors function clears the serial port error counters for the serial port specified by stream. If stream does not point to a valid serial port the function has no effect.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

get_status

Document (Version 2.51) 4/4/2011 94

IEC 61131-3 C Tools Function Specifications

clear_protocol_status

Clear Protocol Counters

Syntax

#include <ctools.h> void clear_protocol_status(FILE *stream);

Description

The clear_protocol_status function clears the error and message counters for the serial port specified by stream. If stream does not point to a valid serial port the function has no effect.

The IO_SYSTEM resource needs to be requested before calling this function.

Document (Version 2.51) 4/4/2011 95

IEC 61131-3 C Tools Function Specifications

clearSFTranslationTable

Clear Store and Forward Translation Configuration

Syntax

#include <ctools.h> void clearSFTranslationTable(void);

Description

The clearSFTranslationTable function clears all entries in the store and forward translation table.

Notes

The TeleBUS Protocols User Manual describes store and forward messaging mode.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

getSFTranslation, checkSFTranslationTable

Example

See the example for the setSFTranslation function.

Document (Version 2.51) 4/4/2011 96

IEC 61131-3 C Tools Function Specifications

clearStatusBit

Clear Bits in Controller Status Code

Syntax

#include <ctools.h> unsigned clearStatusBit(unsigned bitMask);

Description

The clearStatusBit function clears the bits indicated by bitMask in the controller status code. When the status code is non-zero, the STAT LED blinks a binary sequence corresponding to the code. If code is zero, the STAT LED turns off.

The function returns the value of the status register.

Notes

The status output opens if code is non-zero. Refer to the System Hardware

Manual for more information.

The binary sequence consists of short and long flashes of the error LED. A short flash of 1/10th of a second indicates a binary zero. A longer flash of approximately 1/2 of a second indicates a binary one. The least significant digit is output first. As few bits as possible are displayed, leading zeros are ignored.

There is a two-second delay between repetitions.

The STAT LED is the LED located on the top left hand corner of the 5203 or

5204 controller board.

The Register Assignment uses bits 0 and 1 of the status code.

See Also

setStatusBit, setStatus, getStatusBit

Document (Version 2.51) 4/4/2011 97

IEC 61131-3 C Tools Function Specifications

clear_tx

Clear Serial Port Transmit Buffer

Syntax

#include <ctools.h> void clear_tx(FILE *stream);

Description

The clear_tx function clears the transmit buffer for the serial port specified by

stream. If stream does not point to a valid serial port the function has no effect.

See Also

get_status

Document (Version 2.51) 4/4/2011 98

IEC 61131-3 C Tools Function Specifications

configurationRegisterMapping

Enable or disable mapping of device configuration registers.

Syntax

#include <ctools.h> void configurationRegisterMapping(

BOOLEAN enabled

);

Description

This function enables or disables mapping of device configuration registers.

These registers are located at a fixed location in the input register area. enabled selects if the registers are mapped. Valid values are TRUE and FALSE.

Selecting FALSE hide the configuration data but does not change it.

See Also

configurationSetApplicationID

Document (Version 2.51) 4/4/2011 99

IEC 61131-3 C Tools Function Specifications

configurationSetApplicationID

Set an application ID.

Syntax

#include <ctools.h>

BOOLEAN configurationSetApplicationID(

UINT16 applicationType,

UINT16 action,

UINT16 companyID,

);

UINT16 application,

UINT16 version

Description

This function stores or removes an application ID in the device configuration data. The device configuration appears in Modbus registers if the register mapping is enabled. applicationType specifies the type of application. It is one of DCAT_LOGIC1,

DCAT_LOGIC2, or DCAT_C.

• DCAT_LOGIC1: Device configuration application type is the first logic application.

• DCAT_LOGIC2: Device configuration application type is the second logic application.

• DCAT_C: Device configuration application type is a C application.

If DCAT_C is used, the application ID is added to the table of C applications. The applications don’t appear in any fixed order in the C application table. action specifies if the ID is to be added or removed. Valid values are DCA_ADD and DCA_REMOVE.

• DCA_ADD: attempting to add a duplicate value (matching companyID, application, and version) will result in only one entry in the table. The function will return TRUE (indicating the data is in the table).

• DCA_REMOVE: For logic applications the ID will be removed unconditionally. For C applications, the ID will be removed if it is found in the table (matching companyID, application, and version). companyID specifies your company. Contact Control Microsystems to obtain a company ID. 0 indicates an unused entry. application specifies your application. Valid values are 0 to 65535. You need to maintain unique values for your company. version is the version of your application in the format major * 100 + minor. Valid values are 0 to 65535.

The function returns TRUE if the action was successful, and FALSE if an error occurred.

Document (Version 2.51) 4/4/2011 100

IEC 61131-3 C Tools Function Specifications

Register Mapping

The Device configuration is stored in Modbus input (3xxxx) registers as shown below. The registers are read with standard Modbus commands. These registers cannot be written to. Device configuration registers used fixed addresses. This facilitates identifying the applications in a standard manner.

The Device configuration registers can be enabled or disabled by entering a 0 or

1 in the Start Register. They are disabled until enabled by a logic application.

This provides compatibility with controllers that have already used these registers for other purposes.

The application IDs are cleared on every controller reset. Applications need to run and set the application ID for it to be valid.

These data types are used.

Data Type Description

uint uchar

type[n]

Unsigned 16–bit integer

Unsigned 8–bit character n–element array of specified data type

The following information is stored in the device configuration. 2 logic application identifiers are provided for compatibility with SCADAPack ES/ER controllers that provide 2 IEC 61131-3 applications. The second logic application identifier is not used with other controllers. 32 application identifiers are provided to accommodate C applications in SCADAPack 330/350 controllers.

Register Data Type

39800 uchar[8]

39808

39809

39810

39813

39816

39817

39820

39823

39826

39829

39832

39835

39838

39841 uint uint uint[3] uint[3] uint uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3]

Description

Controller ID (padded with nulls = 0), first byte in lowest register, one byte per register.

Firmware version (major*100 + minor)

Firmware version build number (if applicable)

Logic application 1 identifier (see format below)

Logic application 2 identifier (see format below)

Number of applications identifiers used (0 to 32)

Identifiers are listed sequentially starting with identifier 1. Unused identifiers will return 0.

Application identifier 1 (see format below)

Application identifier 2 (see format below)

Application identifier 3 (see format below)

Application identifier 4 (see format below)

Application identifier 5 (see format below)

Application identifier 6 (see format below)

Application identifier 7 (see format below)

Application identifier 8 (see format below)

Application identifier 9 (see format below)

Document (Version 2.51) 4/4/2011 101

Register Data Type

39844

39847

39850

39853

39856

39859

39862

39865

39868

39871

39874

39877

39880

39883

39886

39889

39892

39895

39898

39901

39904

39907

39910

39913 to

39999 uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3] uint[3]

IEC 61131-3 C Tools Function Specifications

Description

Application identifier 10 (see format below)

Application identifier 11 (see format below)

Application identifier 12 (see format below)

Application identifier 13 (see format below)

Application identifier 14 (see format below)

Application identifier 15 (see format below)

Application identifier 16 (see format below)

Application identifier 17 (see format below)

Application identifier 18 (see format below)

Application identifier 19 (see format below)

Application identifier 20 (see format below)

Application identifier 21 (see format below)

Application identifier 22 (see format below)

Application identifier 23 (see format below)

Application identifier 24 (see format below)

Application identifier 25 (see format below)

Application identifier 26 (see format below)

Application identifier 27 (see format below)

Application identifier 28 (see format below)

Application identifier 29 (see format below)

Application identifier 30 (see format below)

Application identifier 31 (see format below)

Application identifier 32 (see format below)

Reserved for future expansion

Application Identifier

The application identifier is formatted as follows.

Data Type

uint uint uint

Description

Company ID (see below)

Application number (0 to 65535)

Application version (major*100 + minor)

Company Identifier

Control Microsystems will maintain a list of company identifiers to ensure the company ID is unique. Contact the technical support department.

Company ID 0 indicates an identifier is unused.

Document (Version 2.51) 4/4/2011 102

See Also

configurationRegisterMapping

IEC 61131-3 C Tools Function Specifications

Notes

Application IDs for C programs are not automatically removed. A task exit handler can be used to remove the ID when the C application is ended.

Application IDs are cleared when the controller is reset.

Document (Version 2.51) 4/4/2011 103

IEC 61131-3 C Tools Function Specifications

crc_reverse

Calculate a CRC Checksum

Syntax

#include <ctools.h> unsigned crc_reverse(unsigned char *start, unsigned char *end, unsigned poly, unsigned initial);

Description

The crc_reverse function calculates a CRC type checksum on memory using the reverse algorithm. The memory starts at the byte pointed to by start, and ends with the byte pointed to by end. The generator polynomial is specified by poly.

poly may be any value, but needs to be carefully chosen to ensure good error detection. The checksum accumulator is set to initial before the calculation is started.

Notes

The reverse algorithm is named for the direction bits are shifted. In the reverse algorithm, bits are shifted towards the least significant bit. This produces different checksums than the classical, or forward algorithm, using the same polynomials.

See Also

checksum

Document (Version 2.51) 4/4/2011 104

IEC 61131-3 C Tools Function Specifications

createRoutingTable

Create Routing Table

Syntax

#include <ctools.h>

BOOLEAN createRoutingTable (UINT16 size);

Description

This function destroys any existing DNP routing table, and allocates memory for a new routing table according to the ‘size’ parameter.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

The function returns TRUE if successful, FALSE otherwise.

Example

See the example in the dnpSendUnsolicited section.

Document (Version 2.51) 4/4/2011 105

create_task

Create a New Task

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> int create_task(void *function, unsigned priority, unsigned type, unsigned stack);

Description

The create_task function allocates stack space for a task and places the task on the ready queue. function specifies the start address of the routine to be executed. The task will execute immediately if its priority is higher than the current task.

priority is an execution priority between 1 and 4 for the created task. The 4 task priority levels aid in scheduling task execution.

type specifies if the task is ended when an application program is stopped. Valid values for type are:

SYSTEM system tasks do not terminate when the program stops

APPLICATION application tasks terminate when the program stops

It is recommended that only APPLICATION type tasks be created.

The stack parameter specifies how many stack blocks are allocated for the task.

Each stack block is 256 bytes.

The create_task function returns the task ID (TID) of the task created. If an error occurs, -1 is returned.

Notes

Refer to the Real Time Operating System section for more information on tasks.

The main task and the Ladder Logic and I/O scanning task have a priority of 1. If the created task is continuously running processing code, create the task with a priority of 1 and call release_processor periodically; otherwise the remaining priority 1 tasks will be blocked from executing.

For tasks such as a protocol handler, that wait for an event using the wait_event or receive_message function, a priority greater than 1 may be selected without blocking other lower priority tasks.

The number of stack blocks required depends on the functions called within the task, and the size of local variables created. Most tasks require 2 stack blocks. If any of the printf functions are used, then at least 4 stack blocks are required.

Add local variable usage to these limits, if large local arrays or structures are created. Large structures and arrays are usually best handled as static global variables within the task source file. (The variables are global to all functions in the task, but cannot be seen by functions in other files.)

Document (Version 2.51) 4/4/2011 106

IEC 61131-3 C Tools Function Specifications

Additional stack space may be made available by disabling unused protocol tasks. See the section Program Development or the set_protocol() function for more information.

See Also

end_task

Example

#include <ctools.h>

#define TIME_TO_PRINT 20 void task1(void)

{ int a, b; while (TRUE)

{

/* body of task 1 loop - processing I/O */ request_resource(IO_SYSTEM); a = dbase(MODBUS, 30001);

{ b = dbase(MODBUS, 30002); setdbase(MODBUS, 40020, a * b); release_resource(IO_SYSTEM);

}

/* Allow other tasks to execute */ release_processor();

} void task2(void) while(TRUE)

{

}

/* body of task 2 loop - event handler */ wait_event(TIME_TO_PRINT); printf("It’s time for a coffee break\r\n");

}

/* --------------------------------------------

The shutdown function stops the signalling

of TIME_TO_PRINT events when application is stopped.

-------------------------------------------- */ void shutdown(void)

{ endTimedEvent(TIME_TO_PRINT);

} void main(void)

{

TASKINFO taskStatus;

Document (Version 2.51) 4/4/2011 107

}

IEC 61131-3 C Tools Function Specifications

/* continuos processing task at priority 1 */ create_task(task1, 1, APPLICATION, 2);

/* event handler needs larger stack for printf function */ create_task(task2, 3, APPLICATION, 4);

/* set up task exit handler to stop

signalling of events when this task ends */ taskStatus = getTaskInfo(0); installExitHandler(taskStatus.taskID, shutdown);

/* start timed event to occur every 10 sec */ startTimedEvent(TIME_TO_PRINT, 100); interval(0, 10); while(TRUE)

{

}

/* body of main task loop */

/* other processing code */

/* Allow other tasks to execute */ release_processor();

Document (Version 2.51) 4/4/2011 108

IEC 61131-3 C Tools Function Specifications

databaseRead

Read Value from I/O Database

Syntax

#include <ctools.h>

BOOLEAN databaseRead(UINT16 type, UINT16 address, INT16* value)

Description

The databaseRead function reads a value from the database. type specifies the method of addressing the database. address specifies the location in the database. If the specified address is valid then TRUE is returned and the value is copied to the variable pointed to by value. If the specified address is not valid then FALSE is returned and the variable pointed to by value is left unchanged.

The table below shows the valid address types and ranges.

Type Address Ranges Register

Size

MODBUS 00001 to NUMCOIL

10001 to 10000 + NUMSTATUS

30001 to 30000 + NUMINPUT

40001 to 40000 + NUMHOLDING

1 bit

1 bit

16 bit

16 bit

LINEAR 0 to NUMLINEAR-1 16 bit

If the specified address is in the valid range but it has not been defined by an application, then the address is also invalid. An address is defined if any of the following is true:

• The address has been assigned as the Network Address for an IEC 61131-3

Dictionary variable.

• The address is defined in a database handler installed by a C or C++ application.

• The address is within the default range of the Permanent Non-volatile

Modbus Registers: 40001 to 40000 + NUMHOLDING_PERMANENT, and

00001 to NUMCOIL_PERMANENT.

When this function is called, the specified address is searched for under these three categories in the order listed above until the address is found. If the address is not found, FALSE is returned. If the address is defined in more than one of these categories, the first occurrence of the address in the order listed is used.

Notes

Refer to the section Permanent Non-Volatile Modbus Registers for details on potential addressing conflicts during application downloading.

The IO_SYSTEM resource needs to be requested before calling this function.

Document (Version 2.51) 4/4/2011 109

IEC 61131-3 C Tools Function Specifications

See Also

databaseWrite, setdbase

Example

}

#include <ctools.h> void main(void)

{

INT16 value;

BOOLEAN status; request_resource(IO_SYSTEM);

/* Read Modbus status input point */ status = databaseRead(MODBUS, 10001, &value);

/* Read 16 bit register */ status = databaseRead(LINEAR, 3020, &value);

/* Read 16 bit register beginning at first status register */ status = databaseRead(LINEAR, START_STATUS, &value);

/* Read 6th input register */ status = databaseRead(LINEAR, START_INPUT+5, &value); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 110

IEC 61131-3 C Tools Function Specifications

databaseWrite

Write Value to I/O Database

Syntax

#include <ctools.h>

BOOLEAN databaseWrite(UINT16 type, UINT16 address, INT16 value)

Description

The databaseWrite function writes value to the I/O database. type specifies the method of addressing the database. address specifies the location in the database. If the specified address is valid then TRUE is returned and the value is written. If the specified address is not valid then FALSE is returned and nothing is done.

The table below shows the valid address types and ranges.

Type Address Ranges Register

Size

MODBUS 00001 to NUMCOIL

10001 to 10000 + NUMSTATUS

30001 to 30000 + NUMINPUT

40001 to 40000 + NUMHOLDING

1 bit

1 bit

16 bit

16 bit

LINEAR 0 to NUMLINEAR-1 16 bit

If the specified address is in the valid range but it has not been defined by an application, then the address is also invalid. An address is defined if any of the following is true:

• The address has been assigned as the Network Address for an IEC 61131-3

Dictionary variable.

• The address is defined in a database handler installed by a C or C++ application.

• The address is within the default range of the Permanent Non-volatile

Modbus Registers: 40001 to 40000 + NUMHOLDING_PERMANENT, and

00001 to NUMCOIL_PERMANENT.

When this function is called, the specified address is searched for under these three categories in the order listed above until the address is found. If the address is not found, FALSE is returned. If the address is defined in more than one of these categories, the first occurrence of the address in the order listed is used.

Notes

Refer to the section Permanent Non-Volatile Modbus Registers for details on potential addressing conflicts during application downloading.

Document (Version 2.51) 4/4/2011 111

IEC 61131-3 C Tools Function Specifications

When writing to LINEAR digital addresses, value is a bit mask which writes data to 16 1-bit registers at once. If any of these 1-bit registers is invalid, only the valid registers are written and FALSE is returned.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

databaseRead, setdbase

Example

}

#include <ctools.h> void main(void)

{

BOOLEAN status; request_resource(IO_SYSTEM); status = databaseWrite(MODBUS, 40001, 102);

/* Turn ON the first 16 coils */ status = databaseWrite(LINEAR, START_COIL, 255);

/* Write to a 16 bit register */ status = databaseWrite(LINEAR, 3020, 240);

/* Write to the 12th holding register */ status = databaseWrite(LINEAR, START_HOLDING+11, 330); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 112

IEC 61131-3 C Tools Function Specifications

datalogCreate

Create Data Log Function

Syntax

#include <ctools.h>

DATALOG_STATUS datalogCreate(

UINT16 logID,

DATALOG_CONFIGURATION * pLogConfiguration

);

Description

This function creates a data log with the specified configuration. The data log is created in the data log memory space.

The function has two parameters. logID specifies the data log to be created. The valid range is 0 to 15. pLogConfiguration points to a structure with the configuration for the data log.

The function returns the status of the operation.

Notes

The configuration of an existing data log cannot be changed. The log needs to be deleted and recreated to change the configuration.

Data logs are stored in memory from a pool for all data logs. If there is insufficient memory the creation operation fails. The function returns DLS_NOMEMORY.

If the data log already exists the creation operation fails. The function returns

DLS_EXISTS.

If the log ID is not valid the creation operation fails. The function returns

DLS_BADID.

If the configuration is not valid the creation operation fails. The function returns

DLS_BADCONFIG.

See Also

datalogDelete, datalogSettings

Example

/*----------------------------------------------

The following code shows how to create a

data log and how to write one record into it.

----------------------------------------------*/

#include "ctools.h"

/*---------------------------------

Structure used only to copy one

record into data log

---------------------------------*/ struct dataRecord

Document (Version 2.51) 4/4/2011 113

IEC 61131-3 C Tools Function Specifications

{

UINT16 value1; int value2; double value3; float value4; float value5;

}; int logID;

/*---------------------------------

Declare a structure for the log

---------------------------------*/

DATALOG_CONFIGURATION dLogConfig;

/*---------------------------------

Declare a struture to hold the

data that will be copied in log

---------------------------------*/ struct dataRecord data;

/*---------------------

Function declaration

----------------------*/ void ConfigureLog(void); void InitRecord(void); void main(void)

{

*/

ConfigureLog(); /* function call to cofigure log

InitRecord(); if(datalogCreate(logID, &dLogConfig) == DLS_CREATED)

{

/* Start writing records in log */ if( datalogWrite(logID, (UINT16 *)&data) )

{

}

/* one record was written in data log */

}

}

/* Log configuration */ void ConfigureLog(void)

{

/* Assign a number to the data log */ logID = 10;

}

/* Fill in the log configuration structure */ dLogConfig.records = 200; dLogConfig.fields = 5; dLogConfig.typesOfFields[0] = DLV_UINT16; dLogConfig.typesOfFields[1] = DLV_INT32; dLogConfig.typesOfFields[2] = DLV_DOUBLE; dLogConfig.typesOfFields[3] = DLV_FLOAT; dLogConfig.typesOfFields[4] = DLV_FLOAT;

/* One record initialization */

Document (Version 2.51) 4/4/2011 114

IEC 61131-3 C Tools Function Specifications void InitRecord(void)

{

/* Assign some data for the log */ data.value1 = 100; data.value2 = 200; data.value3 = 30000;

} data.value4 = 40.3; data.value5 = 50.75;

Document (Version 2.51) 4/4/2011 115

IEC 61131-3 C Tools Function Specifications

datalogDelete

Delete Data Log Function

Syntax

#include <ctools.h>

BOOLEAN datalogDelete(

UINT16 logID

);

Description

This function destroys the specified data log. The memory used by the data log is returned to the freed.

The function has one parameter. logID specifies the data log to be deleted. The valid range is 0 to 15.

The function returns TRUE if the data log was deleted. The function returns

FALSE if the log ID is not valid or if the log had not been created.

See Also

datalogCreate

Example

/* The following code shows the only way to

change the configuration of an existing log

is to delete the log and recreate the data

log */

#include <ctools.h> int logID;

/* Declare a structure for the log */

DATALOG_CONFIGURATION dLogConfig;

/* Select logID #10 */ logID = 10;

/* Read the configuration of logID #10 */ if( datalogSettings( logID, &dLogConfig ) )

{

if(dLogConfig.typesOfFields[0] == DLV_INT16)

{

/* Wrong type. Delete whole log and start from scratch */

if(datalogDelete(logID) )

{

/* Re-enter the log configuration */ dLogConfig.records = 200; dLogConfig.fields = 5; dLogConfig.typesOfFields[0] = DLV_UINT16;

Document (Version 2.51) 4/4/2011 116

IEC 61131-3 C Tools Function Specifications dLogConfig.typesOfFields[1] = DLV_INT32; dLogConfig.typesOfFields[2] = DLV_DOUBLE; dLogConfig.typesOfFields[3] = DLV_FLOAT; dLogConfig.typesOfFields[4] = DLV_FLOAT;

datalogCreate(logID, &dLogConfig);

}

else

{

/* could not delete log */

}

}

} else

{

/* Could not read settings */

}

Document (Version 2.51) 4/4/2011 117

IEC 61131-3 C Tools Function Specifications

datalogPurge

Purge Data Log Function

Syntax

#include <ctools.h>

BOOLEAN datalogPurge(

UINT16 logID,

BOOLEAN purgeAll,

UINT32 sequenceNumber

);

Description

This function removes records from a data log. The function can remove all the records, or a group of records starting with the oldest in the log.

The function has three parameters. logID specifies the data log. The valid range is 0 to 15. If purgeAll is TRUE, all records are removed, otherwise the oldest records are removed. sequenceNumber specifies the sequence number of the most recent record to remove. All records up to and including this record are removed. This parameter is ignored if purgeAll is TRUE.

The function returns TRUE if the operation succeeds. The function returns

FALSE if the log ID is invalid, if the log has not been created, or if the sequence number cannot be found in the log.

Notes

Purging the oldest records in the log is usually done after reading the log. The sequence number used is that of the last record read from the log. This removes the records that have been read and leaves any records added since the records were read.

If the sequence number specifies a record that is not in the log, no records are removed.

See Also

datalogReadStart, datalogReadNext, datalogWrite

Example

#include <ctools.h> int logID, sequenceNumber;

/* Declare flag to purge entire of data log or part of it */

BOOLEAN purgeAll;

/* Which data log to purge? */ logID = 10;

/* Set flag to purge only part of data log */

Document (Version 2.51) 4/4/2011 118

IEC 61131-3 C Tools Function Specifications purgeAll = FALSE;

/* How many of the oldest records to purge */ sequenceNumber = 150; if( datalogPurge(logID, purgeAll, sequenceNumber) )

{

/* Successful at purging the first 150 records of log */

/* Start writing records again */

}

/* To purge the entire data log, simply set flag to TRUE */ purgeAll = TRUE;

/* Call up function with same parameters */ if( datalogPurge(logID, purgeAll, sequenceNumber) )

{

/* Successful at purging the entire data log */

/* Start writing records again */

}

Document (Version 2.51) 4/4/2011 119

IEC 61131-3 C Tools Function Specifications

datalogReadNext

Read Data Log Next Function

This function returns the next record in the data log.

Syntax

#include <ctools.h>

BOOLEAN datalogReadNext(

UINT16 logID,

UINT32 sequenceNumber,

UINT32 * pSequenceNumber,

UINT32 * pNextSequenceNumber,

UINT16 * pData

);

Description

This function reads the next record from the data log starting at the specified sequence number. The function returns the record with the specified sequence number if it is present in the log. If the record no longer exists it returns the next record in the log.

The function has five parameters. logID specifies the data log. The valid range is

0 to 15. sequenceNumber is sequence number of the record to be read. pSequenceNumber is a pointer to a variable to hold the sequence number of the record read. pNextSequenceNumber is a pointer to a variable to hold the sequence number of the next record in the log. This is normally used for the next call to this function. pData is a pointer to memory to hold the data read from the log.

The function returns TRUE if a record is read from the log. The function returns

FALSE if the log ID is not valid, if the log has not been created or if there are no more records in the log.

Notes

Use the datalogReadStart function to obtain the sequence number of the oldest record in the data log.

The pData parameter needs to point to memory of sufficient size to hold all the data in a record.

It is normally necessary to call this function until it returns FALSE in order to read all the data from the log. This accommodates cases where data is added to the log while it is being read.

If data is read from the log at a slower rate than it is logged, it is possible that the sequence numbers of the records read will not be sequential. This indicates that records were overwritten between calls to read data.

The sequence number rolls over after reaching its maximum value.

Document (Version 2.51) 4/4/2011 120

IEC 61131-3 C Tools Function Specifications

See Also

datalogReadStart, datalogPurge, datalogWrite

Example

See the example for datalogReadStart.

Document (Version 2.51) 4/4/2011 121

IEC 61131-3 C Tools Function Specifications

datalogReadStart

Read Data Log Start Function

Syntax

#include <ctools.h>

BOOLEAN datalogReadStart(

UINT16 logID,

UINT32 * pSequenceNumber

);

Description

This function returns the sequence number of the record at the start of the data log. This is the oldest record in the log.

The function has two parameters. logID specifies the data log. The valid range is

0 to 15. pSequenceNumber is a pointer to a variable to hold the sequence number.

The function returns TRUE if the operation succeeded. The function returns

FALSE if the log ID is not valid or if the log has not been created.

Notes

Use the datalogReadNext function to read records from the log.

The function will return a sequence number even if the log is empty. In this case the next call to datalogReadNext will return no data.

See Also

datalogReadNext, datalogPurge, datalogWrite

Example

/************************************************

The following code shows how to read records

from data log.

************************************************/

#include "ctools.h"

#include <stdlib.h>

UINT16 recordSize, logID,

*pData; /* Pointer to memory to hold data read from log. */

UINT32 sequenceNumber,/* Sequence number of record to be read. */

nextSequenceNumber; /* Sequence number of next record. */ void main(void)

{

/* Select data log #10 */

Document (Version 2.51) 4/4/2011 122

IEC 61131-3 C Tools Function Specifications

logID = 10;

/* Find first record in data log #10 and store

its sequence number into sequenceNumber */

if( datalogReadStart(logID, &sequenceNumber) )

{

/* Get the size of this record */ if( datalogRecordSize(logID, &recordSize) )

{

/* Allocate memory of size recordSize */

pData = (UINT16 *) malloc(recordSize);

/* Read all records from data log #10. */

while( datalogReadNext(logID, sequenceNumber,

&sequenceNumber, &nextSequenceNumber, pData) )

{ read. */

/* Use pData and its contents.

Set next sequence number of record to be

}

}

sequenceNumber = nextSequenceNumber;

}

}

Document (Version 2.51) 4/4/2011 123

IEC 61131-3 C Tools Function Specifications

datalogRecordSize

Data Log Record Size Function

Syntax

#include < ctools.h >

BOOLEAN datalogRecordSize(

UINT16 logID,

UINT16 * pRecordSize;

);

Description

This function returns the size of a record for the specified data log. The log needs to have been previously created with the datalogCreate function.

The function has two parameters. logID specifies the data log. The valid range is

0 to 15. pRecordSize points to a variable that will hold the size of a record in the log.

The function returns TRUE if the operation succeeded. The function returns

FALSE if the log ID is invalid or if the data log does not exist.

Notes

This function is useful in determining how much memory needs to be allocated for a call to datalogReadNext or datalogWrite.

See Also

datalogCreate, datalogSettings

Example

See the example for datalogReadStart.

Document (Version 2.51) 4/4/2011 124

IEC 61131-3 C Tools Function Specifications

datalogSettings

Data Log Settings Function

Syntax

#include < ctools.h >

BOOLEAN datalogSettings(

UINT16 logID,

DATALOG_CONFIGURATION * pLogConfiguration

);

Description

This function reads the configuration of the specified data log. The log needs to have been previously created with the datalogCreate function.

The function has two parameters. logID specifies the data log. The valid range is

0 to 15. pLogConfiguration points to a structure that will hold the data log configuration.

The function returns TRUE if the operation succeeded. The function returns

FALSE if the log ID is invalid or if the data log does not exist.

Notes

The configuration of an existing data log cannot be changed. The log needs to be deleted and recreated to change the configuration.

See Also

datalogCreate, datalogRecordSize

Example

See example for datalogDelete.

Document (Version 2.51) 4/4/2011 125

IEC 61131-3 C Tools Function Specifications

datalogWrite

Write Data Log Function

Syntax

#include <ctools.h>

BOOLEAN datalogWrite(

UINT16 logID,

UINT16 * pData

);

Description

This function writes a record to the specified data log. The log needs to have been previously created with the datalogCreate function.

The function has two parameters. logID specifies the data log. The valid range is

0 to 15. pData is a pointer to the data to be written to the log. The amount of data copied using the pointer is determined by the configuration of the data log.

The function returns TRUE if the data is added to the log. The function returns

FALSE if the log ID is not valid or if the log does not exist.

Notes

Refer to the datalogCreate function for details on the configuration of the data log.

If the data log is full, then the oldest record in the log is replaced with this record.

See Also

datalogReadStart datalogReadNext datalogPurge

Example

See the example for datalogCreate.

Document (Version 2.51) 4/4/2011 126

dbase

IEC 61131-3 C Tools Function Specifications

Read Value from I/O Database

Syntax

#include <ctools.h> int dbase(unsigned type, unsigned address);

Description

The dbase function reads a value from the database. type specifies the method of addressing the database. address specifies the location in the database. If the specified address is not valid then the variable pointed to by value is left unchanged. The table below shows the valid address types and ranges.

Type Address Ranges

MODBUS 00001 to NUMCOIL

10001 to 10000 + NUMSTATUS

30001 to 30000 + NUMINPUT

LINEAR

40001 to 40000 + NUMHOLDING

0 to NUMLINEAR-1

Notes

Register

Size

1 bit

1 bit

16 bit

16 bit

16 bit

If the specified address is in the valid range but it has not been defined by an application, then the address is also invalid. An address is defined if any of the following is true:

• The address has been assigned as the Network Address for an IEC 61131-3

Dictionary variable.

• The address is defined in a database handler installed by a C or C++ application.

• The address is within the default range of the Permanent Non-volatile

Modbus Registers: 40001 to 40000 + NUMHOLDING_PERMANENT, and

00001 to NUMCOIL_PERMANENT.

When this function is called, the specified address is searched for under these three categories in the order listed above until the address is found. If the address is not found, then the variable pointed to by value is left unchanged. If the address is defined in more than one of these categories, the first occurrence of the address in the order listed is used.

Refer to the section Permanent Non-Volatile Modbus Registers for details on potential addressing conflicts during application downloading.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

setdbase, databaseRead, databaseWrite

Example

Document (Version 2.51) 4/4/2011 127

IEC 61131-3 C Tools Function Specifications

}

#include <ctools.h> void main(void)

{ int a; request_resource(IO_SYSTEM);

/* Read Modbus status input point */ a = dbase(MODBUS, 10001);

/* Read 16 bit register */ a = dbase(LINEAR, 3020);

/* Read 16 bit register beginning at first status register */ a = dbase(LINEAR, START_STATUS);

/* Read 6th input register */ a = dbase(LINEAR, START_INPUT + 5); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 128

IEC 61131-3 C Tools Function Specifications

deallocate_envelope

Return Envelope to the RTOS

Syntax

#include <ctools.h> void deallocate_envelope(envelope *penv);

Description

The deallocate_envelope function returns the envelope pointed to by penv to the pool of free envelopes maintained by the operating system.

See Also

allocate_envelope

Example

See the example for the allocate_envelope function.

Document (Version 2.51) 4/4/2011 129

IEC 61131-3 C Tools Function Specifications

dnpInstallConnectionHandler

Configures the connection handler for DNP.

Syntax

#include <ctools.h> void dnpInstallConnectionHandler(void (* function)

(DNP_CONNECTION_EVENT event));

Description

This function installs a handler that will permit user-defined actions to occur when

DNP requires a connection, message confirmation is received, or a timeout occurs. function is a pointer to the handler function. If function is NULL the handler is disabled.

The function has no return value.

Notes

The handler function needs to process the event and return immediately. If the required action involves waiting this needs to be done outside of the handler function. See the example below for one possible implementation.

The application needs to disable the handler when the application ends. This prevents the protocol driver from calling the handler while the application is stopped. Call the dnpInstallConnectionHandler with a NULL pointer. The usual method is to create a task exit handler function to do this. See the example below for details.

The handler function has one parameter.

• event is DNP event that has occurred. It may be one of

DNP_CONNECTION_REQUIRED, DNP_MESSAGE_COMPLETE, or

DNP_MESSAGE_TIMEOUT. See the structure definition for the meaning of these events.

The handler function has no return value.

By default no connection handler is installed and no special steps are taken when DNP requires a connection, receives a message confirmation, or a timeout occurs.

Example

This example shows how a C application can handle the events and inform a logic application of the events. The logic application is responsible for making and ending the dial-up connection.

The program uses the following registers.

Document (Version 2.51) 4/4/2011 130

IEC 61131-3 C Tools Function Specifications

• 10001 turns on when a connection is requested by DNP for unsolicited reporting.

• 10002 turns on when the unsolicited report is complete.

• 10003 turns on when the unsolicited report is fails.

• The ladder logic program turns on register 1 when the connection is complete and turns off the register when the connection is broken.

/* ---------------------------------------------------------------

--------

dnp.c

Demonstration program for using the DNP connection handler.

Copyright 2001, Control Microsystems Inc.

---------------------------------------------------------------

-------- */

/* ---------------------------------------------------------------

--------

Include Files

---------------------------------------------------------------

-------- */

#include <ctools.h>

/* ---------------------------------------------------------------

--------

Constants

---------------------------------------------------------------

-------- */

/* register for signaling #define CONNECTION_REQUIRED 10001 connection required */

#define MESSAGE_COMPLETE 10002 unsolicited message is complete */

/* register for signaling

#define MESSAGE_FAILED 10003 unsolicited message failed */

/* register for signaling

#define CONNECTION_STATUS 1 /* connection status register */

/* ---------------------------------------------------------------

--------

Private Functions

---------------------------------------------------------------

-------- */

/* ---------------------------------------------------------------

--------

sampleDNPHandler

This function is the user defined DNP connection handler. It will be

called by internal DNP routines when a connection is required, when

confirmation of a message is received, and when a communication timeout

occurs.

Document (Version 2.51) 4/4/2011 131

IEC 61131-3 C Tools Function Specifications

The function takes a variable of type DNP_CONNECTION_EVENT as an input.

This input instructs the handler as to what functionality is required.

The valid choices are connection required

(DNP_CONNECTION_REQUIRED),

message confirmation received (DNP_MESSAGE_COMPLETE), and timeout occurred

(DNP_MESSAGE_TIMEOUT).

The function does not return any values.

---------------------------------------------------------------

-------- */

}

*/ bits */ static void sampleDNPHandler(DNP_CONNECTION_EVENT event)

{

/* Determine what connection event is required or just occurred */ switch(event)

{ case DNP_CONNECTION_REQUIRED:

/* indicate connection is needed and clear other bits */ request_resource(IO_SYSTEM); setdbase(MODBUS, CONNECTION_REQUIRED, 1); setdbase(MODBUS, MESSAGE_COMPLETE, 0); setdbase(MODBUS, MESSAGE_FAILED, 0); release_resource(IO_SYSTEM); break; case DNP_MESSAGE_COMPLETE:

/* indicate message sent and clear other bits request_resource(IO_SYSTEM); setdbase(MODBUS, CONNECTION_REQUIRED, 0); setdbase(MODBUS, MESSAGE_COMPLETE, 1); setdbase(MODBUS, MESSAGE_FAILED, 0); release_resource(IO_SYSTEM); break; case DNP_MESSAGE_TIMEOUT:

/* indicate message failed and clear other request_resource(IO_SYSTEM); setdbase(MODBUS, CONNECTION_REQUIRED, 0); setdbase(MODBUS, MESSAGE_COMPLETE, 0); setdbase(MODBUS, MESSAGE_FAILED, 1); release_resource(IO_SYSTEM); break; default:

/* ignore invalid requests */ break;

}

Document (Version 2.51) 4/4/2011 132

IEC 61131-3 C Tools Function Specifications

/* ---------------------------------------------------------------

--------

Public Functions

---------------------------------------------------------------

-------- */

/* ---------------------------------------------------------------

--------

main

This function is the main task of a user application. It monitors a

register from the ladder logic application. When the register value

changes, the function signals DNP events.

The function has no parameters.

The function does not return.

---------------------------------------------------------------

-------- */ void main(void)

{ int lastConnectionState; /* last state of connection register */ int currentConnectionState; connection register */

/* current state of

/* install DNP connection handler */ dnpInstallConnectionHandler(sampleDNPHandler);

/* get the current connection state */ lastConnectionState = dbase(MODBUS, CONNECTION_STATUS);

/* loop forever */ while (TRUE)

{ request_resource(IO_SYSTEM);

/* get the current connection state */ currentConnectionState = dbase(MODBUS,

CONNECTION_STATUS);

/* if the state has changed */ if (currentConnectionState != lastConnectionState)

{

/* if the connection is active */ if (currentConnectionState)

{

/* Inform DNP that a connection exists

*/ dnpConnectionEvent(DNP_CONNECTED);

/* clear the request flag */ setdbase(MODBUS, CONNECTION_REQUIRED,

0);

Document (Version 2.51) 4/4/2011 133

closed */

}

}

IEC 61131-3 C Tools Function Specifications

} else

{

/* Inform DNP that the connection is dnpConnectionEvent(DNP_DISCONNECTED);

/* clear the message flags */ setdbase(MODBUS, MESSAGE_COMPLETE, 0);

} setdbase(MODBUS, MESSAGE_FAILED, 0);

/* save the new state */

} lastConnectionState = currentConnectionState;

/* release the processor so other tasks can run */ release_resource(IO_SYSTEM); release_processor();

Document (Version 2.51) 4/4/2011 134

IEC 61131-3 C Tools Function Specifications

dnpClearEventLog

Clear DNP Event Log

Syntax:

#include <ctools.h>

BOOLEAN dnpClearEventLog(void);

Description:

The dnpClearEventLogs function deletes all change events from the DNP change event buffers, for all point types.

Example:

See the example in the dnpSendUnsolicited section.

Document (Version 2.51) 4/4/2011 135

IEC 61131-3 C Tools Function Specifications

dnpConnectionEvent

Report a DNP connection event

Syntax

#include <ctools.h> void dnpConnectionEvent(DNP_CONNECTION_EVENT event);

Description

dnpConnectionEvent is used to report a change in connection status to DNP.

This function is only used if a custom DNP connection handler has been installed. event is current connection status. The valid connection status settings are

DNP_CONNECTED, and DNP_DISCONNECTED.

See Also

dnpInstallConnectionHandler

Example

See the dnpInstallConnectionHandler example.

Document (Version 2.51) 4/4/2011 136

IEC 61131-3 C Tools Function Specifications

dnpCreateRoutingTable

Create Routing Table

Syntax

#include <ctools.h>

BOOLEAN createRoutingTable (UINT16 size);

Description

This function destroys any existing DNP routing table, and allocates memory for a new routing table according to the ‘size’ parameter.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

The function returns TRUE if successful, FALSE otherwise.

Example

See the dnpInstallConnectionHandler example.

Document (Version 2.51) 4/4/2011 137

IEC 61131-3 C Tools Function Specifications

dnpGenerateEventLog

Generate DNP Event Log

Syntax

#include <ctools.h>

BOOLEAN dnpGenerateEventLog(

UINT16 pointType,

UINT16 pointAddress

);

Description

The dnpGenerateEventLog function generates a change event for the DNP point specified by pointType and pointAddress. pointType specifies the type of DNP point. Allowed values are:

BI_POINT

AI16_POINT

AI32_POINT binary input

16 bit analog input

32 bit analog input

AISF_POINT

CI16_POINT short float analog input

16 bit counter output

CI32_POINT 32 bit counter output pointAddress specifies the DNP address of the point.

A change event is generated for the specified point (with the current time and current value), and stored in the DNP event buffer.

The format of the event will depend on the Event Reporting Method and Class of

Event Object that have been configured for the point.

The function returns TRUE if the event was generated. It returns FALSE if the

DNP point is invalid, or if the DNP configuration has not been created.

Notes

DNP See the dnpInstallConnectionHandler example.

be enabled before calling this function in order to create the DNP configuration.

Example

See the example in the dnpSendUnsolicited section.

Document (Version 2.51) 4/4/2011 138

IEC 61131-3 C Tools Function Specifications

dnpGetAI16Config

Get DNP 16-bit Analog Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpGetAI16Config(

UINT16 point, dnpAnalogInput * pAnalogInput

);

Description

This function reads the configuration of a DNP 16-bit analog input point.

The function has two parameters: the point number; and a pointer to an analog input point configuration structure.

The function returns TRUE if the configuration was read. It returns FALSE if the point number is not valid, if the pointer is NULL, or if DNP configuration has not been created.

Notes

DNP See the dnpInstallConnectionHandler example.

be enabled before calling this function in order to create the DNP configuration.

See Also

dnpGetAI32Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 139

IEC 61131-3 C Tools Function Specifications

dnpGetAI32Config

Get DNP 32-bit Analog Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpGetAI32Config(

UINT32 point, dnpAnalogInput * pAnalogInput

);

Description

This function reads the configuration of a DNP 32-bit analog input point.

The function has two parameters: the point number; and a pointer to an analog input point configuration structure.

The function returns TRUE if the configuration was read. It returns FALSE if the point number is not valid, if the pointer is NULL, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpSaveAI32Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 140

IEC 61131-3 C Tools Function Specifications

dnpGetAISFConfig

Get Short Floating Point Analog Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpGetAISFConfig (

UINT16 point, dnpAnalogInput *pAnalogInput;

);

Description

This function reads the configuration of a DNP short floating point analog input point.

The function has two parameters: the point number, and a pointer to a configuration structure.

The function returns TRUE if the configuration was successfully read, or FALSE otherwise (if the point number is not valid, or pointer is NULL, or if the DNP configuration has not been created).

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

Document (Version 2.51) 4/4/2011 141

IEC 61131-3 C Tools Function Specifications

dnpGetAO16Config

Get DNP 16-bit Analog Output Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpGetAO16Config(

UINT16 point, dnpAnalogOutput * pAnalogOutput

);

Description

This function reads the configuration of a DNP 16-bit analog output point.

The function has two parameters: the point number; and a pointer to an analog output point configuration structure.

The function returns TRUE if the configuration was read. It returns FALSE if the point number is not valid, if the pointer is NULL, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpSaveAO16Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 142

IEC 61131-3 C Tools Function Specifications

dnpGetAO32Config

Get DNP 32-bit Analog Output Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpGetAO32Config(

UINT32 point, dnpAnalogOutput * pAnalogOutput

);

Description

This function reads the configuration of a DNP 32-bit analog output point.

The function has two parameters: the point number; and a pointer to an analog output point configuration structure.

The function returns TRUE if the configuration was read. It returns FALSE if the point number is not valid, if the pointer is NULL, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpSaveAO32Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 143

IEC 61131-3 C Tools Function Specifications

dnpGetAOSFConfig

Get Short Floating Point Analog Output Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpGetAOSFConfig (

UINT16 point, dnpAnalogOutput *pAnalogOutput;

);

Description

This function reads the configuration of a DNP short floating point analog output point.

The function has two parameters: the point number, and a pointer to a configuration structure.

The function returns TRUE if the configuration was successfully read, or FALSE otherwise (if the point number is not valid, or pointer is NULL, or if the DNP configuration has not been created).

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

Document (Version 2.51) 4/4/2011 144

IEC 61131-3 C Tools Function Specifications

dnpGetBIConfig

Get DNP Binary Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpGetBIConfig(

UINT16 point, dnpBinaryInput * pBinaryInput

);

Description

This function reads the configuration of a DNP binary input point.

The function has two parameters: the point number; and a pointer to a binary input point configuration structure.

The function returns TRUE if the configuration was read. It returns FALSE if the point number is not valid, if the pointer is NULL, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpSaveBIConfig

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 145

IEC 61131-3 C Tools Function Specifications

dnpGetBIConfigEx

Read DNP Binary Input Extended Point

Syntax

BOOLEAN dnpGetBIConfigEx(

UINT16 point, dnpBinaryInputEx *pBinaryInput

);

Description

This function reads the configuration of an extended DNP Binary Input point.

The function has two parameters: the point number, and a pointer to an extended binary input point configuration structure.

The function returns TRUE if the configuration was successfully read. It returns

FALSE if the point number is not valid, if the configuration is not valid, or if the

DNP configuration has not been created.

This function supersedes dnpSaveBIConfig.

Document (Version 2.51) 4/4/2011 146

IEC 61131-3 C Tools Function Specifications

dnpGetBOConfig

Get DNP Binary Output Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpGetBOConfig(

UINT16 point, dnpBinaryOutput * pBinaryOutput

);

Description

This function reads the configuration of a DNP binary output point.

The function has two parameters: the point number; and a pointer to a binary output point configuration structure.

The function returns TRUE if the configuration was read. It returns FALSE if the point number is not valid, if the pointer is NULL, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpSaveBOConfig

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 147

IEC 61131-3 C Tools Function Specifications

dnpGetCI16Config

Get DNP 16-bit Counter Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpGetCI16Config(

UINT16 point, dnpCounterInput * pCounterInput

);

Description

This function reads the configuration of a DNP 16-bit counter input point.

The function has two parameters: the point number; and a pointer to a counter input point configuration structure.

The function returns TRUE if the configuration was read. It returns FALSE if the point number is not valid, if the pointer is NULL, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpSaveCI16Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 148

IEC 61131-3 C Tools Function Specifications

dnpGetCI32Config

Get DNP 32-bit Counter Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpGetCI32Config(

UINT32 point, dnpCounterInput * pCounterInput

);

Description

This function reads the configuration of a DNP 32-bit counter input point.

The function has two parameters: the point number; and a pointer to a counter input point configuration structure.

The function returns TRUE if the configuration was read. It returns FALSE if the point number is not valid, if the pointer is NULL, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpSaveCI32Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 149

IEC 61131-3 C Tools Function Specifications

dnpGetConfiguration

Get DNP Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpGetConfiguration( dnpConfiguration * pConfiguration

);

Description

This function reads the DNP configuration.

The function has one parameter: a pointer to a DNP configuration structure.

The function returns TRUE if the configuration was read and FALSE if an error occurred.

See Also

dnpSaveConfiguration

Example

The following program demonstrates how to configure DNP for operation on com2. To illustrate creation of points it uses a sequential mapping of Modbus registers to points. This is not required. Any mapping may be used. void main(void)

{

UINT16 index; /* loop index */ struct prot_settings settings; /* protocol settings */ dnpConfiguration configuration; /* configuration settings

*/

/* binary input dnpBinaryInput binaryInput; settings */ dnpBinaryOutput binaryOutput; settings */ dnpAnalogInput analogInput; settings */ dnpAnalogOutput analogOutput;

/* binary output

/* analog input

/* analog output settings */ dnpCounterInput counterInput; settings */

/* counter input

/* Stop any protocol currently active on com port 2 */ get_protocol(com2,&settings); settings.type = NO_PROTOCOL; set_protocol(com2,&settings);

/* Load the Configuration Parameters */ configuration.masterAddress = DEFAULT_DNP_MASTER; configuration.rtuAddress = DEFAULT_DNP_RTU; configuration.datalinkConfirm = TRUE;

Document (Version 2.51) 4/4/2011 150

IEC 61131-3 C Tools Function Specifications configuration.datalinkRetries =

DEFAULT_DLINK_RETRIES; configuration.datalinkTimeout =

DEFAULT_DLINK_TIMEOUT; configuration.operateTimeout =

DEFAULT_OPERATE_TIMEOUT; configuration.applicationConfirm = TRUE; configuration.maximumResponse =

DEFAULT_MAX_RESP_LENGTH; configuration.applicationRetries = DEFAULT_APPL_RETRIES; configuration.applicationTimeout = DEFAULT_APPL_TIMEOUT; configuration.timeSynchronization = TIME_SYNC; configuration.BI_number = 8; configuration.BI_cosBufferSize = DEFAULT_COS_BUFF; configuration.BI_soeBufferSize = DEFAULT_SOE_BUFF; configuration.BO_number = 8; configuration.CI16_number = 24; configuration.CI16_bufferSize = 48; configuration.CI32_number = 12; configuration.CI32_bufferSize = 24; configuration.AI16_number = 24; configuration.AI16_reportingMethod = CURRENT_VALUE; configuration.AI16_bufferSize = 24; configuration.AI32_number = 12; configuration.AI32_reportingMethod = CURRENT_VALUE; configuration.AI32_bufferSize = 12; configuration.AO16_number = 8; configuration.AO32_number = 8; configuration.unsolicited = TRUE; configuration.holdTime = DEFAULT_HOLD_TIME; configuration.holdCount = DEFAULT_HOLD_COUNT; dnpSaveConfiguration(&configuration);

/* Start DNP protocol on com port 2 */ get_protocol(com2,&settings); settings.type = DNP; set_protocol(com2,&settings);

/* Save port settings so DNP protocol will automatically start */ request_resource(IO_SYSTEM); save(EEPROM_RUN); release_resource(IO_SYSTEM);

/* Configure Binary Output Points */ for (index = 0; index < configuration.BO_number; index++)

{ binaryOutput.modbusAddress1 = 1 + index; binaryOutput.modbusAddress2 = 1 + index; binaryOutput.controlType = NOT_PAIRED;

Document (Version 2.51) 4/4/2011 151

Document (Version 2.51) 4/4/2011

IEC 61131-3 C Tools Function Specifications dnpSaveBOConfig(index, &binaryOutput);

}

/* Configure Binary Input Points */ for (index = 0;index < configuration.BI_number; index++)

{ binaryInput.modbusAddress = 10001 + index; binaryInput.class = CLASS_1; binaryInput.eventType = COS;

} dnpSaveBIConfig(index, &binaryInput);

/* Configure 16 Bit Analog Input Points */ for (index = 0; index < configuration.AI16_number; index++)

{ analogInput.modbusAddress = 30001 + index; analogInput.class = CLASS_2; analogInput.deadband = 1;

} dnpSaveAI16Config(index, &analogInput);

/* Configure32 Bit Analog Input Points */ for (index = 0; index < configuration.AI32_number; index++)

{ analogInput.modbusAddress = 30001 + index * 2; analogInput.class = CLASS_2; analogInput.deadband = 1;

} dnpSaveAI32Config(index,&analogInput);

/* Configure 16 Bit Analog Output Points */ for (index = 0;index < configuration.AO16_number; index++)

{ analogOutput.modbusAddress = 40001 + index;

} dnpSaveAO16Config(index, &analogOutput);

/* Configure 32 Bit Analog Output Points */ for (index = 0; index < configuration.AO32_number; index++)

{ analogOutput.modbusAddress = 40101 + index * 2;

} dnpSaveAO32Config(index, &analogOutput);

/* Configure 16 Bit Counter Input Points */ for (index = 0; index < configuration.CI16_number; index++)

{ counterInput.modbusAddress = 30001 + index; counterInput.class = CLASS_3; counterInput.threshold = 1;

152

IEC 61131-3 C Tools Function Specifications

} dnpSaveCI16Config(index, &counterInput);

/* Configure 32 bit Counter Input Points */ for (index = 0; index < configuration.CI32_number; index++)

{

} counterInput.modbusAddress = 30001 + index * 2; counterInput.class = CLASS_3; counterInput.threshold = 1; dnpSaveCI32Config(index, &counterInput);

*/

}

/* add additional initialization code for your application here ... */

/* loop forever */ while (TRUE)

{

/* add additional code for your application here ...

}

/* allow other tasks of this priority to execute */ release_processor(); return;

Document (Version 2.51) 4/4/2011 153

IEC 61131-3 C Tools Function Specifications

dnpGetConfigurationEx

Read DNP Extended Configuration

Syntax

BOOLEAN dnpGetConfigurationEx ( dnpConfigurationEx *pDnpConfigurationEx

);

Description

This function reads the extended DNP configuration parameters.

The function has one parameter: a pointer to the DNP extended configuration structure.

The function returns TRUE if the configuration was successfully read, or FALSE otherwise (if the pointer is NULL, or if the DNP configuration has not been created).

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

This function supersedes the dnpGetConfiguration function.

Document (Version 2.51) 4/4/2011 154

IEC 61131-3 C Tools Function Specifications

dnpGetRuntimeStatus

Get DNP Runtime Status

Syntax

#include <ctools.h>

BOOLEAN dnpGetRuntimeStatus(

DNP_RUNTIME_STATUS *status

);

Description

The dnpGetRuntimeStatus function reads the current status of all DNP change event buffers, and returns information in the status structure.

DNP needs to be enabled before calling this function in order to create the DNP configuration.

Example

See the example in the dnpSendUnsolicited section.

Document (Version 2.51) 4/4/2011 155

IEC 61131-3 C Tools Function Specifications

dnpGetUnsolicitedBackoffTime

Get DNP Unsolicited Back Off Time

Syntax:

#include <ctools.h>

UINT16 dnpGetUnsolicitedBackoffTime();

Description:

The dnpGetUnsolicitedBackoffTime function reads the unsolicited back off time from the controller.

The time is in seconds; and the allowed range is 0-65535 seconds. A value of zero indicates that the unsolicited back off timer is disabled.

Document (Version 2.51) 4/4/2011 156

IEC 61131-3 C Tools Function Specifications

dnpReadRoutingTableDialStrings

Read DNP Routing Table Entry Dial Strings

Syntax

BOOLEAN dnpReadRoutingTableDialStrings(

UINT16 index,

);

UINT16 maxPrimaryDialStringLength,

CHAR *primaryDialString,

UINT16 maxSecondaryDialStringLength,

CHAR *secondaryDialString

Description

This function reads a primary and secondary dial string from an entry in the DNP routing table. index specifies the index of an entry in the DNP routing table. maxPrimaryDialStringLength specifies the maximum length of primaryDialString excluding the null-terminator character. The function uses this to limit the size of the returned string to prevent overflowing the storage passed to the function. primaryDialString returns the primary dial string of the target station. It needs to point to an array of size maxPrimaryDialStringLength. maxSecondaryDialStringLength specifies the maximum length of secondaryDialString excluding the null-terminator character. The function uses this to limit the size of the returned string to prevent overflowing the storage passed to the function. secondaryDialString returns the secondary dial string of the target station. It needs to point to an array of size maxSecondaryDialStringLength.

Notes

This function needs to be used in conjunction with the dnpReadRoutingTableEntry function to read a complete entry in the DNP routing table.

Document (Version 2.51) 4/4/2011 157

IEC 61131-3 C Tools Function Specifications

dnpReadRoutingTableEntry

Read Routing Table entry

Syntax

#include <ctools.h>

BOOLEAN dnpReadRoutingTableEntry (

UINT16 index, routingTable *pRoute

);

Description

This function reads an entry from the routing table.

pRoute is a pointer to a table entry; it is written by this function.

The return value is TRUE if pRoute was successfully written or FALSE otherwise.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

The function returns the total number of entries in the DNP routing table.

Document (Version 2.51) 4/4/2011 158

IEC 61131-3 C Tools Function Specifications

dnpReadRoutingTableSize

Read Routing Table size

Syntax

#include <ctools.h>

UINT16 dnpReadRoutingTableSize (void);

Description

This function reads the total number of entries in the routing table.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

The function returns the total number of entries in the routing table.

Document (Version 2.51) 4/4/2011 159

IEC 61131-3 C Tools Function Specifications

dnpSaveAI16Config

Save DNP 16-Bit Analog Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpSaveAI16Config(

UINT16 point, dnpAnalogInput * pAnalogInput

);

Description

This function sets the configuration of a DNP 16-bit analog input point.

The function has two parameters: the point number; and a pointer to an analog input point configuration structure.

The function returns TRUE if the configuration was written. It returns FALSE if the point number is not valid, if the configuration is not valid, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpGetAI16Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 160

IEC 61131-3 C Tools Function Specifications

dnpSaveAI32Config

Save DNP 32-Bit Analog Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpSaveAI32Config(

UINT32 point, dnpAnalogInput * pAnalogInput

);

Description

This function sets the configuration of a DNP 32-bit analog input point.

The function has two parameters: the point number; and a pointer to an analog input point configuration structure.

The function returns TRUE if the configuration was written. It returns FALSE if the point number is not valid, if the configuration is not valid, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpGetAI32Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 161

IEC 61131-3 C Tools Function Specifications

dnpSaveAISFConfig

Save Short Floating Point Analog Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpSaveAISFConfig (

UINT16 point, dnpAnalogInput *pAnalogInput;

);

Description

This function sets the configuration of a DNP short floating point analog input point.

The function has two parameters: the point number, and a pointer to a configuration structure.

The function returns TRUE if the configuration was successfully written, or

FALSE otherwise (if the point number is not valid, or the configuration is not valid, or if the DNP configuration has not been created).

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

Document (Version 2.51) 4/4/2011 162

IEC 61131-3 C Tools Function Specifications

dnpSaveAO16Config

Save DNP 16-Bit Analog Output Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpSaveAO16Config(

UINT16 point, dnpAnalogOutput * pAnalogOutput

);

Description

This function sets the configuration of a DNP 16-bit analog output point.

The function has two parameters: the point number; and a pointer to an analog output point configuration structure.

The function returns TRUE if the configuration was written. It returns FALSE if the point number is not valid, if the configuration is not valid, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpGetAO16Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 163

IEC 61131-3 C Tools Function Specifications

dnpSaveAO32Config

Save DNP 32-Bit Analog Output Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpSaveAO32Config(

UINT32 point, dnpAnalogOutput * pAnalogOutput

);

Description

This function sets the configuration of a DNP 32-bit analog output point.

The function has two parameters: the point number; and a pointer to an analog output point configuration structure.

The function returns TRUE if the configuration was written. It returns FALSE if the point number is not valid, if the configuration is not valid, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpGetAO32Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 164

IEC 61131-3 C Tools Function Specifications

dnpSaveAOSFConfig

Save Short Floating Point Analog Output Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpSaveAOSFConfig (

UINT16 point, dnpAnalogOutput *pAnalogOutput;

);

Description

This function sets the configuration of a DNP short floating point analog output point.

The function has two parameters: the point number, and a pointer to a configuration structure.

The function returns TRUE if the configuration was successfully written, or

FALSE otherwise (if the point number is not valid, or the configuration is not valid, or if the DNP configuration has not been created).

Notes

DNP needs to be enabled before calling this function in order to create the DNP

Document (Version 2.51) 4/4/2011 165

IEC 61131-3 C Tools Function Specifications

dnpSaveBIConfig

Save DNP Binary Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpSaveBIConfig(

UINT16 point, dnpBinaryInput * pBinaryInput

);

Description

This function sets the configuration of a DNP binary input point.

The function has two parameters: the point number; and a pointer to a binary input point configuration structure.

The function returns TRUE if the configuration was written. It returns FALSE if the point number is not valid, if the configuration is not valid, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpGetBIConfig

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 166

IEC 61131-3 C Tools Function Specifications

dnpSaveBIConfigEx

Write DNP Binary Input Extended Point

Syntax

BOOLEAN dnpSaveBIConfigEx(

UINT16 point, dnpBinaryInputEx *pBinaryInput

);

Description

This function writes the configuration of an extended DNP Binary Input point.

The function has two parameters: the point number, and a pointer to an extended binary input point configuration structure.

The function returns TRUE if the configuration was successfully written. It returns

FALSE if the point number is not valid, if the configuration is not valid, or if the

DNP configuration has not been created.

This function supersedes dnpSaveBIConfig.

Document (Version 2.51) 4/4/2011 167

IEC 61131-3 C Tools Function Specifications

dnpSaveBOConfig

Save DNP Binary Output Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpSaveBOConfig(

UINT16 point, dnpBinaryOutput * pBinaryOutput

);

Description

This function sets the configuration of a DNP binary output point.

The function has two parameters: the point number; and a pointer to a binary output point configuration structure.

The function returns TRUE if the configuration was written. It returns FALSE if the point number is not valid, if the configuration is not valid, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpGetBOConfig

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 168

IEC 61131-3 C Tools Function Specifications

dnpSaveCI16Config

Save DNP 16-Bit Counter Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpSaveCI16Config(

UINT16 point, dnpCounterInput * pCounterInput

);

Description

This function sets the configuration of a DNP 16-bit counter input point.

The function has two parameters: the point number; and a pointer to a counter input point configuration structure.

The function returns TRUE if the configuration was written. It returns FALSE if the point number is not valid, if the configuration is not valid, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpGetCI16Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 169

IEC 61131-3 C Tools Function Specifications

dnpSaveCI32Config

Save DNP 32-Bit Counter Input Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpSaveCI32Config(

UINT32 point, dnpCounterInput * pCounterInput

);

Description

This function sets the configuration of a DNP 32-bit counter input point.

The function has two parameters: the point number; and a pointer to a counter input point configuration structure.

The function returns TRUE if the configuration was written. It returns FALSE if the point number is not valid, if the configuration is not valid, or if DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

See Also

dnpGetCI32Config

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 170

IEC 61131-3 C Tools Function Specifications

dnpSaveConfiguration

Save DNP Configuration

Syntax

#include <ctools.h>

BOOLEAN dnpSaveConfiguration( dnpConfiguration * pConfiguration

);

Description

This function sets the DNP configuration.

The function has one parameter: a pointer to a DNP configuration structure.

The function returns TRUE if the configuration was updated and FALSE if an error occurred. No changes are made to any parameters if an error occurs.

Notes

This function needs to be called before enabling DNP.

The following parameters cannot be changed if DNP is enabled. The function will not make any changes and will return FALSE if this is attempted. The protocol needs to be disabled in order to make a change involving these parameters.

• BI_number

• BI_cosBufferSize

• BI_soeBufferSize

• BO_number

• CI16_number

• CI16_bufferSize

• CI32_number

• CI32_bufferSize

• AI16_number

• AI16_reportingMethod

• AI16_bufferSize

• AI32_number

• AI32_reportingMethod

• AI32_bufferSize

• AO16_number

• AO32_number

Document (Version 2.51) 4/4/2011 171

IEC 61131-3 C Tools Function Specifications

The following parameters can be changed when DNP is enabled.

• masterAddress;

• rtuAddress;

• datalinkConfirm;

• datalinkRetries;

• datalinkTimeout;

• operateTimeout

• applicationConfirm

• maximumResponse

• applicationRetries

• applicationTimeout

• timeSynchronization

• unsolicited

• holdTime

• holdCount

See Also

dnpGetConfiguration

Example

See example in the dnpGetConfiguration function section.

Document (Version 2.51) 4/4/2011 172

IEC 61131-3 C Tools Function Specifications

dnpSaveConfigurationEx

Write DNP Extended Configuration

Syntax

BOOLEAN dnpSaveConfigurationEx ( dnpConfigurationEx *pDnpConfigurationEx

);

Description

This function writes the extended DNP configuration parameters.

The function has one parameter: a pointer to the DNP extended configuration structure.

The function returns TRUE if the configuration was successfully written, or

FALSE otherwise (if the pointer is NULL, or if the DNP configuration has not been created).

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

This function supersedes the dnpSaveConfiguration function.

Document (Version 2.51) 4/4/2011 173

IEC 61131-3 C Tools Function Specifications

dnpSaveUnsolicitedBackoffTime

Save DNP Unsolicited Back Off Time

Syntax:

BOOLEAN dnpSaveUnsolicitedBackoffTime (

UINT16 backoffTime

);

Description:

The dnpSaveUnsolicitedBackoffTime function writes the unsolicited back off time to the controller.

The time is in seconds; and the allowed range is 0-65535 seconds. A value of zero indicates that the unsolicited back off timer is disabled.

The function returns TRUE if the function was successful. It returns FALSE if the

DNP configuration has not been created.

Document (Version 2.51) 4/4/2011 174

IEC 61131-3 C Tools Function Specifications

dnpSendUnsolicited

Send DNP Unsolicited Response

Syntax

#include <ctools.h>

UINT16 dnpSendUnsolicitedResponse(

UINT16 classFlags

);

Description

The dnpSendUnsolicitedResponse function sends an ‘Unsolicited Response’ message in DNP protocol, with data from the specified class(es).

class specifies the class(es) of event data to include in the message.

• Allowed values are

#define CLASS0_FLAG 0x01 /* flag for enabling Class 0 Unsolicited

Responses */

#define CLASS1_FLAG 0x02 /* flag for enabling Class 1 Unsolicited

Responses */

#define CLASS2_FLAG 0x04 /* flag for enabling Class 2 Unsolicited

Responses */

#define CLASS3_FLAG 0x08 /* flag for enabling Class 3 Unsolicited

Responses */

DNP needs to be enabled before calling this function in order to create the DNP configuration.

Example

/* ---------------------------------------------------------------

---

SCADAPack 32 C++ Application Main Program

Copyright 2001 - 2002, Control Microsystems Inc.

Test application for new DNP API Functions.

written by James Wiles May 2003

This app was written for a ScadaPack 32P, running DNP on comm port

4.

---------------------------------------------------------------

*/

#include <ctools.h>

#include <string.h>

/* ---------------------------------------------------------------

---

Document (Version 2.51) 4/4/2011 175

IEC 61131-3 C Tools Function Specifications

Constants

---------------------------------------------------------------

*/

/*

* Event Triggers :

* This application detects when these registers have been set,

* then performs the specified action and clears the register.

*/

#define CLEAR_EVENTS

Buffers */

100 /* Clear all DNP Event Log

#define GENERATE_BI_EVENT 101 /* Generate a change event for BI channel 0 */

102 /* Generate a change event #define GENERATE_AI16_EVENT for 16-bit AI channel 0 */

#define CLASS0_REPORT report of Class 0 data */

103 /* Send an unsolicited

/*

* Status Flags

*/

#define EVENTS_CLASS1

#define EVENTS_CLASS2

#define EVENTS_CLASS3

110

111

112

/*

* Status Registers

*/

#define EVENT_COUNT_AI16 40102

#define EVENT_COUNT_BI 40104

#define EVENT_COUNT_CLASS1 40106

#define EVENT_COUNT_CLASS2 40108

#define EVENT_COUNT_CLASS3 40110

/* ---------------------------------------------------------------

---

main

This routine is the main application loop.

---------------------------------------------------------------

*/ void main(void)

{

UINT16 index; /* loop index */ struct prot_settings protocolSettings; /* protocol settings */ dnpConfiguration configuration; dnpBinaryInput binaryInput; dnpAnalogInput analogInput;

DNP_RUNTIME_STATUS dnpStatus; int clear_events_flag; int bi_event_flag; int ai16_event_flag; int class0_report_flag;

Document (Version 2.51) 4/4/2011 176

IEC 61131-3 C Tools Function Specifications

/* Set DNP Configuration */ configuration.masterAddress = 100; configuration.rtuAddress = 1; configuration.datalinkConfirm = FALSE; configuration.datalinkRetries =

DEFAULT_DLINK_RETRIES; configuration.datalinkTimeout =

DEFAULT_DLINK_TIMEOUT; configuration.operateTimeout =

DEFAULT_OPERATE_TIMEOUT; configuration.applicationConfirm = FALSE; configuration.maximumResponse =

DEFAULT_MAX_RESP_LENGTH; configuration.applicationRetries = DEFAULT_APPL_RETRIES; configuration.applicationTimeout = DEFAULT_APPL_TIMEOUT; configuration.timeSynchronization = NO_TIME_SYNC; configuration.BI_number = 2; configuration.BI_startAddress = 0; configuration.BI_reportingMethod = REPORT_ALL_EVENTS; configuration.BI_soeBufferSize = 1000; configuration.BO_number = 0; configuration.BO_startAddress = 0; configuration.CI16_number = 0; configuration.CI16_startAddress = 0; configuration.CI16_reportingMethod = REPORT_ALL_EVENTS; configuration.CI16_bufferSize = 0; configuration.CI32_number = 0; configuration.CI32_startAddress = 100; configuration.CI32_reportingMethod = REPORT_ALL_EVENTS; configuration.CI32_bufferSize = 0; configuration.CI32_wordOrder = MSW_FIRST; configuration.AI16_number = 2; configuration.AI16_startAddress = 0; configuration.AI16_reportingMethod = REPORT_ALL_EVENTS; configuration.AI16_bufferSize = 1000; configuration.AI32_number = 0; configuration.AI32_startAddress = 100; configuration.AI32_reportingMethod = REPORT_ALL_EVENTS; configuration.AI32_bufferSize = 0; configuration.AI32_wordOrder = MSW_FIRST; configuration.AISF_number = 0; configuration.AISF_startAddress = 200; configuration.AISF_reportingMethod = REPORT_CHANGE_EVENTS; configuration.AISF_bufferSize = 0; configuration.AISF_wordOrder = MSW_FIRST; configuration.AO16_number = 0; configuration.AO16_startAddress = 0; configuration.AO32_number = 0; configuration.AO32_startAddress = 100; configuration.AO32_wordOrder = MSW_FIRST; configuration.AOSF_number = 0; configuration.AOSF_startAddress = 200; configuration.AOSF_wordOrder = MSW_FIRST;

Document (Version 2.51) 4/4/2011 177

IEC 61131-3 C Tools Function Specifications configuration.autoUnsolicitedClass1 = TRUE; configuration.holdTimeClass1 = 10; configuration.holdCountClass1 = 3; configuration.autoUnsolicitedClass2 = TRUE; configuration.holdTimeClass2 = 10; configuration.holdCountClass2 = 3; configuration.autoUnsolicitedClass3 = TRUE; configuration.holdTimeClass3 = 10; configuration.holdCountClass3 = 3; dnpSaveConfiguration(&configuration);

/* Start DNP protocol on com port 4 */ get_protocol(com4, &protocolSettings); protocolSettings.type = DNP; set_protocol(com4, &protocolSettings);

/* Configure Binary Input Points */ for (index = 0;index < configuration.BI_number; index++)

{ binaryInput.modbusAddress = 10001 + index; binaryInput.eventClass = CLASS_1; dnpSaveBIConfig(configuration.BI_startAddress + index, &binaryInput);

}

/* Configure 16 Bit Analog Input Points */ for (index = 0; index < configuration.AI16_number; index++)

{ analogInput.modbusAddress = 40002 + index * 2; analogInput.eventClass = CLASS_2; analogInput.deadband = 1; dnpSaveAI16Config(configuration.AI16_startAddress + index, &analogInput);

}

/*

* Configure DNP Routing Table :

* station 100 via com4

* station 101 via com4

*/ dnpCreateRoutingTable(2); dnpWriteRoutingTableEntry(0, 100, CIF_Com4,

DEFAULT_DLINK_RETRIES, DEFAULT_DLINK_TIMEOUT); dnpWriteRoutingTableEntry(1, 101, CIF_Com4,

DEFAULT_DLINK_RETRIES, DEFAULT_DLINK_TIMEOUT);

/*

* main loop

*/ while (TRUE)

{

/* request IO resource */

Document (Version 2.51) 4/4/2011 178

IEC 61131-3 C Tools Function Specifications request_resource(IO_SYSTEM);

/* read DNP status */ dnpGetRuntimeStatus(&dnpStatus); setdbase(MODBUS, EVENTS_CLASS1, dnpStatus.eventCountClass1 ? 1 : 0); setdbase(MODBUS, EVENTS_CLASS2, dnpStatus.eventCountClass2 ? 1 : 0); setdbase(MODBUS, EVENTS_CLASS3, dnpStatus.eventCountClass3 ? 1 : 0); setdbase(MODBUS, EVENT_COUNT_AI16, dnpStatus.eventCountAI16); setdbase(MODBUS, EVENT_COUNT_BI, dnpStatus.eventCountBI); setdbase(MODBUS, EVENT_COUNT_CLASS1, dnpStatus.eventCountClass1); setdbase(MODBUS, EVENT_COUNT_CLASS2, dnpStatus.eventCountClass2); setdbase(MODBUS, EVENT_COUNT_CLASS3, dnpStatus.eventCountClass3); release_resource(IO_SYSTEM); clear_events_flag = FALSE; bi_event_flag = FALSE; ai16_event_flag = FALSE; class0_report_flag = FALSE;

/* Read Event Triggers */ if (dbase(MODBUS, CLEAR_EVENTS))

{ setdbase(MODBUS, CLEAR_EVENTS, 0); clear_events_flag = TRUE;

} if (dbase(MODBUS, GENERATE_BI_EVENT))

{ setdbase(MODBUS, GENERATE_BI_EVENT, 0);

} bi_event_flag = FALSE; if (dbase(MODBUS, GENERATE_AI16_EVENT))

{

} setdbase(MODBUS, GENERATE_AI16_EVENT, 0); ai16_event_flag = FALSE; if (dbase(MODBUS, CLASS0_REPORT))

{

} setdbase(MODBUS, CLASS0_REPORT, 0); class0_report_flag = FALSE;

/* release IO resource */ release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 179

IEC 61131-3 C Tools Function Specifications

}

/* Clear DNP Event Log buffer if requested */ if (clear_events_flag)

{

} dnpClearEventLogs(); requested */

/* Generate a DNP Change Event for BI Point 0 if if (bi_event_flag)

{

} dnpGenerateEventLog(BI_POINT, 0);

*/

/* Generate a DNP Change Event for 16-bit AI Point 0 if requested */ if (ai16_event_flag)

{

} dnpGenerateEventLog(AI16_POINT, 0);

/* Send DNP Class 0 Unsolicited Report if requested if (class0_report_flag)

{

} dnpSendUnsolicitedResponse(CLASS0_FLAG);

}

/* release processor to other tasks */ release_processor();

Document (Version 2.51) 4/4/2011 180

IEC 61131-3 C Tools Function Specifications

dnpSendUnsolicitedResponse

Send DNP Unsolicited Response

Syntax

BOOLEAN dnpSendUnsolicitedResponse(

UINT16 classFlags

);

Description

The dnpSendUnsolicitedResponse function sends an Unsolicited Response message in DNP, with data from the specified classes. class specifies the class or classes of event data to include in the message. It can contain any combination of the following values; if multiple values are used they should be ORed together:

CLASS0_FLAG

CLASS1_FLAG

CLASS2_FLAG

CLASS3_FLAG enables Class 0 Unsolicited Responses enables Class 1 Unsolicited Responses enables Class 2 Unsolicited Responses enables Class 3 Unsolicited Responses

The function returns TRUE if the DNP unsolicited response message was successfully triggered. It returns FALSE if an unsolicited message of the same class is already pending, or if the DNP configuration has not been created.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

If no events are pending an empty unsolicited message will be sent.

Document (Version 2.51) 4/4/2011 181

IEC 61131-3 C Tools Function Specifications

dnpWriteRoutingTableEntry

Write Routing Table Entry

Syntax

#include <ctools.h>

BOOLEAN dnpWriteRoutingTableEntry (

UINT16 index,

UINT16 dnpAddress,

UINT16 commPort,

);

UINT16 DataLinkRetries,

UINT16 DataLinkTimeout

Description

This function writes an entry in the DNP routing table.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

The function returns TRUE if successful, FALSE otherwise.

Example

See the example in the section Error! Reference source not found..

Document (Version 2.51) 4/4/2011 182

IEC 61131-3 C Tools Function Specifications

dnpWriteRoutingTableDialStrings

Write DNP Routing Table Entry Dial Strings

Syntax

BOOLEAN dnpWriteRoutingTableDialStrings(

UINT16 index,

UINT16 primaryDialStringLength,

CHAR *primaryDialString,

UINT16 secondaryDialStringLength,

CHAR *secondaryDialString

);

Description

This function writes a primary and secondary dial string into an entry in the DNP routing table. index specifies the index of an entry in the DNP routing table. primaryDialStringLength specifies the length of primaryDialString excluding the null-terminator character. primaryDialString specifies the dial string used when dialing the target station.

This string is used on the first attempt. secondaryDialStringLength specifies the length of secondaryDialString excluding the null-terminator character. secondaryDialString specifies the dial string to be used when dialing the target station. It is used for the next attempt if the first attempt is unsuccessful.

Notes

This function needs to be used in conjunction with the dnpWriteRoutingTableEntry function to write a complete entry in the DNP routing table.

Document (Version 2.51) 4/4/2011 183

IEC 61131-3 C Tools Function Specifications

end_application

Terminates all Application Tasks

Syntax

#include <ctools.h> void end_application(void);

Description

The end_application function terminates all APPLICATION type tasks created with the create_task function. Stack space and resources used by the tasks are freed.

Notes

This function is used normally by communication protocols to stop an executing application program, prior to loading a new program into memory.

See Also

create_task, end_task

Document (Version 2.51) 4/4/2011 184

end_task

Terminate a Task

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> void end_task(unsigned task_ID);

Description

The end_task function terminates the task specified by task_ID. Stack space and resources used by the task are freed. The end_task function terminates both APPLICATION and SYSTEM type tasks.

See Also

create_task, getTaskInfo

Document (Version 2.51) 4/4/2011 185

IEC 61131-3 C Tools Function Specifications

endTimedEvent

Terminate Signaling of a Regular Event

Syntax

#include <ctools.h> unsigned endTimedEvent(unsigned event);

Description

This endTimedEvent function cancels signaling of a timed event, initialized by the startTimedEvent function.

The function returns TRUE if the event signaling was canceled.

The function returns FALSE if the event number is not valid, or if the event was not previously initiated with the startTimedEvent function. The function has no effect in these cases.

Notes

Valid events are numbered 0 to RTOS_EVENTS - 1. Any events defined in ctools.h are not valid events for use in an application program.

Example

See the examples for startTimedEvent.

See Also

startTimedEvent

Document (Version 2.51) 4/4/2011 186

IEC 61131-3 C Tools Function Specifications

enronInstallCommandHandler

Installs handler for Enron Modbus commands.

Syntax

#include <ctools.h> void enronInstallCommandHandler(

UINT16 (* function)(

UINT16 length,

UCHAR * pCommand,

UINT16 responseSize,

UINT16 * pResponseLength,

UCHAR * pResponse

)

);

Description

This function installs a handler function for Enron Modbus commands. The protocol driver calls this handler function each time a command is received for the Enron Modbus station. function is a pointer to the handler function. If function is NULL the handler is disabled.

The function has no return value.

Notes

The application needs to disable the handler when the application ends. This prevents the protocol driver from calling the handler while the application is stopped. Call the enronInstallCommmandHandler with a NULL pointer. The usual method is to create a task exit handler function to do this. See the example below for details.

The handler function has five parameters.

• length is the number of characters in the command message.

• pCommand is a pointer to the command message. The first byte in the message is the function code, followed by the Enron Modbus message. See the Enron Modbus protocol specification for details on the message formats.

• responseSize is the size of the response buffer in characters.

• pResponseLength is a pointer to a variable that will hold the number of characters in the response. If the handler returns TRUE, it needs to set this variable.

• pResponse is a pointer to a buffer that will hold the response message. The buffer size is responseSize characters. The handler cannot write beyond the end of the buffer. If the handler returns TRUE, it needs to set this variable.

The data needs to start with the function code and end with the last data

Document (Version 2.51) 4/4/2011 187

IEC 61131-3 C Tools Function Specifications byte. The protocol driver will add the station address, checksum, and message framing to the response.

The handler function returns the following values.

Value Description

NORMAL

ILLEGAL_FUNCTION

Indicates protocol handler should send a normal response message. Data are returned using pResponse and pResponseLength.

Indicates protocol handler should send an

Illegal Function exception response message.

This response should be used when the function code in the command is not recognized.

ILLEGAL_DATA_ADDRESS Indicates protocol handler should send an

Illegal Data Address exception response message. This response should be used when the data address in the command is not recognized.

ILLEGAL_DATA_VALUE Indicates protocol handler should send an

Illegal Data Value exception response message. This response should be used when invalid data is found in the command.

If the function returns NORMAL then the protocol driver sends the response message in the buffer pointed to by pResponse. If the function returns an exception response protocol driver returns the exception response to the caller.

The buffer pointed to by pResponse is not used.

Example

This program installs a simple handler function.

{

#include <ctools.h>

/* -----------------------------------------------------

This function processes Enron Modbus commands.

----------------------------------------------------- */

UINT16 commandHandler(

UINT16 length,

UCHAR * pCommand,

UINT16 responseSize,

UINT16 * pResponseLength,

UCHAR * pResponse

)

UCHAR command;

UINT16 result;

/* if a command byte was received */ if (length >= 1)

{

/* get the command byte */ command = pCommand[0];

Document (Version 2.51) 4/4/2011 188

IEC 61131-3 C Tools Function Specifications switch (command)

{

/* read unit status command */ case 7:

/* if the response buffer is large enough */ if (responseSize > 2)

{

} else

/* build the response header */ pResponse[0] = pCommand[0];

/* set the unit status */ pResponse[1] = 17;

/* set response length */

*pResponseLength = 2;

/* indicate the command worked */ result = NORMAL;

{

} break;

/* buffer is to small to respond */ result = ILLEGAL_FUNCTION;

}

} else

{

/* add cases for other commands here */ default:

}

/* command is invalid */ result = ILLEGAL_FUNCTION;

/* command is too short so return error */ result = ILLEGAL_FUNCTION;

} return result;

/* -----------------------------------------------------

This function unhooks the protocol handler when the

main task ends.

----------------------------------------------------- */ void mainExitHandler(void)

{

/* unhook the handler function */ enronInstallCommandHandler(NULL);

} void main(void)

{

TASKINFO thisTask;

/* install handler to execute when this task ends */

Document (Version 2.51) 4/4/2011 189

}

IEC 61131-3 C Tools Function Specifications thisTask = getTaskInfo(0); installExitHandler(thisTask.taskID, mainExitHandler);

/* install handler for Enron Modbus */ enronInstallCommandHandler(commandHandler);

/* infinite loop of main task */ while (TRUE)

{

}

/* add application code here */

Document (Version 2.51) 4/4/2011 190

IEC 61131-3 C Tools Function Specifications

forceLed

Set State of Force LED

Syntax

#include <ctools.h> void forceLed(unsigned state);

Description

The forceLed function sets the state of the FORCE LED. state may be either

LED_ON or LED_OFF.

Notes

The FORCE LED is used to indicate forced I/O.

See Also

setStatus

Document (Version 2.51) 4/4/2011 191

IEC 61131-3 C Tools Function Specifications

getABConfiguration

Get DF1 Protocol Configuration

Syntax

#include <ctools.h> struct ABConfiguration *getABConfiguration(FILE *stream, struct

ABConfiguration *ABConfig);

Description

The getABConfiguration function gets the DF1 protocol configuration parameters for the stream. If stream does not point to a valid serial port the function has no effect. ABConfig needs to point to an AB protocol configuration structure.

The getABConfiguration function copies the AB configuration parameters into the ABConfig structure and returns a pointer to it.

See Also

setABConfiguration

Example

This program displays the DF1 configuration parameters for com1.

#include <ctools.h> void main(void)

{ struct ABConfiguration ABConfig; getABConfiguration(com1, &ABConfig); printf("Min protected address: %u\r\n",

ABConfig.min_protected_address); printf("Max protected address: %u\r\n",

ABConfig.max_protected_address);

}

Document (Version 2.51) 4/4/2011 192

IEC 61131-3 C Tools Function Specifications

getBootType

Get Controller Boot Up State

Syntax

#include <ctools.h> unsigned getBootType(void);

Description

The getBootType function returns the boot up state of the controller. The possible return values are:

SERVICE

RUN controller started in SERVICE mode controller started in RUN mode

Example

}

#include <ctools.h> void main(void)

{ struct prot_settings settings;

/* Disable the protocol on serial port 1 */ settings.type = NO_PROTOCOL; settings.station = 1; settings.priority = 3; settings.SFMessaging = FALSE; request_resource(IO_SYSTEM); set_protocol(com1, &settings); release_resource(IO_SYSTEM);

/* Display the boot status information */ printf("Boot type: %d\r\n", getBootType());

Document (Version 2.51) 4/4/2011 193

IEC 61131-3 C Tools Function Specifications

getclock

Read the Real Time Clock

Syntax

#include <rtc.h> struct clock getclock(void);

Description

The getclock function reads the time and date from the real time clock hardware.

The getclock function returns a struct clock containing the time and date information.

Notes

The time format returned by the getclock function is not compatible with the standard UNIX style functions supplied by Microtec.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

setclock, getClockTime

Example

This program displays the current date and time.

}

#include <ctools.h> main(void)

{ struct clock now; request_resource(IO_SYSTEM); now = getclock(); /* read the clock */ release_resource(IO_SYSTEM); printf("%2d/%2d/%2d", now.day, now.month, now.year); printf("%2d:%2d\r\n",now.hour, now.minute);

Document (Version 2.51) 4/4/2011 194

IEC 61131-3 C Tools Function Specifications

getClockAlarm

Read the Real Time Clock Alarm Settings

Syntax

#include <ctools.h>

ALARM_SETTING getClockAlarm(void);

Description

The getClockAlarm function returns the alarm setting in the real time clock. The alarm is used to wake the controller from sleep mode.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

alarmIn, setClockAlarm

Document (Version 2.51) 4/4/2011 195

IEC 61131-3 C Tools Function Specifications

getClockTime

Read the Real Time Clock

Syntax

#include <ctools.h> void getClockTime(long * pDays, long * pHundredths);

Description

The getClockTime function reads the read time clock and returns the value as the number of whole days since 01/01/97 and the number of hundredths of a second since the start of the current day. The function works for 100 years from

01/01/97 to 12/31/96 then rolls over.

The function has two parameters: a pointer to the variable to hold the days; and a pointer to a variable to hold the hundredths of a second.

The function has no return value.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

setclock, getclock

Document (Version 2.51) 4/4/2011 196

getControllerID

Get Controller ID

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> void getControllerID(char * pID)

Description

This function writes the Controller ID to the string pointed to by pID. The

Controller ID is a unique ID for the controller set at the factory. The pointer pID needs to point to a character string of length CONTROLLER_ID_LEN.

Example

This program displays the Controller ID.

}

#include <ctools.h> void main(void)

{ char ctlrID[CONTROLLER_ID_LEN]; unsigned index; getControllerID(ctlrID); fprintf(com1, "\r\nController ID : "); for (index=0; index<CONTROLLER_ID_LEN; index++)

{

} fputc(ctlrID[index], com1);

Document (Version 2.51) 4/4/2011 197

IEC 61131-3 C Tools Function Specifications

getIOErrorIndication

Get I/O Module Error Indication

Syntax

#include <ctools.h> unsigned getIOErrorIndication(void);

Description

The getIOErrorIndication function returns the state of the I/O module error indication. TRUE is returned if the I/O module communication status is currently reported in the controller status register and Status LED. FALSE is returned if the

I/O module communication status is not reported.

Notes

Refer to the 5203/4 System Manual or the SCADAPack System Manual for further information on the Status LED and Status Output.

See Also

setIOErrorIndication

Document (Version 2.51) 4/4/2011 198

IEC 61131-3 C Tools Function Specifications

getPortCharacteristics

Get Serial Port Characteristics

Syntax

#include <ctools.h> unsigned getPortCharacteristics(FILE *stream, PORT_CHARACTERISTICS

*pCharacteristics);

Description

The getPortCharacteristics function gets information about features supported by the serial port pointed to by stream. If stream does not point to a valid serial port the function has no effect and FALSE is returned; otherwise TRUE is returned.

The getPortCharacteristics function copies the serial port characteristics into the structure pointed to by pCharacteristics.

Notes

Refer to the Overview of Functions section for detailed information on serial ports.

Refer to the Structures and Types section for a description of the fields in the

PORT_CHARACTERISTICS structure.

See Also

get_port

Example

}

#include <ctools.h> void main(void)

{

PORT_CHARACTERISTICS options; getPortCharacteristics(com3, &options); fprintf(com1, "Dataflow options: %d\r\n", options.dataflow); fprintf(com1, "Protocol options: %d\r\n", options.protocol);

Document (Version 2.51) 4/4/2011 199

IEC 61131-3 C Tools Function Specifications

getPowerMode

Get Current Power Mode

Syntax

#include <ctools.h>

BOOLEAN getPowerMode(UCHAR* cpuPower, UCHAR* lan, UCHAR* usbPeripheral, UCHAR* usbHost);

Description

The getPowerMode function places the current state of the CPU, LAN, USB peripheral port, and USB host port in the passed parameters. The following table lists the possible return values and their meaning.

Macro

PM_CPU_FULL

PM_CPU_REDUCED

PM_CPU_SLEEP

PM_LAN_ENABLED

PM_LAN_DISABLED

PM_USB_PERIPHERAL_ENAB

LED

PM_USB_PERIPHERAL_DISAB

LED

PM_USB_HOST_ENABLED

PM_USB_HOST_DISABLED

PM_UNAVAILABLE

Meaning

The CPU is set to run at full speed

The CPU is set to run at a reduced speed

The CPU is set to sleep mode

The LAN is enabled

The LAN is disabled

The USB peripheral port is enabled

The USB peripheral port is disabled

The USB host port is enabled

The USB host port is disabled

The status of the device could not be read.

TRUE is returned if the values placed in the passed parameters are valid, otherwise FALSE is returned.

The application program may set the current power mode with the setPowerMode function.

See Also

setPowerMode, setWakeSource, getWakeSource

Document (Version 2.51) 4/4/2011 200

IEC 61131-3 C Tools Function Specifications

get_port

Get Serial Port Configuration

Syntax

#include <ctools.h> struct pconfig *get_port(FILE *stream, struct pconfig *settings);

Description

The get_port function gets the serial port configuration for the stream. If stream does not point to a valid serial port the function has no effect.

The get_port function copies the serial port settings into the structure pointed to by settings and returns a pointer to the structure.

Notes

Refer to the Overview of Functions section for detailed information on serial ports.

Refer to the Structure and Types section for a description of the fields in the

pconfig structure.

See Also

set_port

}

Example

#include <ctools.h> void main(void)

{ struct pconfig settings; get_port(com1, &settings); printf("Baud rate: %d\r\n", settings.baud); printf("Duplex: %d\r\n", settings.duplex);

Document (Version 2.51) 4/4/2011 201

IEC 61131-3 C Tools Function Specifications

getProgramStatus

Get Program Status Flag

Syntax

#include <ctools.h> unsigned getProgramStatus( void );

Description

The getProgramStatus function returns the application program status flag. The status flag is set to NEW_PROGRAM when the C program is erased or downloaded to the controller from the program loader.

The application program may modify the status flag with the setProgramStatus function.

See Also

setProgramStatus

Example

This program stores a default alarm limit into the I/O database the first time it is run. On subsequent executions, it uses the limit in the database. The limit in the database can be modified by a communication protocol during execution.

#include <ctools.h>

#define HI_ALARM

#define ALARM_OUTPUT void main( void )

{ int inputValue;

41000

1026 if (getProgramStatus() == NEW_PROGRAM)

{

/* Set default alarm limit */ request_resource(IO_SYSTEM); setdbase(MODBUS, HI_ALARM, 4000); release_resource(IO_SYSTEM);

/* Use values in database from now on */ setProgramStatus(PROGRAM_EXECUTED);

} while (TRUE)

{ request_resource(IO_SYSTEM);

/* Test input against alarm limits */ if (ain(INPUT) > dbase(MODBUS, HI_ALARM)) setdbase(MODBUS, ALARM_OUTPUT, 1); else

Document (Version 2.51) 4/4/2011 202

}

}

IEC 61131-3 C Tools Function Specifications setdbase(MODBUS, ALARM_OUTPUT, 0); release_resource(IO_SYSTEM);

/* Allow other tasks to execute */ release_processor();

Document (Version 2.51) 4/4/2011 203

IEC 61131-3 C Tools Function Specifications

get_protocol

Get Protocol Configuration

Syntax

#include <ctools.h> struct prot_settings *get_protocol(FILE *stream, struct prot_settings *settings);

Description

The get_protocol function gets the communication protocol configuration for the

stream. If stream does not point to a valid serial port the function has no effect.

settings needs to point to a protocol configuration structure, prot_settings.

The get_protocol function copies the protocol settings into the structure pointed to by settings and returns a pointer to that structure.

Refer to the ctools.h file for a description of the fields in the prot_settings structure.

Refer to the Overview of Functions section for detailed information on communication protocols.

See Also

set_protocol

Example

This program displays the protocol configuration for com1.

#include <ctools.h> void main(void)

{ struct prot_settings settings; get_protocol(com1, &settings); printf("Type: %d\r\n", settings.type); printf("Station: %d\r\n", settings.station); printf("Priority: %d\r\n", settings.priority);

}

Document (Version 2.51) 4/4/2011 204

IEC 61131-3 C Tools Function Specifications

getProtocolSettings

Get Protocol Extended Addressing Configuration

Syntax

#include <ctools.h>

BOOLEAN getProtocolSettings(

FILE * stream,

PROTOCOL_SETTINGS * settings

);

Description

The getProtocolSettings function reads the protocol parameters for a serial port.

This function supports extended addressing.

The function has two parameters: stream is one of com1, com2, com3 or com4; and settings, a pointer to a PROTOCOL_SETTINGS structure. Refer to the description of the structure for an explanation of the parameters.

The function returns TRUE if the structure was changed. It returns FALSE if the stream is not valid.

Notes

Extended addressing is available on the Modbus RTU and Modbus ASCII protocols only. See the TeleBUS Protocols User Manual for details.

Refer to the TeleBUS Protocols User Manual section for detailed information on communication protocols.

See Also

setProtocolSettings, get_protocol

Example

This program displays the protocol configuration for com1.

#include <ctools.h> void main(void)

{

PROTOCOL_SETTINGS settings;

} if (getProtocolSettings(com1, &settings)

{ printf("Type: %d\r\n", settings.type); printf("Station: %d\r\n", settings.station); printf("Address Mode: %d\r\n", settings.mode); printf("SF Messaging: %d\r\n", settings.SFMessaging); printf("Priority: %d\r\n", settings.priority); else

Document (Version 2.51) 4/4/2011 205

}

{

}

IEC 61131-3 C Tools Function Specifications printf(“Serial port is not valid\r\n”);

Document (Version 2.51) 4/4/2011 206

IEC 61131-3 C Tools Function Specifications

getProtocolSettingsEx

Reads extended protocol settings for a serial port.

Syntax

#include <ctools.h>

BOOLEAN getProtocolSettingsEx(

FILE * stream,

PROTOCOL_SETTINGS_EX * pSettings

);

Description

The setProtocolSettingsEx function sets protocol parameters for a serial port.

This function supports extended addressing and Enron Modbus parameters.

The function has two arguments:

• stream specifies the serial port. It is one of com1, com2, com3 or com4.

• pSettings is a pointer to a PROTOCOL_SETTINGS_EX structure. Refer to the description of the structure for an explanation of the parameters.

The function returns TRUE if the settings were retrieved. It returns FALSE if the stream is not valid.

Notes

Extended addressing and the Enron Modbus station are available on the Modbus

RTU and Modbus ASCII protocols only. See the TeleBUS Protocols User Manual for details.

See Also

setProtocolSettingsEx

Example

This program displays the protocol configuration for com1.

#include <ctools.h> void main(void)

{

PROTOCOL_SETTINGS_EX settings; if (getProtocolSettingsEx(com1, &settings)

{

} printf("Type: %d\r\n", settings.type); printf("Station: %d\r\n", settings.station); printf("Address Mode: %d\r\n", settings.mode); printf("SF: %d\r\n", settings.SFMessaging); printf("Priority: %d\r\n", settings.priority); printf("Enron: %d\r\n", settings.enronEnabled); printf("Enron station: %d\r\n", settings.enronStation);

Document (Version 2.51) 4/4/2011 207

}

IEC 61131-3 C Tools Function Specifications else

{

} printf(“Serial port is not valid\r\n”);

Document (Version 2.51) 4/4/2011 208

IEC 61131-3 C Tools Function Specifications

get_protocol_status

Get Protocol Information

Syntax

#include <ctools.h> struct prot_status get_protocol_status(FILE *stream);

Description

The get_protocol_status function returns the protocol error and message counters for stream. If stream does not point to a valid serial port the function has no effect.

Refer to the Overview of Functions section for detailed information on communication protocols.

See Also

clear_protocol_status

Example

This program displays the checksum error counter for com2.

}

#include <ctools.h> void main(void)

{ struct prot_status status; status = get_protocol_status(com2); printf("Checksum: %d\r\n", status.checksum_errors);

Document (Version 2.51) 4/4/2011 209

IEC 61131-3 C Tools Function Specifications

getSFTranslation

Read Store and Forward Translation

Syntax

#include <ctools.h> struct SFTranslation getSFTranslation(unsigned index);

Description

The getSFTranslation function returns the entry at index in the store and forward address translation table. If index is invalid, a disabled table entry is returned.

The function returns a SFTranslation structure. It is described in the Structures

and Types section.

Notes

The TeleBUS Protocols User Manual describes store and forward messaging mode.

See Also

clearSFTranslationTable, checkSFTranslationTable

Example

See the example for the setSFTranslation function.

Document (Version 2.51) 4/4/2011 210

get_status

Get Serial Port Status

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> struct pstatus *get_status(FILE *stream, struct pstatus *status);

Description

The get_status function returns serial port error counters, I/O lines status and

I/O driver buffer information for stream. If stream does not point to a valid serial port the function has no effect. status needs to point to a valid serial port status structure, pstatus.

The get_status function copies the serial port status into the structure pointed to by status and returns a pointer to that structure settings.

Refer to the Overview of Functions section for detailed information on serial ports.

See Also

clear_errors

}

Example

This program displays the framing and parity errors for com1.

#include <ctools.h> void main(void)

{ struct pstatus status; get_status(com1, &status); printf("Framing: %d\r\n", status.framing); printf("Parity: %d\r\n", status.parity);

Document (Version 2.51) 4/4/2011 211

IEC 61131-3 C Tools Function Specifications

getStatusBit

Read Bits in Controller Status Code

Syntax

#include <ctools.h> unsigned getStatusBit(unsigned bitMask);

Description

The getStatusBit function returns the values of the bits indicated by bitMask in the controller status code.

See Also

setStatusBit, setStatus, clearStatusBit

Document (Version 2.51) 4/4/2011 212

IEC 61131-3 C Tools Function Specifications

getTaskInfo

Get Information on a Task

Syntax

#include <ctools.h>

TASKINFO getTaskInfo(unsigned taskID);

Description

The getTaskInfo function returns information about the task specified by taskID.

If taskID is 0 the function returns information about the current task.

Notes

If the specified task ID does not identify a valid task, all fields in the return data are set to zero. The calling function should check the taskID field in the

TASKINFO structure: if it is zero the remaining information is not valid.

Refer to the Structures and Types section for a description of the fields in the

TASKINFO structure.

Example

The following program displays information about all valid tasks.

{

#include <string.h>

#include <ctools.h> void main(void) struct prot_settings settings;

TASKINFO taskStatus; unsigned task; char state[6][20]; char type[2][20];

/* Set up state strings */ strcpy(state[TS_READY], "Ready"); strcpy(state[TS_EXECUTING], "Executing"); strcpy(state[TS_WAIT_ENVELOPE], "Waiting for Envelope"); strcpy(state[TS_WAIT_EVENT], "Waiting for Event"); strcpy(state[TS_WAIT_MESSAGE], "Waiting for Message"); strcpy(state[TS_WAIT_RESOURCE], "Waiting for Resource");

/* Set up type strings */ strcpy(type[APPLICATION], "Application"); strcpy(type[SYSTEM], "System");

/* Disable the protocol on serial port 1 */ settings.type = NO_PROTOCOL; settings.station = 1; settings.priority = 3; settings.SFMessaging = FALSE; request_resource(IO_SYSTEM); set_protocol(com1, &settings);

Document (Version 2.51) 4/4/2011 213

}

IEC 61131-3 C Tools Function Specifications release_resource(IO_SYSTEM);

/* display information about all tasks */ for (task = 0; task <= RTOS_TASKS; task++)

{ taskStatus = getTaskInfo(task); if (taskStatus.taskID != 0)

{

/* show information for valid task */

%d:\r\n", task); fprintf(com1, "\r\n\r\nInformation about task taskStatus.taskID); fprintf(com1, " Task ID: %d\r\n", fprintf(com1, " Priority: %d\r\n", taskStatus.priority); fprintf(com1, " Status: %s\r\n", state[taskStatus.status]); if (taskStatus.status == TS_WAIT_EVENT)

{ fprintf(com1, " Event: %d\r\n", taskStatus.requirement);

} if (taskStatus.status == TS_WAIT_RESOURCE)

{ fprintf(com1, " Resource: %d\r\n", taskStatus.requirement);

} taskStatus.error); fprintf(com1, " Error: %d\r\n", fprintf(com1, " Type: %s\r\n", type[taskStatus.type]);

}

} while (TRUE)

{

/* Allow other tasks to execute */

} release_processor();

Document (Version 2.51) 4/4/2011 214

IEC 61131-3 C Tools Function Specifications

getVersion

Get Firmware Version Information

Syntax

#include <ctools.h>

VERSION getVersion(void);

Description

The getVersion function obtains firmware version information. It returns a

VERSION structure. Refer to the Structures and Types section for a description of the fields in the VERSION structure.

Notes

The version information can be used to adapt a program to a specific type of controller or version of firmware. For example, a bug work-around could be executed only if older firmware is detected.

Example

This program displays the version information.

}

#include <ctools.h> void main(void)

{ struct prot_settings settings;

VERSION versionInfo;

/* Disable the protocol on serial port 1 */ settings.type = NO_PROTOCOL; settings.station = 1; settings.priority = 3; settings.SFMessaging = FALSE; request_resource(IO_SYSTEM); set_protocol(com1, &settings); release_resource(IO_SYSTEM);

/* Display the ROM version information */ versionInfo = getVersion(); fprintf(com1, "\r\nFirmware Information\r\n"); fprintf(com1, " Controller type: %d\r\n", versionInfo.controller); fprintf(com1, " Firmware version: %d\r\n", versionInfo.version); fprintf(com1, " Creation date: %s\r\n", versionInfo.date); fprintf(com1, " Copyright: %s\r\n", versionInfo.copyright);

Document (Version 2.51) 4/4/2011 215

IEC 61131-3 C Tools Function Specifications

getWakeSource

Gets Conditions for Waking from Sleep Mode

Syntax

#include <ctools.h> unsigned getWakeSource(void);

Description

The getWakeSource function returns a bit mask of the active wake up sources.

Valid wake up sources are listed below.

• WS_REAL_TIME_CLOCK

• WS_INTERRUPT_INPUT

• WS_LED_POWER_SWITCH

• WS_COUNTER_0_OVERFLOW

• WS_COUNTER_1_OVERFLOW

• WS_COUNTER_2_OVERFLOW

See Also

setWakeSource, sleep

Example

The following code fragment displays the enabled wake up sources. unsigned enabled; enabled = getWakeSource(); fputs("Enabled wake up sources:\r\n", com1); if (enabled & WS_REAL_TIME_CLOCK) fputs(" Real Time Clock\r\n", com1); if (enabled & WS_INTERRUPT_INPUT) fputs(" Interrupt Input\r\n", com1); if (enabled & WS_LED_POWER_SWITCH) fputs(" LED Power Switch\r\n", com1); if (enabled & WS_COUNTER_0_OVERFLOW) fputs(" Counter 0 Overflow\r\n", com1); if (enabled & WS_COUNTER_1_OVERFLOW) fputs(" Counter 1 Overflow\r\n", com1); if (enabled & WS_COUNTER_2_OVERFLOW) fputs(" Counter 2 Overflow\r\n", com1);

Document (Version 2.51) 4/4/2011 216

IEC 61131-3 C Tools Function Specifications

hartIO

Read and Write 5904 HART Interface Module

Syntax

#include <ctools.h>

BOOLEAN hartIO(unsigned module);

Description

This function reads the specified 5904 HART Interface module. It checks if a response has been received and if a corresponding command has been sent. If so, the response to the command is processed.

This function writes the specified 5904 HART Interface module. It checks if there is a new command to send. If so, this command is written to the 5904 interface.

The function has one parameter: the module number of the 5904 HART Interface

(0 to 3).

The function returns TRUE if the 5904 HART Interface responded and FALSE if it did not or if the module number is not valid.

Notes

This function is called automatically if the 5904 module is in the register assignment. Use this function to implement communication with the 5904 if register assignment is not used.

See Also

hartSetConfiguration, hartGetConfiguration, hartCommand

Document (Version 2.51) 4/4/2011 217

IEC 61131-3 C Tools Function Specifications

hartCommand

Send Command using HART Interface Module

Syntax

#include <ctools.h>

BOOLEAN hartCommand( unsigned module,

HART_DEVICE * const device,

HART_COMMAND * const command, void (* processResponse)( unsigned,

HART_RESPONSE)

);

Description

This function sends a command to a HART slave device using a HART interface module. This function can be used to implement HART commands not provided by the Network Layer API.

The function has four parameters. The first is the module number of the 5904

HART interface (0 to 3). The second is the device to which the command is to be sent.

The third parameter is a structure describing the command to send. This contains the command number, and the data field of the HART message. See the HART protocol documentation for your device for details.

The fourth parameter is a pointer to a function that will process the response.

This function is called when a response to the command is received by the HART interface. The function is defined as follows: void function_name(HART_RESPONSE response)

The single parameter is a structure containing the response code and the data field from the message.

The function returns TRUE if the 5904 HART Interface responded and FALSE if it did not or if the module number is not valid or there is an error in the command.

Notes

The function returns immediately after the command is sent. The calling program needs to wait for the response to be received. Use the hartStatus command to read the status of the command.

The number of attempts and the number of preambles sent are set with the hartSetConfiguration command.

A program needs to initialize the link before executing any other commands.

The function determines if long or short addressing is to be used by the command number. Long addressing is used for all commands except commands

0 and 11.

The functions hartCommand0, hartCommand1, etc. are used to send commands provided by the Network Layer.

Document (Version 2.51) 4/4/2011 218

IEC 61131-3 C Tools Function Specifications

See Also

hartStatus, hartSetConfiguration, hartCommand0, hartCommand1

Document (Version 2.51) 4/4/2011 219

IEC 61131-3 C Tools Function Specifications

hartCommand0

Read Unique Identifier

Syntax

#include <ctools.h>

BOOLEAN hartCommand0(unsigned module, unsigned address,

HART_DEVICE * const device);

Description

This function reads the unique identifier of a HART device using command 0 with a short-form address. This is a link initialization function.

The function has three parameters: the module-number of the 5904 module (0 to

3); the short-form address of the HART device (0 to 15); and a pointer to a

HART_DEVICE structure. The information read by command 0 is written into the

HART_DEVICE structure when the response is received by the 5904 HART interface module.

The function returns TRUE if the command was sent. The function returns

FALSE if the module number is invalid, or if the device address is invalid.

Notes

The function returns immediately after the command is sent. The calling program needs to wait for the response to be received. Use the hartStatus command to read the status of the command.

The number of attempts and the number of preambles sent are set with the hartSetConfiguration command.

A program needs to initialize the link before executing any other commands.

See Also

hartCommand11, hartStatus, hartSetConfiguration

Document (Version 2.51) 4/4/2011 220

IEC 61131-3 C Tools Function Specifications

hartCommand1

Read Primary Variable

Syntax

#include <ctools.h>

BOOLEAN hartCommand1(unsigned module, HART_DEVICE * const device,

HART_VARIABLE * primaryVariable);

Description

This function reads the primary variable of a HART device using command 1.

The function has three parameters: the module-number of the 5904 module (0 to

3); the device to be read; and a pointer to the primary variable. The variable pointed to by primaryVariable is updated when the response is received by the

5904 HART interface module.

The primaryVariable needs to be a static modular or global variable. A primaryVariable should be declared for each HART I/O module in use. A local variable or dynamically allocated variable may not be used because a late command response received after the variable is freed will write data over the freed variable space.

The function returns TRUE if the command was sent. The function returns

FALSE if the module number is invalid.

Notes

The HART_DEVICE structure needs to be initialized using hartCommand0 or hartCommand11.

The function returns immediately after the command is sent. The calling program needs to wait for the response to be received. Use the hartStatus command to read the status of the command.

The number of attempts and the number of preambles sent are set with the hartSetConfiguration command.

The code field of the HART_VARIABLE structure not changed. Command 1 does not return a variable code.

See Also

hartCommand2, hartStatus, hartSetConfiguration

Document (Version 2.51) 4/4/2011 221

IEC 61131-3 C Tools Function Specifications

hartCommand2

Read Primary Variable Current and Percent of Range

Syntax

#include <ctools.h>

BOOLEAN hartCommand2(unsigned module, HART_DEVICE * const device,

HART_VARIABLE * pvCurrent, HART_VARIABLE * pvPercent);

Description

This function reads the primary variable (PV), as current and percent of range, of a HART device using command 2.

The function has four parameters: the module-number of the 5904 module (0 to

3); the device to be read; a pointer to the PV current variable; and a pointer to the

PV percent variable. The pvCurrent and pvPercent variables are updated when the response is received by the 5904 HART interface.

The pvCurrent and pvPercent variables needs to be static modular or global variables. A pvCurrent and pvPercent variable should be declared for each

HART I/O module in use. A local variable or dynamically allocated variable may not be used because a late command response received after the variable is freed will write data over the freed variable space

The function returns TRUE if the command was sent. The function returns

FALSE if the module number is invalid.

Notes

The HART_DEVICE structure needs to be initialized using hartCommand0 or hartCommand11.

The function returns immediately after the command is sent. The calling program needs to wait for the response to be received. Use the hartStatus command to read the status of the command.

The number of attempts and the number of preambles sent are set with the hartSetConfiguration command.

The code field of both HART_VARIABLE structures is not changed. The response from the HART device to command 2 does not include variable codes.

The units field of the pvCurrent variable is set to 39 (units = mA). The units field of the pvPercent variable is set to 57 (units = percent). The response from the

HART device to command 2 does not include units.

See Also

hartCommand1, hartStatus, hartSetConfiguration

Document (Version 2.51) 4/4/2011 222

IEC 61131-3 C Tools Function Specifications

hartCommand3

Read Primary Variable Current and Dynamic Variables

Syntax

#include <ctools.h>

BOOLEAN hartCommand3(unsigned module, HART_DEVICE * const device,

HART_VARIABLE * variables);

Description

This function reads dynamic variables and primary variable current from a HART device using command 3.

The function has three parameters: the module number of the 5904 module (0 to

3); the device to be read; and a pointer to an array of five HART_VARIABLE structures.

The variables array needs to be static modular or global variables. An array of variables should be declared for each HART I/O module in use. A local variable or dynamically allocated variable may not be used because a late command response received after the variable is freed will write data over the freed variable space.

The variables array is updated when the response is received by the 5904 interface as follows.

Variable Contains

variables[0] primary variable current variables[1] primary variable variables[2] secondary variable variables[3] tertiary variable variables[4] fourth variable

The function returns TRUE if the command was sent. The function returns

FALSE if the module number is invalid.

Notes

The HART_DEVICE structure needs to be initialized using hartCommand0 or hartCommand11.

The function returns immediately after the command is sent. The calling program needs to wait for the response to be received. Use the hartStatus command to read the status of the command.

The number of attempts and the number of preambles sent are set with the hartSetConfiguration command.

Not all devices return primary, secondary, tertiary and fourth variables. If the device does not support a variable, zero is written into the value and units code for that variable.

Document (Version 2.51) 4/4/2011 223

IEC 61131-3 C Tools Function Specifications

The code field of both HART_VARIABLE structures is not changed. The response from the HART device to command 3 does not include variable codes.

The units field of variable[0] is set to 39 (units = mA). The response from the

HART device to command 3 does not include units.

See Also

hartCommand33, hartStatus, hartSetConfiguration

Document (Version 2.51) 4/4/2011 224

IEC 61131-3 C Tools Function Specifications

hartCommand11

Read Unique Identifier Associated with Tag

Syntax

#include <ctools.h>

BOOLEAN hartCommand11(unsigned module, char * deviceTag,

HART_DEVICE * device);

Description

This function reads the unique identifier of a HART device using command 11.

This is a link initialization function.

The function has three parameters: the module number of the 5904 module (0 to

3); a pointer to a null terminated string containing the tag of the HART device; and a pointer to a HART_DEVICE structure. The information read by command

11 is written into the HART_DEVICE structure when the response is received by the 5904 interface.

The function returns TRUE if the command was sent. The function returns

FALSE if the module number is invalid.

Notes

The function returns immediately after the command is sent. The calling program needs to wait for the response to be received. Use the hartStatus command to read the status of the command.

The number of attempts and the number of preambles sent are set with the hartSetConfiguration command.

A program needs to initialize the link before executing any other commands.

See Also

hartCommand0, hartStatus, hartSetConfiguration

Document (Version 2.51) 4/4/2011 225

IEC 61131-3 C Tools Function Specifications

hartCommand33

Read Transmitter Variables

Syntax

#include <ctools.h>

BOOLEAN hartCommand33(unsigned module, HART_DEVICE * const device, unsigned variableCode[4], HART_VARIABLE * variables);

Description

This function reads selected variables from a HART device using command 33.

The function has four parameters: the module number of the 5904 module (0 to

3); the device to be read; an array of codes; and a pointer to an array of four

HART_VARIABLE structures.

The variables array needs to be static modular or global variables. An array of variables should be declared for each HART I/O module in use. A local variable or dynamically allocated variable may not be used because a late command response received after the variable is freed will write data over the freed variable space.

The variableCode array specifies which variables are to be read from the transmitter. Consult the documentation for the transmitter for valid values.

The variables array is updated when the response is received by the 5904 interface as follows.

Variable Contains

variables[0] transmitter variable, code and units specified by variableCode[0] variables[1] transmitter variable, code and units specified by variableCode[1] variables[2] transmitter variable, code and units specified by variableCode[2] variables[3] transmitter variable, code and units specified by variableCode[3]

The function returns TRUE if the command was sent. The function returns

FALSE if the module number is invalid.

Notes

The HART_DEVICE structure needs to be initialized using hartCommand0 or hartCommand11.

The pointer variables needs to point to an array with at least four elements.

Document (Version 2.51) 4/4/2011 226

IEC 61131-3 C Tools Function Specifications

The function returns immediately after the command is sent. The calling program needs to wait for the response to be received. Use the hartStatus command to read the status of the command.

The number of attempts and the number of preambles sent are set with the hartSetConfiguration command.

The function requests four variables and expects four variables in the response.

See Also

hartCommand3, hartStatus, hartSetConfiguration

Document (Version 2.51) 4/4/2011 227

IEC 61131-3 C Tools Function Specifications

hartStatus

Return Status of Last HART Command Sent

Syntax

#include <ctools.h>

BOOLEAN hartStatus(unsigned module, HART_RESULT * status, unsigned

* code);

Description

This function returns the status of the last HART command sent by a 5904 module (0 to 3). Use this function to determine if a response has been received to a command sent.

The function has three parameters: the module number of the 5904 module; a pointer to the status variable; and a pointer to the additional status code variable.

The status and code variables are updated with the following information.

Result Status code

HART interface module is not communicating

Command ready to be sent

Command sent to device

HR_NoModuleResponse

HR_CommandPending

HR_CommandSent

Response received HR_Response not used not used current attempt number response code from HART device (see Notes)

No valid response received after all attempts made

HR_NoResponse

HR_WaitTransmit

0=no response from HART device.

Other = error response code from HART device

(see Notes) not used HART interface module is not ready to transmit

The function returns TRUE if the status was read. The function returns FALSE if the module number is invalid.

Notes

The response code from the HART device contains communication error and status information. The information varies by device, but there are some common values.

• If bit 7 of the high byte is set, the high byte contains a communication error summary. This field is bit-mapped. The table shows the meaning of each bit

Document (Version 2.51) 4/4/2011 228

IEC 61131-3 C Tools Function Specifications as defined by the HART protocol specifications. Consult the documentation for the HART device for more information.

Bit Description

3

2

1

0

6

5

4 vertical parity error overrun error framing error longitudinal parity error reserved – always 0 buffer overflow

Undefined

• If bit 7 of the high byte is cleared, the high byte contains a command response summary. The table shows common values. Other values may be defined for specific commands. Consult the documentation for the HART device.

Code Description

32

64

Busy – the device is performing a function that cannot be interrupted by this command

Command not Implemented – the command is not defined for this device.

• The low byte contains the field device status. This field is bit-mapped. The table shows the meaning of each bit as defined by the HART protocol specifications. Consult the documentation for the HART device for more information.

Document (Version 2.51) 4/4/2011 229

IEC 61131-3 C Tools Function Specifications

hartGetConfiguration

Read HART Module Settings

Syntax

#include <ctools.h>

BOOLEAN hartGetConfiguration(unsigned module, HART_SETTINGS * settings);

Description

This function returns the configuration settings of a 5904 module.

The function has two parameters: the module number of the 5904 module (0 to

3); and a pointer to the settings structure.

The function returns TRUE if the settings were read. The function returns FALSE if the module number is invalid.

See Also

hartSetConfiguration

Document (Version 2.51) 4/4/2011 230

IEC 61131-3 C Tools Function Specifications

hartSetConfiguration

Write HART Module Settings

Syntax

#include <ctools.h>

BOOLEAN hartSetConfiguration(unsigned module, HART_SETTINGS settings);

Description

This function writes configuration settings to a 5904 module.

The function has two parameters: the module number of the 5904 module (0 to

3); and a settings structure.

The function returns TRUE if the settings were written. The function returns

FALSE if the module number or the settings are invalid.

Notes

The configuration settings are stored in the EEPROM_RUN section of the

EEPROM. The user-defined settings are used when the controller is reset in the

RUN mode. Default settings are used when the controller is reset in the

SERVICE or COLD BOOT modes.

If a CNFG 5904 HART Interface module is in the register assignment, forced registers from it take precedence over the settings supplied here.

See Also

hartGetConfiguration

Document (Version 2.51) 4/4/2011 231

IEC 61131-3 C Tools Function Specifications

hartPackString

Convert String to HART Packed String

Syntax

#include <ctools.h> void hartPackString(char * pPackedString, const char * pString, unsigned sizePackedString);

Description

This function stores an ASCII string into a HART packed ASCII string.

The function has three parameters: a pointer to a packed array; a pointer to an unpacked array; and the size of the packed array. The packed array needs to be a multiple of three in size. The unpacked array needs to be a multiple of four in size. It should be padded with spaces at the end if the string is not long enough.

The function has no return value.

See Also

hartUnpackString

Document (Version 2.51) 4/4/2011 232

IEC 61131-3 C Tools Function Specifications

hartUnpackString

Convert HART Packed String to String

Syntax

#include <ctools.h> void hartUnpackString(char * pString, const char * pPackedString, unsigned sizePackedString);

Description

This function unpacks a HART packed ASCII string into a normal ASCII string.

The function has three parameters: a pointer to an unpacked array; a pointer to a packed array; and the size of the packed array. The packed array needs to be a multiple of three in size. The unpacked array needs to be a multiple of four in size.

The function has no return value.

See Also

hartPackString

Document (Version 2.51) 4/4/2011 233

IEC 61131-3 C Tools Function Specifications

install_handler

Install Serial Port Handler

Syntax

#include <ctools.h> void install_handler(FILE *stream, void *function(unsigned, unsigned));

Description

The install_handler function installs a serial port character handler function. The serial port driver calls this function each time it receives a character. If stream does not point to a valid serial port the function has no effect.

function specifies the handler function, which takes two arguments. The first argument is the received character. The second argument is an error flag. A nonzero value indicates an error. If function is NULL, the default handler for the port is installed. The default handler does nothing.

Notes

The install_handler function can be used to write custom communication protocols.

The handler is called at the completion of the receiver interrupt handler. RTOS calls (see functions listed in the section Real Time Operating System Functions at the start of this chapter) may not be made within the interrupt handler, with one exception. The interrupt_signal_event RTOS call can be used to signal events.

To optimize performance, minimize the length of messages on com3 and com4.

Examples of recommended uses for com3 and com4 are for local operator display terminals, and for programming and diagnostics using the IEC 61131-3 program.

Example

#include <ctools.h>

#define CHAR_RECEIVED 11

/* --------------------------------------------

signal

This routine signals an event when a character

is received on com1. If there is an error, the

character is ignored.

-------------------------------------------- */ void signal(unsigned character, unsigned error)

{ if (error == 0) interrupt_signal_event( CHAR_RECEIVED );

Document (Version 2.51) 4/4/2011 234

IEC 61131-3 C Tools Function Specifications

}

{

} character;

/* --------------------------------------------

main

This program displays all characters received

on com1 using an installed handler to signal

the reception of a character.

-------------------------------------------- */ void main(void) struct prot_settings protocolSettings; int character;

/* Disable protocol */ get_protocol(com1, &protocolSettings); protocolSettings.type = NO_PROTOCOL; request_resource(IO_SYSTEM); set_protocol(com1, &protocolSettings); release_resource(IO_SYSTEM);

/* Enable character handler */ install_handler(com1, signal);

/* Print each character as it is recevied */ while (TRUE)

{

} wait_event(CHAR_RECEIVED); character = fgetc(com1); fputs("character: ", com1); fputc(character, com1); fputs("\r\n", com1);

Document (Version 2.51) 4/4/2011 235

IEC 61131-3 C Tools Function Specifications

installClockHandler

Install Handler for Real Time Clock

Syntax

#include <ctools.h> void installClockHandler(void (*function)(void));

Description

The installClockHandler function installs a real time clock alarm handler function. The real time clock alarm function calls this function each time a real time clock alarm occurs.

function specifies the handler function. If function is NULL, the handler is disabled.

Notes

RTOS calls (see functions listed in the section Real Time Operating System

Functions at the start of this chapter) may not be made within the interrupt handler, with one exception. The interrupt_signal_event RTOS call can be used to signal events.

See Also

setClockAlarm

Example

/* --------------------------------------------

This program demonstrates how to call a

function at a specific time of day.

-------------------------------------------- */

#include <ctools.h>

#define ALARM_EVENT 20

/* --------------------------------------------

This function signals an event when the alarm occurs.

-------------------------------------------- */ void alarmHandler(void)

{ interrupt_signal_event( ALARM_EVENT );

}

/* --------------------------------------------

This task processes alarms signaled by the clock handler

-------------------------------------------- */ void processAlarms(void)

{

Document (Version 2.51) 4/4/2011 236

IEC 61131-3 C Tools Function Specifications

} while(TRUE)

{

} wait_event(ALARM_EVENT);

/* Reset the alarm for the next day */ request_resource(IO_SYSTEM); resetClockAlarm(); release_resource(IO_SYSTEM); fprintf(com1, "It’s quitting time!\r\n"); void main(void)

{ struct prot_settings settings;

ALARM_SETTING alarm;

/* Disable the protocol on serial port 1 */ settings.type = NO_PROTOCOL; settings.station = 1; settings.priority = 3; settings.SFMessaging = FALSE; request_resource(IO_SYSTEM); set_protocol(com1, &settings); release_resource(IO_SYSTEM);

/* Install clock handler function */ installClockHandler(alarmHandler);

/* Create task for processing alarm events */ create_task(processAlarms, 3, APPLICATION, 4);

/* Set real time clock alarm */ alarm.type = AT_ABSOLUTE; alarm.hour = 16; alarm.minute = 0; alarm.second = 0; request_resource(IO_SYSTEM); setClockAlarm(alarm); release_resource(IO_SYSTEM); while(TRUE)

{

/* body of main task loop */

/* other processing code */

/* Allow other tasks to execute */ release_processor();

}

}

Document (Version 2.51) 4/4/2011 237

IEC 61131-3 C Tools Function Specifications

installDbaseHandler

Install User Defined Dbase Handler

Syntax

#include <ctools.h> void installDbaseHandler

(

BOOLEAN (* handler)

(

unsigned address,

int *value

)

)

Description

The installDbaseHandler function allows an extension to be defined for the dbase() function.

If a handler is installed, it is called by the dbase function when one of the following conditions apply:

• There is no IEC 61131-3 application downloaded, or

• There is no IEC 61131-3 variable assigned to the specified Modbus address.

The function installDbaseHandler has one parameter: a pointer to a function to handle the dbase extensions. See the section Dbase Handler Function for a full description of the handler function and it’s parameters. If the pointer is NULL, no handler is installed.

The installed handler is always called with a Modbus address. Linear addresses are converted to Modbus addresses before calling the handler. Use the

installSetdbaseHandler function to install a write access handler for the same addresses handled by the dbase handler.

C Tools functions dbase and setdbase are used by all protocols to access

Modbus or Linear registers.

Notes

Call this function with the NULL pointer to remove the dbase handler. This needs to be done when the application program is ended with an exit handler. Use the installExitHandler function to install the exit handler.

If the Dbase handler is not removed within an exit handler, it will remain installed and continue to operate until the controller power is cycled. Erasing the C

Program from the Initialize dialog will not remove the Dbase handler. If the handler is located in a RAM-based application and left installed while a different

C application is downloaded, the original handler will be corrupted.

See Also

setdbase

Document (Version 2.51) 4/4/2011 238

IEC 61131-3 C Tools Function Specifications

Example

See example for Dbase Handler Function.

Document (Version 2.51) 4/4/2011 239

IEC 61131-3 C Tools Function Specifications

installSetdbaseHandler

Install User Defined Setdbase Handler

Syntax

#include <ctools.h> void installSetdbaseHandler

(

BOOLEAN (* handler)

(

unsigned address,

int value

)

)

Description

The installSetdbaseHandler function allows an extension to be defined for the setdbase() function.

If a handler is installed, it is called by the setdbase function when one of the following conditions apply:

• There is no IEC 61131-3 application downloaded, or

• There is no IEC 61131-3 variable assigned to the specified Modbus address.

The function installSetdbaseHandler has one parameter: a pointer to a function to handle the setdbase extensions. See the section Setdbase Handler Function for a description of the handler function and it’s parameters. If the pointer is

NULL, no handler is installed.

The installed handler is called with a Modbus address. Linear addresses are converted to Modbus addresses before calling the handler. Use the

installDbaseHandler function to install a read access handler for the same addresses handled by the setdbase handler.

C Tools functions dbase and setdbase are used by all protocols to access

Modbus or Linear registers.

Notes

Call this function with the NULL pointer to remove the setdbase handler. This needs to be done when the application program is ended with an exit handler.

Use the installExitHandler function to install the exit handler.

If the Setdbase handler is not removed within an exit handler, it will remain installed and continue to operate until the controller power is cycled. Erasing the

C Program from the Initialize dialog will not remove the Setdbase handler. If the handler is located in a RAM-based application and left installed while a different

C application is downloaded, the original handler will be corrupted.

See Also

setdbase, installDbaseHandler

Document (Version 2.51) 4/4/2011 240

IEC 61131-3 C Tools Function Specifications

Example

See example for Setdbase Handler Function.

Document (Version 2.51) 4/4/2011 241

IEC 61131-3 C Tools Function Specifications

Dbase Handler Function

User Defined Dbase Handler Function

The dbase handler function is a user-defined function that handles reading of

Modbus addresses not assigned in the IEC 61131-3 Dictionary. The function can have any name; dbaseHandler is used in the description below.

Syntax

#include <ctools.h>

BOOLEAN dbaseHandler( unsigned address, int * value

)

Description

This function is called by the dbase function when one of the following conditions apply:

• There is no IEC 61131-3 application downloaded, or

• There is no IEC 61131-3 variable assigned to the specified Modbus address.

The function has two parameters:

• The address parameter is the Modbus address to be read.

• The value parameter is a pointer to an integer containing the current value at

address.

If the address is to be handled, the handler function needs to return TRUE and the value pointed to by value needs to be set to the current value for the specified Modbus address.

If the address is not to be handled, the function needs to return FALSE and the value pointed to by value needs to be left unchanged.

Notes

The IO_SYSTEM resource needs to be requested before calling dbase, which calls this handler. Requesting the IO_SYSTEM resource ensures that only one task may call the handler at a time. Therefore, the function does not have to be re-entrant.

An array may be defined to store the current values for all Modbus addresses handled by this function. See the section Data Storage if a non-initialized data array is required.

See Also

installDbaseHandler

Document (Version 2.51) 4/4/2011 242

IEC 61131-3 C Tools Function Specifications

Example

/* ---------------------------------------------

dbaseHandler.c

This is a sample program for the installDbaseHandler and installSetdbaseHandler functions. This sample program demonstrates database handlers for the Modbus registers 1001 to 1100 and 31001 to 31100.

When the handlers are installed, calls to the functions dbase() or setdbase() for these Modbus registers will call these handlers.

This is true as long as the register is not already assigned to an

IEC 61131-3 variable.

Note that the dbase() and setdbase() functions are used by C applications and by all protocols.

----------------------------------------------- */

#include "ctools.h"

/* See section on Data Storage in this manual if coilDbase and inputDbase need to be saved when controller is off */

{ static unsigned inputDbase[100]; static BOOLEAN dbaseHandler( unsigned address, /* Modbus register address */ int *value /* pointer to value at address */

) if ((address > 1000) && (address <= 1100))

{

*value = coilDbase[address - 1001]; return TRUE;

} else if ((address > 31000)&&(address <= 31100))

{

*value = inputDbase[address - 31001];

} else return TRUE;

{

{

}

/* all other addresses are not handled */ return FALSE;

} static BOOLEAN setdbaseHandler( unsigned address,/* Modbus register address */ int value /* value to write at address */

) if ((address > 1000) && (address <= 1100))

{ if (value == 0)

Document (Version 2.51) 4/4/2011 243

IEC 61131-3 C Tools Function Specifications

}

{

} coilDbase[address - 1001] = FALSE;

} else

{

} coilDbase[address - 1001] = TRUE; return TRUE; else if ((address > 31000)&&(address <= 31100))

{ inputDbase[address - 31001] = value; return TRUE;

} else

{

}

/* all other addresses are not handled */ return FALSE; static void shutdown(void)

{

/* remove database handlers */

} installDbaseHandler(NULL); installSetdbaseHandler(NULL);

/* -----------------------------------------------

main

This routine is the main program.

The exit handler is installed.

The database handlers are installed.

The database is then updated continuously with

I/O data in the main loop.

----------------------------------------------- */ void main(void)

{ int ainData[8]; unsigned

TASKINFO index; taskStatus; taskStatus = getTaskInfo(0); installExitHandler(taskStatus.taskID, shutdown); installDbaseHandler(dbaseHandler); installSetdbaseHandler(setdbaseHandler); while (TRUE)

{ request_resource(IO_SYSTEM); isaRead8Ain(0, ainData); for (index=0; index<8; index++)

Document (Version 2.51) 4/4/2011 244

IEC 61131-3 C Tools Function Specifications

{ ainData[index]);

}

/* copy Ain data to the database */ setdbase(MODBUS, 31001 + index, isaWrite8Dout(0, doutData); release_resource(IO_SYSTEM); release_processor();

}

}

/* get Dout data from the database */ doutData <<= 1; doutData |= dbase(MODBUS, 1008 - index);

Document (Version 2.51) 4/4/2011 245

IEC 61131-3 C Tools Function Specifications

Setdbase Handler Function

User Defined Setdbase Handler Function

The setdbase handler function is a user-defined function that handles writing to

Modbus addresses not assigned in the IEC 61131-3 Dictionary. The function can have any name; setdbaseHandler is used in the description below.

Syntax

#include <ctools.h>

BOOLEAN setdbaseHandler( unsigned address, int value

)

Description

This function is called by the setdbase function when one of the following conditions apply:

• There is no IEC 61131-3 application downloaded, or

• There is no IEC 61131-3 variable assigned to the specified Modbus address.

The function has two parameters:

• The address parameter is the Modbus address to be written.

• The value parameter is the integer value to write to the Modbus address.

If the address is to be handled, the handler function needs to return TRUE and write value to the current value at the Modbus address.

If the address is not to be handled, the function needs to return FALSE and do nothing.

Notes

The IO_SYSTEM resource needs to be requested before calling setdbase, which calls this handler. Requesting the IO_SYSTEM resource ensures that only one task may call the handler at a time. Therefore, the function does not have to be re-entrant.

An array may be defined to store the current values for all Modbus addresses handled by this function. See the section Data Storage if a non-initialized data array is required.

See Also

installSetdbaseHandler

Example

See example for Dbase Handler Function.

Document (Version 2.51) 4/4/2011 246

IEC 61131-3 C Tools Function Specifications

installExitHandler

Install Handler Called when Task Ends

Syntax

#include <ctools.h> unsigned installExitHandler(unsigned taskID, void

(*function)(void));

Description

The installExitHandler function defines a function that is called when the task, specified by taskID, is ended. function specifies the handler function. If function is

NULL, the handler is disabled.

Notes

The exit handler function will be called when:

• the task is ended by the end_task function

• the end_application function is executed and the function is an

APPLICATION type function

• the program is stopped from the IEC 61131-3 program and the task is an

APPLICATION type function

• the C program is erased by the IEC 61131-3 program.

The exit handler function is not called if power to the controller is removed. In this case all execution stops when power is removedfails. The application program starts from the beginning when power is reapplied.

RTOS functions cannot be called from the exit handler.

Example

See the example for startTimedEvent.

Document (Version 2.51) 4/4/2011 247

IEC 61131-3 C Tools Function Specifications

installModbusHandler

Install User Defined Modbus Handler

Syntax

#include <ctools.h> void installModbusHandler( unsigned (* handler)(unsigned char *, unsigned,

unsigned char *, unsigned *)

);

Description

The installModbusHandler function allows user-defined extensions to standard

Modbus protocol. This function specifies a function to be called when a Modbus message is received for the station, but is not understood by the standard

Modbus protocol. The installed handler function is called only if the message is addressed to the station, and the message checksum is correct.

The function has one parameter: a pointer to a function to handle the messages.

See the section Handler Function for a description of the function and it’s parameters. If the pointer is NULL, no function is called for non-standard messages.

The function has no return value.

Notes

This function is used to create a user-defined extension to the standard Modbus protocol.

Call this function with the NULL pointer to disable processing of non-standard

Modbus messages. This needs to be done when the application program is ended with an exit handler. Use the installExitHandler function to install the exit handler.

If the Modbus handler is not disabled within an exit handler, it will remain installed and continue to operate until the controller power is cycled. Changing the protocol type or Erasing the C Program from IEC 61131-3 Initialize dialog will not remove the Modbus handler. If the handler is located in a RAM-based application and left enabled while a different C application is downloaded, the original handler will be corrupted.

See Also

Handler Function

Document (Version 2.51) 4/4/2011 248

IEC 61131-3 C Tools Function Specifications

Handler Function

User Specified Handler Function

The handler function is a user-specified function that handles processing of

Modbus messages not recognized by the protocol. The function can have any name; handler is used in the description below.

Syntax

#include <ctools.h> unsigned handler( unsigned char * message, unsigned messageLength, unsigned char * response, unsigned * responseLength

);

Description

This function handler is a user-defined handler for processing Modbus messages. The function is called for each Modbus message with a function code that is not recognized by the standard Modbus protocol.

The handler function should process the message string and create a response string. IF the message is not understood, one of the error codes should be returned.

The function has four parameters.

• The message parameter is a pointer to the first character of the received message. The first character of the message is the function code. The format of the data after the function code is defined by the function code.

• The messageLength parameter is the number of characters in the message.

• The response parameter is a pointer to the first character of a buffer to hold the response. The function should write the response into this buffer. The buffer is 253 characters long. The first character of the buffer is the function code of the message. The format of the data after the function code is defined by the function code.

• The responseLength parameter is a pointer to the length of the response.

The function should set the length of the response using this pointer. The length is the number of characters placed into the response buffer.

The function needs to return one of four values. The first causes a normal response to be sent. The others cause an exception response to be sent.

• NORMAL indicates the response and responseLength have been set to valid values. The Modbus protocol will add the station address and checksum to this string and transmit the reply to the master station.

• ILLEGAL_FUNCTION indicates the function code in the message was not understood. The handler function needs to return this value for all function

Document (Version 2.51) 4/4/2011 249

IEC 61131-3 C Tools Function Specifications codes it does not process. The Modbus protocol will return an Illegal

Function exception response.

• ILLEGAL_DATA_ADDRESS indicates the function code in the message was understood, but that the command referenced an address that is not valid.

The Modbus protocol will return an Illegal Data Address exception response.

• ILLEGAL_DATA_VALUE indicates the function code in the message was understood, but that the command included data that is not valid. The

Modbus protocol will return an Illegal Data Address exception response.

Function Codes Used

The following function codes are currently used by the TeleBUS Modbuscompatible protocol. All other function codes are available for use. For maximum compatibility with other Modbus and Modbus-compatible devices it is recommended that codes in the user-defined function code range be used first.

Code Type

5

6

7

15

16

17

65

66

1

2

3

4

67

68

69

70

Description

Modbus standard Read coil registers from I/O database

Modbus standard Read status registers from I/O database

Modbus standard Read holding registers from I/O database

Modbus standard Read input registers from I/O database

Modbus standard Write a single coil register

Modbus standard Write a single holding register

Modbus standard Read exception status

Modbus standard Write multiple coil registers

Modbus standard Write multiple holding registers

Modbus standard Report slave identification string

TeleBUS extension Used by Telepace

TeleBUS extension Used by Telepace

TeleBUS extension Used by Telepace

TeleBUS extension Used by Telepace

TeleBUS extension Used by Telepace

TeleBUS extension Used by Telepace

Notes

One handler function is used for all serial ports. Only one port will be active at any time. Therefore, the function does not have to be re-entrant.

The handler function is called from the Modbus protocol task. This task may preempt the execution of another task. If there are shared resources, the handler function needs to request and release the appropriate resources to ensure proper operation.

The station address is not included in the message or response string. It will be added to the response string before sending the reply.

Document (Version 2.51) 4/4/2011 250

IEC 61131-3 C Tools Function Specifications

The checksum is not included in the message or the response string. It will be added to the response string before sending the reply.

The maximum size of the response string is 253 bytes. If a longer response length is returned, the Modbus protocol will report an ILLEGAL_DATA_VALUE exception. The response will not be returned.

See Also

installModbusHandler

Example

/* -----------------------------------------------

handler.c

This is a sample program for the InstallModbusHandler function. This sample program uses function code 71 to demonstrate a simple method for using the installModbusHandler function.

When the handler is installed Modbus ASCII messages using function code 71 that are received on com2 of the controller will

be processed as shown in the program text.

To turn on digital output 00001:

From a terminal send the ASCII command :014701B7

Where;

01 is the station address

47 is the function code in hex

01 is the command for the function code

B7 is the message checksum

To turn off digital output 00001:

From a terminal send the ASCII command

Where;

01 is the station address

:014700B8

47 is the function code in hex

00 is the command for the function code

B8 is the message checksum

-------------------------------------------- */

#include <ctools.h> static unsigned myModbusHandler( unsigned char * message, unsigned messageLength, unsigned char * response, unsigned * responseLength

{

) unsigned char * pMessage; unsigned char * pResponse; pMessage = message; if (*pMessage == 71)

{

Document (Version 2.51) 4/4/2011 251

IEC 61131-3 C Tools Function Specifications

/* Action for command data */ pMessage++;

if (*pMessage == 0)

{ request_resource(IO_SYSTEM); setdbase(MODBUS, 1, 0); release_resource(IO_SYSTEM); pResponse = response;

*pResponse = 71; pResponse++;

*pResponse pResponse++;

*pResponse pResponse++;

*pResponse pResponse++;

= 'O';

= 'F';

= 'F';

}

*responseLength = 4; return NORMAL; if (*pMessage == 1)

{ request_resource(IO_SYSTEM); setdbase(MODBUS, 1, 1); release_resource(IO_SYSTEM);

} pResponse = response;

*pResponse = 71; pResponse++;

*pResponse pResponse++;

*pResponse pResponse++;

= 'O';

= 'N';

*responseLength = 3;

} return NORMAL;

} static void shutdown(void)

{

} installModbusHandler(NULL);

/* -----------------------------------------------

main

This routine is the modbus slave application.

Document (Version 2.51) 4/4/2011 252

IEC 61131-3 C Tools Function Specifications

Serial port com2 is configured for Modbus ASCII protocol.

Register Assignment is configured.

The modbus handler is installed.

The exit handler is installed.

-------------------------------------------- */ void main(void)

{

TASKINFO taskStatus; struct pconfig portSettings; struct prot_settings protSettings; portSettings.baud = BAUD9600; portSettings.duplex portSettings.parity portSettings.data_bits portSettings.stop_bits portSettings.flow_rx portSettings.flow_tx portSettings.type

= FULL;

= NONE;

= DATA7;

= STOP1;

= DISABLE;

= DISABLE;

= RS232; portSettings.timeout = 600; set_port(com2, &portSettings); get_protocol(com2, &protSettings); protSettings.station = 1; protSettings.type = MODBUS_ASCII; set_protocol(com2, &protSettings);

/* Configure Register Assignment */ clearRegAssignment(); addRegAssignment(DIN_generic8, 0, 10017, 0, 0, 0); addRegAssignment(SCADAPack_lowerIO,0, 1, 10001, 30001, 0); addRegAssignment(DIAG_protocolStatus,1,31000, 0, 0, 0);

/* Install Modbus Handler */ request_resource(IO_SYSTEM); installModbusHandler(myModbusHandler); release_resource(IO_SYSTEM);

/* Install Exit Handler */ taskStatus = getTaskInfo(0); installExitHandler(taskStatus.taskID, shutdown); while(TRUE)

{

} release_processor();

}

Document (Version 2.51) 4/4/2011 253

IEC 61131-3 C Tools Function Specifications

installRTCHandler

Install User Defined Real-Time-Clock Handler

Syntax

#include <ctools.h> void installRTCHandler( void (* rtchandler)(TIME *now,

TIME *new)

);

Description

The installRTCHandler function allows an application program to override

Modbus protocol and DNP protocol commands to set the real time clock. This function specifies a function to be called when a Modbus or DNP message is received for the station. The installed handler function is called only if the message is for setting the real time clock.

The function has one parameter: a pointer to a function to handle the messages.

See the section RTCHandler Function for a description of the function and its parameters. If the pointer is NULL, no function is called for set the real time clock commands, and the default method is used set the real time clock.

The function has no return value.

Notes

Call this function with the NULL pointer to disable processing of Set Real Time

Clock messages. This needs to be done when the application program is ended with an exit handler. Use the installExitHandler function to install the exit handler.

If the RTC handler is not disabled within an exit handler, it will remain installed and continue to operate until the controller power is cycled. Changing the protocol type or Erasing the C Program from the Telepace Initialize dialog will not remove the handler. If the handler is located in a RAM-based application and left enabled while a different C application is downloaded, the original handler will be corrupted.

See Also

RTCHandler Function, installExitHandler

Document (Version 2.51) 4/4/2011 254

IEC 61131-3 C Tools Function Specifications

RTCHandler Function

User Specified Real Time Clock Handler Function

The handler function is a user-specified function that handles processing of

Modbus messages or DNP messages for setting the real time clock. The function can have any name; rtchandler is used in the description below.

Syntax

#include <ctools.h> void rtchandler(

TIME *now,

TIME *new

);

Description

This function rtchandler is a user-defined handler for processing Modbus messages or DNP messages. The function is called only for messages that set the real time clock.

The rtchandler function should set the real time clock to the requested time. If there is a delay before this can be done, the time when the message was received is provided so that a correction to the requested time can be made.

The function has two parameters.

• The now parameter is a pointer to the structure containing the time when the message was received.

• The new parameter is a pointer to the structure containing the requested time.

The function does not return a value.

Notes

The IO_SYSTEM resource has already been requested before calling this function. If this function calls other functions that require the IO_SYSTEM resource (e.g. setclock), there is no need to request or release the resource.

This function cannot request or release the IO_SYSTEM resource.

See Also

installRTCHandler

Document (Version 2.51) 4/4/2011 255

IEC 61131-3 C Tools Function Specifications

interruptCounter

Read Interrupt Input Counter

Syntax

#include <ctools.h> unsigned long interruptCounter(unsigned clear);

Description

The interruptCounter routine reads the interrupt input as a counter. If clear is

TRUE the counter is cleared after reading; otherwise if it is FALSE the counter continues to accumulate.

Notes

The interrupt input is located on the 5203 or 5204 controller board. Refer to the

System Hardware Manual for more information on the hardware.

The counter increments on the rising edge of the input signal.

The maximum input frequency that can be counted by the interrupt input is 200

Hz.

See Also

interruptInput, readBoolVariable

Document (Version 2.51) 4/4/2011 256

IEC 61131-3 C Tools Function Specifications

interruptInput

Read State of Interrupt Digital Input

Syntax

#include <ctools.h> unsigned interruptInput(void);

Description

The interruptInput function reads the status of the interrupt input point on the controller. It returns TRUE if the input is energized and FALSE if it is not.

Notes

The interrupt input can be used as wake up source for the controller or as an additional a digital input. Refer to the System Hardware Manual for wiring details.

See Also

Document (Version 2.51) 4/4/2011 257

IEC 61131-3 C Tools Function Specifications

interrupt_signal_event

Signal Event in Interrupt Handler

Syntax

#include <ctools.h> void interrupt_signal_event(unsigned event_number);

Description

The interrupt_signal_event function is used in an interrupt handler to signal events. The function signals that the event_number event has occurred.

If there are tasks waiting for the event, the highest priority task is made ready to execute. Otherwise the event flag is incremented. Up to 255 occurrences of an event will be recorded. The current task is blocked of there is a higher priority task waiting for the event.

Notes

Refer to the Real Time Operating System section for more information on events.

This function is only to be used within an interrupt handler.

Valid events are numbered 0 to RTOS_EVENTS - 1. Any events defined in ctools.h. are not valid events for use in an application program.

See Also

signal_event, startTimedEvent, installClockHandler

Document (Version 2.51) 4/4/2011 258

IEC 61131-3 C Tools Function Specifications

interval

Set Timer Tick Interval

Syntax

#include <ctools.h> void interval(unsigned timer, unsigned value);

Description

The interval function sets the tick interval for timer to value. Tick intervals are measured in multiples of 0.1 second.

If the timer number is invalid, the task's error code is set to TIMER_BADTIMER.

Notes

The default timer tick interval is 1/10 second.

See Also

settimer,

Example

Set timer 5 to count 12 seconds using 1.0 s ticks. interval(5, 10); settimer(5, 12); settimer(5, 120);

/* 1.0 s ticks */

/* time = 12 seconds */

Set timer 5 to count 12 seconds using 0.1 s ticks. interval(5, 1); /* 0.1 s ticks */

/* time = 12 seconds */

Document (Version 2.51) 4/4/2011 259

IEC 61131-3 C Tools Function Specifications

ioBusReadByte

Read One Byte from I

2

C Slave Device

Syntax

#include <ctools.h> unsigned char ioBusReadByte(void);

Description

The ioBusReadByte function returns one byte read from an I

2

C slave device.

The byte is acknowledged by the master receiver. This function can be used multiple times in sequence to read data from a slave device. The last byte read from the slave needs to be read with the ioBusReadLastByte function.

If only one byte is to be read from a device, the ioBusReadLastByte function needs to be used instead of this function.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

ioBusStart, ioBusStop, ioBusReadLastByte, ioBusReadMessage,

ioBusSelectForRead ioBusSelectForWrite, ioBusWriteByte,

ioBusWriteMessage

Example

}

#include <ctools.h> void main(void)

{ unsigned char data[3]; unsigned char ioBusAddress = 114; request_resource(IO_SYSTEM); ioBusStart(); if (ioBusSelectForRead(ioBusAddress))

{ data[0] = ioBusReadByte(); data[1] = ioBusReadByte();

/* reading the last byte terminates read */ data[2] = ioBusReadLastByte();

} ioBusStop(); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 260

IEC 61131-3 C Tools Function Specifications

ioBusReadLastByte

Read Last Byte from I

2

C Slave Device

Syntax

#include <ctools.h> unsigned char ioBusReadLastByte(void);

Description

The ioBusReadLastByte function returns one byte read from an I

2

C slave device and terminates reading from the slave. The byte is not acknowledged by the master receiver. This signals to the slave device that the read is complete.

This function needs to be used once at the end of a read.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

ioBusStart, ioBusStop, ioBusReadByte, ioBusReadMessage,

ioBusSelectForRead ioBusSelectForWrite, ioBusWriteByte,

ioBusWriteMessage

Example

See example for ioBusReadByte.

Document (Version 2.51) 4/4/2011 261

IEC 61131-3 C Tools Function Specifications

ioBusReadMessage

Read Message from I

2

C Slave Device

Syntax

#include <ctools.h>

READSTATUS ioBusReadMessage(unsigned address, unsigned

numberBytes, unsigned char *message);

Description

The ioBusReadMessage function reads a specified number of bytes from an I

2

C slave device.

The function issues a START condition, selects the device for reading, reads the specified number of bytes, and issues a STOP condition. It detects if the device cannot be selected and, if so, aborts the read.

The function has three parameters: the address of the device; the number of bytes to read, numberBytes; and a pointer to a buffer, message, capable of holding the data read.

The function returns the status of the read:

Value

RS_success

RS_selectFailed

Description

read was successful slave device could not be selected

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

ioBusWriteMessage, ioBusStart, ioBusStop, ioBusReadByte

ioBusReadLastByte, ioBusSelectForRead ioBusSelectForWrite,

ioBusWriteByte, ioBusWriteMessage

Example

#include <ctools.h> void main(void)

{

READSTATUS status; request_resource(IO_SYSTEM);

/* Read a 10 byte message from I2C device */ status = ioBusReadMessage(ioBusAddress, 10, message); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 262

}

IEC 61131-3 C Tools Function Specifications if (status != RS_success)

{ fprintf(com1, "I/O error = %d\n\r", status);

}

Document (Version 2.51) 4/4/2011 263

IEC 61131-3 C Tools Function Specifications

ioBusSelectForRead

Select I

2

C Slave Device for Reading

Syntax

#include <ctools.h> unsigned ioBusSelectForRead(unsigned char address);

Description

The ioBusSelectForRead function selects an I

2

C slave device for reading. It writes the slave device address with the read/write bit set to the read state. The function handles the formatting of the address byte.

The function has one parameter, the address of the device. It returns TRUE if the write succeeded, that is the byte was acknowledged by the slave. It returns

FALSE if the write was unsuccessful, that is the byte was not acknowledged by the slave.

Notes

This function can only be used immediately after a START condition, e.g.

ioBusStart.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

ioBusStart, ioBusStop, ioBusReadByte, ioBusReadLastByte,

ioBusReadMessage, ioBusSelectForWrite, ioBusWriteByte,

ioBusWriteMessage

Example

See example for ioBusReadByte.

Document (Version 2.51) 4/4/2011 264

IEC 61131-3 C Tools Function Specifications

ioBusSelectForWrite

Select I

2

C Slave Device for Writing

Syntax

#include <ctools.h> unsigned ioBusSelectForWrite(unsigned char address);

Description

The ioBusSelectForWrite function selects an I

2

C slave device for writing. It writes the slave device address with the read/write bit set to the write state. The function handles the formatting of the address byte.

The function has one parameter, the address of the device. It returns TRUE if the write succeeded, that is the byte was acknowledged by the slave. It returns

FALSE if the write was unsuccessful, that is the byte was not acknowledged by the slave.

Notes

This function can only be used immediately after a START condition, e.g.

ioBusStart.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

ioBusStart, ioBusStop, ioBusReadByte, ioBusReadLastByte,

ioBusReadMessage, ioBusSelectForRead, ioBusWriteByte,

ioBusWriteMessage

Example

See example for ioBusWriteByte.

Document (Version 2.51) 4/4/2011 265

IEC 61131-3 C Tools Function Specifications

ioBusStart

Issue an I

2

C Bus START Condition

Syntax

#include <ctools.h> void ioBusStart(void);

Description

The ioBusStart function issues an I

2

C bus START condition.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

ioBusStop, ioBusReadByte, ioBusReadLastByte, ioBusReadMessage,

ioBusSelectForRead ioBusSelectForWrite, ioBusWriteByte,

ioBusWriteMessage

Example

See example for ioBusReadByte.

Document (Version 2.51) 4/4/2011 266

IEC 61131-3 C Tools Function Specifications

ioBusStop

Issue an I

2

C Bus STOP Condition

Syntax

#include <ctools.h> void ioBusStop(void);

Description

The ioBusStop function issues an I

2

C bus STOP condition.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

ioBusStart, ioBusReadByte, ioBusReadLastByte, ioBusReadMessage,

ioBusSelectForRead ioBusSelectForWrite, ioBusWriteByte,

ioBusWriteMessage

Example

See example for ioBusReadByte.

Document (Version 2.51) 4/4/2011 267

IEC 61131-3 C Tools Function Specifications

ioBusWriteByte

Write One Byte to I

2

C Slave Device

Syntax

#include <ctools.h> unsigned ioBusWriteByte(unsigned char byte);

Description

The ioBusWriteByte function writes one byte to an I

2

C slave device and returns the acknowledge signal from the slave. It returns TRUE if the write succeeded, that is the byte was acknowledged by the slave. It returns FALSE if the write was unsuccessful, that is the byte was not acknowledged by the slave.

This function can be used multiple times in sequence to write data to a device.

Notes

ioBusWriteByte can be used to write the address selection byte at the start of an I

2

C message; however, the ioBusSelectForRead and ioBusSelectForWrite functions provide a more convenient interface for doing this.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

ioBusStart, ioBusStop, ioBusReadByte, ioBusReadLastByte,

ioBusReadMessage, ioBusSelectForRead ioBusSelectForWrite,

ioBusWriteMessage

Example

}

#include <ctools.h> void main(void)

{ unsigned char data[2]; unsigned char ioBusAddress = 114; request_resource(IO_SYSTEM); ioBusStart(); if (ioBusSelectForWrite(ioBusAddress))

{ ioBusWriteByte(data[0]); ioBusWriteByte(data[1]);

} ioBusStop(); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 268

IEC 61131-3 C Tools Function Specifications

ioBusWriteMessage

Write Message to I

2

C Slave Device

Syntax

#include <ctools.h>

WRITESTATUS ioBusWriteMessage(unsigned address, unsigned

numberBytes, unsigned char *message);

Description

The ioBusWriteMessage function writes a specified number of bytes to an I

2

C slave device.

The function issues the START condition, selects the device for writing, writes the specified number of bytes, and issues a STOP condition. If the slave does not to acknowledge the selection or any data written to it, the write is aborted immediately.

The function has three parameters: the address of the device; the number of bytes to write, numberBytes; and a pointer to the buffer, message, containing the data.

The function returns the status of the write:

Value

WS_success

WS_selectFailed

WS_noAcknowledge

Description

write was successful slave could not be selected slave failed to acknowledge data

Notes

The IO_SYSTEM resource must be requested before calling this function.

See Also

ioBusStart, ioBusStop, ioBusReadByte, ioBusReadLastByte,

ioBusReadMessage, ioBusSelectForRead ioBusSelectForWrite,

ioBusWriteByte

Example

#include <ctools.h> void main(void)

{ unsigned char unsigned char

WRITESTATUS message[10]; ioBusAddress = 114; status; request_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 269

}

IEC 61131-3 C Tools Function Specifications

/* Write a 10 byte message to I2C device */ status = ioBusWriteMessage(ioBusAddress, 10, message); release_resource(IO_SYSTEM); if (status != WS_success)

{ fprintf(com1, "I/O error = %d\n\r", status);

}

Document (Version 2.51) 4/4/2011 270

ioClear

Turn Off all Outputs

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> void io_clear(void)

Description

The ioClear function turns off all outputs as follows.

• analog outputs are set to 0;

• digital outputs are turned set to 0 (turned off).

Also, all delayed digital I/O actions started by the pulse, pulse_train and

timeout functions are always canceled.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

Document (Version 2.51) 4/4/2011 271

IEC 61131-3 C Tools Function Specifications

ioDatabaseReset

Initialize I/O Database with Default Values

Syntax

#include <ctools.h> void ioDatabaseReset(void);

Description

The ioDatabaseReset function resets the target controller to default settings.

• Configuration parameters are reset to default values.

• All other registers are set to zero.

• All forcing is removed.

• Locked variables are unlocked.

• Set all database locations to zero

• Clear real time clock alarm settings

• Clear serial port event counters

• Clear store and forward configuration

• Enable LED power by default and return to default state after 5 minutes

• Set Outputs on Stop settings to Hold

• Set 5904 HART modem configuration for all modems

• Set Modbus/TCP default configuration

• Write new default data to Flash

Notes

This function can be used to restore the controller to its default state.

ioDatabaseReset has the same effect as selecting the Initialize Controller option from the Initialize command in the IEC 61131-3 program.

The IO_SYSTEM resource needs to be requested before calling this function.

Example

#include <ctools.h> void main(void)

{

/* Power Up Initialization */ request_resource(IO_SYSTEM); ioDatabaseReset(); release_resource(IO_SYSTEM);

/* ... the rest of the program */

Document (Version 2.51) 4/4/2011 272

}

IEC 61131-3 C Tools Function Specifications

Document (Version 2.51) 4/4/2011 273

IEC 61131-3 C Tools Function Specifications

ioRefresh

Update Outputs with Internal Data

Syntax

#include <ctools.h> void ioRefresh(void);

Description

The ioRefresh function resets devices on the 5000 I/O bus. Input channels are scanned to update their values from the I/O hardware. Output channels are scanned to write their values from output tables in memory.

Notes

This function is normally only used by the sleep function to restore output states when the controller wakes.

The IO_SYSTEM resource needs to be requested before calling this function.

Document (Version 2.51) 4/4/2011 274

IEC 61131-3 C Tools Function Specifications

ioReset

Reset 5000 I/O Modules

Syntax

#include <ctools.h> void ioReset(unsigned state)

Description

The ioReset function sets the state of the 5000 I/O bus reset signal. state may be TRUE or FALSE.

The reset signal restarts all devices on the 5000 I/O bus. Output modules clear all their output points. Input modules restart their input scanning. All modules remain in the reset state until the reset signal is set to FALSE.

Notes

Leaving the reset signal in the TRUE state disables I/O.

The ioClear function provides a more effective method of resetting the I/O system.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

ioRefresh, ioClear

Document (Version 2.51) 4/4/2011 275

IEC 61131-3 C Tools Function Specifications

isaRead16Din

Read 16 Digital Inputs

Syntax

#include <ctools.h> unsigned isaRead16Din(unsigned moduleAddress, unsigned *data)

Description

The isaRead16Din function reads any 16-point Digital Input Module at the specified moduleAddress. Data is read from the 16 digital inputs and copied to the 16-bit value pointed to by data.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned. The valid range for moduleAddress is 0 to

15.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead8Din

Example

This program displays the values of the 16 digital inputs read from a 16 point

Digital Input Module at module address 0.

}

#include <ctools.h> void main(void)

{ unsigned point; unsigned dinData;

/* Read data from digital input module */ request_resource(IO_SYSTEM); isaRead16Din(0, &dinData); release_resource(IO_SYSTEM);

/* Print module data */ fprintf(com1, "Point Value"); for (point = 0; point < 16; point++)

{ fprintf(com1, "\n\r%d ", point); putchar( dinData & 0x0001 ? '1' :'0'); dinData >>= 1;

}

Document (Version 2.51) 4/4/2011 276

IEC 61131-3 C Tools Function Specifications

isaRead32Din

Read 32 Digital Inputs

Syntax

#include <ctools.h> unsigned isaRead32Din(

UINT16 moduleAddress,

UINT32 *data)

Description

The isaRead32Din function reads any 32 point Digital Input Module at the specified moduleAddress. Data is read from the 32 digital inputs and copied to the 32-bit value pointed to by data.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned. The valid range for moduleAddress is 0 to

15.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead8Din, isaRead16Din

Example

This program displays the values of the 32 digital inputs read from a 32 point

Digital Input Module at module address 0.

}

#include <ctools.h> void main(void)

{

UINT16 point;

UINT32 dinData;

/* Read data from digital input module */ request_resource(IO_SYSTEM); isaRead32Din(0, &dinData); release_resource(IO_SYSTEM);

/* Print module data */ fprintf(com1, "Point

{

} fprintf(com1, "\n\r%d ", point); putchar( dinData & 0x0001 ? '1' :'0'); dinData >>= 1;

Value"); for (point = 0; point < 32; point++)

Document (Version 2.51) 4/4/2011 277

IEC 61131-3 C Tools Function Specifications

isaRead4Ain

Read 4 Analog Inputs

Syntax

#include <ctools.h> unsigned isaRead4Ain(unsigned moduleAddress, int *dataArray)

Description

The isaRead4Ain function reads any 4 point Analog Input Module at the specified moduleAddress. Data is read from the 4 analog inputs and copied to the array pointed to by dataArray. dataArray needs to point to an array of four 16bit integers.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned. The valid range for moduleAddress is 0 to

15.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead8Ain

Example

This program displays the values of the 4 analog inputs read from a 4 point

Analog Input Module at module address 0.

}

#include <ctools.h> void main(void)

{ unsigned point; int dataArray[4];

/* Read data from analog input module */ request_resource(IO_SYSTEM); isaRead4Ain(0, dataArray); release_resource(IO_SYSTEM);

/* Print module data */ fprintf(com1, "Point Value\n\r"); for (point = 0; point < 4; point++)

{ fprintf(com1, "%d %d\n\r", point, dataArray[point]);

}

Document (Version 2.51) 4/4/2011 278

IEC 61131-3 C Tools Function Specifications

isaRead4Counter

Read 4 Counter Inputs

Syntax

#include <ctools.h> unsigned isaRead4Counter(unsigned moduleAddress, unsigned long

*dataArray)

Description

The isaRead4Counter function reads any 4 point Counter Input Module at the specified moduleAddress. Data is read from the 4 counter inputs and copied to the array pointed to by dataArray. dataArray needs to point to an array of four 32bit integers.

The maximum count is 4,294,967,295. Counters roll back to 0 when the maximum count is exceeded.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned. The valid range for moduleAddress is 0 to

15.

The IO_SYSTEM resource needs to be requested before calling this function.

Example

This program displays the values of the 4 counter inputs read from a 4 point

Counter Input Module at module address 0.

}

#include <ctools.h> void main(void)

{ unsigned point;

/* Read data from counter input module */ request_resource(IO_SYSTEM); isaRead4Counter(0, dataArray); release_resource(IO_SYSTEM);

/* Print counter data */ fprintf(com1, "Point

{ fprintf(com1, "%d %lu\n\r", point, dataArray[point]);

}

Value\n\r"); for (point = 0; point < 4; point++)

Document (Version 2.51) 4/4/2011 279

IEC 61131-3 C Tools Function Specifications

isaRead4202Inputs

Read SCADAPack 4202 DR Inputs

Syntax

#include <ctools.h> unsigned isaRead4202Inputs( unsigned * dinData, int * ainData, unsigned long * counterDataArray

)

Description

The isaRead4202Inputs function reads the digital, counter, and analog inputs from the SCADAPack 4202 DR I/O. Data is read from the digital input and copied to the 16-bit value pointed to by dinData. Data is read from the analog input and copied to the value pointed to by ainData. Data is read from 2 counter inputs and copied to the array pointed to by counterDataArray. dinData needs to point to a 16-bit unsigned integer. ainData needs to point to a 16-bit integer. couterDataArray needs to point to an array of two 32-bit unsigned integers.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

When this function reads data from the transmitter, it also processes the receiver buffer for the com3 serial port. The com3 serial port is also continuously processed automatically. The additional service to the com3 receiver caused by this function does not affect the normal automatic operation of com3.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite4202Outputs

Example

This program displays the values of the 1 digital input, 2 counter inputs and 1 analog input read from SCADAPack 4202 DR I/O.

#include "ctools.h" void main(void)

{ unsigned reg, counter; unsigned long value;

request_resource(IO_SYSTEM);

/* Read 4202GFC inputs and write to I/O database */

Document (Version 2.51) 4/4/2011 280

IEC 61131-3 C Tools Function Specifications

}

ioRead4202Inputs (10001, 30001);

/* Print digital inputy */

fprintf(com2, "Register Value");

fprintf(com2, "\n\r%5u ", 10001);

fputc(dbase(MODBUS, 10001) ? '1' :'0', com2);

/* print analog input */

reg = 30001;

fprintf(com2, "\n\r%5u %d\n\r", reg, dbase(MODBUS, reg));

/* print counter inputs */

fprintf(com2, "Counter Value\n\r");

counter = 0;

for(reg = 30002; reg <= 30005; reg += 2)

{

value = (unsigned long) dbase(MODBUS, reg) |

((unsigned long) dbase(MODBUS, reg + 1) <<

16);

fprintf(com2, "%u:%5u %lu\n\r", counter++, reg, value);

}

release_resource(IO_SYSTEM);

/* Wait here forever */ while (TRUE)

{

NULL;

}

Document (Version 2.51) 4/4/2011 281

IEC 61131-3 C Tools Function Specifications

isaRead4202DSInputs

Read SCADAPack 4202 DS Inputs

Syntax

#include <ctools.h> unsigned isaRead4202DSInputs( unsigned * dinData, int * ainData, unsigned long * counterDataArray

)

Description

The isaRead4202DSInputs function reads the digital, counter, and analog inputs from the SCADAPack 4202 DS I/O. Data is read from the digital input and copied to the 16-bit value pointed to by dinData. Data is read from 3 analog inputs and copied to the value pointed to by ainData. Data is read from 2 counter inputs and copied to the array pointed to by counterDataArray. dinData needs to point to a 16-bit unsigned integer. ainData needs to point to an array of three 16-bit integers. couterDataArray needs to point to an array of two 32-bit unsigned integers.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

When this function reads data from the SCADAPack 4202 DS I/O it also processes the receiver buffer for the com3 serial port. The com3 serial port is also continuously processed automatically. The additional service to the com3 receiver caused by this function does not affect the normal automatic operation of com3.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite4202DSOutputs

Example

This program displays the values of the digital input, 2 counter inputs and 3 analog input read from the SCADAPack 4202 DS I/O.

#include "ctools.h" void main(void)

{ unsigned reg, counter; unsigned long value;

request_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 282

IEC 61131-3 C Tools Function Specifications

/* Read 4202 DS inputs and write to I/O database */

ioRead4202DSInputs (10001, 30001);

/* Print digital inputy */

fprintf(com2, "Register Value");

fprintf(com2, "\n\r%5u ", 10001);

fputc(dbase(MODBUS, 10001) ? '1' :'0', com2);

/* print analog inputs */

fprintf(com2, "\n\r%5u %d\n\r", 30001, dbase(MODBUS,

30001));

fprintf(com2, "%5u %d\n\r", 30002, dbase(MODBUS,

30002));

fprintf(com2, "%5u %d\n\r", 30003, dbase(MODBUS,

30003));

/* print counter inputs */

fprintf(com2, "Counter Value\n\r");

counter = 0;

for(reg = 30004; reg <= 30007; reg += 2)

{

value = (unsigned long) dbase(MODBUS, reg) |

((unsigned long) dbase(MODBUS, reg + 1) <<

16);

fprintf(com2, "%u:%5u %lu\n\r", counter++, reg, value);

}

release_resource(IO_SYSTEM);

/* Wait here forever */ while (TRUE)

{

} release_processor();

}

Document (Version 2.51) 4/4/2011 283

IEC 61131-3 C Tools Function Specifications

isaRead5505Inputs

Read 5505 Inputs

Syntax

#include <ctools.h> unsigned isaRead5505Inputs(

UINT16 moduleAddress,

UINT16 *dinData, float *ainDataArray,

)

Description

The isaRead5505Inputs function reads the digital and analog inputs from the specified 5505 I/O module. Data is read from the 16 digital inputs and copied to the variable pointed to by dinData. Data is read from the 4 analog inputs and copied to the array pointed to by ainDataArray. moduleAddress is the address of the 5505 module. Valid values are 0 to 15. dinData needs to point to a 16-bit unsigned integer. Each of the 16 bits in the integer represents one input point.

There are 16 digital input points on the module. The function of these inputs is described in the table below.

Point

Offset

0

Function

1

2

3

4

5

6

7

8

OFF = channel 0 RTD is good

ON = channel 0 RTD is open or PWR input is off

OFF = channel 0 data in range

ON = channel 0 data is out of range

OFF = channel 0 RTD is using 3-wire measurement

ON = channel 0 RTD is using 4-wire measurement reserved for future use

OFF = channel 1 RTD is good

ON = channel 1 RTD is open or PWR input is off

OFF = channel 1 data in range

ON = channel 1 data is out of range

OFF = channel 1 RTD is using 3-wire measurement

ON = channel 1 RTD is using 4-wire measurement reserved for future use

OFF = channel 2 RTD is good

ON = channel 2 RTD is open or PWR input is off

Document (Version 2.51) 4/4/2011 284

IEC 61131-3 C Tools Function Specifications

9

10

11

12

13

14

15

OFF = channel 2 data in range

ON = channel 2 data is out of range

OFF = channel 2 RTD is using 3-wire measurement

ON = channel 2 RTD is using 4-wire measurement reserved for future use

OFF = channel 3 RTD is good

ON = channel 3 RTD is open or PWR input is off

OFF = channel 3 data in range

ON = channel 3 data is out of range

OFF = channel 3 RTD is using 3-wire measurement

ON = channel 3 RTD is using 4-wire measurement reserved for future use ainDataArray needs to point to an array of four floating point values.

The function returns FALSE if an I/O error occurs; otherwise, TRUE is returned.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite5505Outputs

Example

This program displays the values of the 16 digital inputs and 4 analog inputs read from 5505 I/O module 3.

#include <ctools.h> void main(void)

{

UINT16 point;

UINT16 dinData; float ainDataArray[4];

/* Read input data from 5505 I/O module */ request_resource(IO_SYSTEM); isaRead5505Inputs(3, dinData, ainDataArray); release_resource(IO_SYSTEM);

/* Print digital input data */ fprintf(com1, "Din Point Value\n\r"); for (point = 0; point < 15; point++)

{ fprintf(com1, "\n\r%d ", point);

/* if the point is on */ if ((dinData & (1 << point)) != 0)

Document (Version 2.51) 4/4/2011 285

}

}

IEC 61131-3 C Tools Function Specifications

{

} else

{ putchar('1'); putchar('0');

}

/* Print analog input data */ fprintf(com1, "\r\nAin Point Value\n\r"); for (point = 0; point < 4; point++)

{ fprintf(com1, "%d %f\n\r", point,

} ainDataArray[point]);

Document (Version 2.51) 4/4/2011 286

IEC 61131-3 C Tools Function Specifications

isaRead5506Inputs

Read 5506 Inputs

Syntax

#include <ctools.h> unsigned isaRead5506Inputs(

UINT16 moduleAddress,

UCHAR *dinData,

INT16 *ainDataArray,

)

Description

The isaRead5506Inputs function reads the digital and analog inputs from the specified 5506 I/O module. Data is read from all 8 digital inputs and copied to the variable pointed to by dinData. Data is read from all 8 analog inputs and copied to the array pointed to by ainDataArray. moduleAddress is the address of the 5506 module. Valid values are 0 to 15. dinData needs to point to an 8-bit unsigned character. Each of the 8 bits in the character represents one input point. ainDataArray needs to point to an array of eight 16-bit integers.

The function returns FALSE if an I/O error occurs; otherwise, TRUE is returned.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite5506Outputs

Example

This program displays the values of the 8 digital inputs and 8 analog inputs read from 5506 I/O module 3.

#include <ctools.h> void main(void)

{

UINT16 point;

UCHAR dinData;

INT16 ainDataArray[8];

/* Read input data from 5506 I/O module */ request_resource(IO_SYSTEM); isaRead5506Inputs(3, dinData, ainDataArray); release_resource(IO_SYSTEM);

/* Print digital input data */

Document (Version 2.51) 4/4/2011 287

}

}

IEC 61131-3 C Tools Function Specifications fprintf(com1, "Din Point Value\n\r"); for (point = 0; point < 7; point++)

{ fprintf(com1, "\n\r%d ", point);

/* if the point is on */ if ((dinData & (1 << point)) != 0)

{ putchar('1');

} else

{ putchar('0');

}

/* Print analog input data */ fprintf(com1, "\r\nAin Point Value\n\r"); for (point = 0; point < 8; point++)

{ fprintf(com1, "%d %d\n\r", point, ainDataArray[point]);

}

Document (Version 2.51) 4/4/2011 288

IEC 61131-3 C Tools Function Specifications

isaRead5601Inputs

Read SCADAPack Lower I/O Module Inputs

Syntax

#include <ctools.h> unsigned isaRead5601Inputs(unsigned *dinData, int *ainDataArray)

Description

The isaRead5601Inputs function reads the digital and analog inputs from a 5601

I/O Module (SCADAPack lower I/O module). Data is read from the 16 digital inputs and copied to the 16-bit value pointed to by dinData. Data is read from the

8 analog inputs and copied to the array pointed to by ainDataArray.

dinData needs to point to a 16-bit integer. ainDataArray needs to point to an array of eight 16-bit integers.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

Note that when this function reads data from the 5601 it also processes the receiver buffer for the com3 serial port. If the controller type is a SCADAPack or

SCADAPack PLUS, the com3 serial port is also continuously processed automatically.

The additional service to the com3 receiver caused by this function does not affect the normal automatic operation of com3.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite5601Outputs

Example

This program displays the values of the 16 digital inputs and 8 analog inputs read from a 5601 I/O Module.

#include <ctools.h> void main(void)

{ unsigned point; unsigned dinData; int ainDataArray[8];

/* Read input data from 5601 module */ request_resource(IO_SYSTEM); isaRead5601Inputs(&dinData, ainDataArray); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 289

}

IEC 61131-3 C Tools Function Specifications

/* Print digital input data */ fprintf(com1, "Din Point Value\n\r"); for (point = 0; point < 16; point++)

{

} fprintf(com1, "\n\r%d ", point); putchar( dinData & 0x0001 ? '1' :'0'); dinData >>= 1;

/* Print analog input data */ fprintf(com1, "\r\nAin Point Value\n\r"); for (point = 0; point < 8; point++)

{ fprintf(com1, "%d %d\n\r", point, ainDataArray[point]);

}

Document (Version 2.51) 4/4/2011 290

IEC 61131-3 C Tools Function Specifications

isaRead5602Inputs

Read SCADAPack Upper I/O Module Inputs

Syntax

#include <ctools.h> unsigned isaRead5602Inputs(unsigned char *dinData, int

*ainDataArray)

Description

The isaRead5602Inputs function reads the inputs from a 5602 I/O Module

(SCADAPack Upper I/O module) as digital or analog inputs. Data is read from the 5 analog inputs and copied to the array pointed to by ainDataArray. The same 5 analog inputs are also read as 5 digital inputs and copied to the 8-bit value pointed to by dinData.

A digital input is ON if the corresponding filtered analog input value is greater than or equal to 20% of its full-scale value, otherwise it is OFF. Analog inputs 0 to

4 correspond to digital inputs 0 to 4.

dinData needs to point to an 8-bit value. ainDataArray needs to point to an array of five 16-bit integers.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

Note that when this function reads data from the 5602 it also processes the receiver buffer for the com4 serial port. If the controller type is a SCADAPack

LIGHT or SCADAPack PLUS, the com4 serial port is also continuously processed automatically.

The additional service to the com4 receiver caused by this function does not affect the normal automatic operation of com4.

The IO_SYSTEM resource must be requested before calling this function.

See Also

isaWrite5602Outputs

Example

This program displays the values of the 5 inputs read from a 5602 I/O Module as both digital and analog inputs.

#include <ctools.h> void main(void)

{ unsigned point; unsigned char dinData; int ainDataArray[5];

Document (Version 2.51) 4/4/2011 291

}

IEC 61131-3 C Tools Function Specifications

/* Read input data from 5601 module */ request_resource(IO_SYSTEM); isaRead5602Inputs(&dinData, ainDataArray); release_resource(IO_SYSTEM);

/* Print digital input data */ fprintf(com1, "Din Point Value\n\r"); for (point = 0; point < 5; point++)

{

} fprintf(com1, "\n\r%d ", point); putchar( dinData & 0x01 ? '1' :'0'); dinData >>= 1;

/* Print analog input data */ fprintf(com1, "\r\nAin Point Value\n\r"); for (point = 0; point < 5; point++)

{ fprintf(com1, "%d %d\n\r", point, ainDataArray[point]);

}

Document (Version 2.51) 4/4/2011 292

IEC 61131-3 C Tools Function Specifications

isaRead5604Inputs

Read 5604 Inputs

Syntax

#include <ctools.h> unsigned isaRead5604Inputs(

UCHAR *dinData,

INT16 *ainDataArray)

Description

The isaRead5604Inputs function reads the digital and analog inputs from 5604

I/O module. Data is read from the 35 digital inputs and copied to the array pointed to by dinData. Data is read from the 10 analog inputs and copied to the array pointed to by ainDataArray. dinData needs to point to an array of five 8-bit unsigned characters. Each bit in the array represents one input point. ainDataArray needs to point to an array of ten 16-bit integers.

The function returns FALSE if an I/O error occurs; otherwise, TRUE is returned.

Notes

When this function reads data from the 5604 I/O module it also processes the receiver buffer for the com3 serial port. The com3 serial port is also continuously processed automatically. The additional service to the com3 receiver caused by this function does not affect the normal automatic operation of com3.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite5604Outputs

Example

This program displays the values of the 35 digital inputs and 10 analog inputs read from the 5604 I/O.

#include <ctools.h> void main(void)

{

UINT16 point;

UCHAR dinData[5];

INT16 ainDataArray[10];

/* Read input data from 5604 I/O */ request_resource(IO_SYSTEM); isaRead5604Inputs(dinData, ainDataArray); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 293

}

}

IEC 61131-3 C Tools Function Specifications

/* Print digital input data */ fprintf(com1, "Din Point Value\n\r"); for (point = 0; point < 35; point++)

{ fprintf(com1, "\n\r%d ", point);

}

/* if the point is on */ if (dinData[point/8] & (1 << (point % 8)) != 0)

{

} else

{ putchar('1'); putchar('0');

/* Print analog input data */ fprintf(com1, "\r\nAin Point Value\n\r"); for (point = 0; point < 10; point++)

{

} fprintf(com1, "%d %d\n\r", point, ainDataArray[point]);

Document (Version 2.51) 4/4/2011 294

IEC 61131-3 C Tools Function Specifications

isaRead5606Inputs

Read 5606 Inputs

Syntax

#include <ctools.h> unsigned isaRead5606Inputs(

UINT16 moduleAddress,

UCHAR *dinDataArray,

INT16 *ainDataArray,

)

Description

The isaRead5606Inputs function reads the digital and analog inputs from the specified 5606 I/O module. Data is read from the 40 digital inputs and copied to the array pointed to by dinDataArray. Data is read from the 8 analog inputs and copied to the array pointed to by ainDataArray. moduleAddress is the address of the 5606 module. Valid values are 0 to 7. dinDataArray needs to point to an array of five 8-bit unsigned characters. Each bit in the array represents one input point. ainDataArray needs to point to an array of eight 16-bit integers.

The function returns FALSE if an I/O error occurs; otherwise, TRUE is returned.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite5606Outputs

Example

This program displays the values of the 40 digital inputs and 8 analog inputs read from 5606 I/O module 3.

#include <ctools.h> void main(void)

{

UINT16 point;

UCHAR dinData[5];

INT16 ainDataArray[8];

/* Read input data from 5606 I/O module */ request_resource(IO_SYSTEM); isaRead5606Inputs(3, dinData, ainDataArray); release_resource(IO_SYSTEM);

/* Print digital input data */

Document (Version 2.51) 4/4/2011 295

}

}

IEC 61131-3 C Tools Function Specifications fprintf(com1, "Din Point Value\n\r"); for (point = 0; point < 40; point++)

{ fprintf(com1, "\n\r%d ", point);

/* if the point is on */ if ((dinData[point/8] & (1 << (point % 8))) != 0)

{ putchar('1');

} else

{ putchar('0');

}

/* Print analog input data */ fprintf(com1, "\r\nAin Point Value\n\r"); for (point = 0; point < 8; point++)

{ fprintf(com1, "%d %d\n\r", point, ainDataArray[point]);

}

Document (Version 2.51) 4/4/2011 296

IEC 61131-3 C Tools Function Specifications

isaRead8Ain

Read 8 Analog Inputs

Syntax

#include <ctools.h> unsigned isaRead8Ain(unsigned moduleAddress, int *dataArray)

Description

The isaRead8Ain function reads any 8 point Analog Input Module at the specified moduleAddress. Data is read from all 8 analog inputs and copied to the array pointed to by dataArray. dataArray needs to point to an array of eight 16-bit integers.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned. The valid range for moduleAddress is 0 to

15.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead4Ain

Example

This program displays the values of the 8 analog inputs read from an 8 point

Analog Input Module at module address 0.

}

#include <ctools.h> void main(void)

{ unsigned point; int dataArray[8];

/* Read data from analog input module */ request_resource(IO_SYSTEM); isaRead8Ain(0, dataArray); release_resource(IO_SYSTEM);

/* Print module data */ fprintf(com1, "Point Value\n\r"); for (point = 0; point < 8; point++)

{ fprintf(com1, "%d %d\n\r", point, dataArray[point]);

}

Document (Version 2.51) 4/4/2011 297

IEC 61131-3 C Tools Function Specifications

isaRead8Din

Read 8 Digital Inputs

Syntax

#include <ctools.h> unsigned isaRead8Din(unsigned moduleAddress, unsigned char *data)

Description

The isaRead8Din function reads any 8 point Digital Input Module at the specified

moduleAddress. Data is read from the 8 digital inputs and copied to the 8-bit value pointed to by data.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned. The valid range for moduleAddress is 0 to

15.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead16Din

Example

This program displays the values of the 8 digital inputs read from an 8 point

Digital Input Module at module address 0.

}

#include <ctools.h> void main(void)

{ unsigned point; unsigned char dinData;

/* Read data from digital input module */ request_resource(IO_SYSTEM); isaRead8Din(0, &dinData); release_resource(IO_SYSTEM);

/* Print module data */ fprintf(com1, "Point Value"); for (point = 0; point < 8; point++)

{ fprintf(com1, "\n\r%d ", point); putchar( dinData & 0x01 ? '1' :'0'); dinData >>= 1;

}

Document (Version 2.51) 4/4/2011 298

IEC 61131-3 C Tools Function Specifications

isaReadLPInputs

Read SCADAPack LP Inputs

Syntax

#include <ctools.h> unsigned isaReadLPInputs(unsigned *dinData, int *ainDataArray)

Description

The isaReadLPInputs function reads the digital and analog inputs from

SCADAPack LP I/O. Data is read from the 16 digital inputs and copied to the 16bit value pointed to by dinData. Data is read from the 8 analog inputs and copied to the array pointed to by ainDataArray. dinData needs to point to a 16-bit integer. ainDataArray must point to an array of eight 16-bit integers.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

When this function reads data from the SCADAPack LP I/O it also processes the receiver buffer for the com3 serial port. The com3 serial port is also continuously processed automatically. The additional service to the com3 receiver caused by this function does not affect the normal automatic operation of com3.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWriteLPOutputs

Example

This program displays the values of the 16 digital inputs and 8 analog inputs read from the SCADAPack LP I/O.

#include <ctools.h> void main(void)

{ unsigned point; unsigned dinData; int ainDataArray[8];

/* Read input data from SCADAPack LP I/O */ request_resource(IO_SYSTEM); isaReadLPInputs (&dinData, ainDataArray); release_resource(IO_SYSTEM);

/* Print digital input data */ fprintf(com1, "Din Point Value\n\r");

Document (Version 2.51) 4/4/2011 299

}

IEC 61131-3 C Tools Function Specifications for (point = 0; point < 16; point++)

{ fprintf(com1, "\n\r%d ", point); putchar( dinData & 0x0001 ? '1' :'0'); dinData >>= 1;

}

/* Print analog input data */ fprintf(com1, "\r\nAin Point Value\n\r"); for (point = 0; point < 8; point++)

{ fprintf(com1, "%d %d\n\r", point, ainDataArray[point]);

}

Document (Version 2.51) 4/4/2011 300

IEC 61131-3 C Tools Function Specifications

isaReadSP100Inputs

Read SCADAPack 100 Inputs

Syntax

#include <ctools.h> unsigned isaReadSP100Inputs( unsigned *dinData, int *ainDataArray, unsigned long *cinDataArray

)

Description

The isaReadSP100Inputs function reads the digital, analog, and counter inputs from SCADAPack 100 I/O. Data is read from the 6 digital inputs and copied to the 16-bit value pointed to by dinData. Data is read from the 6 analog inputs and copied to the array pointed to by ainDataArray. Data is read from the counter input and copied to the array pointed to by cinDataArray. dinData needs to point to a 16-bit integer. ainDataArray needs to point to an array of six 16-bit integers. cinDataArray must point to an array of one 32-bit integer.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

The first four analog inputs are read from the external analog inputs.

The fifth and sixth analog inputs are read from the temperature sensor and the battery voltage sensor respectively.

See Also

isaWriteSP100Outputs

Example

This program displays the values of the 6 digital inputs, 6 analog inputs, and one counter input read from the SCADAPack 100 I/O.

#include <ctools.h> void main(void)

{ unsigned point; unsigned dinData; int ainDataArray[6]; unsigned long cinData;

/* Read input data from SCADAPack 100 I/O */

Document (Version 2.51) 4/4/2011 301

}

IEC 61131-3 C Tools Function Specifications request_resource(IO_SYSTEM); isaReadSP100Inputs (&dinData, ainDataArray, &cinData); release_resource(IO_SYSTEM);

/* Print digital input data */ for (point = 0; point < 6; point++)

{ if (dinData & 0x0001)

{

} else

{ fprintf(com1, "DIN %d = 1\r\n", point);

}

} fprintf(com1, "DIN %d = 0\r\n", point); dinData >>= 1; fprintf(com1, "\r\n");

/* Print analog input data */ for (point = 0; point < 6; point++)

{ fprintf(com1, "AIN %d = %d\n\r", point, ainDataArray[point]);

} fprintf(com1, "\r\n");

/* Print counter input data */ fprintf(com1, "\r\nCounter = %ul\n\r", cinData);

Document (Version 2.51) 4/4/2011 302

IEC 61131-3 C Tools Function Specifications

isaWrite16Dout

Write to 16 Digital Outputs

Syntax

#include <ctools.h> unsigned isaWrite16Dout(unsigned moduleAddress, unsigned data)

Description

The isaWrite16Dout function writes data to any 16-point Digital Output Module at the specified moduleAddress. Data from the specified 16-bit value is written to the 16 digital outputs.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned. The valid range for moduleAddress is 0 to

15.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite8Dout

Example

This program turns ON all 16 digital outputs of a 16-point Digital Output Module at module address 0.

#include <ctools.h> void main(void)

{

/* Write data to digital output module */ request_resource(IO_SYSTEM); isaWrite16Dout(0, 0xFFFF); release_resource(IO_SYSTEM);

}

Document (Version 2.51) 4/4/2011 303

IEC 61131-3 C Tools Function Specifications

isaWrite2Aout

Write to 2 Analog Outputs

Syntax

#include <ctools.h> unsigned isaWrite2Aout(unsigned moduleAddress, int *dataArray)

Description

The isaWrite2Aout function writes data to any 2 point Analog Output Module at the specified moduleAddress. Data is read from the array pointed to by dataArray and written to the 2 analog outputs. dataArray needs to point to an array of two

16-bit integers.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned. The valid range for moduleAddress is 0 to

15.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite4Aout, isaWrite5303Aout

Example

This program sets both analog outputs to half scale on a 2-point Analog Output

Module at module address 0.

}

#include <ctools.h> void main(void)

{ int dataArray[2]; dataArray[0] = 16384; dataArray[1] = 16384;

/* Write data to analog output module */ request_resource(IO_SYSTEM); isaWrite2Aout(0, dataArray); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 304

IEC 61131-3 C Tools Function Specifications

isaWrite32Dout

Write to 32 Digital Outputs

Syntax

#include <ctools.h> unsigned isaWrite32Dout(

UINT16 moduleAddress,

UINT32 data)

Description

The isaWrite32Dout function writes data to any 32-point Digital Output Module at the specified moduleAddress. Data from the specified 32-bit value is written to the 32 digital outputs.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned. The valid range for moduleAddress is 0 to

15.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite8Dout, isaWrite16Dout

Example

This program turns ON all 32 digital outputs of a 32-point Digital Output Module at module address 0.

#include <ctools.h> void main(void)

{

}

/* Write data to digital output module */ request_resource(IO_SYSTEM); isaWrite32Dout(0, 0xFFFFFFFF); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 305

IEC 61131-3 C Tools Function Specifications

isaWrite4Aout

Write to 4 Analog Outputs

Syntax

#include <ctools.h> unsigned isaWrite4Aout(unsigned moduleAddress, int *dataArray)

Description

The isaWrite4Aout function writes data to any 4 point Analog Output Module at the specified moduleAddress. Data is read from the array pointed to by dataArray and written to the 4 analog outputs. dataArray needs to point to an array of four

16-bit integers.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned. The valid range for moduleAddress is 0 to

15.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite2Aout, isaWrite5303Aout

Example

This program sets all 4 analog outputs to half scale on a 4 point Analog Output

Module at module address 0.

}

#include <ctools.h> void main(void)

{ int dataArray[4]; dataArray[0] = 16384; dataArray[1] = 16384; dataArray[2] = 16384; dataArray[3] = 16384;

/* Write data to analog output module */ request_resource(IO_SYSTEM); isaWrite4Aout(0, dataArray); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 306

IEC 61131-3 C Tools Function Specifications

isaWrite4AoutChecksum

Write to 4 Point Analog Output Module with Checksum

Syntax

#include <ctools.h>

UINT16 isaWrite4AoutChecksum(

UINT16 moduleAddress,

INT16 *dataArray

)

Description

The isaWrite4AoutChecksum function writes data to a 4-point analog output module with checksum support. The function can be used with 5304 analog output modules. Use the isaWrite4Aout function for all other analog output modules.

The function has two parameters.

• moduleAddress is the address of the module. The valid range is 0 to 15.

• dataArray needs to point to an array of four INT16 variables.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite2Aout, isaWrite4Aout, isaWrite5303Aout

Example

This program sets all 4 analog outputs to half scale on a 5304 Analog Output

Module at module at address 0.

#include <ctools.h> void main(void)

{

INT16 dataArray[4];

/* set all output values to one-half scale */ dataArray[0] = 16384; dataArray[1] = 16384; dataArray[2] = 16384; dataArray[3] = 16384;

/* Write data to 5304 analog output module */ request_resource(IO_SYSTEM); isaWrite4AoutChecksum(0, dataArray);

Document (Version 2.51) 4/4/2011 307

}

IEC 61131-3 C Tools Function Specifications release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 308

IEC 61131-3 C Tools Function Specifications

isaWrite4202Outputs

Write to SCADAPack 4202 DR Analog Output

Syntax

#include <ctools.h> unsigned isaWrite4202Outputs( int aoutData

)

Description

The isaWrite4202Outputs function writes data to the analog output of the

SCADAPack 4202 DR I/O. aoutData is the analog output value.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

When this function writes data to the SCADAPack 4202 DS I/O it also processes the transmit buffer for the com3 serial port. The com3 serial port is also continuously processed automatically. The additional service to the com3 receiver caused by this function does not affect the normal automatic operation of com3.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead4202Inputs, isaWrite4202OutputsEx

Example

This program sets the analog output to full scale.

}

#include <ctools.h> void main(void)

{ int analogData;

/* set analog output to full scale */ analogData = 32767;

/* Write output data to 4202 DR output */ request_resource(IO_SYSTEM); isaWrite4202Outputs(analogData); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 309

IEC 61131-3 C Tools Function Specifications

isaWrite4202OutputsEx

Write to SCADAPack 4202 DR with Extended Outputs

Syntax

#include <ctools.h> unsigned isaWrite4202OutputsEx( unsigned doutData, int aoutData

)

Description

The isaWrite4202OutputsEx function writes data to the outputs of a SCADAPack

4202 DR equipped with a digital output (Extended I/O). doutData is the digital output value. Bit 0 of the value controls the digital output. If this bit is 1, the digital output is turned on. aoutData is the analog output value.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

When this function writes data to the SCADAPack 4202 DR I/O, it also processes the transmit buffer for the com3 serial port. The com3 serial port is also continuously processed automatically. The additional service to the com3 receiver caused by this function does not affect the normal automatic operation of com3.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead4202Inputs

Example

This program sets the analog output to full scale and turns on the digital output.

#include <ctools.h> void main(void)

{ unsigned digitalData; int analogData;

/* turn on digital output */ digitalData = 0x01;

/* set analog output to full scale */ analogData = 32767;

/* Write output data to 4202 DR outputs */

Document (Version 2.51) 4/4/2011 310

}

IEC 61131-3 C Tools Function Specifications request_resource(IO_SYSTEM); isaWrite4202OutputsEx(digitalData, analogData); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 311

IEC 61131-3 C Tools Function Specifications

isaWrite4202DSOutputs

Write to SCADAPack 4202 DS Outputs

Syntax

#include <ctools.h> unsigned isaWrite4202DSoutputs( unsigned doutData

)

Description

The isaWrite4202DSOutputs function writes data to the outputs of the

SCADAPack 4202 DS I/O. doutData is the digital output value. Bits 0 and 1 of the value control the digital outputs. If a bit is 1, the corresponding digital output is turned on.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

When this function writes data to the SCADAPack 4202 DS I/O it also processes the transmit buffer for the com3 serial port. The com3 serial port is also continuously processed automatically. The additional service to the com3 receiver caused by this function does not affect the normal automatic operation of com3.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead4202DSInputs

Example

This program turns on the digital outputs.

#include <ctools.h> void main(void)

{ unsigned digitalData;

/* turn on digital outputs */ digitalData = 0x02;

/* Write output data to 4202 DS outputs */ request_resource(IO_SYSTEM); isaWrite4202DSOutputs(digitalData); release_resource(IO_SYSTEM);

}

Document (Version 2.51) 4/4/2011 312

IEC 61131-3 C Tools Function Specifications

isaWrite5303Aout

Write to 5303 Analog Outputs

Syntax

#include <ctools.h> unsigned isaWrite5303Aout(int *dataArray)

Description

The isaWrite5303Aout function writes data to the 2 points on a 5303

SCADAPack Analog Output Module. Data is read from the array pointed to by

dataArray and written to the 2 analog outputs. dataArray must point to an array of two 16-bit integers.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite2Aout, isaWrite2Aout

Example

This program sets both analog outputs to half scale on a 5303 Analog Output

Module.

}

#include <ctools.h> void main(void)

{ int dataArray[2]; dataArray[0] = 16384; dataArray[1] = 16384;

/* Write data to analog output module */ request_resource(IO_SYSTEM); isaWrite5303Aout(dataArray); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 313

IEC 61131-3 C Tools Function Specifications

isaWrite5505Outputs

Write 5505 Configuration

Syntax

#include <ctools.h> unsigned isaWrite5505Outputs(

UINT16 moduleAddress,

UINT16 *inputType,

UINT16 inputFilter

)

Description

The isaWrite5505Outputs function writes configuration data to the 5505 I/O module. moduleAddress is the address of the 5505 module. Valid values are 0 to 15. inputType must point to an array of 4 unsigned integers that select the type of analog inputs on the module. Valid values for each integer are

• 0 = RTD in deg Celsius

• 1 = RTD in deg Fahrenheit

• 2 = RTD in deg Kelvin

• 3 = resistance measurement in ohms. inputFilter selects the analog input filter. This is used for all inputs. Valid values are

• 0 = 0.5 s

• 1 = 1 s

• 2 = 2 s

• 3 = 4 s

The function returns FALSE if an I/O error occurs; otherwise, TRUE is returned.

Notes

The IO_SYSTEM resource must be requested before calling this function.

See Also

isaRead5505Inputs

Example

This program writes the configuration data to a 5505 I/O module at address 1.

#include <ctools.h>

Document (Version 2.51) 4/4/2011 314

IEC 61131-3 C Tools Function Specifications

} void main(void)

{

UINT16 inputType[4];

UINT16 inputFilter;

/* set analog input types to RTD deg F */ inputType[0] = 1; inputType[1] = 1; inputType[2] = 1; inputType[3] = 1;

/* set filter */ inputFilter = 0; // mimimum filter

/* Write configuration data to 5505 I/O module */ request_resource(IO_SYSTEM); isaWrite5505Outputs(1, inputType, inputFilter); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 315

IEC 61131-3 C Tools Function Specifications

isaWrite5506Outputs

Write to 5506 Configuration

Syntax

#include <ctools.h> unsigned isaWrite5506Outputs(

UINT16 moduleAddress,

UINT16 *inputType,

UINT16 inputFilter,

UINT16 scanFrequency

)

Description

The isaWrite5506Outputs function writes configuration data to the 5506 I/O module. moduleAddress is the address of the 5506 module. Valid values are 0 to 15. inputType needs to point to an array of 8 unsigned integers that select the type of analog inputs on the module. Valid values for each integer are

• 0 = 0 to 5V

• 1 = 1 to 5 V

• 2 = 0 to 20 mA

• 3 = 4 to 20 mA. inputFilter selects the analog input filter. This is used for all inputs. Valid values are

• 0 = 3 Hz

• 1 = 6 Hz

• 2 = 11 Hz

• 3 = 30 Hz scanFrequency is the scan frequency setting. Valid values are

• 0 = 60 Hz

• 1 = 50 Hz

The function returns FALSE if an I/O error occurs; otherwise, TRUE is returned.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead5506Inputs

Document (Version 2.51) 4/4/2011 316

IEC 61131-3 C Tools Function Specifications

Example

This program writes the configuration data to a 5506 I/O module.

#include <ctools.h> void main(void)

{

UINT16 inputType[8];

UINT16 inputFilter;

UINT16 scanFrequency;

/* set analog input types to 4-20 mA */ inputType[0] = 3; inputType[1] = 3; inputType[2] = 3; inputType[3] = 3; inputType[4] = 3; inputType[5] = 3; inputType[6] = 3; inputType[7] = 3;

/* set filter and frequency */ inputFilter = 0; // maximum filter scanFrequency = 0; // 60 Hz

/* Write configuration data to 5506 I/O module */ request_resource(IO_SYSTEM); isaWrite5506Outputs(1, inputType, inputFilter, scanFrequency); release_resource(IO_SYSTEM);

}

Document (Version 2.51) 4/4/2011 317

IEC 61131-3 C Tools Function Specifications

isaWrite5601Outputs

Write to SCADAPack Lower I/O Module Outputs

Syntax

#include <ctools.h> unsigned isaWrite5601Outputs(unsigned data)

Description

The isaWrite5601Outputs function writes data to the digital outputs of a 5601

I/O Module (SCADAPack lower I/O module). The first 12 bits of the specified 16bit data value are written to the 12 digital outputs.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

Note that when this function writes data to the 5601 it also services the transmit buffer of the com3 serial port. If the controller type is a SCADAPack or

SCADAPack PLUS, the com3 serial port is also continuously processed automatically.

The additional service to the com3 transmitter caused by this function does not affect the normal automatic operation of com3.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead5601Inputs

Example

This program turns ON all 12 digital outputs of a 5601 I/O Module.

#include <ctools.h> void main(void)

{

/* Write output data to 5601 I/O module */ request_resource(IO_SYSTEM); isaWrite5601Outputs(0x0FFF); release_resource(IO_SYSTEM);

}

Document (Version 2.51) 4/4/2011 318

IEC 61131-3 C Tools Function Specifications

isaWrite5602Outputs

Write to SCADAPack Upper I/O Module Outputs

Syntax

#include <ctools.h> unsigned isaWrite5602Outputs(unsigned char data)

Description

The isaWrite5602Outputs function writes data to the digital outputs of a 5602

I/O Module (SCADAPack upper I/O module). The first 2 bits of the specified 8-bit data value are written to the 2 digital outputs.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

When this function writes data to the 5602 it also services the transmit buffer of the com4 serial port. If the controller type is a SCADAPack LIGHT or

SCADAPack PLUS, the com4 serial port is also continuously processed automatically.

The additional service to the com4 transmitter caused by this function does not affect the normal automatic operation of com4.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead5602Inputs

Example

This program turns ON both digital outputs of a 5602 I/O Module.

#include <ctools.h> void main(void)

{

/* Write output data to 5602 I/O module */ request_resource(IO_SYSTEM); isaWrite5602Outputs(0x03); release_resource(IO_SYSTEM);

}

Document (Version 2.51) 4/4/2011 319

IEC 61131-3 C Tools Function Specifications

isaWrite5604Outputs

Write to 5604 Outputs

Syntax

#include <ctools.h> unsigned isaWrite5604Outputs(

UCHAR *doutData,

INT16 *aoutData)

Description

The isaWrite5604Outputs function writes data to the digital and analog outputs of the 5604 I/O module. doutData needs to point to an array of five 8-bit unsigned characters. Each bit in the array represents one output point. The first 36 bits of the array are written to the 36 digital outputs. aoutData needs to point to an array of two 16-bit integers. Analog data from this array are written to the two analog outputs.

The function returns FALSE if an I/O error occurs; otherwise, TRUE is returned.

Notes

When this function writes data to the 5604 I/O it also processes the transmit buffer for the com3 serial port. The com3 serial port is also continuously processed automatically. The additional service to the com3 transmitter caused by this function does not affect the normal automatic operation of com3.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead5604Inputs

Example

This program turns on all 32 digital outputs and sets the analog outputs to full scale. The internal digital outputs are turned off.

#include <ctools.h> void main(void)

{

UCHAR digitalData[5];

INT16 analogData[2];

/* turn on all external digital outputs */ digitalData[0] = 0xFF; digitalData[1] = 0xFF; digitalData[2] = 0xFF; digitalData[3] = 0xFF;

Document (Version 2.51) 4/4/2011 320

}

IEC 61131-3 C Tools Function Specifications

/* turn off all internal digital outputs */ digitalData[4] = 0x00;

/* set analog outputs to full scale */ analogData[0] = 32767; analogData[1] = 32767;

/* Write output data to 5604 I/O */ request_resource(IO_SYSTEM); isaWrite5604Outputs(digitalData, analogData); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 321

IEC 61131-3 C Tools Function Specifications

isaWrite5606Outputs

Write to 5606 Outputs

Syntax

#include <ctools.h> unsigned isaWrite5606Outputs(

UINT16 moduleAddress,

UCHAR *doutData,

INT16 *aoutData,

UINT16 *inputType,

UINT16 inputFilter,

UINT16 scanFrequency,

UINT16 outputType

)

Description

The isaWrite5606Outputs function writes data to the digital and analog outputs of the 5606 I/O module, and configures the module. moduleAddress is the address of the 5606 module. Valid values are 0 to 7. doutData needs to point to an array of two 8-bit unsigned characters. Each bit in the array represents one output point. The 16 bits of the array are written to the

16 digital outputs. aoutData needs to point to an array of two 16-bit integers. Analog data from this array are written to the two analog outputs. inputType needs to point to an array of 8 unsigned integers that select the type of analog inputs on the module. Valid values for each integer are

• 0 = 0 to 5V

• 1 = 0 to 10 V

• 2 = 0 to 20 mA

• 3 = 4 to 20 mA. inputFilter selects the analog input filter. This is used for all inputs. Valid values are

• 0 = 3 Hz

• 1 = 6 Hz

• 2 = 11 Hz

• 3 = 30 Hz scanFrequency is the scan frequency setting. Valid values are

• 0 = 60 Hz

• 1 = 50 Hz

Document (Version 2.51) 4/4/2011 322

IEC 61131-3 C Tools Function Specifications outputType selects the type of analog outputs on the module. Valid values are

• 0 = 0 to 20 mA

• 1 = 4 to 20 mA.

The function returns FALSE if an I/O error occurs; otherwise, TRUE is returned.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaRead5606Inputs

Example

This program turns on all 16 digital outputs and sets the analog outputs to full scale.

#include <ctools.h> void main(void)

{

UCHAR digitalData[2];

INT16 analogData[2];

UINT16 inputType[8];

UINT16 inputFilter;

UINT16 scanFrequency;

UINT16 outputType;

/* turn on all external digital outputs */ digitalData[0] = 0xFF; digitalData[1] = 0xFF;

/* set analog outputs to full scale */ analogData[0] = 32767; analogData[1] = 32767;

/* set analog input types to 4-20 mA */ inputType[0] = 3; inputType[1] = 3; inputType[2] = 3; inputType[3] = 3; inputType[4] = 3; inputType[5] = 3; inputType[6] = 3; inputType[7] = 3;

/* set filter and frequency */ inputFilter = 0; // maximum filter scanFrequency = 0; // 60 Hz

/* set analog output type to 4-20 mA */ outputType = 1;

Document (Version 2.51) 4/4/2011 323

IEC 61131-3 C Tools Function Specifications

/* Write output data to 5606 I/O module */ request_resource(IO_SYSTEM); isaWrite5606Outputs(1, digitalData, analogData, inputType, inputFilter, scanFrequency, outputType); release_resource(IO_SYSTEM);

}

Document (Version 2.51) 4/4/2011 324

IEC 61131-3 C Tools Function Specifications

isaWrite8Dout

Write to 8 Digital Outputs

Syntax

#include <ctools.h> unsigned isaWrite8Dout(unsigned moduleAddress, unsigned char data)

Description

The isaWrite8Dout function writes data to any 8 point Digital Output Module at the specified moduleAddress. Data from the specified 8-bit value is written to the

8 digital outputs.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned. The valid range for moduleAddress is 0 to

15.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite16Dout

Example

This program turns ON all 8 digital outputs of an 8 point Digital Output Module at module address 0.

#include <ctools.h> void main(void)

{

/* Write data to digital output module */ request_resource(IO_SYSTEM); isaWrite8Dout(0, 0xFF); release_resource(IO_SYSTEM);

}

Document (Version 2.51) 4/4/2011 325

IEC 61131-3 C Tools Function Specifications

isaWriteAout

Write to Analog Output Module

Syntax

#include <ctools.h> unsigned isaWriteAout(

UINT16 moduleAddress, enum ioModuleType moduleType,

INT16 * pData)

Description

The isaWriteAout function writes data to an analog output module. The function has three parameters. moduleAddress is the address of the module. The valid range is 0 to 15. moduleType is the type of the module. It needs to be one of io5301, io5302, io5303 (SCADAPack Analog Output), or io5304. pData is a pointer to an array of INT16 variables. The size of the array depends on the module type.

• If moduleType is io5301 or io5303, pData needs to point to an array of two

INT16 variables.

• If moduleType is io5302 or io5304, pData needs to point to an array of four

INT16 variables.

The function returns FALSE if the moduleAddress is invalid or if an I/O error occurs; otherwise TRUE is returned.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaWrite2Aout, isaWrite4Aout, isaWrite5303Aout

Example

This program sets all 4 analog outputs to half scale on a 5304 Analog Output

Module at module at address 0.

#include <ctools.h> void main(void)

{

INT16 dataArray[4];

/* set all output values to one-half scale */ dataArray[0] = 16384; dataArray[1] = 16384; dataArray[2] = 16384;

Document (Version 2.51) 4/4/2011 326

} dataArray[3] = 16384;

IEC 61131-3 C Tools Function Specifications

/* Write data to 5304 analog output module */ request_resource(IO_SYSTEM); isaWriteAout(0, io5304, dataArray); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 327

IEC 61131-3 C Tools Function Specifications

isaWriteLPOutputs

Write to SCADAPack LP Outputs

Syntax

#include <ctools.h> unsigned isaWriteLPOutputs(unsigned doutData, int aoutData[2])

Description

The isaWriteLPOutputs function writes data to the digital and analog outputs of the SCADAPack LP I/O. doutData is the digital output data. The first 12 bits of the specified 16-bit data value are written to the 12 digital outputs. aoutData is an array of two analog output values.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

When this function writes data to the SCADAPack LP I/O it also processes the transmit buffer for the com3 serial port. The com3 serial port is also continuously processed automatically. The additional service to the com3 receiver caused by this function does not affect the normal automatic operation of com3.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaReadLPInputs

Example

This program turns on all 12 digital outputs and sets the analog outputs to full scale.

#include <ctools.h> void main(void)

{ unsigned digitalData; int analogData[2];

/* turn on all digital outputs */ digitalData = 0x0FFF;

/* set analog outputs to full scale */ analogData[0] = 32767; analogData[1] = 32767;

/* Write output data to SCADAPack LP I/O */ request_resource(IO_SYSTEM); isaWriteLPOutputs(digitalData, analogData);

Document (Version 2.51) 4/4/2011 328

}

IEC 61131-3 C Tools Function Specifications release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 329

IEC 61131-3 C Tools Function Specifications

isaWriteSP100Outputs

Write to SCADAPack 100 Outputs

Syntax

#include <ctools.h> unsigned isaWriteSP100Outputs(unsigned doutData)

Description

The isaWriteSP100Outputs function writes data to the digital outputs of the

SCADAPack 100 I/O. doutData is the digital output data. The first 6 bits of the specified 16-bit data value are written to the 6 digital outputs.

The function returns FALSE if an I/O error occurs; otherwise TRUE is returned.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

isaReadSP100Inputs

Example

This program turns on all 6 digital outputs.

#include <ctools.h> void main(void)

{ unsigned digitalData;

/* turn on all digital outputs */ digitalData = 0x0FFF;

/* Write output data to SCADAPack 100 I/O */ request_resource(IO_SYSTEM); isaWriteSP100Outputs(digitalData); release_resource(IO_SYSTEM);

}

Document (Version 2.51) 4/4/2011 330

IEC 61131-3 C Tools Function Specifications

ledGetDefault

Read LED Power Control Parameters

Syntax

#include <ctools.h> struct ledControl_tag ledGetDefault(void);

Description

The ledGetDefault routine returns the default LED power control parameters.

The controller controls LED power to 5000 I/O modules. To conserve power, the

LEDs can be disabled.

The user can change the LED power setting with the LED POWER switch on the controller. The LED power returns to its default state after a user specified time period.

Example

See the example for the ledSetDefault function.

Document (Version 2.51) 4/4/2011 331

ledPower

Set LED Power State

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> unsigned ledPower(unsigned state);

Description

The ledPower function sets the LED power state. The LED power will remain in the state until the default time-out period expires. state needs to be LED_ON or

LED_OFF.

The function returns TRUE if state is valid and FALSE if it is not.

Notes

The LED POWER switch also controls the LED power. A user may override the setting made by this function.

The ledSetDefault function sets the default state of the LED power. This state overrides the value set by this function.

See Also

ledPowerSwitch, ledSetDefault

Document (Version 2.51) 4/4/2011 332

IEC 61131-3 C Tools Function Specifications

ledPowerSwitch

Read State of the LED Power Switch

Syntax

#include <ctools.h> unsigned ledPowerSwitch(void);

Description

The ledPowerSwitch function returns the status of the led power switch. The function returns FALSE if the switch is released and TRUE if the switch is pressed.

Notes

The program for user input may use this switch. However, pressing the switch will have the side effect of changing the LED power state.

See Also

ledPower, ledSetDefault

Document (Version 2.51) 4/4/2011 333

IEC 61131-3 C Tools Function Specifications

ledSetDefault

Set Default Parameters for LED Power Control

Syntax

#include <ctools.h> unsigned ledSetDefault(struct ledControl_tag ledControl);

Description

The ledSetDefault routine sets default parameters for LED power control. The controller controls LED power to 5000 I/O modules. To conserve power, the

LEDs can be disabled.

The LED power setting can be changed by the user with the LED POWER switch on the controller. The LED power returns to its default state after a user specified time period.

The ledControl structure contains the default values. Refer to the Structures and

Types section for a description of the fields in the ledControl_tag structure. Valid values for the state field are LED_ON and LED_OFF. Valid values for the time field are 1 to 65535 minutes.

The function returns TRUE if the parameters are valid and false if they are not. If either parameter is not valid, the default values are not changed.

The IO_SYSTEM resource needs to be requested before calling this function.

Example

}

#include <ctools.h> void main(void)

{ struct ledControl_tag ledControl; request_resource(IO_SYSTEM);

/* Turn LEDS off after 20 minutes */ ledControl.time = 20; ledControl.state = LED_OFF; ledSetDefault(ledControl); release_resource(IO_SYSTEM);

/* ... the reset of the program */

Document (Version 2.51) 4/4/2011 334

IEC 61131-3 C Tools Function Specifications

load

Read Parameters from EEPROM

Syntax

#include <ctools.h> void load(unsigned section);

Description

The load function reads data from the specified section of the EEPROM into

RAM.. Valid values for section are EEPROM_EVERY and EEPROM_RUN.

The save function writes data to the EEPROM.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

The EEPROM_EVERY section is not used.

The EEPROM_RUN section is loaded from EEPROM to RAM when the controller is reset and the Run/Service switch is in the RUN position. Otherwise default information is used for this section. This section contains:

• serial port configuration tables

• protocol configuration tables

See Also

save

Document (Version 2.51) 4/4/2011 335

IEC 61131-3 C Tools Function Specifications

master_message

Send Protocol Command

Syntax

#include <ctools.h> extern unsigned master_message(FILE *stream, unsigned function, unsigned slave_station, unsigned slave_address, unsigned

master_address, unsigned length);

Description

The master_message function sends a command using a communication protocol. The communication protocol task waits for the response from the slave station. The current task continues execution.

stream specifies the serial port.

function specifies the protocol function code. Refer to the communication protocol manual for supported function codes.

slave specifies the network address of the slave station. This is also known as the slave station number.

address specifies the location of data in the slave station. Depending on the protocol function code, data may be read or written at this location.

master_address specifies the location of data in the master (this controller).

Depending on the protocol function code, data may be read or written at this location.

length specifies the number or registers.

The master_message function returns the command status from the protocol driver.

Value

MM_SENT

MM_BAD_FUNCTION

MM_BAD_SLAVE

MM_BAD_ADDRESS

MM_BAD_LENGTH

MM_EOT

MM_WRONG_RSP

MM_CMD_ACKED

Description

message transmitted to slave function is not recognized slave station number is not valid slave or master database address not valid too many or too few registers specified

Master message status: AB slave response was an EOT message

Master message status: AB slave response did not match command sent.

Master message status: AB half duplex command has been acknowledged by slave – Master may now send poll command.

Document (Version 2.51) 4/4/2011 336

IEC 61131-3 C Tools Function Specifications

MM_EXCEPTION_FUNCTION

MM_EXCEPTION_ADDRESS

Master message status: Modbus slave returned a function exception.

Master message status: Modbus slave returned an address exception.

MM_EXCEPTION_VALUE

MM_RECEIVED

Master message status: Modbus slave returned a value exception.

Master message status: response received.

MM_RECEIVED_BAD_LENGTH Master message status: response received with incorrect amount of data.

The calling task monitors the status of the command sent using the

get_protocol_status function. The command field of the prot_status structure is set to MM_SENT if a master message is sent. It will be set to MM_RECEIVED when the response to the message is received with the proper length. It will be set to MM_RECEIVED_BAD_LENGTH when a response to the message is received with the improper length.

Notes

Refer to the communication protocol manual for more information.

Users of TeleSAFE BASIC and the TeleSAFE 6000 C compiler should be aware that the address parameter now specifies the actual database address, when used with the Modbus protocol. This parameter specified the address offset on these older TeleSAFE products.

To optimize performance, minimize the length of messages on com3 and com4.

Examples of recommended uses for com3 and com4 are for local operator display terminals, and for programming and diagnostics using the IEC 61131-3 program.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

clear_protocol_status

Example Using Modbus Protocol

This program sends a master message, on com2, using the Modbus protocol, then waits for a response from the slave. The number of good and failed messages is printed to com1.

/* --------------------------------------------

poll.c

Polling program for Modbus slave.

-------------------------------------------- */

#include <ctools.h>

/* --------------------------------------------

wait_for_response

Document (Version 2.51) 4/4/2011 337

IEC 61131-3 C Tools Function Specifications

The wait_for_response function waits for a

response to be received to a master_message on

the serial port specified by stream. It returns

when a response is received, or when the period

specified by time (in tenths of a second)

expires.

-------------------------------------------- */ void wait_for_response(FILE *stream, unsigned time)

{ struct prot_status status; static unsigned long good, bad; interval(0, 1); settimer(0, time); do {

/* Allow other tasks to execute */ release_processor();

} while (timer(0) && status.command == MM_SENT); status = get_protocol_status(stream); if (status.command == MM_RECEIVED)

} else good++; bad++; fprintf(com1, "Good: %8lu Bad: %8lu\r", good, bad);

/* -------------------------------------------- main

The main function sets up serial ports then

sends commands to a Modbus slave.

-------------------------------------------- */ void main(void)

{ struct prot_settings settings; struct pconfig portset; request_resource(IO_SYSTEM);

/* disable protocol on serial port 1 */ settings.type = NO_PROTOCOL; settings.station = 1; settings.priority = 3; settings.SFMessaging = FALSE; set_protocol(com1, &settings);

/* Set communication parameters for port 1 */ portset.baud = BAUD9600; portset.duplex = FULL; portset.parity = NONE; portset.data_bits = DATA8; portset.stop_bits = STOP1;

Document (Version 2.51) 4/4/2011 338

}

Examples using DF1 Protocol

IEC 61131-3 C Tools Function Specifications portset.flow_rx = DISABLE; portset.flow_tx = DISABLE; portset.type = RS232; portset.timeout = 600; set_port(com1, &portset);

/* enable Modbus protocol on serial port 2 */ settings.type = MODBUS_ASCII; settings.station = 2; settings.priority = 3; settings.SFMessaging = FALSE; set_protocol(com2, &settings);

/* Set communication parameters for port 2 */ portset.baud = BAUD9600; portset.duplex = HALF; portset.parity = NONE; portset.data_bits = DATA8; portset.stop_bits = STOP1; portset.flow_rx = DISABLE; portset.flow_tx = DISABLE; portset.type = RS485_2WIRE; portset.timeout = 600; set_port(com2, &portset); release_resource(IO_SYSTEM);

/* Main communication loop */ while (TRUE)

{

/* Transfer slave inputs to outputs */ request_resource(IO_SYSTEM); master_message(com2, 2, 1, 10001, 17, 8); release_resource(IO_SYSTEM); wait_for_response(com2, 10);

/* Transfer inputs to slave outputs */ request_resource(IO_SYSTEM); master_message(com2, 15, 1, 1, 10009, 8); release_resource(IO_SYSTEM); wait_for_response(com2, 10);

}

/* Allow other tasks to execute */ release_processor();

Full Duplex

Using the same example program above, apply the following calling format for the master_message function.

Document (Version 2.51) 4/4/2011 339

IEC 61131-3 C Tools Function Specifications

This code fragment uses the protected write command (function=0) to transmit

13 (length=13) 16-bit registers to slave station 10 (slave=10). The data will be read from registers 127 to 139 (master_address=127), and stored into registers

180 to 192 (address=180) in the slave station. The command will be transmitted on com2 (stream=com2). master_message(com2, 0, 10, 180, 127, 13);

This code fragment uses the unprotected read command (function=1) to read 74

(length=74) 16-bit registers from slave station 37 (slave=37). The data will be read from registers 300 to 373 in the slave (address=300), and stored in registers

400 to 473 in the master (master_address=400). The command will be transmitted on com2 (stream=com2). master_message(com2, 1, 37, 300, 400, 74);

This code fragment will send specific bits from a single 16-bit register in the master to slave station 33. The unprotected bit write command (function=5) will be used. Bits 0,1,7,12 and 15 of register 100 (master_address=100) will be sent to register 1432 (address=1432) in the slave. The length parameter is used as a bit mask and is evaluated as follows: bit mask = 1001 0000 1000 0011 in binary

= 9083 in hexadecimal

= 36,995 in decimal

Therefore the command, sent on com2, is: master_message(com2, 5, 33, 1432, 100, 36995);

Half Duplex

The example program is the same as for Full Duplex except that instead of waiting for a response after calling master_message, the slave must be polled for a response. Add the following function poll_for_response to the example program above and call it instead of wait_for_response:

/* --------------------------------------------

poll_for_response

The poll_for_response function polls the

specified slave for a response to a master

message sent on the serial port specified by

stream. It returns when the correct response

is received, or when the period specified by

time (in tenths of a second) expires.

-------------------------------------------- */ unsigned poll_for_response(FILE *stream, unsigned slave, unsigned time)

{ struct prot_status status; unsigned done; static unsigned long good, bad;

Document (Version 2.51) 4/4/2011 340

}

IEC 61131-3 C Tools Function Specifications

/* set timeout timer */ interval( 0, 10 ); settimer( 0, time ); do

{

/* wait until command status changes or timer expires */ do

{

} status = get_protocol_status( stream ); release_processor(); while(timer(0)&& (status.command==MM_SENT));

/* command has been ACKed, send poll */ if (status.command == MM_CMD_ACKED)

{

} pollABSlave(stream, slave); done = FALSE;

/* response/command mismatch, poll again */ else if (status.command == MM_WRONG_RSP)

{

} pollABSlave(stream, slave); done = FALSE;

/* correct response was received */ else if (status.command == MM_RECEIVED)

{ good++; done = TRUE;

}

/* timer has expired or status is MM_EOT */ else

{ bad++; done = TRUE;

}

} while (!done); fprintf(com1, "Good: %8lu Bad: %8lu\r", good, bad);

Document (Version 2.51) 4/4/2011 341

IEC 61131-3 C Tools Function Specifications

modbusExceptionStatus

Set Response to Protocol Command

Syntax

#include <ctools.h> void modbusExceptionStatus(unsigned char status);

Description

The modbusExceptionStatus function is used in conjunction with the Modbus compatible communication protocol. It sets the result returned in response to the

Read Exception Status command. This command is provided for compatibility with some Modbus protocol drivers for host computers.

The value of status is determined by the requirements of the host computer.

Notes

The specified result will be sent each time that the protocol command is received, until a new result is specified.

The result is cleared when the controller is reset. The application program needs to initialize the status each time it is run.

See Also

modbusSlaveID

Document (Version 2.51) 4/4/2011 342

IEC 61131-3 C Tools Function Specifications

modbusSlaveID

Set Response to Protocol Command

Syntax

#include <ctools.h> void modbusSlaveID(unsigned char *string, unsigned length);

Description

The modbusSlaveID function is used in conjunction with the Modbus compatible communication protocol. It sets the result returned in response to the Report

Slave ID command. This command is provided for compatibility with some

Modbus protocol drivers for host computers.

string points to a string of at least length characters. The contents of the string is determined by the requirements of the host computer. The string is not NULL terminated and may contain multiple NULL characters.

The length specifies how many characters are returned by the protocol command. length needs to be in the range 1 to REPORT_SLAVE_ID_SIZE. If

length is too large only the first REPORT_SLAVE_ID_SIZE characters of the string will be sent in response to the command.

Notes

The specified result will be sent each time that the protocol command is received, until a new result is specified.

The function copies the data pointed to by string. string may be modified after the function is called.

The result is cleared when the controller is reset. The application program needs to initialize the salve ID string each time it is run.

See Also

modbusExceptionStatus

Document (Version 2.51) 4/4/2011 343

IEC 61131-3 C Tools Function Specifications

modbusProcessCommand Function

Process a Modbus command and return the response.

Syntax

#include <ctools.h>

BOOLEAN processModbusCommand(

FILE * stream,

UCHAR * pCommand,

UINT16 commandLength,

UINT16 responseSize,

UCHAR * pResponse,

UINT16 * pResponseLength

)

Description

The processModbusCommand function processes a Modbus protocol command and returns the response. The function can be used by an application to encapsulate Modbus RTU commands in another protocol. stream is a FILE pointer that identifies the serial port where the command was received. This is used for to accumulate statistics for the serial port. pCommand is a pointer to a buffer containing the Modbus command. The contents of the buffer needs to be a standard Modbus RTU message. The

Modbus RTU checksum is not required. commandLength is the number of bytes in the Modbus command. The length needs to include all the address and data bytes. It cannot include the checksum bytes, if any, in the command buffer. responseSize is the size of the response buffer in bytes. A 300-byte buffer is recommended. If this is not practical in the application, a smaller buffer may be supplied. Some responses may be truncated if a smaller buffer is used. pResponse is a pointer to a buffer to contain the Modbus response. The function will store the response in this buffer in standard Modbus RTU format including two checksum bytes at the end of the response. pResponseLength is a pointer to a variable to hold response length. The function will store the number of bytes in the response in this variable. The length will include two checksum bytes.

The function returns TRUE if the response is valid and can be used. It returns

FALSE if the response is too long to fit into the supplied response buffer.

Notes

To use the function on a serial port, a protocol handler must be created for the encapsulating protocol. Set the protocol type for the port to NO_PROTOCOL to allow the custom handler to be used.

The function supports standard and extended addressing. Configure the protocol settings for the serial port for the appropriate protocol.

Document (Version 2.51) 4/4/2011 344

IEC 61131-3 C Tools Function Specifications

The Modbus RTU checksum is not required in the command so the encapsulating protocol may omit them if they are not needed. This may be useful in host devices that don't create a Modbus RTU message with checksum prior to encapsulation.

The Modbus RTU checksum is included in the response to support encapsulating a complete Modbus RTU format message. If the checksum is not needed by the encapsulating protocol the checksum bytes may be ignored.

See Also

set_protocol

Example

This example is taken from a protocol driver than encapsulates Modbus RTU messages in another protocol. It shows how to pass the Modbus RTU command to the Modbus driver, and obtain the response.

The example assumes the Modbus RTU messages are transmitted with the checksum. The length of the checksum is subtracted when calling the processModbusCommand function. The checksum is included when responding.

/* receive the packet in the encapsulating protocol */

/* verify the packet is valid */

/* locate the Modbus RTU command in the command buffer */ pCommandData = commandBuffer + PROTOCOL_HEADER_SIZE;

/* get length of Modbus RTU command from the packet header */ commandLength = commandBuffer[DATA_SIZE] - 2;

/* locate the Modbus RTU response in the response buffer leaving room for the packet header */ pResponseData = responseBuffer + PROTOCOL_HEADER_SIZE;

{

/* process the Modbus message */ if (processModbusCommand( stream, pCommandData, commandLength,

MODBUS_BUFFER_SIZE, pResponseData,

&responseLength))

/* put the response length in the header */ responseBuffer[DATA_SIZE] = responseLength;

/* fill in rest of packet header */

/* transmit the encapsulated response */

}

Document (Version 2.51) 4/4/2011 345

IEC 61131-3 C Tools Function Specifications

modemAbort

Unconditionally Terminate Dial-up Connection

Syntax

#include <ctools.h> void modemAbort(FILE *port);

Description

The modemAbort function unconditionally terminates a dial-up connection, connection in progress or modem initialization started by the C application. port specifies the serial port the where the modem is installed.

The connection or initialization is terminated only if it was started from a C application. Connections made from a Ladder Logic application and answered calls are not terminated.

This function can be used in a task exit handler.

Notes

The serial port type needs to be set to RS232_MODEM.

A pause of a few seconds is required between terminating a connection and initiating a new call. This pause allows the external modem time to hang up.

Use this function in a task exit handler to clean-up any open dial-up connections or modem initializations. If a task is ended by executing end_task from another task, modem connections or initializations need to be aborted in the exit handler.

Otherwise, the reservation ID for the port remains valid. No other task or Ladder

Logic program may use modem functions on the port. Not Calling modemAbort or modemAbortAll in the task exit handler may result in the port being unavailable to any programs until the controller is reset.

The modem connection or initialization is automatically terminated when IEC

61131-3 stops the C application and when the controller is rebooted.

Reservation IDs returned by the modemDial and modemInit functions on this port are invalid after calling modemAbort.

See Also

modemAbortAll, modemDial, modemDialEnd, modemDialStatus,

modemInit, modemInitEnd, modemInitStatus, modemNotification

Example

Refer to the examples in the Functions Overview section.

Document (Version 2.51) 4/4/2011 346

IEC 61131-3 C Tools Function Specifications

modemAbortAll

Unconditionally Terminate All Dial-up Connections

Syntax

#include <ctools.h> void modemAbort(void);

Description

The modemAbortAll function unconditionally terminates all dial-up connections, connections in progress or modem initializations started by the C application.

The connections or initializations are terminated only if they were started from a

C application. Connections made from a Ladder Logic application and answered calls are not terminated.

This function can be used in a task exit handler.

Notes

A pause of a few seconds is required between terminating a connection and initiating a new call. This pause allows the external modem time to hang up.

Use this function in a task exit handler to clean-up any open dial-up connections or modem initializations. If executing end_task from another task ends a task, modem connections or initializations needs to be aborted in the exit handler.

Otherwise, the reservation ID for the port remains valid. No other task or Ladder

Logic program may use modem functions on the port. Not calling modemAbort or modemAbortAll in the task exit handler may result in the port being unavailable to any programs until the controller is reset.

The modem connection or initialization is automatically terminated when IEC

61131-3 stops the C application and when the controller is rebooted.

This function will terminate all open dial-up connections or modem initializations started by the C application - even those started by other tasks. The exit handler can call this function instead of multiple calls to modemAbort if all the connections or initializations were started from the same task.

All reservation IDs returned by the modemDial and modemInit functions are invalid after calling modemAbort.

See Also

modemAbort, modemDial, modemDialEnd, modemDialStatus, modemInit,

modemInitEnd, modemInitStatus, modemNotification

Example

This program installs an exit handler for the main task that terminates any dial-up connections made by the task. This handler is not strictly necessary if IEC

61131-3 ends the main task. However, it demonstrates how to use the

Document (Version 2.51) 4/4/2011 347

IEC 61131-3 C Tools Function Specifications modemAbortAll function and an exit handler for another task in a more complex program.

}

{

#include <ctools.h>

/* --------------------------------------------

The shutdown function aborts any active

modem connections when the task is ended.

-------------------------------------------- */ void shutdown(void)

{

} modemAbortAll(); void main(void)

TASKINFO taskStatus;

/* set up exit handler for this task */ taskStatus = getTaskInfo(0); installExitHandler(taskStatus.taskID, shutdown); while(TRUE)

{

}

/* rest of main task here */

/* Allow other tasks to execute */ release_processor();

Document (Version 2.51) 4/4/2011 348

IEC 61131-3 C Tools Function Specifications

modemDial

Connect to a Remote Dial-up Controller

Syntax

#include <ctools.h> enum DialError modemDial(struct ModemSetup *configuration, reserve_id *id);

Description

The modemDial function connects a controller to a remote controller using an external dial-up modem. One modemDial function may be active on each serial port. The modemDial function handles all port sharing and multiple dialing attempts.

The ModemSetup structure specified by configuration defines the serial port, dialing parameters, modem initialization string and the phone number to dial.

Refer to the Structures and Types section for a description of the fields in the

ModemSetup structure.

id points to a reservation identifier for the serial port. The identifier ensures that no other modem control function can access the serial port. This parameter must be supplied to the modemDialEnd and modemDialStatus functions.

The function returns an error code. DE_NoError indicates that the connect operation has begun. Any other code indicates an error. Refer to the description in the Structures and Types section for a complete description of error codes.

Notes

The serial port type needs to be set to RS232_MODEM.

The SCADAPack 100 does not support dial up connections on com port 1.

The modemDialStatus function returns the status of the connection attempt initiated by modemDial.

The modemDialEnd function terminates the connection to the remote controller.

A pause of a few seconds is required between terminating a connection and initiating a new call. This pause allows the external modem time to hang up.

If a communication protocol is active on the serial port when a connection is initiated, the protocol will be disabled until the connection is made, then reenabled. This allows the controller to communicate with the external modem on the port. The protocol settings will also be restored when a connection is terminated with the modemDialEnd function.

If a modemInit function or an incoming call is active on the port, the modemDial function cannot access the port and will return an error code of DE_NotInControl.

If communication stops for more than five minutes, then outgoing call requests are allowed to end the incoming call. This prevents problems with the modem or the calling application from permanently disabling outgoing calls.

Document (Version 2.51) 4/4/2011 349

IEC 61131-3 C Tools Function Specifications

The reservation identifier is valid until the call is terminated and another modem function or an incoming call takes control of the port.

To optimize performance, minimize the length of messages on com3 and com4.

Examples of recommended uses for com3 and com4 are for local operator display terminals, and for programming and diagnostics using the IEC 61131-3 program.

This function cannot be called in a task exit handler.

See Also

modemAbort, modemAbortAll, modemDialEnd, modemDialStatus,

modemInit, modemInitEnd, modemInitStatus, modemNotification

Example

Refer to the examples in the Functions Overview section.

Document (Version 2.51) 4/4/2011 350

IEC 61131-3 C Tools Function Specifications

modemDialEnd

Terminate Dial-up Connection

Syntax

#include <ctools.h> void modemDialEnd(FILE *port, reserve_id id, enum DialError

*error);

Description

The modemDialEnd function terminates a dial-up connection or connection in progress. port specifies the serial port the where the modem is installed. id is the port reservation identifier returned by the modemDial function.

The function sets the variable pointed to by error. If no error occurred

DE_NoError is returned. Any other value indicates an error. Refer to the

Structures and Types section for a complete description of error codes.

Notes

The serial port type needs to be set to RS232_MODEM.

A connection can be terminated by any of the following events. Once terminated another modem function or incoming call can take control of the serial port.

• Execution of the modemDialEnd function.

• Execution of the modemAbort or modemAbortAll functions.

• The remote device hangs up the phone line.

• An accidental loss of carrier occurs due to phone line problems.

A pause of a few seconds is required between terminating a connection and initiating a new call. This pause allows the external modem time to hang up.

The reservation identifier is valid until the call is terminated and another modem function or an incoming call takes control of the port. The modemDialEnd function returns a DE_NotInControl error code, if another modem function or incoming call is in control of the port.

This function cannot be called in a task exit handler. Use modemAbort instead.

See Also

modemAbort, modemAbortAll, modemDial, modemDialStatus, modemInit,

modemInitEnd, modemInitStatus, modemNotification

Document (Version 2.51) 4/4/2011 351

IEC 61131-3 C Tools Function Specifications

modemDialStatus

Return Status of Dial-up Connection

Syntax

#include <ctools.h> void modemDialStatus(FILE *port, reserve_id id, enum DialError *

error, enum DialState *state);

Description

The modemDialStatus function returns the status of a remote connection initiated by the modemDial function. port specifies the serial port where the modem is installed. id is the port reservation identifier returned by the

modemDial function.

The function sets the variable pointed to by error. If no error occurred

DE_NoError is returned. Any other value indicates an error. Refer to the

Structures and Types section for a complete description of error codes.

The function sets the variable pointed to by state to the current execution state of dialing operation. The state value is not valid if the error code is

DE_NotInControl. Refer to the dialup.h section for a complete description of state codes.

Notes

The serial port type needs to be set to RS232_MODEM.

The reservation identifier is valid until the call is terminated and another modem function or an incoming call takes control of the port. The modemDialStatus function will return a DE_NotInControl error code, if another dial function or incoming call is now in control of the port.

This function cannot be called in a task exit handler.

See Also

modemAbort, modemAbortAll, modemDial, modemDialEnd, modemInit,

modemInitEnd, modemInitStatus, modemNotification

Document (Version 2.51) 4/4/2011 352

IEC 61131-3 C Tools Function Specifications

modemInit

Initialize Dial-up Modem

Syntax

#include <ctools.h> enum DialError modemInit(struct ModemInit *configuration, reserve_id *id);

Description

The modemInit function sends an initialization string to an external dial-up modem. It is typically used to set up a modem to answer incoming calls. One modemInit function may be active on each serial port. The modemInit function handles all port sharing and multiple dialing attempts.

The ModemInit structure pointed to by configuration defines the serial port and modem initialization string. Refer to the Structures and Types section for a description of the fields in the ModemInit structure.

The id variable is set to a reservation identifier for the serial port. The identifier ensures that no other modem control function can access the serial port. This parameter needs to be supplied to the modemInitEnd and modemInitStatus functions.

The function returns an error code. DE_NoError indicates that the initialize operation has begun. Any other code indicates an error. Refer to the Structures

and Types section for a complete description of error codes.

Notes

The serial port type needs to be set to RS232_MODEM.

The modemInitStatus function returns the status of the connection attempt initiated by modemInit.

The modemInitEnd function terminates initialization of the modem.

If a communication protocol is active on the serial port, the protocol will be disabled until the initialization is complete then re-enabled. This allows the controller to communicate with the external modem on the port. The protocol settings will also be restored when initialization is terminated with the

modemInitEnd function.

If a modemDial function or an incoming call is active on the port, the modemInit function cannot access the port and will return an error code of DE_NotInControl.

The reservation identifier is valid until the call is terminated and another modem function or an incoming call takes control of the port.

To optimize performance, minimize the length of messages on com3 and com4.

Examples of recommended uses for com3 and com4 are for local operator display terminals, and for programming and diagnostics using the IEC 61131-3 program.

Document (Version 2.51) 4/4/2011 353

IEC 61131-3 C Tools Function Specifications

This function cannot be called in a task exit handler.

See Also

modemAbort, modemAbortAll, modemDial, modemDialEnd,

modemDialStatus, modemInitEnd, modemInitStatus, modemNotification

Example

Refer to the example in the Functions Overview section.

Document (Version 2.51) 4/4/2011 354

IEC 61131-3 C Tools Function Specifications

modemInitEnd

Abort Initialization of Dial-up Modem

Syntax

#include <ctools.h> void modemInitEnd(FILE *port, reserve_id id, enum DialError

*error);

Description

The modemInitEnd function terminates a modem initialization in progress. port specifies the serial port where the modem is installed. id is the port reservation identifier returned by the modemInit function.

The function sets the variable pointed to by error. If no error occurred

DE_NoError is returned. Any other value indicates an error. Refer to the

Structures and Types section for a complete description of error codes.

Notes

The serial port type needs to be set to RS232_MODEM.

Normally this function should be called once the modemInitStatus function indicates the initialization is complete.

The reservation identifier is valid until the initialization is complete or terminated, and another modem function or an incoming call takes control of the port. The

modemInitEnd function returns a DE_NotInControl error code, if another modem function or incoming call is in control of the port.

This function cannot be called in a task exit handler. Use modemAbort instead.

See Also

modemAbort, modemAbortAll, modemDial, modemDialEnd,

modemDialStatus, modemInit, modemInitStatus, modemNotification

Document (Version 2.51) 4/4/2011 355

IEC 61131-3 C Tools Function Specifications

modemInitStatus

Return Status of Dial-up Modem Initialization

Syntax

#include <ctools.h> void modemInitStatus(FILE *port, reserve_id id, enum DialError

*error, enum DialState *state);

Description

The modemInitStatus function returns the status a modem initialization started by the modemInit function. port specifies the serial port where the modem is installed. id is the port reservation identifier returned by the modemInit function.

The function sets the variable pointed to by error. If no error occurred

DE_NoError is returned. Any other value indicates an error. Refer to the

Structures and Types section for a complete description of error codes.

The function sets the variable pointed to by state to the current execution state of dialing operation. The state value is not valid if the error code is

DE_NotInControl. Refer to the dialup.h section for a complete description of state codes.

Notes

The serial port type needs to be set to RS232_MODEM.

The port will remain in the DS_Calling state until modem initialization is complete or is unsuccessful. The application should wait until the state is not DS_Calling before calling the modemInitEnd function.

The reservation identifier is valid until the initialization is complete or terminated, and another modem function or an incoming call takes control of the port.

This function cannot be called in a task exit handler.

See Also

modemAbort, modemAbortAll, modemDial, modemDialEnd,

modemDialStatus, modemInit, modemInitEnd, modemNotification

Document (Version 2.51) 4/4/2011 356

IEC 61131-3 C Tools Function Specifications

modemNotification

Notify the modem handler of an important event

Syntax

#include <ctools.h> void modemNotification(UINT16 port_index);

Description

The modemNotification function notifies the dial-up modem handler that an interesting event has occurred. This informs the modem handler not to disconnect an incoming call when an outgoing call is requested with modemDial.

This function is used with custom communication protocols. The function is usually called when a message is received by the protocol, although it can be called for other reasons.

The port_index indicates the serial port that received the message.

Notes

The serial port type needs to be set to RS232_MODEM.

Use the portIndex function to obtain the index of the serial port.

The dial-up connection handler prevents outgoing calls from using the serial port when an incoming call is in progress and communication is active. If communication stops for more than five minutes, then outgoing call requests are allowed to end the incoming call. This prevents problems with the modem or the calling application from permanently disabling outgoing calls.

The function is used with programs that dial out through an external modem using the modemDial function. It is not required where the modem is used for dialing into the controller only.

See Also

modemAbort, modemAbortAll, modemDial, modemDialEnd,

modemDialStatus, modemInit, modemInitEnd, modemInitStatus

Document (Version 2.51) 4/4/2011 357

IEC 61131-3 C Tools Function Specifications

optionSwitch

Read State of Controller Option Switches

Syntax

#include <ctools.h> unsigned optionSwitch(unsigned option);

Description

The optionSwitch function returns the state of the controller option switch specified by option. option may be 1, 2 or 3.

The function returns OPEN if the switch is in the open position. It returns

CLOSED if the switch is in the closed position.

Notes

The option switches are located under the cover of the controller module.

The SCADAPack LP, SCADAPack 100 and SCADAPack of controllers do not have option switches.

All options are user defined.

However, when a SCADAPack I/O module is placed in the Register Assignment, option switch 1 selects the input range for analog inputs on this module. When the SCADAPack AOUT module is placed in the Register Assignment, option switch 2 selects the output range for analog outputs on this module. Refer to the

SCADAPack System Hardware Manual for further information on option switches.

Document (Version 2.51) 4/4/2011 358

IEC 61131-3 C Tools Function Specifications

pidExecute

Execute PID control algorithm

Syntax

#include <ctools.h>

BOOLEAN pidExecute(PID_DATA * pData);

Description

This function executes the PID algorithm. The function may be called as often as desired, but needs to be called at least once per the value in the period field for proper operation.

The function has one parameter. pData is a pointer to a structure containing the

PID block data and outputs.

The function returns TRUE if the PID block executed. The function returns

FALSE if it was not time for execution.

Notes

To properly initialize the PID algorithm do one of the following.

Call the pidInitialize function once before calling this function the first time, or put the PID algorithm in manual mode (autoMode = FALSE in PID_DATA) for the first call to the pidExecute function.

See Also

pidInitialize

Example

This example initializes one PID control structure and executes the control algorithm continuously. Input data is read from analog inputs. Output data is written to analog outputs.

{

#include <ctools.h>

// event number to signal when I/O scan completes

#define IO_COMPLETE 0 void main(void)

INT16 ainData[4];

INT16 aoutData[4]; // analog output data

PID_DATA pidData;

BOOLEAN executed;

// analog input data

// PID algorithm data

// indicates if PID executed

// read analog input ioRequest(MT_Ain4, 0); ioNotification(IO_COMPLETE); wait_event(IO_COMPLETE); ioReadAin4(0, ainData);

Document (Version 2.51) 4/4/2011 359

}

IEC 61131-3 C Tools Function Specifications

// get initial process value from analog input pidData.pv = ainData[0];

// configure PID block pidData.sp = 1000; pidData.gain = 1; pidData.reset = 100; pidData.rate = 0; pidData.deadband = 10; pidData.fullScale = 32767; pidData.zeroScale = 0; pidData.manualOutput = 0; pidData.period = 1000; pidData.autoMode = TRUE;

// initialize the PID block pidInitialize(&pidData);

// main loop while (TRUE)

{

// execute all I/O requests ioRequest(MT_Ain4, 0); ioNotification(IO_COMPLETE); wait_event(IO_COMPLETE);

// get process input ioReadAin4(0, ainData); pidData.pv = ainData[0];

// execute the PID block executed = pidExecute(&pidData);

// if the output changed if (executed)

{

}

// write the output to analog output module aoutData[0] = pidData.output; ioWriteAout4(0, aoutData); ioRequest(MT_Aout4, 0);

}

// release processor to other priority 1 tasks release_processor();

Document (Version 2.51) 4/4/2011 360

IEC 61131-3 C Tools Function Specifications

pidInitialize

Initialize PID controller data

Syntax

#include <ctools.h> void pidInitialize(PID_DATA * pData);

Description

This function initializes the PID algorithm data.

The function has one parameter. pData is a pointer to a structure containing the

PID data and outputs.

The function should be called once before calling the pidExecute function for the first time. The structure pointed to by pData needs to contain valid values for sp, pv, and manualOutput before calling the function.

The function has no return value.

See Also

pidExecute

Example

See the example for pidExecute.

Document (Version 2.51) 4/4/2011 361

IEC 61131-3 C Tools Function Specifications

pollABSlave

Poll DF1 Slave for Response

Syntax

#include <ctools.h> unsigned pollABSlave(FILE *stream, unsigned slave);

Description

The pollABSlave function is used to send a poll command to the slave station specified by slave in the DF1 Half Duplex protocol configured for the specified port. stream specifies the serial port.

The function returns FALSE if the slave number is invalid, or if the protocol currently installed on the specified serial port is not an DF1 Half Duplex protocol.

Otherwise it returns TRUE and the protocol command status is set to MM_SENT.

Notes

See the example using the pollABSlave function in the sample polling function

"poll_for_response" shown in the example for the master_message function.

See Also

master_message

Example

This program segment polls slave station 9 for a response communicating on the

com2 serial port.

#include <ctools.h> pollABSlave(com2, 9);

Document (Version 2.51) 4/4/2011 362

IEC 61131-3 C Tools Function Specifications

poll_event

Test for Event Occurrence

Syntax

#include <ctools.h> int poll_event(int event);

Description

The poll_event function tests if an event has occurred.

The poll_event function returns TRUE, and the event counter is decrements, if the event has occurred. Otherwise it returns FALSE.

The current task continues to execute.

Notes

Refer to the Real Time Operating System section for more information on events.

Valid events are numbered 0 to RTOS_EVENTS - 1. Any events defined in primitiv.h are not valid events for use in an application program.

See Also

signal_event, startTimedEvent

Example

This program implements a somewhat inefficient transfer of data between com1 and com2. (It would be more efficient to test for EOF from getc).

}

#include <ctools.h> void main(void)

{ while(TRUE)

{ if (poll_event(COM1_RCVR)) fputc(getc(com1), com2); if (poll_event(COM2_RCVR)) fputc(getc(com2), com1);

}

/* Allow other tasks to execute */ release_processor();

Document (Version 2.51) 4/4/2011 363

IEC 61131-3 C Tools Function Specifications

poll_message

Test for Received Message

Syntax

#include <ctools.h> envelope *poll_message(void);

Description

The poll_message function tests if a message has been received by the current task.

The poll_message function returns a pointer to an envelope if a message has been received. It returns NULL if no message has been received.

The current task continues to execute.

Notes

Refer to the Real Time Operating System section for more information on messages.

See Also

send_message, receive_message

Example

This task performs a function continuously, and processes received messages

(from higher priority tasks) when they are received.

#include <ctools.h> void task(void)

{ envelope *letter;

} while(TRUE)

{

} letter=poll_message(); if (letter != NULL)

/* process the message now */

/* more code here */

Document (Version 2.51) 4/4/2011 364

IEC 61131-3 C Tools Function Specifications

poll_resource

Test Resource Availability

Syntax

#include <ctools.h> int poll_resource(int resource);

Description

The poll_resource function tests if the resource specified by resource is available. If the resource is available it is given to the task.

The poll_resource function returns TRUE if the resource is available. It returns

FALSE if it is not available.

The current task continues to execute.

Notes

Refer to the Real Time Operating System section for more information on resources.

See Also

request_resource, release_resource

Document (Version 2.51) 4/4/2011 365

IEC 61131-3 C Tools Function Specifications

portConfiguration

Get Pointer to Port Configuration Structure

Syntax

#include <ctools.h> struct pconfig *portConfiguration(FILE *stream);

Description

The portConfiguration function returns a pointer to the configuration structure for stream. A NULL pointer is returned if stream is not valid.

Notes

It is recommended the get_port and set_port functions be used to access the configuration table.

Document (Version 2.51) 4/4/2011 366

IEC 61131-3 C Tools Function Specifications

portIndex

Get Index of Serial Port

Syntax

#include <ctools.h> unsigned portIndex(FILE *stream);

Description

The portIndex function returns an array index for the serial port specified by

stream. It is guaranteed to return a value suitable for an array index, in increasing order of external serial port numbers, if no error occurs.

If the stream is not recognized, SERIAL_PORTS is returned, to indicate an error.

See Also

portStream

Document (Version 2.51) 4/4/2011 367

IEC 61131-3 C Tools Function Specifications

portStream

Get Serial Port Corresponding to Index

Syntax

#include <ctools.h>

FILE *portStream(unsigned index);

Description

The portStream function returns the file pointer corresponding to index. This function is the inverse of the portIndex function. If the index is not valid, the

NULL pointer is returned.

See Also

portIndex

Document (Version 2.51) 4/4/2011 368

IEC 61131-3 C Tools Function Specifications

processModbusCommand

Process a Modbus Command and Return the Response

Syntax

#include <ctools.h>

BOOLEAN processModbusCommand(

FILE * stream,

UCHAR * pCommand,

UINT16 commandLength,

UINT16 responseSize,

UCHAR * pResponse,

UINT16 * pResponseLength

)

Description

The processModbusCommand function processes a Modbus protocol command and returns the response. The function can be used by an application to encapsulate Modbus RTU commands in another protocol. stream is a FILE pointer that identifies the serial port where the command was received. This is used for to accumulate statistics for the serial port. pCommand is a pointer to a buffer containing the Modbus command. The contents of the buffer needs to be a standard Modbus RTU message. The

Modbus RTU checksum is not required. commandLength is the number of bytes in the Modbus command. The length needs to include all the address and data bytes. It cannot include the checksum bytes, if any, in the command buffer. responseSize is the size of the response buffer in bytes. A 300-byte buffer is recommended. If this is not practical in the application, a smaller buffer may be supplied. Some responses may be truncated if a smaller buffer is used. pResponse is a pointer to a buffer to contain the Modbus response. The function will store the response in this buffer in standard Modbus RTU format including two checksum bytes at the end of the response. pResponseLength is a pointer to a variable to hold response length. The function will store the number of bytes in the response in this variable. The length will include two checksum bytes.

The function returns TRUE if the response is valid and can be used. It returns

FALSE if the response is too long to fit into the supplied response buffer.

Notes

To use the function on a serial port, a protocol handler needs to be created for the encapsulating protocol. Set the protocol type for the port to NO_PROTOCOL to allow the custom handler to be used.

The function supports standard and extended addressing. Configure the protocol settings for the serial port for the appropriate protocol.

Document (Version 2.51) 4/4/2011 369

IEC 61131-3 C Tools Function Specifications

The Modbus RTU checksum is not required in the command so the encapsulating protocol may omit them if they are not needed. This may be useful in host devices that don't create a Modbus RTU message with checksum prior to encapsulation.

The Modbus RTU checksum is included in the response to support encapsulating a complete Modbus RTU format message. If the checksum is not needed by the encapsulating protocol the checksum bytes may be ignored.

See Also

setProtocolSettings

Example

This example is taken from a protocol driver than encapsulates Modbus RTU messages in another protocol. It shows how to pass the Modbus RTU command to the Modbus driver, and obtain the response.

The example assumes the Modbus RTU messages are transmitted with the checksum. The length of the checksum is subtracted when calling the processModbusCommand function. The checksum is included when responding.

Contact Control Microsystems technical support department for a complete program that uses this function.

}

/* receive the packet in the encapsulating protocol */

/* verify the packet is valid */

/* locate the Modbus RTU command in the command buffer */ pCommandData = commandBuffer + PROTOCOL_HEADER_SIZE;

/* get length of Modbus RTU command from the packet header */ commandLength = commandBuffer[DATA_SIZE] - 2;

/* locate the Modbus RTU response in the response buffer leaving room for the packet header */ pResponseData = responseBuffer + PROTOCOL_HEADER_SIZE;

{

/* process the Modbus message */ if (processModbusCommand( stream, pCommandData, commandLength,

MODBUS_BUFFER_SIZE, pResponseData,

&responseLength))

/* put the response length in the header */ responseBuffer[DATA_SIZE] = responseLength;

/* fill in rest of packet header */

/* transmit the encapsulated response */

Document (Version 2.51) 4/4/2011 370

IEC 61131-3 C Tools Function Specifications

queue_mode

Control Serial Data Transmission

Syntax

#include <ctools.h> void queue_mode(FILE *stream, int mode);

Description

The queue_mode function controls transmission of the serial data. Normally data output to a serial port are placed in the transmit buffer and transmitted as soon as the hardware is ready. If queuing is enabled, the characters are held in the transmit buffer until queuing is disabled. If the buffer fills, queuing is disabled automatically.

stream specifies the serial port. If it is not valid the function has no effect.

mode specifies the queuing control. It may be DISABLE or ENABLE.

Notes

Queuing is often used with communication protocols that use character timing for message framing. Its uses in an application program are limited.

Document (Version 2.51) 4/4/2011 371

IEC 61131-3 C Tools Function Specifications

readBoolVariable

Read IEC 61131-3 Boolean Variable

Syntax

#include <ctools.h>

BOOLEAN readBoolVariable(unsigned char * varName, unsigned char *

value)

Description

This function returns the current value of the specified boolean variable.

The variable is specified by its name expressed as a character string. The name is case insensitive (The IEC 61131-3 Dictionary also treats variable names as case insensitive). If the variable is found, TRUE is returned and the variable value is written to the unsigned char value pointed to by value. If the variable is not found or if the IEC 61131-3 Symbols Status is invalid, FALSE is returned and the current value is left unchanged. The IEC 61131-3 Symbols Status is invalid if the Application TIC code download and Application Symbols download do not share the same symbols CRC checksum.

Notes

This function requires the IEC 61131-3 Application Symbols to be downloaded to the controller in addition to the Application TIC code. This function provides a convenient method to access IEC 61131-3 variables by name; however, because the variable name needs to be looked up in the IEC 61131-3 variable list each call, the performance of the function may be slow for large numbers of variables.

For better performance, use the variable’s network address and the dbase function.

The IO_SYSTEM system resource needs to be requested before calling this function.

See Also

writeBoolVariable

Example

This program displays the contents of the boolean variable named “Switch1”.

#include <ctools.h> void main(void)

{

BOOLEAN status; unsigned char value; request_resource(IO_SYSTEM); status = readBoolVariable("Switch1", &value); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 372

}

IEC 61131-3 C Tools Function Specifications printf("status = %u, Switch1 = %d\r\n", status, value);

Document (Version 2.51) 4/4/2011 373

IEC 61131-3 C Tools Function Specifications

readCounter

Read Accumulator Input

Syntax

#include <ctools.h> unsigned long readCounter(unsigned counter, unsigned clear);

Description

The readCounter routine reads the digital input counter specified by counter. The

counter may be 0, 1 or 2. If clear is TRUE the counter is cleared after reading; otherwise if it is FALSE the counter continues to accumulate.

If counter is not valid, a BAD_COUNTER error is reported for the current task.

Notes

The three DIN/counter inputs are located on the 5203 or 5204 controller board.

Refer to the System Hardware Manual for more information on the hardware.

The counter increments on the rising edge of the input signal.

See Also

readCounterInput, check_error

Document (Version 2.51) 4/4/2011 374

IEC 61131-3 C Tools Function Specifications

readCounterInput

Read Counter Input Status

Syntax

#include <ctools.h> unsigned readCounterInput(unsigned input)

Description

The readCounterInput function returns the status of the DIN/counter input point specified by input. It returns TRUE if the input is ON and FALSE if the input is

OFF.

If input is not valid, the function returns FALSE.

Notes

The three DIN/counter inputs are located on the 5203 or 5204 controller board.

Refer to the System Hardware Manual for more information on the hardware.

See Also

readBoolVariable

Document (Version 2.51) 4/4/2011 375

IEC 61131-3 C Tools Function Specifications

readBattery

Read Lithium Battery Voltage

Syntax

#include <ctools.h> int readBattery(void);

Description

The readBattery function returns the RAM backup battery voltage in millivolts.

The range is 0 to 5000 mV. A normal reading is about 3600 mV.

Example

#include <ctools.h> if (readBattery() < 2500)

{

} fprintf(com1, “Battery Voltage is low\r\n”);

Document (Version 2.51) 4/4/2011 376

IEC 61131-3 C Tools Function Specifications

readInternalAD

Read Controller Internal Analog Inputs

Syntax

#include <ctools.h> int readInternalAD(unsigned channel);

Description

The readInternalAD function reads analog inputs connected to the internal AD converter. channel may be 0 to 7.

The function returns a value in the range 0 to 32767.

Notes

There are only two channels with signals connected to them.

• AD_THERMISTOR reads the thermistor input.

• AD_BATTERY reads the battery input

See Also

readBattery, readIntVariable

Document (Version 2.51) 4/4/2011 377

IEC 61131-3 C Tools Function Specifications

readIntVariable

Read IEC 61131-3 Integer Variable

Syntax

#include <ctools.h>

BOOLEAN readIntVariable(unsigned char * varName, signed long *

value)

Description

This function returns the current value of the specified integer variable.

The variable is specified by its name expressed as a character string. The name is case insensitive (The IEC 61131-3 Dictionary also treats variable names as case insensitive). If the variable is found, TRUE is returned and the variable value is written to the signed long value pointed to by value. If the variable is not found or if the IEC 61131-3 Symbols Status is invalid, FALSE is returned and the current value is left unchanged. The IEC 61131-3 Symbols Status is invalid if the

Application TIC code download and Application Symbols download do not share the same symbols CRC checksum.

Notes

This function requires the IEC 61131-3 Application Symbols to be downloaded to the controller in addition to the Application TIC code. This function provides a convenient method to access IEC 61131-3 variables by name; however, because the variable name needs to be looked up in the IEC 61131-3 variable list each call, the performance of the function may be slow for large numbers of variables.

For better performance, use the variable’s network address and the dbase function.

The IO_SYSTEM system resource needs to be requested before calling this function.

See Also

writeIntVariable

Example

This program displays the contents of the integer variable named “Temperature”.

#include <ctools.h> void main(void)

{

BOOLEAN status; signed long value; request_resource(IO_SYSTEM); status = readIntVariable("Temperature", &value); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 378

}

IEC 61131-3 C Tools Function Specifications printf("status = %u, Temp = %ld\r\n", status, value);

Document (Version 2.51) 4/4/2011 379

IEC 61131-3 C Tools Function Specifications

readMsgVariable

Read IEC 61131-3 Message Variable

Syntax

#include <ctools.h>

BOOLEAN readMsgVariable(unsigned char * varName, unsigned char * msg)

Description

This function returns the current value of the specified message variable.

The variable is specified by its name expressed as a character string. The name is case insensitive (The IEC 61131-3 Dictionary also treats variable names as case insensitive). If the variable is found, TRUE is returned and the message is written to the string pointed to by msg. If the variable is not found or if the IEC

61131-3 Symbols Status is invalid, FALSE is returned and the buffer is left unchanged. The IEC 61131-3 Symbols Status is invalid if the Application TIC code download and Application Symbols download do not share the same symbols CRC checksum.

The pointer msg needs to point to a character string large enough to hold the maximum length declared for the specified message variable plus two length bytes and a null termination byte (i.e. max declared length + 3). IEC 61131-3 message variables have the following format:

Byte

Location

0

Description

1

2

… max + 1 max + 2

Maximum length as declared in IEC 61131-3 Dictionary (1 to

255)

Current Length = number of bytes up to first null byte in message data (0 to maximum length)

First message data byte

Last byte in message buffer

Null termination byte (Terminates a message having the maximum length.)

Notes

This function requires the IEC 61131-3 Application Symbols to be downloaded to the controller in addition to the Application TIC code. This function provides a convenient method to access IEC 61131-3 variables by name; however, because the variable name needs to be looked up in the IEC 61131-3 variable list each call, the performance of the function may be slow for large numbers of variables.

For better performance, use the variable’s network address and the dbase function.

Document (Version 2.51) 4/4/2011 380

IEC 61131-3 C Tools Function Specifications

The IO_SYSTEM system resource needs to be requested before calling this function.

See Also

writeMsgVariable

Example

This program displays the contents of the message variable named “msgData” of maximum length 20.

}

#include <ctools.h> void main(void)

{

BOOLEAN status; unsigned char msg[23]; request_resource(IO_SYSTEM); status = readMsgVariable("msgData", msg); release_resource(IO_SYSTEM); printf("status = %u, max length = %d, current length = %d, message = %s\r\n", status, msg[0], msg[1], msg + 2);

Document (Version 2.51) 4/4/2011 381

IEC 61131-3 C Tools Function Specifications

readRealVariable

Read IEC 61131-3 Real Variable

Syntax

#include <ctools.h>

BOOLEAN readRealVariable(unsigned char * varName, float * value)

Description

This function returns the current value of the specified real (i.e. floating point) variable.

The variable is specified by its name expressed as a character string. The name is case insensitive (The IEC 61131-3 Dictionary also treats variable names as case insensitive). If the variable is found, TRUE is returned and the variable value is written to the floating point value pointed to by value. If the variable is not found or if the IEC 61131-3 Symbols Status is invalid, FALSE is returned and the current value is left unchanged. The IEC 61131-3 Symbols Status is invalid if the

Application TIC code download and Application Symbols download do not share the same symbols CRC checksum.

Notes

This function requires the IEC 61131-3 Application Symbols to be downloaded to the controller in addition to the Application TIC code. This function provides a convenient method to access IEC 61131-3 variables by name; however, because the variable name needs to be looked up in the IEC 61131-3 variable list each call, the performance of the function may be slow for large numbers of variables.

For better performance, use the variable’s network address and the dbase function.

The IO_SYSTEM system resource needs to be requested before calling this function.

See Also

writeRealVariable

Example

This program displays the contents of the real variable named “Flow”.

#include <ctools.h> void main(void)

{

BOOLEAN float status; value; request_resource(IO_SYSTEM); status = readRealVariable("Flow", &value); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 382

}

IEC 61131-3 C Tools Function Specifications printf("status = %u, Flow = %f\r\n", status, value);

Document (Version 2.51) 4/4/2011 383

IEC 61131-3 C Tools Function Specifications

readRoutingTableEntry

Read Routing Table entry

Syntax:

#include <ctools.h>

BOOLEAN readRoutingTableEntry (

UINT16 index, routingTable *pRoute

);

Description:

This function reads an entry from the routing table.

pRoute is a pointer to a table entry; it is written by this function.

The return value is TRUE if pRoute was successfully written or FALSE otherwise.

Notes:

DNP needs to be enabled before calling this function in order to create the DNP configuration.

The function returns the total number of entries in the DNP routing table.

Document (Version 2.51) 4/4/2011 384

IEC 61131-3 C Tools Function Specifications

readRoutingTableSize

Read Routing Table size

Syntax:

#include <ctools.h>

UINT16 readRoutingTableSize (void);

Description:

This function reads the total number of entries in the routing table.

Notes:

DNP needs to be enabled before calling this function in order to create the DNP configuration.

The function returns the total number of entries in the routing table.

Document (Version 2.51) 4/4/2011 385

IEC 61131-3 C Tools Function Specifications

readStopwatch

Read Stopwatch Timer

Syntax

#include <ctools.h> unsigned long readStopwatch(void)

Description

The readStopwatch function reads the stopwatch timer. The stopwatch time is in ms and has a resolution of 10 ms. The stopwatch time rolls over to 0 when it reaches the maximum value for an unsigned long integer: 4,294,967,295 ms (or about 497 days).

See Also

settimer, timer

Example

This program measures the execution time in ms of an operation.

}

#include <ctools.h> void main(void)

{ unsigned long startTime, endTime; startTime = readStopwatch();

/* operation to be timed */ endTime = readStopwatch(); printf("Execution time = %lu ms\r\n", endTime - startTime);

Document (Version 2.51) 4/4/2011 386

IEC 61131-3 C Tools Function Specifications

readThermistor

Read Controller Ambient Temperature

Syntax

#include <ctools.h> int readThermistor(unsigned scale);

Description

The readThermistor function returns the temperature measured at the main board in the specified temperature scale. If the temperature scale is not recognized, the temperature is returned in Celsius. The scale may be

T_CELSIUS, T_FAHRENHEIT, T_KELVIN or T_RANKINE.

The temperature is rounded to the nearest degree.

Example

}

#include <ctools.h> void checkTemperature(void)

{ int temperature; temperature = readThermistor(T_FAHREHEIT); if (temperature < 0) fprintf(com1, “It’s COLD!!!\r\n”); else if (temperature > 90) fprintf(com1, “It’s HOT!!!\r\n”);

Document (Version 2.51) 4/4/2011 387

IEC 61131-3 C Tools Function Specifications

readTimerVariable

Read IEC 61131-3 Timer Variable

Syntax

#include <ctools.h>

BOOLEAN readTimerVariable(unsigned char * varName, unsigned long *

value)

Description

This function returns the current value in milliseconds of the specified timer variable. The maximum value returned is 86399999 ms (or 24 hours). The specified timer may be active or stopped.

The variable is specified by its name expressed as a character string. The name is case insensitive (The IEC 61131-3 Dictionary also treats variable names as case insensitive). If the variable is found, TRUE is returned and the variable value is written to the unsigned long value pointed to by value. If the variable is not found or if the IEC 61131-3 Symbols Status is invalid, FALSE is returned and the current value is left unchanged. The IEC 61131-3 Symbols Status is invalid if the Application TIC code download and Application Symbols download do not share the same symbols CRC checksum.

Notes

This function requires the IEC 61131-3 Application Symbols to be downloaded to the controller in addition to the Application TIC code. This function provides a convenient method to access IEC 61131-3 variables by name; however, because the variable name needs to be looked up in the IEC 61131-3 variable list each call, the performance of the function may be slow for large numbers of variables.

For better performance, use the variable’s network address and the dbase function.

The IO_SYSTEM system resource needs to be requested before calling this function.

See Also

writeTimerVariable

Example

This program displays the contents of the timer variable named “Time1”.

#include <ctools.h> void main(void)

{

BOOLEAN status; unsigned long value; request_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 388

}

IEC 61131-3 C Tools Function Specifications status = readTimerVariable("Time1", &value); release_resource(IO_SYSTEM); printf("status = %u, Time1 = %lu\r\n", status, value);

Document (Version 2.51) 4/4/2011 389

read_timer_info

Get Timer Status

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> struct timer_info read_timer_info(unsigned timer);

Description

The read_timer_info function gets status information for the timer specified by

timer.

The read_timer_info function returns a timer_info structure with information about the specified timer. Refer to the description of the timer_info structure for information about the fields.

See Also

settimer

Example

This program starts a pulse train and displays timer information.

}

*/

#include <ctools.h> void main(void)

{ struct timer_info tinfo;

/* Start Pulse Train */ interval(10, 1); pulse_train(3, 5, 10, 500);

/* multiplier = 1 while (timer(10) > 100) /* wait a while */

{

/* Allow other tasks to execute */

} release_processor();

/* Display Status of Pulse Train */ tinfo = read_timer_info(10); printf("Pulses Remaining: %d\r\n", tinfo.time/2); printf("Output Channel: %d\r\n", tinfo.channel); printf("Output Bit: %d\r\n", tinfo.bit);

Document (Version 2.51) 4/4/2011 390

IEC 61131-3 C Tools Function Specifications

receive_message

Receive a Message

Syntax

#include <ctools.h> envelope *receive_message(void);

Description

The receive_message function reads the next available envelope from the message queue for the current task. If the queue is empty, the task is blocked until a message is sent to it.

The receive_message function returns a pointer to an envelope structure.

Notes

Refer to the Real Time Operating System section for more information on messages.

See Also

send_message, poll_message

Example

This task waits for messages, then prints their contents. The envelopes received are returned to the operating system.

}

#include <ctools.h> void show_message(void)

{ envelope *msg; while (TRUE)

{

} msg = receive_message(); printf("Message data %ld\r\n", msg->data); deallocate_envelope(msg);

Document (Version 2.51) 4/4/2011 391

IEC 61131-3 C Tools Function Specifications

release_processor

Release Processor to other Tasks

Syntax

#include <ctools.h> void release_processor(void);

Description

The release_processor function releases control of the CPU to other tasks.

Other tasks of the same priority will run. Tasks of the same priority run in a round-robin fashion, as each releases the processor to the next.

Notes

The release_processor function needs to be called in all idle loops of a program to allow other tasks to execute.

Release all resources in use by a task before releasing the processor.

Refer to the Real Time Operating System section for more information on tasks and task scheduling.

See Also

release_resource

Document (Version 2.51) 4/4/2011 392

IEC 61131-3 C Tools Function Specifications

release_resource

Release Control of a Resource

Syntax

#include <ctools.h> void release_resource(int resource);

Description

The release_resource function releases control of the resource specified by

resource.

If other tasks are waiting for the resource, the highest priority of these tasks, is given the resource and is made ready to execute. If no tasks are waiting the resource is made available, and the current task continues to run.

Notes

Refer to the Real Time Operating System section for more information on resources.

See Also

request_resource, poll_resource

Example

See the example for the request_resource function.

Document (Version 2.51) 4/4/2011 393

report_error

Set Task Error Code

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> void report_error(int error);

Description

The report_error functions sets the error code for the current task to error. An error code is maintained for each executing task.

Notes

This function is used in sharable I/O routines to return error codes to the task using the routine.

Some functions supplied with the Microtec C compiler report errors using the global variable errno. The error code in this variable may be written over by another task before it can be used.

See also:

check_error

Document (Version 2.51) 4/4/2011 394

IEC 61131-3 C Tools Function Specifications

request_resource

Obtain Control of a Resource

Syntax

#include <ctools.h> void request_resource(int resource);

Description

The request_resource function obtains control of the resource specified by

resource. If the resource is in use, the task is blocked until it is available.

Notes

Use the request_resource function to control access to non-sharable resources.

Refer to the Real Time Operating System section for more information on resources.

See Also

release_resource, poll_resource

Example

This code fragment obtains the dynamic memory resource, allocates some memory, and releases the resource.

}

#include <ctools.h> void task(void)

{ unsigned *ptr;

/* ... code here */ request_resource(DYNAMIC_MEMORY); ptr = (unsigned *)malloc((size_t)100); release_resource(DYNAMIC_MEMORY);

/* ... more code here */

Document (Version 2.51) 4/4/2011 395

IEC 61131-3 C Tools Function Specifications

resetAllABSlaves

Erase All AB Slave Responses

Syntax

#include <ctools.h> unsigned resetAllABSlaves(FILE *stream);

Description

The resetAllABSlaves function is used to send a protocol message to all slaves communicating on the specified port to erase all responses not yet polled. stream specifies the serial port.

This function applies to the DF1 Half Duplex protocols only. The function returns

FALSE if the protocol currently installed on the specified serial port is not an DF1

Half Duplex protocol, otherwise it returns TRUE.

Notes

The purpose of this command is to re-synch slaves with the master if the master has lost track of the order of responses to poll. This situation may exist if the master has been power cycled, for example. This function should not normally be needed if polling is done using the sample polling function "poll_for_response" shown in the example for the master_message function.

Example

This program segment will cause all slaves communicating on the com2 serial port to erase all pending responses.

#include <protocol.h> resetAllABSlaves(com2);

Document (Version 2.51) 4/4/2011 396

IEC 61131-3 C Tools Function Specifications

resetClockAlarm

Acknowledge and Reset Real Time Clock Alarm

Syntax

#include <ctools.h> void resetClockAlarm(void);

Description

Real time clock alarms occur once after being set. The alarm setting remains in the real time clock. The alarm must be acknowledged before it can occur again.

The resetClockAlarm function acknowledges the last real time clock alarm and re-enables the alarm. Calling the function after waking up from an alarm will reset the alarm for 24 hours after the current alarm.

Notes

This function should be called after a real time clock alarm occurs. This includes after returning from the sleep function with a return code of

WS_REAL_TIME_CLOCK.

The alarm time is not changed by this function.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

setClockAlarm, getClockAlarm, alarmIn

Example

See the example for the installClockHandler function.

Document (Version 2.51) 4/4/2011 397

IEC 61131-3 C Tools Function Specifications

route

Redirect Standard I/O Streams

Syntax

#include <ctools.h> void route(FILE *logical, FILE *hardware);

Description

The route function redirects the I/O streams associated with stdout, stdin, and stderr. These streams are routed to the com1 serial port. logical specifies the stream to redirect. hardware specifies the hardware device which will output the data. It may be one of com1, com2, com3 or com4.

Notes

This function has a global effect, so all tasks must agree on the routing.

Output streams need to be redirected to a device that supports output. Input streams need to be redirected to a device that supports input.

Example

This program segment will redirect all input, output and errors to the com2 serial port.

#include <ctools.h> route(stderr, com2); route(stdout, com2); route(stdin, com2);

/* send errors to com2 */

/* send output to com2 */

/* get input from com2 */

Document (Version 2.51) 4/4/2011 398

IEC 61131-3 C Tools Function Specifications

runLed

Control Run LED State

Syntax

#include <ctools.h> void runLed(unsigned state);

Description

The runLed function sets the run light LED to the specified state. state may be one of the following values.

LED_ON

LED_OFF turn on run LED turn off run LED

The run LED remains in the specified state until changed, or until the controller is reset.

Notes

The ladder logic interpreter controls the state of the RUN LED. If ladder logic is installed in the controller, a C program should not use this function.

}

Example

#include <ctools.h> void main(void)

{ runLed(LED_ON);

/* ... the rest of the code */

/* program is running */

Document (Version 2.51) 4/4/2011 399

IEC 61131-3 C Tools Function Specifications

save

Write Parameters to EEPROM

Syntax

#include <ctools.h> void save(unsigned section);

Description

The save function writes data from RAM to the specified section of the

EEPROM. Valid values for section are EEPROM_EVERY and EEPROM_RUN.

Notes

The EEPROM_EVERY section is loaded whenever the controller is reset. It is not used.

The EEPROM_RUN section is loaded from EEPROM to RAM when the controller is reset and the Run/Service switch is in the RUN position. Otherwise default information is used for this section. This section contains:

• serial port configuration tables

• protocol configuration tables

• store and forward enable flags

• LED power settings

• make for wake-up sources

• execution period on power-up for PID controllers

• HART modem settings

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

load

Example

This code fragment saves all parameters. request_resource(IO_SYSTEM); save(EEPROM_RUN); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 400

IEC 61131-3 C Tools Function Specifications

searchRoutingTable

Search Routing Table

Syntax

#include <ctools.h>

BOOLEAN searchRoutingTable (

UINT16 Address routingTable *pRoute

);

Description

This function searches the routing table for a specific DNP address.

pRoute is a pointer to a table entry; it is written by this function.

The return value is TRUE if pRoute was successfully written or FALSE otherwise.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

Document (Version 2.51) 4/4/2011 401

IEC 61131-3 C Tools Function Specifications

send_message

Send a Message to a Task

Syntax

#include <ctools.h> void send_message(envelope *penv);

Description

The send_message function sends a message to a task. The envelope specified by penv contains the message destination, type and data.

The envelope is placed in the destination task's message queue. If the destination task is waiting for a message it is made ready to execute.

The current task is not blocked by the send_message function.

Notes

Envelopes are obtained from the operating system with the allocate_envelope function.

See Also

receive_message, poll_message, allocate_envelope

Example

This program creates a task to display a message and sends a message to it.

}

#include <ctools.h> void showIt(void)

{ envelope *msg; while (TRUE)

{

} msg = receive_message(); printf("Message data %ld\r\n", msg->data); deallocate_envelope(msg); void main(void)

{ envelope *msg; unsigned tid;

/* message pointer */

/* task ID */ tid = create_task(showIt, 2, APPLICATION, 1); msg = allocate_envelope(); msg->destination = tid;

Document (Version 2.51) 4/4/2011 402

}

IEC 61131-3 C Tools Function Specifications msg->type = MSG_DATA; msg->data = 1002; send_message(msg);

/* wait for ever so that main and other

APPLICATION tasks won’t end */ while(TRUE)

{

/* Allow other tasks to execute */

} release_processor();

Document (Version 2.51) 4/4/2011 403

IEC 61131-3 C Tools Function Specifications

setABConfiguration

Set DF1 Protocol Configuration

Syntax

#include <ctools.h> int setABConfiguration(FILE *stream, struct ABConfiguration

*ABConfig);

Description

The setABConfiguration function sets DF1 protocol configuration parameters.

stream specifies the serial port. ABConfig references an DF1 protocol configuration structure. Refer to the description of the ABConfiguration structure for an explanation of the fields.

The setABConfiguration function returns TRUE if the settings were changed. It returns FALSE if stream does not point to a valid serial port.

See Also

getABConfiguration

Example

This code fragment changes the maximum protected address to 7000. This is the maximum address accessible by protected DF1 commands received on com2.

#include <ctools.h> struct ABConfiguration ABConfig; getABConfiguration(com2, &ABConfig);

ABConfig.max_protected_address = 7000; setABConfiguration(com2, &ABConfig);

Document (Version 2.51) 4/4/2011 404

IEC 61131-3 C Tools Function Specifications

setBootType

Set Controller Boot Up State

Syntax

#include <ctools.h> void setBootType(unsigned type);

Description

The setBootType function defines the controller boot up type code. This function is used by the operating system start up routines. It should not be used in an application program.

Notes

The value set with this function can be read with the getBootType function.

Document (Version 2.51) 4/4/2011 405

setclock

Set Real Time Clock

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> void setclock(struct clock *now);

Description

The setclock function sets the real time clock. now references a clock structure containing the time and date to be set.

Refer to the Structures and Types section for a description of the fields. All fields of the clock structure needs to be set with valid values for the clock to operate properly.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

getclock

}

Example

This function switches the clock to daylight savings time.

#include <ctools.h>

#include <primitiv.h> void daylight(void)

{ struct clock now; request_resource(IO_SYSTEM); now = getclock(); now.hour = now.hour + 1 % 24; setclock(&now); request_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 406

IEC 61131-3 C Tools Function Specifications

setClockAlarm

Set the Real Time Clock Alarm

Syntax

#include <ctools.h> unsigned setClockAlarm(ALARM_SETTING alarm);

Description

The setClockAlarm function configures the real time clock to alarm at the specified alarm setting. The ALARM_SETTING structure alarm specifies the time of the alarm. Refer to the rtc.h section for a description of the fields in the structure.

The function returns TRUE if the alarm can be configured, and FALSE if there is an error in the alarm setting. No change is made to the alarm settings if there is an error.

Notes

An alarm will occur only once, but remains set until disabled. Use the

resetClockAlarm function to acknowledge an alarm that has occurred and reenable the alarm for the same time.

Set the alarm type to AT_NONE to disable an alarm. It is not necessary to specify the hour, minute and second when disabling the alarm.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

alarmIn, getclock

Example

#include <ctools.h>

/* --------------------------------------------

wakeUpAtEight

The wakeUpAtEight function sets an alarm for 08:00 AM and puts the controller into sleep mode.

-------------------------------------------- */ void wakeUpAtEight(void)

{

ALARM_SETTING alarm; unsigned wakeSource;

/* Set alarm for 08:00 */ alarm.type = AT_ABSOLUTE; alarm.hour = 8;

Document (Version 2.51) 4/4/2011 407

} alarm.minute = 0; alarm.second = 0;

IEC 61131-3 C Tools Function Specifications

/* Set the alarm */ request_resource(IO_SYSTEM); setClockAlarm(alarm) release_resource(IO_SYSTEM);

/* Sleep until alarm ignoring other wake ups */ do

{ request_resource(IO_SYSTEM); wakeSource = sleep(); release_resource(IO_SYSTEM);

} until (wakeSource == WS_REAL_TIME_CLOCK);

/* Disable the alarm */ alarm.type = AT_NONE; request_resource(IO_SYSTEM); setClockAlarm(alarm); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 408

IEC 61131-3 C Tools Function Specifications

setdbase

Write Value to I/O Database

Syntax

#include <ctools.h> void setdbase(unsigned type, unsigned address, int value);

Description

The setdbase function writes value to the I/O database. type specifies the method of addressing the database. address specifies the location in the database. If the specified address is not valid then nothing is done. The table below shows the valid address types and ranges.

Type Address Ranges

MODBUS 00001 to NUMCOIL

10001 to 10000 + NUMSTATUS

LINEAR

30001 to 30000 + NUMINPUT

40001 to 40000 + NUMHOLDING

0 to NUMLINEAR-1

Register

Size

1 bit

1 bit

16 bit

16 bit

16 bit

Notes

When writing to LINEAR digital addresses, value is a bit mask which writes data to 16 1-bit registers at once. If any of these 1-bit registers is invalid, only the valid registers are written.

Refer to the Functions Overview section for more information.

If the specified address is in the valid range but it has not been defined by an application, then the address also is invalid. An address is defined if any of the following is true:

• The address has been assigned as the Network Address for an IEC 61131-3

Dictionary variable.

• The address is defined in a database handler installed by a C or C++ application.

• The address is within the default range of the Permanent Non-volatile

Modbus Registers: 40001 to 40000 + NUMHOLDING_PERMANENT, and

00001 to NUMCOIL_PERMANENT.

When this function is called, the specified address is searched for under these three categories in the order listed above until the address is found. If the address is not found, nothing is done. If the address is defined in more than one of these categories, the first occurrence of the address in the order listed is used.

Document (Version 2.51) 4/4/2011 409

IEC 61131-3 C Tools Function Specifications

Refer to the section Permanent Non-Volatile Modbus Registers for details on potential addressing conflicts during application downloading.

The IO_SYSTEM resource needs to be requested before calling this function.

Example

}

#include <ctools.h> void main(void)

{ request_resource(IO_SYSTEM); setdbase(MODBUS, 40001, 102);

/* Turn ON the first 16 coils */ setdbase(LINEAR, START_COIL, 255);

/* Write to a 16 bit register */ setdbase(LINEAR, 3020, 240);

/* Write to the 12th holding register */ setdbase(LINEAR, START_HOLDING, 330);

/* Write to the 12th holding register */ setdbase(LINEAR, START_HOLDING, 330); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 410

IEC 61131-3 C Tools Function Specifications

setDTR

Control RS232 Port DTR Signal

Syntax

#include <ctools.h> void setDTR(FILE *stream, unsigned state);

Description

The setDTR function sets the status of the DTR signal line for the communication port specified by stream. When state is SIGNAL_ON the DTR line is asserted.

When state is SIGNAL_OFF the DTR line is de-asserted.

Notes

The DTR line follows the normal RS232 voltage levels for asserted and deasserted states.

This function is only useful on RS232 ports. The function has no effect if the serial port is not an RS232 port.

Document (Version 2.51) 4/4/2011 411

IEC 61131-3 C Tools Function Specifications

setIOErrorIndication

Set I/O Module Error Indication

Syntax

#include <ctools.h> void setIOErrorIndication(unsigned state);

Description

The setIOErrorIndication function sets the I/O module error indication to the specified state. If set to TRUE, the I/O module communication status is reported in the controller status register and Status LED. If set to FALSE, the I/O module communication status is not reported.

Notes

Refer to the 5203/4 System Manual or the SCADAPack System Manual for further information on the Status LED and Status Output.

See Also

getIOErrorIndication

Document (Version 2.51) 4/4/2011 412

IEC 61131-3 C Tools Function Specifications

setPowerMode

Set Current Power Mode

Syntax

#include <ctools.h>

BOOLEAN setPowerMode(UCHAR cpuPower, UCHAR lan, UCHAR usbPeripheral, UCHAR usbHost);

Description

The setPowerMode function returns TRUE if the new settings were successfully applied. The setPowerMode function allows for power savings to be realized by controlling the power to the LAN port, changing the clock speed, and individually controlling the host and peripheral USB power. The following table of macros summarizes the choices available.

Macro

PM_CPU_FULL

PM_CPU_REDUCED

PM_CPU_SLEEP

PM_LAN_ENABLED

PM_LAN_DISABLED

PM_USB_PERIPHERAL_ENAB

LED

PM_USB_PERIPHERAL_DISAB

LED

PM_USB_HOST_ENABLED

PM_USB_HOST_DISABLED

PM_NO_CHANGE

Meaning

The CPU is set to run at full speed

The CPU is set to run at a reduced speed

The CPU is set to sleep mode

The LAN is enabled

The LAN is disabled

The USB peripheral port is enabled

The USB peripheral port is disabled

The USB host port is enabled

The USB host port is disabled

The current value will be used

TRUE is returned if the requested change was made, otherwise FALSE is returned.

The application program may view the current power mode with the

getPowerMode function.

See Also

getPowerMode, setWakeSource, getWakeSource

Document (Version 2.51) 4/4/2011 413

IEC 61131-3 C Tools Function Specifications

set_port

Set Serial Port Configuration

Syntax

#include <ctools.h> void set_port(FILE *stream, struct pconfig *settings);

Description

The set_port function sets serial port communication parameters. stream must specify one of com1, com2, com3 or com4. settings references a serial port configuration structure. Refer to the description of the pconfig structure for an explanation of the fields.

Notes

If the serial port settings are the same as the current settings, this function has no effect.

The serial port is reset when settings are changed. All data in the receive and transmit buffers are discarded.

To optimize performance, minimize the length of messages on com3 and com4.

Examples of recommended uses for com3 and com4 are for local operator display terminals, and for programming and diagnostics using the IEC 61131-3 program.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

get_port

Example

This code fragment changes the baud rate on com2 to 19200 baud.

#include <ctools.h> struct pconfig settings; get_port(com2, &settings); settings.baud = BAUD19200; request_resource(IO_SYSTEM); set_port(com2, &settings); release_resource(IO_SYSTEM);

This code fragment sets com2 to the same settings as com1.

#include <serial.h>

#include <primitiv.h> struct pconfig settings; request_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 414

IEC 61131-3 C Tools Function Specifications set_port(com2, get_port(com1, &settings)); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 415

IEC 61131-3 C Tools Function Specifications

setProgramStatus

Get Program Status Flag

Syntax

#include <ctools.h> void setProgramStatus( unsigned status );

Description

The setProgramStatus function sets the application program status flag. The status flag is set to NEW_PROGRAM when a cold boot of the controller is performed, or a program is downloaded to the controller from the program loader.

Notes

There are two pre-defined values for the flag. However the application program may make whatever use of the flag it sees fit.

NEW_PROGRAM

PROGRAM_EXECUTED indicates the program is newly loaded. indicates the program has been executed.

See Also

getProgramStatus

Example

See the example for getProgramStatus.

Document (Version 2.51) 4/4/2011 416

IEC 61131-3 C Tools Function Specifications

set_protocol

Set Communication Protocol Configuration

Syntax

#include <ctools.h> int set_protocol(FILE *stream, struct prot_settings *settings);

Description

The set_protocol function sets protocol parameters. stream needs to specify one of com1, com2, com3 or com4. settings references a protocol configuration structure. Refer to the description of the prot_settings structure for an explanation of the fields.

The set_protocol function returns TRUE if the settings were changed. It returns

FALSE if there is an error in the settings or if the protocol does not to start.

The IO_SYSTEM resource needs to be requested before calling this function.

Notes

Setting the protocol type to NO_PROTOCOL ends the protocol task and frees the stack resources allocated to it.

Remember to add a call to modemNotification when writing a custom protocol.

See Also

get_protocol, start_protocol, modemNotification

Example

This code fragment changes the station number of the com2 protocol to 4.

#include <ctools.h> struct prot_settings settings; get_protocol(com2, &settings); settings.station = 4; request_resource(IO_SYSTEM); set_protocol(com2, &settings); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 417

IEC 61131-3 C Tools Function Specifications

setProtocolSettings

Set Protocol Extended Addressing Configuration

Syntax

#include <ctools.h>

BOOLEAN setProtocolSettings(

FILE * stream,

PROTOCOL_SETTINGS * settings

);

Description

The setProtocolSettings function sets protocol parameters for a serial port. This function supports extended addressing.

The function has two arguments: stream is one of com1, com2, com3 or com4; and settings, a pointer to a PROTOCOL_SETTINGS structure. Refer to the description of the structure for an explanation of the parameters.

The function returns TRUE if the settings were changed. It returns FALSE if the stream is not valid, or if the protocol does not start.

The IO_SYSTEM resource must be requested before calling this function.

Notes

Setting the protocol type to NO_PROTOCOL ends the protocol task and frees the stack resources allocated to it.

Remember to add a call to modemNotification when writing a custom protocol.

Extended addressing is available on the Modbus RTU and Modbus ASCII protocols only. See the TeleBUS Protocols User Manual for details.

See Also

getProtocolSettings, start_protocol, get_protocol, set_protocol,

modemNotification

Example

This code fragment sets protocol parameters for the com2 serial port.

#include <ctools.h>

PROTOCOL_SETTINGS settings; settings.type = MODBUS_RTU; settings.station = 1234; settings.priority = 3; settings.SFMessaging = FALSE; settings.mode = AM_extended; request_resource(IO_SYSTEM); setProtocolSettings(com2, &settings);

Document (Version 2.51) 4/4/2011 418

release_resource(IO_SYSTEM);

IEC 61131-3 C Tools Function Specifications

Document (Version 2.51) 4/4/2011 419

IEC 61131-3 C Tools Function Specifications

setProtocolSettingsEx

Sets extended protocol settings for a serial port.

Syntax

#include <ctools.h>

BOOLEAN setProtocolSettingsEx(

FILE * stream,

PROTOCOL_SETTINGS_EX * pSettings

);

Description

The setProtocolSettingsEx function sets protocol parameters for a serial port.

This function supports extended addressing and Enron Modbus parameters.

The function has two arguments:

• stream specifies the serial port. It is one of com1, com2, com3 or com4.

• pSettings is a pointer to a PROTOCOL_SETTINGS_EX structure. Refer to the description of the structure for an explanation of the parameters.

The function returns TRUE if the settings were changed. It returns FALSE if the stream is not valid, or if the protocol does not start.

Notes

The IO_SYSTEM resource needs to be requested before calling this function.

Setting the protocol type to NO_PROTOCOL ends the protocol task and frees the stack resources allocated to it.

Remember to add a call to modemNotification when writing a custom protocol.

Extended addressing and the Enron Modbus station are available on the Modbus

RTU and Modbus ASCII protocols only. See the TeleBUS Protocols User Manual for details.

See Also

getProtocolSettingsEx

Example

This code fragment sets protocol parameters for the com2 serial port.

#include <ctools.h>

PROTOCOL_SETTINGS_EX settings; settings.type = MODBUS_RTU; settings.station = 1; settings.priority = 3; settings.SFMessaging = FALSE; settings.mode = AM_standard;

Document (Version 2.51) 4/4/2011 420

IEC 61131-3 C Tools Function Specifications settings.enronEnabled = TRUE; settings.enronStation = 4; request_resource(IO_SYSTEM); setProtocolSettingsEx(com2, &settings); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 421

IEC 61131-3 C Tools Function Specifications

setSFTranslation

Write Store and Forward Translation

Syntax

#include <ctools.h> struct SFTranslationStatus setSFTranslation(unsigned index, struct

SFTranslation translation);

Description

The setSFTranslation function writes translation into the store and forward address translation table at the location specified by index. translation consists of two port and station address pairs. The function checks for invalid translations; if the translation is not valid it is not stored.

The function returns a SFTranslationStatus structure. It is described in the

Structures and Types section. The code field of the structure is set to one of the following. If there is an error, the index field is set to the location of the translation that is not valid.

Result code Meaning

SF_VALID

SF_PORT_OUT_OF_RA

NGE

All translations are valid

SF_NO_TRANSLATION The entry defines re-transmission of the same message on the same port

One or both of the serial port indexes is not valid

SF_STATION_OUT_OF_

RANGE

One or both of the stations is not valid

SF_ALREADY_DEFINED The translation already exists in the table

SF_INDEX_OUT_OF_RA

NGE

The entry referenced by index does not exist in the table

Notes

The TeleBUS Protocols User Manual describes store and forward messaging mode.

Writing a translation with both stations set to station 256 can clear a translation in the table. Station 256 is not a valid station.

The protocol type and communication parameters may differ between serial ports. The store and forward messaging will translate the protocol messages.

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

getSFTranslation, clearSFTranslationTable, checkSFTranslationTable

Document (Version 2.51) 4/4/2011 422

IEC 61131-3 C Tools Function Specifications

Example

This program enables store and forward messaging on com1 and com2. Two entries are placed into the store and forward table.

The communication parameters and protocol type on com2 are different from com1.

#include <ctools.h> void main(void)

{ struct prot_settings settings; struct pconfig portset; struct SFTranslation translation; struct SFTranslationStatus status; request_resource(IO_SYSTEM);

/* Set communication parameters for port 1 */ portset.baud = BAUD9600; portset.duplex = FULL; portset.parity = NONE; portset.data_bits = DATA8; portset.stop_bits = STOP1; portset.flow_rx = DISABLE; portset.flow_tx = DISABLE; portset.type = RS232; portset.timeout = 600; set_port(com1, &portset);

/* Set communication parameters for port 2 */ portset.baud = BAUD1200; portset.duplex = HALF; portset.parity = NONE; portset.data_bits = DATA8; portset.stop_bits = STOP1;

Document (Version 2.51) 4/4/2011 423

IEC 61131-3 C Tools Function Specifications portset.flow_rx = DISABLE; portset.flow_tx = DISABLE; portset.type = RS232; portset.timeout = 600; set_port(com2, &portset);

/* Set up the translation table */ clearSFTranslationTable(); translation.portA = portIndex(com1); translation.stationA = 2; translation.portB = portIndex(com2); translation.stationB = 3; setSFTranslation(0, translation); translation.portA = portIndex(com1); translation.stationA = 4; translation.portB = portIndex(com2); translation.stationB = 5; setSFTranslation(1, translation);

/* Enable store and forward messaging */ settings.type = MODBUS_RTU; settings.station = 1; settings.priority = 3; settings.SFMessaging = TRUE; set_protocol(com1, &settings); settings.type = MODBUS_ASCII; settings.station = 1; settings.priority = 3; settings.SFMessaging = TRUE; set_protocol(com2, &settings);

Document (Version 2.51) 4/4/2011 424

}

IEC 61131-3 C Tools Function Specifications release_resource(IO_SYSTEM);

}

{

/* Check if everything is correct */ status = checkSFTranslationTable(); if (status.code != SF_VALID)

/* Blink the error code on the status LED */ setStatus(status.code);

} else

{ setStatus(0);

{ while (TRUE)

/* main loop of application program */

}

Document (Version 2.51) 4/4/2011 425

IEC 61131-3 C Tools Function Specifications

setStatus

Set Controller Status Code

Syntax

#include <ctools.h> void setStatus(unsigned code);

Description

The setStatus function sets the controller status code. When the status code is non-zero, the STAT LED blinks a binary sequence corresponding to the code. If

code is zero, the STAT LED turns off.

Notes

The status output opens if code is non-zero. Refer to the System Hardware

Manual for more information.

The binary sequence consists of short and long flashes of the error LED. A short flash of 1/10th of a second indicates a binary zero. A binary one is indicated by a longer flash of approximately 1/2 of a second. The least significant digit is output first. As few bits as possible are displayed, leading zeros are ignored. There is a two second delay between repetitions.

The Register Assignment uses bits 0 and 1 of the status code. It is recommended that the setStatusBit function be used instead of setStatus to prevent modification of these bits.

See Also

setStatusBit, clearStatusBit, getStatusBit

Document (Version 2.51) 4/4/2011 426

IEC 61131-3 C Tools Function Specifications

setStatusBit

Set Bits in Controller Status Code

Syntax

#include <ctools.h> unsigned setStatusBit(unsigned bitMask);

Description

The setStatusBit function sets the bits indicated by bitMask in the controller status code. When the status code is non-zero, the STAT LED blinks a binary sequence corresponding to the code. If code is zero, the STAT LED turns off.

The function returns the value of the status register.

Notes

The status output opens if code is non-zero. Refer to the System Hardware

Manual for more information.

The binary sequence consists of short and long flashes of the error LED. A short flash of 1/10th of a second indicates a binary zero. A binary one is indicated by a longer flash of approximately 1/2 of a second. The least significant digit is output first. As few bits as possible are displayed, leading zeros are ignored. There is a two second delay between repetitions.

The Register Assignment uses bits 0 and 1 of the status code.

See Also

clearStatusBit, clearStatusBit, getStatusBit

Document (Version 2.51) 4/4/2011 427

settimer

Set a Timer

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> void settimer(unsigned timer, unsigned value);

Description

The settimer function loads value into timer specified by timer. The timer counts down at the timer interval frequency.

The settimer function can reset a timer before it has finished counting down.

Notes

The settimer function cancels delayed digital I/O actions started with the

timeout, pulse and pulse_train functions..

See Also

interval

Example

This code fragment sets timer 8 for 10 seconds, using an interval of 0.5 seconds. interval(8, 5); /* interval = 1/2 second */ settimer(8, 20); /* 10 second timer */

This code fragment sets timer 9 for 60 seconds using an interval of 1.0 seconds. interval(9, 10); /* interval = 1 second */ settimer(9, 60); /* 60 second timer */

Document (Version 2.51) 4/4/2011 428

IEC 61131-3 C Tools Function Specifications

setWakeSource

Sets Conditions for Waking from Sleep Mode

Syntax

#include <ctools.h> void setWakeSource(unsigned enableMask);

Description

The setWakeSource routine enables and disables sources that will wake up the processor. It enables all sources specified by enableMask. All other sources are disabled.

Valid wake up sources are listed below. Multiple sources may be OR’ed together.

• WS_NONE

• WS_ALL

• WS_REAL_TIME_CLOCK

• WS_INTERRUPT_INPUT

• WS_LED_POWER_SWITCH

• WS_COUNTER_0_OVERFLOW

• WS_COUNTER_1_OVERFLOW

• WS_COUNTER_2_OVERFLOW

Notes

Specifying WS_NONE as the wake up source will prevent the controller from waking, except by a power on reset.

See Also

getWakeSource, sleep

Example

The code fragments below show how to enable and disable wake up sources.

/* Wake up on all sources */ setWakeSource(WS_ALL);

/* Enable wake up on real time clock only */ setWakeSource(WS_REAL_TINE_CLOCK);

Document (Version 2.51) 4/4/2011 429

IEC 61131-3 C Tools Function Specifications

signal_event

Signal Occurrence of Event

Syntax

#include <ctools.h> void signal_event(int event_number);

Description

The signal_event function signals that the event_number event has occurred.

If there are tasks waiting for the event, the highest priority task is made ready to execute. Otherwise the event flag is incremented. Up to 255 occurrences of an event will be recorded. The current task is blocked of there is a higher priority task waiting for the event.

Notes

Refer to the Real Time Operating System section for more information on events.

Valid events are numbered 0 to RTOS_EVENTS - 1. Any events defined in ctools.h are not valid events for use in an application program.

Example

This program creates a task to wait for an event, then signals the event.

}

#include <ctools.h> void task1(void)

{ while(TRUE)

{ wait_event(20); printf("Event 20 occurred\r\n");

} void main(void)

{ create_task(task1, 3, APPLICATION, 4); while(TRUE)

{

/* body of main task loop */

/* The body of this main task is intended solely for signaling the event waited for by

Normally main would be busy with more important things to do otherwise the code in task1 could be executed within main’s wait loop */ task1.

Document (Version 2.51) 4/4/2011 430

}

}

IEC 61131-3 C Tools Function Specifications settimer(0, 10); while (timer(0))

{

/* 1 second interval */

/* wait for 1 s */

/* Allow other tasks to execute */ release_processor();

} signal_event(20);

Document (Version 2.51) 4/4/2011 431

IEC 61131-3 C Tools Function Specifications

sleep

Suspend Controller Operation

Syntax

#include <ctools.h> unsigned sleep(void);

Description

The sleep function puts the controller into a sleep mode. Sleep mode reduces the power consumption to a minimum by halting the microprocessor clock and shutting down the power supply. All programs halt until the controller resumes execution. All output points turn off while the controller is in sleep mode.

The controller resumes execution under the conditions shown in the table below.

The application program may disable some wake up conditions. If a wake up condition is disabled the controller will not resume execution when the condition occurs. The table below shows the effect of disabling the various wake up conditions. All wake up conditions will be enabled by default. Refer to the description of the setWakeSource function for details.

Condition Wake Up Effects

Hardware

Reset

Disable

Allowed

No

Disable Effect

Not applicable.

External

Interrupt

Real Time

Clock Alarm

LED Power

Button

Hardware

Counter

Rollover

Application programs execute from start of program.

Program execution continues from point sleep function was executed.

Program execution continues from point sleep function was executed.

Program execution continues from point sleep function was executed.

Software portion of counter is incremented.

Program execution continues from point sleep function was executed.

Yes

Yes

Yes

Yes

Interrupt input ignored

Alarm ignored

LED power button ignored

Software portion of counter is incremented.

Controller returns to sleep mode.

Document (Version 2.51) 4/4/2011 432

IEC 61131-3 C Tools Function Specifications

The sleep function returns a wake up code indicating which condition caused the controller to resume execution.

Return Code Condition

WS_REAL_TIME_CLOCK real time clock alarm

WS_INTERRUPT_INPUT rising edge of interrupt input

WS_LED_POWER_SWITCH LED Power switch pushed

WS_COUNTER_0_OVERFL

OW

WS_COUNTER_1_OVERFL

OW roll over of low word of counter 0 (every

65536 transitions) roll over of low word of counter 1 (every

65536 transitions)

WS_COUNTER_2_OVERFL

OW roll over of low word of counter 2 (every

65536 transitions)

The IO_SYSTEM resource needs to be requested before calling this function.

See Also

setclock, alarmIn, setWakeSource, getWakeSource

Example

See the examples for the setClockAlarm and alarmIn functions.

Document (Version 2.51) 4/4/2011 433

start_protocol

Enable Protocol Task

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> int start_protocol(FILE *stream);

Description

The start_protocol function enables a protocol task on the port specified by

stream. The protocol configuration settings stored in memory are used.

The start_protocol function returns TRUE if the protocol started and FALSE if there was an error.

Notes

The start_protocol function is used by the system start up routine. Application programs should use the set_protocol function to control protocol operation.

See Also

get_protocol, set_protocol

Document (Version 2.51) 4/4/2011 434

startup_task

Identify Start Up Task

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> void *startup_task(void);

Description

The startup_task function returns the address of the system or application start up task.

Notes

This function is used by the reset routine. It is normally not used in an application program.

Document (Version 2.51) 4/4/2011 435

IEC 61131-3 C Tools Function Specifications

startTimedEvent

Enable Signaling of a Regular Event

Syntax

#include <ctools.h> unsigned startTimedEvent(unsigned event, unsigned interval);

Description

The startTimedEvent function causes the specified event to be signaled at the specified interval. interval is measured in multiples of 0.1 seconds. The task that is to receive the events should use the wait_event or poll_event functions to detect the event.

The function returns TRUE if the event can be signaled. If interval is 0 or if the event number is not valid, the function returns FALSE and no change is made to the event signaling (a previously enabled event will not be changed).

Notes

Valid events are numbered 0 to RTOS_EVENTS - 1. Any events defined in ctools.h are not valid events for use in an application program.

The application program should stop the signaling of timed events when the task which waits for the events is ended. If the event signaling is not stopped, events will continue to build up in the queue until a function waits for them. The example below shows a simple method using the installExitHandler function.

See Also

endTimedEvent, signal_event

Example

The program prints the time every 10 seconds.

#include <string.h>

#include <ctools.h>

#define TIME_TO_PRINT 15

/* --------------------------------------------

The shutdown function stops the signalling

of TIME_TO_PRINT events.

-------------------------------------------- */ void shutdown(void)

{

} endTimedEvent(TIME_TO_PRINT);

/* --------------------------------------------

The main function sets up signalling of

a timed event, then waits for that event.

Document (Version 2.51) 4/4/2011 436

IEC 61131-3 C Tools Function Specifications

The time is printed each time the event

occurs.

-------------------------------------------- */ void main(void)

{ struct prot_settings settings; struct clock now;

TASKINFO taskStatus;

/* Disable the protocol on serial port 1 */ settings.type = NO_PROTOCOL; settings.station = 1; settings.priority = 3; settings.SFMessaging = FALSE; request_resource(IO_SYSTEM); set_protocol(com1, &settings); release_resource(IO_SYSTEM);

/* set up task exit handler to stop

signalling of events when this task ends */ taskStatus = getTaskInfo(0); installExitHandler(taskStatus.taskID, shutdown);

/* start timed event */ startTimedEvent(TIME_TO_PRINT, 100); while (TRUE)

{ now = getclock(); release_resource(IO_SYSTEM); fprintf(com1, "Time %02u:%02u:%02u\r\n", now.hour, now.minute, now.second);

}

} wait_event(TIME_TO_PRINT); request_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 437

timer

Read a Timer

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> unsigned timer(unsigned timer);

Description

The timer function returns the time remaining in timer. timer needs to be in the range 0 to 31. A zero value means that the timer has finished counting down.

If the timer number is invalid, the function returns 0 and the task's error code is set to TIMER_BADTIMER.

See Also

interval, settimer

Example

This code fragment sets a timer, then displays the time remaining until it reaches

0.

#include <ctools.h> interval(0, 1); settimer(0, 10); while (timer(0)) printf("Time %d\r\n", timer(0));

Document (Version 2.51) 4/4/2011 438

IEC 61131-3 C Tools Function Specifications

timeoutCancel

Cancel Timeout Notification Function

Syntax

#include <ctools.h> unsigned timeoutCancel(unsigned timeoutID);

Description

This function cancels a timeout notification that was requested with the timeoutRequest function. No notification will be sent. The envelope provided when the request was made is de-allocated.

The function has one parameter: the ID of the timeout request. This is the value returned by the timeoutRequest function.

The function returns TRUE if the request was cancelled and FALSE if the timeout

ID is not currently active.

Notes

The function will return FALSE if the timeout notification has already been made.

In this case the envelope will not be de-allocated as it has already been given to the destination task. That task is responsible for de-allocating the envelope.

This function cannot be called from a task exit handler. See installExitHandler function for details of exit handlers.

See Also

timeoutRequest

Example

See the example for the timeoutRequest function.

Document (Version 2.51) 4/4/2011 439

IEC 61131-3 C Tools Function Specifications

timeoutRequest

Request Timeout Notification Function

Syntax

#include <ctools.h> unsigned timeoutRequest(unsigned delay, envelope * pEnvelope);

Description

This function requests a timeout notification. A message is sent to the task specified in the envelope after the specified delay.

A task receives the message using the receive_message or poll_message function. The envelope received by the receiving task has the following characteristics.

• The source field is set to the task ID of the task that called timeoutRequest.

• The message type field is set to MSG_TIMEOUT.

• The message data is set to the timeout ID.

The function has two parameters: the length of time in tenths of a second before the timeout occurs, and a pointer to an envelope. The resolution of the delay is –

0.1/+0 seconds. The notification message is sent delay-1 to delay tenths of a second after the function call.

The function returns the ID of the timeout request. This can be used to identify and cancel the timeout. The timeout ID changes with each call to the function.

Although the ID will eventually repeat, it is sufficiently unique to allow the timeout notification to be identified. This can be useful in identifying notifications received by a task and matching them with requests.

Notes

Do not de-allocate the envelope passed to timeoutRequest in the calling function.

After a call to timeoutRequest either use timeoutCancel to free the envelope if the timeout has not occurred yet, or call deallocate_envelope in the destination task after the envelope has been delivered.

The timeout may be cancelled using the timeoutCancel function.

The task that receives the notification message needs to de-allocate the envelope after receiving it.

No checking is done on the task ID. The caller needs to ensure it is valid.

If the delay is zero, the message is sent immediately, provided an envelope is available.

This function cannot be called from a task exit handler. See installExitHandler function for details of exit handlers.

Document (Version 2.51) 4/4/2011 440

IEC 61131-3 C Tools Function Specifications

See Also

timeoutCancel

Example

This example shows a task that acts on messages received from other tasks and when a timeout occurs. The task waits for a message for up to 10 seconds. If it does not receive one, it proceeds with other processing anyway.

The task shows how to deal with notifications from older timeout requests. These occur when the notification was send before the timeout was cancelled. The task ignores timeout notifications that don’t match the last timeout request.

#include <mriext.h>

#include <ctools.h> void aTask(void)

{ envelope * pEnvelope;

TASKINFO thisTask; unsigned timeoutID; unsigned done;

/* get the task ID for this task */ thisTask = getTaskInfo(0); while (TRUE)

{

/* allocate an envelope and address it to this task */ pEnvelope = allocate_envelope(); pEnvelope->destination = thisTask.taskID;

/* request a timeout in 10 seconds */ timeoutID = timeoutRequest(100, pEnvelope); done = FALSE; while (!done)

{

/* wait for a message or a timeout */ pEnvelope = receive_message();

/* determine the message type */ if (pEnvelope->type == MSG_TIMEOUT)

{

/* does it match the last request? */ if (pEnvelope->data == timeoutID)

}

{

/* accept the timeout */ done = TRUE;

} else

{

/* cancel the timeout */ timeoutCancel(timeoutID); done = TRUE;

Document (Version 2.51) 4/4/2011 441

}

IEC 61131-3 C Tools Function Specifications

/* process message from other task here */

}

/* return the envelope to the RTOS */ deallocate_envelope(pEnvelope);

}

/* proceed with rest of task’s actions here */

}

Document (Version 2.51) 4/4/2011 442

wait_event

Wait for an Event

IEC 61131-3 C Tools Function Specifications

Syntax

#include <ctools.h> void wait_event(int event);

Description

The wait_event function tests if an event has occurred. If the event has occurred, the event counter is decrements and the function returns. If the event has not occurred, the task is blocked until it does occur.

Notes

Refer to the Real Time Operating System section for more information on events.

Valid events are numbered 0 to RTOS_EVENTS - 1. Any events defined in primitiv.h are not valid events for use in an application program.

See Also

signal_event, startTimedEvent

Example

See the example for the signal_event function.

Document (Version 2.51) 4/4/2011 443

IEC 61131-3 C Tools Function Specifications

wd_auto

Automatic Watchdog Timer Mode

Syntax

#include <ctools.h> void wd_auto(void);

Description

The wd_auto function gives control of the watchdog timer to the operating system. The timer is automatically updated by the system.

Notes

Refer to the Functions Overview section for more information.

See Also

wd_manual, wd_pulse

Example

See the example for the wd_manual function

Document (Version 2.51) 4/4/2011 444

IEC 61131-3 C Tools Function Specifications

wd_manual

Manual Watchdog Timer Mode

Syntax

#include <ctools.h> void wd_manual(void);

Description

The wd_manual function takes control of the watchdog timer.

Notes

The application program needs to retrigger the watchdog timer at least every 0.5 seconds using the wd_pulse function, to prevent an controller reset.

Refer to the Functions Overview section for more information.

See Also

wd_auto, wd_pulse

Example

This program takes control of the watchdog timer for a section of code, then returns it to the control of the operating system.

}

#include <ctools.h> void main(void)

{ wd_manual(); wd_pulse();

/* ... code executing in less than 0.5 s */ wd_pulse();

/* ... code executing in less than 0.5 s */ wd_auto()

/* ... as much code as you wish */

Document (Version 2.51) 4/4/2011 445

IEC 61131-3 C Tools Function Specifications

wd_pulse

Retrigger Watchdog Timer

Syntax

#include <ctools.h> void wd_pulse(void);

Description

The wd_pulse function retriggers the watchdog timer.

Notes

The wd_pulse function needs to execute at least every 0.5 seconds, to prevent an controller reset, if the wd_manual function has been executed.

Refer to the Functions Overview section for more information.

See Also

wd_auto, wd_manual

Example

See the example for the wd_manual function

Document (Version 2.51) 4/4/2011 446

IEC 61131-3 C Tools Function Specifications

writeBoolVariable

Write to IEC 61131-3 Boolean Variable

Syntax

#include <ctools.h>

BOOLEAN writeBoolVariable(unsigned char * varName, unsigned char

value)

Description

This function writes to the specified boolean variable.

The variable is specified by its name expressed as a character string. The name is case insensitive (The IEC 61131-3 Dictionary also treats variable names as case insensitive). If the variable is found, TRUE is returned and the specified

value is written to the variable. If the variable is not found or if the IEC 61131-3

Symbols Status is invalid, nothing is done and FALSE is returned. The IEC

61131-3 Symbols Status is invalid if the Application TIC code download and

Application Symbols download do not share the same symbols CRC checksum.

TRUE is written when value is any non-zero value. FALSE is written when value is 0.

Notes

This function requires the IEC 61131-3 Application Symbols to be downloaded to the controller in addition to the Application TIC code. This function provides a convenient method to access IEC 61131-3 variables by name; however, because the variable name needs to be looked up in the IEC 61131-3 variable list each call, the performance of the function may be slow for large numbers of variables.

For better performance, use the variable’s network address and the setdbase function.

The IO_SYSTEM system resource needs to be requested before calling this function.

See Also

setdbase, readBoolVariable

Example

This program writes a TRUE state to the boolean variable named “Switch1”.

}

#include <ctools.h> void main(void)

{

BOOLEAN status; request_resource(IO_SYSTEM); status = writeBoolVariable("Switch1", TRUE); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 447

IEC 61131-3 C Tools Function Specifications

writeIntVariable

Write to IEC 61131-3 Integer Variable

Syntax

#include <ctools.h>

BOOLEAN writeIntVariable(unsigned char * varName, signed long

value)

Description

This function writes to the specified integer variable.

The variable is specified by its name expressed as a character string. The name is case insensitive (The IEC 61131-3 Dictionary also treats variable names as case insensitive). If the variable is found, TRUE is returned and the specified signed long value is written to the variable. If the variable is not found or if the

IEC 61131-3 Symbols Status is invalid, nothing is done and FALSE is returned.

The IEC 61131-3 Symbols Status is invalid if the Application TIC code download and Application Symbols download do not share the same symbols CRC checksum.

Notes

This function requires the IEC 61131-3 Application Symbols to be downloaded to the controller in addition to the Application TIC code. This function provides a convenient method to access IEC 61131-3 variables by name; however, because the variable name needs to be looked up in the IEC 61131-3 variable list each call, the performance of the function may be slow for large numbers of variables.

For better performance, use the variable’s network address and the setdbase function.

The IO_SYSTEM system resource needs to be requested before calling this function.

See Also

setdbase, readIntVariable

Example

This program writes the value 120,000 to the integer variable named

“Pressure1”.

#include <ctools.h> void main(void)

{

BOOLEAN status; request_resource(IO_SYSTEM); status = writeIntVariable("Pressure1", 120000); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 448

}

IEC 61131-3 C Tools Function Specifications

Document (Version 2.51) 4/4/2011 449

IEC 61131-3 C Tools Function Specifications

writeRealVariable

Write to IEC 61131-3 Real Variable

Syntax

#include <ctools.h>

BOOLEAN writeRealVariable(unsigned char * varName, float value)

Description

This function writes to the specified real (i.e. floating point) variable.

The variable is specified by its name expressed as a character string. The name is case insensitive (The IEC 61131-3 Dictionary also treats variable names as case insensitive). If the variable is found, TRUE is returned and the specified floating-point value is written to the variable. If the variable is not found or if the

IEC 61131-3 Symbols Status is invalid, nothing is done and FALSE is returned.

The IEC 61131-3 Symbols Status is invalid if the Application TIC code download and Application Symbols download do not share the same symbols CRC checksum.

Notes

This function requires the IEC 61131-3 Application Symbols to be downloaded to the controller in addition to the Application TIC code. This function provides a convenient method to access IEC 61131-3 variables by name; however, because the variable name needs to be looked up in the IEC 61131-3 variable list each call, the performance of the function may be slow for large numbers of variables.

For better performance, use the variable’s network address and the setdbase function.

The IO_SYSTEM system resource needs to be requested before calling this function.

See Also

setdbase, readRealVariable

Example

This program writes the value 25.607 to the real variable named “Flowrate”.

#include <ctools.h> void main(void)

{

BOOLEAN status; request_resource(IO_SYSTEM); status = writeRealVariable("Flowrate", 25.607); release_resource(IO_SYSTEM);

}

Document (Version 2.51) 4/4/2011 450

IEC 61131-3 C Tools Function Specifications

writeMsgVariable

Write to IEC 61131-3 Message Variable

Syntax

#include <ctools.h>

BOOLEAN writeMsgVariable(unsigned char * varName, unsigned char * msg)

Description

This function writes to the specified message variable.

The variable is specified by its name expressed as a character string. The name is case insensitive (The IEC 61131-3 Dictionary also treats variable names as case insensitive). If the variable is found, TRUE is returned and the specified string is written to the message variable. If the variable is not found or if the IEC

61131-3 Symbols Status is invalid, nothing is done and FALSE is returned. The

IEC 61131-3 Symbols Status is invalid if the Application TIC code download and

Application Symbols download do not share the same symbols CRC checksum.

The pointer msg needs to point to a character string large enough to hold the maximum length declared for the specified message variable plus two length bytes and a null termination byte (i.e. max declared length + 3).

When writing to the message variable, all bytes are copied except the first byte

(max length byte) and the last byte (null termination byte). IEC 61131-3 message variables have the following format:

Byte

Location

0

Description

1

2

… max + 1 max + 2

Maximum length as declared in IEC 61131-3 Dictionary (1 to

255)

Current Length = location of first null byte (0 to maximum length)

First message data byte

Last byte in message buffer

Null termination byte (Terminates a message having the maximum length.)

Notes

This function requires the IEC 61131-3 Application Symbols to be downloaded to the controller in addition to the Application TIC code. This function provides a convenient method to access IEC 61131-3 variables by name; however, because the variable name needs to be looked up in the IEC 61131-3 variable list each call, the performance of the function may be slow for large numbers of variables.

Document (Version 2.51) 4/4/2011 451

IEC 61131-3 C Tools Function Specifications

For better performance, use the variable’s network address and the setdbase function.

The IO_SYSTEM system resource needs to be requested before calling this function.

See Also

setdbase, readMsgVariable

Example

This program writes the message “Warning” to the message variable named

“TextData”. TextData has a maximum length of 10 bytes and a current length of 7 bytes.

}

#include <ctools.h> void main(void)

{

BOOLEAN status; unsigned char msg[13]; msg[0] = 10; msg[1] = 7; msg[2] = 'W'; msg[3] = 'a'; msg[4] = 'r'; msg[5] = 'n'; msg[6] = 'i'; msg[7] = 'n'; msg[8] = 'g'; msg[9] = 0; msg[10] = 0; msg[11] = 0; msg[12] = 0; request_resource(IO_SYSTEM); status = writeMsgVariable("TextData", msg); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 452

IEC 61131-3 C Tools Function Specifications

writeTimerVariable

Write to IEC 61131-3 Timer Variable

Syntax

#include <ctools.h>

BOOLEAN writeTimerVariable(unsigned char * varName, unsigned long

value)

Description

This function writes a value in milliseconds to the specified timer variable. The maximum value that may be written is 86399999 ms (or 24 hours). If the value is greater than 86399999 ms, the value modulus 86399999 is written to the timer variable. The specified timer may be active or stopped.

The variable is specified by its name expressed as a character string. The name is case insensitive (The IEC 61131-3 Dictionary also treats variable names as case insensitive). If the variable is found, TRUE is returned and the specified unsigned long value is written to the variable. If the variable is not found or if the

IEC 61131-3 Symbols Status is invalid, nothing is done and FALSE is returned.

The IEC 61131-3 Symbols Status is invalid if the Application TIC code download and Application Symbols download do not share the same symbols CRC checksum.

Notes

This function requires the IEC 61131-3 Application Symbols to be downloaded to the controller in addition to the Application TIC code. This function provides a convenient method to access IEC 61131-3 variables by name; however, because the variable name needs to be looked up in the IEC 61131-3 variable list each call, the performance of the function may be slow for large numbers of variables.

For better performance, use the variable’s network address and the setdbase function.

The IO_SYSTEM system resource needs to be requested before calling this function.

See Also

setdbase, readTimerVariable

Example

This program writes the value 10000 ms to the timer variable named “Delay”.

#include <ctools.h> void main(void)

{

BOOLEAN status; request_resource(IO_SYSTEM); status = writeTimerVariable("Delay", 10000); release_resource(IO_SYSTEM);

Document (Version 2.51) 4/4/2011 453

}

IEC 61131-3 C Tools Function Specifications

Document (Version 2.51) 4/4/2011 454

IEC 61131-3 C Tools Function Specifications

writeRoutingTableEntry

Write Routing Table Entry

);

Syntax

#include <ctools.h>

BOOLEAN writeRoutingTableEntry (

UINT16 index,

UINT16 dnpAddress,

UINT16 commPort,

UINT16 DataLinkRetries,

UINT16 DataLinkTimeout

Description

This function writes an entry in the DNP routing table.

Notes

DNP needs to be enabled before calling this function in order to create the DNP configuration.

The function returns TRUE if successful, FALSE otherwise.

Example

See the example in the dnpSendUnsolicited section.

Document (Version 2.51) 4/4/2011 455

IEC 61131-3 C Tools Macro Definitions

IEC 61131-3 C Tools Macro Definitions

A

Macro

AB

AB_PARSER

AB_FULL_BCC

AB_FULL_CRC

AB_HALF_BCC

AB_HALF_CRC

AB_PROTOCOL

AD_BATTERY

AD_THERMISTOR

ADDITIVE

AIN_END

AIN_START

AIO_BADCHAN

AIO_SUPPORTED

AIO_TIMEOUT

AO

AOUT_END

AOUT_START

APPLICATION

Document (Version 2.51) 4/4/2011

Definition

Specifies Allan-Bradley database addressing.

System resource: DF1 protocol message parser.

Specifies the DF1 Full Duplex protocol emulation for the serial port. (BCC checksum)

Specifies the DF1 Full Duplex protocol emulation for the serial port. (CRC checksum)

Specifies the DF1 Half Duplex protocol emulation for the serial port. (BCC checksum)

Specifies the DF1 Half Duplex protocol emulation for the serial port. (CRC checksum)

DF1 protocol firmware option

Internal AD channel connected to lithium battery

Internal AD channel connected to thermistor

Additive checksum

Number of last analog input channel.

Number of first analog input channel.

Error code: bad analog input channel specified.

If defined indicates analog I/O supported.

Error code: input device did not respond.

Variable name: alarm output address

Number of last analog output channel.

Number of first analog output channel.

Specifies an application type task. All application tasks are terminated by the end_application function.

456

Macro

AT_ABSOLUTE

AT_NONE

B

Macro

BACKGROUND

BASE_TYPE_MASK

BAUD110

BAUD115200

BAUD1200

BAUD150

BAUD19200

BAUD2400

BAUD300

BAUD38400

BAUD4800

BAUD57600

BAUD600

BAUD75

BAUD9600

BYTE_EOR

C

Macro

CA

CLASS0_FLAG

CLASS1_FLAG

CLASS2_FLAG

CLASS3_FLAG

CLOSED

Document (Version 2.51) 4/4/2011

IEC 61131-3 C Tools Macro Definitions

Definition

Specifies a fixed time of day alarm.

Disables alarms

Definition

System event: background I/O requested.

The background I/O task uses this event. It should not be used in an application program.

Controller type bit mask

Specifies 110-baud port speed.

Specifies 115200-baud port speed.

Specifies 1200-baud port speed.

Specifies 150-baud port speed.

Specifies 19200-baud port speed.

Specifies 2400-baud port speed.

Specifies 300-baud port speed.

Specifies 38400-baud port speed.

Specifies 4800-baud port speed.

Specifies 57600-baud port speed.

Specifies 600-baud port speed.

Specifies 75-baud port speed.

Specifies 9600-baud port speed.

Byte-wise exclusive OR checksum

Definition

Variable name: cascade setpoint source specifies a flag for enabling DNP Class 0 data specifies a flag for enabling DNP Class 1 data specifies a flag for enabling DNP Class 2 data specifies a flag for enabling DNP Class 3 data

Specifies switch is in closed position

457

Macro

COLD_BOOT com1

COM1_FREE

COM1_RCVR com2

COM2_FREE

COM2_RCVR com3

COM3_RCVR com4

COM4_RCVR

COUNTER_CHANNELS

COUNTER_END

COUNTER_START

COUNTER_SUPPORTED

CPU_CLOCK_RATE

CR

CRC_16

CRC_CCITT

IEC 61131-3 C Tools Macro Definitions

Definition

Cold-boot switch depressed when CPU was reset.

Points to a file object for the com1 serial port.

System event: com1 transmit buffer is no longer full. This event is used internally by the serial I/O driver.

System event: indicates activity on com1 receiver. The meaning depends on the character handler installed.

Points to a file object for the com2 serial port.

System event: com2 transmit buffer is no longer full. This event is used internally by the serial I/O driver.

System event: indicates activity on com2 receiver. The meaning depends on the character handler installed.

Points to a file object for the com3 serial port.

System event: indicates activity on com3 receiver. The meaning depends on the character handler installed.

Points to a file object for the com4serial port.

System event: indicates activity on com4 receiver. The meaning depends on the character handler installed.

Specifies number of 5000 I/O counter input channels

Number of last counter input channel

Number of first counter input channel

If defined indicates counter I/O hardware supported.

Frequency of the system clock in cycles per second

Variable name: control register

CRC-16 type CRC checksum (reverse algorithm)

CCITT type CRC checksum (reverse algorithm)

Document (Version 2.51) 4/4/2011 458

D

Macro

DATA_SIZE

DATA7

DATA8

DB

DB_BADSIZE

DB_BADTYPE

DB_OK

DCA_ADD

DCA_REMOVE

DCAT_C

DCAT_LOGIC1

DCAT_LOGIC2

DE_BadConfig

DE_BusyLine

DE_CallAborted

DE_CarrierLost

DE_FailedToConnect

DE_InitError

DE_NoDialTone

DE_NoError

DE_NoModem

Document (Version 2.51) 4/4/2011

IEC 61131-3 C Tools Macro Definitions

Definition

Maximum length of the HART command or response field.

Specifies 7 bit world length.

Specifies 8 bit word length.

Variable name: deadband

Error code: out of range address specified

Error code: bad database addressing type specified

Error code: no error occurred

Add the ID to the configuration registers.

Remove the ID from the configuration registers.

Device configuration application type is a C application

Device configuration application type is the first logic application

Device configuration application type is the second logic application

The modem configuration structure contains an error

The phone number called was busy

A call in progress was aborted by the user

The connection to the remote site was lost

(modem reported NO CARRIER). Carrier is lost for a time exceeding the S10 setting in the modem. Phone lines with call waiting are very susceptible to this condition.

The modem could not connect to the remote site

Modem initialization failed (the modem may be turned off)

Modem did not detect a dial tone or the S6 setting in the modem is too short.

No error has occurred

The serial port is not configured as a modem (port type must be

RS232_MODEM). Or no modem is connected to the controller serial port.

459

E

Macro

DE_NotInControl

DIN_END

DIN_START

DIO_SUPPORTED

DISABLE

DNP

DO

DOUT_END

DOUT_START

DS_Calling

DS_Connected

DS_Inactive

DS_Terminating

DUTY_CYCLE

DYNAMIC_MEMORY

IEC 61131-3 C Tools Macro Definitions

Definition

The serial port is in use by another modem function or has answered an incoming call.

Number of last regular digital input channel.

Number of first regular digital input channel

If defined indicates digital I/O hardware supported.

Specifies flow control is disabled.

Specifies the DNP protocol for the serial port

Variable name: decrease output

Number of last regular digital output channel.

Number of first regular digital output channel

The controller is making a connection to a remote controller

The controller is connected to a remote controller

The serial port is not in use by a modem

The controller is ending a connection to a remote controller.

Specifies timer is generating square wave output.

System resource: all memory allocation functions such as malloc, alloc, and zalloc.

Macro

EEPROM_EVERY

EEPROM_RUN

EEPROM_SUPPORTED

ENABLE

ER

EVEN

EX

Definition

EEPROM section loaded to RAM on every

CPU reboot

EEPROM section loaded to RAM on RUN type boots only.

If defined, indicates that there is an

EEPROM in the controller.

Specifies flow control is enabled.

Variable name: error

Specifies even parity.

Variable name: automatic execution period

Document (Version 2.51) 4/4/2011 460

F

G

H

I

Macro

EXTENDED_DIN_END

EXTENDED_DIN_START

EXTENDED_DOUT_END

EXTENDED_DOUT_START

IEC 61131-3 C Tools Macro Definitions

Definition

Number of last extended digital input channel.

Number of first extended digital input channel

Number of last extended digital output channel.

Number of first extended digital output channel

Macro

FOPEN_MAX

FORCE_MULTIPLE_COILS

FORCE_SINGLE_COIL

FULL

Definition

Redefinition of macro from stdio.h

Modbus function code

Modbus function code

Specifies full duplex.

Macro

GASFLOW

GFC_4202

GFC_4202DS

Macro

HALF

Macro

IO_SYSTEM

Definition

Gas Flow calculation firmware option

SCADAPack 4202 DR controller

SCADAPack 4202 DS controller

Definition

Specifies half duplex.

Definition

System resource for all I/O hardware functions.

Document (Version 2.51) 4/4/2011 461

L

IEC 61131-3 C Tools Macro Definitions

Macro

LED_OFF

LED_ON

LINEAR

LOAD_MULTIPLE_REGISTER

S

LOAD_SINGLE_REGISTER

LOCAL_COUNTERS

Definition

Specifies LED is to be turned off.

Specifies LED is to be turned on.

Specifies linear database addressing.

Modbus function code

Modbus function code

Number of 5203/4 counter inputs

M

Macro

MAX_PRIORITY

MM_BAD_ADDRESS

MM_BAD_FUNCTION

MM_BAD_LENGTH

MM_BAD_SLAVE

MM_NO_MESSAGE

MM_PROTOCOL_NOT_SUPPORTE

D

MM_RECEIVED

MM_RECEIVED_BAD_LENGTH

MM_SENT

MODBUS

MODBUS_ASCII

MM_EOT

Definition

The maximum task priority.

Master message status: invalid database address

Master message status: invalid function code

Master message status: invalid message length

Master message status: invalid slave station address

Master message status: no message was sent.

Master message status: selected protocol is not supported.

Master message status: response received.

Master message status: response received with the incorrect amount of data.

Master message status: message was sent.

Specifies Modbus database addressing.

Specifies the Modbus ASCII protocol emulation for the serial port.

Master message status: DF1 slave response was an EOT message

Document (Version 2.51) 4/4/2011 462

IEC 61131-3 C Tools Macro Definitions

Macro

MM_WRONG_RSP

MM_CMD_ACKED

MM_EXCEPTION_ADDRESS

MM_EXCEPTION_DEVICE_BUSY

MM_EXCEPTION_DEVICE_FAILUR

E

MM_EXCEPTION_FUNCTION

MM_EXCEPTION_VALUE

MODBUS_PARSER

MODBUS_RTU

MODEM_CMD_MAX_LEN

MODEM_MSG

MSG_DATA

MSG_POINTER

Definition

Master message status: DF1 slave response did not match command sent.

Master message status: DF1 half duplex command has been acknowledged by slave – Master may now send poll command.

Master message status: Modbus slave returned an address exception.

Master message status: Modbus slave returned a Device Busy exception.

Master message status: Modbus slave returned a Device Failure exception.

Master message status: Modbus slave returned a function exception.

Master message status: Modbus slave returned a value exception.

System resource: Modbus protocol message parser.

Specifies the Modbus RTU protocol emulation for the serial port.

Maximum length of the modem initialization command string

System event: new modem message generated.

Specifies the data field in an envelope contains a data value.

Specifies the data field in an envelope contains a pointer.

N

Macro

NEVER

NEW_PROGRAM

NO_ERROR

NO_PROTOCOL

NONE

NORMAL

NORMAL

Document (Version 2.51) 4/4/2011

Definition

System event: this event will never occur.

Application program is newly loaded.

Error code: indicates no error has occurred.

Specifies no communication protocol for the serial port.

Specifies no parity.

Specifies normal count down timer.

Specifies normal count down timer.

463

IEC 61131-3 C Tools Macro Definitions

Macro Definition

NOTYPE

NUMAB

NUMCOIL

Specifies serial port type is not known.

Number of registers in the Allan-Bradley database.

Number of registers in the Modbus coil section.

NUMCOIL_PERMANENT

NUMHOLDING

Number of coil registers in the Permanent

Non-Volatile Modbus Registers section.

Number of registers in the Modbus holding register section.

NUMHOLDING_PERMANENT Number of holding registers in the

Permanent Non-Volatile Modbus Registers section.

NUMINPUT

NUMLINEAR

NUMSTATUS

Number of registers in the Modbus input register section.

Number of registers in the linear database.

Number of registers in the Modbus status section.

O

Macro

ODD

OPEN

Definition

Specifies odd parity.

Specifies switch is in open position

P

Macro Definition

PC_FLOW_RX_RECEIVE_ST

OP

Receiver disabled after receipt of a message.

PC_FLOW_RX_XON_XOFF Receiver Xon/Xoff flow control.

PC_FLOW_TX_IGNORE_CTS Transmitter flow control ignores CTS.

PC_FLOW_TX_XON_XOFF

PC_PROTOCOL_RTU_FRAMI

NG

Transmitter Xon/Xoff flow control.

Modbus RTU framing.

PHONE_NUM_MAX_LEN

PM_CPU_FULL_CLOCK

Maximum length of the phone number string

The CPU is set to run at full speed

PM_CPU_REDUCED_CLOCK The CPU is set to run at a reduced speed

PM_CPU_SLEEP

PM_LAN_ENABLED

PM_LAN_DISABLED

The CPU is set to sleep mode

The LAN is enabled

The LAN is disabled

Document (Version 2.51) 4/4/2011 464

IEC 61131-3 C Tools Macro Definitions

Macro

PM_USB_PERIPHERAL_ENA

BLED

PM_USB_PERIPHERAL_DISA

BLED

PM_USB_HOST_ENABLED

PM_USB_HOST_DISABLED

PM_UNAVAILABLE

PM_NO_CHANGE

PROGRAM_EXECUTED

PROGRAM_NOT_LOADED

Definition

The USB peripheral port is enabled

The USB peripheral port is disabled

The USB host port is enabled

The USB host port is disabled

The status of the device could not be read.

The current value will be used

Application program has been executed.

The requested application program is not loaded.

R

Macro Definition

READ_COIL_STATUS Modbus function code

READ_EXCEPTION_STATUS Modbus function code

READ_HOLDING_REGISTER Modbus function code

READ_INPUT_REGISTER Modbus function code

READ_INPUT_STATUS Modbus function code

READSTATUS

REPORT_SLAVE_ID

RS232

RS232_COLLISION_AVOIDAN

CE

RS232_MODEM enum ReadStatus

Modbus function code

Specifies serial port is an RS-232 port.

Specifies serial port is RS232 and uses CD for collision avoidance.

Specifies serial port is an RS-232 dial-up modem.

Specifies serial port is a 4 wire RS-485 port. RS485_4WIRE

RTOS_ENVELOPES

RTOS_EVENTS

RTOS_PRIORITIES

RTOS_RESOURCES

RTOS_TASKS

RUN

Number of RTOS envelopes.

Number of RTOS events.

Number of RTOS task priorities.

Number of RTOS resource flags.

Number of RTOS tasks.

Run/Service switch is in RUN position.

S

Document (Version 2.51) 4/4/2011 465

IEC 61131-3 C Tools Macro Definitions

Macro Definition

S_MODULE_FAILURE

S_NORMAL

SCADAPACK

SCADAPACK_LIGHT

SCADAPACK_PLUS

SERIAL_PORTS

SERVICE

Status LED code for I/O module communication failure

Status LED code for normal status

SCADAPack controller

SCADAPack LIGHT controller

SCADAPack PLUS controller

Number of serial ports.

Run/Service switch is in SERVICE position.

SF_ALREADY_DEFINED Result code: translation is already defined in the table

SF_INDEX_OUT_OF_RANGE Result code: invalid translation table index

SF_NO_TRANSLATION Result code: entry does not define a translation

SF_PORT_OUT_OF_RANGE Result code: serial port is not valid

Result code: station number is not valid SF_STATION_OUT_OF_RAN

GE

SF_TABLE_SIZE

SF_VALID

SIGNAL_CTS

SIGNAL_CTS

SIGNAL_DCD

Number of entries in the store and forward table

Result code: translation is valid

I/O line bit mask: clear to send signal

Matches status of CTS input.

I/O line bit mask: carrier detect signal

SIGNAL_DCD

SIGNAL_OFF

SIGNAL_OH

SIGNAL_OH

SIGNAL_ON

SIGNAL_RING

Matches status of DCD input.

Specifies a signal is de-asserted

I/O line bit mask: off hook signal

Not supported – forced low (1).

Specifies a signal is asserted

I/O line bit mask: ring signal

SIGNAL_RING

SIGNAL_VOICE

SIGNAL_VOICE

START_INPUT

Not supported – forced low (0).

I/O line bit mask: voice/data switch signal

Not supported – forced low (0).

SLEEP_MODE_SUPPORTED Defined if sleep function is supported

SMARTWIRE_5201_5202 SmartWIRE 5201 and 5202 controllers

STACK_SIZE

START_COIL

Size of the machine stack.

Start of the coils section in the linear database.

START_HOLDING Start of the holding register section in the linear database.

Start of the input register section in the linear database.

Document (Version 2.51) 4/4/2011 466

Macro

START_STATUS

STARTUP_

APPLICATION

STARTUP_SYSTEM

STOP1

STOP2

SYSTEM

IEC 61131-3 C Tools Macro Definitions

Definition

Start of the status section in the linear database.

Specifies the application start up task.

Specifies the system start up task.

Specifies 1 stop bit.

Specifies 2 stop bits.

Specifies a system type task. System tasks are not terminated by the end_application function.

T

Macro

T_CELSIUS

T_FAHRENHEIT

T_KELVIN

T_RANKINE

TELESAFE_6000_16EX

TELESAFE_MICRO_16

TIMED_OUT

TIMEOUT

TIMER_BADADDR

TIMER_BADINTERVAL

TIMER_BADTIMER

TIMER_BADVALUE

TIMER_MAX

TS_EXECUTING

TS_READY

TS_WAIT_

RESOURCE

TS_WAIT_ENVELOPE

TS_WAIT_EVENT

TS_WAIT_MESSAGE

Document (Version 2.51) 4/4/2011

Definition

Specifies temperatures in degrees Celsius

Specifies temperatures in degrees

Fahrenheit

Specifies temperatures in degrees Kelvin

Specifies temperatures in degrees Rankine

TeleSAFE 6000-16EX controller

TeleSAFE Micro16 controller

Specifies timer is has reached zero.

Specifies timer is generating timed output change.

Error code: invalid digital I/O address

Error code: invalid timer interval

Error code: invalid timer

Error code: invalid time value

Number of last valid software timer.

Task status indicating task is executing.

Task status indicating task is ready to execute

Task status indicating task is blocked waiting for a resource

Task status indicating task is blocked waiting for an envelope

Task status indicating task is blocked waiting for an event

Task status indicating task is blocked waiting for a message

467

V

W

IEC 61131-3 C Tools Macro Definitions

Macro

VI_DATE_SIZE

Definition

Number of characters in version information date field

Macro

WRITESTATUS

WS_ALL

WS_COUNTER_0_OVERFLO

W

WS_COUNTER_1_OVERFLO

W

WS_COUNTER_2_OVERFLO

W

WS_INTERRUPT_INPUT

WS_LED_POWER_SWITCH

WS_NONE

WS_REAL_TIME_CLOCK

WS_UNDEFINED

Definition

enum WriteStatus

All wake up sources enabled

Bit mask to enable counter 0 overflow as wake up source

Bit mask to enable counter 1 overflow as wake up source

Bit mask to enable counter 2 overflow as wake up source

Bit mask to enable interrupt input as wake up source

Bit mask to enable LED power switch as wake up source

No wake up source enabled

Bit mask to enable real time clock as wake up source

Undefined wake up source

Document (Version 2.51) 4/4/2011 468

IEC 61131-3 C Tools Structures and Types

IEC 61131-3 C Tools Structures and Types

ABConfiguration

The ABConfiguration structure defines settings for DF1 communication protocol.

/* DF1 Protocol Configuration */ struct ABConfiguration { unsigned min_protected_address; unsigned max_protected_address;

};

• min_protected_address is the minimum allowable DF1 physical 16-bit address allowed in all protected commands. The default value is 0.

• max_protected_address is the maximum allowable DF1 physical 16-bit address allowed in all protected commands. The default value is NUMAB.

ADDRESS_MODE

The ADDRESS_MODE enumerated type describes addressing modes for communication protocols. typedef enum addressMode_t

{

AM_standard = 0,

AM_extended

}

ADDRESS_MODE;

• AM_standard returns standard Modbus addressing. Standard addressing allows 255 stations and is compatible with standard Modbus devices

• AM_extended returns extended addressing. Extended addressing allows

65534 stations.

ALARM_SETTING

The ALARM_SETTING structure defines a real time clock alarm setting. typedef struct alarmSetting_tag {

UINT16 type;

UINT16 hour;

UINT16 minute;

UINT16 second;

} ALARM_SETTING;

• type specifies the type of alarm. It may be the AT_NONE or AT_ABSOLUTE macro.

Document (Version 2.51) 4/4/2011 469

IEC 61131-3 C Tools Structures and Types

• hour specifies the hour at which the alarm will occur.

• minute specifies the minute at which the alarm will occur.

• second specifies the second at which the alarm will occur.

clock

The clock structure contains time and date for reading or writing the real time clock. struct clock {

UINT16 year;

UINT16 month;

UINT16 day;

UINT16 dayofweek;

UINT16 hour;

UINT16 minute;

UINT16 second;

};

• year is the current year. It is two digits in the range 00 to 99.

• month is the current month. It is in the range 1 to 12.

• day is the current day. It is in the range 1 to 31.

• dayofweek is the current day of the week. It is in the range 1 to 7. 1 =

Sunday, 2 = Monday…7 = Saturday.

• hour is the current hour. It is in the range 00 to 23.

• minute is the current minute. It is in the range 00 to 59.

• second is the current second. It is in the range 00 to 59.

DATALOG_CONFIGURATION

The data log configuration structure holds the configuration of the data log. Each record in a data log may hold up to eight fields. Not all the fields are used if fewer than eight variables are declared.

The amount of memory used for a record depends on the number of fields in the record and the size of each field. Use the datalogRecordSize function to determine the memory needed for each record. typedef struct datalogConfiguration_type {

UINT16 records; /* # of records */

UINT16 fields; /* # of fields per record */

DATALOG_VARIABLE typesOfFields[MAX_NUMBER_OF_FIELDS];

} DATALOG_CONFIGURATION;

DATALOG_STATUS

The data log status enumerated type is used to report status information. typedef enum {

Document (Version 2.51) 4/4/2011 470

IEC 61131-3 C Tools Structures and Types

DLS_CREATED, /* data log created */

DLS_BADID, /* invalid log ID */

DLS_EXISTS, /* log already exists */

DLS_BADSEQUENCE

} DATALOG_STATUS;

/* sequence number not in use */

DATALOG_VARIABLE

The data log variable enumerated type is specify the type and size of variables to be recorded in the log. typedef enum {

DLV_UINT16 = 0,

DLV_INT16,

DLV_UINT32,

DLV_INT32,

/* 16 bit unsigned integer */

/* 16 bit signed integer */

/* 32 bit unsigned integer */

/* 32 bit signed integer */

DLV_FLOAT, /* 32 bit floating point */

DLV_CMITIME, /* 64 bit time */

DLV_DOUBLE

} DATALOG_VARIABLE;

/* 64 bit floating point */

DialError

The DialError enumerated type defines error responses from the dial-up modem functions and may have one of the following values. enum DialError

{

DE_NoError = 0,

DE_BadConfig,

DE_NoModem,

DE_InitError,

DE_NoDialTone,

DE_BusyLine,

DE_CallAborted,

DE_FailedToConnect,

DE_CarrierLost,

DE_NotInControl

DE_CallCut

};

• DE_NoError returns no error has occurred

• DE_BadConfig returns the modem configuration structure contains an error

• DE_NoModem returns the serial port is not configured as a modem (port type must be RS232_MODEM). Or no modem is connected to the controller serial port.

• DE_InitError returns modem initialization failed (the modem may be turned off)

• DE_NoDialTone returns modem did not detect a dial tone or the S6 setting in the modem is too short.

• DE_BusyLine returns the phone number called was busy

Document (Version 2.51) 4/4/2011 471

IEC 61131-3 C Tools Structures and Types

• DE_CallAborted returns a call in progress was aborted by the user

• DE_FailedToConnect returns the modem could not connect to the remote site

• DE_CarrierLost returns the connection to the remote site was lost (modem reported NO CARRIER). Carrier is lost for a time exceeding the S10 setting in the modem. Phone lines with call waiting are very susceptible to this condition.

• DE_NotInControl returns the serial port is in use by another modem function or has answered an incoming call.

• DE_CallCut returns an incoming call was disconnected while attempting to dial out.

DialState

The DialState enumerated type defines the state of the modemDial operation and may have one of the following values. enum DialState

{

DS_Inactive,

DS_Calling,

DS_Connected,

DS_Terminating

};

• DS_Inactive returns the serial port is not in use by a modem

• DS_Calling returns the controller is making a connection to a remote controller

• DS_Connected returns the controller is connected to a remote controller

• DS_Terminating returns the controller is ending a connection to a remote controller.

dnpAnalogInput

The dnpAnalogInput type describes a DNP analog input point. This type is used for both 16-bit and 32-bit points. typedef struct dnpAnalogInput_type

{

UINT16 modbusAddress;

UCHAR class;

UINT32 deadband;

} dnpAnalogInput;

• modbusAddress is the address of the Modbus register number associated with the point.

• class is the reporting class for the object. It may be set to CLASS_1,

CLASS_2 or CLASS_3.

Document (Version 2.51) 4/4/2011 472

IEC 61131-3 C Tools Structures and Types

• deadband is the amount by which the analog input value must change before an event will be reported for the point.

dnpAnalogOutput

The dnpAnalogOutput type describes a DNP analog output point. This type is used for both 16-bit and 32-bit points. typedef struct dnpAnalogOutput_type

{

UINT16 modbusAddress;

} dnpAnalogOutput;

• modbusAddress is the address of the Modbus register associated with the point.

dnpBinaryInput dnpBinaryInputEx_type

The dnpBinaryInputEx type describes an extended DNP Binary Input point. typedef struct dnpBinaryInputEx_type

{

UINT16 modbusAddress;

UCHAR eventClass;

UCHAR debounce;

} dnpBinaryInputEx;

• modbusAddress is the address of the Modbus register associated with the point.

• class is the reporting class for the object. It may be set to CLASS_1,

CLASS_2 or CLASS_3.

• debounceTime is the debounce time for thebinary input.

dnpBinaryOutput

The dnpBinaryInput type describes a DNP binary input point. typedef struct dnpBinaryInput_type

{

UINT16 modbusAddress;

UCHAR class;

} dnpBinaryInput;

• modbusAddress is the address of the Modbus register associated with the point.

• class is the reporting class for the object. It may be set to CLASS_1,

CLASS_2 or CLASS_3.

The dnpBinaryOutput type describes a DNP binary output point. typedef struct dnpBinaryOutput_type

{

Document (Version 2.51) 4/4/2011 473

IEC 61131-3 C Tools Structures and Types

UINT16 modbusAddress1;

UINT16 modbusAddress2;

UCHAR controlType;

} dnpBinaryOutput;

• modbusAddress1 is the address of the first Modbus register associated with the point. This field is always used.

• modbusAddress2 is the address of the second Modbus register associated with the point. This field is used only with paired outputs. See the controlType field.

• controlType determines if one or two outputs are associated with this output point. It may be set to PAIRED or NOT_PAIRED.

• A paired output uses two Modbus registers for output. The first output is the

Trip output and the second is the Close output. This is used with Control

Relay Output Block objects.

• A non-paired output uses one Modbus register for output. This is used with

Binary Output objects.

DNP_CONNECTION_EVENT Type

This enumerated type lists DNP events. typedef enum dnpConnectionEventType

{

DNP_CONNECTED=0,

DNP_DISCONNECTED,

DNP_CONNECTION_REQUIRED,

DNP_MESSAGE_COMPLETE,

DNP_MESSAGE_TIMEOUT

} DNP_CONNECTION_EVENT;

• The DNP_CONNECTED event indicates that the handler has connected to the master station. The application sends this event to DNP. When DNP receives this event it will send unsolicited messages.

• The DNP_DISCONNECTED event indicates that the handler has disconnected from the master station. The application sends this event to

DNP. When DNP receives this event it will request a new connection before sending unsolicited messages.

• The DNP_CONNECTION_REQUIRED event indicates that DNP wishes to connect to the master station. DNP sends this event to the application. The application should process this event by making a connection.

• The DNP_MESSAGE_COMPLETE event indicates that DNP has received confirmation of unsolicited messages from the master station. DNP sends this event to the application. The application should process this event by disconnecting. In many applications a short delay before disconnecting is useful as it allows the master station to send commands to the slave after the unsolicited reporting is complete.

Document (Version 2.51) 4/4/2011 474

IEC 61131-3 C Tools Structures and Types

• The DNP_MESSAGE_TIMEOUT event indicates that DNP has attempted to send an unsolicited message but did not receive confirmation after all attempts. This usually means there is a communication problem. DNP sends this event to the application. The application should process this event by disconnecting.

dnpConfiguration

The dnpConfiguration type describes the DNP parameters. typedef struct dnpConfiguration_type

{

UINT16 masterAddress;

UINT16 rtuAddress;

CHAR datalinkConfirm;

CHAR datalinkRetries;

UINT16 datalinkTimeout;

UINT16 operateTimeout;

UCHAR applicationConfirm;

UINT16 maximumResponse;

UCHAR applicationRetries;

UINT16 applicationTimeout;

INT16 timeSynchronization;

UINT16 BI_number;

UINT16 BI_startAddress;

CHAR BI_reportingMethod;

UINT16 BI_soebufferSize;

UINT16 BO_number;

UINT16 BO_startAddress;

UINT16 CI16_number;

UINT16 CI16_startAddress;

CHAR CI16_reportingMethod;

UINT16 CI16_bufferSize;

UINT16 CI32_number;

UINT16 CI32_startAddress;

CHAR CI32_reportingMethod;

UINT16 CI32_bufferSize;

CHAR CI32_wordOrder;

UINT16 AI16_number;

UINT16 AI16_startAddress;

CHAR AI16_reportingMethod;

UINT16 AI16_bufferSize;

UINT16 AI32_number;

UINT16 AI32_startAddress;

CHAR AI32_reportingMethod;

UINT16 AI32_bufferSize;

CHAR AI32_wordOrder;

UINT16 AISF_number;

UINT16 AISF_startAddress;

CHAR AISF_reportingMethod;

UINT16 AISF_bufferSize;

CHAR AISF_wordOrder;

UINT16 AO16_number;

UINT16 AO16_startAddress;

UINT16 AO32_number;

UINT16 AO32_startAddress;

Document (Version 2.51) 4/4/2011 475

IEC 61131-3 C Tools Structures and Types

CHAR AO32_wordOrder;

UINT16 AOSF_number;

UINT16 AOSF_startAddress;

CHAR AOSF_wordOrder;

UINT16 autoUnsolicitedClass1;

UINT16 holdTimeClass1;

UINT16 holdCountClass1;

UINT16 autoUnsolicitedClass2;

UINT16 holdTimeClass2;

UINT16 holdCountClass2;

UINT16 autoUnsolicitedClass3;

UINT16 holdTimeClass3;

UINT16 holdCountClass3;

} dnpConfiguration;

• masterAddress is the address of the master station. Unsolicited messages are sent to this station. Solicited messages must come from this station.

Valid values are 0 to 65534.

• rtuAddress is the address of the RTU. The master station must send messages to this address. Valid values are 0 to 65534.

• datalinkConfirm enables requesting data link layer confirmations. Valid values are TRUE and FALSE.

• datalinkRetries is the number of times the data link layer will retry a failed message. Valid values are 0 to 255.

• datalinkTimeout is the length of time the data link layer will wait for a response before trying again or aborting the transmission. The value is measured in milliseconds. Valid values are 100 to 60000 in multiples of 100 milliseconds.

• operateTimeout is the length of time an operate command is valid after receiving a select command. The value is measured in seconds. Valid values are 1 to 6500.

• applicationConfirm enables requesting application layer confirmations. Valid values are TRUE and FALSE.

• maximumResponse is the maximum length of an application layer response.

Valid values are 20 to 2048. The recommended value is 2048 unless the master cannot handle responses this large.

• applicationRetries is the number of times the application layer will retry a transmission. Valid values are 0 to 255.

• applicationTimeout is the length of time the application layer will wait for a response before trying again or aborting the transmission. The value is measured in milliseconds. Valid values are 100 to 60000 in multiples of 100 milliseconds. This value must be larger than the data link timeout.

• timeSynchronization defines how often the RTU will request a time synchronization from the master.

Document (Version 2.51) 4/4/2011 476

IEC 61131-3 C Tools Structures and Types

• Set this to NO_TIME_SYNC to disable time synchronization requests.

• Set this to STARTUP_TIME_SYNC to request time synchronization at start up only.

• Set this to 1 to 32767 to set the time synchronization period in seconds.

• BI_number is the number of binary input points. Valid values are 0 to 9999.

• BI_startAddress is the DNP address of the first Binary Input point.

• BI_reportingMethod determines how binary inputs are reported either

Change Of State or Log All Events.

• BI_bufferSize is the Binary Input Change Event Buffer Size.

• BO_number is the number of binary output points. Valid values are 0 to

9999.

• BO_startAddress is the DNP address of the first Binary Output point.

• CI16_number is the number of 16-bit counter input points. Valid values are 0 to 9999.

• CI16_startAddress is the DNP address of the first CI16 point.

• CI16_reportingMethod determines how CI16 inputs are reported either

Change Of State or Log All Events.

• CI16_bufferSize is the number of events in the 16-bit counter change buffer.

Valid values are 0 to 9999.

• CI32_number is the number of 32-bit counter input points. Valid values are 0 to 9999.

• CI32_startAddress is the DNP address of the first CI32 point.

• CI32_reportingMethod determines how CI32 inputs are reported either

Change Of State or Log All Events.

• CI32_bufferSize is the number of events in the 32-bit counter change buffer.

Valid values are 0 to 9999.

• CI32_wordOrder is the Word Order of CI32 points (0=LSW first, 1=MSW first).

• AI16_number is the number of 16-bit analog input points. Valid values are 0 to 9999.

• AI16_startAddress is the DNP address of the first AI16 point.

• AI16_reportingMethod determines how 16-bit analog changes are reported.

• Set this to FIRST_VALUE to report the value of the first change event measured.

• Set this to CURRENT_VALUE to report the value of the latest change event measured.

Document (Version 2.51) 4/4/2011 477

IEC 61131-3 C Tools Structures and Types

• AI16_bufferSize is the number of events in the 16-bit analog input change buffer. Valid values are 0 to 9999.

• AI32_number is the number of 32-bit analog input points. Valid values are 0 to 9999.

• AI32_startAddress is the DNP address of the first AI32 point.

• AI32_reportingMethod determines how 32-bit analog changes are reported.

• Set this to FIRST_VALUE to report the value of the first change event measured.

• Set this to CURRENT_VALUE to report the value of the latest change event measured.

• AI32_bufferSize is the number of events in the 32-bit analog input change buffer. Valid values are 0 to 9999.

• AI32_wordOrder is the Word Order of AI32 points (0=LSW first, 1=MSW first)

• AO16_number is the number of 16-bit analog output points. Valid values are

0 to 9999.

• AO16_startAddress is the DNP address of the first AO16 point.

• AO32_number is the number of 32-bit analog output points. Valid values are

0 to 9999.

• AO32_startAddress is the DNP address of the first AO32 point.

• AO32_wordOrder is the Word Order of AO32 points (0=LSW first, 1=MSW first)

• AOSF_number is the number of short float Analog Outputs.

• AOSF_startAddress is the DNP address of first AOSF point.

• AOSF_wordOrder is the Word Order of AOSF points (0=LSW first, 1=MSW first).

• autoUnsolicitedClass1 enables or disables automatic Unsolicited reporting of

Class 1 events.

• holdTimeClass1 is the maximum period to hold Class 1 events before reporting

• holdCountClass1 is the maximum number of Class 1 events to hold before reporting.

• autoUnsolicitedClass2 enables or disables automatic Unsolicited reporting of

Class 2 events.

• holdTimeClass2 is the maximum period to hold Class 2 events before reporting

• holdCountClass2 is the maximum number of Class 2 events to hold before reporting.

Document (Version 2.51) 4/4/2011 478

IEC 61131-3 C Tools Structures and Types

• autoUnsolicitedClass3 enables or disables automatic Unsolicited reporting of

Class 3 events.

• holdTimeClass3 is the maximum period to hold Class 3 events before reporting.

• HoldCountClass3 is the maximum number of Class 3 events to hold before reporting.

dnpConfigurationEx

The dnpConfigurationEx type includes extra parameters in the DNP

Configuration. typedef struct dnpConfigurationEx_type

{

UINT16 rtuAddress;

UCHAR datalinkConfirm;

UCHAR datalinkRetries;

UINT16 datalinkTimeout;

UINT16 operateTimeout;

UCHAR applicationConfirm;

UINT16 maximumResponse;

UCHAR applicationRetries;

UINT16 applicationTimeout;

INT16 timeSynchronization;

UINT16 BI_number;

UINT16 BI_startAddress;

UCHAR BI_reportingMethod;

UINT16 BI_soeBufferSize;

UINT16 BO_number;

UINT16 BO_startAddress;

UINT16 CI16_number;

UINT16 CI16_startAddress;

UCHAR CI16_reportingMethod;

UINT16 CI16_bufferSize;

UINT16 CI32_number;

UINT16 CI32_startAddress;

UCHAR CI32_reportingMethod;

UINT16 CI32_bufferSize;

UCHAR CI32_wordOrder;

UINT16 AI16_number;

UINT16 AI16_startAddress;

UCHAR AI16_reportingMethod;

UINT16 AI16_bufferSize;

UINT16 AI32_number;

UINT16 AI32_startAddress;

UCHAR AI32_reportingMethod;

UINT16 AI32_bufferSize;

UCHAR AI32_wordOrder;

UINT16 AISF_number;

UINT16 AISF_startAddress;

UCHAR AISF_reportingMethod;

UINT16 AISF_bufferSize;

UCHAR AISF_wordOrder;

UINT16 AO16_number;

Document (Version 2.51) 4/4/2011 479

IEC 61131-3 C Tools Structures and Types

UINT16 AO16_startAddress;

UINT16 AO32_number;

UINT16 AO32_startAddress;

UCHAR AO32_wordOrder;

UINT16 AOSF_number;

UINT16 AOSF_startAddress;

UCHAR AOSF_wordOrder;

UINT16 autoUnsolicitedClass1;

UINT16 holdTimeClass1;

UINT16 holdCountClass1;

UINT16 autoUnsolicitedClass2;

UINT16 holdTimeClass2;

UINT16 holdCountClass2;

UINT16 autoUnsolicitedClass3;

UINT16 holdTimeClass3;

UINT16 holdCountClass3;

UINT16 enableUnsolicitedOnStartup;

UINT16 sendUnsolicitedOnStartup;

UINT16 level2Compliance;

UINT16 masterAddressCount;

UINT16 masterAddress[8];

UINT16 maxEventsInResponse;

UINT16 dialAttempts;

UINT16 dialTimeout;

UINT16 pauseTime;

UINT16 onlineInactivity;

UINT16 dialType;

Char modemInitString[64];

} dnpConfigurationEx;

• rtuAddress is the address of the RTU. The master station must send messages to this address. Valid values are 0 to 65534.

• datalinkConfirm enables requesting data link layer confirmations. Valid values are TRUE and FALSE.

• datalinkRetries is the number of times the data link layer will retry a failed message. Valid values are 0 to 255.

• datalinkTimeout is the length of time the data link layer will wait for a response before trying again or aborting the transmission. The value is measured in milliseconds. Valid values are 100 to 60000 in multiples of 100 milliseconds.

• operateTimeout is the length of time an operate command is valid after receiving a select command. The value is measured in seconds. Valid values are 1 to 6500.

• applicationConfirm enables requesting application layer confirmations. Valid values are TRUE and FALSE.

• maximumResponse is the maximum length of an application layer response.

Valid values are 20 to 2048. The recommended value is 2048 unless the master cannot handle responses this large.

• applicationRetries is the number of times the application layer will retry a transmission. Valid values are 0 to 255.

Document (Version 2.51) 4/4/2011 480

IEC 61131-3 C Tools Structures and Types

• applicationTimeout is the length of time the application layer will wait for a response before trying again or aborting the transmission. The value is measured in milliseconds. Valid values are 100 to 60000 in multiples of 100 milliseconds. This value must be larger than the data link timeout.

• timeSynchronization defines how often the RTU will request a time synchronization from the master.

• Set this to NO_TIME_SYNC to disable time synchronization requests.

• Set this to STARTUP_TIME_SYNC to request time synchronization at start up only.

• Set this to 1 to 32767 to set the time synchronization period in seconds.

• BI_number is the number of binary input points. Valid values are 0 to 9999.

• BI_startAddress is the DNP address of the first Binary Input point.

• BI_reportingMethod determines how binary inputs are reported either

Change Of State or Log All Events.

• BI_soebufferSize is the Binary Input Change Event Buffer Size.

• BO_number is the number of binary output points. Valid values are 0 to

9999.

• BO_startAddress is the DNP address of the first Binary Output point.

• CI16_number is the number of 16-bit counter input points. Valid values are 0 to 9999.

• CI16_startAddress is the DNP address of the first CI16 point.

• CI16_reportingMethod determines how CI16 inputs are reported either

Change Of State or Log All Events.

• CI16_bufferSize is the number of events in the 16-bit counter change buffer.

Valid values are 0 to 9999.

• CI32_number is the number of 32-bit counter input points. Valid values are 0 to 9999.

• CI32_startAddress is the DNP address of the first CI32 point.

• CI32_reportingMethod determines how CI32 inputs are reported either

Change Of State or Log All Events.

• CI32_bufferSize is the number of events in the 32-bit counter change buffer.

Valid values are 0 to 9999.

• CI32_wordOrder is the Word Order of CI32 points (0=LSW first, 1=MSW first).

• AI16_number is the number of 16-bit analog input points. Valid values are 0 to 9999.

• AI16_startAddress is the DNP address of the first AI16 point.

Document (Version 2.51) 4/4/2011 481

IEC 61131-3 C Tools Structures and Types

• AI16_reportingMethod determines how 16-bit analog changes are reported.

• Set this to FIRST_VALUE to report the value of the first change event measured.

• Set this to CURRENT_VALUE to report the value of the latest change event measured.

• AI16_bufferSize is the number of events in the 16-bit analog input change buffer. Valid values are 0 to 9999.

• AI32_number is the number of 32-bit analog input points. Valid values are 0 to 9999.

• AI32_startAddress is the DNP address of the first AI32 point.

• AI32_reportingMethod determines how 32-bit analog changes are reported.

• Set this to FIRST_VALUE to report the value of the first change event measured.

• Set this to CURRENT_VALUE to report the value of the latest change event measured.

• AI32_bufferSize is the number of events in the 32-bit analog input change buffer. Valid values are 0 to 9999.

• AI32_wordOrder is the Word Order of AI32 points (0=LSW first, 1=MSW first)

• AISF_number is the number of short float Analog Inputs.

• AISF_startAddress is the DNP address of first AISF point.

• AISF_reportingMethod is the event reporting method, Change Of State or

Log All Events.

• AISF_bufferSize is the short float Analog Input Event Buffer Size.

• AISF_wordOrder is the word order of AISF points (0=LSW first, 1=MSW first)

*/

• AO16_number is the number of 16-bit analog output points. Valid values are

0 to 9999.

• AO16_startAddress is the DNP address of the first AO16 point.

• AO32_number is the number of 32-bit analog output points. Valid values are

0 to 9999.

• AO32_startAddress is the DNP address of the first AO32 point.

• AO32_wordOrder is the Word Order of AO32 points (0=LSW first, 1=MSW first)

• AOSF_number is the number of short float Analog Outputs.

• AOSF_startAddress is the DNP address of first AOSF point.

Document (Version 2.51) 4/4/2011 482

IEC 61131-3 C Tools Structures and Types

• AOSF_wordOrder is the Word Order of AOSF points (0=LSW first, 1=MSW first).

• autoUnsolicitedClass1 enables or disables automatic Unsolicited reporting of

Class 1 events.

• holdTimeClass1 is the maximum period to hold Class 1 events before reporting

• holdCountClass1 is the maximum number of Class 1 events to hold before reporting.

• autoUnsolicitedClass2 enables or disables automatic Unsolicited reporting of

Class 2 events.

• holdTimeClass2 is the maximum period to hold Class 2 events before reporting

• holdCountClass2 is the maximum number of Class 2 events to hold before reporting.

• autoUnsolicitedClass3 enables or disables automatic Unsolicited reporting of

Class 3 events.

• holdTimeClass3 is the maximum period to hold Class 3 events before reporting.

• HoldCountClass3 is the maximum number of Class 3 events to hold before reporting.

• EnableUnsolicitedOnStartup enables or disables unsolicited reporting at start-up.

• SendUnsolicitedOnStartup sends an unsolicited report at start-up.

• level2Compliance reports only level 2 compliant data types (excludes floats,

AO-32).

• MasterAddressCount is the number of master stations.

• masterAddress[8] is the number of master station addresses.

• MaxEventsInResponse is the maximum number of change events to include in read response.

• PSTNDialAttempts is the maximum number of dial attempts to establish a

PSTN connection.

• PSTNDialTimeout is the maximum time after initiating a PSTN dial sequence to wait for a carrier signal.

• PSTNPauseTime is the pause time between dial events.

• PSTNOnlineInactivity is the maximum time after message activity to leave a

PSTN connection open before hanging up.

• PSTNDialType is the dial type: tone or pulse dialling.

Document (Version 2.51) 4/4/2011 483

IEC 61131-3 C Tools Structures and Types

• modemInitString[64] is the initialization string to send to the modem.

dnpCounterInput

The dnpCounterInput type describes a DNP counter input point. This type is used for both 16-bit and 32-bit points. typedef struct dnpCounterInput_type

{

UINT16 modbusAddress;

UCHAR class;

UINT32 threshold;

} dnpCounterInput;

• modbusAddress is the address of the Modbus register number associated with the point.

• class is the reporting class for the object. It may be set to CLASS_1,

CLASS_2 or CLASS_3.

• threshold is the amount by which the counter input value must change before an event will be reported for the point.

dnpPointType

The enumerated type DNP_POINT_TYPE includes all allowed DNP data point types. typedef enum dnpPointType

{

BI_POINT=0,

AI16_POINT,

AI32_POINT,

AISF_POINT,

AILF_POINT,

CI16_POINT,

CI32_POINT,

BO_POINT,

AO16_POINT,

AO32_POINT,

AOSF_POINT,

AOLF_POINT

} DNP_POINT_TYPE;

/* binary input */

/* 16 bit analog input */

/* 32 bit analog input */

/* short float analog input */

/* long float analog input */

/* 16 bit counter output */

/* 32 bit counter output */

/* binary output */

/* 16 bit analog output */

/* 32 bit analog output */

/* short float analog output */

/* long float analog output */

DNP_RUNTIME_STATUS

The DNP_RUNTIME_STATUS type describes a structure for holding status information about DNP event log buffers.

/* DNP Runtime Status */ typedef struct dnp_runtime_status

{

*/

UINT16 eventCountBI; /* number of binary input events

Document (Version 2.51) 4/4/2011 484

envelope

IEC 61131-3 C Tools Structures and Types

*/

UINT16 eventCountCI16; /* number of 16-bit counter events

UINT16 eventCountCI32; /* number of 32-bit counter events

*/

UINT16 eventCountAI16; /* number of 16-bit analog input events */

UINT16 eventCountAI32; events */

/* number of 32-bit analog input

UINT16 eventCountAISF; /* number of short floating-point analog input events */

UINT16 eventCountClass1; /* number of class 1 events */

UINT16 eventCountClass2; /* number of class 2 events */

UINT16 eventCountClass3; /* number of class 3 events */

} DNP_RUNTIME_STATUS;

• eventCountBI is number of binary input events.

• eventCountCI16 is number of 16-bit counter events.

• eventCountCI32 is number of 32-bit counter events.

• eventCountAI16 is number of 16-bit analog input events.

• eventCountAI32 is number of 32-bit analog input events.

• eventCountAISF is number of short floating-point analog input events.

• eventCountClass1 is the class 1 event counter.

• eventCountClass2 is the class 2 event counter.

• eventCountClass3 is the class 3 event counter.

The envelope type is a structure containing a message envelope. Envelopes are used for inter-task communication. typedef struct env {

struct env *link;

unsigned source;

unsigned destination;

unsigned type;

unsigned long data;

unsigned owner;

}

envelope;

• link is a pointer to the next envelope in a queue. This field is used by the

RTOS. It is of no interest to an application program.

• source is the task ID of the task sending the message. This field is specified automatically by the send_message function. The receiving task may read this field to determine the source of the message.

Document (Version 2.51) 4/4/2011 485

IEC 61131-3 C Tools Structures and Types

• destination is the task ID of the task to receive the message. It must be specified before calling the send_message function.

• type specifies the type of data in the data field. It may be MSG_DATA,

MSG_POINTER, or any other value defined by the application program. This field is not required.

• data is the message data. The field may contain a datum or pointer. The application program determines the use of this field.

• owner is the task that owns the envelope. This field is set by the RTOS and must not be changed by an application program.

HART_COMMAND

The HART_COMMAND type is a structure containing a command to be sent to a

HART slave device. The command field contains the HART command number.

The length field contains the length of the data string to be transmitted (the byte count in HART documentation). The data field contains the data to be sent to the slave. typedef struct hartCommand_t

{ unsigned command; unsigned length; char data[DATA_SIZE];

}

HART_COMMAND;

• command is the HART command number.

• length is the number of characters in the data string.

• data[DATA_SIZE] is the data field for the command.

HART_DEVICE

The HART_DEVICE type is a structure containing information about the HART device. The information is read from the device using command 0 or command

11. The fields are identical to those read by the commands. Refer to the command documentation for more information. typedef struct hartDevice_t

{ unsigned char manufacturerID; unsigned char manufacturerDeviceType; unsigned char preamblesRequested; unsigned char commandRevision; unsigned char transmitterRevision; unsigned char softwareRevision; unsigned char hardwareRevision; unsigned char flags; unsigned long deviceID;

}

HART_DEVICE;

Document (Version 2.51) 4/4/2011 486

IEC 61131-3 C Tools Structures and Types

HART_RESPONSE

The HART_RESPONSE type is a structure containing a response from a HART slave device. The command field contains the HART command number. The length field contains the length of the data string to be transmitted (the byte count in HART documentation). The data field contains the data to be sent to the slave. typedef struct hartResponse_t

{ unsigned responseCode, unsigned length, char data[DATA_SIZE];

}

HART_RESPONSE;

• response is the response code from the device.

• length is the length of response data.

• data[DATA_SIZE] is the data field for the response.

HART_RESULT

The HART_RESULT enumeration type defines a list of results of sending a command. typedef enum hartResult_t

{

HR_NoModuleResponse=0,

HR_CommandPending,

HR_CommandSent,

HR_Response,

HR_NoResponse,

HR_WaitTransmit

}

HART_RESULT;

• HR_NoModuleResponse returns no response from HART modem module.

• HR_CommandPending returns command ready to be sent, but not sent.

• HR_CommandSent returns command sent.

• HR_Response returns response received.

• HR_NoResponse returns no response after all attempts.

• HR_WaitTransmit returns modem is not ready to transmit.

HART_SETTINGS

The HART_SETTINGS type is a structure containing the configuration for the

HART modem module. The useAutoPreamble field indicates if the number of preambles is set by the value in the HART_SETTINGS structure (FALSE) or the value in the HART_DEVICE structure (TRUE). The deviceType field determines

Document (Version 2.51) 4/4/2011 487

IEC 61131-3 C Tools Structures and Types if the 5904 modem is a HART primary master or secondary master device

(primary master is the recommended setting). typedef struct hartSettings_t

{ unsigned attempts; unsigned preambles;

BOOLEAN useAutoPreamble; unsigned deviceType;

}

HART_SETTINGS;

• attempts is the number of command attempts (1 to 4).

• preambles is the number of preambles to send (2 to 15).

• useAutoPreamble is a flag to use the requested preambles.

• deviceType is the type of HART master (1 = primary; 0 = secondary).

HART_VARIABLE

The HART_VARIABLE type is a structure containing a variable read from a

HART device. The structure contains three fields that are used by various commands. Note that not all fields will be used by all commands. Refer to the command specific documentation. typedef struct hartVariable_t

{ float value; unsigned units; unsigned variableCode;

}

HART_VARIABLE;

• value is the value of the variable.

• units are the units of measurement.

• variableCode is the transmitter specific variable ID.

ledControl_tag

The ledControl_tag structure defines LED power control parameters. struct ledControl_tag { unsigned state; unsigned time;

};

• state is the default LED state. It is either the LED_ON or LED_OFF macro.

• time is the period, in minutes, after which the LED power returns to its default state.

Document (Version 2.51) 4/4/2011 488

ModemInit

ModemSetup

IEC 61131-3 C Tools Structures and Types

The ModemInit structure specifies modem initialization parameters for the modemInit function. struct ModemInit

{

FILE * port; char modemCommand[MODEM_CMD_MAX_LEN + 2];

};

• port is the serial port where the modem is connected.

• modemCommand is the initialization string for the modem. The characters

AT will be prefixed to the command, and a carriage returned suffixed to the command when it is sent to the modem. Refer to the section Modem

Commands for suggested command strings for your modem.

The ModemSetup structure specifies modem initialization and dialing control parameters for the modemDial function. struct ModemSetup

{

FILE * port; unsigned short unsigned short dialAttempts; detectTime; unsigned short unsigned short pauseTime; dialmethod; char modemCommand[MODEM_CMD_MAX_LEN + 2]; char phoneNumber[PHONE_NUM_MAX_LEN + 2];

};

• port is the serial port where the modem is connected.

• dialAttempts is the number of times the controller will attempt to dial the remote controller before giving up and reporting an error.

• detectTime is the length of time in seconds that the controller will wait for carrier to be detected. It is measured from the start of the dialing attempt.

• pauseTime is the length of time in seconds that the controller will wait between dialing attempts.

• dialmethod selects pulse or tone dialing. Set dialmethod to 0 for tone dialing or 1 for pulse dialing.

• modemCommand is the initialization string for the modem. The characters

AT will be prepended to the command, and a carriage returned appended to the command when it is sent to the modem. Refer to the section Modem

Commands for suggested command strings for your modem.

Document (Version 2.51) 4/4/2011 489

IEC 61131-3 C Tools Structures and Types

• phoneNumber is the phone number of the remote controller. The characters

ATD and the dialing method will be prepended to the command, and a carriage returned appended to the command when it is sent to the modem.

PROTOCOL_SETTINGS

The Extended Protocol Settings structure defines settings for a communication protocol. This structure differs from the standard settings in that it allows additional settings to be specified. typedef struct protocolSettings_t

{ unsigned char type; unsigned station; unsigned char priority; unsigned SFMessaging;

ADDRESS_MODE mode;

}

PROTOCOL_SETTINGS;

• type is the protocol type. It may be one of NO_PROTOCOL, MODBUS_RTU, or MODBUS_ASCII macros.

• station is the station address of the controller. Note that each serial port may have a different address. The valid values are determined by the communication protocol. This field is not used if the protocol type is

NO_PROTOCOL.

• priority is the task priority of the protocol task. This field is not used if the protocol type is NO_PROTOCOL.

• SFMessaging is the enable Store and Forward messaging control flag.

• ADDRESS_MODE is the addressing mode, standard or extended.

PROTOCOL_SETTINGS_EX Type

This structure contains serial port protocol settings including Enron Modbus support. typedef struct protocolSettingsEx_t

{

UCHAR type;

UINT16 station;

UCHAR priority;

UINT16 SFMessaging;

ADDRESS_MODE mode;

BOOLEAN enronEnabled;

UINT16 enronStation;

}

PROTOCOL_SETTINGS_EX;

• type is the protocol type. It may be one of NO_PROTOCOL, MODBUS_RTU, or MODBUS_ASCII.

Document (Version 2.51) 4/4/2011 490

IEC 61131-3 C Tools Structures and Types

• station is the station address of the controller. Note that each serial port may have a different address. The valid values are determined by the communication protocol. This field is not used if the protocol type is

NO_PROTOCOL.

• priority is the task priority of the protocol task. This field is not used if the protocol type is NO_PROTOCOL.

• SFMessaging is the enable Store and Forward messaging control flag.

• ADDRESS_MODE is the addressing mode, AM_standard or AM_extended.

• enronEnabled determines if the Enron Modbus station is enabled. It may be

TRUE or FALSE.

• enronStation is the station address for the Enron Modbus protocol. It is used if enronEnabled is set to TRUE. Valid values are 1 to 255 for standard addressing, and 1 to 65534 for extended addressing.

prot_settings

The Protocol Settings structure defines settings for a communication protocol.

This structure differs from the extended settings in that it allows fewer settings to be specified. struct prot_settings {

unsigned char type;

unsigned char station;

unsigned char priority;

unsigned SFMessaging;

};

• type is the protocol type. It may be one of NO_PROTOCOL, MODBUS_RTU,

MODBUS_ASCII, AB_FULL_BCC, AB_HALF_BCC, AB_FULL_CRC,

AB_HALF_CRC or DNP macros.

• station is the station address of the controller. Note that each serial port may have a different address. The valid values are determined by the communication protocol. This field is not used if the protocol type is

NO_PROTOCOL.

• priority is the task priority of the protocol task. This field is not used if the protocol type is NO_PROTOCOL.

• SFMessaging is the enable Store and Forward messaging control flag.

prot_status

The prot_status structure contains protocol status information. struct prot_status {

unsigned command_errors;

unsigned format_errors;

unsigned checksum_errors;

unsigned cmd_received;

unsigned cmd_sent;

Document (Version 2.51) 4/4/2011 491

pconfig

IEC 61131-3 C Tools Structures and Types

unsigned rsp_received;

unsigned rsp_sent;

unsigned command;

int task_id;

unsigned stored_messages;

unsigned forwarded_messages;

};

• command_errors is the number of messages received with invalid command codes.

• format_errors is the number of messages received with bad message data.

• checksum_errors is the number of messages received with bad checksums.

• cmd_received is the number of commands received.

• cmd_sent is the number of commands sent by the master_message function.

• rsp_received is the number of responses received by the master_message function.

• rsp_sent is the number of responses sent.

• command is the status of the last protocol command sent.

• task_id is the ID of the protocol task. This field is used by the set_protocol function to control protocol execution.

• stored_messages is the number of messages stored for forwarding.

• forwarded_messages is the number of messages forwarded.

The pconfig structure contains serial port settings. struct pconfig {

unsigned baud;

unsigned duplex;

unsigned parity;

unsigned data_bits;

unsigned stop_bits;

unsigned flow_rx;

unsigned flow_tx;

unsigned type;

unsigned timeout;

};

• baud is the communication speed. It is one of the BAUD_xxx macros.

• duplex is either the FULL or HALF macro.

• parity is one of NONE, EVEN or ODD macros.

• data_bits is the word length. It is either the DATA7 or DATA8 macro.

Document (Version 2.51) 4/4/2011 492

IEC 61131-3 C Tools Structures and Types

• stop_bits in the number of stop bits transmitted. It is either the STOP1 or

STOP2 macro.

• flow_rx specifies flow control on the receiver. It is either the DISABLE or

ENABLE macro.

• For com1 and com2 setting this parameter selects XON/XOFF flow control. It may be enabled or disabled.

If any protocol, other than Modbus ASCII, is used on the port you must set flow_rx to DISABLE. If Modbus ASCII or no protocol is used, you can set flow_rx to ENABLE or DISABLE. In most cases DISABLE is recommended.

• For com3 and com4 setting this parameter selects Receiver Disable after message reception. This is used with the Modbus RTU protocol only. If the

Modbus RTU protocol is used, set flow_rx to ENABLE. Otherwise set flow_rx to DISABLE.

• flow_tx specifies flow control on the transmitter. It is either the DISABLE or

ENABLE macro.

• For com1 and com2 setting this parameter selects XON/XOFF flow control. It may be enabled or disabled.

If any protocol, other than Modbus ASCII, is used on the port you must set flow_tx to DISABLE. If Modbus ASCII or no protocol is used, you can set flow_tx to ENABLE or DISABLE. In most cases DISABLE is recommended.

• For com3 and com4 setting this parameter indicates if the port should ignore the CTS signal. Setting the parameter to ENABLE causes the port to ignore the CTS signal.

• type specifies the serial port type. It is one of NOTYPE, RS232,

RS232_MODEM, RS485, or RS232_COLLISION_AVOID macros.

• timeout specifies the time the driver will wait when the transmit buffer fills, before it clears the buffer.

PORT_CHARACTERISTICS

The PORT_CHARACTERISTICS type is a structure that contains serial port characteristics. typedef struct portCharacteristics_tag { unsigned dataflow; unsigned buffering; unsigned protocol; unsigned long options;

} PORT_CHARACTERISTICS;

• dataflow is a bit mapped field describing the data flow options supported on the serial port. ANDing can isolate the options with the

PC_FLOW_RX_RECEIVE_STOP, PC_FLOW_RX_XON_XOFF,

PC_FLOW_TX_IGNORE_CTS or PC_FLOW_TX_XON_XOFF macros.

Document (Version 2.51) 4/4/2011 493

IEC 61131-3 C Tools Structures and Types

• buffering describes the buffering options supported. No buffering options are currently supported.

• protocol describes the protocol options supported. The macro,

PC_PROTOCOL_RTU_FRAMING is the only option supported.

• options describes additional options supported. No additional options are currently supported.

pstatus

The pstatus structure contains serial port status information. struct pstatus {

unsigned framing;

unsigned parity;

unsigned c_overrun;

unsigned b_overrun;

unsigned rx_buffer_size;

unsigned rx_buffer_used;

unsigned tx_buffer_size;

unsigned tx_buffer_used;

unsigned io_lines;

};

• framing is the number of received characters with framing errors.

• parity is the number of received characters with parity errors.

• c_overrun is the number of received character overrun errors.

• b_overrun is the number of receive buffer overrun errors.

• rx_buffer_size is the size of the receive buffer in characters.

• rx_buffer_used is the number of characters in the receive buffer.

• tx_buffer_size is the size of the transmit buffer in characters.

• tx_buffer_used is the number of characters in the transmit buffer.

• io_lines is a bit mapped field indicating the status of the I/O lines on the serial port. The values for these lines differ between serial ports (see tables below).

ANDing can isolate the signals with the SIGNAL_CTS, SIGNAL_DCD,

SIGNAL_OH, SIGNAL_RING or SIGNAL_VOICE macros.

READSTATUS

The READSTATUS enumerated type indicates the status of an I

2

C bus message read and may have one of the following values. enum ReadStatus {

RS_success,

RS_selectFailed

}; typedef enum ReadStatus READSTATUS;

Document (Version 2.51) 4/4/2011 494

IEC 61131-3 C Tools Structures and Types

• RS_success returns read was successful.

• RS_selectFailed returns slave device could not be selected

routingTable

The routingTable type describes an entry in the DNP Routing Table.

Note that the DNP Routing Table is a list of routes, which are maintained in ascending order of DNP addresses.

typedef struct RoutingTable_type

{

UINT16 address;

UINT16 comPort;

UINT16 retries;

UINT16 timeout;

*/

} routingTable;

• address is the DNP address.

• comPort is the serial port interface.

/* station address */

/* com port interface */

/* number of retries */

/* timeout in milliseconds

• retries is the number of data link retires for this table entry.

• timeout is the timeout in milliseconds.

SFTranslation

The SFTranslation structure contains Store and Forward Messaging translation information. This is used to define an address and port translation. struct SFTranslation { unsigned portA; unsigned stationA; unsigned portB; unsigned stationB;

};

• portA is the index of the first serial port. The index is obtained with the portIndex function.

• stationA is the station address of the first station.

• portB is the index of the second serial port. The index is obtained with the portIndex function.

• stationB is the station address of the second station.

SFTranslationStatus

The SFTranslationStatus structure contains information about a Store and

Forward Translation table entry. It is used to report information about specific table entries.

Document (Version 2.51) 4/4/2011 495

IEC 61131-3 C Tools Structures and Types struct SFTranslationStatus { unsigned index; unsigned code;

};

• index is the location in the store and forward table to which the status code applies.

• code is the status code. It is one of SF_VALID,

SF_INDEX_OUT_OF_RANGE, SF_NO_TRANSLATION,

SF_PORT_OUT_OF_RANGE, SF_STATION_OUT_OF_RANGE, or

SF_ALREADY_DEFINED macros.

TASKINFO

The TASKINFO type is a structure containing information about a task.

/* Task Information Structure */ typedef struct taskInformation_tag { unsigned taskID; unsigned priority; unsigned status; unsigned requirement; unsigned error; unsigned type;

} TASKINFO;

• taskID is the identifier of the task.

• priority is the execution priority of the task.

• status is the current execution status the task. This may be one of

TS_READY, TS_EXECUTING, TS_WAIT_ENVELOPE, TS_WAIT_EVENT,

TS_WAIT_MESSAGE, or TS_WAIT_RESOURCE macros.

• requirement is used if the task is waiting for an event or resource. If the status field is TS_WAIT_EVENT, then requirement indicates on which event it is waiting. If the status field is TS_WAIT_RESOURCE then requirement indicates on which resource it is waiting.

• error is the task error code. This is the same value as returned by the check_error function.

• type is the task type. It will be either SYSTEM or APPLICATION.

taskInfo_tag

The taskInfo_tag structure contains start up task information. struct taskInfo_tag {

void *address;

unsigned stack;

unsigned identity;

};

Document (Version 2.51) 4/4/2011 496

IEC 61131-3 C Tools Structures and Types

• address is the pointer to the start up routine.

• stack is the required stack size for the routine

• identity is the type of routine found (STARTUP_APPLICATION or

STARTUP_SYSTEM)

timer_info

The timer_info structure contains information about a timer. struct timer_info {

unsigned time;

unsigned interval;

unsigned interval_remaining;

unsigned flags;

unsigned duty_on;

unsigned duty_period;

unsigned channel;

unsigned bit;

};

• time is the time remaining in the timer in ticks.

• interval is the length of a timer tick in 10ths of a second.

• interval_remaining is the time remaining in the interval count down register in

10ths of a second.

• flags is the timer type and status bits (NORMAL, PULSE TRAIN,

DUTY_CYCLE, TIMEOUT, and TIMED_OUT). More than one condition may be true at any time.

• duty_on is the length of the on high portion of the square wave output. This is used only by the pulse function.

• duty_period is the period of the square wave output This is used only by the

pulse function.

• channel and bit specify the digital output point. This is used by pulse,

pulse_train and timeout functions.

VERSION

The Firmware Version Information Structure holds information about the firmware. typedef struct versionInfo_tag { unsigned version; unsigned controller; char date[VI_DATE_SIZE + 1]; char copyright[VI_STRING_SIZE + 1];

} VERSION;

• version is the firmware version number.

Document (Version 2.51) 4/4/2011 497

IEC 61131-3 C Tools Structures and Types

• controller is target controller for the firmware.

• date is a string containing the date the firmware was created.

• copyright is a string containing Control Microsystems copyright information.

WRITESTATUS

The WRITESTATUS enumerated type indicates the status of an I

2

C bus message read and may have one of the following values. enum WriteStatus {

WS_success,

WS_selectFailed,

WS_noAcknowledge

}; typedef enum WriteStatus WRITESTATUS;

• WS_success returns write was successful

• WS_selectFailed returns slave could not be selected

• WS_noAcknowledge returns slave failed to acknowledge data

Document (Version 2.51) 4/4/2011 498

C Compiler Known Problems

C Compiler Known Problems

The C compiler supplied with the IEC 61131-3 C Tools is a product of Microtec.

There is two known problems with the compiler.

Use of Initialized Static Local Variables

The compiler incorrectly allocates storage for initialized static local variables. The storage is allocated incorrectly in memory reserved for constant string data. The storage should be allocated in memory for initialized variables.

Problems Caused

A program loaded in ROM cannot modify a variable declared in this fashion.

A program loaded in RAM can modify the variable. However, the variable is in a section of program memory that the operating system expects to remain constant. Modifying the variable causes the operating system to think the program has been modified. The program continues to run correctly, but will not run again if it is stopped by the C Program Loader or if the controller is reset. The operating system detects that the program memory is corrupt and does not execute the program.

Example

The compiler generates incorrect code for the following example. Storage for the variable a is allocated in the strings section. It should be in the initvars section.

If the program is loaded in ROM, it cannot modify the variable a.

If the program is loaded in RAM, it can be run once after being written to a controller memory. All subsequent attempts to run the program will fail. void main(void)

{ static int a = 1;

} a++;

/* other code here */

Working Around the Problem

There are two ways to work around the problem.

1. Use global variable instead of a local variable. For example: static int a = 1; void main(void)

{ a++;

Document (Version 2.51) 4/4/2011 499

C Compiler Known Problems

}

/* other code here */

2. If the local variable is to be initialized to zero, then a non-initialized static local variable can be used. For example: void main(void)

{ static int a; a++;

}

/* other code here */

In this example the declaration: static int a; is the same as the following: static int a = 0;

The operating systems sets non-initialized variables (stored in the zerovars section) to zero before running the program.

Correction to the Problem

This problem exists with the C Compiler supplied by Microtec. It will not be corrected. Users must work around the problem as described above.

Use of pow Function

The compiler sometimes incorrectly evaluates expressions involving the pow function with other arithmetic.

Also, a task calling the pow function requires at least 5 stack blocks. The need for more stack space by the pow function is not a compiler problem, it is simply a requirement of pow.

Problems Caused

Some arithmetic expressions involving the pow function may result in incorrect results. When testing expressions that call pow, if the result is found to be incorrect, it will be consistently incorrect for all values used by variables in the expression.

The pow function requires at least 5 stack blocks. If 4 or less stack blocks are used by the task calling pow, the controller will overflow its stack space. When the stack space overflows the behavior is unpredictable, and will most likely cause the controller to reset.

Example

The compiler generates incorrect code for the following example. The result of this expression is incorrect for all values used for its variables.

Document (Version 2.51) 4/4/2011 500

void main(void)

{ double a, b, c, d, e; a = pow(b, c) * (d + e);

/* other code here */

}

C Compiler Known Problems

Working Around the Problem

There are two ways to work around the problem.

1. To work around the problem compute the pow result on a separate line and use the result in the arithmetic expression afterwards. For example:

} void main(void)

{ double a, b, c, d, e, result; result = pow(b, c); a = result * (d + e);

/* other code here */

When a task calls the pow function it requires at least 5 stack blocks. The default stack space allocated to the main task is only 4 blocks. To modify the number of stack blocks allocated to the main task refer to the section Start-Up Function

Structure for details on editing appstart.c. See the function create_task to specify the stack used by other tasks.

2. The powf function may be used instead of pow where double precision is not required.

Correction to the Problem

This problem exists with the C Compiler supplied by Microtec. It will not be corrected. Users must work around the problem as described above.

Document (Version 2.51) 4/4/2011 501

Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement

Table of contents