tciv-client 0.0.2 → 0.0.4

package/README.md

@@ -28,6 +28,7 @@ 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)
   - [Reboot](#device-reboot)
 - [API](#api)
   - [Connectivity](#connectivity)
@@ -42,6 +43,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 +227,19 @@ 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
+```
+
 ### CLI Options
 
 | Flag | Short | Description | Default |
@@ -244,6 +259,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 +415,25 @@ 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 |
+
 ---
 
 ### `scanNetwork()`
@@ -440,6 +476,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,15 @@ 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.');
+            break;
+        }
         case 'video': {
             const client = getClient();
             console.log(`📷 Video URLs for ${flag('host', 'h')}:\n`);

package/dist/client.d.ts

@@ -7,13 +7,13 @@
  * 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';
+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 */
@@ -126,8 +126,17 @@ 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>;
     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,28 @@ 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
+        }
+    }
     // ── Internal helpers ────────────────────────────────────────────────────
     async _fetch(path, method = 'GET', timeout, body, contentType) {
         const controller = new AbortController();

package/dist/index.d.ts

@@ -1,4 +1,3 @@
 export { TcivClient } from './client.js';
-export { TcivClient as ZenitelClient } from './client.js';
 export { scanNetwork } from './scanner.js';
-export type { ZenitelClientOptions as TcivClientOptions, 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,3 +1,2 @@
 export { TcivClient } from './client.js';
-export { TcivClient as ZenitelClient } from './client.js';
 export { scanNetwork } from './scanner.js';

package/dist/scanner.d.ts

@@ -6,5 +6,5 @@
  *
  * 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/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.2",
+  "version": "0.0.4",
   "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",