Skip to content

GreenShoeGarage/Sensorium

Repository files navigation

SENSORIUM v3.0

SENSORIUM is a local-first field instrument for designing defensible sensing systems from the physical phenomenon through installed validation, deployment, review, and evidence.

Its central question is:

Can the complete sensing system reliably distinguish the physical states the project needs to tell apart?

SENSORIUM preserves facts, measurements, calculations, assumptions, recommendations, unknowns, confounders, stale evidence, and accepted limitations. It does not compress engineering judgment into a single observability score.

Run locally

  1. Download sensorium-v3.0.html.
  2. Open it in a current desktop browser.
  3. No server, account, installation, or internet connection is required.
  4. Projects and the reusable engineering library save locally in the browser.
  5. Export project JSON and library JSON for portable backup.

The application does not transmit project information.

SENSORIUM v3.0 design environment

v3.0 adds five connected design workspaces to the complete v2.9 workflow:

What-if Analysis → Architecture Comparison → Observability Map → Measurement Argument → Engineering Libraries

These additions make it possible to explore alternatives without overwriting the working design, compare complete sensing architectures, see shared system weaknesses, state the technical measurement argument, and reuse evidence-backed local engineering records.

Complete workflow

The core engineering thread remains:

Phenomenon → Sensor → Placement → Interface → Calibrate → Validate

SENSORIUM extends that thread through:

Analytics → What-if → Multi-sensor → Architectures → Logging → Deployment → Review → Observability → Observability Map → Measurement Argument → Evidence Package

A persistent Requirement Thread keeps one measurement objective in context across the technical workspaces. Upstream changes mark affected downstream evidence stale instead of silently treating old conclusions as current.

Workspaces

Overview

Shows Requirement Thread coverage, current observability, stale downstream stages, next actions, templates, operational readiness, what-if records, architecture decisions, map findings, measurement arguments, and reusable library records.

Phenomenon

Defines stable requirement IDs, physical quantities, units, ranges, normal and target states, thresholds, sensitivity, timing, environment, interfering conditions, evidence basis, and the supported decision.

Sensors

Compares candidates requirement by requirement. Every suitability result includes its reasons. Roles include primary, reference, redundant, comparison, candidate, and rejected.

Placement

Provides image-backed sensor markers, orientation and sensitive-axis arrows, cable paths, scale metadata, placement templates, and installed-location checks.

Diagrams

Combines physical placement, signal chain, power, grounding, calibration setup, and validation setup in one editable, layer-based diagram workspace.

Interface

Builds the signal chain and checks compatibility, power headroom, ADC span and quantization, sampling, filtering, latency, throughput, storage, shielding, grounding, bus conflicts, and termination.

Calibration

Manages calibration plans, named runs, repeated observations, increasing and decreasing sequences, CSV mapping, regression, residuals, R², RMSE, repeatability, hysteresis, and correction preview.

Uncertainty

Maintains requirement-specific and shared contributors, distributions, divisors, sensitivity coefficients, expanded uncertainty, threshold comparison, and guard bands. Unknown values remain visible and outside the numeric combination.

Validation

Stores installed-system procedures and individual trials for range, thresholds, response time, repeatability, false positives, false negatives, interference, power interruption, communications loss, disconnection, and reference comparison.

Analytics

Imports time-series CSV evidence and calculates baseline statistics, noise, drift, gaps, threshold crossings, condition separation, and reference RMSE.

What-if Analysis

Creates non-destructive alternatives for:

  • Sensor and placement
  • Sampling rate and filtering
  • ADC resolution
  • Cable length
  • Uncertainty multiplier
  • Decision threshold
  • Interface latency
  • Reference channel

Each scenario exposes blocking findings, cautions, strengths, signal-to-uncertainty separation, ADC counts, timing margin, and preserved tradeoffs. Up to four scenarios can be compared side by side. A reviewed scenario can be applied explicitly to the working design, which records downstream change impact.

Multi-sensor

Defines redundant, differential, reference-compensated, voting, complementary-modality, and derived architectures with explicit channels, roles, weights, decision rules, fallback behavior, common-cause risks, and validation plans.

Architecture Comparison

Compares complete sensing-system options rather than isolated sensor specifications. Each option can link:

  • A requirement
  • A what-if scenario
  • A multi-sensor architecture
  • A sampling and logging plan
  • Cost, power, complexity, maintainability, and replaceability assumptions
  • Strengths, limitations, and retained rationale

The architecture decision record preserves the preferred option, constraints, reviewer, status, and rejected alternatives.

Logging

