CSM-TCP-Router.vipb

<VI_Package_Builder_Settings Version="2020.1" Created_Date="2023-09-27 14:21:53" Modified_Date="2025-02-28 15:22:55" Creator="liyao" Comments="" ID="87a1501566075aebed5513952fe62c41">
  <Library_General_Settings>
    <Package_File_Name>NEVSTOP_lib_CSM_TCP_Router_Example</Package_File_Name>
    <Library_Version>2025.2.0.2</Library_Version>
    <Auto_Increment_Version>false</Auto_Increment_Version>
    <Library_Source_Folder>src</Library_Source_Folder>
    <Library_Output_Folder>vip</Library_Output_Folder>
    <Company_Name>NEVSTOP</Company_Name>
    <Library_Summary/>
    <Library_License>Apache-2.0</Library_License>
    <Package_LabVIEW_Version>20.0</Package_LabVIEW_Version>
    <Community_Edition>true</Community_Edition>
    <Package_Icon>00000D7E002800000C9A00000400000200020022002200080000000000FFFFFF00FF80000000FFFFFFFFFFFF0000FFFFFFFFCCCC0000FFFFFFFF99990000FFFFFFFF66660000FFFFFFFF33330000FFFFFFFF00000000FFFFCCCCFFFF0000FFFFCCCCCCCC0000FFFFCCCC99990000FFFFCCCC66660000FFFFCCCC33330000FFFFCCCC00000000FFFF9999FFFF0000FFFF9999CCCC0000FFFF999999990000FFFF999966660000FFFF999933330000FFFF999900000000FFFF6666FFFF0000FFFF6666CCCC0000FFFF666699990000FFFF666666660000FFFF666633330000FFFF666600000000FFFF3333FFFF0000FFFF3333CCCC0000FFFF333399990000FFFF333366660000FFFF333333330000FFFF333300000000FFFF0000FFFF0000FFFF0000CCCC0000FFFF000099990000FFFF000066660000FFFF000033330000FFFF000000000000CCCCFFFFFFFF0000CCCCFFFFCCCC0000CCCCFFFF99990000CCCCFFFF66660000CCCCFFFF33330000CCCCFFFF00000000CCCCCCCCFFFF0000CCCCCCCCCCCC0000CCCCCCCC99990000CCCCCCCC66660000CCCCCCCC33330000CCCCCCCC00000000CCCC9999FFFF0000CCCC9999CCCC0000CCCC999999990000CCCC999966660000CCCC999933330000CCCC999900000000CCCC6666FFFF0000CCCC6666CCCC0000CCCC666699990000CCCC666666660000CCCC666633330000CCCC666600000000CCCC3333FFFF0000CCCC3333CCCC0000CCCC333399990000CCCC333366660000CCCC333333330000CCCC333300000000CCCC0000FFFF0000CCCC0000CCCC0000CCCC000099990000CCCC000066660000CCCC000033330000CCCC0000000000009999FFFFFFFF00009999FFFFCCCC00009999FFFF999900009999FFFF666600009999FFFF333300009999FFFF000000009999CCCCFFFF00009999CCCCCCCC00009999CCCC999900009999CCCC666600009999CCCC333300009999CCCC0000000099999999FFFF000099999999CCCC0000999999999999000099999999666600009999999933330000999999990000000099996666FFFF000099996666CCCC0000999966669999000099996666666600009999666633330000999966660000000099993333FFFF000099993333CCCC0000999933339999000099993333666600009999333333330000999933330000000099990000FFFF000099990000CCCC000099990000999900009999000066660000999900003333000099990000000000006666FFFFFFFF00006666FFFFCCCC00006666FFFF999900006666FFFF666600006666FFFF333300006666FFFF000000006666CCCCFFFF00006666CCCCCCCC00006666CCCC999900006666CCCC666600006666CCCC333300006666CCCC0000000066669999FFFF000066669999CCCC0000666699999999000066669999666600006666999933330000666699990000000066666666FFFF000066666666CCCC0000666666669999000066666666666600006666666633330000666666660000000066663333FFFF000066663333CCCC0000666633339999000066663333666600006666333333330000666633330000000066660000FFFF000066660000CCCC000066660000999900006666000066660000666600003333000066660000000000003333FFFFFFFF00003333FFFFCCCC00003333FFFF999900003333FFFF666600003333FFFF333300003333FFFF000000003333CCCCFFFF00003333CCCCCCCC00003333CCCC999900003333CCCC666600003333CCCC333300003333CCCC0000000033339999FFFF000033339999CCCC0000333399999999000033339999666600003333999933330000333399990000000033336666FFFF000033336666CCCC0000333366669999000033336666666600003333666633330000333366660000000033333333FFFF000033333333CCCC0000333333339999000033333333666600003333333333330000333333330000000033330000FFFF000033330000CCCC000033330000999900003333000066660000333300003333000033330000000000000000FFFFFFFF00000000FFFFCCCC00000000FFFF999900000000FFFF666600000000FFFF333300000000FFFF000000000000CCCCFFFF00000000CCCCCCCC00000000CCCC999900000000CCCC666600000000CCCC333300000000CCCC0000000000009999FFFF000000009999CCCC0000000099999999000000009999666600000000999933330000000099990000000000006666FFFF000000006666CCCC0000000066669999000000006666666600000000666633330000000066660000000000003333FFFF000000003333CCCC0000000033339999000000003333666600000000333333330000000033330000000000000000FFFF000000000000CCCC0000000000009999000000000000666600000000000033330000EEEE000000000000DDDD000000000000BBBB000000000000AAAA0000000000008888000000000000777700000000000055550000000000004444000000000000222200000000000011110000000000000000EEEE000000000000DDDD000000000000BBBB000000000000AAAA0000000000008888000000000000777700000000000055550000000000004444000000000000222200000000000011110000000000000000EEEE000000000000DDDD000000000000BBBB000000000000AAAA0000000000008888000000000000777700000000000055550000000000004444000000000000222200000000000011110000EEEEEEEEEEEE0000DDDDDDDDDDDD0000BBBBBBBBBBBB0000AAAAAAAAAAAA000088888888888800007777777777770000555555555555000044444444444400002222222222220000111111111111000000000000000000F881818181818181818181818181818181818181818181818181818181F800F8817575757575757575757575757575757575757575757575757575757581F88100000000000000000000000000000000000000000000000000000000000081810000000000000000000000000000000000000000000000000000000000008181000000000000000000000000000000000000000000000000000000000000818100C5C5C5C5C5C5C5C5C5C5C5C5C5C5C5C5C5000000000000000000000000818100C5C50000C5C5C5000000C500C5C5C500C5000000000000000000000000818100C500C5C500C500C5C5C5C50000C50000C5000000000000000000000000818100C500C5C5C5C5C50000C5C500C500C500C5000000C9C9C9C9C900000000818100C500C5C500C5C5C5C500C500C5C5C500C50000C90000000000C9000000818100C5C50000C5C5000000C5C500C5C5C500C500C90000C9C9C90000C90000818100C5C5C5C5C5C5C5C5C5C5C5C5C5C5C5C5C5000000C9000000C900C900008181000000002BFF2B2B2B0000002BFF2B2B2B00000000C9000000C900C9000081810000000000FF2B000000000000FF2B00000000000000C90000C900C900008181000000FFFFFFFFFFFFFFFFFFFFFFFFFF000000000000C900C90000C900008181000000002B2B2B2B2BFF2B2B2B2B2B2B2B00000000C900C90000C90000008181000000000000000000FF2B00000000000000000000C9C90000C900000000818100000000000000C9C9C9C9C900000000C900000000000000C90000000000818100000000000000C9C9C9C9C92B00000000C90000C90000C9000000000000818100000000000000C9C9C9C9C92BC9C9C9C9C9C900C90000C9000000000000818100000000000000C9C9C9C9C92B00000000C9000000C9C900000000000000818100000000000000C9C9C9C9C92B000000C900000000000000000000000000818100000000000000002B2B2B2B2B000000000000000000000000000000000081810000000000C9C9000000000000000000000000000000000000000000000081810000000000C900C9000000000000000000C900000000000000000000000081810000000000C9C90000C9C9C900C900C900C9C90000C90000C9C90000000081810000000000C900C900C900C900C900C900C90000C900C900C9000000000081810000000000C900C900C9C9C90000C9C90000C900C9C90000C9000000000081810000000000000000000000000000000000000000000000000000000000008181F600000000000000000000000000000000000000000000000000000000F681F881F60000000000000000000000000000000000000000000000000000F681F800F881818181818181818181818181818181818181818181818181818181F8007FFFFFFEFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF7FFFFFFE002900000012000000020000000D01000000000100000000000A000000080000000000240024002900000012000000020000000D00FAFAFA00010000000000100000001000000002002300000000000000000023002900000012000000020000000D00FFFFFF00010000000000100000001000000002002200010001000100010022002900000012000000020000000D00FAFAFA00010000000000100000001000000002000000240024002400240000002900000012000000020000000D00F8F8F800010000000000100000001000000002000100230023002300230001</Package_Icon>
    <Product_Name>CSM TCP Router Example</Product_Name>
    <Was_Built>true</Was_Built>
    <Target>LabVIEW</Target>
  </Library_General_Settings>
  <Advanced_Settings>
    <Package_Dependencies>
      <Additional_External_Dependencies>jki_lib_tcp_server &gt;=5.0.0.8</Additional_External_Dependencies>
      <Additional_External_Dependencies>nevstop_lib_communicable_state_machine &gt;=2025.2.28.95859</Additional_External_Dependencies>
      <Additional_External_Dependencies>nevstop_lib_csm_api_string_arguments_support &gt;=2025.1.27.145038</Additional_External_Dependencies>
      <Additional_External_Dependencies>nevstop_lib_csm_ini_static_variable_support &gt;=2025.2.28.100053</Additional_External_Dependencies>
      <Additional_External_Dependencies>nevstop_lib_csm_massdata_parameter_support &gt;=2024.12.31.84154</Additional_External_Dependencies>
      <Additional_External_Dependencies>nevstop_lib_globalstop &gt;=2022.12.12.102654</Additional_External_Dependencies>
      <Additional_External_Dependencies>oglib_error &gt;=4.2.0.23</Additional_External_Dependencies>
      <Additional_External_Dependencies>oglib_time &gt;=4.0.1.3</Additional_External_Dependencies>
    </Package_Dependencies>
    <Custom_Action_VIs>
      <Pre-Build_VI/>
      <Post-Build_VI/>
      <Pre-Install_VI/>
      <Post-Install_VI/>
      <Pre-Uninstall_VI/>
      <Post-Uninstall_VI/>
    </Custom_Action_VIs>
    <VI_Package_Configuration_File>CSM-TCP-Router.vipc</VI_Package_Configuration_File>
    <Description>
      <One_Line_Description_Summary>Application Example to show how to setup a TCP Server and Client using CSM and JKI TCP Server.</One_Line_Description_Summary>
      <Description>This repository demonstrates how to create a reusable TCP communication layer (CSM-TCP-Router) to turn a local program into a TCP server for remote control. This example showcases the advantages of the CSM framework's invisible bus.

