## Core
[feature] #502 Support modules in lvlibp
[add] #588 Add "Current State" and "Remaining States" to CSM Data Core for better debugging
[update] #504 Do not use global variable as changing flag
[update] #555 When CSM starts processing the Macro: Exit state, it no longer processes any messages
[update] #584 Add more detailed information to CSM errors
[fix] #499 Fix critical error that occurs when CSM module is built into lvlibp and run asynchronously

## Argument
[update] #545 ErrStr now supports warnings, which are ignored and converted to empty strings
[update] #501 Use ErrString for critical errors
[update] #498 SafeString now starts with argument type

## Global Log
[add] #596 Add message log type for CSM global log
[add] #561 Add log and show the number of remaining logs
[add] #520 Show call-chain of CSM module in "module created" log

## API
[add] Support ¡°=> VariableName" in CSM - Run Script.vi
[add] Add additional ¡°wait" command in CSM - Run Script.vi
[add] #543 Add ¡°CSM - Resolve Module Name.vi¡± to get module name from worker/chain node name
[add] #552 Add "CSM - Drop Broadcast Registry.vi" to clear all registration relationships
[fix] #549 Reset CSM - Module VI Reference.vi cache after topmost VI restarts
[fix] #548 Fix CSM - Remove Module in Broadcast Registry.vi

## Attribute
[fix] #535 Fix CSM Attribute TagDVR cache error
[fix] #533 CSM Attribute should be case insensitive

## Advance Modes
[fix] #540 Fix "VI Reference" not allowed in Chain Mode by default
[fix] #560 #556 Management API should work for worker mode and chain mode
[fix] #557 Fix removal of internal registry rules for chain/worker

## Debug Tools
[add] New Example Browser Tool
[add] #496 Add script running function in debug console
[update] #461 Logviewer uses queue of global log events

## Doc/Palette
[feature] More testcases to cover all features of csm
[update] Improve palette and documentation

yao was a contributor to this release

##Core
[important] #236 #475 #481 #482 #487 #490 #491 CSM Framework now support register state.
[important] #488 After "Macro: Initialize" is complete, CSM start to process external message.

##API
[update] #485 Add "Recursive" option for "CSM - List Submodules.vi"

##CSMLoop
[fix] #479 fix bug that async-message could not get response until loop is stopped.

yao was a contributor to this release

#Core
[important] #437 #474 #472 #469 Align the life cycle of resources(Queue,User Event, DVR) of CSM to a background thread VI when CSM is started asynchronously.

#Arguments
[update] #466 Add "Argument Token" concept, if user add a new argument type, use as prefix to identify the argument type. Use "CSM - Argument Token.vi" to parse the argumen type.

#Tools
[update] #463 improve Debug Console, support operation of broadcasting status
[update] #467 Show speed of filtered log instead of counts
[update] minor update #465

#utility
[add] #195 Add a utility VI to identify the state triggered reason(local-call, remote-call, status-callback)

yao was a contributor to this release

##Core
[update] #459 Default DequeueTMO is changed from 0ms to 1ms, which will improve debugging performance if any related errors. Thanks @ZhaoLi-an

##API
[update] #450 Enhance "CSM - List module" Behavior. Now system level module could be included.
[update] Add a "" prefix in "CSM - Convert Data to HexStr.vi" to identify the argument type.
[update] Add waiting time for CSM to be alive in CSM Status/Exit Event API

##GlobalLog
[add] #448 #453 #454 #455 #456 #457 Now global event support queue operation.
[add] #454 New snippet for using Global Event Queue.
[update] #455 use event source timestamp instead of handling timestamp.

##Example
[add] add a new example "4. Advance Examples\Global Log Handling Capability" to demostrate the improved global log handling capibility.

##Tools
[update] Debug Console add message handling speed indicator.
[update] #460 Debug Console use queue based global log API.
[update] #456 CSM File Logger use Queue based global log API.

yao was a contributor to this release

#Core
[fix] #436 fix that for or Worker mode, when logviewer is open ,terminate workers' caller VI, flood of CSM module will be generated.
[fix] #423 Throw a CSM Missing Return State Error if the user clears the return state for a message(-&), as this action may potentially lead to an infinite loop issue.

#IDE
[update] Interface browser Update #430 #424 #425 #428

#Addon
[update]#435 Add option for front insert in CSMLS - Define Loop State(s).vi

#utility
[update] prompt user that CSM - Internal State Debug Log History.vi is disabled in runtime by default.

