User Manual

awaBerry Python API Client

awaBerry Agentic API Python client — library documentation, pip install instructions, and examples for integrating device automation into Python scripts and applications.

awaBerry Python API Client

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

Prerequisites

Python 3.x installed
Requests library (install via pip install requests)

Examples

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

Additional Endpoints

/startDeviceConnectionWebsocket: Not yet implemented in Python client. To use, add a method:
def start_device_connection_websocket(session_token, deviceuuid): ...
Example usage:
result = start_device_connection_websocket(session_token, deviceuuid) print(result)
/getWebSocket: Not yet implemented in Python client. To use, add a method:
def get_websocket(session_token, deviceuuid): ...
Example usage:
ws = get_websocket(session_token, 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