crestron-setup 0.0.0__tar.gz

crestron_setup-0.0.0/.github/prompts/crestron-cli.prompt.md

@@ -0,0 +1,33 @@
+---
+description: Look up Crestron processor CLI commands, syntax, and parameters
+---
+
+# Crestron CLI Command Reference
+
+You have access to a comprehensive Crestron CP4 command reference database at [crestron_command_reference.md](../../crestron_command_reference.md).
+
+## When to Use
+
+Use this skill when the user needs to:
+
+- Look up the syntax or parameters for a Crestron CLI command
+- Find which command performs a specific function on a Crestron processor
+- Understand available commands by role (Administrator, Operator, Programmer, Connect)
+- Write or modify `expect` scripts that interact with the Crestron CLI
+- Troubleshoot command usage or errors on a Crestron processor
+
+## How to Use
+
+1. Read the command reference file to find the relevant command(s).
+2. The reference contains:
+   - **Command Index** — table of all 414 commands with role and description
+   - **Command Details** — detailed syntax, parameters, and usage for each command
+3. Commands are organized alphabetically. Use the index to find commands by description, or search the details for parameter syntax.
+
+## Key Context
+
+- The Crestron CLI uses a `MODEL>` prompt (e.g., `CP4>`, `MC4>`). It is **not** a standard Unix shell.
+- Commands are case-insensitive but conventionally shown in mixed case (e.g., `ADDPUBKEYtouser`).
+- Roles determine access level: Connect < Operator < Programmer < Administrator.
+- Some commands return `ERROR:` when prerequisites aren't met (e.g., BACnet not running, AD not configured).
+- Use `COMMAND ?` to get help for any command on a live processor.

crestron_setup-0.0.0/.github/workflows/release.yml

