Skip to content

Latest commit

 

History

History
130 lines (88 loc) · 4.59 KB

VI Description(en) - 05. Module Operation API.md

File metadata and controls

130 lines (88 loc) · 4.59 KB
Raw

CSM API

Module Operation API

CSM - Wait for Module to Be Alive.vi

Wait for the CSM module to come online within the specified timeout period.

-- Controls --

  • CSM Name: CSM module name
  • Wait(5000ms): Wait timeout, default is 5s

-- Indicators --

  • CSM Name(dup): CSM module name
  • Waited(ms): Time waited

CSM - Wait for All Modules to be Alive.vi

Wait for a group of CSM modules to come online within the specified timeout period.

-- Controls --

  • CSM Names: CSM module names
  • Timeout(5000ms): Wait timeout, default is 5s

-- Indicators --

  • CSMs Left: CSM modules that did not come online within the timeout period
  • Waited(ms): Time waited

CSM - Wait for All Modules to Exit.vi

Wait for a group of CSM modules to go offline within the specified timeout period, usually used for program exit.

-- Controls --

  • CSM Names: CSM module names
  • Timeout(5000ms): Wait timeout, default is 5s

-- Indicators --

  • CSMs Left: CSM modules that did not go offline within the timeout period
  • Waited(ms): Time waited

CSM - Post Message.vi

Send an asynchronous message to the CSM without waiting for a return, and continue executing the subsequent code.

-- Controls --

  • CSM Name: CSM module name
  • State: Message string
  • Arguments(""): Message parameters
  • Current Module("" to generate an ID): Current module name. If not provided, a temporary ID is generated for debugging purposes.

CSM - Wait and Post Message.vi

Send an asynchronous message to the CSM without waiting for a return, and continue executing the subsequent code. If the CSM module is not online, it will wait for the specified time.

-- Controls --

  • CSM Name: CSM module name
  • State: Message string
  • Arguments(""): Message parameters
  • Current Module("" to generate an ID): Current module name. If not provided, a temporary ID is generated for debugging purposes.
  • Wait(5000ms): Wait timeout, default is 5s

CSM - Send Message and Wait for Reply.vi

Send a synchronous message to the CSM and wait for a return message. If the return message is not received within the timeout period, a timeout error is returned.

-- Controls --

  • Target Module: Target CSM module name
  • State: Message string
  • Arguments(""): Message parameters
  • Response Timeout(5000ms): Timeout setting for waiting for the return message, default is 5000ms.

-- Indicators --

  • Response: Returned response

CSM - Wait and Send Message for Reply.vi

Send a synchronous message to the CSM and wait for a return message. If the return message is not received within the timeout period, a timeout error is returned. If the CSM module is not online, it will wait for the specified time.

-- Controls --

  • CSM Name: CSM module name
  • State: Message string
  • Arguments(""): Message parameters
  • Response Timeout(5000ms): Timeout setting for waiting for the return message, default is 5000ms.
  • Current Module("" to generate an ID): Current module name. If not provided, a temporary ID is generated for debugging purposes.
  • Wait(5000ms): Wait timeout, default is 5s

-- Indicators --

  • Response: Returned response
  • Source CSM: Source CSM module name of the returned response

CSM - Run Script.vi

Run a CSM script. Multiple message instructions can be executed at once.

-- Controls --

  • CSM Scripts: Scripts to be run
  • Response Timeout(5000ms): Timeout setting for waiting for the return message, default is 5000ms.
  • Continue If Error?(F): Whether to continue execution if an error occurs
  • Current Module("" to generate an ID): Current module name. If not provided, a temporary ID is generated for debugging purposes.
  • Wait(5000ms): Wait timeout, default is 5s

-- Indicators --

  • Scripts Left: Remaining scripts that were not executed

CSM - Status Change Event.vi

Get the CSM status change event handle.

-- Controls --

  • CSM Module: CSM module name

-- Indicators --

  • Status Change Event: CSM status change event handle

CSM - Destroy Status Change Event.vi

Release the CSM status change event handle.

-- Controls --

  • Status Change Event: CSM status change event handle

CSM - Module Exit Event.vi

Get the CSM module exit event handle.

-- Controls --

  • CSM Module: CSM module name

-- Indicators --

  • CSM Exit Event: CSM module exit event handle