CSM Continuous Measurement and Logging

目录

  1. 需求映射
    1. 需求分析与映射思路
    2. 从需求到API设计
    3. 数据流的订阅机制
    4. 设计优势
  2. 可复用模块
    1. Logging Module : 将1D波形数据记录到TDMS文件中
    2. DAQ模块
      1. Acquisition Module: 生成正弦/方波模拟信号数据
      2. SoundInput-DAQ: 使用声卡采集波形数据
    3. Algorithm Module: 波形数据分析模块
  3. 连续测量和记录应用程序
    1. 用户界面模块
    2. 系统架构
    3. 宏命令与工作流程
      1. 启动过程 (Macro: Initialize)
      2. 退出过程 (Macro: Exit)
      3. 开始采集过程 (Macro: Start)
      4. 停止采集过程 (Macro: Stop)
  4. 下载
  5. 依赖项
  6. 架构优势

基于 CSM（可通信状态机）框架更简单、更直观、更优雅地实现连续测量和记录应用的示例。

项目仓库：https://github.com/NEVSTOP-LAB/CSM-Continuous-Meausrement-and-Logging

需求映射

在开始编码之前，我们首先要将应用需求分解并映射到CSM模块和接口设计。这是CSM应用开发的关键步骤。

需求分析与映射思路

这个连续测量和记录应用需要实现数据采集、记录、分析和显示的完整流程。根据CSM框架的单一职责原则，我们将功能需求拆分为独立的模块，每个模块负责一个明确的职责。

graph TB
    subgraph "应用需求"
        R1[数据采集<br/>持续采集波形数据]
        R2[数据记录<br/>保存到TDMS文件]
        R3[数据分析<br/>FFT、功率谱等]
        R4[用户界面<br/>显示和控制]
        R5[配置管理<br/>参数配置]
    end
    
    subgraph "CSM模块设计"
        M1[Acquisition Module<br/>数据采集模块]
        M2[Logging Module<br/>数据记录模块]
        M3[Algorithm Module<br/>数据分析模块]
        M4[UI Module<br/>界面控制模块]
    end
    
    R1 --> M1
    R2 --> M2
    R3 --> M3
    R4 --> M4
    R5 --> M4
    
    style R1 fill:#e1f5ff
    style R2 fill:#e1f5ff
    style R3 fill:#e1f5ff
    style R4 fill:#e1f5ff
    style R5 fill:#e1f5ff
    style M1 fill:#fff4e6
    style M2 fill:#fff4e6
    style M3 fill:#fff4e6
    style M4 fill:#fff4e6

从需求到API设计

每个模块的功能需求自然转化为API接口。以Acquisition Module为例，”开始采集”和”停止采集”的需求直接映射为API: Start和API: Stop接口。当采集到数据后，通过Acquired Waveform状态广播通知其他模块，这种设计使得数据生产者无需关心数据的消费者是谁。

Logging Module提供数据记录能力，通过API: Update Settings配置保存路径，API: Start和API: Stop控制记录的开始和停止，API: Log接收并写入数据。Algorithm Module则提供多种分析方法的API接口，如API: FFT(Peak)、API: FFT(RMS)和API: Power Spectrum，每个API接收波形数据并返回分析结果。

UI Module作为协调者，实现用户交互和流程控制。通过Macro: Initialize完成初始化，Macro: Start和Macro: Stop控制整个应用的启停流程，并通过UI: Update Waveforms和UI: Update FFT等状态更新界面显示。

数据流的订阅机制

CSM框架的状态订阅机制是实现数据流的关键。下图展示了数据如何从采集模块流向记录、分析和显示模块：

graph LR
    Acq[Acquisition Module<br/>采集数据]
    Log[Logging Module<br/>记录到文件]
    Alg[Algorithm Module<br/>数据分析]
    UI[UI Module<br/>界面显示]
    
    Acq -->|Acquired Waveform<br/>状态订阅| Log
    Acq -->|Acquired Waveform<br/>状态订阅| Alg
    Acq -->|Acquired Waveform<br/>状态订阅| UI
    Alg -->|Power Spectrum<br/>状态订阅| UI
    
    style Acq fill:#e8f5e9
    style Log fill:#fff3e0
    style Alg fill:#e3f2fd
    style UI fill:#fce4ec

当Acquisition Module采集到数据时，它发布Acquired Waveform状态。Logging Module订阅了这个状态并映射到API: Log，自动触发数据记录。Algorithm Module同样订阅该状态并映射到API: Power Spectrum，自动执行分析。UI Module订阅后更新波形显示。这种发布-订阅模式实现了模块间的完全解耦，数据生产者不需要知道有多少消费者，也不需要在代码中显式调用它们。

设计优势

这种需求映射方法带来了清晰的架构：应用需求被分解为独立的功能模块，每个模块通过明确的API接口对外提供服务，模块间通过状态订阅机制连接数据流。这样的设计实现了松耦合、高内聚的模块化架构，使得每个模块都可以独立开发、测试和复用。当需要添加新功能时，只需创建新模块并注册相应的状态订阅，无需修改现有代码。

可复用模块

Logging Module : 将1D波形数据记录到TDMS文件中

API 描述 参数 响应
API: Update Settings 配置API 数据文件夹的完整路径
(类型: 普通字符串)		 N/A
API: Start 开始记录。在数据文件夹中创建基于时间的文件名的TDMS文件。 N/A N/A
API: Log 将数据记录到TDMS文件中。 1D波形数组。
(类型: MassData)		 N/A
API: Stop 停止记录。 N/A N/A

示例：（假设模块名称为”Logging”）

API: Update Settings >> c:\_data -> Logging
API: Log >> MassData-Start:89012,Size:1156 -> Logging
API: Start -> Logging
API: Stop -> Logging