@@ -0,0 +1,125 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+jobs:
+  # ── Build sdist + wheel ────────────────────────────────────────────────
+  build-wheel:
+    name: Build wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # setuptools-scm needs full history
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - run: pip install build
+
+      - run: python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  # ── Publish to PyPI (Trusted Publisher OIDC) ───────────────────────────
+  publish-pypi:
+    name: Publish to PyPI
+    needs: build-wheel
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  # ── Build standalone executables ───────────────────────────────────────
+  build-executables:
+    name: Build ${{ matrix.os }} executable
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: macos-latest
+            artifact: crestron-setup-macos
+            binary: crestron-setup
+          - os: windows-latest
+            artifact: crestron-setup-windows
+            binary: crestron-setup.exe
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: pip install . pyinstaller
+
+      - name: Build executable
+        run: >
+          pyinstaller
+          --onefile
+          --name crestron-setup
+          --collect-submodules crestron_setup
+          crestron_setup/__main__.py
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.artifact }}
+          path: dist/${{ matrix.binary }}
+
+  # ── Create GitHub Release ──────────────────────────────────────────────
+  github-release:
+    name: GitHub Release
+    needs: [build-executables, publish-pypi]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: artifacts/
+
+      - name: Prepare release assets
+        run: |
+          mkdir release
+          cp artifacts/crestron-setup-macos/crestron-setup release/crestron-setup-macos
+          cp artifacts/crestron-setup-windows/crestron-setup.exe release/crestron-setup-windows.exe
+          cd release && sha256sum * > checksums.txt
+
+      - name: Create release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+          files: release/*
+
+  # ── Bump Homebrew formula ──────────────────────────────────────────────
+  bump-homebrew:
+    name: Update Homebrew tap
+    needs: github-release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: mislav/bump-homebrew-formula-action@v3
+        with:
+          formula-name: crestron-setup
+          homebrew-tap: mikejobson/homebrew-tap
+          download-url: https://github.com/mikejobson/Crestron-Processor-Setup/releases/download/${{ github.ref_name }}/crestron-setup-macos
+        env:
+          COMMITTER_TOKEN: ${{ secrets.HOMEBREW_TAP_TOKEN }}

crestron_setup-0.0.0/.gitignore

@@ -0,0 +1,7 @@
+.venv/
+__pycache__/
+*.pyc
+*.egg-info/
+dist/
+build/
+crestron_setup/_version.py

crestron_setup-0.0.0/AGENTS.md

@@ -0,0 +1,79 @@
+# Agent Instructions
+
+## Project Overview
+
+Cross-platform Python CLI application for automated Crestron processor provisioning. Discovers devices via CIP protocol, manages accounts, configures settings, and handles firmware — all through an interactive terminal console. The legacy bash script (`setup_processor.sh`) is kept for reference.
+
+The Crestron CLI is **not** a standard shell — it uses a custom `MODEL>` prompt (e.g., `CP4>`, `MC4>`). SSH automation uses paramiko's `invoke_shell()` with channel read/write, NOT `exec_command()`.
+
+## Key Files
+
+- `crestron_setup/` — Python package (the main application)
+  - `cli.py` — Interactive menu loop (main entry point)
+  - `discovery.py` — CIP device discovery (UDP broadcast on port 41794)
+  - `ssh.py` — SSH/SFTP via paramiko (`invoke_shell()` + prompt detection)
+  - `provisioning.py` — 5-phase setup logic (port of `setup_processor.sh`)
+  - `firmware.py` — Firmware download, version comparison, local file discovery
+  - `config.py` — YAML config loading/saving with platform-aware paths
+  - `models.py` — Data classes (`Device`, `Config`, `FirmwareSource`)
+  - `__main__.py` — Entry point for `python -m crestron_setup`
+- `config.example.yaml` — Template configuration file
+- `setup_processor.sh` — Legacy bash/expect script (macOS only)
+- `crestron_command_reference.md` — 414-command CLI reference from a live CP4
+- `example commands.txt` — Reference log of a manual setup session
+
+## Architecture
+
+### Python Application (`crestron_setup/`)
+
+**Discovery**: `discovery.py` broadcasts a 266-byte CIP packet on UDP 41794, parses `0x15` responses to extract hostname, model, firmware version, and MAC address. Requires root/admin privileges.
+
+**SSH**: `ssh.py` uses paramiko `invoke_shell()` with prompt detection via regex `[A-Za-z0-9-]+>`. The `CrestronSSH` class wraps connect/send_command/disconnect. `CrestronFirstBoot` handles the first-boot account creation flow (crestron/empty password → Username:/Password:/Verify prompts).
+
+**Provisioning**: `provisioning.py` runs 5 sequential phases (same as the legacy bash script):
+
+1. **Account Creation** — Detect first-boot, create admin account or verify existing
+2. **Public Key Upload** — SFTP `.pub` to `/user/`
+3. **Configuration** — 12 CLI commands (ADDPUBKEYTOUSER, TIMEZONE, TIMEDATE, SNTP, ports, lockout, FIPS, VER -V)
+4. **Reboot** — Send REBOOT, poll ping + SSH (300s timeout)
+5. **Firmware Upload** — Version comparison + SFTP `.puf` to `/firmware/`
+
+**Firmware**: `firmware.py` downloads from per-model URLs configured in YAML, caches in `~/.cache/crestron-setup/firmware/`, falls back to a local firmware directory.
+
+**Config**: `config.py` loads from `~/.config/crestron-setup/config.yaml` (macOS/Linux) or `%APPDATA%\crestron-setup\config.yaml` (Windows). A local `config.yaml` takes priority.
+
+**CLI**: `cli.py` uses `rich` (tables, progress bars) and `questionary` (arrow-key menus, checkboxes, password prompts) for the interactive console.
+
+## Conventions
+
+- Status output uses rich markup: `[green][OK][/green]`, `[red][FAIL][/red]`, `[cyan][INFO][/cyan]`, `[yellow][WARN][/yellow]`
+- Firmware filenames follow `{model_lower}_{version}.puf` (e.g., `mc4_2.8006.00284.01.puf`)
+- PUF version from `VER -V` is used for firmware version comparison
+- SSH connections use `look_for_keys=False, allow_agent=False` to force password auth
+
+## Common Pitfalls
+
+- Crestron SSH is NOT a standard shell — `exec_command()` will not work. Must use `invoke_shell()` with channel read/write and prompt regex matching.
+- `VER -V` output has **leading whitespace** — don't anchor with `^` when parsing.
+- The processor needs time after reboot before SFTP is ready (SSH may respond first). Firmware uploads happen **before** the reboot phase.
+- Discovery requires root/admin for UDP broadcast on port 41794.
+- First-boot detection: HTTPS check for `/createUser.html` redirect (fast) → SSH as `crestron` with empty password (fallback). If `Username:` prompt appears over SSH, it's first boot; if `MODEL>` prompt appears, it's already configured.
+
+## Testing
+
+```bash
+# Create venv and install
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e .
+
+# Run the console
+python -m crestron_setup
+
+# Discovery requires sudo
+sudo .venv/bin/python -m crestron_setup
+
+# Legacy bash script (macOS only)
+bash -n setup_processor.sh
+./setup_processor.sh <hostname-or-ip>
+```

crestron_setup-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mike Jobson
+
+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.

crestron_setup-0.0.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: crestron-setup
+Version: 0.0.0
+Summary: Cross-platform Crestron processor provisioning console
+Author-email: Mike Jobson <mike@mikejobson.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/mikejobson/Crestron-Processor-Setup
+Project-URL: Repository, https://github.com/mikejobson/Crestron-Processor-Setup
+Project-URL: Issues, https://github.com/mikejobson/Crestron-Processor-Setup/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: paramiko>=3.0
+Requires-Dist: rich>=13.0
+Requires-Dist: questionary>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: httpx>=0.27
+Dynamic: license-file
+
+# Crestron Processor Setup
+
+Cross-platform interactive console for Crestron processor provisioning. Discovers devices on the LAN, creates accounts, configures settings, and manages firmware — all from a terminal menu.
+
+## Features
+
+- **Device Discovery** — CIP protocol broadcast (UDP 41794) finds Crestron processors on the local network, with first-boot detection
+- **Interactive Console** — Arrow-key menus, checkbox device selection, progress bars
+- **Cross-Platform** — Python + paramiko (works on macOS, Linux, and Windows — no `expect` dependency)
+- **Firmware Management** — Download firmware from configurable URLs and upload to processors
+- **5-Phase Provisioning**:
+  1. **Account Creation** — Detects first-boot state; creates admin account or verifies existing credentials
+  2. **Public Key Upload** — SFTP `.pub` key to `/user/`
+  3. **Configuration** — Timezone, NTP, web ports, login lockout policy, FIPS mode
+  4. **Firmware Upload** — Version comparison; uploads `.puf` to `/firmware/` only if newer
+  5. **Reboot** — Sends `REBOOT` and polls until back online
+
+## Requirements
+
+- Python 3.10+
+- Root/admin privileges for device discovery (UDP broadcast)
+
+## Installation
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate    # Windows: .venv\Scripts\activate
+pip install -e .
+```
+
+## Usage
+
+```bash
+# Launch the interactive console
+python -m crestron_setup
+
+# Discovery requires elevated privileges
+sudo .venv/bin/python -m crestron_setup
+```
+
+The console presents a main menu with options to discover devices, set up a device by IP, download firmware, or edit settings.
+
+## Configuration
+
+Settings are stored in `~/.config/crestron-setup/config.yaml` (macOS/Linux) or `%APPDATA%\crestron-setup\config.yaml` (Windows). A local `config.yaml` in the working directory takes priority.
+
+Copy `config.example.yaml` to get started. Key settings:
+
+| Setting           | Default                    | Description                         |
+| ----------------- | -------------------------- | ----------------------------------- |
+| `timezone`        | `33` (GMT Standard Time)   | Crestron timezone ID                |
+| `ntp_server`      | `pool.ntp.org`             | NTP server address                  |
+| `pubkey_file`     | `~/.ssh/id_rsa.pub`        | SSH public key to upload            |
+| `firmware_dir`    | `~/Sync/Crestron Firmware` | Local firmware directory (fallback) |
+| `web_port`        | `8080`                     | Web server port                     |
+| `secure_web_port` | `8443`                     | Secure web server port              |
+| `firmware_urls`   | _(empty)_                  | Per-model firmware download URLs    |
+
+## Files
+
+| Path                            | Purpose                                                      |
+| ------------------------------- | ------------------------------------------------------------ |
+| `crestron_setup/`               | Python package — CLI, discovery, SSH, provisioning, firmware |
+| `config.example.yaml`           | Template configuration file                                  |
+| `setup_processor.sh`            | Legacy bash script (macOS only, requires `expect`)           |
+| `crestron_command_reference.md` | CLI command reference (414 commands) from a live CP4         |
+| `example commands.txt`          | Reference log of a manual setup session                      |
+
+## Legacy Bash Script
+
+The original `setup_processor.sh` is still included for reference. It requires macOS with `expect` and takes a single hostname argument:
+
+```bash
+./setup_processor.sh <hostname-or-ip>
+```

crestron_setup-0.0.0/README.md

@@ -0,0 +1,75 @@
+# Crestron Processor Setup
+
+Cross-platform interactive console for Crestron processor provisioning. Discovers devices on the LAN, creates accounts, configures settings, and manages firmware — all from a terminal menu.
+
+## Features
+
+- **Device Discovery** — CIP protocol broadcast (UDP 41794) finds Crestron processors on the local network, with first-boot detection
+- **Interactive Console** — Arrow-key menus, checkbox device selection, progress bars
+- **Cross-Platform** — Python + paramiko (works on macOS, Linux, and Windows — no `expect` dependency)
+- **Firmware Management** — Download firmware from configurable URLs and upload to processors
+- **5-Phase Provisioning**:
+  1. **Account Creation** — Detects first-boot state; creates admin account or verifies existing credentials
+  2. **Public Key Upload** — SFTP `.pub` key to `/user/`
+  3. **Configuration** — Timezone, NTP, web ports, login lockout policy, FIPS mode
+  4. **Firmware Upload** — Version comparison; uploads `.puf` to `/firmware/` only if newer
+  5. **Reboot** — Sends `REBOOT` and polls until back online
+
+## Requirements
+
+- Python 3.10+
+- Root/admin privileges for device discovery (UDP broadcast)
+
+## Installation
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate    # Windows: .venv\Scripts\activate
+pip install -e .
+```
+
+## Usage
+
+```bash
+# Launch the interactive console
+python -m crestron_setup
+
+# Discovery requires elevated privileges
+sudo .venv/bin/python -m crestron_setup
+```
+
+The console presents a main menu with options to discover devices, set up a device by IP, download firmware, or edit settings.
+
+## Configuration
+
+Settings are stored in `~/.config/crestron-setup/config.yaml` (macOS/Linux) or `%APPDATA%\crestron-setup\config.yaml` (Windows). A local `config.yaml` in the working directory takes priority.
+
+Copy `config.example.yaml` to get started. Key settings:
+
+| Setting           | Default                    | Description                         |
+| ----------------- | -------------------------- | ----------------------------------- |
+| `timezone`        | `33` (GMT Standard Time)   | Crestron timezone ID                |
+| `ntp_server`      | `pool.ntp.org`             | NTP server address                  |
+| `pubkey_file`     | `~/.ssh/id_rsa.pub`        | SSH public key to upload            |
+| `firmware_dir`    | `~/Sync/Crestron Firmware` | Local firmware directory (fallback) |
+| `web_port`        | `8080`                     | Web server port                     |
+| `secure_web_port` | `8443`                     | Secure web server port              |
+| `firmware_urls`   | _(empty)_                  | Per-model firmware download URLs    |
+
+## Files
+
+| Path                            | Purpose                                                      |
+| ------------------------------- | ------------------------------------------------------------ |
+| `crestron_setup/`               | Python package — CLI, discovery, SSH, provisioning, firmware |
+| `config.example.yaml`           | Template configuration file                                  |
+| `setup_processor.sh`            | Legacy bash script (macOS only, requires `expect`)           |
+| `crestron_command_reference.md` | CLI command reference (414 commands) from a live CP4         |
+| `example commands.txt`          | Reference log of a manual setup session                      |
+
+## Legacy Bash Script
+
+The original `setup_processor.sh` is still included for reference. It requires macOS with `expect` and takes a single hostname argument:
+
+```bash
+./setup_processor.sh <hostname-or-ip>
+```

crestron_setup-0.0.0/config.example.yaml

@@ -0,0 +1,49 @@
+# Default configuration for Crestron processor setup.
+# Copy to ~/.config/crestron-setup/config.yaml (macOS/Linux)
+#       or %APPDATA%\crestron-setup\config.yaml (Windows)
+
+# Timezone ID to set on processors (use TIMEZONE LIST on a processor to see options)
+timezone: "33" # 33 = GMT Standard Time
+
+# NTP server for time synchronisation
+ntp_server: "pool.ntp.org"
+
+# SSH public key file to upload to processors
+pubkey_file: "~/.ssh/id_rsa.pub"
+
+# Local directory to search for .puf firmware files (fallback if no download URL)
+firmware_dir: "~/Sync/Crestron Firmware"
+
+# Web server ports
+web_port: 8080
+secure_web_port: 8443
+
+# Login lockout policy
+user_login_attempts: 5
+user_lockout_time: "1m"
+login_attempts: 20
+lockout_time: "5m"
+
+# FIPS mode (ON or OFF)
+fips_mode: "OFF"
+
+# Firmware download URLs per model.
+# These are checked when running firmware updates. Leave empty or remove
+# entries for models where you provide firmware files locally.
+# Supports optional auth headers — see examples below.
+firmware_urls:
+  # CP4:
+  #   url: "https://example.com/firmware/cp4_latest.puf"
+  #   headers:
+  #     Authorization: "Bearer YOUR_TOKEN_HERE"
+  # MC4:
+  #   url: "https://example.com/firmware/mc4_latest.puf"
+  # CP4N:
+  #   url: "https://example.com/firmware/cp4n_latest.puf"
+  # RMC4:
+  #   url: "https://example.com/firmware/rmc4_latest.puf"
+
+# Discovery settings
+discovery:
+  timeout: 5 # Seconds to listen for responses
+  broadcast_count: 3 # Number of broadcast packets to send