NoemeApi documentation

NoemeApi Typescript SDK

This SDK provides typed class and methods to communicate with Robocc products

Installation

The sources are provided in this repo, along with distributed library that you can use via

npm install https://github.com/robocc/noeme-api-ts-sdk

Usage

Once installed via npm, you can instantiate NoemeApi class via import

import { NoemeApi } from "@robocc/noeme-api";
import { TopicEventCode } from "@robocc/noeme-api/events";

const api = new NoemeApi({ host: "localhost:7523", api_key: "...", use_ssl: false });
api.on(TopicEventCode.Ready, () => console.log("Ready !"))
api.on(TopicEventCode.VehiclePose, (pose) =>
console.log(`New vehicle pose ${pose.x} ${pose.y}`)
);
api.start()

Replace host option to connect to remote API via device IP (usually on port 7523) and set api_key.

Documentation

You can find documenation at https://docs.robocc.com/noeme-api-ts/8.10.8-jujols-8/

Generated using TypeDoc