← Back to Skills Marketplace
yujiecharles

ECG-AI-Diagnosis

by yujiecharles · GitHub ↗ · v0.9.1 · MIT-0
cross-platform ✓ Security Clean
160
Downloads
2
Stars
0
Active Installs
4
Versions
Install in OpenClaw
/install ecg-ai-diagnosis
Description
Analyze ECG signals via heartvoice (心之声) API — single-lead and 12-lead. Automatically selects endpoint based on user intent and responds in the user's langua...
README (SKILL.md)

heartvoice ECG Analysis Skill

Analyze ECG data via the heartvoice (心之声) cloud API. The agent is responsible for detecting user intent (1-lead vs 12-lead) and language (Chinese vs English), then passing the appropriate explicit flags to the CLI script. The script itself requires explicit --mode and --lang parameters — all "automatic" behavior lives in the agent layer, not the script.

When to Activate

  • User wants to analyze ECG / heart rhythm / electrocardiogram data
  • User provides a JSON file containing ECG signal data
  • Code or conversation mentions 心电图, ECG, 心电分析, 心律分析
  • Keywords: 单导联, 十二导联, 1-lead, 12-lead, single lead, twelve lead
  • User asks about arrhythmia detection, QRS/QT intervals, or signal quality
  • User says "analyze ECG", "分析心电", "ecg diagnosis", or similar

Environment Setup

# Required — get your key at https://www.heartvoice.com.cn/aiCloud
export HEARTVOICE_API_KEY="your_api_key"

# Install dependencies
pip install requests

Never hardcode API keys. Always use environment variables or .env files.

Agent Responsibilities

The agent (not the CLI script) is responsible for two kinds of detection:

1. Detect analysis type → pass as CLI mode

Scan the user message for keywords and map to the explicit CLI mode argument:

User Intent CN Keywords EN Keywords CLI Mode
Single-lead signal 单导联、单导、1导联 1-lead, single lead, one lead 1-lead
12-lead signal 十二导联、12导联、多导联 12-lead, twelve lead 12-lead

If the user does not specify a type, ask before running the script:

  • Chinese: "请问您要分析的是单导联信号还是十二导联信号?"
  • English: "Would you like to analyze a single-lead or 12-lead signal?"

2. Detect user language → pass as --lang flag

Detect the language the user writes in and pass it as the --lang CLI flag:

User Language --lang Value
Chinese (中文) zh (default)
English en

Then respond entirely in that language throughout the session.

Workflow

  1. Agent detects analysis type (1-lead / 12-lead) from user message keywords. If ambiguous, ask.
  2. Agent detects user language (zh / en) from the message.
  3. Agent extracts file path from the user message.
  4. Agent runs the CLI script with explicit arguments: python3 scripts/call_api.py \x3Cmode> --json_path \x3Cpath> --lang \x3Clang>.
  5. Agent parses the structured JSON output from stdout.
  6. Agent presents the result as a natural-language report in the user's language.

Script Commands

# 1-lead signal analysis (Chinese output)
python3 scripts/call_api.py 1-lead --json_path \x3Cpath/to/file.json>

# 1-lead signal analysis (English output)
python3 scripts/call_api.py 1-lead --json_path \x3Cpath/to/file.json> --lang en

# 12-lead signal analysis (Chinese output)
python3 scripts/call_api.py 12-lead --json_path \x3Cpath/to/file.json>

# 12-lead signal analysis (English output)
python3 scripts/call_api.py 12-lead --json_path \x3Cpath/to/file.json> --lang en

Set --lang zh (default) or --lang en based on the language the user writes in.

Input File Formats

ADC Conversion Formula

The data arrays contain raw sample values from your recording device (integers or floats, depending on the device). The API internally converts them to millivolts (mV) using:

voltage_mV = (sampleValue - adcZero) / adcGain
  • adcZero — the sample value that corresponds to 0 mV (baseline offset)
  • adcGain — the number of sample units per 1 mV

Example 1 (integer samples): adcGain = 1000, adcZero = 0, sample = 512voltage = (512 - 0) / 1000 = 0.512 mV.

Example 2 (float samples, already in mV): if your device outputs values already in millivolts (e.g. 0.512), set adcGain = 1.0 and adcZero = 0.0 so the formula becomes a no-op: voltage = (0.512 - 0) / 1 = 0.512 mV.

These two parameters must match your recording device's output configuration; incorrect values will produce wrong voltage readings and unreliable diagnoses.

