OPC服务器用户手册范本模板Word格式.docx

1、 在高层次上说,OPC服务器包含几个对象：服务器、标签组和标签项。OPC服务器对象包含标签组,标签组包含标签项.层次关系如下：图23 对象层次关系 OPC的标签组为客户端提供了组织数据的一种方法.例如，用户可以根据特定的显示和报告的需要来组织标签组中的条目（标签项）,并可以进行数据的读写。OPC客户端还可以配置数据的更新速率。在一个标签组中，用户可以定义一个或多个OPC标签项，如图2-3图 23 标签组/标签项的关系图 OPC中的标签项表示了OPC服务器中相联系的数据源。从用户接口的角度,客户端不能直接存取标签项，因为没有定义直接的标签项接口,所有的标签项必须通过OPC的标签组来实现存取。 和

2、每个标签项相关联的有标签值、标签质量和时间戳，相关的内容可以参考本说明书的附录或OPC规范。（二）用工具包 开发的OPC 客户端程序的框架OPCClient。DLL动态库中包含了OPC客户端开发工具包所用到的功能，客户端应用程序通过工具包和OPC 服务器的接口进行操作，用户不必了解OPC相关的通讯规范和实现。实现数据的读取和回写等功能。（三）调用工具包接口的流程图如下：关于上面流程的说明：1对于工具包的激活说明：如果用户购买的是加密锁加密的方式，在运行时系统会自动检测.如果用户购买的是序列号加密的方式，在程序初始化之前要进行相应的激活,否则系统会认为工具为演示版。2用户首先调用Init进行初始

3、化.3初始化后,可以和OPC 服务器进行连接4初始化成功之后,注册数据改变回调函数.5向OPC服务器对象可添加一个或多个标签组。6向OPC标签组对象可添加一个或多个标签项。7当相关联的OPC服务器发生数据改变时，注册的回调函数会被调用，用户可以对接到的数据进行相关的处理和操作。8在客户程序退出时，调用Uninit。（四）在开发过程中，用户必须完成一些工作：1建立应用程序,加载OPC运行库。2按照工具包的提供的接口进行正确的函数调用.三、工具包的接口描述以下接口均采用stdcall调用规范。（一） 初始化函数1、初始化函数function Init: BOOL；功能说明该函数用来初始化工具包动态

4、库。 参数说明 无返 回 值 如果函数成功返回TRUE,否则返回FALSE 附加说明 一般情况下在动态库被加载时应被调用。如果函数调用成功，在动态被卸载时应调用Uninit。2、注销函数 procedure Uninit；功能说明该函数用来注销工具包。返 回 值 无附加说明一般情况下在程序退出时调用,终止服务并释放相应的资源.3、工具包激活函数 function ActiveCode（const UserName， Password: PChar）: BOOL;功能说明该函数用来激活工具包，用于序列号加密的版本.如果不调用此函数，则工具包被当做DEMO版本处理. 参数说明 说明UserName

5、用户在订货时得到的用户名Password用户在订货时得到的注册号返 回 值 如果函数成功返回TRUE，否则返回FALSE附加说明 用户名和注册号为配对使用。（二） 服务器连接函数 1、服务器连接 function Connect（const MachineName， ServerName： PChar； Version： SHORT = 2）: THANDLE；功能说明该函数用来连接服务器，服务器端构建相应的组件对象，返回OPC服务器的接口指针。 参数说明 MachineNameOPC服务器的节点名称ServerNameOPC服务器的名称Version版本号,可有默认值返 回 值 如果函数不成

6、功返回NULL，否则返回OPC服务器的连接句柄。附加说明 函数返回的接口指针很重要，对服务器的操作都要用到。2、断开服务器连接 procedure Disconnect（hConnect: THANDLE）；功能说明该函数用来断开服务器连接，释放对象资源并通知OPC服务器退出.hConnectOPC服务器的连接句柄返 回 值 无。附加说明 程序退出时要调用该函数。3、得到OPC服务器个数函数 function GetServerCount（MachineName： Integer；功能说明该函数用来得到某节点中OPC服务器个数函数。 参数说明 返 回 值 返回该节点OPC服务器个数函数。附加说

