Socket Server (Remote API)

Warning

This is an experimental feature.

The Socket Server allows other programming languages (or remote machines) to use AutoControl by sending JSON commands over TCP.

Starting the Server

import sys
from je_auto_control import start_autocontrol_socket_server

try:
    server = start_autocontrol_socket_server(host="localhost", port=9938)
    while not server.close_flag:
        pass
    sys.exit(0)
except Exception as error:
    print(repr(error))

The server runs in a background thread and listens for JSON action commands.

Sending Commands (Client)

import socket
import json

sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.connect(("localhost", 9938))

command = json.dumps([
    ["AC_set_mouse_position", {"x": 500, "y": 300}],
    ["AC_click_mouse", {"mouse_keycode": "mouse_left"}]
])
sock.sendall(command.encode("utf-8"))

response = sock.recv(8192).decode("utf-8")
print(response)
sock.close()

Protocol Details

Property	Value
Encoding	UTF-8
End-of-response marker	Return_Data_Over_JE
Shutdown command	Send "quit_server" to stop the server
Default port	9938