mirror of https://github.com/UNITRONIX/BetterDesk.git synced 2026-09-10 09:35:39 +00:00

Files

T

History

UNITRONIX abe0d52fe4 chore: refresh EOL runtimes and patch non-agent dependencies

Move Docker/CI/installers to Node 24 and Go 1.26 images, bump Alpine server runtime, apply safe npm/Go patch updates, migrate SNMP to pysnmp, and document deferred majors.

2026-08-01 09:19:42 +02:00

nodejs

chore: refresh EOL runtimes and patch non-agent dependencies

2026-08-01 09:19:42 +02:00

python

Anonymize operator infrastructure fingerprints from public repo.

2026-06-28 19:07:42 +02:00

README.md

chore: transition project license to AGPL-3.0

2026-06-13 12:41:33 +02:00

README.md

BetterDesk CDAP — SDKs & Bridges

Software Development Kits and reference bridge implementations for the Connected Device Automation Protocol (CDAP) used by BetterDesk server.

SDKs

SDK	Directory	Language	Status
Python	`sdks/python/`	Python 3.9+	✅ Stable
Node.js	`sdks/nodejs/`	Node.js 18+	✅ Stable

Reference Bridges

Bridge	Directory	Protocol	Use Case
Modbus	`bridges/modbus/`	Modbus TCP/RTU	PLCs, VFDs, power meters
SNMP	`bridges/snmp/`	SNMP v2c/v3	Switches, routers, UPS
REST/Webhook	`bridges/rest-webhook/`	HTTP	Home Assistant, cloud APIs

Native Agent

The BetterDesk Agent is a standalone Go binary that runs on target devices, providing system monitoring, terminal access, file browsing, screenshots, and clipboard sync through CDAP.

Component	Directory	Language
Agent	`betterdesk-agent/`	Go 1.25+

Quick Start

Python Bridge

pip install ./sdks/python
pip install pymodbus  # for Modbus bridge
cd bridges/modbus
cp config.example.json config.json
python bridge_modbus.py -c config.json

Node.js Bridge

const { CDAPBridge, gauge, toggle } = require('./sdks/nodejs');

const bridge = new CDAPBridge({
  server: 'ws://your-server:21122/cdap',
  apiKey: 'KEY',
  deviceName: 'My Bridge',
});
bridge.addWidget(gauge('temp', 'Temperature'));
bridge.run();

Go Agent

cd betterdesk-agent
go build -o betterdesk-agent .
./betterdesk-agent -server ws://your-server:21122/cdap -auth api_key -key YOUR_KEY

CDAP Protocol Overview

CDAP uses WebSocket (port 21122) with JSON messages:

Device/Bridge → Server:
  auth → auth_result
  register → registered
  heartbeat → heartbeat_ack
  state_update (widget values)
  alert / alert_resolve
  log

Server → Device/Bridge:
  command (widget_id, action, value, params)
  terminal_start / terminal_data / terminal_resize
  file_list / file_read / file_write / file_delete
  clipboard_set
  desktop_start / desktop_input

Authentication methods: api_key, device_token, user_password.

License

AGPL-3.0