1-lead JSON

{
  "ecgData": [0.512, 0.515, 0.520, 0.518, 0.525, 0.530, 0.528, 0.535],
  "ecgSampleRate": 500,
  "adcGain": 1.0,
  "adcZero": 0.0
}

In this example, values are already in mV, so adcGain = 1.0 and adcZero = 0.0 (identity conversion). If your device outputs raw integer ADC values instead, adjust adcGain and adcZero accordingly.

Field Type Required Description
ecgData number[] Yes Sample value array — integers or floats, converted to mV via the formula above
ecgSampleRate number Yes Sampling rate in Hz (e.g. 500)
adcGain number Yes Sample units per 1 mV
adcZero number Yes Sample value corresponding to 0 mV baseline

12-lead JSON

{
  "dataI":   [...], "dataII":  [...], "dataIII": [...],
  "dataAVR": [...], "dataAVL": [...], "dataAVF": [...],
  "dataV1":  [...], "dataV2":  [...], "dataV3":  [...],
  "dataV4":  [...], "dataV5":  [...], "dataV6":  [...],
  "ecgSampleRate": 500,
  "adcGain": 1000.0,
  "adcZero": 0.0
}

In this example, values are raw integer ADC samples with adcGain = 1000 (1000 units = 1 mV).

Field Type Required Description
dataIdataV6 number[] Yes 12 lead sample arrays (I, II, III, aVR, aVL, aVF, V1–V6) — integers or floats, converted to mV via the formula above
ecgSampleRate number Yes Sampling rate in Hz
adcGain number Yes Sample units per 1 mV — shared across all 12 leads
adcZero number Yes Sample value corresponding to 0 mV baseline

Response Format

The fields below are the script's output (printed to stdout as JSON). The script normalizes the API's camelCase field names (e.g. avgHr, avgQrs, isAbnormal) to snake_case (e.g. avg_hr, avg_qrs, is_abnormal) for consistency. When reading the script output, always use the snake_case names listed here.

1-lead response fields

Field Type Description
status string "success" or "error"
summary string Natural-language summary in requested language
diagnosis string[] Label list, e.g. ["SN"]
possible_diagnosis string[] Possible labels list
is_abnormal boolean Whether abnormal rhythm detected
is_reverse boolean Whether lead reversal detected
sq_grade string Signal quality score, e.g. "0.95"
avg_hr number Average heart rate (bpm)
avg_qrs number QRS duration (ms)
pr_interval number PR interval (ms)
avg_qt number QT interval (ms)
avg_p number P wave duration (ms)
avg_qtc number Corrected QT interval (ms)
pac_count number Atrial premature beat count
pvc_count number Ventricular premature beat count

12-lead response fields

Field Type Description
status string "success" or "error"
analysis_state boolean Whether analysis succeeded
summary string Natural-language summary in requested language
diagnoses object[] Array of {"label", "result", "description"}
diagnosis_results string[] Flat list of result strings
risk_level number Risk level — 0 = normal
HR number Heart rate (bpm)
atrial_rate number Atrial rate (bpm)
ventricular_rate number Ventricular rate (bpm)
P / PR / QRS / QT / QTc / T number Intervals (ms)
QRS_axis / P_axis / T_axis number Electrical axes (degrees)
SV1 / SV2 / SV5 / RV1 / RV2 / RV5 / RV6 number Wave amplitudes (mV)

Examples

Example 1 — Chinese user, single-lead

用户:请帮我分析这个单导联信号,数据放在 data/ecg_data.json 里

Agent runs:

python3 scripts/call_api.py 1-lead --json_path data/ecg_data.json --lang zh

Output:

{
  "status": "success",
  "summary": "检测到:窦性心律。平均心率 72 次/分钟,QRS 宽度 86 毫秒,PR 间期 156 毫秒,QT 间期 380 毫秒,QTc 412 毫秒,P 波宽度 102 毫秒。信号质量 0.95。房性早搏 0 次,室性早搏 0 次。",
  "diagnosis": ["SN"],
  "possible_diagnosis": [],
  "is_abnormal": false,
  "avg_hr": 72,
  "sq_grade": "0.95"
}

Agent responds:

分析完成。该心电信号显示窦性心律,平均心率 72 次/分钟,各项参数均在正常范围内。信号质量评分 0.95(优秀),未检测到房性或室性早搏。

Example 2 — English user, 12-lead

User: Analyze my 12-lead ECG data from records/12lead.json