7、明 无。4、得到服务器名称 function GetServerName（Index: Buf: PChar; BufSize: Integer）：功能说明该函数根据索引号得到服务器名称。 参数说明 IndexOPC服务器的索引号Buf服务器名称的缓存指针，该缓存用于存放返回的服务器名称BufSize缓存的大小。返 回 值 如果函数成功返回TRUE，否则返回FALSE。附加说明 无。5、得到服务器信息 function GetServerStatus（hConnect：THANDLE；var SvrStatus： SERVERINFORMATION）:功能说明该函数用于得到服务器的信息.Svr

8、Status返回的服务器状态信息返 回 值 如果函数成功返回TRUE，否则返回FALSE。附加说明 服务器信息结构说明typedef struct _SERVERINFORMATION FILETIME ftStartTime；/启动时间 FILETIME ftCurrentTime；/当前时间 FILETIME ftLastUpdateTime；/最近更新时间 WORD dwServerState;/服务器状态 DWORD dwGroupCount；/服务器中组的个数 DWORD dwBandWidth；/服务器带宽 WORD wMajorVersion;/主版本号 WORD wMinorV

9、ersion；/次版本号 WORD wBuildNumber;/编译序数 WORD wReserved；/保留 char* szVendorInfo;/服务器供应商信息 int BufSize;/缓存尺寸 SERVERINFORMATION；服务器状态OPCSERVERSTATE声明:（在OPC DA规范中定义） enum tagOPCSERVERSTATE OPC_STATUS_RUNNING = 1, OPC_STATUS_FAILED = OPC_STATUS_RUNNING + 1, OPC_STATUS_NOCONFIG = OPC_STATUS_FAILED + 1， OPC_ST

10、ATUS_SUSPENDED = OPC_STATUS_NOCONFIG + 1， OPC_STATUS_TEST = OPC_STATUS_SUSPENDED + 1 OPCSERVERSTATE;（三） 标签组函数1、增加标签组 function AddGroup（hConnect: Name: bActive: dwRate： DWORD；TimeBias: PLongint; DeadBand: PSingle； dwLCID: DWORD）：功能说明该函数用于增加标签组。Name标签组的名称bActive是否同时激活dwRate本标签组的数据更新速率TimeBias数据更新的基准时间

11、（以分钟为单位）.如果该参数为NULL表示使用系统默认的时间基准。DeadBand数据更新的死区（变化百分比），只有当标签的数据变化大于死区时才会触发回调函数给客户端。如果参数为空则表示死区为0。dwLCID此参数用于服务器以文本方式返回值（给这个组的相关操作）时使用的语言.这包括象报警或条件状态或数字线圈的状态等.返 回 值 返回新增标签组的句柄。附加说明 无2、删除标签组 procedure RemoveGroup（hConnect, hGroup:功能说明该函数用于删除标签组.hGroup标签组的句柄返 回 值 无附加说明 无3、设置标签组名称 function SetGroupName

12、（hConnect, hGroup： THANDLE; const Name： PChar）：功能说明该函数用于设置标签组名称。返 回 值 如果函数成功返回TRUE，否则返回FALSE。附加说明 无4、设置标签组状态参数 function SetGroupState（hConnect， hGroup: Rate： bActive：BOOL；TimeBias： DWORD; DeadBand： Single; DWORD）:功能说明该函数用于设置标签组状态参数。Rate数据更新的基准时间（以分钟为单位）。如果该参数为NULL表示使用系统默认的时间基准。如果参数为空则表示死区为0.0此参数用于服务

