An open API service indexing awesome lists of open source software.

https://github.com/jshulgach/neurobridge

NeuroBridge: Where AI perception meets real-time robotics control
https://github.com/jshulgach/neurobridge

ai arduino artificial-intelligence computer-vision gpt4 grounding-dino llama llama3 llm python raspberry-pi robot robotics sam

Last synced: 3 months ago
JSON representation

NeuroBridge: Where AI perception meets real-time robotics control

Awesome Lists containing this project

README

          

# NeuroBridge

NeuroBridge is the open-source runtime project for the assistive exoskeleton AI stack.

It hosts the conversation runtime, safety/policy pipeline, deployment bundle system, telemetry channels, and operator-facing tools for NML Hand Exo workflows.

## Highlights

- Runtime-first architecture with configurable providers and safety validation.
- Deployment bundles (`config/bundles`) for reproducible adapter + policy defaults.
- Simulation-first defaults for safer onboarding (`simulate_exo: true`, `dry_run: true` in default bundle).
- CLI, GUI, and visualizer entrypoints.
- Local source fallback support for cross-repo development with `NML_Hand_Exo`.

## Repository Layout

- `src/neurobridge_assist/`: lightweight launcher and bootstrap.
- `src/nml_hand_exo/`: runtime package (assistant app, adapters, policy, telemetry, UI).
- `config/`: bundles, adapter configs, policy profiles, skill packs.
- `legacy_archive/`: preserved legacy files for reference (not active runtime path).
- `docs/`: project documentation and contributor references.

## Quick Start

From repository root:

```powershell
python -m pip install -e .
neurobridge-assist --bundle nml_default --command "status"
```

Run the direct entrypoints:

```powershell
nml-ai-assist --bundle nml_default --command "status"
nml-ai-assist-gui
nml-exo-state-visualizer
```

Or call the thin launcher module:

```powershell
python main.py --bundle nml_default --command "status"
```

## Typical Two-Terminal Workflow (Simulator)

Terminal A (conversation loop):

```powershell
nml-ai-assist --bundle nml_default --conversation-mode --simulate-exo --dry-run
```

Terminal B (state visualizer):

```powershell
nml-exo-state-visualizer
```

For live simulated execution (state-changing commands), explicitly disable dry-run:

```powershell
nml-ai-assist --bundle nml_default --command "close the hand" --simulate-exo --no-dry-run --auto-confirm
```

If telemetry appears stale, ensure only one listener is attached to the same telemetry port or pick an isolated port:

```powershell
nml-ai-assist --bundle nml_default --conversation-mode --simulate-exo --no-dry-run --telemetry-port 9877
nml-exo-state-visualizer
```

## Configuration Model

- Bundle: `--bundle ` or `--bundle-file `
- Policy profile: `--policy-profile ` or `--policy-profile-file `
- Adapter selection: `--robot-adapter nml_hand_exo|virtual_openclaw`
- Adapter config: `--robot-config `

Useful discovery commands:

```powershell
nml-ai-assist --list-bundles
nml-ai-assist --list-policy-profiles
nml-ai-assist --list-robot-adapters
```

## Optional AI Extras

Install optional speech/provider extras:

```powershell
python -m pip install -e .[ai]
```

## Fallback Import Behavior

`neurobridge-assist` resolves runtime imports in this order:

1. Local NeuroBridge source (`src/nml_hand_exo`)
2. `NML_HAND_EXO_PATH` environment override (expected to point to `NML_Hand_Exo/src`)
3. Sibling fallback path `../NML_Hand_Exo/src`

## Documentation

- [docs/QUICKSTART.md](docs/QUICKSTART.md)
- [docs/CONFIGURATION.md](docs/CONFIGURATION.md)
- [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md)
- [docs/RELEASES.md](docs/RELEASES.md)
- [MIGRATION_NOTES.md](MIGRATION_NOTES.md)

## Contributing and Community

- [CONTRIBUTING.md](CONTRIBUTING.md)
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
- [SECURITY.md](SECURITY.md)
- [SUPPORT.md](SUPPORT.md)

## License

MIT. See [LICENSE](LICENSE).