tciv-client 0.0.4 → 0.0.6

package/README.md

@@ -29,6 +29,7 @@ This library is intended for **system integrators and IT administrators** managi
   - [Provisioning](#full-device-provisioning)
   - [Video](#video)
   - [Factory Reset](#factory-reset)
+  - [Mode (SIP/Edge)](#mode-sipedge)
   - [Reboot](#device-reboot)
 - [API](#api)
   - [Connectivity](#connectivity)
@@ -240,6 +241,27 @@ tciv factory-reset -h 192.168.1.143 --keep-ip
 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 |
@@ -434,6 +456,27 @@ await z.factoryReset('dhcp');
 | `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()`

package/dist/cli.js

@@ -229,6 +229,41 @@ async function main() {
             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': {

package/dist/client.d.ts

@@ -43,7 +43,11 @@ export declare class TcivClient {
     };
     /** Read current SIP config by scraping the form fields */
     getSIPConfig(): Promise<SIPConfig>;
-    /** Write SIP config via POST to zForm_save_changes */
+    /**
+     * Write SIP config via POST to zForm_save_changes.
+     * The Zenitel form requires ALL fields to be present — partial submissions are silently ignored.
+     * Submit field is `sipconfig=SAVE` (not signallingMode).
+     */
     setSIPConfig(config: SIPConfig): Promise<void>;
     /** Enable webcall + relay HTTP API (required for FW ≥4.11.3.1) */
     enableWebcall(): Promise<void>;
@@ -137,6 +141,28 @@ export declare class TcivClient {
      *   - '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

@@ -188,24 +188,41 @@ export class TcivClient {
             transport: select('sip_outbound_transport'),
         };
     }
-    /** Write SIP config via POST to zForm_save_changes */
+    /**
+     * Write SIP config via POST to zForm_save_changes.
+     * The Zenitel form requires ALL fields to be present — partial submissions are silently ignored.
+     * Submit field is `sipconfig=SAVE` (not signallingMode).
+     */
     async setSIPConfig(config) {
-        const fields = {};
-        if (config.displayName !== undefined)
-            fields.sip_nick = config.displayName;
-        if (config.directoryNumber !== undefined)
-            fields.sip_id = config.directoryNumber;
-        if (config.domain !== undefined)
-            fields.sip_domain = config.domain;
-        if (config.authUsername !== undefined)
-            fields.sip_auth_user = config.authUsername;
-        if (config.authPassword !== undefined)
-            fields.sip_auth_pwd = config.authPassword;
-        if (config.outboundProxy !== undefined)
-            fields.sip_ppa = config.outboundProxy;
-        if (config.transport !== undefined)
-            fields.sip_outbound_transport = config.transport.toUpperCase();
-        fields.save_changes = 'Save';
+        // Read current values first (read-modify-write)
+        const current = await this.getSIPConfig();
+        const fields = {
+            sip_nick: config.displayName ?? current.displayName ?? '',
+            sip_id: config.directoryNumber ?? current.directoryNumber ?? '',
+            sip_domain: config.domain ?? current.domain ?? '',
+            sip_domain2: config.domain ?? current.domain ?? '',
+            sip_domain3: config.domain ?? current.domain ?? '',
+            registration_method: '0',
+            sip_auth_user: config.authUsername ?? current.authUsername ?? '',
+            sip_auth_pwd: config.authPassword ?? current.authPassword ?? '',
+            register_interval: '100',
+            fail_interval: '60',
+            sip_ppa: config.outboundProxy ?? current.outboundProxy ?? '',
+            sip_ppp: '5060',
+            sip_outbound_proxy_backup_address: '',
+            sip_outbound_proxy_backup_port: '5060',
+            sip_outbound_proxy_backup_address2: '',
+            sip_outbound_proxy_backup_port2: '5060',
+            sip_outbound_transport: (config.transport ?? current.transport ?? 'udp').toUpperCase(),
+            sip_scheme: 'sip',
+            rtp_encryption: 'disabled',
+            srtp_crypto_type: 'AES_CM_128_HMAC_SHA1_80',
+            multicast_relay: '',
+            auto_answer_mode: 'on',
+            auto_resume_call: 'on',
+            mkey_dtmf: 'on',
+            sipconfig: 'SAVE',
+        };
         await this._post('/goform/zForm_save_changes', fields);
     }
     // ── Webcall Enable/Disable ─────────────────────────────────────────────
@@ -242,7 +259,8 @@ export class TcivClient {
     async getDAK(buttonIndex = 0) {
         const res = await this._fetch('/goform/zForm_speeddial_configuration_basic_auth');
         const html = await res.text();
-        const match = html.match(new RegExp(`name='dak_value${buttonIndex}'[^>]*value='([^']*)'`));
+        // Attribute order varies: value may come before or after name
+        const match = html.match(new RegExp(`dak_value${buttonIndex}[^>]*value='([^']*)'`));
         return match?.[1] || '';
     }
     // ── Config Backup / Restore ────────────────────────────────────────────
@@ -673,6 +691,55 @@ export class TcivClient {
             // 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,18 +1,30 @@
 {
   "name": "tciv-client",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "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",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
-      "require": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
     },
     "./scanner": {
-      "import": { "types": "./dist/scanner.d.ts", "default": "./dist/scanner.js" },
-      "require": { "types": "./dist/scanner.d.ts", "default": "./dist/scanner.js" }
+      "import": {
+        "types": "./dist/scanner.d.ts",
+        "default": "./dist/scanner.js"
+      },
+      "require": {
+        "types": "./dist/scanner.d.ts",
+        "default": "./dist/scanner.js"
+      }
     }
   },
   "bin": {
@@ -30,10 +42,20 @@
     "tsx": "^4.21.0",
     "@types/node": "^22.0.0"
   },
-  "files": ["dist", "README.md"],
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "keywords": [
-    "intercom", "TCIV", "SIP", "door-access",
-    "relay", "DTMF", "webcall", "building-automation", "tciv-client"
+    "intercom",
+    "TCIV",
+    "SIP",
+    "door-access",
+    "relay",
+    "DTMF",
+    "webcall",
+    "building-automation",
+    "tciv-client"
   ],
   "license": "Apache-2.0",
   "repository": {