Skip to main content
The Alpha Camera SDK family is a set of official REST clients for the Alpha Camera REST API. Each is published independently and tracks the same versioned API surface.
LanguagePackageRegistryReference
TypeScript / JavaScript@alpha-sdk/clientnpmTypeScript SDK
Pythonalpha-sdk-clientPyPIPython SDK
SwiftAlphaSDKSwiftPMSwift SDK

Example apps

Reference apps that use the published SDKs and server package:
Every client targets the same REST server. To run that server locally, install @alpha-sdk/api — it ships the native binary, the camera-server CLI, and (for Node.js applications) a ServerManager class for embedding the server lifecycle. Browser-only or mobile applications connect to a server running elsewhere on the network.

Quick orientation

Every language client follows the same shape:
client
  ├── server          health, status, logs
  ├── cameras         list, connect, disconnect, getConnectionStatus
  ├── properties      get, set, getAll, getPriorityKey, setPriorityKey
  ├── actions         shutter, halfPress, afShutter, zoom, focusNearFar, movieRec
  ├── liveView        enable, disable, getStatus, start, stop, getFrame
  ├── sdCard          list, download, downloadThumbnail, downloadScreennail
  └── settings        download, upload, list, importLut
The following are intentionally outside the generated client surface — see recipes for the recommended patterns:
  • Server-Sent Events — consume with native EventSource (browser), URLSession.bytes(for:) (Swift), or httpx.stream (Python).
  • Discovery, reconnect, and lifecycle helpers — copy the recipe that fits your application.

Pick your path

TypeScript

npm install @alpha-sdk/client — Node, Electron, Tauri, browsers.

Python

pip install alpha-sdk-client — sync + async clients, Pydantic models.

Swift

SwiftPM — iOS 15+, macOS 12+, native async/await.

Need to run the server?

@alpha-sdk/api — installs the REST API server, the camera-server CLI, and a Node.js ServerManager class.

Recipes

Patterns that live outside the generated SDK surface. Copy and adapt — every recipe shows TypeScript, Python, and Swift side-by-side.

SSE event consumer

React in real time to propertyChanged, downloadComplete, transferProgress, etc.

Live-view JPEG polling

Pull a frame every ~66ms and render it.

Server subprocess

Spawn the native server from Python or any non-Node runtime.

Discovery + reconnect

Poll /api/cameras, track which is connected, hot-plug handling.

Retry + backoff

Hand-roll exponential backoff for flaky connect / SD card calls.

React hook

useCamera() — bind one camera’s connection + property state.