tciv-client 0.0.3 → 0.0.5

package/README.md

@@ -28,6 +28,8 @@ This library is intended for **system integrators and IT administrators** managi
   - [Call Button (DAK)](#call-button-dak-configuration)
   - [Provisioning](#full-device-provisioning)
   - [Video](#video)
+  - [Factory Reset](#factory-reset)
+  - [Mode (SIP/Edge)](#mode-sipedge)
   - [Reboot](#device-reboot)
 - [API](#api)
   - [Connectivity](#connectivity)
@@ -42,6 +44,7 @@ This library is intended for **system integrators and IT administrators** managi
   - [Provisioning](#full-device-provisioning-1)
   - [Audio Settings](#audio-settings)
   - [Reboot](#reboot)
+  - [Factory Reset](#factory-reset-1)
 - [Device Discovery](#scannetwork)
 - [Supported Hardware](#supported-hardware)
 - [HTTP API Reference](#http-api-reference)
@@ -225,6 +228,40 @@ tciv provision -h 192.168.1.143 \
 tciv reboot -h 192.168.1.143
 ```
 
+### Factory Reset
+
+```bash
+# Full reset (IP → 169.254.1.100)
+tciv factory-reset -h 192.168.1.143
+
+# Reset but keep current IP settings (recommended)
+tciv factory-reset -h 192.168.1.143 --keep-ip
+
+# Reset with DHCP enabled
+tciv factory-reset -h 192.168.1.143 --dhcp
+```
+
+### Mode (SIP/Edge)
+
+```bash
+# Read current mode
+tciv mode -h 192.168.1.143
+# 📡 Current mode: SIP (sip)
+
+# Switch to SIP mode (reboots device, waits ~40s)
+tciv mode set sip -h 192.168.1.143
+
+# Switch to Edge mode
+tciv mode set exc -h 192.168.1.143
+```
+
+| Mode value | Description |
+|------------|-------------|
+| `sip` | SIP mode (required for Portia) |
+| `dip` | ICX-AlphaCom |
+| `exc` | Edge |
+| `srv` | Edge Controller |
+
 ### CLI Options
 
 | Flag | Short | Description | Default |
@@ -244,6 +281,8 @@ tciv reboot -h 192.168.1.143
 | `--no-reboot` | | Skip reboot after DAK set | |
 | `--sip-user` | | SIP auth username (provision) | |
 | `--sip-pass` | | SIP auth password (provision) | |
+| `--keep-ip` | | Factory reset: keep IP settings | |
+| `--dhcp` | | Factory reset: enable DHCP | |
 
 ---
 
@@ -398,6 +437,46 @@ fs.writeFileSync('audio-backup.json', JSON.stringify(raw, null, 2));
 await z.reboot(); // ~30 seconds offline
 ```
 
+#### Factory Reset
+
+```typescript
+// Full reset (static IP 169.254.1.100)
+await z.factoryReset('full');
+
+// Reset but keep current IP (recommended)
+await z.factoryReset('keep-ip');
+
+// Reset with DHCP
+await z.factoryReset('dhcp');
+```
+
+| Mode | Behavior |
+|------|----------|
+| `full` | All defaults, IP → 169.254.1.100 |
+| `dhcp` | All defaults, DHCP enabled |
+| `keep-ip` | All defaults, current IP preserved |
+
+#### Mode
+
+```typescript
+// Read current mode
+const mode = await z.getMode();
+// 'sip' | 'dip' | 'pulse' (Edge) | 'srv'
+
+// Switch to SIP mode
+await z.setMode('sip');
+await z.applyChanges(); // triggers reboot
+await z.waitForReboot(); // polls until online (~40s)
+```
+
+#### Wait for Reboot
+
+```typescript
+// Poll until device comes back online (default 60s timeout)
+const online = await z.waitForReboot(60000, 3000);
+// true = device is back, false = timeout
+```
+
 ---
 
 ### `scanNetwork()`
@@ -440,6 +519,7 @@ All endpoints require valid administrator credentials via HTTP Basic Auth.
 | `/goform/zForm_config_backup` | POST | Config restore (upload) |
 | `/ipst_config.tar.gz` | GET | Config backup download |
 | `/goform/zForm_system_prefs` | POST | Reboot device |
+| `/goform/zForm_send_cmd` | POST | Factory reset (full/DHCP/keep-ip) |
 | `/mjpg/video.mjpg` | GET | Live MJPG stream |
 
 ## License

package/dist/cli.js

@@ -222,6 +222,50 @@ async function main() {
             console.log('✅ Reboot command sent. Device will be offline for ~30 seconds.');
             break;
         }
+        case 'factory-reset': {
+            const client = getClient();
+            const mode = hasFlag('keep-ip') ? 'keep-ip' : hasFlag('dhcp') ? 'dhcp' : 'full';
+            const labels = { 'full': 'full (IP → 169.254.1.100)', 'dhcp': 'full + DHCP', 'keep-ip': 'keep IP settings' };
+            console.log(`⚠️  Factory reset (${labels[mode]}) — all settings will be lost!`);
+            await client.factoryReset(mode);
+            console.log('✅ Factory reset sent. Device will reboot with default settings.');
+            if (!hasFlag('no-wait')) {
+                console.log('⏳ Waiting for device to come back online...');
+                const ok = await client.waitForReboot(90000);
+                console.log(ok ? '✅ Device is back online!' : '⚠️  Timeout — device may still be rebooting.');
+            }
+            break;
+        }
+        case 'mode': {
+            const client = getClient();
+            const subCmd = args[1]; // get | set
+            if (subCmd === 'set') {
+                const target = args[2];
+                if (!target || !['sip', 'dip', 'exc', 'srv'].includes(target)) {
+                    console.error('Usage: tciv mode set <sip|dip|exc|srv>');
+                    console.log('  sip  = SIP mode');
+                    console.log('  dip  = ICX-AlphaCom');
+                    console.log('  exc  = Edge');
+                    console.log('  srv  = Edge Controller');
+                    process.exit(1);
+                }
+                console.log(`🔄 Setting mode to ${target}...`);
+                await client.setMode(target);
+                console.log('📤 Applying changes (device will reboot)...');
+                await client.applyChanges();
+                if (!hasFlag('no-wait')) {
+                    console.log('⏳ Waiting for device to come back online...');
+                    const ok = await client.waitForReboot(90000);
+                    console.log(ok ? '✅ Device is back online!' : '⚠️  Timeout — device may still be rebooting.');
+                }
+            }
+            else {
+                const mode = await client.getMode();
+                const labels = { sip: 'SIP', dip: 'ICX-AlphaCom', exc: 'Edge', srv: 'Edge Controller', pulse: 'Edge' };
+                console.log(`📡 Current mode: ${labels[mode] || mode} (${mode})`);
+            }
+            break;
+        }
         case 'video': {
             const client = getClient();
             console.log(`📷 Video URLs for ${flag('host', 'h')}:\n`);

package/dist/client.d.ts

@@ -126,8 +126,39 @@ export declare class TcivClient {
     private _replaceFileInTar;
     /** Recalculate tar header checksum (sum of all header bytes with checksum field as spaces) */
     private _updateTarChecksum;
-    /** Reboot the Zenitel (required after config changes) */
+    /** Reboot the device (required after config changes) */
     reboot(): Promise<void>;
+    /**
+     * Factory reset — restores all settings to defaults. Device will reboot.
+     *
+     * @param mode - Reset mode:
+     *   - 'full'     → Static IP 169.254.1.100 (default)
+     *   - 'dhcp'     → Factory defaults + DHCP enabled
+     *   - 'keep-ip'  → Factory defaults but keep current IP settings
+     */
+    factoryReset(mode?: 'full' | 'dhcp' | 'keep-ip'): Promise<void>;
+    /**
+     * Get the current device mode.
+     * Returns 'sip', 'dip' (ICX-AlphaCom), 'exc' (Edge), or 'srv' (Edge Controller).
+     */
+    getMode(): Promise<string>;
+    /**
+     * Set device mode. Requires applyChanges() + reboot afterwards.
+     * @param mode - 'sip' | 'dip' (ICX-AlphaCom) | 'exc' (Edge) | 'srv' (Edge Controller)
+     */
+    setMode(mode: 'sip' | 'dip' | 'exc' | 'srv'): Promise<void>;
+    /**
+     * Send APPLY command to trigger reboot after config changes.
+     * The device responds with "System is rebooting..." and goes offline.
+     */
+    applyChanges(): Promise<void>;
+    /**
+     * Poll the device until it comes back online after a reboot.
+     * @param timeoutMs - Max wait time (default 60s)
+     * @param intervalMs - Poll interval (default 3s)
+     * @returns true if device came back, false if timeout
+     */
+    waitForReboot(timeoutMs?: number, intervalMs?: number): Promise<boolean>;
     private _fetch;
     private _html;
     private _post;

package/dist/client.js

@@ -642,7 +642,7 @@ export class TcivClient {
         Buffer.from(checksumStr).copy(header, 148);
     }
     // ── Reboot ─────────────────────────────────────────────────────────────
-    /** Reboot the Zenitel (required after config changes) */
+    /** Reboot the device (required after config changes) */
     async reboot() {
         try {
             await this._post('/goform/zForm_system_prefs', { reboot: 'Reboot' });
@@ -651,6 +651,77 @@ export class TcivClient {
             // May disconnect before response — that's expected
         }
     }
+    /**
+     * Factory reset — restores all settings to defaults. Device will reboot.
+     *
+     * @param mode - Reset mode:
+     *   - 'full'     → Static IP 169.254.1.100 (default)
+     *   - 'dhcp'     → Factory defaults + DHCP enabled
+     *   - 'keep-ip'  → Factory defaults but keep current IP settings
+     */
+    async factoryReset(mode = 'full') {
+        const params = {
+            'full': 'factory_reset',
+            'dhcp': 'factory_reset_dhcp',
+            'keep-ip': 'factory_reset_keep_ip_settings',
+        };
+        const name = params[mode];
+        try {
+            await this._post('/goform/zForm_send_cmd', { [name]: '1' });
+        }
+        catch {
+            // Device disconnects during reset — expected
+        }
+    }
+    // ── Mode (SIP / Edge / ICX-AlphaCom) ───────────────────────────────────
+    /**
+     * Get the current device mode.
+     * Returns 'sip', 'dip' (ICX-AlphaCom), 'exc' (Edge), or 'srv' (Edge Controller).
+     */
+    async getMode() {
+        const info = await this.getDeviceInfo();
+        return info.mode || 'sip';
+    }
+    /**
+     * Set device mode. Requires applyChanges() + reboot afterwards.
+     * @param mode - 'sip' | 'dip' (ICX-AlphaCom) | 'exc' (Edge) | 'srv' (Edge Controller)
+     */
+    async setMode(mode) {
+        await this._post('/goform/zForm_save_changes', {
+            sigmode: mode,
+            signallingMode: 'SAVE',
+        });
+    }
+    /**
+     * Send APPLY command to trigger reboot after config changes.
+     * The device responds with "System is rebooting..." and goes offline.
+     */
+    async applyChanges() {
+        try {
+            await this._fetch('/goform/zForm_send_cmd?message=APPLY', 'GET', 5000);
+        }
+        catch {
+            // Device disconnects during reboot — expected
+        }
+    }
+    // ── Wait for reboot ────────────────────────────────────────────────────
+    /**
+     * Poll the device until it comes back online after a reboot.
+     * @param timeoutMs - Max wait time (default 60s)
+     * @param intervalMs - Poll interval (default 3s)
+     * @returns true if device came back, false if timeout
+     */
+    async waitForReboot(timeoutMs = 60000, intervalMs = 3000) {
+        const start = Date.now();
+        // Wait a bit for device to actually go offline first
+        await new Promise(r => setTimeout(r, 5000));
+        while (Date.now() - start < timeoutMs) {
+            if (await this.isReachable())
+                return true;
+            await new Promise(r => setTimeout(r, intervalMs));
+        }
+        return false;
+    }
     // ── Internal helpers ────────────────────────────────────────────────────
     async _fetch(path, method = 'GET', timeout, body, contentType) {
         const controller = new AbortController();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tciv-client",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "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",