Agent runs:

python3 scripts/call_api.py 12-lead --json_path records/12lead.json --lang en

Output:

{
  "status": "success",
  "summary": "Detected: Sinus Rhythm. Heart rate 75 bpm, QRS duration 88 ms, PR interval 160 ms, QT interval 376 ms, QTc 420 ms, P wave 100 ms, T wave 180 ms. Risk assessment: normal.",
  "diagnoses": [{"label": "SN", "result": "Sinus Rhythm", "description": "Normal sinus rhythm"}],
  "risk_level": 0,
  "HR": 75
}

Agent responds:

Analysis complete. The 12-lead ECG shows Sinus Rhythm with a heart rate of 75 bpm. All intervals are within normal range. Risk level: normal (0).

Example 3 — Ambiguous intent

User: Can you analyze this ECG for me? The file is at data/signal.json

Agent asks:

Would you like to analyze a single-lead (1-lead) or 12-lead signal?

Error Handling

Situation Action
File not found Report the exact path; ask user for the correct path
Missing JSON fields List the missing required fields by name
HEARTVOICE_API_KEY not set Tell the user to visit https://www.heartvoice.com.cn/aiCloud to obtain an API Key and set it as the HEARTVOICE_API_KEY environment variable
HTTP error from API Show status code and error message from the response
API business error (errorCode != 0) Show the error message returned by the API
File too large (> 5 MB) Tell the user the file exceeds the 5 MB limit
Ambiguous intent Ask whether the data is 1-lead or 12-lead

Security & Privacy

Data flow: This skill reads a user-specified local JSON file and sends its contents (ECG signal data, sample rate, ADC parameters) over HTTPS to the heartvoice cloud API (api.heartvoice.com.cn) for analysis. The user should be aware that their ECG data leaves the local machine. No other files or environment variables beyond HEARTVOICE_API_KEY are accessed.

  • Never hardcode API keys in scripts or commit them to version control
  • ECG data is sensitive medical data — do not log or store raw signal data unnecessarily; inform the user before transmitting
  • Always use HTTPS (the API endpoint enforces TLS)
  • Add .env to .gitignore if using dotenv files
  • The skill only reads the file path explicitly provided by the user — it does not scan or access other files
  • This tool provides AI-assisted analysis only; it is NOT a substitute for professional medical diagnosis

Tips

  • Signal quality (sq_grade) below 0.6 usually indicates noisy data — suggest the user re-record or check electrode contact
  • For 12-lead analysis, all 12 lead arrays must be present; partial data will fail field validation
  • The adcGain and adcZero values must match your recording device's ADC configuration — see the ADC Conversion Formula section for how they translate raw samples to millivolts
  • JSON file size limit is 5 MB
  • Typical ecgSampleRate values: 250, 500, 1000 Hz — check your device specs
  • Use the example files in data/ to verify your setup before analyzing real signals

Programmatic Usage

You can also import the script functions directly in Python:

import os
from scripts.call_api import load_json, build_1lead_payload, call_api, format_1lead_result

