uc-config 0.1.0

package/examples/full-setup.ts

@@ -0,0 +1,113 @@
+import {
+  activity,
+  bind,
+  button,
+  command,
+  defineRemote,
+  delay,
+  dock,
+  driver,
+  entity,
+  integration,
+  irCode,
+  localCommand,
+  macro,
+  page,
+  pairing,
+  profile,
+  ref,
+  remote,
+  resource,
+  secret,
+  settings,
+} from "uc-config";
+
+// Template only: replace hostnames, driver IDs, entity IDs and commands from inventory.
+// Provisioning and dependent configuration are separate plan/apply phases.
+const volume = command(ref("receiver"), "REPLACE_WITH_VOLUME_COMMAND");
+
+export default defineRemote({
+  schemaVersion: 1,
+  resources: {
+    device: settings("device", { name: "Living room" }),
+    mediaDriver: driver("my-media-driver", {
+      driver_url: "ws://media-driver.local:9090",
+    }),
+    media: integration({
+      driver: ref("mediaDriver"),
+      name: "Living room devices",
+      // Inputs must match the selected driver's setup_data_schema.
+      setup: { host: "receiver.local", token: secret("env:MEDIA_TOKEN", "v1") },
+    }),
+    receiver: entity({
+      integration: ref("media"),
+      entityId: "REPLACE_WITH_AVAILABLE_ENTITY_ID",
+    }),
+    chargingDock: dock({
+      setup: {
+        manually: {
+          name: "Living room dock",
+          custom_ws_url: "dock.local",
+          token: secret("env:DOCK_TOKEN"),
+        },
+      },
+      data: { name: "Living room dock" },
+    }),
+    television: remote({
+      create: {
+        name: { en: "TV" },
+        custom_codeset: { manufacturer_id: "custom", device_name: "TV" },
+      },
+      data: { name: { en: "TV" } },
+    }),
+    // Use a learned/exported real code before applying this resource.
+    tvPower: irCode(ref("television"), "POWER", {
+      format: "PRONTO",
+      value: "REPLACE_WITH_LEARNED_CODE",
+    }),
+    streamer: remote({
+      create: { name: { en: "Streamer" }, kind: "BT", bt: {} },
+      data: { name: { en: "Streamer" } },
+    }),
+    streamerPairing: pairing(ref("streamer")),
+    streamerHome: bind(
+      ref("streamer"),
+      "HOME",
+      localCommand("HOME"),
+      "short_press",
+      "remote",
+    ),
+    watchTV: activity({
+      name: "Watch TV",
+      entities: [ref("television"), ref("receiver"), ref("streamer")],
+      on: [command(ref("television"), "POWER"), delay(1500)],
+      options: { prevent_sleep: false },
+    }),
+    volumeUp: bind(ref("watchTV"), "VOLUME_UP", volume),
+    controls: page(ref("watchTV"), {
+      name: "Controls",
+      grid: { width: 4, height: 6 },
+      items: [
+        button({
+          label: "Home",
+          at: [0, 0],
+          size: [2, 1],
+          command: command(ref("streamer"), "HOME"),
+        }),
+      ],
+    }),
+    mute: macro({
+      name: "Mute",
+      entities: [ref("receiver")],
+      steps: [command(ref("receiver"), "REPLACE_WITH_MUTE_COMMAND")],
+    }),
+    family: profile({ name: "Family", restricted: false }),
+    home: resource("profilePage", {
+      parent: ref("family"),
+      data: {
+        name: "Home",
+        items: [{ entity_id: ref("watchTV") }, { entity_id: ref("mute") }],
+      },
+    }),
+  },
+});

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "uc-config",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Configuration-as-code for the Unfolded Circle Remote 3, designed to be driven by coding agents",
+  "license": "MIT",
+  "homepage": "https://github.com/bpolly/uc-config#readme",
+  "bugs": {
+    "url": "https://github.com/bpolly/uc-config/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bpolly/uc-config.git"
+  },
+  "keywords": [
+    "unfolded-circle",
+    "remote-3",
+    "home-theater",
+    "configuration-as-code",
+    "infrastructure-as-code",
+    "ai-agents"
+  ],
+  "bin": {
+    "uc-config": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "vendor",
+    "docs",
+    "examples",
+    "remote.config.example.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "build": "tsc && node scripts/copy-types.mjs",
+    "check": "tsc --noEmit",
+    "test": "npm run build --silent && tsx --test test/*.test.ts",
+    "uc": "tsx src/cli.ts",
+    "generate": "openapi-typescript vendor/core-api.json -o src/wire.d.ts",
+    "format": "prettier --write src/*.ts test/*.ts examples/*.ts remote.config.example.ts README.md docs/*.md",
+    "format:check": "prettier --check src/*.ts test/*.ts examples/*.ts remote.config.example.ts README.md docs/*.md",
+    "check:examples": "tsc -p tsconfig.examples.json",
+    "prepublishOnly": "npm run check && npm test && npm run check:examples"
+  },
+  "dependencies": {
+    "ajv": "^8.20.0",
+    "ajv-formats": "^3.0.1",
+    "commander": "^15.0.0",
+    "tsx": "^4.23.13"
+  },
+  "devDependencies": {
+    "@types/node": "^26.6.2",
+    "openapi-typescript": "^7.13.0",
+    "prettier": "^3.9.8",
+    "typescript": "^5.9.3"
+  }
+}

