unmnd / nv.py

A more modern robotics framework

nv Robotics Framework

Welcome to the documentation for nv (pronounced envy), a new robotics framework designed to make robot development easier, and more accessible than ever before.

Looking for the nv website? Click here

Looking for the Python version of nv? Click here

Looking for the JavaScipt version of nv? Click here

nv is built on two core concepts:

1. Simplicity - completing tasks and reaching development milestones should be as easy as possible for the developer, without unecessary boilerplate, configuration and setup processes, or additional dependencies that might not be used.
2. Flexibility - anything a developer wants to do should be possible with minimal additional work or implementation procedures.

While a lot of the concepts and interfaces within nv are similar to another popular robot framework, ROS (Robot Operating System), there are numerous changes and tweaks which make nv a more suitable framework for many developers.

Licensing

nv has been published on GitHub under GPL-3.0-or-later, however you way wish to use nv in a way which is not compatible with this license, such as within a distributed closed-source project.

If this is the case, please contact us at [e-mail] with your requirements for alternative licensing options.

Quickstart

Install using a package manager

$ pip install nv-framework
$ npm install nv-framework

Run the official Docker container

$ docker run -it ghcr.io/unmnd/nv.py
$ docker run -it ghcr.io/unmnd/nv.js

Introduction to nv

🌐 1. Overview of an nv network

💬 2. Communicating within an nv network

🗃️ 3. Getting and setting parameters

📐 4. Installing the nv framework

⌨️ 5. nvcli - Command line tools

Tutorials

🌱 Writing your first node (Python)

🌱 Writing your first node (JavaScript)