yao was a contributor to this release

#important
[add] #399 add "Interface Browser Dialog", which is used for manage all your CSMs in project.
[add] #396 add "Script Editor" in RCM of string constant, it's useful and please try it.

#Core
[update] #413 If an error occurs during a message call, previously the response would be overwritten by the "Error Handler" response. Now, if you haven't specified any response in the "Error Handler", the caller will still receive the original message response.
[fix] #411 Fix sys-level module status-register issue

#API
[add] #406 add API to list submodule names
[add] #392 add API to set timeout of waiting reply for sync-message.
[add] #394 add a corner case API which could flush the CSM message queue
[update] VI Ref will be cached in "CSM - Module VI Reference.vi"
[update] #390 #391 Refactor palette and icon to make it more friendly to use. Thanks @ZhaoLi-an
[update] remove inline for non-CSM Support API to reduce loading time
[fix] fix message in queue number error of CSM - Module Status.vi when multiple Sync-Messages are in Queue.

#Template
[update] #389 select Case Insensitive Match in "UI: Front Panel State" case. Thanks @ZhaoLi-an
[update] tiny update to csm template(size...)

#Addon
[fix][CSMLS] #419 fix issue that macro message with loop support could not get resp/asyn-resp. Thanks @wulei2LabVIEW
[fix][CSM File Logger] Create every folders in log file path if needed.

#Tool
[add] #417 add an option to enable "retain wire value" option, which will help debugging a lot.
[add] #408 add RCM for jumping to CSM State of the log in Debug Consol and log viewer.
[update] debug-console provide option to convert safe string automatically
[update] #404 #403 #402 RCM entry update
[fix] #420 #421 minor bug fix. Thanks @wulei2LabVIEW

yao was a contributor to this release

# Core
[add] #379 Modules starting with '.' are recognized as system-level and excluded from "CSM - List Module.vi".
[update] Removed inline option for "Parse State Queue++.vi" to reduce CSM module loading time.
[update] #288 CSM now stops the loop before processing "Macro: Exit".
[fix] #387 "CSM - Forward States to CSM.vi" now generates a notify user-event to break event structure waiting.

# Template
[add] #386 Added a new DQMH-Style Template, moving UI handler out of the CSM-message loop.

# Tool
[add] #322 Added "Make Bent Wire Straight.vi" to CSMHelper.
[add] #381 Added tool to fix JKISM State Editor RCM entry for CSM.
[add] Added tool to create CSM palette in functions root palette.
[add] #374 Added "Go to State" RCM for String Constant.
[update] Added Exit toolbar button to post "Macro: Exit" to the selected CSM module.
[update] #384 Adapted to changes in jkism 2024, fixing State Editor RCM issues.

