Please add documentation

[Arnau478]

I would like to use this awesome library, but I'm unable to figure out how to use it. Could you please add some sort of documentation, examples or something like that? It would be very helpful, and more people could use Agnoc

[adrigzr]

Hi @Arnau478, glad to ear. I have it pending due to some changes in the API I want to do.

I know it isn't doc, but an example usage can be seen in the Congatudo implementation.

[Arnau478]

@adrigzr Thanks! I'll later try it out!

[adrigzr]

To add more info about how to use, let me give you a little snippet of code that will be useful IMO:

const { CloudServer } = require("@agnoc/core");

const server = new CloudServer();

server.on("error", (e) => {
  console.error(e);
});

server.on("addRobot", async(robot) => {
  console.log(`Robot ${robot.device.id} added`);

  // robot.on("updateDevice", () => {});
  // robot.on("updateMap", () => {});
  // robot.on("updateRobotPosition", () => {});
  // robot.on("updateChargerPosition", () => {});

  await robot.locate();
});

server.listen("0.0.0.0");

Remember to use next version of the lib:

npm install @agnoc/core@next

[Arnau478]

Thanks! I will definetly try it!

And also, in the official conga app there is an option to remote control the robot, kind of like a joystick... Is there any way to implement that?

[adrigzr]

Sure:

await robot.enterManualMode();

// Modes values:
//   "forward" = 1,
//   "left" = 2,
//   "right" = 3,
//   "backward" = 4,
//   "stop" = 5,
//   "init" = 10,
await robot.setManualMode(1); // go forward
await robot.setManualMode(2); // go left
await robot.setManualMode(3); // go right

await robot.leaveManualMode();