Open62541教程:在OPC UA服务器中添加方法节点
概述
本文基于open62541项目,详细讲解如何在OPC UA服务器中创建和添加方法节点(MethodNode)。方法节点允许客户端通过OPC UA调用服务器端定义的功能,类似于面向对象编程中的对象方法。
OPC UA方法节点基础
在OPC UA信息模型中,方法节点具有以下特点:
- 方法节点可以被多个对象引用,类似于编程语言中的方法共享
- 方法调用时总是明确指定上下文对象
- 方法参数通过输入输出变量定义,支持多种数据类型和数组
- 参数约束通过子变量节点定义,包括数据类型、值等级和数组维度
示例一:Hello World方法
方法功能
创建一个简单的"Hello World"方法,接收一个字符串输入,返回"Hello "加上输入字符串。
实现步骤
- 定义方法回调函数:
static UA_StatusCode
helloWorldMethodCallback(UA_Server *server,
const UA_NodeId *sessionId, void *sessionHandle,
const UA_NodeId *methodId, void *methodContext,
const UA_NodeId *objectId, void *objectContext,
size_t inputSize, const UA_Variant *input,
size_t outputSize, UA_Variant *output) {
// 获取输入字符串
UA_String *inputStr = (UA_String*)input->data;
// 创建输出字符串
UA_String tmp = UA_STRING_ALLOC("Hello ");
if(inputStr->length > 0) {
tmp.data = (UA_Byte *)UA_realloc(tmp.data, tmp.length + inputStr->length);
memcpy(&tmp.data[tmp.length], inputStr->data, inputStr->length);
tmp.length += inputStr->length;
}
// 设置输出参数
UA_Variant_setScalarCopy(output, &tmp, &UA_TYPES[UA_TYPES_STRING]);
UA_String_clear(&tmp);
// 记录日志
UA_LOG_INFO(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "Hello World was called");
return UA_STATUSCODE_GOOD;
}
- 配置方法参数:
UA_Argument inputArgument;
UA_Argument_init(&inputArgument);
inputArgument.description = UA_LOCALIZEDTEXT("en-US", "A String");
inputArgument.name = UA_STRING("MyInput");
inputArgument.dataType = UA_TYPES[UA_TYPES_STRING].typeId;
inputArgument.valueRank = UA_VALUERANK_SCALAR;
UA_Argument outputArgument;
UA_Argument_init(&outputArgument);
outputArgument.description = UA_LOCALIZEDTEXT("en-US", "A String");
outputArgument.name = UA_STRING("MyOutput");
outputArgument.dataType = UA_TYPES[UA_TYPES_STRING].typeId;
outputArgument.valueRank = UA_VALUERANK_SCALAR;
- 添加方法节点:
UA_MethodAttributes helloAttr = UA_MethodAttributes_default;
helloAttr.description = UA_LOCALIZEDTEXT("en-US","Say `Hello World`");
helloAttr.displayName = UA_LOCALIZEDTEXT("en-US","Hello World");
helloAttr.executable = true;
helloAttr.userExecutable = true;
UA_Server_addMethodNode(server, UA_NODEID_NUMERIC(1,62541),
UA_NS0ID(OBJECTSFOLDER),
UA_NS0ID(HASCOMPONENT),
UA_QUALIFIEDNAME(1, "hello world"),
helloAttr, &helloWorldMethodCallback,
1, &inputArgument, 1, &outputArgument, NULL, NULL);
示例二:数组增量方法
方法功能
创建一个处理数组的方法,接收一个包含5个整数的数组和一个增量值,返回每个元素增加增量值后的新数组。
实现步骤
- 定义方法回调函数:
static UA_StatusCode
IncInt32ArrayMethodCallback(UA_Server *server,
const UA_NodeId *sessionId, void *sessionContext,
const UA_NodeId *methodId, void *methodContext,
const UA_NodeId *objectId, void *objectContext,
size_t inputSize, const UA_Variant *input,
size_t outputSize, UA_Variant *output) {
// 获取输入数组和增量值
UA_Int32 *inputArray = (UA_Int32*)input[0].data;
UA_Int32 delta = *(UA_Int32*)input[1].data;
// 复制输入数组到输出
UA_StatusCode retval = UA_Variant_setArrayCopy(output, inputArray, 5,
&UA_TYPES[UA_TYPES_INT32]);
if(retval != UA_STATUSCODE_GOOD)
return retval;
// 对每个元素增加增量值
UA_Int32 *outputArray = (UA_Int32*)output->data;
for(size_t i = 0; i < input->arrayLength; i++)
outputArray[i] = inputArray[i] + delta;
return UA_STATUSCODE_GOOD;
}
- 配置方法参数:
// 输入参数1:5元素整型数组
UA_Argument inputArguments[2];
UA_Argument_init(&inputArguments[0]);
inputArguments[0].description = UA_LOCALIZEDTEXT("en-US", "int32[5] array");
inputArguments[0].name = UA_STRING("int32 array");
inputArguments[0].dataType = UA_TYPES[UA_TYPES_INT32].typeId;
inputArguments[0].valueRank = UA_VALUERANK_ONE_DIMENSION;
UA_UInt32 pInputDimension = 5;
inputArguments[0].arrayDimensionsSize = 1;
inputArguments[0].arrayDimensions = &pInputDimension;
// 输入参数2:整型增量值
UA_Argument_init(&inputArguments[1]);
inputArguments[1].description = UA_LOCALIZEDTEXT("en-US", "int32 delta");
inputArguments[1].name = UA_STRING("int32 delta");
inputArguments[1].dataType = UA_TYPES[UA_TYPES_INT32].typeId;
inputArguments[1].valueRank = UA_VALUERANK_SCALAR;
// 输出参数:处理后的5元素整型数组
UA_Argument outputArgument;
UA_Argument_init(&outputArgument);
outputArgument.description = UA_LOCALIZEDTEXT("en-US", "int32[5] array");
outputArgument.name = UA_STRING("each entry is incremented by the delta");
outputArgument.dataType = UA_TYPES[UA_TYPES_INT32].typeId;
outputArgument.valueRank = UA_VALUERANK_ONE_DIMENSION;
UA_UInt32 pOutputDimension = 5;
outputArgument.arrayDimensionsSize = 1;
outputArgument.arrayDimensions = &pOutputDimension;
- 添加方法节点:
UA_MethodAttributes incAttr = UA_MethodAttributes_default;
incAttr.description = UA_LOCALIZEDTEXT("en-US", "IncInt32ArrayValues");
incAttr.displayName = UA_LOCALIZEDTEXT("en-US", "IncInt32ArrayValues");
incAttr.executable = true;
incAttr.userExecutable = true;
UA_Server_addMethodNode(server, UA_NODEID_STRING(1, "IncInt32ArrayValues"),
UA_NS0ID(OBJECTSFOLDER),
UA_NS0ID(HASCOMPONENT),
UA_QUALIFIEDNAME(1, "IncInt32ArrayValues"),
incAttr, &IncInt32ArrayMethodCallback,
2, inputArguments, 1, &outputArgument,
NULL, NULL);
服务器主程序
将上述方法添加到服务器并运行:
int main(void) {
UA_Server *server = UA_Server_new();
addHelloWorldMethod(server);
addIncInt32ArrayMethod(server);
UA_Server_runUntilInterrupt(server);
UA_Server_delete(server);
return 0;
}
关键点总结
- 方法回调函数:处理客户端请求的核心逻辑,需要正确处理输入参数并设置输出参数
- 参数定义:明确定义每个参数的数据类型、值等级和数组维度
- 方法属性:设置方法的显示名称、描述和执行权限
- 节点添加:使用
UA_Server_addMethodNode
将方法添加到服务器信息模型中
通过本文的示例,开发者可以掌握在open62541中创建OPC UA方法节点的基本方法,并根据实际需求扩展更复杂的功能。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考