# Example
[fix] Minor documentation fixes (#380, #383).

# Installer
[update] Brought installing window to topmost (NI Knowledge Base: https://knowledge.ni.com/KnowledgeArticleDetails?id=kA03q000000YOu6CAG&l=en-US).
[update] Improved installing window.
[update] #382 Updated copyright year.

# CSM Loop Support
[update] Changed all APIs to subroutines.
[obsolete] #288 CSMLS - Add Exit State(s) with Loop Check.vi is no longer needed. "Parse State Queue++.vi" handles this automatically.

# Testcase
[add] #373 Added testcase to check dependencies; fails if unexpected dependencies are included.
[add] Added testcase to check for VI path length.
[add] Added testcase to validate CSM RCM dependencies.

yao was a contributor to this release

#Template
[update] #359 optimize template while loop size. thanks @casey502

#GlobalLog
[fix] #372 #371 Display precise logs for registration and unregistration actions.

#Tool
[add] #368 add .lvcsm file to store all configuration for csm tools
[update] The highlight tool will no longer use underlines in arguments, making it easier to distinguish the "_" symbol within them.
[update] #353 Improve CSM tool Launcher loading speed.
[update] Show help content of CSM debug tools in CSM tool Launcher
[update] add "API Only" option for listing CSM states in CSM debug console
[fix] #327 CSM tool launcher should function as a singleton.which should not be triggered repeatedly.

#CSMHelper
[add] #370 add "Jump to CSM State.vi", which will be used in CSM Tools and Plugins.

#Example
[update] minor fix/update #355 #357
[Fix] #365 fix data name error in "0. Base Concepts/CSM Data Type.vi". thanks @MapleBay

yao was a contributor to this release

#Core
[fix] #323 fix grammar of unregister, to make it more friendly for new CSM user
[update] #297 Internal Status registration will be automatically removed after csm exits.

#API
[update] update ctrl palette for CSM
[fix] minor fix #347

#Template
[update] #349 make template looks simple. Thanks @drjdpowell

#Tool
[update] improve csm tools performance

#Documentation
[add] add a new example VI to compare the teamplates of JKISM and CSM
[fix] #348 fix unreadable description issue. Thanks @drjdpowell
[update] Update utility VI icons

#utility
[add] add Global Log History Cacher.vi and quick drop snippet of Global Log monitoring loop
[update] #344 show argument in filted periodic log in debug tools
[update] Add "Skip in Runtime(T)" option for CSM - Internal State Debug Log History.vi

yao was a contributor to this release

[important] Peroidic States/Log will automatically be filtered in Template/DebugTools/Examples
[important] Change License to MIT, to enable more csm users

#Core
[update] #337 Show Responses in "CSM - Run Script.vi"

#Template
[update] Update template to use new State Debug Log VI, which will automatically filter period States in log

#Installer
[update] Remove the localization process to speed up the installation. You can use the CSM Tool to change the description language.

#Tool
[update] #285 Peroidic States/Log will automatically be filtered in DebugTools
[fix] minor fix #327

yao was a contributor to this release

#Core
[fix] #328 Fixed CSM Status Change Event not working bug.

#VI Analyzer
[fix] Minor fixes & updates for #325, #326.

#installer
[add] #330 Automatically localize VI description after installation.

#Documenation
[update] Updated VI Description markdown help files in zh-cn.

#tools
[update] Updated Switch Language Tool.
[update] Updated Command Debug Tool, commands listed automatically when switching CSM module.

yao was a contributor to this release

#Core
[update] Uncheck inline option in Parse State Queue++.vi.
[fix] minor fix #302 #304 #308 #309

#Tool
[important] #92 #287 Add Vi analyzer Support.
[update] #305 include *.vit files in Add "VI Reference" Tool.

yao was a contributor to this release

#Core
[important] Reorganize all broadcast registry APIs to make them more user-friendly.
[important] #234 Add Global Event Filter System
[add] #289 Add two more api for Send/Post Message to CSM.
[add] add CSM - Run Script VI to execute multiple states once.
[fix] #291 The Registry of status should not be removed after CSM exit. It should be unregistered explicitly.
[fix] #295 Stand-Alone CSM module should be able to register other module's status change.
[fix] #299 CSM Module name should be case insensitive.

#CSMHelper
[important][add] Add CSM-Helper APIs for creating tools for CSM.

#Tool
[add] #300 add tool to fix "VI Reference" case in every CSM module VIs.
[add] Add Show FP/BD buttons in toolbars.

#Template
[important] #298 Add "VI Reference" case for template, to provide interface to get CSM VI Ref.
[remove] Remove 'More template' mnu. Use template VIs in ¡±File>>New..." instead.

#addon
[add] add CSM Watchdog to ensure all CSM modules exit after application is exited.
[update] #290 add appending or not optional input for "CSMLS - Append Continious State (CSM)"
[fix] #293 corner case in csm logger thread.

yao was a contributor to this release

##Core
[update] #282 Multiple Status Input is supported in CSM - Broadcast Status Change.vi

##Addons
[update] #286 Add timestamp format input for logging.

##Template
[update] #281 Connect last Response to Response in Error Handler Case.
[update] Remove most error wires as it's not necessary for most cases.
[update] #235 Reorg Error code.

##Utility
[fix] Ignore case in Set Enum String Value Utility VI to improve user experience
[update] #286 Add timestamp format input for String History Cacher.

yao was a contributor to this release

##Arguments
[update] #275 `,` and `;` are added to keyword list

##Tool
[update] #277 Response Timeout could be modified. The value is stored in LabVIEW.ini as "CSM.Tool.DebugPanel.Response Timeout"
[update] #278 More History for CSM-DebugConsole
[update] Create Tool Btn for CSM - Mermaid Tool

##Addon
[fix] #280 Loop Support: fix bug in CSMLS - Remove Loop Tag and previous State(s) to Break.vi

##Documentation
[update] minor update to examples #274

##Utility
[update] all embedded OpenG SubVI is marked as subroutine

yao was a contributor to this release

#Core
[add] #269 Add APIs to check registration in BroadcastRegistry
[update] #272 csm name support utf-8 charactors
[fix] #239 The registration status of a module can now be linked to two messages from a single CSM module.
[fix] #268 Fix bug that CSM of chain type is not included in result of CSM - List Modules.vi

#Tool
[add] #270 Show status registration information in LogViewer
[add] Add "Highlight All CSM Scripts" in popup menu plugin
[update] improve tool launcher dialog

#Template
[update] Change templates names to make it more comprehensible
[update] Update descriptions in all templates

#Addon-Logger
[add] #271 logger file will be limited by file-size(10M as default) and file-num(2 as default) parameter.
[update] add handshake between thread and api

#Documentation
[update] Update library icon

yao was a contributor to this release

#Core
[add] #269 Add APIs to check registration in BroadcastRegistry
[update] #272 csm name support utf-8 charactors
[fix] #239 The registration status of a module can now be linked to two messages from a single CSM module.
[fix] #268 Fix bug that CSM of chain type is not included in result of CSM - List Modules.vi

#Tool
[add] #270 Show status registration information in LogViewer
[add] Add "Highlight All CSM Scripts" in popup menu plugin
[update] improve tool launcher dialog

#Template
[update] Change templates names to make it more comprehensible
[update] Update descriptions in all templates

#Addon-Logger
[add] #271 logger file will be limited by file-size(10M as default) and file-num(2 as default) parameter.
[update] add handshake between thread and api

#Documentation
[update] Update library icon

yao was a contributor to this release

#Core
[important] upgrade to LabVIEW 2017 for plugin and other features

#Side-Loop Support
[update] update palette

#Addon
[change] change csm log file extension to .csmlog

#DebugTool
[important] add pop-up menu plugin
[add] #167 pop-up menu for script constant string: Make Argument Safe/Revert Safe String
[add] pop-up menu for script constant string: Hightlight CSM Script
[add] add CSM - Remove all CSM Bookmarks tool to remove all comment bookmarks of CSM template
[update] add error log window in LogViewer to highlight error occurred
[update] some minor improvement

#Utility
[add] add CSM Data Type String.vi in palette
[add] add CSM Data Type String to Enum.vi in palette

#Documentation
[update] #256 update icons

yao was a contributor to this release

#Core
[fix] #258 Terminated CSM will not be included in CSM - List Modules.vi any more.
[fix] #262 Advanced operation(register,unregister,status,interrupt..) will not be filtered by CSM - Filter Messages to Non-Existing Modules.vi any more.
[add] IMPORTANT: #259 User defined operation "->" is permitted. You can now assign a user-defined tag to a local CSM message, which offers greater flexibility for creating add-ons.

#Side-Loop Support
[add] Add option of immediately(F) option for CSM - Request CSM to Post Message.vi and CSM - Request CSM to Broadcast Status Change.vi
[add] Add CSM - Module Exit Event.vi for triggering Non-CSM side loop exit.
[add] #249 Add "CSM - Flood of Events Handler Side Loop" template

#DebugTool
[add] IMPORTANT: add a new tool: CSM Debug Console.
[improve] LogViewer: 1. Add Clear History Button; 2. Add History Length Entry; 3. Add Back to Top Button; 4. Add Log File Support
[improve] Improved names for built-in tools in the tool launcher.
[improve] all tool window will be open in the center the primitive screen.

#Addons
[add] LoopSupport: addon to define a loop in CSM, which is used in NEVSTOP-Lab project
[add] FileLoggerSupport: addon to log CSM activities to log file.

#documentation
[improve] #260 improve pre-build action script to fix palette VI names

#installer
[improve] #257 reduce installation time
[improve] Improvement according to vi-analyzer

yao was a contributor to this release

#GlobalEvent
[improve] improve release logic. Use watchdog for background thread exit
[improve] minor fix #254

#Utility
[add] #251 add "CSM - Filter Messages to Non-Existing Modules.vi"

#Tool
[add] #252 add a toolbar entry to launcher CSM tools

#Documentation
[fix] #246 fix vipm.io links
[improve] #245 improve user experience
[improve] Update example VIs' icons/Palette icons

yao was a contributor to this release

#Core
[update] #242 For async-message, if target turned invalid before response, no ¡°target error¡± throw out
[fix] Clear Last Message's Error before new remote message, to avoid some misinformation

#Arguments
[fix] Fix the error input of "CSM - Convert HexStr to Data.vi"
[fix] minor fix #237

#Global Event
[add] #240 add "Module Created" and "Module Destroyed" log to global log system
[fix] #238 Align global event ref lifecycle with a background thread, rather than the caller VI

#Utility
[add] Add "CSM - Remove Duplicated Following Messages.vi", to remove duplicated message
[add] Add "CSM - Replace Substitution Marks in Messages.vi", to help build multiple-line states easily

#Documentation
[add] Create web wiki for CSM: https://nevstop-lab.github.io/CSM-Wiki/

yao was a contributor to this release

# Core
[Critical] #207 ¡°Target Busy Error¡± is absolete. Now a sync-call message will not generate "Target Busy Error" but waiting until timeout.
[fix] #219 #225 #226 fix bug that the cache system is ineffective when CSMs start/exit in the same microsecond
[fix] #197 fix the bug of timeout behavior of CSM - Send Message and Wait for Reply.vi
[fix] #196 fix the bug that status of agent(worker Mode) could not trigger registered action
[fix] #215 now CSM - Module Turns Invalid (CSM) support Agent & Chain
[fix] #217 fix the bug that Single Character could not be used as module name

#GlobalLog
[add] #214 add Error Handler which logs error in global log if any.
[update] #220 #221 Log Error Information in CSM - Generate User Global Log.vi
[fix] #212 Remove some meaningless items in log

#Utility
[add] #209 add Build Exit Messages of CSMs.vi
[add] #216 add two sync-up VI: CSM - Wait for All Modules to Exit.and CSM - Wait for All Modules to be Alive
[add] add Random Change Flag.vi for internal bug fix.

# Installer
[improvement] #203 Change post-install action window to JKISM
[update] #228 show relative path in post-install action window

# Template
[add] add CSM - No-Event Structure Template - Tiny.vi
[minor update] #211 #223

yao was a contributor to this release

# Core
[add] #144 add build-in chain of responsibility mode "$" as key words in module name.
[add] add CSM - Break Down Multiple States String.vi
[add] #184 add CSM - Keywords.vi for exposing keywords of CSM
[add] #161 Response/Async Response carry the Error information from target CSM module
[add] Allowed Messages(Empty for all) terminal for Parse State Queue++.vi
[improve] make Parse State Queue++.vi block diagram clear
[imporve] #140 Improve CSM - Send Message and Wait for Reply.vi and CSM - Post Message.vi
[fix] #173 fix bug that sync message(-@) is blocking by mass of async message(->).
[fix] fix No source module name for "Macro: Exit"
[fix] show pre-state argument for Response(sync-call)
[fix] show pre-state/pre-argument for "Target Error","Target Timeout Error" or "Traget Busy Error"

# Arguments
[add] Convert Error with Argument API and example

# Template
[critical] Change Error Status Arguments to SafeString as Default in template
[add] add a stub string constant which is for exiting sub-modules
[update] #186 show "Init State("Macro: Initialize")" control for templates
[update] init error shift resgister in front of loop
[fix] #179 Show documentation case by default

# documentation
[fix] #180 Update description of quick-drop VIs in documentation palette

yao was a contributor to this release

[critical]#169 show both source message and arguments for response/async response, which will broken old module but easy to fix.
[add] #158 Add State Table - DebugTool
[add] #156 Create CSM_Tool_Launcher entry in Tool Menu
[add] #154 Create stub folder [labview]\templates\Communicable State Machine(CSM) for template VIs
[add] Apache License 2.0 License
[add] update More template palette tool
[add] Example of demostration of build-in error handling framework
[improve] #160 improve debug tools of CSM
[improve] #174 Show all keyword in template
[improve] #168 template: add case in Response/Async Response
[fix] #153 Small fix and update to templates
[fix] #150 Fix description in pages of vipm.io
[fix] #157 Fix QD of CSM_Tool_Launcher
[fix] #164 fix // is not included in Make Argument Safe.vi
[fix] #171 register status@* should exclude itself from list, to prevent recursive call.

yao was a contributor to this release

1. Template of JKISM++ Module
- With Event Structure Template
- No-Event Strcture Template
- With Event Structure Template(Tiny)

2. Advance API for Module Managment
- List Modules
- Check if Module Exists
- Start Async/Sync Call

3. Examples
- Base Concepts
- Create a reuse Module
- Caller is JKISM Scenario
- Caller is Other Framework Scenario
- Advance Examples
- JKISM with Side Loop as a Module
- Action Workers Example

4. Tools
- Localization API/Template Tool
- Debug Tool for monitoring system change
- Debug Tool for status dashboard

yao was a contributor to this release