systemlink-cli 1.3.1__py3-none-any.whl

slcli/examples/demo-test-plans/README.md

@@ -0,0 +1,132 @@
+# Demo Test Plans Example
+
+This example provides a complete, ready-to-use setup for demonstrating SystemLink test planning workflows.
+
+## What's Included
+
+The example creates the following resources in your SystemLink workspace:
+
+### Infrastructure
+
+- **Location**: Demo HQ (Austin, TX)
+- **Product**: Demo Widget Pro (Industrial Equipment)
+
+### Test Infrastructure
+
+- **Systems**:
+  - Test Stand 1 (Serial: TS-001)
+  - Test Stand 2 (Serial: TS-002)
+- **Assets**:
+  - Asset 1 on Test Stand 1 (Serial: ASSET-001)
+  - Asset 2 on Test Stand 2 (Serial: ASSET-002)
+- **DUTs**:
+  - DUT 1 - Model X1 (Serial: DUT-001) on Asset 1
+  - DUT 2 - Model X2 (Serial: DUT-002) on Asset 2
+
+### Test Planning
+
+- **Test Template**: Demo Test Template
+  - Pre-configured for both test systems
+  - Ready to use in test creation workflow
+
+## Setup Time
+
+Approximately **5 minutes** to provision all resources.
+
+## Installation Steps
+
+### 1. Preview the resources
+
+```bash
+slcli example info demo-test-plans
+```
+
+This shows all 9 resources that will be created.
+
+### 2. Dry-run (validate without creating)
+
+```bash
+slcli example install demo-test-plans -w <workspace-id> --dry-run
+```
+
+### 3. Install to a workspace
+
+```bash
+slcli example install demo-test-plans -w <workspace>
+```
+
+Optionally write an audit log with JSON output:
+
+```bash
+slcli example install demo-test-plans -w <workspace> --audit-log install-log.json --format json
+```
+
+### 4. Verify in SystemLink Web UI
+
+1. Open SystemLink web interface
+2. Navigate to **Assets & Test Planning**
+3. Verify that locations, products, systems, assets, and DUTs are visible
+
+## Using the Example
+
+Once installed, you can:
+
+1. **Create a test** from the Demo Test Template
+2. **Schedule test execution** on Test Stand 1 or Test Stand 2
+3. **Run tests** against DUT 1 or DUT 2
+4. **Track results** in test history
+
+## Cleanup
+
+To remove all example resources:
+
+```bash
+# Preview what would be deleted
+slcli example delete demo-test-plans -w <workspace-id> --dry-run
+
+# Delete all demo-tagged resources in a workspace
+slcli example delete demo-test-plans -w <workspace>
+
+# Write an audit log of deletion results
+slcli example delete demo-test-plans -w <workspace> --audit-log delete-log.json --format json
+```
+
+**Important**: Cleanup only deletes resources tagged with "demo". Any resources you created or modified separately will not be deleted.
+
+## Troubleshooting
+
+### Example installation fails
+
+Check that your workspace exists:
+
+```bash
+slcli workspace list
+```
+
+If no workspace exists, create one:
+
+```bash
+slcli workspace create --name "Default workspace"
+```
+
+### Resources not visible in web UI
+
+1. Ensure you're viewing the correct workspace
+2. Refresh the web browser
+3. Check workspace settings: Assets & Test Planning > Settings
+
+### Can't delete resources
+
+1. Verify workspace permissions
+2. Confirm resources are tagged for deletion in the config
+
+## Next Steps
+
+After installing this example, consider:
+
+1. Creating additional test templates for different product lines
+2. Adding more test systems or DUTs
+3. Creating workflows to automate test execution
+4. Setting up data logging to track results over time
+
+For more information, see the [SystemLink documentation](https://docs.systemlink.local/).

slcli/examples/demo-test-plans/config.yaml

@@ -0,0 +1,154 @@
+---
+# SLE Example Configuration: Demo Test Plans
+format_version: "1.0"
+name: "demo-test-plans"
+title: "Demo Test Plans"
+description: |
+  A complete example demonstrating the end-to-end test planning workflow.
+  Includes systems, assets, DUTs, locations, products, and test templates.
+  Perfect for training and evaluation scenarios.
+
+author: "NI"
+created_date: "2025-12-17"
+updated_date: "2025-12-17"
+tags:
+  - "training"
+  - "beginner"
+  - "test-plans"
+
+estimated_setup_time_minutes: 5
+required_systemlink_version: "2024.1"
+target_workspace: null
+
+resources:
+  # Phase 1: Locations (no dependencies)
+  - type: "location"
+    name: "Demo HQ"
+    properties:
+      address: "123 Main St"
+      city: "Austin"
+      state: "TX"
+      country: "USA"
+    id_reference: "loc_hq"
+    tags: ["demo"]
+
+  # Phase 2: Products (no dependencies)
+  - type: "product"
+    name: "Demo Widget Pro"
+    properties:
+      description: "Professional widget for demonstration"
+      category: "Industrial Equipment"
+      manufacturer: "Demo Inc."
+    id_reference: "prod_widget"
+    tags: ["demo"]
+
+  # Phase 3: Systems (depends on location, product)
+  - type: "system"
+    name: "Test Stand 1"
+    properties:
+      description: "First test system for demo workflow"
+      location_id: "${loc_hq}"
+      product_id: "${prod_widget}"
+      serial_number: "TS-001"
+      status: "operational"
+    id_reference: "sys_ts1"
+    tags: ["demo"]
+
+  - type: "system"
+    name: "Test Stand 2"
+    properties:
+      description: "Second test system for demo workflow"
+      location_id: "${loc_hq}"
+      product_id: "${prod_widget}"
+      serial_number: "TS-002"
+      status: "operational"
+    id_reference: "sys_ts2"
+    tags: ["demo"]
+
+  # Phase 4: Assets (depends on system)
+  - type: "asset"
+    name: "Asset 1 - Stand 1"
+    properties:
+      system_id: "${sys_ts1}"
+      serial_number: "ASSET-001"
+      status: "active"
+    id_reference: "asset_1"
+    tags: ["demo"]
+
+  - type: "asset"
+    name: "Asset 2 - Stand 2"
+    properties:
+      system_id: "${sys_ts2}"
+      serial_number: "ASSET-002"
+      status: "active"
+    id_reference: "asset_2"
+    tags: ["demo"]
+
+  # Phase 5: DUTs (depends on asset)
+  - type: "dut"
+    name: "DUT 1 - Stand 1"
+    properties:
+      asset_id: "${asset_1}"
+      model: "Demo Model X1"
+      serial_number: "DUT-001"
+      status: "ready"
+    id_reference: "dut_1"
+    tags: ["demo"]
+
+  - type: "dut"
+    name: "DUT 2 - Stand 2"
+    properties:
+      asset_id: "${asset_2}"
+      model: "Demo Model X2"
+      serial_number: "DUT-002"
+      status: "ready"
+    id_reference: "dut_2"
+    tags: ["demo"]
+
+  # Phase 6: Templates (no direct dependencies)
+  - type: "testtemplate"
+    name: "Demo Test Template"
+    properties:
+      description: "Basic test template for demo workflow"
+      version: "1.0"
+      systems: ["${sys_ts1}", "${sys_ts2}"]
+      products: ["${prod_widget}"]
+    id_reference: "template_demo"
+    tags: ["demo"]
+
+cleanup:
+  order:
+    - "testtemplate"
+    - "dut"
+    - "asset"
+    - "system"
+    - "product"
+    - "location"
+  filter_tags: ["demo"]
+  require_confirmation: true
+
+validation:
+  require_workspace: true
+
+post_install:
+  instructions: |
+    ✓ Example installed successfully!
+    
+    Resources created:
+    - 1 location: Demo HQ
+    - 1 product: Demo Widget Pro
+    - 2 systems: Test Stand 1, Test Stand 2
+    - 2 assets: Asset 1, Asset 2
+    - 2 DUTs: DUT 1, DUT 2
+    - 1 test template: Demo Test Template
+    
+    Next steps:
+    1. Open SystemLink web interface
+    2. Navigate to Assets & Test Planning
+    3. Create a test by selecting:
+       - System: "Test Stand 1" or "Test Stand 2"
+       - Product: "Demo Widget Pro"
+       - Template: "Demo Test Template"
+    4. Run a test to verify setup
+    
+    Learn more: https://docs.systemlink.local/examples

slcli/examples/exercise-5-1-parametric-insights/README.md

@@ -0,0 +1,101 @@
+# Exercise 5-1: Parametric Insights — Instructor Setup Guide
+
+Supporting training data for **Exercise 5-1: Query and Visualize Parametric Test Data**.
+
+## Overview
+
+This example provisions a realistic six-week dataset of thermal cycle test results for a
+lithium-ion battery pack product (**Model ABC**) collected across three test stands.
+Students use Test Insights to locate the product, group results by system, visualize
+parametric measurements in a data space, and save their work.
+
+## Quick Start
+
+```bash
+# Preview what will be created (recommended before running)
+slcli example install exercise-5-1-parametric-insights -w <workspace> --dry-run
+
+# Install into the target workspace
+slcli example install exercise-5-1-parametric-insights -w <workspace>
+
+# Remove all provisioned resources when the session ends
+slcli example delete exercise-5-1-parametric-insights -w <workspace>
+```
+
+## Resources Provisioned
+
+| Type               | Count | Details                                            |
+| ------------------ | ----- | -------------------------------------------------- |
+| Location           | 1     | Battery Testing Lab (Austin, TX)                   |
+| Products           | 3     | Model ABC (primary), Model XYZ, Model ABC Rev B    |
+| Systems            | 3     | Thermal Cycle Tester TC-01, TC-02, TC-03           |
+| DUTs               | 5     | One per system + XYZ and Rev B units               |
+| Test results       | 18    | Model ABC: 6 cycles per stand, Jan 6 – Feb 13 2026 |
+| Test results       | 4     | Model XYZ acceptance tests (distractor)            |
+| Test results       | 3     | Model ABC Rev B qualification (distractor)         |
+| Incomplete results | 3     | Aborted/skipped runs (realism)                     |
+
+**Total: 28 test results across 3 products**
+
+## Measurements Recorded per Model ABC Result
+
+Each of the 18 Model ABC results carries the following measurement properties:
+
+| Field                                           | Unit | Spec limit    |
+| ----------------------------------------------- | ---- | ------------- |
+| `cycle_count`                                   | —    | informational |
+| `cell_temperature_1_c` … `cell_temperature_4_c` | °C   | max 42 °C     |
+| `ambient_temperature_c`                         | °C   | informational |
+| `terminal_voltage_v`                            | V    | min 3.70 V    |
+| `charge_current_a`                              | A    | 1.20 – 1.60 A |
+| `capacity_ah`                                   | Ah   | min 50.0 Ah   |
+| `internal_resistance_mohm`                      | mΩ   | max 20.0 mΩ   |
+| `state_of_charge_pct`                           | %    | min 98.0 %    |
+
+## Deliberate Data Patterns for Student Discovery
+
+The dataset contains several anomalies that students should discover through the
+visualization tasks in the exercise:
+
+### TC-03 Temperature Offset (Step 3.13 — Color by System)
+
+TC-03 consistently runs **3–4 °C warmer** than TC-01 and TC-02 across all six cycles.
+When students color a scatter plot by System, this offset becomes immediately visible.
+Instructors can prompt: _"What might cause one stand to run consistently hotter?"_
+(Suggested answer: chamber thermocouple calibration drift.)
+
+### TC-01 Cycle 5 — Internal Resistance Spike (Feb 4, FAIL)
+
+`internal_resistance_mohm` spikes to **21.4 mΩ** (spec: ≤ 20.0 mΩ), causing the only
+FAIL result on TC-01. The value returns to 15.8 mΩ in Cycle 6 after maintenance.
+Visible in a line chart with Time on X-axis and `internal_resistance_mohm` on Y-axis.
+
+### TC-03 Cycle 4 — Cell Temperature Spike (Jan 30, FAIL)
+
+`cell_temperature_3_c` spikes to **44.8 °C** (spec: ≤ 42 °C) while the other three
+channels remain normal (~41 °C). This isolated channel spike, visible in a line chart,
+suggests a faulty cell or mounting contact rather than an ambient condition.
+
+### Capacity and Voltage Aging Trend
+
+Both `capacity_ah` and `terminal_voltage_v` show a slow monotonic decrease across all
+three stands (approximately 1 Ah and 0.05 V over six cycles). This is consistent with
+normal lithium-ion aging and is visible when plotting with Time on X-axis.
+
+### Distractor Products
+
+The Products table will show **Model ABC**, **Model XYZ**, and **Model ABC Rev B**.
+Students must identify the correct product by part number `BAT-MODEL-ABC-001`, not just
+by name. Model XYZ uses different measurement fields (capacitor bank); Model ABC Rev B
+uses the same fields but with noticeably lower internal resistance (~10 mΩ vs ~12–15 mΩ),
+illustrating the design improvement.
+
+## Estimated Setup Time
+
+~5 minutes
+
+## Requirements
+
+- SystemLink Enterprise 2024.1 or later
+- Test Insights module with Data Spaces enabled
+- Target workspace must exist before running install