Arkeo All-in-One API Documentation¶
The Arkeo All-in-One API allows external applications to control and query the Arkeo measurement software. Communication happens using the TCP protocol on port 6360, enabling users to perform a variety of commands manage measurements. Each connected client can send JSON-encoded requests and receive JSON responses.
API Modules¶
The API is divided in 4 sections, each controlling a specific part of the software.
-
MAIN - System-level control
Manage application state, connections, and global operations such as routine selection and execution.
-
ROUTINE - Measurement routines
Configure and run measurement workflows such as JV scans, MPPT, impedance spectroscopy, and luminescence measurements.
-
TMPCTL - Temperature control
Monitor and control temperature controllers, setpoints, ramps, and stabilization status.
-
MUX - Multiplexer management
Configure and control hardware multiplexers for channel routing and device selection.
Getting started¶
If this is your first time using the API, start here:
- ๐ API overview & protocol
- ๐ง Request & response format
- ๐งช Examples
Connection details¶
- Protocol: TCP
- Port:
6360 - Message format: JSON (length-prefixed)
The API is designed to be language-agnostic and can be used from LabVIEW, Python, MATLAB, C/C++, or any TCP-capable environment.