package/remote.config.example.ts

@@ -0,0 +1,65 @@
+// Starter configuration. For an existing remote, prefer generating
+// remote.config.ts with `npm run uc -- import` instead of copying this file.
+//
+// Every entity ID and command below is a placeholder. Replace them with exact
+// values from generated/devices.ts (written by `inventory --bindings`).
+import {
+  activity,
+  bind,
+  button,
+  command,
+  defineRemote,
+  delay,
+  page,
+  ref,
+} from "uc-config";
+
+const tv = "REPLACE.main.media_player.TV_ID";
+const receiver = "REPLACE.main.media_player.RECEIVER_ID";
+const streamer = "REPLACE.main.media_player.STREAMER_ID";
+
+export default defineRemote({
+  schemaVersion: 1,
+  resources: {
+    "activity.watch_tv": activity({
+      name: "Watch TV",
+      entities: [tv, receiver, streamer],
+      on: [
+        command(tv, "media_player.on"),
+        delay(1500),
+        command(receiver, "media_player.on"),
+      ],
+      off: [
+        command(receiver, "media_player.off"),
+        command(tv, "media_player.off"),
+      ],
+    }),
+    "activity.watch_tv.button.volume_up": bind(
+      ref("activity.watch_tv"),
+      "VOLUME_UP",
+      command(receiver, "media_player.volume_up"),
+    ),
+    "activity.watch_tv.button.volume_down": bind(
+      ref("activity.watch_tv"),
+      "VOLUME_DOWN",
+      command(receiver, "media_player.volume_down"),
+    ),
+    "activity.watch_tv.button.home": bind(
+      ref("activity.watch_tv"),
+      "HOME",
+      command(streamer, "media_player.home"),
+    ),
+    "activity.watch_tv.page.main": page(ref("activity.watch_tv"), {
+      name: "Main",
+      grid: { width: 4, height: 6 },
+      items: [
+        button({
+          label: "Play / Pause",
+          at: [0, 0],
+          size: [2, 1],
+          command: command(streamer, "media_player.play_pause"),
+        }),
+      ],
+    }),
+  },
+});

package/vendor/README.md

@@ -0,0 +1,9 @@
+# Upstream specification
+
+`core-api.json` is a YAML-to-JSON conversion (no semantic changes) of
+https://github.com/unfoldedcircle/core-api/blob/04b0d08ccc59f3f146aa9ad031d0c87a0502fce7/core-api/rest/UCR-core-openapi.yaml
+
+Copyright Unfolded Circle and contributors. Specification licensed CC-BY-SA-4.0:
+https://creativecommons.org/licenses/by-sa/4.0/
+
+Specification version: 0.46.0. This is not the same version identifier as the device's public `api` field. Generated wire types are derived from this specification. Hardware compatibility must be checked separately.