# CSM-Continuous-Meausrement-and-Logging

**Repository Path**: NEVSTOP-LAB/CSM-Continuous-Meausrement-and-Logging

## Basic Information

- **Project Name**: CSM-Continuous-Meausrement-and-Logging
- **Description**: DAQ framework & Modules based on Communicable State Machine(CSM)
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-04-26
- **Last Updated**: 2026-03-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: LabVIEW-CSM

## README

# CSM Continuous Measurement and Logging

[English](./README.md) | [中文](./README(CN).md)

[![Image](https://www.vipm.io/package/nevstop_lib_csm_continuous_meausrement_and_logging_example/badge.svg?metric=installs)](https://www.vipm.io/package/nevstop_lib_csm_continuous_meausrement_and_logging_example/)
[![Image](https://www.vipm.io/package/nevstop_lib_csm_continuous_meausrement_and_logging_example/badge.svg?metric=stars)](https://www.vipm.io/package/nevstop_lib_csm_continuous_meausrement_and_logging_example/)
[![GitHub all releases](https://img.shields.io/github/downloads/NEVSTOP-LAB/CSM-Continuous-Meausrement-and-Logging/total)](https://github.com/NEVSTOP-LAB/CSM-Continuous-Meausrement-and-Logging/releases)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

An example demonstrating a simpler, more intuitive, and elegant approach to building Continuous Measurement and Logging applications using the CSM (Communicable State Machine) framework.

## Reusable Modules

### `Logging Module`: Logging 1D Waveform Data to TDMS File

| API | Description | Arguments | Response |
| --- | --- | --- | --- |
| `API: Update Settings` | Configuration API | Full path of data folder <br/> (Type: `Plain String`) | N/A |
| `API: Start` | Start logging. Creates a time-based named TDMS file in the data folder. | N/A | N/A |
| `API: Log` | Log data to the TDMS file. | 1D Waveform array.  <br/> (Type: `massdata`) | N/A |
| `API: Stop` | Stop logging. | N/A | N/A |

**Example: (Suppose module name is "Logging")**

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

### `DAQ Module`: Acquire Waveform Data

| API | Description | Arguments | Response |
| --- | --- | --- | --- |
| `API: Start` | Start data generation every 200ms. | N/A | N/A |
| `API: Stop` | Stop data generation. | N/A | N/A |

| Status | Description | Arguments |
| --- | --- | --- |
| Acquired Waveform | Simulated Data.  | 1D Waveform array. <br/> (Type: `MassData`) |

The front panel of the module VI is used for configuration.

#### `Acquisition Module`: Generate Sine/Square Simulated Signal Data

![Alt text](./_doc/Simluated%20DAQ.png)

#### `SoundInput-DAQ`: Use your sound card to acquire waveform data.

![Alt text](./_doc/Sound_Card%20DAQ.png)

**Example: (Suppose module name is "Acquisition")**

``` text
API: Start -> Acquisition
API: Stop -> Acquisition
```

### `Algorithm Module`: Data Analysis Algorithms for Waveforms

| API | Description | Arguments | Response |
| --- | --- | --- | --- |
| `API: FFT(Peak)` | Analyze waveform with FFT(peak) method | 1D Waveform array. <br/> (Type: `MassData`) | 1D Cluster(waveform) Array. <br/> (Type: `MassData`) |
| `API: FFT(RMS)` | Analyze waveform with FFT(RMS) method | 1D Waveform array. <br/> (Type: `MassData`) | 1D Cluster(waveform) Array. <br/> (Type: `MassData`) |
| `API: Power Spectrum` | Get Power Spectrum of Waveform | 1D Waveform array. <br/> (Type: `MassData`) | 1D Cluster(waveform) Array. <br/> (Type: `MassData`) |

## Continuous Measurement and Logging Application

`Logging Module` and `Acquisition Module` are designed to operate independently without any direct knowledge of each other. For a complete Continuous Measurement and Logging application, a user interface module is required to coordinate their activities. For simplicity (and to facilitate comparison with the Workers framework), the UI Module also serves as the application controller.

When you need to use real hardware for data acquisition, simply create another CSM module for your specific hardware that implements the same API and status interface, then replace the `Acquisition Module` in the UI module. Since the interface remains the same, the rest of the UI module requires no changes.

### UI Module

Create a UI similar to the [Workers Continuous Measurement and Logging Example](https://www.vipm.io/package/sc_workers_framework_core/)

![Alt text](./_doc/mainUI.png)

Create a Block Diagram using the CSM Template. Place the `Logging Module` and `Acquisition Module` as submodules.

![mainBD](./_doc/MainBD.png)

``` mermaid
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"
```