## Features

- All CSM messages that can be sent locally can be transmitted to the local program via TCP connection using CSM synchronous and asynchronous message formats.
- Based on the JKI-TCP-Server library, it supports multiple TCP clients connecting simultaneously.
- [client] Provides a standard TCP client that can connect to the server to verify remote connections and message sending.

&gt; [!IMPORTANT]
&gt; `TCP Packet Format:` | Data Length (4 bytes) | CSM Command String (plain text) |

&gt; [!NOTE]
&gt; Example: Suppose there is a CSM module named DAQmx locally with an interface "API: Start Sampling".
&gt; Locally, we can send messages to this module to control the start and stop of sampling:
&gt;
&gt; - API: Start Sampling -@ DAQmx // Synchronous message
&gt; - API: Start Sampling -&gt; DAQmx // Asynchronous message
&gt; - API: Start Sampling -&gt;| DAQmx // Asynchronous message without return
&gt;
&gt; Now, by sending the same text message via TCP connection, remote control can be achieved.

&gt; [!WARNING]
&gt; Currently, CSM-TCP-Router only supports synchronous messages (-@) and asynchronous messages without return (-&gt;|). Asynchronous messages (-&gt;) will be treated as asynchronous messages without return.

## Usage

1. Install this tool and dependencies via VIPM
2. Open the example project CSM-TCP-Router.lvproj in the CSM examples
3. Start the CSM-TCP-Router(Server).vi in the code project
4. Start Client.vi, enter the server's IP address and port number, and click connect
5. Enter commands and click send to see the returned messages in the console
6. View the history of executed messages in the log interface of the Server program
7. Enter `Bye` in Client.vi to disconnect
8. Close the Server program
</Description>
      <Copyright/>
      <Packager>NEVSTOP</Packager>
      <URL>https://github.com/NEVSTOP-LAB/CSM-TCP-Router-App</URL>
      <Release_Notes>[add] add IP address/Port input dialog for client.
