Skip to content
This repository was archived by the owner on Oct 20, 2026. It is now read-only.

About

Persistent equipment states and observed runtime from scalar signals. By SuperJupiter. Hardware validation pending.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

SuperJupiter MachineState

Consolidated library available

For new projects, start with SuperJupiter Sensor Toolkit. This standalone package and its published releases remain available. Existing installations need no change.

If migrating with PlatformIO, replace the standalone dependency with:

lib_deps = superjupiter/[email protected]

Replace this standalone include:

#include <SuperJupiterMachineState.h>

with this consolidated include:

#include <SuperJupiter/SensorToolkit/MachineState.h>

The component namespace and behaviour are preserved from standalone 0.1.1. If using an earlier version, review its API migration requirements first. Use one implementation of this component per application; do not mix standalone and consolidated copies.

See the consolidated migration guide and consolidated README for Arduino/CMake installation. Hardware validation pending.

Persistent equipment states and observed runtime from scalar signals.

Version 0.1.1: evolving preview. Hardware validation pending.

Original MIT-licensed portable C++11 by SuperJupiter. No mandatory service, hidden clock reads, network calls or heap allocation in the core.

What it does

A scalar activity signal <=stoppedThreshold suggests Stopped, >=runningThreshold suggests Running, otherwise Idle. A candidate must persist for settleMs across qualifying observations. Changing candidates restarts persistence. Missing or invalid input changes state to Unknown; no runtime is inferred across a gap exceeding maxGapMs. Intervals within the gap limit are attributed to the previous confirmed state, including candidate transition time. Use measured signal-specific thresholds; inferred states are not guaranteed physical truth. Not a machinery safety controller.

Install

PlatformIO exact release (after registry publication):

lib_deps = superjupiter/[email protected]

Arduino: use the versioned GitHub release ZIP. Library Manager registration and index propagation are separate steps; check the official index before relying on IDE availability.

Example

#include <SuperJupiterMachineState.h>
using namespace superjupiter::machine_state;
int main() {
MachineState machine(Config(2,50,1000,5000));
machine.push(100,0);
Result state=machine.push(100,1000);
(void)state;
return 0;
}

For Arduino, open examples/Minimal. It uses synthetic data only. Results are deliberately local so applications can inspect outcomes before adding I/O.

CMake

add_subdirectory(path/to/superjupiter-machine-state)
target_link_libraries(your_app PRIVATE SuperJupiter::MachineState)

For an installed package use find_package(SuperJupiterMachineState 0.1 CONFIG REQUIRED). Top-level CMake builds tests/examples; a subproject does not enable developer tools by default.

Documentation and verification

cmake -S . -B build/cmake
cmake --build build/cmake
ctest --test-dir build/cmake --output-on-failure
python3 tools/check_release.py --tag v0.1.1

Keep raw observations and their provenance in your application. Derived results are not physical truth. Do not use fast-math or finite-math-only compiler assumptions. AVR double may have float precision. Software tests, board compilation and physical validation are reported separately.

Fits the SuperJupiter measurement portfolio

Complements SensorQuality and SampleWindow without a required dependency. Each component can be used independently. Domain models, customer data and proprietary applications are excluded.

Support and licence

MIT. Report reproducible bugs through repository issues; private security reports: [email protected]. Include version, configuration, inputs, expected and observed behaviour. No credentials or private customer data.

Compatibility review 0.1.1

This patch includes independent regression tests and a reviewed interoperability contract. Hardware validation pending.

  • Removed unused duplicated math helpers and unnecessary includes.
  • Invalid numeric observations clear continuity while preserving monotonic observation time; out-of-order invalid data cannot mutate state.

About

Persistent equipment states and observed runtime from scalar signals. By SuperJupiter. Hardware validation pending.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages