vnrobo-agent 0.1.0

Lightweight heartbeat agent for VnRobo Fleet Monitor

vnrobo-agent

Lightweight Python agent that sends robot telemetry to VnRobo Fleet Monitor — the open fleet monitoring dashboard for robotics teams.

from vnrobo_agent import VnRoboAgent

agent = VnRoboAgent(api_key="your-key", robot_id="robot-01")
agent.start()  # sends heartbeat every 60s in background

Install

pip install vnrobo-agent

Requires Python 3.8+. No dependencies beyond requests.

Quick Start

from vnrobo_agent import VnRoboAgent

agent = VnRoboAgent(
    api_key="your-key",   # or set VNROBO_API_KEY env var
    robot_id="robot-01",  # or set VNROBO_ROBOT_ID env var
    interval=30,          # heartbeat every 30s (default: 60)
)
agent.start()

# ... your robot code runs here ...

agent.stop()

Get your free API key at app.vnrobo.com — free for up to 3 robots.

Send Rich Telemetry

agent.send_heartbeat(
    status="busy",                               # online | idle | busy | error | offline
    battery=72.5,                                # battery % 0-100
    location={"lat": 21.0285, "lng": 105.8542}, # GPS or indoor coords
    metadata={"task": "picking", "payload_kg": 3.2},
)

ROS 2 Integration

# Zero-config ROS 2 monitoring (no code required):
# See github.com/VnRobo/ros2-fleet-bridge

# Or use the included example node:
ros2 run your_package vnrobo_heartbeat \
    --ros-args -p api_key:=YOUR_KEY -p robot_id:=my_robot

Full example: examples/ros2_heartbeat.py

Isaac Lab / RL Training

Track training robots in real-time on the dashboard:

agent = VnRoboAgent(api_key=os.environ["VNROBO_KEY"], robot_id="go2-train-01")

# In your training loop:
agent.send_heartbeat(
    status="training",
    metadata={"episode": ep, "reward": float(mean_reward), "step": total_steps},
)

CLI

# Test connectivity
vnrobo-agent ping --api-key YOUR_KEY --robot-id robot-01

# Run as daemon
vnrobo-agent start --api-key YOUR_KEY --robot-id robot-01 --interval 30

# Or via environment variables
export VNROBO_API_KEY=your-key
export VNROBO_ROBOT_ID=robot-01
vnrobo-agent start

Compatibility

Platform	Support
ROS 2 (Humble / Iron / Jazzy)	✅
Isaac Lab / Isaac Sim	✅
Unitree SDK (Go2, G1, H1)	✅
MuJoCo / Gymnasium	✅
Bare Python / embedded	✅

Contributing

git clone https://github.com/VnRobo/vnrobo-agent
cd vnrobo-agent
pip install -e .

Issues and PRs welcome.

License

MIT — see LICENSE.

---

Monitor your robots for free → app.vnrobo.com