Open Interface API Reference - GE

2y ago
79 Views
9 Downloads
4.02 MB
515 Pages
Last View : 21d ago
Last Download : 2m ago
Upload by : Lilly Andre
Transcription

CIMPLICITY 11Open Interface API ReferenceGE DigitalProficy Historian and Operations Hub: Data Analysis in Context1

Proprietary NoticeThe information contained in this publication is believed to be accurate and reliable. However, General Electric Company assumes noresponsibilities for any errors, omissions or inaccuracies. Information contained in the publication is subject to change without notice.No part of this publication may be reproduced in any form, or stored in a database or retrieval system, or transmitted or distributed in anyform by any means, electronic, mechanical photocopying, recording or otherwise, without the prior written permission of General ElectricCompany. Information contained herein is subject to change without notice. 2020, General Electric Company. All rights reserved.Trademark NoticesGE, the GE Monogram, and Predix are either registered trademarks or trademarks of General Electric Company.Microsoft is a registered trademark of Microsoft Corporation, in the United States and/or other countries.All other trademarks are the property of their respective owners.We want to hear from you. If you have any comments, questions, or suggestions about our documentation, send them to the following emailaddress:doc@ge.com

Open Interface API Reference

Chapter 1. About CIMPLICITY Open Interface.23Chapter 2. Login/Logout API.25About the Login/Logout API.25Code a Login Box.25Code a Login Box.25Example Login Box Installation. 25Tips about Coding a Login Box. 26Install a Customized Login Box. 26Install a Customized Login Box. 26Step 1. Register the Replacement Login Control. 27Step 2. Select the Type of Login Box you want. 27Step 3. Set a CIMPLICITY Global Parameter on the Server.28Step 4. Set a CIMPLICITY Global Parameter on both the Server and Viewer.29Step 5. Stop and Restart CIMPLICITY.30Login/Logout API Support. 30Login/Logout API Support. 30Simple Login/Logout Example using Basic Script. 32Chapter 3. Alarm Management API. 33About Alarm Management API.33Integration of Alarm Management and Base System.33Alarm Management API Contents.33Notes on Internationalization for the Alarm Management API. 34Alarm Management API Overview. 36Alarm Management API Overview. 36

Contents iiiOperation Overview. 36Alarm Management API Features. 38Alarm Management API Getting Started. 38Alarm Management API Getting Started. 38Alarm Management API Sample Program. 39Example: Send When Buffer Filled. 40Example: Send an Alarm With Multiple Parameters. 41Example: External Alarm Timestamps.41Field Definitions: Alarm Management API Application.42Field Definitions: Alarm Management API Application.42Include Files. 43General Subroutines for the Alarm Management API. 43General Subroutines for Field Definitions: Alarm Management API. 43coprcnam.44cor logstatus. 45cor long long from stamp utc.45cor stamp.46cor stamp calc utcHR.46cor stamp calcHR.47cor stamp cmp.48cor stamp convert to ascii. 49cor stamp convert to ascii utc. 49cor stamp get components utcHR. 50cor stamp get componentsHR.51

Contents ivcor stamp get diff. 51cor stamp get diffHR. 52cor stamp getfracHR. 52cor stamp is set.53cor stamp is valid. 53cor stamp reset. 54cor stamp set fracHR. 54ipc deactivate. 55ipc register. 56Application Subroutines for Alarm Management API. 57Application Subroutines for Field Definitions: Alarm Management API. 57amaru init. 57amaru add gen.58amaru add gen stamp. 60amaru add update.62amaru add update ca. 64amaru add update stamp. 65amaru add update stamp ca.67amaru send msg. 69amaru alloc buffer.70amaru num messages. 71amaru get resp.71amaru free buffer. 72