13、器以文本方式返回值（给这个组的相关操作）时使用的语言。这包括象报警或条件状态或数字线圈的状态等。返 回 值 如果函数成功返回TRUE，否则返回FALSE。5、得到标签组状态 function GetGroupState（hConnect, hGroup: Integer; var pRate: var bActive: var pTimeBias：var pDeadBand: Single； var pLCID:标签组的缓冲区大小pRatepTimeBias如果该参数为NULL表示使用系统默认的时间基准.pDeadBand数据更新的死区（变化百分比）,只有当标签的数据变化大于死区时才会触发回调

14、函数给客户端。pLCID返 回 值 如果函数成功返回TRUE,否则返回FALSE。（四） 标签项函数1、增加标签项 function AddItem（hConnect, hGroup： ItemName：功能说明该函数用于在标签组中增加标签项。ItemName标签项的名称返 回 值 该标签项的句柄2、删除标签项 procedure RemoveItem（hConnect， hGroup， hItem:功能说明该函数用于在标签组中删除标签项.hItem标签项的句柄返 回 值 该标签项的句柄3、读标签的数据 function ReadItem（hConnect, hGroup, hItem： va

15、r Value： OleVariant;var pTimeStamp： FILETIME; var pQuality：功能说明该函数用于在标签组中读取标签的数据.Value标签的值pTimeStamp标签的时间戳pQuality标签的质量4、写标签项 function WriteItem（hConnect, hGroup， hItem: pVar： POleVariant； DoAsync: BOOL = False）:功能说明该函数用于在标签组中标签数据的回写。pVar标签的回写值DoAsync回写操作的方式（是同步方式还是异步方式）5、激活标签项 function ActiveItem（h

16、Connect, hGroup, hItem: BOOL）:功能说明该函数用于在标签组中标签项的激活。是否激活附加说明 无6、验证标签项 function ValidateItem（hConnect， hGroup： var pType: TVarType;var pAccessRights:功能说明该函数用于在标签组中验证标签项.pType标签的数据类型pAccessRights标签的存取权限返 回 值 如果函数成功返回TRUE，否则返回FALSE.7、得到标签项个数 function GetItemCount（hConnect: THANDLE）：功能说明该函数用于得到某个连接中标签项的个

17、数.返 回 值 返回标签项的个数。8、得到标签项名称 function GetItemName（hConnect: index： BufSize：功能说明该函数用于得到标签项名称.index标签的索引号标签名缓冲区的指针标签名缓冲区的大小返 回 值 如果函数成功返回TRUE,否则返回FALSE。9、得到标签项全名 function GetItemFullName（hConnect: index: Buf：功能说明该函数用于得到标签项全名。返 回 值 如果函数成功返回TRUE，否则返回FALSE.10、得到标签项属性的个数 function NumberOfItemProperties（hCon

18、nect: ItemName:功能说明该函数用于得到得到标签项属性的个数。返 回 值 标签项属性的个数。11、得到标签项属性说明 function GetItemPropertyDescription（hConnect： PropertyIndex: var pPropertyID:var VT: Integer）:功能说明该函数用于得到得到标签项属性的描述。PropertyIndex标签项属性的索引号pPropertyID属性IDVT属性的数据类型属性描述缓冲区的指针属性描述缓冲区的大小12、读 标签项属性值 function ReadPropertyValue（hConnect： Prop

19、ertyID: pValue: POleVariant）:（五） 回调函数 procedure SetDataChangeProc（hConnect： lpCallback： DATACHANGEPROC; WriteCallback： WRITEFINISHPROC = nil）;功能说明该函数用于注册数据改变回调函数.lpCallback回调函数的程序指针（数据改变时调用）WriteCallback写数据函数的程序指针附加说明 当服务器中有数据改变时，会调用注册的回调函数.（六） 其它函数1、浏览标签项 function BrowseItems（hConnect: FilterType: WORD）：功能说明该函数用于遍历某个连接中的标签项。FilterType过滤类型返 回 值 返回遍历标签项的个数。2、设置浏览标签的过滤条件 function Set