Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

176 changes: 89 additions & 87 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,146 +1,148 @@
# SwarmPlug
# SwarmPlug ver0.3

### Versioned Infrastructure for Semantic Normalization in ROS Systems
**Semantic Snapshot Specification**

---

## Statement

## 1. Statement
SwarmPlug ver0.3 defines a deterministic semantic snapshot specification
for heterogeneous ROS-based systems.

SwarmPlug is a **versioned infrastructure project**.
It does not coordinate.
It does not transmit.
It does not decide.

It defines deterministic layers for semantic normalization
in heterogeneous ROS-based environments.
**It standardizes semantics.**

SwarmPlug does **not**:
---

- Replace ROS

- Define control logic

- Implement coordination strategies

- Provide intelligence systems
## Problem

Robotic systems expose runtime state in inconsistent forms:

- Different topic names
- Different coordinate conventions
- Different mode representations
- Different task encodings


SwarmPlug defines infrastructure boundaries.
Without semantic normalization, higher-level coordination becomes system-specific.

---

## 2. Development Model
## Position

SwarmPlug evolves through **explicit version layers**.
SwarmPlug ver0.3 defines a neutral semantic abstraction boundary
between ROS runtime and distributed coordination.

Each version:
`Host Runtime → Semantic Abstraction → Snapshot`

- Has a narrowly defined responsibility

- Is boundary-limited

- Is version-scoped

- Does not expand retroactively


New capabilities are introduced only through new versions.
**ver0.3 completes the semantic abstraction layer.**

---

## 3. Version Index
## Architecture (Conceptual)

|Version|Responsibility|
|---|---|
|**ver0.1**|Host attachment|
|**ver0.2**|Canonical identity|
|**ver0.3**|Semantic snapshot model|
```mermaid
flowchart TB

Future versions will be introduced as independent milestones.
subgraph L1["Host Runtime"]
A1["ROS Topics / Services / Params"]
end

---
subgraph L2["Semantic Abstraction"]
B1["Canonical Identity"]
B2["Unified State Fields"]
B3["Deterministic Trigger Model"]
end

## 4. Layered Direction
subgraph L3["Snapshot (v0.3 Schema)"]
C1["meta + identity + state"]
end

SwarmPlug development follows a strict structural progression:
A1 --> B1 --> C1
A1 --> B2 --> C1
B3 --> C1

```
Attachment
Identity
Semantics
Future Layers

```
---

Each layer must remain:
## Determinism

- Deterministic

- Versioned

- Infrastructure-oriented
Snapshot generation follows two defined triggers:

- Event-based

- Boundary-defined
- Periodic


Given identical host state and identical trigger conditions,
the resulting snapshot structure remains invariant.


---

## 5. Scope Discipline
## Schema Boundary

SwarmPlug explicitly separates normalization infrastructure from:
ver0.3 formalizes:

- Runtime control systems

- Transport mechanisms

- Distributed coordination logic
- `meta`
- `identity`
- `state`

- Intelligence or learning layers

Canonical state fields include:

- pose
- twist
- mode

- External anchoring or persistence systems
- task_state (optional)


These domains are outside the core normalization layer.
The schema is versioned.

---

## 6. Stability Principle
## Scope Limitation

Once defined, a version:
SwarmPlug ver0.3 does not include:

- Remains version-scoped

- Remains boundary-limited

- Does not absorb new responsibilities
- Network transport
- Mesh communication
- Blockchain anchoring
- Decision logic
- Control loops


Evolution occurs by addition, not modification.
Those layers are out of scope.

---

## 7. Repository Structure
```
/ver0.1 → Host attachment layer
/ver0.2 → Canonical identity layer
/ver0.3 → Semantic snapshot layer
```

Each directory documents a completed infrastructure layer.

Subsequent versions will be added as independent directories.
## Version Context
| Version | Responsibility |
|---------|----------------------|
| ver0.1 | Host attachment |
| ver0.2 | Canonical identity |
| ver0.3 | Semantic snapshot |

---

## 8. Foundational Principle
## Principle

Infrastructure precedes coordination.
Normalization precedes intelligence.
Versioning precedes expansion.
Determinism precedes distribution.

**ver0.3 establishes the normalization layer.**

## License

This version specification is part of the SwarmPlug documentation.

Licensed under the **SwarmPlug Documentation License v1.0**.

SwarmPlug develops by structure, not by feature accumulation.
## Contact
If you are evaluating SwarmPlug for research or engineering use,feel free to reach out at: swarmplug@gmail.com
See the **main LICENSE** file for details.

**Note:SwarmPlug is developed under a boundary-first philosophy. Core implementation remains private by design.**