Defines acquisition rate, channel count, packet overhead, throughput, buffering, storage, retention, timestamps, synchronization, missing-data handling, offline recovery, file schema, and quality flags.

Deployment

Carries the design into installed-asset, commissioning, calibration-due, inspection, service, repair, replacement, and decommissioning records.

Review

Supports structured engineering review with questions, concerns, requested evidence, requested changes, approval conditions, responses, resolution status, snapshots, and revision comparison.

Observability

Evaluates every focused requirement across sensor fit, state separation, placement, confounders, interface, sampling, uncertainty, calibration, validation, reference channels, and change impact.

Classifications are:

  • Clearly observable
  • Observable with validation
  • Marginally observable
  • Confounded
  • Not observable
  • Insufficient information

Every result includes plain-language reasoning, evidence gaps, assumptions, and corrective actions.

Observability Map

Shows observability as a requirement-by-factor matrix. The map supports classification and hotspot filters, CSV and SVG exports, factor summaries, shared dependencies, and common-cause findings. It is a navigation and review instrument, not a combined score.

Measurement Argument

Builds an editable nine-part technical argument:

  1. Required distinction
  2. Physical phenomenon
  3. Sensor response
  4. Placement effects
  5. Signal acquisition
  6. Calibration establishes meaning
  7. Remaining uncertainty
  8. Validation demonstrates performance
  9. Limitations and unresolved evidence

Arguments retain explicit assumptions, conclusion, author, reviewer, date, and status. They can be refreshed from current evidence, duplicated, exported as text or standalone HTML, and included in the evidence package.

Engineering Libraries

Maintains reusable local records for:

  • Sensors
  • Interface components
  • Reference standards
  • Uncertainty templates
  • Validation procedures
  • Placement patterns
  • Known confounders

Records preserve source, evidence, usage notes, and structured reusable data. Library records can be captured from a project, applied to the focused requirement, exported, and imported. Reuse never bypasses project checks.

Evidence Package

Builds a selectable 22-section package including scenarios, architecture comparison, observability map, and measurement arguments alongside the full design, calibration, uncertainty, validation, deployment, review, traceability, history, and evidence index.

Exports include standalone HTML, evidence JSON, project JSON, CSV appendices, browser Print / Save PDF, and diagram SVGs.

Easy Mode 2.0

Easy Mode asks for the intended measurement or detection, expected span, supported decision, environment, controller or logger, timing, power, and reference access. It creates a linked starter architecture with visible recommendations and assumptions. Moving into Advanced Mode retains all data.

Local data and project safety

SENSORIUM includes:

  • Automatic local saving with visible status
  • Recovery snapshots
  • Versioned project schema migration
  • Import validation and repair reporting
  • Project integrity checks
  • Active-project and all-project JSON backup
  • Duplicate, archive, rename, and delete controls
  • Clear Sample Data
  • Start Fresh
  • Clean New Project behavior
  • Separate portable engineering-library backup

New Project and Start Fresh create a genuinely clean active workflow.

Included files

  • sensorium-v3.0.html — complete standalone application
  • README.md — operating guide
  • CHANGELOG.md — v3.0 release record
  • DATA-SCHEMA.md — schema 7 documentation
  • KEYBOARD-SHORTCUTS.md — controls and navigation
  • TEST-NOTES.md — release validation record
  • SAMPLE-MEASUREMENT.csv — import-ready sample data
  • ENGINEERING-LIBRARY-SAMPLE.json — portable starter library
  • QA-v3-overview.png — overview screenshot
  • QA-v3-scenarios.png — what-if screenshot
  • QA-v3-observability-map.png — observability-map screenshot

Sample project

The embedded Motor Bearing Temperature and Vibration Monitoring project demonstrates:

  • Temperature and vibration requirements
  • Primary and reference sensors
  • Placement tradeoffs and confounding airflow
  • Signal-chain and sampling checks
  • Calibration observations
  • Unknown and numeric uncertainty contributors
  • Installed-system validation and false-positive evidence
  • Time-series measurement analytics
  • Multi-sensor architecture
  • Logging, deployment, and review records
  • Three what-if scenarios
  • Three competing complete architectures
  • A proposed architecture decision
  • Requirement-level observability mapping
  • A generated measurement argument

The sample intentionally includes unresolved and confounded conditions so the application demonstrates engineering judgment rather than a falsely complete design.

Important boundary

SENSORIUM calculations and generated findings support engineering work; they do not certify a real installation. Review exact component datasheets, applicable standards, calibration traceability, safety requirements, environmental conditions, and measured evidence before relying on a design.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages