Developer Documentation

Everything you need to connect your robots to VnRobo Fleet Monitor.

Get Started in 2 Minutes

Install the agent, connect your robot, see it on your dashboard.

1. Install the agent

vnrobo-agent is a lightweight Python package. Only requires requests.

bash

pip install vnrobo-agent

2. Connect from Python

Initialize the agent with your API key and robot ID. Heartbeats are sent automatically in the background.

python

from vnrobo_agent import VnRoboAgent

agent = VnRoboAgent(
    api_key="your-api-key",
    robot_id="your-robot-id",
    interval=60  # heartbeat every 60 seconds
)
agent.start()

3. Or use the CLI

For quick testing or non-Python environments, use the CLI directly.

bash

vnrobo-agent start \
  --api-key=vnr_prod_xxxx \
  --robot-id=AMR-01 \
  --interval=60