api_key = os.environ["HEARTVOICE_API_KEY"]
data = load_json("data/example_1lead.json")
payload = build_1lead_payload(data)
raw_result = call_api(
    "https://api.heartvoice.com.cn/api/v1/basic/ecg/1-lead/analyze",
    payload, api_key
)
output = format_1lead_result(raw_result)
print(output["summary"])
print(f"Heart rate: {output['avg_hr']} bpm")
Usage Guidance
This skill is internally consistent: it reads a local ECG JSON file and sends that data (and only that data) to heartvoice's cloud API using the HEARTVOICE_API_KEY. Before installing or using it: - Treat ECG JSON as sensitive health data (PHI). Obtain patient consent and follow applicable laws (HIPAA, GDPR, local medical regulation). - Verify the vendor (https://www.heartvoice.com.cn/aiCloud), review their privacy/processing policies, and confirm TLS endpoints and data retention policies. - Keep HEARTVOICE_API_KEY secret (use env vars, do not paste into chat). Rotate and scope the key if the vendor supports it. - Test first with synthetic or anonymized example data rather than real patient data. - Limit file sizes and confirm the 5 MB client-side check is acceptable for your devices; review any additional logging/telemetry you may have in your environment. - If you require on-prem or non-cloud processing for compliance, do not use this skill. Confidence is high that the package does what it claims; the primary residual risk is privacy/regulatory (sensitive data sent to an external cloud), not covert or unrelated code behavior.
Capability Analysis
Type: OpenClaw Skill Name: ecg-ai-diagnosis Version: 0.9.1 The skill is a legitimate tool for analyzing ECG data via the Heartvoice cloud API. The core logic in `scripts/call_api.py` is well-structured, uses standard libraries (requests, argparse), and strictly adheres to the stated purpose of processing ECG JSON files and communicating with the official API endpoints (api.heartvoice.com.cn). The documentation in `SKILL.md` and `README.md` provides clear instructions for the AI agent, including necessary privacy warnings regarding medical data and proper environment variable management for the API key.
Capability Assessment
Purpose & Capability
Name/description (ECG analysis via heartvoice) match the files and runtime behavior. The only required secret is HEARTVOICE_API_KEY and the script calls heartvoice API endpoints (api.heartvoice.com.cn) — this is expected for the declared purpose.
Instruction Scope
SKILL.md instructs the agent to read a user-provided local JSON file, detect lead type/language, and run scripts/call_api.py which POSTs the JSON to heartvoice over HTTPS. This is coherent but important: the agent will read local files and transmit potentially sensitive medical data to an external service. The README explicitly notes this data flow.
Install Mechanism
No install spec in registry; the only dependency is the widely used 'requests' Python package listed in requirements.txt. There are no downloads from unknown URLs or archives to extract.
Credentials
Only HEARTVOICE_API_KEY is required and declared as the primary credential. SKILL.md and code only read that env var and user-specified JSON files; there are no unrelated credentials or config paths requested.
Persistence & Privilege
The skill is not always-enabled (always:false) and does not request elevated or persistent system privileges. It does not modify other skills or system configs.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install ecg-ai-diagnosis
  3. After installation, invoke the skill by name or use /ecg-ai-diagnosis
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v0.9.1
- Clarified that all endpoint and language auto-detection logic should be implemented in the agent, not the CLI script. - Updated and expanded JSON input format documentation to distinguish integer and float sample values and provide explicit conversion examples. - Adjusted terminology from "ADC value" to "sample value" for input data to reflect varying device output types. - Explicitly documented that the CLI script requires explicit arguments for mode and language; there is no internal auto-detection. - Clarified and updated the field naming conventions for script output (snake_case) for integration consistency.
v0.9.0
Version 0.9.0 - Initial public release of the ECG AI diagnosis skill. - Added support for both 1-lead and 12-lead ECG JSON file analysis via heartvoice (心之声) cloud API. - Automatically detects user intent and language; selects proper analysis endpoint and responds in the user's language. - Provides extensive documentation on required JSON formats, ADC conversion, and API result fields. - Includes usage examples, error handling guidelines, and new sample data files for 1-lead and 12-lead ECG.
v0.8.1
- Updated API key environment variable from XINZHISHENG_API_KEY to HEARTVOICE_API_KEY and adjusted documentation. - Reworded guidance for obtaining the API key and updated the registration/login link for clarity. - Improved the error message for missing API key to direct users to the correct cloud login page. - No functional changes; documentation and usage instructions updated for consistency.
v0.8.0
- Improved user experience: Skill now auto-detects both ECG type (1-lead or 12-lead) and user language, responding in the appropriate language. - Intuitive workflow: Determines file path and analysis mode directly from the user message. - Error handling expanded to cover missing files, API keys, required fields, and ambiguous inputs with clear instructions in the user’s language. - Detailed documentation of input formats, API usage, and response fields for both 1-lead and 12-lead ECG analyses. - Updated examples and workflow for both Chinese and English users.
Metadata
Slug ecg-ai-diagnosis
Version 0.9.1
License MIT-0
All-time Installs 1
Active Installs 0
Total Versions 4
Frequently Asked Questions

What is ECG-AI-Diagnosis?

Analyze ECG signals via heartvoice (心之声) API — single-lead and 12-lead. Automatically selects endpoint based on user intent and responds in the user's langua... It is an AI Agent Skill for Claude Code / OpenClaw, with 160 downloads so far.

How do I install ECG-AI-Diagnosis?

Run "/install ecg-ai-diagnosis" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is ECG-AI-Diagnosis free?

Yes, ECG-AI-Diagnosis is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does ECG-AI-Diagnosis support?

ECG-AI-Diagnosis is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created ECG-AI-Diagnosis?

It is built and maintained by yujiecharles (@yujiecharles); the current version is v0.9.1.

💬 Comments