[update] update connection information
[update] update server/client VI icon
[fix] type "bye", client will exit, as the connection will be closed from server side.
[fix] minor fix. #5</Release_Notes>
    </Description>
    <Destinations>
      <Toolkit_VIs>
        <LLB>false</LLB>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path>&lt;user.lib&gt;\_NEVSTOP\CSM-TCP-Router</Path>
      </Toolkit_VIs>
      <Examples>
        <LLB>false</LLB>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path>&lt;application&gt;\examples\NEVSTOP\Communicable State Machine(CSM)\CSM TCP Router Application</Path>
      </Examples>
      <Custom_Probes>
        <LLB>false</LLB>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path/>
      </Custom_Probes>
      <Custom_Errors>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path/>
      </Custom_Errors>
      <Help_Files>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path/>
      </Help_Files>
      <Template_VIs>
        <LLB>false</LLB>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path/>
      </Template_VIs>
      <File_Menu>
        <LLB>false</LLB>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path/>
      </File_Menu>
      <Tools_Menu>
        <LLB>false</LLB>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path/>
      </Tools_Menu>
      <Help_Menu>
        <LLB>false</LLB>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path/>
      </Help_Menu>
      <Project_Templates>
        <LLB>false</LLB>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path/>
      </Project_Templates>
      <Project_Provider>
        <LLB>false</LLB>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path/>
      </Project_Provider>
      <QuickDrop_Plugins>
        <LLB>false</LLB>
        <Preserve_Hierarchy>true</Preserve_Hierarchy>
        <Path/>
      </QuickDrop_Plugins>
    </Destinations>
    <Source_Files>
      <Destination_Overrides>
        <Path>.</Path>
        <Destination>1</Destination>
        <Additional_Destination>false</Additional_Destination>
        <Additional_Destination_Index>0</Additional_Destination_Index>
      </Destination_Overrides>
      <Password_Overrides>
        <Path>.</Path>
        <Password/>
        <Locked_Only>false</Locked_Only>
      </Password_Overrides>
      <Namespace_Overrides>
        <Path>.</Path>
        <Namespace_Type>Prefix</Namespace_Type>
        <Namespace/>
      </Namespace_Overrides>
      <Place_Folder_Contents>
        <Path/>
      </Place_Folder_Contents>
    </Source_Files>
    <License_Agreement_Filepath>LICENSE</License_Agreement_Filepath>
    <Licensing_and_Activation>
      <License_LF_file_path/>
      <Licensed_library_file_path/>
      <Perform_License_Binding>false</Perform_License_Binding>
      <Purchase_URL/>
      <License_File_Password/>
      <Web_Activation_URL/>
      <Phone_Activation_Number/>
      <Auto_Activation_URL/>
      <Library_Protection_Password>&lt;random:32&gt;</Library_Protection_Password>
      <Enable_Deactivation>false</Enable_Deactivation>
      <Encryption_key_id/>
      <Client_key/>
      <Server_key/>
      <License_Sublibraries>false</License_Sublibraries>
    </Licensing_and_Activation>
    <Palette_Sets>
      <Palette_Set_Name>Default</Palette_Set_Name>
      <Use_Custom_Category>false</Use_Custom_Category>
      <Custom_Category_Name/>
      <Custom_Category_Icon>00000504002900000012000000020000000D00FFFFFF000100000000000A00000008000000000020002000280000025600000222000000030007001D00180000000000FFFFFF0000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000000FFFFFFFFFFFF000000000000FFFFFF000000FFFFFF000000FFFFFFFFFFFF000000000000FFFFFF000000000000000000FFFFFFFFFFFF000000FFFFFFFFFFFF000000000000FFFFFF000000FFFFFF000000FFFFFF000000FFFFFFFFFFFF000000FFFFFF000000FFFFFF000000FFFFFFFFFFFFFFFFFFFFFFFF000000FFFFFFFFFFFF000000FFFFFF000000FFFFFF000000FFFFFF000000000000FFFFFF000000FFFFFF000000000000FFFFFF000000FFFFFF000000FFFFFF000000000000FFFFFFFFFFFFFFFFFF000000FFFFFFFFFFFF000000FFFFFF000000FFFFFF000000000000FFFFFF000000FFFFFF000000FFFFFF000000FFFFFFFFFFFF000000000000000000FFFFFFFFFFFFFFFFFF000000FFFFFFFFFFFF000000FFFFFFFFFFFF000000FFFFFF000000FFFFFF000000FFFFFFFFFFFF000000FFFFFF000000FFFFFF000000000000FFFFFFFFFFFF000000FFFFFFFFFFFF000000000000FFFFFFFFFFFFFFFFFF000000FFFFFFFFFFFFFFFFFF000000FFFFFFFFFFFF000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000003FCD4DC9BFA950957FAD5895BFA9C4953FAC98893F0000003F002900000012000000020000000D00CCCCFF000100000000000A00000008001900000020002000280000025600000222001900030020001D00180000000000FFFFFF0000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF6C00006C0000FFFFFFFFFFFF6C00006C0000FFFFFF6C0000FFFFFF6C0000FFFFFFFFFFFF6C00006C0000FFFFFF6C00006C00006C0000FFFFFFFFFFFF6C0000FFFFFFFFFFFF6C00006C0000FFFFFF6C0000FFFFFF6C0000FFFFFF6C0000FFFFFFFFFFFF6C0000FFFFFF6C0000FFFFFF6C0000FFFFFFFFFFFFFFFFFFFFFFFF6C0000FFFFFFFFFFFF6C0000FFFFFF6C0000FFFFFF6C0000FFFFFF6C00006C0000FFFFFF6C0000FFFFFF6C00006C0000FFFFFF6C0000FFFFFF6C0000FFFFFF6C00006C0000FFFFFFFFFFFFFFFFFF6C0000FFFFFFFFFFFF6C0000FFFFFF6C0000FFFFFF6C00006C0000FFFFFF6C0000FFFFFF6C0000FFFFFF6C0000FFFFFFFFFFFF6C00006C00006C0000FFFFFFFFFFFFFFFFFF6C0000FFFFFFFFFFFF6C0000FFFFFFFFFFFF6C0000FFFFFF6C0000FFFFFF6C0000FFFFFFFFFFFF6C0000FFFFFF6C0000FFFFFF6C00006C0000FFFFFFFFFFFF6C0000FFFFFFFFFFFF6C00006C0000FFFFFFFFFFFFFFFFFF6C0000FFFFFFFFFFFFFFFFFF6C0000FFFFFFFFFFFF6C0000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000003FCD4DC9BFA950957FAD5895BFA9C4953FAC98893F0000003F</Custom_Category_Icon>
      <Controls_Palette_Information>
        <Virtual_Palette_Base_Path>Controls</Virtual_Palette_Base_Path>
        <Palette_Disk_Base_Path>&lt;menus&gt;\Controls</Palette_Disk_Base_Path>
        <Syncing_MNU_file/>
      </Controls_Palette_Information>
      <Functions_Palette_Information>
        <Virtual_Palette_Base_Path>Functions</Virtual_Palette_Base_Path>
        <Palette_Disk_Base_Path>&lt;menus&gt;\Categories</Palette_Disk_Base_Path>
        <Syncing_MNU_file/>
      </Functions_Palette_Information>
      <Apply_Short_Names_to_VI_Titles>false</Apply_Short_Names_to_VI_Titles>
      <Apply_Short_Names_to_VI_Titles_2>false</Apply_Short_Names_to_VI_Titles_2>
      <Library_or_Class_Nmae/>
    </Palette_Sets>
    <Install_Requirements>
      <All_Windows>true</All_Windows>
      <Windows_7>true</Windows_7>
      <Windows_Vista>true</Windows_Vista>
      <Windows_XP>true</Windows_XP>
      <Mac_OS>true</Mac_OS>
      <Linux>true</Linux>
      <Built_LV_Version>false</Built_LV_Version>
      <Built_LV_Version_or_greater>true</Built_LV_Version_or_greater>
      <Windows_8>true</Windows_8>
      <OS_32-Bit>true</OS_32-Bit>
      <OS_64-Bit>true</OS_64-Bit>
      <LV_32-Bit>true</LV_32-Bit>
      <LV_64-Bit>true</LV_64-Bit>
    </Install_Requirements>
    <LabVIEW>
      <close_labview_before_install>false</close_labview_before_install>
      <restart_labview_after_install>false</restart_labview_after_install>
      <skip_mass_compile_after_install>false</skip_mass_compile_after_install>
      <install_into_global_environment>false</install_into_global_environment>
    </LabVIEW>
    <VI_Docs>
      <Edit_VI_Description>true</Edit_VI_Description>
      <Text_to_Add>{product_name} {version_number}
{author_name} - {company_name}
{copyright}</Text_to_Add>
    </VI_Docs>
    <System_Destinations/>
  </Advanced_Settings>
  <Library_Palette_Definition/>
</VI_Package_Builder_Settings>