User Manual

awaBerry Node.js API Client

awaBerry Agentic API Node.js client — library documentation, npm install instructions, and examples for integrating device automation into Node.js applications.

awaBerry Node.js API Client

This client allows you to interact with the awaBerry Agentic API from Node.js. See below for prerequisites, setup instructions, and usage examples.

Prerequisites

Node.js installed
Axios library (npm install axios)

Examples

usageFullScenario.js - Full scenario implementation to enter commands and get results from a device.
usageWriteAFileToFolderAndReadBack.js - Example for file read/write permissions.

Additional Endpoints

/startDeviceConnectionWebsocket: Not yet implemented in Node.js client. To use, add a method:
async function startDeviceConnectionWebsocket(sessionToken, deviceuuid) { ... }
Example usage:
const result = await startDeviceConnectionWebsocket(sessionToken, deviceuuid); console.log(result);
/getWebSocket: Not yet implemented in Node.js client. To use, add a method:
async function getWebSocket(sessionToken, deviceuuid) { ... }
Example usage:
const ws = await getWebSocket(sessionToken, deviceuuid); ws.send("your message"); ws.close();

Tests

Download Client Code from GitHub

To get the latest awaBerry API client implementations, follow these steps:

Open a terminal in a folder of your choice.
Run the following command to clone the repository:
git clone https://github.com/awaberry/mcp_server_awaberry.git
Change to the apiclients folder:
cd mcp_server_awaberry/apiclients

This will give you access to all client implementations and tests for Java, Python, TypeScript, and Node.js.

Back to API Clients Overview

Navigate ← awaBerry API Clients Overview ← awaBerry API Documentation ← awaBerry For Developers Main Page