DAQ模块

API 描述 参数 响应
API: Start 开始每200毫秒生成数据。 N/A N/A
API: Stop 停止数据生成。 N/A N/A
Status 描述 参数
Acquired Waveform 模拟生成的数据 1D波形数组.
(类型: MassData)

模块的前面板(Front Panel)用于参数配置。

Acquisition Module: 生成正弦/方波模拟信号数据

Alt text

SoundInput-DAQ: 使用声卡采集波形数据

Alt text

示例：（假设模块名称为”Acquisition”）

API: Start -> Acquisition
API: Stop -> Acquisition

Algorithm Module: 波形数据分析模块

API 描述 参数 响应
API: FFT(Peak) FFT(peak) 分析方法 1D波形数组.
(类型: MassData)		 Cluster波形数组.
(类型: MassData)
API: FFT(RMS) FFT(RMS) 分析方法 1D波形数组.
(类型: MassData)		 Cluster波形数组.
(类型: MassData)
API: Power Spectrum Power Spectrum 分析方法 1D波形数组.
(类型: MassData)		 Cluster波形数组.
(类型: MassData)

连续测量和记录应用程序

“Logging Module” 和 “Acquisition Module” 是设计为完全独立工作的，彼此之间没有直接联系。为了创建完整的连续测量和记录应用，需要一个用户界面模块来协调这两个底层模块的工作。为了简化实现（并便于与Workers框架进行比较），用户界面模块同时也充当应用程序的控制器。

当需要使用真实硬件进行数据采集时，可以为您的特定硬件创建另一个具有相同 API 和状态接口的 CSM 模块，然后替换 UI 模块中的 Acquisition Module。这样可以轻松切换和集成不同的硬件模块，而无需更改 UI 模块的其余部分，因为它们遵循相同的 API 和状态接口。

用户界面模块

创建一个类似于 Workers Continuous Measurement and Logging Example 的用户界面。

Alt text

使用 CSM 模板创建程序框图，将 “Logging Module” 和 “Acquisition Module” 作为子模块放置在 VI 后面板。

mainBD

系统架构

CSM 框架通过隐形总线实现模块间的消息传递：

stateDiagram-v2
direction LR
Acquisition --> Algorithm : "Acquired Waveform >> Power Spectrum"
Acquisition --> Algorithm : Acquired Waveform >> FFT(RMS)
Acquisition --> Logging  : "Acquired Waveform >> API：Log"
Acquisition --> UI : "Acquired Waveform >> UI：Update Waveform"
Algorithm --> UI : "FFT(RMS) >> UI：Update FFT"
Algorithm --> UI : "Power Spectrum >> UI：Update Power Spectrum"

宏命令与工作流程

启动过程 (Macro: Initialize)

初始化数据和用户界面(UI)，从 XML 文件加载配置并将配置发送给子模块。将 ‘Acquisition’ 模块的 ‘Acquired Waveform’ 状态注册到 ‘UI’ 模块的 ‘UI: Update Waveforms’ 状态。当 ‘Acquired Waveform’ 状态发生时，’UI’ 将自动切换到 ‘UI: Update Waveforms’ 状态。

Data: Initialize
Initialize Core Data
Data: Load Configuration From Ini
Events: Register
UI: Initialize
UI: Front Panel State >> Open
Do: Update Settings
DO: Update Status >> Ready...

Macro: Initialize

退出过程 (Macro: Exit)

停止子模块和用户界面模块本身。

Macro: Exit -@ Acquisition
Macro: Exit -@ Logging
Macro: Exit -@ Algorithm
UI: Front Panel State >> Close
Data: Cleanup
Events: Unregister
Exits

Macro: Exit

开始采集过程 (Macro: Start)

更新用户界面(UI)并触发子模块以启动消息进行工作。将 “Acquisition” 模块的 “Acquired Waveform” 状态注册到 “Logging” 模块的 “API: Log” 状态。当 “Acquired Waveform” 状态发生时，”Logging” 模块将自动执行 “API: Log”。

//Register Status
Acquired Waveform@Acquisition >> API: Log@Logging -><register>
Acquired Waveform@Acquisition >> API: Power Spectrum@Algorithm -><register>
Acquired Waveform@Acquisition >> UI: Update Waveforms -><register>
Power Spectrum@Algorithm >> UI: Update FFT -><register>

//Local States
DO: Update Status >> Acquiring and Logging...
UI: Update When Start

//Send Message to Other CSM Modules
API: Start ->| Logging
API: Start ->| Acquisition

Macro: Start

停止采集过程 (Macro: Stop)

更新用户界面(UI)并停止子模块。取消注册 “Acquisition” 模块的 “Acquired Waveform” 状态。

//Local States
DO: Update Status >> Stopping...
UI: Update When Stop

//Send Message to Other CSM Modules
API: Stop ->| Logging
API: Stop ->| Acquisition

//Unregister Status
Acquired Waveform@Acquisition >> API: Log@Logging -><unregister>
Acquired Waveform@Acquisition >> API: Power Spectrum@Algorithm -><unregister>
Acquired Waveform@Acquisition >> UI: Update Waveforms -><unregister>
Power Spectrum@Algorithm >> UI: Update FFT -><unregister>

Macro: Stop

下载

通过VIPM搜索 CSM Continuous Measurement and Logging，即可下载安装。

依赖项

  • CSM Framework - NEVSTOP

架构优势

这个示例充分展示了CSM框架的优势：

  • 模块化设计：各模块独立开发，互不干扰
  • 松耦合：通过状态注册机制实现模块间通信，无需硬编码依赖
  • 易于扩展：可以轻松替换或添加新的模块（如不同的DAQ硬件）
  • 代码复用：底层模块可以在不同的应用中重复使用