MqttRpcDevice 类 |
命名空间: HslCommunication.MQTT
MqttRpcDevice 类型公开以下成员。
名称 | 说明 | |
---|---|---|
MqttRpcDevice(MqttConnectionOptions, String) |
实例化一个MQTT的同步客户端 Instantiate an MQTT synchronization client | |
MqttRpcDevice(String, Int32, String) |
通过指定的ip地址及端口来实例化一个同步的MQTT客户端 Instantiate a synchronized MQTT client with the specified IP address and port |
名称 | 说明 | |
---|---|---|
ByteTransform |
当前的数据变换机制,当你需要从字节数据转换类型数据的时候需要。 The current data transformation mechanism is required when you need to convert type data from byte data. | |
CommunicationPipe | (继承自 BinaryCommunication。) | |
ConnectionId |
当前连接的唯一ID号,默认为长度20的guid码加随机数组成,方便列表管理,也可以自己指定 (继承自 BinaryCommunication。)The unique ID number of the current connection. The default is a 20-digit guid code plus a random number. | |
ConnectionOptions |
获取或设置当前的连接信息,客户端将根据这个连接配置进行连接服务器,在连接之前需要设置相关的信息才有效。 (继承自 MqttSyncClient。)To obtain or set the current connection information, the client will connect to the server according to this connection configuration. Before connecting, the relevant information needs to be set to be effective. | |
ConnectTimeOut |
获取或设置接收服务器反馈的时间,如果为负数,则不接收反馈 (继承自 TcpNetCommunication。)Gets or sets the time to receive server feedback, and if it is a negative number, does not receive feedback | |
DeviceTopic |
获取或设置当前的设备主题信息 Get or set the current device theme information. | |
IpAddress |
获取或是设置远程服务器的IP地址,如果是本机测试,那么需要设置为127.0.0.1 (继承自 TcpNetCommunication。)Get or set the IP address of the remote server. If it is a local test, then it needs to be set to 127.0.0.1 | |
LocalBinding |
获取或设置绑定的本地的IP地址和端口号信息,如果端口设置为0,代表任何可用的端口 (继承自 TcpNetCommunication。)Get or set the bound local IP address and port number information, if the port is set to 0, it means any available port | |
LogNet |
组件的日志工具,支持日志记录,只要实例化后,当前网络的基本信息,就以DEBUG等级进行输出 (继承自 BinaryCommunication。)The component's logging tool supports logging. As long as the instantiation of the basic network information, the output will be output at DEBUG | |
Port |
获取或设置服务器的端口号,具体的值需要取决于对方的配置 (继承自 TcpNetCommunication。)Gets or sets the port number of the server. The specific value depends on the configuration of the other party. | |
ReceiveTimeOut |
获取或设置接收服务器反馈的时间,如果为负数,则不接收反馈 (继承自 BinaryCommunication。)Gets or sets the time to receive server feedback, and if it is a negative number, does not receive feedback | |
SendBeforeHex |
获取或设置在发送通信报文前追加发送的字节信息,HEX格式,通常用于lora组网时,需要携带 00 00 00 02 四个字节的站地址功能。 (继承自 BinaryCommunication。)Obtain or set the byte information sent before sending communication packets, HEX format, usually used for LORA networking, you need to carry 00 00 00 02 four-byte station address function. | |
SleepTime |
获取或设置在正式接收对方返回数据前的时候,需要休息的时间,当设置为0的时候,不需要休息。 (继承自 BinaryCommunication。)Get or set the time required to rest before officially receiving the data from the other party. When it is set to 0, no rest is required. | |
SocketKeepAliveTime |
获取或设置客户端的Socket的心跳时间信息,这个是Socket底层自动实现的心跳包,不基于协议层实现。默认小于0,不开启心跳检测,如果需要开启,设置 60_000 比较合适,单位毫秒 (继承自 TcpNetCommunication。)Get or set the heartbeat time information of the Socket of the client. This is the heartbeat packet automatically implemented by the bottom layer of the Socket, not based on the protocol layer. The default value is less than 0, and heartbeat detection is not enabled. If you need to enable it, it is more appropriate to set 60_000, in milliseconds. | |
StringEncoding |
获取或设置使用字符串访问的时候,使用的编码信息,默认为UT8编码 (继承自 MqttSyncClient。)Get or set the encoding information used when accessing with a string, the default is UT8 encoding |
名称 | 说明 | |
---|---|---|
ConnectClose |
手动断开与远程服务器的连接,如果当前是长连接模式,那么就会切换到短连接模式 (继承自 TcpNetCommunication。)Manually disconnect from the remote server, if it is currently in long connection mode, it will switch to short connection mode | |
ConnectCloseAsync |
手动断开与远程服务器的连接,如果当前是长连接模式,那么就会切换到短连接模式 (继承自 TcpNetCommunication。)Manually disconnect from the remote server, if it is currently in long connection mode, it will switch to short connection mode | |
ConnectServer |
尝试连接远程的服务器,如果连接成功,就切换短连接模式到长连接模式,后面的每次请求都共享一个通道,使得通讯速度更快速 (继承自 TcpNetCommunication。)Try to connect to a remote server. If the connection is successful, switch the short connection mode to the long connection mode. Each subsequent request will share a channel, making the communication speed faster. | |
ConnectServerAsync |
尝试连接远程的服务器,如果连接成功,就切换短连接模式到长连接模式,后面的每次请求都共享一个通道,使得通讯速度更快速 (继承自 TcpNetCommunication。)Try to connect to a remote server. If the connection is successful, switch the short connection mode to the long connection mode. Each subsequent request will share a channel, making the communication speed faster. | |
DecideWhetherQAMessage |
决定当前的消息是否是用于问答机制返回的消息,默认直接返回 true, 实际的情况需要根据协议进行重写方法 (继承自 BinaryCommunication。)To determine whether the current message is the message returned by the question answering mechanism, the default is true. In actual cases, the rewriting method needs to be performed according to the protocol | |
DeleteFile(String, String) |
[文件引擎] 删除服务器的指定的文件名,需要指定分类信息,文件名 (继承自 MqttSyncClient。)[File Engine] Delete the specified file name of the server, need to specify the classification information, file name | |
DeleteFile(String, String) |
[文件引擎] 删除服务器的指定的文件名,需要指定分类信息,文件名 (继承自 MqttSyncClient。)[File Engine] Delete the specified file name of the server, need to specify the classification information, file name | |
DeleteFileAsync(String, String) |
[文件引擎] 删除服务器的指定的文件名,需要指定分类信息,文件名 (继承自 MqttSyncClient。)[File Engine] Delete the specified file name of the server, need to specify the classification information, file name | |
DeleteFileAsync(String, String) |
[文件引擎] 删除服务器的指定的文件名,需要指定分类信息,文件名 (继承自 MqttSyncClient。)[File Engine] Delete the specified file name of the server, need to specify the classification information, file name | |
DeleteFolder |
[文件引擎] 删除服务器上指定的分类信息及管理的所有的文件,包含所有的子分类信息,不可逆操作,谨慎操作。 (继承自 MqttSyncClient。)[File Engine] Delete the specified classification information and all files managed on the server, including all sub-classification information, irreversible operation, and careful operation. | |
DeleteFolderAsync |
[文件引擎] 删除服务器上指定的分类信息及管理的所有的文件,包含所有的子分类信息,不可逆操作,谨慎操作。 (继承自 MqttSyncClient。)[File Engine] Delete the specified classification information and all files managed on the server, including all sub-classification information, irreversible operation, and careful operation. | |
DeleteFolderFiles |
[文件引擎] 删除服务器上指定的分类的所有的文件,不可逆操作,谨慎操作。 (继承自 MqttSyncClient。)[File Engine] Delete the specified classification information and all files managed on the server, irreversible operation, and careful operation. | |
DeleteFolderFilesAsync |
[文件引擎] 删除服务器上指定的分类的所有的文件,不可逆操作,谨慎操作。 (继承自 MqttSyncClient。)[File Engine] Delete the specified classification information and all files managed on the server, irreversible operation, and careful operation. | |
DownloadBitmap |
[文件引擎] 从远程服务器下载一个文件,生成一个Bitmap图片对象,需要指定文件类别,文件名,进度报告,可用于用户头像的存储 (继承自 MqttSyncClient。)[File Engine] Download a file from a remote server and generate a Bitmap image object. You need to specify the file category, file name, and progress report, which can be used to store the user's avatar | |
DownloadBitmapAsync |
[文件引擎] 从远程服务器下载一个文件,生成一个Bitmap图片对象,需要指定文件类别,文件名,进度报告,可用于用户头像的存储 (继承自 MqttSyncClient。)[File Engine] Download a file from a remote server and generate a Bitmap image object. You need to specify the file category, file name, and progress report, which can be used to store the user's avatar | |
DownloadFile(String, String, ActionInt64, Int64, Stream, HslCancelToken) |
[文件引擎] 从远程服务器下载一个文件到流中,需要指定文件类别,文件名,进度报告,本地保存的文件名 (继承自 MqttSyncClient。)To download a file from a remote server to the stream, you need to specify the file category, file name, progress report, and file name saved locally | |
DownloadFile(String, String, ActionInt64, Int64, String, HslCancelToken) |
[文件引擎] 从远程服务器下载一个文件到本地,需要指定文件类别,文件名,进度报告,本地保存的文件名 (继承自 MqttSyncClient。)[File Engine] To download a file from a remote server to the local, you need to specify the file category, file name, progress report, and file name saved locally | |
DownloadFileAsync(String, String, ActionInt64, Int64, Stream, HslCancelToken) |
[文件引擎] 从远程服务器下载一个文件到流中,需要指定文件类别,文件名,进度报告,本地保存的文件名 (继承自 MqttSyncClient。)To download a file from a remote server to the stream, you need to specify the file category, file name, progress report, and file name saved locally | |
DownloadFileAsync(String, String, ActionInt64, Int64, String, HslCancelToken) |
[文件引擎] 从远程服务器下载一个文件到本地,需要指定文件类别,文件名,进度报告,本地保存的文件名 (继承自 MqttSyncClient。)[File Engine] To download a file from a remote server to the local, you need to specify the file category, file name, progress report, and file name saved locally | |
DownloadPathFileNames |
[文件引擎] 下载指定分类信息的所有的文件描述信息,需要指定分类信息,例如:Files/Personal/Admin (继承自 MqttSyncClient。)[File Engine] To download all the file description information of the specified classification information, you need to specify the classification information, for example: Files/Personal/Admin | |
DownloadPathFileNamesAsync |
[文件引擎] 下载指定分类信息的所有的文件描述信息,需要指定分类信息,例如:Files/Personal/Admin (继承自 MqttSyncClient。)[File Engine] To download all the file description information of the specified classification information, you need to specify the classification information, for example: Files/Personal/Admin | |
DownloadPathFolders |
下载指定分类信息的全部子分类信息 (继承自 MqttSyncClient。)Download all sub-category information of the specified category information | |
DownloadPathFoldersAsync |
下载指定分类信息的全部子分类信息 (继承自 MqttSyncClient。)Download all sub-category information of the specified category information | |
Equals | Determines whether the specified object is equal to the current object. (继承自 Object。) | |
ExtraAfterReadFromCoreServer |
和服务器交互完成的时候调用的方法,可以根据读写结果进行一些额外的操作,具体的操作需要根据实际的需求来重写实现 (继承自 BinaryCommunication。)The method called when the interaction with the server is completed can perform some additional operations based on the read and write results. The specific operations need to be rewritten according to actual needs. | |
ExtraOnDisconnect |
根据实际的协议选择是否重写本方法,有些协议在断开连接之前,需要发送一些报文来关闭当前的网络通道 (继承自 BinaryCommunication。)Select whether to rewrite this method according to the actual protocol. Some protocols need to send some packets to close the current network channel before disconnecting. | |
ExtraOnDisconnectAsync |
根据实际的协议选择是否重写本方法,有些协议在断开连接之前,需要发送一些报文来关闭当前的网络通道 (继承自 BinaryCommunication。)Select whether to rewrite this method according to the actual protocol. Some protocols need to send some packets to close the current network channel before disconnecting. | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (继承自 Object。) | |
GetGroupFileInfo |
[文件引擎] 获取服务器文件夹的指定目录的文件统计信息,包括文件数量,总大小,最后更新时间 (继承自 MqttSyncClient。)[File Engine] Get the file statistics of the specified directory of the server folder, including the number of files, the total size, and the last update time | |
GetGroupFileInfoAsync |
[文件引擎] 获取服务器文件夹的指定目录的文件统计信息,包括文件数量,总大小,最后更新时间 (继承自 MqttSyncClient。)[File Engine] Get the file statistics of the specified directory of the server folder, including the number of files, the total size, and the last update time | |
GetHashCode | Serves as the default hash function. (继承自 Object。) | |
GetLogTextFromBinary |
获取当前的报文进行日志记录的时候,是否使用二进制的格式记录,默认返回 LogMsgFormatBinary,重写可以根据session对象分别返回不同记录模式 (继承自 BinaryCommunication。)Whether to log the current packet in binary format, the default return is LogMsgFormatBinary. If you want to override it, different recording modes can be returned according to session | |
GetNewNetMessage |
获取一个新的消息对象的方法,需要在继承类里面进行重写 (继承自 BinaryCommunication。)The method to get a new message object needs to be overridden in the inheritance class | |
GetSubGroupFileInfos |
[文件引擎] 获取服务器文件夹的指定目录的所有子目录的文件信息,包括每个子目录的文件数量,总大小,最后更新时间 (继承自 MqttSyncClient。)[File Engine] Get the file information of all subdirectories of the specified directory of the server folder, including the number of files in each subdirectory, the total size, and the last update time | |
GetSubGroupFileInfosAsync |
[文件引擎] 获取服务器文件夹的指定目录的所有子目录的文件信息,包括每个子目录的文件数量,总大小,最后更新时间 (继承自 MqttSyncClient。)[File Engine] Get the file information of all subdirectories of the specified directory of the server folder, including the number of files in each subdirectory, the total size, and the last update time | |
GetType | Gets the Type of the current instance. (继承自 Object。) | |
InitializationOnConnect |
根据实际的协议选择是否重写本方法,有些协议在创建连接之后,需要进行一些初始化的信号握手,才能最终建立网络通道。 (继承自 MqttSyncClient。)Whether to rewrite this method is based on the actual protocol. Some protocols require some initial signal handshake to establish a network channel after the connection is created. | |
InitializationOnConnectAsync |
根据实际的协议选择是否重写本方法,有些协议在创建连接之后,需要进行一些初始化的信号握手,才能最终建立网络通道。 (继承自 MqttSyncClient。)Whether to rewrite this method is based on the actual protocol. Some protocols require some initial signal handshake to establish a network channel after the connection is created. | |
IpAddressPing |
对当前设备的IP地址进行PING的操作,返回PING的结果,正常来说,返回Success (继承自 TcpNetCommunication。)PING the IP address of the current device and return the PING result. Normally, it returns Success | |
IsFileExists |
[文件引擎] 请求服务器指定分类是否存在指定的文件名,需要指定分类信息,文件名 (继承自 MqttSyncClient。)[File Engine] Request the server to specify whether the specified file name exists in the specified category, need to specify the category information, file name | |
IsFileExistsAsync |
[文件引擎] 请求服务器指定分类是否存在指定的文件名,需要指定分类信息,文件名 (继承自 MqttSyncClient。)[File Engine] Request the server to specify whether the specified file name exists in the specified category, need to specify the category information, file name | |
LogRevcMessage(Byte) |
使用日志记录一个接收的报文信息 (继承自 BinaryCommunication。)` Logs are used to record information about a received packet | |
LogRevcMessage(Byte, PipeSession) |
使用日志记录一个接收的报文信息 (继承自 BinaryCommunication。)` Logs are used to record information about a received packet | |
LogSendMessage(Byte) |
使用日志记录一个发送的报文信息 (继承自 BinaryCommunication。)Logs are used to record information about a send packet | |
LogSendMessage(Byte, PipeSession) |
使用日志记录一个发送的报文信息 (继承自 BinaryCommunication。)Logs are used to record information about a send packet | |
MemberwiseClone | Creates a shallow copy of the current Object. (继承自 Object。) | |
PackCommandWithHeader |
对当前的命令进行打包处理,通常是携带命令头内容,标记当前的命令的长度信息,需要进行重写,否则默认不打包 (继承自 BinaryCommunication。)The current command is packaged, usually carrying the content of the command header, marking the length of the current command, and it needs to be rewritten, otherwise it is not packaged by default | |
Read(String, UInt16) |
批量读取字节数组信息,需要指定地址和长度,返回原始的字节数组 Batch read byte array information, need to specify the address and length, return the original byte array | |
Read(String, Byte, ActionInt64, Int64, ActionString, String, ActionInt64, Int64) |
从MQTT服务器同步读取数据,将payload发送到服务器,然后从服务器返回相关的数据,支持数据发送进度报告,服务器执行进度报告,接收数据进度报告操作 (继承自 MqttSyncClient。)Synchronously read data from the MQTT server, send the payload to the server, and then return relevant data from the server, support data transmission progress report, the server executes the progress report, and receives the data progress report | |
ReadT |
读取支持Hsl特性的数据内容,该特性为HslDeviceAddressAttribute,详细参考api文档说明,或是官网的详细文档 Read the data content of the Hsl attribute. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details. | |
ReadAsync(String, UInt16) |
异步批量读取字节数组信息,需要指定地址和长度,返回原始的字节数组 Asynchronous batch read byte array information, need to specify the address and length, return the original byte array | |
ReadAsync(String, Byte, ActionInt64, Int64, ActionString, String, ActionInt64, Int64) |
从MQTT服务器同步读取数据,将payload发送到服务器,然后从服务器返回相关的数据,支持数据发送进度报告,服务器执行进度报告,接收数据进度报告操作 (继承自 MqttSyncClient。)Synchronously read data from the MQTT server, send the payload to the server, and then return relevant data from the server, support data transmission progress report, the server executes the progress report, and receives the data progress report | |
ReadAsyncT |
异步读取支持Hsl特性的数据内容,该特性为HslDeviceAddressAttribute,详细参考api文档说明 Asynchronously read the data content of the Hsl attribute. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details. | |
ReadBool(String) |
读取单个的Boolean数据信息 Read a single Boolean data message | |
ReadBool(String, UInt16) |
批量读取Boolean数组信息,需要指定地址和长度,返回Boolean 数组 Batch read Boolean array information, need to specify the address and length, return Boolean array | |
ReadBoolAsync(String) |
异步读取单个的Boolean数据信息 Asynchronously read a single Boolean data message | |
ReadBoolAsync(String, UInt16) |
异步批量读取Boolean数组信息,需要指定地址和长度,返回Boolean 数组 Asynchronously batch read Boolean array information, need to specify the address and length, return Boolean array | |
ReadCustomerT(String) |
读取自定义的数据类型,需要继承自IDataTransfer接口,返回一个新的类型的实例对象。 To read a custom data type, you need to inherit from the IDataTransfer interface and return an instance object of a new type. | |
ReadCustomerT(String, T) |
读取自定义的数据类型,需要继承自IDataTransfer接口,传入一个实例,对这个实例进行赋值,并返回该实例的对象。 To read a custom data type, you need to inherit from the IDataTransfer interface, pass in an instance, assign a value to this instance, and return the object of the instance. | |
ReadCustomerAsyncT(String) |
读取自定义的数据类型,需要继承自IDataTransfer接口,返回一个新的类型的实例对象。 To read a custom data type, you need to inherit from the IDataTransfer interface and return an instance object of a new type. | |
ReadCustomerAsyncT(String, T) |
读取自定义的数据类型,需要继承自IDataTransfer接口,传入一个实例,对这个实例进行赋值,并返回该实例的对象。 To read a custom data type, you need to inherit from the IDataTransfer interface, pass in an instance, assign a value to this instance, and return the object of the instance. | |
ReadDouble(String) |
读取双浮点的数据 Read double floating point data | |
ReadDouble(String, UInt16) |
读取双浮点数据的数组 Read double floating point data array | |
ReadDoubleAsync(String) |
异步读取双浮点的数据 Asynchronously read double floating point data | |
ReadDoubleAsync(String, UInt16) |
异步读取双浮点数据的数组 Asynchronously read double floating point data array | |
ReadFloat(String) |
读取单浮点数据 Read single floating point data | |
ReadFloat(String, UInt16) |
读取单浮点精度的数组 Read single floating point array | |
ReadFloatAsync(String) |
异步读取单浮点数据 Asynchronously read single floating point data | |
ReadFloatAsync(String, UInt16) |
异步读取单浮点精度的数组 Asynchronously read single floating point array | |
ReadFromCoreServer(Byte) |
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。 (继承自 BinaryCommunication。)Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object | |
ReadFromCoreServer(IEnumerableByte) |
将多个数据报文按顺序发到设备,并从设备接收返回的数据内容,然后拼接成一个Byte[]信息,需要重写UnpackResponseContent(Byte, Byte)方法才能返回正确的结果。 (继承自 BinaryCommunication。)Send multiple data packets to the device in sequence, and receive the returned data content from the device, and then splicing them into a Byte[] message, you need to rewrite UnpackResponseContent(Byte, Byte) method to return the correct result. | |
ReadFromCoreServer(Byte, Boolean, Boolean) |
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。 (继承自 BinaryCommunication。)Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object | |
ReadFromCoreServer(CommunicationPipe, Byte, Boolean, Boolean) |
使用指定的管道来进行数据通信,发送原始数据到管道,然后从管道接收相关的数据返回,本方法无锁
(继承自 MqttSyncClient。) | |
ReadFromCoreServerAsync(Byte) |
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。 (继承自 BinaryCommunication。)Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object | |
ReadFromCoreServerAsync(IEnumerableByte) |
将多个数据报文按顺序发到设备,并从设备接收返回的数据内容,然后拼接成一个Byte[]信息,需要重写UnpackResponseContent(Byte, Byte)方法才能返回正确的结果。 (继承自 BinaryCommunication。)Send multiple data packets to the device in sequence, and receive the returned data content from the device, and then splicing them into a Byte[] message, you need to rewrite UnpackResponseContent(Byte, Byte) method to return the correct result. | |
ReadFromCoreServerAsync(Byte, Boolean, Boolean) |
将二进制的数据发送到管道中去,然后从管道里接收二进制的数据回来,并返回是否成功的结果对象。 (继承自 BinaryCommunication。)Send binary data to the pipeline, and then receive binary data back from the pipeline, and return whether the success of the result object | |
ReadFromCoreServerAsync(CommunicationPipe, Byte, Boolean, Boolean) |
使用指定的管道来进行数据通信,发送原始数据到管道,然后从管道接收相关的数据返回,本方法无锁
(继承自 MqttSyncClient。) | |
ReadInt16(String) |
读取16位的有符号的整型数据 Read 16-bit signed integer data | |
ReadInt16(String, UInt16) |
读取16位的有符号整型数组 Read 16-bit signed integer array | |
ReadInt16Async(String) |
异步读取16位的有符号的整型数据 Asynchronously read 16-bit signed integer data | |
ReadInt16Async(String, UInt16) |
异步读取16位的有符号整型数组 Asynchronously read 16-bit signed integer array | |
ReadInt32(String) |
读取32位的有符号整型 Read 32-bit signed integer | |
ReadInt32(String, UInt16) |
读取32位有符号整型数组 Read 32-bit signed integer array | |
ReadInt32Async(String) |
异步读取32位的有符号整型 Asynchronously read 32-bit signed integer | |
ReadInt32Async(String, UInt16) |
异步读取32位有符号整型数组 Asynchronously read 32-bit signed integer array | |
ReadInt64(String) |
读取64位的有符号整型 Read 64-bit signed integer | |
ReadInt64(String, UInt16) |
读取64位的有符号整型数组 Read 64-bit signed integer array | |
ReadInt64Async(String) |
异步读取64位的有符号整型 Asynchronously read 64-bit signed integer | |
ReadInt64Async(String, UInt16) |
异步读取64位的有符号整型数组 Asynchronously read 64-bit signed integer array | |
ReadRetainTopics |
读取服务器的已经驻留的所有消息的主题列表 (继承自 MqttSyncClient。)Read the topic list of all messages that have resided on the server | |
ReadRetainTopicsAsync |
读取服务器的已经驻留的所有消息的主题列表 (继承自 MqttSyncClient。)Read the topic list of all messages that have resided on the server | |
ReadRpcT(String, Object) |
读取MQTT服务器注册的RPC接口,忽略返回的Topic数据,直接将结果转换为泛型对象,如果JSON转换失败,将返回错误,参数传递主题和数据负载,
数据负载示例:new { address = "", length = 0 } 本质是一个匿名对象。 (继承自 MqttSyncClient。)Read the RPC interface registered by the MQTT server, ignore the returned Topic data, and directly convert the result into a generic object. If the JSON conversion fails, an error will be returned. The parameter passes the topic and the data payload. The data payload example: new { address = "", length = 0 } is essentially an anonymous object. | |
ReadRpcT(String, String) |
读取MQTT服务器注册的RPC接口,忽略返回的Topic数据,直接将结果转换为泛型对象,如果JSON转换失败,将返回错误,参数传递主题和数据负载,
数据负载示例:"{\"address\": \"100\",\"length\": 10}" 本质是一个字符串。 (继承自 MqttSyncClient。)Read the RPC interface registered by the MQTT server, ignore the returned Topic data, and directly convert the result into a generic object. If the JSON conversion fails, an error will be returned. The parameter passes the topic and the data payload. The data payload example: "{\"address\ ": \"100\",\"length\": 10}" is essentially a string. | |
ReadRpcApiLog |
读取服务器的指定的API接口的每天的调用次数,如果API接口不存在,或是还没有调用数据,则返回失败。 (继承自 MqttSyncClient。)Read the number of calls per day of the designated API interface of the server. If the API interface does not exist or the data has not been called yet, it returns a failure. | |
ReadRpcApiLogAsync |
读取服务器的指定的API接口的每天的调用次数,如果API接口不存在,或是还没有调用数据,则返回失败。 (继承自 MqttSyncClient。)Read the number of calls per day of the designated API interface of the server. If the API interface does not exist or the data has not been called yet, it returns a failure. | |
ReadRpcApis |
读取服务器的已经注册的API信息列表,将返回API的主题路径,注释信息,示例的传入的数据信息。 (继承自 MqttSyncClient。)Read the registered API information list of the server, and return the API subject path, annotation information, and sample incoming data information. | |
ReadRpcApisAsync |
读取服务器的已经注册的API信息列表,将返回API的主题路径,注释信息,示例的传入的数据信息。 (继承自 MqttSyncClient。)Read the registered API information list of the server, and return the API subject path, annotation information, and sample incoming data information. | |
ReadRpcAsyncT(String, Object) |
读取MQTT服务器注册的RPC接口,忽略返回的Topic数据,直接将结果转换为泛型对象,如果JSON转换失败,将返回错误,参数传递主题和数据负载,
数据负载示例:new { address = "", length = 0 } 本质是一个匿名对象。 (继承自 MqttSyncClient。)Read the RPC interface registered by the MQTT server, ignore the returned Topic data, and directly convert the result into a generic object. If the JSON conversion fails, an error will be returned. The parameter passes the topic and the data payload. The data payload example: new { address = "", length = 0 } is essentially an anonymous object. | |
ReadRpcAsyncT(String, String) |
读取MQTT服务器注册的RPC接口,忽略返回的Topic数据,直接将结果转换为泛型对象,如果JSON转换失败,将返回错误,参数传递主题和数据负载,
数据负载示例:"{\"address\": \"100\",\"length\": 10}" 本质是一个字符串。 (继承自 MqttSyncClient。)Read the RPC interface registered by the MQTT server, ignore the returned Topic data, and directly convert the result into a generic object. If the JSON conversion fails, an error will be returned. The parameter passes the topic and the data payload. The data payload example: "{\"address\ ": \"100\",\"length\": 10}" is essentially a string. | |
ReadSessions |
读取服务器里当前的会话信息
(继承自 MqttSyncClient。) | |
ReadString(String, UInt16) |
读取字符串数据,默认为最常见的ASCII编码 Read string data, default is the most common ASCII encoding | |
ReadString(String, UInt16, Encoding) |
使用指定的编码,读取字符串数据 Reads string data using the specified encoding | |
ReadString(String, String, ActionInt64, Int64, ActionString, String, ActionInt64, Int64) |
从MQTT服务器同步读取数据,将指定编码的字符串payload发送到服务器,然后从服务器返回相关的数据,并转换为指定编码的字符串,支持数据发送进度报告,服务器执行进度报告,接收数据进度报告操作 (继承自 MqttSyncClient。)Synchronously read data from the MQTT server, send the specified encoded string payload to the server, and then return the data from the server, and convert it to the specified encoded string, support data transmission progress report, the server executes the progress report, and receives the data progress report | |
ReadStringAsync(String, UInt16) |
异步读取字符串数据,默认为最常见的ASCII编码 Asynchronously read string data, default is the most common ASCII encoding | |
ReadStringAsync(String, UInt16, Encoding) |
异步使用指定的编码,读取字符串数据 Asynchronously reads string data using the specified encoding | |
ReadStringAsync(String, String, ActionInt64, Int64, ActionString, String, ActionInt64, Int64) |
从MQTT服务器同步读取数据,将指定编码的字符串payload发送到服务器,然后从服务器返回相关的数据,并转换为指定编码的字符串,支持数据发送进度报告,服务器执行进度报告,接收数据进度报告操作 (继承自 MqttSyncClient。)Synchronously read data from the MQTT server, send the specified encoded string payload to the server, and then return the data from the server, and convert it to the specified encoded string, support data transmission progress report, the server executes the progress report, and receives the data progress report | |
ReadStructT |
读取结构体类型的数据,根据结构体自身的定义,读取原始字节数组,然后解析出实际的结构体数据,结构体需要实现HslStructAttribute特性
| |
ReadStructAsyncT |
读取结构体类型的数据,根据结构体自身的定义,读取原始字节数组,然后解析出实际的结构体数据,结构体需要实现HslStructAttribute特性
| |
ReadTopicPayload |
读取服务器的已经驻留的指定主题的消息内容 (继承自 MqttSyncClient。)Read the topic list of all messages that have resided on the server | |
ReadTopicPayloadAsync |
读取服务器的已经驻留的指定主题的消息内容 (继承自 MqttSyncClient。)Read the topic list of all messages that have resided on the server | |
ReadUInt16(String) |
读取16位的无符号整型 Read 16-bit unsigned integer | |
ReadUInt16(String, UInt16) |
读取16位的无符号整型数组 Read 16-bit unsigned integer array | |
ReadUInt16Async(String) |
异步读取16位的无符号整型 Asynchronously read 16-bit unsigned integer | |
ReadUInt16Async(String, UInt16) |
异步读取16位的无符号整型数组 Asynchronously read 16-bit unsigned integer array | |
ReadUInt32(String) |
读取32位的无符号整型 Read 32-bit unsigned integer | |
ReadUInt32(String, UInt16) |
读取32位的无符号整型数组 Read 32-bit unsigned integer array | |
ReadUInt32Async(String) |
异步读取32位的无符号整型 Asynchronously read 32-bit unsigned integer | |
ReadUInt32Async(String, UInt16) |
异步读取32位的无符号整型数组 Asynchronously read 32-bit unsigned integer array | |
ReadUInt64(String) |
读取64位的无符号整型 Read 64-bit unsigned integer | |
ReadUInt64(String, UInt16) |
读取64位的无符号整型的数组 Read 64-bit unsigned integer array | |
ReadUInt64Async(String) |
异步读取64位的无符号整型 Asynchronously read 64-bit unsigned integer | |
ReadUInt64Async(String, UInt16) |
异步读取64位的无符号整型的数组 Asynchronously read 64-bit unsigned integer array | |
RenameFolder |
[文件引擎] 重命名服务器上指定的路径信息,需要指定新的路径名称,当新的路径已经存在的时候,命名失败。 (继承自 MqttSyncClient。)[File Engine] Renames the specified path information on the server, you need to specify a new path name, and when the new path already exists, the naming fails. | |
RenameFolderAsync |
[文件引擎] 重命名服务器上指定的路径信息,需要指定新的路径名称,当新的路径已经存在的时候,命名失败。 (继承自 MqttSyncClient。)[File Engine] Renames the specified path information on the server, you need to specify a new path name, and when the new path already exists, the naming fails. | |
SetDtuPipe |
将当前的通信对象设置DTU模式,允许传入现成的管道,并返回初始化结果,如果该设备重写了握手报文,就是返回握手结果 (继承自 BinaryCommunication。)Set the current communication object to DTU mode, allow the existing pipe to be passed in, and return the initialization result, if the device rewrites the handshake packet, the handshake result is returned | |
SetDtuPipeAsync |
将当前的通信对象设置DTU模式,允许传入现成的管道,并返回初始化结果,如果该设备重写了握手报文,就是返回握手结果 (继承自 BinaryCommunication。)Set the current communication object to DTU mode, allow the existing pipe to be passed in, and return the initialization result, if the device rewrites the handshake packet, the handshake result is returned | |
ToString | Returns a string that represents the current object. (继承自 MqttSyncClient。) | |
UnpackResponseContent |
根据对方返回的报文命令,对命令进行基本的拆包,例如各种Modbus协议拆包为统一的核心报文,还支持对报文的验证 (继承自 BinaryCommunication。)According to the message command returned by the other party, the command is basically unpacked, for example, various Modbus protocols are unpacked into a unified core message, and the verification of the message is also supported | |
UploadFile(String, String, String, ActionInt64, Int64, HslCancelToken) |
[文件引擎] 上传文件给服务器,需要指定上传文件的路径信息(服务器保存的名称就是文件名),以及上传到服务器的分类信息,支持进度汇报功能。 (继承自 MqttSyncClient。)[File Engine] To upload a file to the server, you need to specify the path information of the uploaded file (the name saved by the server is the file name), as well as the classification information uploaded to the server, to support the progress report function. | |
UploadFile(Bitmap, String, String, String, ActionInt64, Int64, HslCancelToken) |
[文件引擎] 上传一个Bitmap图片对象到服务器指定的分类下面,需要指定分类信息,服务器保存的文件名,描述信息,支持进度报告 (继承自 MqttSyncClient。)[File Engine] Upload a Bitmap image object to the category specified by the server, you need to specify the category information, the file name saved by the server, description information, and support for progress reports | |
UploadFile(Stream, String, String, String, ActionInt64, Int64, HslCancelToken) |
[文件引擎] 上传流给服务器,需要指定流,服务器保存的名字,以及上传到服务器的分类信息,支持进度汇报功能。 (继承自 MqttSyncClient。)[File Engine] To upload a stream to the server, you need to specify the stream, the name saved by the server, and the classification information uploaded to the server to support the progress reporting function. | |
UploadFile(String, String, String, String, ActionInt64, Int64, HslCancelToken) |
[文件引擎] 上传文件给服务器,需要指定上传文件的路径信息,服务器保存的名字,以及上传到服务器的分类信息,支持进度汇报功能。 (继承自 MqttSyncClient。)[File Engine] To upload a file to the server, you need to specify the path information of the uploaded file, the name saved by the server, and the classification information uploaded to the server to support the progress report function. | |
UploadFileAsync(String, String, String, ActionInt64, Int64, HslCancelToken) |
[文件引擎] 上传文件给服务器,需要指定上传文件的路径信息(服务器保存的名称就是文件名),以及上传到服务器的分类信息,支持进度汇报功能。 (继承自 MqttSyncClient。)[File Engine] To upload a file to the server, you need to specify the path information of the uploaded file (the name saved by the server is the file name), as well as the classification information uploaded to the server, to support the progress report function. | |
UploadFileAsync(Bitmap, String, String, String, ActionInt64, Int64, HslCancelToken) |
[文件引擎] 上传一个Bitmap图片对象到服务器指定的分类下面,需要指定分类信息,服务器保存的文件名,描述信息,支持进度报告 (继承自 MqttSyncClient。)[File Engine] Upload a Bitmap image object to the category specified by the server, you need to specify the category information, the file name saved by the server, description information, and support for progress reports | |
UploadFileAsync(Stream, String, String, String, ActionInt64, Int64, HslCancelToken) |
[文件引擎] 上传流给服务器,需要指定流,服务器保存的名字,以及上传到服务器的分类信息,支持进度汇报功能。 (继承自 MqttSyncClient。)[File Engine] To upload a stream to the server, you need to specify the stream, the name saved by the server, and the classification information uploaded to the server to support the progress reporting function. | |
UploadFileAsync(String, String, String, String, ActionInt64, Int64, HslCancelToken) |
[文件引擎] 上传文件给服务器,需要指定上传文件的路径信息,服务器保存的名字,以及上传到服务器的分类信息,支持进度汇报功能。 (继承自 MqttSyncClient。)[File Engine] To upload a file to the server, you need to specify the path information of the uploaded file, the name saved by the server, and the classification information uploaded to the server to support the progress report function. | |
Wait(String, Boolean, Int32, Int32) |
等待指定地址的Boolean值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the Boolean value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
Wait(String, Int16, Int32, Int32) |
等待指定地址的Int16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the Int16 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
Wait(String, Int32, Int32, Int32) |
等待指定地址的Int32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the Int32 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
Wait(String, Int64, Int32, Int32) |
等待指定地址的Int64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the Int64 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
Wait(String, UInt16, Int32, Int32) |
等待指定地址的UInt16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the UInt16 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
Wait(String, UInt32, Int32, Int32) |
等待指定地址的UInt32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the UInt32 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
Wait(String, UInt64, Int32, Int32) |
等待指定地址的UInt64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the UInt64 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
WaitAsync(String, Boolean, Int32, Int32) |
等待指定地址的Boolean值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the Boolean value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
WaitAsync(String, Int16, Int32, Int32) |
等待指定地址的Int16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the Int16 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
WaitAsync(String, Int32, Int32, Int32) |
等待指定地址的Int32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the Int32 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
WaitAsync(String, Int64, Int32, Int32) |
等待指定地址的Int64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the Int64 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
WaitAsync(String, UInt16, Int32, Int32) |
等待指定地址的UInt16值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the UInt16 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
WaitAsync(String, UInt32, Int32, Int32) |
等待指定地址的UInt32值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the UInt32 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
WaitAsync(String, UInt64, Int32, Int32) |
等待指定地址的UInt64值为指定的值,可以指定刷新数据的频率,等待的超时时间,如果超时时间为-1的话,则是无期限等待。 Waiting for the UInt64 value of the specified address to be the specified value, you can specify the frequency of refreshing the data, and the timeout time to wait. If the timeout time is -1, it is an indefinite wait. | |
Write(String, Boolean) |
写入单个的Boolean数据,返回是否成功 Write a single Boolean data, and return whether the write was successful | |
Write(String, Boolean) |
批量写入Boolean数组数据,返回是否成功 Batch write Boolean array data, return whether the write was successful | |
Write(String, Byte) |
写入原始的byte数组数据到指定的地址,返回是否写入成功 Write the original byte array data to the specified address, and return whether the write was successful | |
Write(String, Double) |
写入double数据,返回是否成功 Write double data, return whether the write was successful | |
Write(String, Double) |
写入double数组,返回是否成功 Write double array, return whether the write was successful | |
Write(String, Int16) |
写入short数据,返回是否成功 Write short data, returns whether success | |
Write(String, Int16) |
写入short数组,返回是否成功 Write short array, return whether the write was successful | |
Write(String, Int32) |
写入int数据,返回是否成功 Write int data, return whether the write was successful | |
Write(String, Int32) |
写入int[]数组,返回是否成功 Write int array, return whether the write was successful | |
Write(String, Int64) |
写入long数据,返回是否成功 Write long data, return whether the write was successful | |
Write(String, Int64) |
写入long数组,返回是否成功 Write long array, return whether the write was successful | |
Write(String, Single) |
写入float数据,返回是否成功 Write float data, return whether the write was successful | |
Write(String, Single) |
写入float数组,返回是否成功 Write float array, return whether the write was successful | |
Write(String, String) |
写入字符串信息,编码为ASCII Write string information, encoded as ASCII | |
Write(String, UInt16) |
写入ushort数据,返回是否成功 Write ushort data, return whether the write was successful | |
Write(String, UInt16) |
写入ushort数组,返回是否成功 Write ushort array, return whether the write was successful | |
Write(String, UInt32) |
写入uint数据,返回是否成功 Write uint data, return whether the write was successful | |
Write(String, UInt32) |
写入uint[]数组,返回是否成功 Write uint array, return whether the write was successful | |
Write(String, UInt64) |
写入ulong数据,返回是否成功 Write ulong data, return whether the write was successful | |
Write(String, UInt64) |
写入ulong数组,返回是否成功 Write ulong array, return whether the write was successful | |
Write(String, String, Int32) |
写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为ASCII Write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, it is filled with 0 and the encoding is ASCII. | |
Write(String, String, Encoding) |
写入字符串信息,需要指定的编码信息 Write string information, need to specify the encoding information | |
Write(String, String, Int32, Encoding) |
写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为指定的编码信息 Write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, then the operation is complemented with 0 , you should specified the encoding information | |
WriteT(T) |
写入支持Hsl特性的数据,返回是否写入成功,该特性为HslDeviceAddressAttribute,详细参考api文档说明 Write data that supports the Hsl attribute, and return whether the write was successful. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details. | |
WriteAsync(String, Boolean) |
异步批量写入Boolean数组数据,返回是否成功 Asynchronously batch write Boolean array data, return success | |
WriteAsync(String, Boolean) |
异步批量写入Boolean数组数据,返回是否成功 Asynchronously batch write Boolean array data, return success | |
WriteAsync(String, Byte) |
异步写入原始的byte数组数据到指定的地址,返回是否写入成功 Asynchronously writes the original byte array data to the specified address, and returns whether the write was successful | |
WriteAsync(String, Double) |
异步写入double数据,返回是否成功 Asynchronously write double data, return whether the write was successful | |
WriteAsync(String, Double) |
异步写入double数组,返回是否成功 Asynchronously write double array, return whether the write was successful | |
WriteAsync(String, Int16) |
异步写入short数据,返回是否成功 Asynchronously write short data, returns whether success | |
WriteAsync(String, Int16) |
异步写入short数组,返回是否成功 Asynchronously write short array, return whether the write was successful | |
WriteAsync(String, Int32) |
异步写入int数据,返回是否成功 Asynchronously write int data, return whether the write was successful | |
WriteAsync(String, Int32) |
异步写入int[]数组,返回是否成功 Asynchronously write int array, return whether the write was successful | |
WriteAsync(String, Int64) |
异步写入long数据,返回是否成功 Asynchronously write long data, return whether the write was successful | |
WriteAsync(String, Int64) |
异步写入long数组,返回是否成功 Asynchronously write long array, return whether the write was successful | |
WriteAsync(String, Single) |
异步写入float数据,返回是否成功 Asynchronously write float data, return whether the write was successful | |
WriteAsync(String, Single) |
异步写入float数组,返回是否成功 Asynchronously write float array, return whether the write was successful | |
WriteAsync(String, String) |
异步写入字符串信息,编码为ASCII Asynchronously write string information, encoded as ASCII | |
WriteAsync(String, UInt16) |
异步写入ushort数据,返回是否成功 Asynchronously write ushort data, return whether the write was successful | |
WriteAsync(String, UInt16) |
异步写入ushort数组,返回是否成功 Asynchronously write ushort array, return whether the write was successful | |
WriteAsync(String, UInt32) |
异步写入uint数据,返回是否成功 Asynchronously write uint data, return whether the write was successful | |
WriteAsync(String, UInt32) |
异步写入uint[]数组,返回是否成功 Asynchronously write uint array, return whether the write was successful | |
WriteAsync(String, UInt64) |
异步写入ulong数据,返回是否成功 Asynchronously write ulong data, return whether the write was successful | |
WriteAsync(String, UInt64) |
异步写入ulong数组,返回是否成功 Asynchronously write ulong array, return whether the write was successful | |
WriteAsync(String, String, Int32) |
异步写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为ASCII Asynchronously write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, it is filled with 0 and the encoding is ASCII. | |
WriteAsync(String, String, Encoding) |
异步写入字符串信息,需要指定的编码信息 Asynchronously write string information, need to specify the encoding information | |
WriteAsync(String, String, Int32, Encoding) |
异步写入指定长度的字符串信息,如果超出,就截断字符串,如果长度不足,那就补0操作,编码为指定的编码信息 Asynchronously write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, then the operation is complemented with 0 , you should specified the encoding information | |
WriteAsyncT(T) |
异步写入支持Hsl特性的数据,返回是否写入成功,该特性为HslDeviceAddressAttribute,详细参考api文档说明 Asynchronously write data that supports the Hsl attribute, and return whether the write was successful. The attribute is HslDeviceAddressAttribute, please refer to the api documentation for details. | |
WriteCustomerT |
写入自定义类型的数据,该类型必须继承自IDataTransfer接口 Write data of a custom type, which must inherit from the IDataTransfer interface | |
WriteCustomerAsyncT |
写入自定义类型的数据,该类型必须继承自IDataTransfer接口 Write data of a custom type, which must inherit from the IDataTransfer interface |
名称 | 说明 | |
---|---|---|
LogMsgFormatBinary |
设置日志记录报文是否二进制,如果为False,那就使用ASCII码 (继承自 BinaryCommunication。)Set whether the log message is binary, if it is False, then use ASCII code |
名称 | 说明 | |
---|---|---|
ToJsonString |
获取当前对象的JSON格式表示的字符串。 (由 HslExtension 定义。)Gets the string represented by the JSON format of the current object. |
// 以下是举例子,将两个PLC和一个Modbus的对象注册为RPC接口 private MqttServer server; private MelsecMcNet melsec; private SiemensS7Net siemens; private ModbusRtu modbus; public void Start( ) { melsec = new MelsecMcNet( "192.168.0.100", 6000 ); // ip及端口需要改成你自己实际的参数 siemens = new SiemensS7Net( SiemensPLCS.S1200, "192.168.0.101" ); // ip需要改成你自己实际的参数 modbus = new ModbusRtu( 1 ); // 指定站号实例化 modbus.SerialPortInni( "COM2", 9600 ); // 初始化串口信息 modbus.DataFormat = HslCommunication.Core.DataFormat.CDAB; // 根据实际情况设置 server = new MqttServer( ); server.ClientVerification += Server_ClientVerification; // 启动账户密码,如果不需要验证,则注释即可 server.RegisterMqttRpcApi( "MelsecPLC", melsec ); // API分类随便写,方便客户端指定就行,需要唯一 server.RegisterMqttRpcApi( "SiemensPLC", siemens ); // API分类随便写,方便客户端指定就行,需要唯一 server.RegisterMqttRpcApi( "Modbus", modbus ); // API分类随便写,方便客户端指定就行,需要唯一 server.ServerStart( 1883 ); // 启动服务 } private int Server_ClientVerification( MqttSession mqttSession, string clientId, string userName, string passwrod ) { // 这里举例只能账户密码登录 // if (userName == "admin" && passwrod == "123456") return 0; // else return 1; //不校验用户名密码 return 0; }
// 我们接下来在客户端访问当前的数据信息 private MqttRpcDevice rpcMelsec = new MqttRpcDevice( new MqttConnectionOptions( ) { IpAddress = "127.0.0.1", // 服务器的IP地址 Port = 1883, Credentials = new MqttCredential( "admin", "123456" ), // 如果配置了用户名密码 UseRSAProvider = true, // 是否加密通信 }, "MelsecPLC" ); private MqttRpcDevice rpcSiemens = new MqttRpcDevice( new MqttConnectionOptions( ) { IpAddress = "127.0.0.1", // 服务器的IP地址 Port = 1883, Credentials = new MqttCredential( "admin", "123456" ), // 如果配置了用户名密码 UseRSAProvider = true, // 是否加密通信 }, "SiemensPLC" ); private MqttRpcDevice rpcModbus = new MqttRpcDevice( new MqttConnectionOptions( ) { IpAddress = "127.0.0.1", // 服务器的IP地址 Port = 1883, Credentials = new MqttCredential( "admin", "123456" ), // 如果配置了用户名密码 UseRSAProvider = true, // 是否加密通信 }, "Modbus" ); public void Example( ) { // 就可以进行读取了,例如读取三菱设备的D100的short值 OperateResult<short> read1 = rpcMelsec.ReadInt16( "D100" ); OperateResult write1 = rpcMelsec.Write( "D100", (short)123 ); // 例如读取西门设备的float值 OperateResult<float> read2 = rpcSiemens.ReadFloat( "M100" ); OperateResult write2 = rpcSiemens.Write( "M100", 1.23f ); // Modbus设备读取int值 OperateResult<int> read3 = rpcModbus.ReadInt32( "100" ); OperateResult write3 = rpcModbus.Write( "100", 123 ); // 用法上和普通的三菱,西门子,modbus是没有区别的。 }