axbot-ts-sdk

TypeScript SDK for controlling Autoxing AMRs via REST and WebSocket APIs.

Installation

npm install @kingsimba/axbot-sdk

Modules

The SDK is split into sub-path exports — import only what you need:

| Import path | Contents | |---|---| | @kingsimba/axbot-sdk/robotApi | REST API client (RobotApi) and all request/response types | | @kingsimba/axbot-sdk/ws | WebSocket client (WsClient), WsEventEmitter, WsMessageStore | | @kingsimba/axbot-sdk/objectStore | Reactive data stores (ObjectStore, ArrayObjectStore) | | @kingsimba/axbot-sdk/msgs | Topic message type definitions | | @kingsimba/axbot-sdk/decoder | Binary WebSocket frame decoder | | @kingsimba/axbot-sdk/mapInfo | Map info utilities | | @kingsimba/axbot-sdk/pointCloudParser | Point cloud data parser | | @kingsimba/axbot-sdk/pbMessages | Protobuf message helpers | | @kingsimba/axbot-sdk/geojson | GeoJSON type helpers | | @kingsimba/axbot-sdk/utils | General utilities | | @kingsimba/axbot-sdk/proto | Compiled protobuf definitions |

Usage

REST API

import { robotApi } from '@kingsimba/axbot-sdk/robotApi';

// Initialize once with a config
robotApi.init({
  getApiBase: () => '/robot_api/v1/MY_ROBOT_SN',
});

// Call typed REST methods
const maps = await robotApi.getMaps();
await robotApi.wakeDevice();
await robotApi.setControlMode('remote');
await robotApi.setEmergencyStop(false);

WebSocket

import { wsClient } from '@kingsimba/axbot-sdk/ws';
import { WsEventEmitter } from '@kingsimba/axbot-sdk/ws';

// Connect
wsClient.connect('ws://192.168.x.x:8090/ws/v2/topics');

// Subscribe to a topic (event-based, no cache)
const emitter = new WsEventEmitter<MyMsgType>('/chassis/odom');
const unsubscribe = emitter.subscribe((msg) => {
  console.log(msg);
});

// Unsubscribe when done
unsubscribe();

Reactive Object Store

import { MapListStore } from '@kingsimba/axbot-sdk/objectStore';

const unsubscribe = MapListStore.subscribe((maps) => {
  console.log('maps updated', maps);
});

await MapListStore.refresh(); // fetches from robot and notifies subscribers

Building from source

pnpm install
pnpm build

To recompile protobuf definitions:

pnpm proto

Demo

An interactive browser-based demo is available in the sibling axbot-ts-sdk-demo package.

License

MIT — Copyright (c) 2026 Autoxing Technology