@trillboards/edge-sdk 0.1.0 → 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Trillboards, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,113 @@
+# @trillboards/edge-sdk
+
+> **Turn any screen into an AI-powered DOOH advertising endpoint.** Edge AI audience sensing, ad delivery, federated learning, and cloud inference in one package. Linux and Windows.
+
+## Quick Start
+
+```bash
+npm install @trillboards/edge-sdk
+npx trillboards-edge download-models
+npx trillboards-edge start --config trillboards.config.json
+```
+
+## What This Does
+
+The Edge SDK runs on digital signage hardware (kiosks, vending machines, billboards, CTV devices) and provides:
+
+- **Audience sensing** — on-device face detection, gaze tracking, emotion analysis, foot traffic estimation via ONNX models (no cloud dependency)
+- **Ad delivery** — Chromium browser lifecycle, display management, VAST/VPAID ad rendering
+- **Federated learning** — privacy-preserving on-device model training with sparse gradient uploads
+- **Cloud inference** — Gemini Vision scene analysis, content moderation, contextual targeting
+- **Device management** — heartbeat, health monitoring, auto-recovery, signal buffering for offline resilience
+
+All audience data stays on-device. Only aggregated, anonymized metrics are transmitted.
+
+## Configuration
+
+Create `trillboards.config.json`:
+
+```json
+{
+  "apiBaseUrl": "https://api.trillboards.com",
+  "deviceToken": "your-device-token",
+  "camera": { "enabled": true, "width": 640, "height": 480, "fps": 10 },
+  "audio": { "enabled": true },
+  "models": { "dir": "./models", "executionProvider": "cpu" },
+  "kiosk": { "enabled": true, "url": "https://screen.trillboards.com" },
+  "cloud": { "enabled": false },
+  "federated": { "enabled": true },
+  "logLevel": "info"
+}
+```
+
+## Programmatic Usage
+
+```typescript
+import { EdgeAgent, loadConfig } from '@trillboards/edge-sdk';
+
+const config = loadConfig('trillboards.config.json');
+const agent = new EdgeAgent(config);
+
+agent.on('started', ({ fingerprint, tier }) => {
+  console.log(`Device ${fingerprint} running at TIER_${tier}`);
+});
+
+await agent.start();
+```
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `trillboards-edge start [--config path]` | Start the edge agent |
+| `trillboards-edge download-models [--dir path]` | Download ONNX models (BlazeFace, YAMNet) |
+| `trillboards-edge version` | Print SDK version |
+
+## Capability Tiers
+
+The SDK auto-detects device capabilities and adjusts inference accordingly:
+
+| Tier | RAM | NPU | Models | FPS |
+|------|-----|-----|--------|-----|
+| TIER_1 | < 2 GB | No | Face only | 2 |
+| TIER_2 | 2-4 GB | No | Face + Audio | 5 |
+| TIER_3 | 4-8 GB | Optional | All models | 10 |
+| TIER_4 | 8+ GB | Yes | All + high-res | 15+ |
+
+## Execution Providers
+
+- `cpu` — works everywhere (default)
+- `openvino` — Intel integrated GPU (2-3x faster)
+- `directml` — Windows GPU acceleration
+- `cuda` — NVIDIA GPU
+
+## Sub-Packages
+
+This is the umbrella package. For fine-grained control, install sub-packages individually:
+
+| Package | Purpose |
+|---------|---------|
+| [@trillboards/edge-core](https://www.npmjs.com/package/@trillboards/edge-core) | Device identity, Socket.io, config, signal buffer, health monitoring |
+| [@trillboards/edge-sensing](https://www.npmjs.com/package/@trillboards/edge-sensing) | ONNX face detection, audio classification, audience metrics |
+| [@trillboards/edge-ads](https://www.npmjs.com/package/@trillboards/edge-ads) | Chromium browser lifecycle, display management, ad delivery |
+| [@trillboards/edge-federated](https://www.npmjs.com/package/@trillboards/edge-federated) | On-device federated learning, sparse gradient upload |
+| [@trillboards/edge-cloud](https://www.npmjs.com/package/@trillboards/edge-cloud) | Gemini Vision scene analysis, contextual targeting |
+| [@trillboards/edge-platform-linux](https://www.npmjs.com/package/@trillboards/edge-platform-linux) | V4L2 camera, PulseAudio, systemd, kiosk mode |
+| [@trillboards/edge-platform-windows](https://www.npmjs.com/package/@trillboards/edge-platform-windows) | DirectShow, RTSP IP cameras, WASAPI audio |
+
+## Platform Support
+
+- **Linux** — Ubuntu 20.04+, Debian 11+, Raspberry Pi OS (ARM64)
+- **Windows** — Windows 10/11 (x64)
+
+## Get a Device Token
+
+```bash
+npx @trillboards/ads-sdk init
+```
+
+Or register via the [Trillboards API](https://api.trillboards.com/developer).
+
+## License
+
+MIT

package/deploy/docker/package.json

@@ -1,9 +1,9 @@
 {
   "name": "trillboards-edge-docker",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "private": true,
   "dependencies": {
-    "@trillboards/edge-sdk": "0.1.0",
-    "@trillboards/edge-platform-linux": "0.1.0"
+    "@trillboards/edge-sdk": "^0.2.0",
+    "@trillboards/edge-platform-linux": "^0.2.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trillboards/edge-sdk",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Composable cross-platform Edge AI SDK for audience sensing on DOOH/CTV devices",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,21 +15,22 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@trillboards/edge-core": "0.1.0",
-    "@trillboards/edge-sensing": "0.1.0",
-    "@trillboards/edge-federated": "0.1.0",
-    "@trillboards/edge-ads": "0.1.0",
-    "@trillboards/edge-cloud": "0.1.0"
+    "@trillboards/edge-core": "^0.2.0",
+    "@trillboards/edge-sensing": "^0.2.0",
+    "@trillboards/edge-federated": "^0.2.0",
+    "@trillboards/edge-ads": "^0.2.0",
+    "@trillboards/edge-cloud": "^0.2.0"
   },
   "optionalDependencies": {
-    "@trillboards/edge-platform-linux": "0.1.0",
-    "@trillboards/edge-platform-windows": "0.1.0"
+    "@trillboards/edge-platform-linux": "^0.2.0",
+    "@trillboards/edge-platform-windows": "^0.2.0"
   },
-  "files": ["dist", "configs", "deploy"],
+  "files": ["dist", "configs", "deploy", "LICENSE", "README.md"],
   "engines": {
     "node": ">=18.0.0"
   },
-  "license": "UNLICENSED",
+  "author": "Trillboards <engineering@trillboards.com>",
+  "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
@@ -38,7 +39,21 @@
     "url": "https://github.com/trillboards/packages.git",
     "directory": "trillboards-edge-sdk/packages/edge-sdk"
   },
-  "keywords": ["edge-ai", "dooh", "audience-sensing", "onnx", "ctv"],
+  "keywords": [
+    "edge-ai",
+    "dooh",
+    "audience-sensing",
+    "onnx",
+    "ctv",
+    "digital-signage",
+    "computer-vision",
+    "face-detection",
+    "federated-learning",
+    "mcp",
+    "model-context-protocol",
+    "smart-display",
+    "attention-measurement"
+  ],
   "devDependencies": {
     "@types/jest": "^29.5.0",
     "@types/node": "^20.0.0",