tciv-client 0.0.1 → 0.0.3

package/README.md

@@ -9,6 +9,10 @@ Zero runtime dependencies · Native `fetch` (Node 18+) · Tested on **TCIV-2+**
 
 > **Trademark Notice:** This project is **not affiliated with, endorsed by, or sponsored by Zenitel AS.** "Zenitel" and "TCIV" are trademarks of their respective owners. This library is an independent tool for authorized administrators to manage their own intercom systems.
 
+## Intended Use
+
+This library is intended for **system integrators and IT administrators** managing TCIV-series intercoms they own or are authorized to administer. All operations require valid device credentials.
+
 ## Table of Contents
 
 - [Install](#install)
@@ -38,9 +42,9 @@ Zero runtime dependencies · Native `fetch` (Node 18+) · Tested on **TCIV-2+**
   - [Provisioning](#full-device-provisioning-1)
   - [Audio Settings](#audio-settings)
   - [Reboot](#reboot)
-- [Network Scanner](#scannetwork)
+- [Device Discovery](#scannetwork)
 - [Supported Hardware](#supported-hardware)
-- [Goform Endpoint Map](#goform-endpoint-map)
+- [HTTP API Reference](#http-api-reference)
 
 ---
 
@@ -53,9 +57,9 @@ npm install tciv-client
 ## Quick Start
 
 ```typescript
-import { ZenitelClient } from 'tciv-client';
+import { TcivClient } from 'tciv-client';
 
-const z = new ZenitelClient({ host: '192.168.1.143' });
+const z = new TcivClient({ host: '192.168.1.143' });
 
 // Check if device is reachable
 await z.isReachable();           // true
@@ -79,7 +83,7 @@ await z.setAudioSettings({ speaker: { gain: 3 } });
 
 ## CLI
 
-The `zenitel` CLI is included for hardware testing and debugging.
+The `tciv` CLI is included for hardware testing and debugging.
 
 ```bash
 npx tciv <command> [options]
@@ -88,9 +92,9 @@ npx tciv <command> [options]
 ### Device Discovery
 
 ```bash
-zenitel scan
+tciv scan
 
-# 🔍 Scanning network for Zenitel devices...
+# 🔍 Scanning for TCIV devices...
 #
 #   🟢 192.168.1.143
 #      MAC: 00:13:cb:28:35:ca
@@ -106,7 +110,7 @@ zenitel scan
 ### Device Information
 
 ```bash
-zenitel info -h 192.168.1.143
+tciv info -h 192.168.1.143
 
 # 📋 Device info:
 #   Model:          TCIV-2+
@@ -124,19 +128,19 @@ zenitel info -h 192.168.1.143
 ### Call Status & Relays
 
 ```bash
-zenitel status -h 192.168.1.143        # Full status
-zenitel relay -h 192.168.1.143          # Open door (relay1, 3s)
-zenitel relay -h 192.168.1.143 --id gpio2 --timer 5  # GPIO output
-zenitel relay -h 192.168.1.143 --off    # Deactivate
-zenitel call 122 -h 192.168.1.143       # Place SIP call
-zenitel stop -h 192.168.1.143           # Hang up
+tciv status -h 192.168.1.143        # Full status
+tciv relay -h 192.168.1.143          # Open door (relay1, 3s)
+tciv relay -h 192.168.1.143 --id gpio2 --timer 5  # GPIO output
+tciv relay -h 192.168.1.143 --off    # Deactivate
+tciv call 122 -h 192.168.1.143       # Place SIP call
+tciv stop -h 192.168.1.143           # Hang up
 ```
 
 ### SIP Configuration
 
 ```bash
-zenitel sip get -h 192.168.1.143        # Read SIP config
-zenitel sip set -h 192.168.1.143 \
+tciv sip get -h 192.168.1.143        # Read SIP config
+tciv sip set -h 192.168.1.143 \
   --domain my-trunk.sip.twilio.com \
   --number station01
 ```
@@ -144,16 +148,16 @@ zenitel sip set -h 192.168.1.143 \
 ### Webcall API Management
 
 ```bash
-zenitel webcall -h 192.168.1.143           # Check status
-zenitel webcall enable -h 192.168.1.143    # Enable HTTP API
-zenitel webcall disable -h 192.168.1.143   # Disable
+tciv webcall -h 192.168.1.143           # Check status
+tciv webcall enable -h 192.168.1.143    # Enable HTTP API
+tciv webcall disable -h 192.168.1.143   # Disable
 ```
 
 ### Audio Settings
 
 ```bash
 # Read current audio config
-zenitel audio -h 192.168.1.143
+tciv audio -h 192.168.1.143
 
 # 🎵 Audio settings for 192.168.1.143:
 #
@@ -167,26 +171,26 @@ zenitel audio -h 192.168.1.143
 #   Mode:        Voice
 
 # Adjust speaker and mic
-zenitel audio set -h 192.168.1.143 --speaker 3 --mic 3
+tciv audio set -h 192.168.1.143 --speaker 3 --mic 3
 
 # Toggle DSP features
-zenitel audio set -h 192.168.1.143 --aec-on --drc-on --anc-off
+tciv audio set -h 192.168.1.143 --aec-on --drc-on --anc-off
 
 # Backup raw audio config as JSON
-zenitel audio backup -h 192.168.1.143 -o audio-backup.json
+tciv audio backup -h 192.168.1.143 -o audio-backup.json
 ```
 
 ### Config Backup & Restore
 
 ```bash
-zenitel backup -h 192.168.1.143 -o backup.tar.gz
-zenitel restore backup.tar.gz -h 192.168.1.143
+tciv backup -h 192.168.1.143 -o backup.tar.gz
+tciv restore backup.tar.gz -h 192.168.1.143
 ```
 
 ### Video
 
 ```bash
-zenitel video -h 192.168.1.143
+tciv video -h 192.168.1.143
 # 📷 Video URLs:
 #   MJPG:  http://192.168.1.143/mjpg/video.mjpg
 #   RTSP:  rtsp://192.168.1.143:554/1/RTSP
@@ -195,18 +199,18 @@ zenitel video -h 192.168.1.143
 ### Call Button (DAK) Configuration
 
 ```bash
-zenitel dak get -h 192.168.1.143
-zenitel dak set --number portia-ae3c -h 192.168.1.143
+tciv dak get -h 192.168.1.143
+tciv dak set --number portia-ae3c -h 192.168.1.143
 ```
 
 > Downloads config → modifies XML → re-uploads → reboots. Zero external dependencies.
 
 ### Full Device Provisioning
 
-One command to configure a factory-reset Zenitel:
+One command to configure a factory-reset intercom:
 
 ```bash
-zenitel provision -h 192.168.1.143 \
+tciv provision -h 192.168.1.143 \
   --domain testing-mo16m3gw.sip.twilio.com \
   --sip-user zenitel01 \
   --sip-pass 'your-sip-password' \
@@ -218,7 +222,7 @@ zenitel provision -h 192.168.1.143 \
 ### Device Reboot
 
 ```bash
-zenitel reboot -h 192.168.1.143
+tciv reboot -h 192.168.1.143
 ```
 
 ### CLI Options
@@ -227,7 +231,7 @@ zenitel reboot -h 192.168.1.143
 |------|-------|-------------|---------|
 | `--host` | `-h` | Device IP address | required |
 | `--user` | `-u` | Web UI username | `admin` |
-| `--pass` | `-p` | Web UI password | `alphaadmin` |
+| `--pass` | `-p` | Web UI password | `alphaadmin` (change on first login) |
 | `--id` | | Relay ID (`relay1`, `gpio1`–`gpio6`) | `relay1` |
 | `--timer` | | Relay timer (seconds) | `3` |
 | `--timeout` | | Scan timeout (ms) | `5000` |
@@ -245,12 +249,12 @@ zenitel reboot -h 192.168.1.143
 
 ## API
 
-### `ZenitelClient`
+### `TcivClient`
 
 ```typescript
-import { ZenitelClient } from 'tciv-client';
+import { TcivClient } from 'tciv-client';
 
-const z = new ZenitelClient({
+const z = new TcivClient({
   host: '192.168.1.143',
   user: 'admin',         // default
   password: 'alphaadmin', // default
@@ -358,7 +362,7 @@ await z.provisionDevice({
 
 Read and write the full audio configuration — speaker/mic gain, echo cancellation, noise suppression, compression, and automatic volume control.
 
-> The Zenitel config endpoint requires the **complete** JSON payload. `setAudioSettings()` handles this automatically — it reads, merges your changes, and writes back.
+> The config endpoint requires the **complete** JSON payload. `setAudioSettings()` handles this automatically — it reads, merges your changes, and writes back.
 
 ```typescript
 const audio = await z.getAudioSettings();
@@ -408,7 +412,7 @@ const devices = await scanNetwork({ timeout: 5000 });
 | Strategy | Method | Speed |
 |----------|--------|-------|
 | `arp-oui` | ARP table + MAC prefix `00:13:CB` | Fast |
-| `http-probe` | Probe every IP for `zenitel.js` | Thorough |
+| `http-probe` | Probe every IP for `tciv-fingerprint` | Thorough |
 
 ---
 
@@ -420,7 +424,9 @@ const devices = await scanNetwork({ timeout: 5000 });
 | TCIV-3+ | ✅ | ✅ | ✅ | ✅ | Expected |
 | TCIS-2 | — | ✅ | ✅ | ✅ | Expected |
 
-## Goform Endpoint Map
+## HTTP API Reference
+
+All endpoints require valid administrator credentials via HTTP Basic Auth.
 
 | Endpoint | Method | Purpose |
 |----------|--------|---------|
@@ -436,8 +442,6 @@ const devices = await scanNetwork({ timeout: 5000 });
 | `/goform/zForm_system_prefs` | POST | Reboot device |
 | `/mjpg/video.mjpg` | GET | Live MJPG stream |
 
-Auth: **HTTP Basic** on all endpoints.
-
 ## License
 
 Apache-2.0

package/dist/cli.d.ts

@@ -1,14 +1,14 @@
 #!/usr/bin/env node
 /**
- * zenitel — CLI for testing Zenitel intercom interaction
+ * tciv — CLI for TCIV-series intercom administration
  *
  * Usage:
- *   zenitel scan                             Discover Zenitel devices on the network
- *   zenitel info -h 192.168.1.143            Get device info
- *   zenitel relay -h 192.168.1.143           Activate relay1 for 3 seconds
- *   zenitel relay -h ... --id gpio1 --timer 5
- *   zenitel call 122 -h 192.168.1.143        Place a call
- *   zenitel stop -h 192.168.1.143            Stop current call
- *   zenitel status -h 192.168.1.143          Get relay + call status
+ *   tciv scan                             Discover TCIV devices on the network
+ *   tciv info -h 192.168.1.143            Get device info
+ *   tciv relay -h 192.168.1.143           Activate relay1 for 3 seconds
+ *   tciv relay -h ... --id gpio1 --timer 5
+ *   tciv call 122 -h 192.168.1.143        Place a call
+ *   tciv stop -h 192.168.1.143            Stop current call
+ *   tciv status -h 192.168.1.143          Get relay + call status
  */
 export {};

package/dist/cli.js

@@ -1,17 +1,17 @@
 #!/usr/bin/env node
 /**
- * zenitel — CLI for testing Zenitel intercom interaction
+ * tciv — CLI for TCIV-series intercom administration
  *
  * Usage:
- *   zenitel scan                             Discover Zenitel devices on the network
- *   zenitel info -h 192.168.1.143            Get device info
- *   zenitel relay -h 192.168.1.143           Activate relay1 for 3 seconds
- *   zenitel relay -h ... --id gpio1 --timer 5
- *   zenitel call 122 -h 192.168.1.143        Place a call
- *   zenitel stop -h 192.168.1.143            Stop current call
- *   zenitel status -h 192.168.1.143          Get relay + call status
+ *   tciv scan                             Discover TCIV devices on the network
+ *   tciv info -h 192.168.1.143            Get device info
+ *   tciv relay -h 192.168.1.143           Activate relay1 for 3 seconds
+ *   tciv relay -h ... --id gpio1 --timer 5
+ *   tciv call 122 -h 192.168.1.143        Place a call
+ *   tciv stop -h 192.168.1.143            Stop current call
+ *   tciv status -h 192.168.1.143          Get relay + call status
  */
-import { ZenitelClient } from './client.js';
+import { TcivClient } from './client.js';
 import { scanNetwork } from './scanner.js';
 const args = process.argv.slice(2);
 const command = args[0];
@@ -32,7 +32,7 @@ function getClient() {
         console.error('Error: --host (-h) is required');
         process.exit(1);
     }
-    return new ZenitelClient({
+    return new TcivClient({
         host,
         user: flag('user', 'u') ?? 'admin',
         password: flag('pass', 'p') ?? 'alphaadmin',
@@ -41,12 +41,12 @@ function getClient() {
 async function main() {
     switch (command) {
         case 'scan': {
-            console.log('🔍 Scanning network for Zenitel devices...\n');
+            console.log('🔍 Scanning network for TCIV devices...\n');
             const devices = await scanNetwork({
                 timeout: Number(flag('timeout') ?? 5000),
             });
             if (devices.length === 0) {
-                console.log('No Zenitel devices found.');
+                console.log('No TCIV devices found.');
                 break;
             }
             for (const dev of devices) {
@@ -109,7 +109,7 @@ async function main() {
             const client = getClient();
             const number = args[1];
             if (!number) {
-                console.error('Usage: zenitel call <number> -h <host>');
+                console.error('Usage: tciv call <number> -h <host>');
                 process.exit(1);
             }
             console.log(`📞 Calling ${number}...`);
@@ -187,7 +187,7 @@ async function main() {
             else {
                 const info = await client.getDeviceInfo();
                 console.log(`Webcall: ${info.webcallEnabled ? '✅ Enabled' : '❌ Disabled'}`);
-                console.log('\nUsage: zenitel webcall enable|disable -h <host>');
+                console.log('\nUsage: tciv webcall enable|disable -h <host>');
             }
             break;
         }
@@ -206,7 +206,7 @@ async function main() {
             const { readFileSync } = await import('node:fs');
             const inFile = args[1];
             if (!inFile) {
-                console.error('Usage: zenitel restore <file.tar.gz> -h <host>');
+                console.error('Usage: tciv restore <file.tar.gz> -h <host>');
                 process.exit(1);
             }
             console.log(`📤 Uploading config from ${inFile}...`);
@@ -235,7 +235,7 @@ async function main() {
             if (subCmd === 'set') {
                 const number = flag('number') || args[2];
                 if (!number) {
-                    console.error('Usage: zenitel dak set --number <sip-number> -h <host>');
+                    console.error('Usage: tciv dak set --number <sip-number> -h <host>');
                     process.exit(1);
                 }
                 const domain = flag('domain');
@@ -266,7 +266,7 @@ async function main() {
             const sipAuthPassword = flag('sip-pass');
             const agentNumber = flag('number') || flag('agent');
             if (!sipDomain || !sipAuthUser || !sipAuthPassword || !agentNumber) {
-                console.error(`Usage: zenitel provision -h <host> \\
+                console.error(`Usage: tciv provision -h <host> \\
   --domain <sip-domain> \\
   --sip-user <auth-username> \\
   --sip-pass <auth-password> \\
@@ -323,7 +323,7 @@ Optional:
                 if (hasFlag('avc-off'))
                     partial.avc = { enabled: false };
                 if (Object.keys(partial).length === 0) {
-                    console.error(`Usage: zenitel audio set -h <host> [options]
+                    console.error(`Usage: tciv audio set -h <host> [options]
 
   --speaker <dB>    Speaker gain (-10 to +13)
   --mic <dB>        Mic gain (-10 to +10)
@@ -375,10 +375,10 @@ Optional:
             break;
         }
         default:
-            console.log(`zenitel — Zenitel intercom CLI
+            console.log(`tciv — TCIV intercom CLI
 
 Commands:
-  scan                       Discover devices on the network
+  scan                       Discover devices on the local network
   info     -h <host>         Device information
   relay    -h <host>         Activate relay (--id relay1 --timer 3)
   relay    -h <host> --off   Deactivate relay
@@ -398,7 +398,7 @@ Commands:
   video    -h <host>         Show video stream URLs
 
 Options:
-  -h, --host       IP address of the Zenitel
+  -h, --host       IP address of the intercom
   -u, --user       Username (default: admin)
   -p, --pass       Password (default: alphaadmin)
       --id         Relay ID (relay1, gpio1-gpio6)

package/dist/client.d.ts

@@ -1,19 +1,19 @@
 /**
- * ZenitelClient — HTTP scraper for Zenitel intercom web UI
+ * TcivClient — HTTP client for TCIV-series intercom systems
  *
- * All methods use the goform endpoints documented in the Zenitel wiki
+ * All methods use the goform endpoints documented in the manufacturer wiki
  * and confirmed against a real TCIV-2+ (FW 9.2.3.0) at 192.168.1.143.
  *
  * Auth: HTTP Basic Auth (admin/alphaadmin by default).
  * All goform endpoints use POST with form-urlencoded bodies.
  */
-import type { ZenitelClientOptions, DeviceInfo, RelayOptions, RelayStatus, CallStatus, SIPConfig, ProvisionConfig, AudioSettings } from './types.js';
-export declare class ZenitelClient {
+import type { TcivClientOptions, DeviceInfo, RelayOptions, RelayStatus, CallStatus, SIPConfig, ProvisionConfig, AudioSettings } from './types.js';
+export declare class TcivClient {
     private opts;
     private readonly baseUrl;
     private readonly authHeader;
     private readonly timeout;
-    constructor(opts: ZenitelClientOptions);
+    constructor(opts: TcivClientOptions);
     /** Check if the Zenitel is reachable */
     isReachable(): Promise<boolean>;
     /** Scrape station info + header for full device data */

package/dist/client.js

@@ -1,13 +1,13 @@
 /**
- * ZenitelClient — HTTP scraper for Zenitel intercom web UI
+ * TcivClient — HTTP client for TCIV-series intercom systems
  *
- * All methods use the goform endpoints documented in the Zenitel wiki
+ * All methods use the goform endpoints documented in the manufacturer wiki
  * and confirmed against a real TCIV-2+ (FW 9.2.3.0) at 192.168.1.143.
  *
  * Auth: HTTP Basic Auth (admin/alphaadmin by default).
  * All goform endpoints use POST with form-urlencoded bodies.
  */
-export class ZenitelClient {
+export class TcivClient {
     opts;
     baseUrl;
     authHeader;

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { ZenitelClient } from './client.js';
+export { TcivClient } from './client.js';
 export { scanNetwork } from './scanner.js';
-export type { ZenitelClientOptions, ZenitelDevice, ScanOptions, DeviceInfo, RelayOptions, RelayStatus, CallStatus, SIPConfig, ProvisionConfig, AudioSettings, AudioOutputDevice, AudioInputDevice, AECSettings, ANCSettings, FESSSettings, DRCSettings, AVCSettings, } from './types.js';
+export type { TcivClientOptions, TcivDevice, ScanOptions, DeviceInfo, RelayOptions, RelayStatus, CallStatus, SIPConfig, ProvisionConfig, AudioSettings, AudioOutputDevice, AudioInputDevice, AECSettings, ANCSettings, FESSSettings, DRCSettings, AVCSettings, } from './types.js';

package/dist/index.js

@@ -1,2 +1,2 @@
-export { ZenitelClient } from './client.js';
+export { TcivClient } from './client.js';
 export { scanNetwork } from './scanner.js';

package/dist/scanner.d.ts

@@ -1,10 +1,10 @@
 /**
- * Network scanner — Discover Zenitel intercoms on the local network
+ * Device discovery — Discover TCIV intercoms on the local network for authorized administrators
  *
  * Strategy A: ARP table + OUI filter (MAC prefix 00:13:cb = Zenitel)
  * Strategy B: HTTP probe with fingerprinting (zenitel.js in HTML)
  *
  * Both strategies run in parallel and results are merged by IP.
  */
-import type { ZenitelDevice, ScanOptions } from './types.js';
-export declare function scanNetwork(opts?: ScanOptions): Promise<ZenitelDevice[]>;
+import type { TcivDevice, ScanOptions } from './types.js';
+export declare function scanNetwork(opts?: ScanOptions): Promise<TcivDevice[]>;

package/dist/scanner.js

@@ -1,5 +1,5 @@
 /**
- * Network scanner — Discover Zenitel intercoms on the local network
+ * Device discovery — Discover TCIV intercoms on the local network for authorized administrators
  *
  * Strategy A: ARP table + OUI filter (MAC prefix 00:13:cb = Zenitel)
  * Strategy B: HTTP probe with fingerprinting (zenitel.js in HTML)
@@ -9,7 +9,7 @@
 import { execFile } from 'node:child_process';
 import { platform } from 'node:os';
 import { networkInterfaces } from 'node:os';
-import { ZenitelClient } from './client.js';
+import { TcivClient } from './client.js';
 const ZENITEL_OUI = '00:13:cb';
 // ── Public API ────────────────────────────────────────────────────────────
 export async function scanNetwork(opts) {
@@ -42,7 +42,7 @@ async function arpOuiScan() {
     const zenitels = entries.filter((e) => e.mac.toLowerCase().startsWith(ZENITEL_OUI));
     // For each candidate, try to get device info
     const results = await Promise.all(zenitels.map(async (entry) => {
-        const client = new ZenitelClient({ host: entry.ip, timeout: 3000 });
+        const client = new TcivClient({ host: entry.ip, timeout: 3000 });
         try {
             const info = await client.getDeviceInfo();
             return {

package/dist/types.d.ts

@@ -3,7 +3,7 @@
  *
  * All interfaces for the Zenitel HTTP scraper, scanner, and CLI.
  */
-export interface ZenitelClientOptions {
+export interface TcivClientOptions {
     /** IP or hostname of the Zenitel intercom (e.g. "192.168.1.143") */
     host: string;
     /** Web UI username. Default: "admin" */
@@ -15,7 +15,7 @@ export interface ZenitelClientOptions {
     /** HTTP request timeout in ms. Default: 5000 */
     timeout?: number;
 }
-export interface ZenitelDevice {
+export interface TcivDevice {
     ip: string;
     mac: string;
     model?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tciv-client",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "HTTP client for TCIV-series intercom systems (TCIV-2+, TCIV-3). Control relays, SIP configuration, DAK provisioning, webcall, audio settings, and camera feeds.",
   "type": "module",
   "main": "./dist/index.js",