diff --git a/README.md b/README.md index 951ef659..795ec485 100644 --- a/README.md +++ b/README.md @@ -1,164 +1,215 @@ +
-| Your scenario | How OpenTest handles it |
-| --- | --- |
-| **R&D debugging**: quickly see the frequency content of a sound or vibration signal | Open Monitor to view live waveforms and spectra, then switch to FFT, octave, or other measurements for deeper analysis. Save, review, and compare results at any time |
-| **Electroacoustic performance**: frequency response, distortion, and sensitivity of speakers, microphones, headphones, and finished products | Sweep measurement drives the output and acquires the input simultaneously, giving frequency response, distortion, and more in one run. Set upper and lower limits to judge pass/fail automatically |
-| **Product and environmental noise**: sound level, sound power, sound quality | Sound level meter, sound power, and sound quality measurements organize parameters and measurement points around common engineering methods and report the business metrics directly |
-| **Vibration and structural testing** | Vibration measurement reports acceleration, velocity, displacement, and statistics across multiple channels at once |
-| **Building and room acoustics** | RT60 reverberation time measurement |
-| **Production-line testing**: hundreds or thousands of units per day | Test sequences turn "prepare → excite → acquire → analyze → judge → record" into a fixed flow. Operators just place the unit and press Start. Supports multiple stations, barcode scanning, MES upload, and throughput (UPH) statistics |
-| **Calibration** | Built-in sound level calibration workbench and channel sensitivity calibration keep results traceable |
-| **Reporting** | Generate reports from measurement records, export to Excel, Word, and raw waveforms, or configure automatic saving and export |
+![]() Measure Real-time acquisition and analysis with your DAQ hardware. Analyze while acquiring or after acquiring, for both live monitoring and flexible analysis. |
+![]() Analysis Offline, in-depth analysis of recorded waveforms or data, from cleaning to computation, without connecting any hardware. |
+![]() Sequence Repeatable automated tests for labs and production lines. Connects acquisition, analysis, storage and reporting into one batch flow. |
+
![]() FFT analysis · baseband, precision baseband and zoom FFT, 19 window functions, auto- and cross-spectrum, frequency response H1/H2/H3, coherence, harmonic and sideband cursors |
+![]() Octave / CPB · 1/1, 1/3 and up to 1/24 octave bands, A/B/C/Z weighting, compliant with IEC 61260 |
+
![]() Sweep · continuous, stepped and stepped-level sweeps with synchronous generation and acquisition, impulse response, THD (up to the 100th harmonic) and Rub & Buzz |
+![]() Sound level meter · IEC 61672 metering with Leq, Lmax, Lmin, Lpeak, Fast/Slow/Impulse time weighting and statistical percentiles (Ln) |
+
![]() Sound power · ISO 3744, 3745 and 3746, GB/T 32524.1 and GB/T 28543 workflows, 3D measurement-point layouts and background noise correction |
+![]() Sound quality · loudness (Zwicker and Moore), sharpness, roughness, fluctuation strength, tonality and prominence ratio |
+
-**Free to use for:**
+Select test records on the **Report** page to generate a report from a general-purpose template, then export it to Word, Excel or PDF together with data tables, images and raw waveforms. Reports can be duplicated and archived, and sequences can save and export automatically.
-- Personal use, learning, and education;
-- Scientific research, software development, and product R&D;
-- In-house use within a company, **including production environments**;
-- Providing testing, measurement, or other technical services to customers with OpenTest (as long as the software itself is not delivered to the customer).
+## Open hardware connectivity
-The free license includes **4 simultaneously usable physical input or output channels** per OpenTest system.
+
-**A commercial license is required to:**
+Use OpenTest with CRYSOUND measurement devices out of the box, or bring in third-party hardware through audio interfaces, openDAQ and selected DAQ protocols.
-- Use more than 4 channels;
-- Deliver OpenTest to customers with hardware or other commercial products (OEM, ODM, white label, bundled device software);
-- Sell, rent, or repackage and distribute OpenTest or a modified version as commercial software;
-- Offer OpenTest's main functions to third parties over a network for a fee (SaaS, cloud, or hosted services).
+| Protocol | Verified | Supported |
+| :-- | :-- | :-- |
+| **openDAQ** | CRYSOUND SonoDAQ Pro · SonoDAQ Go · SonoDAQ LT | Dewesoft SIRIUS XHS · HBK Fusion RX · HBK Fusion MX |
+| **ASIO** | CRYSOUND CRY6151B · Echo AIO System · RME Fireface UFX III | |
+| **WASAPI** | CRYSOUND CRY2301 noise sensor · miniDSP UMIK-1 · built-in sound cards | |
+| **Modbus-TCP** | CRYSOUND CRY2851 sound level meter | |
+| **NI-DAQmx** | NI USB-4431 · NI cDAQ-9188 | NI cDAQ-9170 · NI cDAQ-9173 |
-In addition, some measurements require the corresponding feature entitlement, obtained online with a cloud account or through a local or USB offline license. Contact CRYSOUND for commercial licenses and feature entitlements.
+Hardware support comes from device plugins, so it depends on the package you install. SonoDAQ adds PTP/GPS clock synchronization. Ordinary sound cards are fine for learning and early checks; use calibrated measurement hardware for formal results. The current list lives on the [website](https://www.opentest.com/).
----
+## Plugins and the AI-assisted CLI
-## Getting started
+**Plugins.** Everything beyond the core comes as an `.otplugin` package: **business plugins** add measurements and **device plugins** add hardware. Import them under **Settings → Plugin Management**, then restart; disabling or uninstalling a plugin never deletes your data. Plugins reuse OpenTest's acquisition, algorithms, storage and charts, so you only write your own measurement logic or device integration. [OpenTest-Plugins](https://github.com/crysound/OpenTest-Plugins) contains the full source of the FFT and SonoDAQ plugins as templates. You decide whether your plugin is open source or paid; selling independent plugins needs no extra commercial license.
-| Who you are | Start here |
-| --- | --- |
-| An engineer who wants to use it | Download and install the package (Windows x64), sign in with a cloud account or import an offline license, install the plugins you need, and follow "How a typical measurement works" for your first test |
-| A contributor or someone building from source | Read the [Developer Guide](docs/development-and-packaging.md) for environment setup, source development, and packaging |
-| A plugin developer | Read the development docs in [OpenTest-Plugins](https://github.com/crysound/OpenTest-Plugins) and use the FFT plugin as a template |
-| Looking for more channels or OEM licensing | Contact CRYSOUND |
+**OpenTest CLI.** [`opentest-cli`](cli/README.md) lets AI agents and scripts drive OpenTest, either through the running desktop UI or directly through the SDK, so engineers can turn test experience and specialized algorithms into reusable modules.
-**System requirements**: Windows 10/11 x64. A microphone recognized by Windows is recommended for your first measurement.
+## Editions and licensing
----
+| Edition | Channels | Highlights |
+| :-- | :-- | :-- |
+| **Community** · free | 4 | Monitor and generator, basic FFT, octave and sweep |
+| **Professional** | 8 | Everything in Community, plus algorithm plugins |
+| **Advanced** | 24 | Sequence and Analysis modes, recorder, export and reports, optional apps |
+| **Enterprise** | Unlimited | All features and optional apps, API/SDK |
+
+Monthly, yearly and lifetime plans and the full feature matrix are on the [pricing page](https://www.opentest.com/pricing/), which is authoritative for editions.
+
+The source in this repository is available under the **[OpenTest Community License 1.0](LICENSE.md)**. In short, it is free for personal use, education, research, software and product development, in-house use including production, and for providing test services to customers, with up to **4 simultaneously used physical channels** per system. A commercial license is needed for more channels, for shipping OpenTest with hardware or other products (OEM, ODM, white label), for selling or redistributing it, or for offering it as a paid hosted service. The license text prevails over this summary.
+
+
-| 你的场景 | OpenTest 的做法 |
-| --- | --- |
-| **研发调试**:想快速看清一个声音或振动信号的频率构成 | 打开 Monitor 实时查看波形与频谱,切到 FFT、倍频程等测量项做深入分析,结果随时保存、回看和对比 |
-| **声学性能测试**:扬声器、麦克风、耳机、整机的频响、失真、灵敏度 | 用扫频测量驱动输出并同步采集,一次得到频响、失真等结果,可设置上下限自动判定合格与否 |
-| **环境与产品噪声评估**:声级、声功率、声品质 | 声级计、声功率、声品质测量项按常用工程方法组织参数与测点,直接给出业务指标 |
-| **振动与结构测试** | 振动测量项输出加速度、速度、位移等结果和统计量,支持多通道同时分析 |
-| **建筑与室内声学** | RT60 混响时间测量 |
-| **产线检测**:同一产品每天测成百上千台 | 用测试序列(Sequence)把“准备 → 激励 → 采集 → 分析 → 判定 → 记录”编排成固定流程,操作员只需放好产品、点开始;支持多工位、扫码、上传 MES 和产能(UPH)统计 |
-| **设备校准** | 内置声级校准工作台与通道灵敏度校准,保证测量结果可追溯 |
-| **出具报告** | 基于测量记录生成报告,可导出 Excel、Word 和原始波形,也可配置自动保存与导出 |
+![]() 测量模式 配合采集硬件实时采集和分析。支持边采集边分析和采集后分析,兼顾动态监测和灵活分析。 |
+![]() 分析模式 离线深度分析已采集的波形或数据,从数据清洗到分析计算全流程完成,无需连接硬件。 |
+![]() 序列模式 面向重复测试和产线,打通“采集-分析-存储-报告”的完整流程,批量执行。 |
+
![]() FFT 分析 · 基带、精确基带和细化 FFT,19 种窗函数,自谱与互谱,H1/H2/H3 频响函数,相干函数,谐波与边带光标 |
+![]() 倍频程 / CPB · 1/1、1/3,最高 1/24 倍频程,A/B/C/Z 计权,符合 IEC 61260 |
+
![]() 扫频 · 连续扫频、步进扫频和步进幅值扫频,激励与采集同步,脉冲响应、THD(最高 100 次谐波)和异音(Rub & Buzz)分析 |
+![]() 声级计 · 符合 IEC 61672,提供 Leq、Lmax、Lmin、Lpeak,快/慢/脉冲时间计权和统计声级(Ln) |
+
![]() 声功率 · 支持 ISO 3744、3745、3746 以及 GB/T 32524.1、GB/T 28543,3D 测点布置和背景噪声修正 |
+![]() 声品质 · 响度(Zwicker 和 Moore)、尖锐度、粗糙度、波动强度、音调度和突出比 |
+
-**免费即可使用:**
+在 **报告** 页面选中测试记录,即可用通用模板生成报告,并连同数据表、图片和原始波形一起导出为 Word、Excel 或 PDF。报告可以复制和归档,序列也可以配置自动保存和导出。
-- 个人用途、学习与教育;
-- 科学研究、软件开发与产品研发;
-- 企业内部使用,**包括正式生产环境**;
-- 用 OpenTest 为客户提供测试、测量等技术服务(软件本身不交付给客户)。
+## 开放硬件连接
-免费许可每套 OpenTest 系统包含 **4 个可同时使用的物理输入或输出通道**。
+
-**以下情况需要商业许可:**
+OpenTest 可以直接配合 CRYSOUND 测量设备使用,也可以通过音频接口、openDAQ 和部分采集卡协议接入第三方硬件。
-- 需要超过 4 个通道;
-- 把 OpenTest 随硬件或其他商业产品交付给客户(OEM、ODM、白牌、设备配套软件);
-- 把 OpenTest 或其修改版作为商业软件出售、出租或重新包装分发;
-- 以收费方式通过网络向第三方提供 OpenTest 的主要功能(SaaS、云服务、托管服务)。
+| 协议 | 已验证 | 已支持 |
+| :-- | :-- | :-- |
+| **openDAQ** | CRYSOUND SonoDAQ Pro · SonoDAQ Go · SonoDAQ LT | Dewesoft SIRIUS XHS · HBK Fusion RX · HBK Fusion MX |
+| **ASIO** | CRYSOUND CRY6151B · Echo AIO System · RME Fireface UFX III | |
+| **WASAPI** | CRYSOUND CRY2301 噪声传感器 · miniDSP UMIK-1 · 电脑内置声卡 | |
+| **Modbus-TCP** | CRYSOUND CRY2851 声级计 | |
+| **NI-DAQmx** | NI USB-4431 · NI cDAQ-9188 | NI cDAQ-9170 · NI cDAQ-9173 |
-另外,部分测量功能需要对应的功能权益,可通过云账号在线获取,也可使用本机或 USB 离线授权。商业许可与功能授权请联系 CRYSOUND。
+硬件支持由设备插件提供,实际可用范围取决于你安装的版本。SonoDAQ 额外支持 PTP/GPS 时钟同步。普通声卡适合学习和初步验证,正式测量请使用经过校准的测量硬件。最新列表以[官网](https://www.opentest.com/zh-hans/)为准。
----
+## 插件与 AI 辅助 CLI
-## 开始使用
+**插件。** 核心以外的能力都以 `.otplugin` 安装包提供:**业务插件**增加测量项,**设备插件**接入新硬件。在 **设置 → 插件管理** 中导入并重启即可生效;禁用或卸载插件不会删除已有数据。插件直接复用 OpenTest 的采集、算法、存储和图表,你只需编写自己的测量逻辑或设备对接。[OpenTest-Plugins](https://github.com/crysound/OpenTest-Plugins) 提供 FFT 和 SonoDAQ 插件的完整源码,可作为模板。插件是否开源、是否收费由你决定;开发和销售独立插件不需要额外的商业许可。
-| 你是谁 | 从这里开始 |
-| --- | --- |
-| 想直接使用的工程师 | 下载安装包安装(Windows x64),用云账号登录或导入离线授权,安装需要的插件,按“一次典型的测量”完成第一次测试 |
-| 想参与开发或自行构建 | 阅读[开发者指南](docs/development-and-packaging_cn.md),了解环境准备、源码运行与打包步骤 |
-| 想开发插件 | 阅读 [OpenTest-Plugins](https://github.com/crysound/OpenTest-Plugins) 中的开发说明,以 FFT 插件为模板 |
-| 想采购更多通道或 OEM 授权 | 联系 CRYSOUND |
+**OpenTest CLI。** [`opentest-cli`](cli/README.md) 让 AI 智能体和脚本既能通过正在运行的桌面界面操作 OpenTest,也能直接调用 SDK,帮助工程师把测试经验和专业算法沉淀成可复用的模块。
-**运行环境**:Windows 10/11 x64;建议准备一支能被 Windows 识别的麦克风,用来完成第一次测量。
+## 版本与许可
----
+| 版本 | 通道数 | 主要能力 |
+| :-- | :-- | :-- |
+| **Community 社区版** · 免费 | 4 | 实时监测与信号发生器,基础 FFT、倍频程和扫频 |
+| **Professional 专业版** | 8 | 社区版全部能力,外加算法插件 |
+| **Advanced 高级版** | 24 | 序列模式、分析模式、录制、导出与报告,可选应用 |
+| **Enterprise 企业版** | 不限 | 全部功能与可选应用,API/SDK |
+
+月付、年付、永久授权以及完整功能对比见[定价页](https://www.opentest.com/zh-hans/%E5%AE%9A%E4%BB%B7/),版本划分以定价页为准。
+
+本仓库源码采用 **[OpenTest Community License 1.0](LICENSE.zh-CN.md)**。简单来说:个人使用、教育、科研、软件与产品研发、企业内部使用(包括生产环境),以及用 OpenTest 为客户提供测试服务,都可以免费使用,每套系统最多 **4 个可同时使用的物理通道**。需要更多通道、随硬件或其他产品交付(OEM、ODM、白牌)、出售或再分发,或以收费托管服务形式提供时,需要商业许可。以上为摘要,以协议原文为准。
+
+