Contents vamaru terminate. 72Alarm Management Configuration Files. 73Alarm Management Configuration Files. 73Alarm Definition File (alarm def).74Alarm Class File (alarm class).78Alarm Type File (alarm type). 80Alarm Field File (alarm field).81Alarm Manager File (alarm mgr).85Alarm Routing File (alarm routing).92Alarm Interested Processes File (alarm intproc).93Alarm Management Definitions Header Files.95Alarm Management Definitions Header Files. 95am defs.h.95amaru proto.h.115Error Codes Returned by AMRP.125Error Codes Returned by AMARU. 126Chapter 4. Alarm Interested Process API.127About the Alarm Interested Process API. 127Contents of the Alarm Interested Process API.127Notes on Internationalization for the Alarm Interested Process API. 128AMIP API Class Reference. 129

Contents viAMIP API Class Reference. 129Classes. 130Command Handlers.132Use the Alarm Interested Process (AMIP) API. 133Use the Alarm Interested Process (AMIP) API.133About the Sample Program.133Step 1. Create the Sample Program Executable. 134Step 2. Run the Sample Program. 135Step 3. Write your AMIP Application.138Step 4. Integrate your AMIP Application with a CIMPLICITY Project.139Chapter 5. External Alarm State Management API.143About the External Alarm State Management API. 143Notes on Internationalization for the External Alarm State Management API. 143External Alarm State Management Getting Started. 145External Alarm State Management Getting Started. 145External Alarm State Management API Contents. 146External Alarm State Management API Sample Program. 1461. Create an XASMgr API Application.1492. Write an XASMgr Application. 1633. Compile and Link the XASMgr Application. 164

Contents vii4. Test the XASMgr Application.1655. Integrate the XASMgr Application with a CIMPLICITY Project. 165Chapter 6. Alarm Viewer API.169About the Alarm Viewer API.169Alarm Viewer and CIMPLICITY Functionality. 169Alarm Viewer Management API Overview. 169Alarm Viewer Management API Overview. 169Alarm Viewer API Operation Overview. 170Alarm Viewer API Features. 170Notes on Internationalization for the Alarm Management API.171Alarm Viewer API Getting Started. 173Alarm Viewer API Getting Started. 173How the Alarm Viewer API Works. 173Application Subroutine Interface Contents.174Build an Alarm Manager Connection.175Alarm Viewer API Sample Program. 180AMV API Class Reference.183AMV API Class Reference.183CAmvAlarm. 184CAmvClassFilter. 195CAmvClassFilterList. 201

Contents viiiCAmvConn. 203CAmvFieldFilter.224CAmvFieldFilterList. 226CAmvResourceFilter. 230CAmvResourceFilterList.232CAmvSetupList. 234CAmvStateFilter. 240CAmvStateFilterList.244CAmvTimeFilter.247Data Types Used by Alarm Viewer API.250Chapter 7. Device Communications Toolkit. 253About the Device Communications Toolkit. 253Communications Enabler Overview. 253Device Communications Subroutines in the Enabler Sample. 254Notes on Internationalization for the Device Communications Toolkit.257Device Communications Enabler Design. 258Device Communications Enabler Design. 258Decisions to be Made Prior to Implementing an Enabler. 259User Customizable Functions. 263Implementation Checklist. 271Implementation Checklist.271

Contents ixuser init() and user term().272user protocol info(). 272user device info(). 272user open port().273user cpu model(). 273user device set max device domain count().273user valid point().273user read data(). 274user remove point().274user write data(). 274user write point quality() or user write point quality2().274user process unsolicited data(), user accept unsolicited data(), anduser process unsolicited data stamp(). 275user on demand response(). 275Create the Executable Image. 275Create the Executable Image. 275Build a Communication Enabler.276Add a new Driver. 276Add a new Driver. 2761. Identify the Protocol and Model Information.2772. Add new Entries to the Registry. 2783. Define the Protocol. 279

