Send Command VI

NI-Industrial Communications for IEC 61850 15.0 Help

Edition Date: December 2015

Part Number: 373800D-01

»View Product Info
Download Help (Windows Only)

Owning Palette: MMS Client VIs

Sends a command to a remote server. This VI also returns the response from the remote server. You must manually select the polymorphic instance to use.

When you send the Initiate command to a server, the client and server negotiate parameter values.

Details  Example

Use the pull-down menu to select an instance of this VI.

Send Initiate

remote server in specifies the refnum of a remote server to which you want to send the command.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
error out contains error information. This output provides standard error out functionality.

Send Conclude

Note Note  If the command fails, the client aborts the association to the remote server.

remote server in specifies the refnum of a remote server to which you want to send the command.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
error out contains error information. This output provides standard error out functionality.

Send Browse

Note Note  This VI sends the browse command to the remote server. This VI gets addresses and attributes of points and data sets from the remote server and stores the information locally. Use the Get Addresses VI to read the information.

remote server in specifies the refnum of a remote server to which you want to send the command.
scope specifies the type of items that you want to browse.

0Point And Dataset (default)
1Dataset Only
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server. If the server contains a large number of files, this VI may send multiple commands to get all files. If this VI sends multiple commands, the timeout value applies to each commands. For example, if timeout is 5 seconds and the VI sends three commands, each command has a timeout value of 5 seconds.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
error out contains error information. This output provides standard error out functionality.

Send Identify

remote server in specifies the refnum of a remote server to which you want to send the command.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
identification returns the identification information of the server.
vendor returns the vendor name of the server.
model returns the model name of the server.
revision returns the revision of the server.
error out contains error information. This output provides standard error out functionality.

Send DefineNamedVariableList

remote server in specifies the refnum of a remote server to which you want to send the command.
dataset address specifies the MMS address of the data set to which you want to add the client points.
point addresses specifies the MMS addresses of the client points that you want to add to the data set.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
error out contains error information. This output provides standard error out functionality.

Send DeletedNamedVariableList

remote server in specifies the refnum of a remote server to which you want to send the command.
dataset addresses specifies the MMS addresses of the data sets that you want to delete.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
error out contains error information. This output provides standard error out functionality.

Send FileDirectory

remote server in specifies the refnum of a remote server to which you want to send the command.
root directory specifies the path that you want to browse on the server. If you specify an empty path, this VI browses the root path of the server.
LabVIEW formats the path using the standard syntax for the platform you are using. NI recommends that you use the Send FileDirectory (String) instance to avoid unexpected path formatting.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server. If the server contains a large number of files, this VI may send multiple commands to get all files. If this VI sends multiple commands, the timeout value applies to each commands. For example, if timeout is 5 seconds and the VI sends three commands, each command has a timeout value of 5 seconds.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
files returns the folders and files under root directory on the server.
name returns the name of the file or folder.
file size returns the size of the file.
last modified time returns the GeneralizedTime when the file or folder was edited. Refer to the ASN.1 standard for the definition of the GeneralizedTime.
folder? returns whether this item is a folder or not.
error out contains error information. This output provides standard error out functionality.

Send FileDirectory (String)

remote server in specifies the refnum of a remote server to which you want to send the command.
root directory specifies the path that you want to browse on the server. If you specify an empty path, this VI browses the root path of the server.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server. If the server contains a large number of files, this VI may send multiple commands to get all files. If this VI sends multiple commands, the timeout value applies to each commands. For example, if timeout is 5 seconds and the VI sends three commands, each command has a timeout value of 5 seconds.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
files returns the folders and files under root directory on the server.
name returns the name of the file or folder.
file size returns the size of the file.
last modified time returns the GeneralizedTime when the file or folder was edited. Refer to the ASN.1 standard for the definition of the GeneralizedTime.
folder? returns whether this item is a folder or not.
error out contains error information. This output provides standard error out functionality.

Send FileGet

remote server in specifies the refnum of a remote server to which you want to send the command.
remote file path specifies the path of the file that you want to download from the server.
LabVIEW formats the path using the standard syntax for the platform you are using. NI recommends that you use the Send FileGet (String) instance to avoid unexpected path formatting.
local file path specifies the location where you want to save the file.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server. If the server contains a large number of files, this VI may send multiple commands to get all files. If this VI sends multiple commands, the timeout value applies to each commands. For example, if timeout is 5 seconds and the VI sends three commands, each command has a timeout value of 5 seconds.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
error out contains error information. This output provides standard error out functionality.

Send FileGet (String)

remote server in specifies the refnum of a remote server to which you want to send the command.
remote file path specifies the path of the file that you want to download from the server.
local file path specifies the location where you want to save the file.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server. If the server contains a large number of files, this VI may send multiple commands to get all files. If this VI sends multiple commands, the timeout value applies to each commands. For example, if timeout is 5 seconds and the VI sends three commands, each command has a timeout value of 5 seconds.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
error out contains error information. This output provides standard error out functionality.

Send FileDelete

remote server in specifies the refnum of a remote server to which you want to send the command.
remote file path specifies the path of the file that you want to remove from the server.
LabVIEW formats the path using the standard syntax for the platform you are using. NI recommends that you use the Send FileDelete (String) instance to avoid unexpected path formatting.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
error out contains error information. This output provides standard error out functionality.

Send FileDelete (String)

remote server in specifies the refnum of a remote server to which you want to send the command.
remote file path specifies the path of the file that you want to remove from the server.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
timeout specifies the timeout value. The default is System Timeout. You can set the system timeout value by using the Misc:System Timeout property of the remote server.
remote server out returns the refnum of the remote server.
response returns the response from the remote server.
type returns the type of the response.

0No Response
1Response
2Confirmed Error
3Reject Error
4Timeout
code returns a confirmed service error code or reject code of the response.
error out contains error information. This output provides standard error out functionality.

Send Command Details

Related Information

MMS Command Responses

MMS Address Format

Example

Refer to the IEC61850 MMS Client.lvproj in the labview\examples\IEC61850\Client directory for an example of using the Send Command VI.

WAS THIS ARTICLE HELPFUL?

Not Helpful