Contents x4. Define the Model. 2865. Merge User Files into CIMPLICITY Software.2886. Merge the Domain Configuration File into a Project.288Device Communications API Sample Program. 290Device Communications API Demonstration Application.290Build the Device Communications API Sample Program.290Programming Notes.292Programming Notes.292Handle Event Flags. 293Device Communications Toolkit Subroutines. 293Device Communications Toolkit Subroutines. 293user accept unsolicited data. 294user cpu model.295user cvt data from device.296user cvt data to device.298user device info.300user device okay. 302user device set max device domain count().303user heartbeat device.304user init. 305user on demand response. 306

Contents xiuser open port. 307user proc event 1.308user proc event 2.309user proc event 3.309user proc event 4.310user proc event 5.311user proc event 6.311user proc event 7.312user proc event 8.312user proc event 9.313user proc event 10.314user process unsolicited data. 314user process unsolicited data stamp.317user protocol info.320user read data. 320user read diag data. 322user remove point. 323user term. 324user valid diag point.325

Contents xiiuser valid point. 326user write data.327user write point quality. 329Device Communications Toolkit Other Subroutines.331Device Communications Toolkit Other Subroutines.331cor sleep. 331dcrp align read. 332dcrp call on time. 332dcrp clear ef. 334dcrp get any ef. 335dcrp get ef. 336dcrp get port parameters. 336dcrp get serial settings. 337dcrp log status. 338dcrp notify unsolicited data. 340dcrp rcv unsolicited data.

GE Digital Proficy Historian and Operations Hub: Data Analysis in Context 1 CI

Related Documents:

api 20 e rapid 20e api 20 ne api campy api nh api staph api 20 strep api coryne api listeriaapi 20 c aux api 20 a rapid id 32 a api 50 ch api 50 chb/e 50 chl reagents to be ordered. strips ref microorganisms suspension inoculum transfer medium i

Latest API exams,latest API-571 dumps,API-571 pdf,API-571 vce,API-571 dumps,API-571 exam questions,API-571 new questions,API-571 actual tests,API-571 practice tests,API-571 real exam questions Created Date

3 API Industry Guide on API Design Apiary - Apiary jump-started the modern API design movement by making API definitions more than just about API documentation, allowing API designers to define APIs in the machine-readable API definition format API blueprint, then mock, share, and publish

filter True for user-level API (default is False – admin API) persistent_auth True for using API REST sessions (default is False) . UI Plugin API (Demo) Scheduling API VDSM hooks. 51 UI Plugins Command Line Interface . 52 Web Admin user interface Extend oVirt Web Admin user interface. 53 Web Admin user interface. 54 Web Admin user interface . 55 Web Admin user interface. 56 Web Admin user .

May 01, 2014 · API RP 580 API RP 580—Risk-Based Inspection API RP 581 API RP 581—Risk-Based Inspection Technology API RP 941 API RP 941—Steels for Hydrogen Service at Elevated Temperatures and Pressures in Petroleum Refineries and Petrochemical Plants API RP1 API Recommended Practices. API

API RP 4G Section 3 API RP 54 Section 9.3.17 API RP 54 Section 9.3.18 API RP 54 Section 9.7 API RP 54 Section 9.2.1 API RP 54 Section 9.3.8 API RP 54 Section 9.3 API RP 54 Section 5.5.1 API RP

Division 1 & 2, ANSI B16.5, API RP 14E, API RP 14C and API RP 14J, API RP 520 Part 1 & 2, API 521, API 526, API 2000, API 1104 and NACE MR-01-75 Select the appropriate ANSI / API pressure/temperature ratings for pipe flanges, valves, and fittings Analyze piping systems so as to determine piping “spec breaks”

Inspection & Testing: API 598 Flange Dimensions: ANSI/ASME 16.5 (1/2” - 10”) Face-to-Face: ANSI/ASME B16.10 Fire Safe: API 607/BS 6755 3-Piece Trunnion Ball Valves - API 6A Basic Design: API 6A Inspection and Testing: API 6A Flange Dimensions: API 6A Face-to-Face: API 6A Fire Safe: API 607/BS 6755