dsc-itv2-client 1.0.7

package/src/examples/arm-disarm-example.js

@@ -0,0 +1,152 @@
+/**
+ * Arm/Disarm Control Example
+ *
+ * This example demonstrates how to arm and disarm partitions
+ * using the ITV2Client library.
+ */
+
+import { ITV2Client } from '../index.js';
+import readline from 'readline';
+
+// Configuration
+const config = {
+  integrationId: process.env.INTEGRATION_ID || '123123123123',
+  accessCode: process.env.ACCESS_CODE || '12345678',
+  masterCode: process.env.MASTER_CODE || '5555',
+  port: parseInt(process.env.UDP_PORT || '3073'),
+  logLevel: process.env.LOG_LEVEL || 'minimal'  // 'silent', 'minimal', 'verbose'
+};
+
+const client = new ITV2Client(config);
+let sessionEstablished = false;
+
+// Create readline interface
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+  prompt: '> '
+});
+
+// Session events
+client.on('listening', (address) => {
+  console.log(`Listening on ${address.address}:${address.port}`);
+  console.log('Waiting for panel connection...\n');
+});
+
+client.on('session:established', () => {
+  sessionEstablished = true;
+  console.log('✅ Session established!\n');
+  console.log('Commands:');
+  console.log('  stay [partition] [code]  - Arm in STAY mode');
+  console.log('  away [partition] [code]  - Arm in AWAY mode');
+  console.log('  disarm [partition] [code] - Disarm partition');
+  console.log('  status                    - Show current status');
+  console.log('  quit                      - Exit\n');
+  rl.prompt();
+});
+
+// Zone events
+client.on('zone:open', (zone) => {
+  console.log(`\n🚪 Zone ${zone} opened`);
+  if (sessionEstablished) rl.prompt();
+});
+
+client.on('zone:closed', (zone) => {
+  console.log(`\n🔒 Zone ${zone} closed`);
+  if (sessionEstablished) rl.prompt();
+});
+
+// Partition events (these would be emitted when the panel confirms arming/disarming)
+client.on('partition:armed', (partition, mode) => {
+  console.log(`\n🛡️  Partition ${partition} ARMED (mode: ${mode})`);
+  if (sessionEstablished) rl.prompt();
+});
+
+client.on('partition:disarmed', (partition) => {
+  console.log(`\n🔓 Partition ${partition} DISARMED`);
+  if (sessionEstablished) rl.prompt();
+});
+
+// Command errors
+client.on('command:error', (error) => {
+  console.log(`\n⚠️  Command error: ${error.message}`);
+  if (sessionEstablished) rl.prompt();
+});
+
+// Handle user commands
+rl.on('line', (line) => {
+  const [cmd, ...args] = line.trim().split(/\s+/);
+
+  if (!sessionEstablished && cmd !== 'quit') {
+    console.log('⚠️  Session not established yet');
+    rl.prompt();
+    return;
+  }
+
+  switch (cmd) {
+    case 'stay':
+      const stayPartition = parseInt(args[0] || '1');
+      const stayCode = args[1] || config.masterCode;
+      console.log(`Arming partition ${stayPartition} in STAY mode...`);
+      client.armStay(stayPartition, stayCode);
+      break;
+
+    case 'away':
+      const awayPartition = parseInt(args[0] || '1');
+      const awayCode = args[1] || config.masterCode;
+      console.log(`Arming partition ${awayPartition} in AWAY mode...`);
+      client.armAway(awayPartition, awayCode);
+      break;
+
+    case 'disarm':
+      const disarmPartition = parseInt(args[0] || '1');
+      const disarmCode = args[1] || config.masterCode;
+      console.log(`Disarming partition ${disarmPartition}...`);
+      client.disarm(disarmPartition, disarmCode);
+      break;
+
+    case 'status':
+      const zones = client.getZones();
+      const partitions = client.getPartitions();
+
+      console.log('\n=== Current Status ===');
+      console.log('\nZones:');
+      for (const [zoneNum, zone] of Object.entries(zones)) {
+        console.log(`  Zone ${zoneNum}: ${zone.open ? 'OPEN' : 'CLOSED'}`);
+      }
+
+      console.log('\nPartitions:');
+      for (const [partNum, partition] of Object.entries(partitions)) {
+        console.log(`  Partition ${partNum}: ${partition.armedState || 'Unknown'}`);
+      }
+      console.log();
+      break;
+
+    case 'quit':
+    case 'exit':
+      console.log('Closing session...');
+      client.stop().then(() => process.exit(0));
+      return;
+
+    case '':
+      // Empty line, just show prompt again
+      break;
+
+    default:
+      console.log(`Unknown command: ${cmd}`);
+      console.log('Type "stay", "away", "disarm", "status", or "quit"');
+      break;
+  }
+
+  rl.prompt();
+});
+
+// Start
+console.log('╔════════════════════════════════════════╗');
+console.log('║  DSC ITV2 Arm/Disarm Control Example  ║');
+console.log('╚════════════════════════════════════════╝\n');
+
+client.start().catch((error) => {
+  console.error('Failed to start:', error.message);
+  process.exit(1);
+});

package/src/examples/basic-monitoring.js

@@ -0,0 +1,82 @@
+/**
+ * Basic Zone Monitoring Example
+ *
+ * This example shows the simplest way to use the ITV2Client library
+ * to monitor zone status changes on your DSC alarm panel.
+ */
+
+import { ITV2Client } from '../index.js';
+
+// Configuration - update with your panel's credentials
+const config = {
+  integrationId: process.env.INTEGRATION_ID || '123123123123',
+  accessCode: process.env.ACCESS_CODE || '12345678',
+  masterCode: process.env.MASTER_CODE || '5555',
+  port: parseInt(process.env.UDP_PORT || '3073'),
+  logLevel: process.env.LOG_LEVEL || 'minimal'  // 'silent', 'minimal', 'verbose'
+};
+
+// Create client
+const client = new ITV2Client(config);
+
+// Handle session events
+client.on('listening', (address) => {
+  console.log(`\n🎧 Listening on ${address.address}:${address.port}`);
+  console.log('⏳ Waiting for panel to connect...\n');
+});
+
+client.on('session:connecting', () => {
+  console.log('🔌 Panel connecting...');
+});
+
+client.on('session:established', (keys) => {
+  console.log('✅ Session established!');
+  console.log('🔐 Encrypted communication enabled\n');
+  console.log('📡 Monitoring zone changes (open/close a door or window)...\n');
+});
+
+client.on('session:closed', () => {
+  console.log('\n👋 Session closed');
+});
+
+client.on('session:error', (error) => {
+  console.error('❌ Session error:', error.message);
+});
+
+// Handle zone events
+client.on('zone:open', (zoneNumber) => {
+  console.log(`🚪 Zone ${zoneNumber} OPENED`);
+});
+
+client.on('zone:closed', (zoneNumber) => {
+  console.log(`🔒 Zone ${zoneNumber} CLOSED`);
+});
+
+client.on('zone:status', (zoneNumber, status) => {
+  // This event includes full status details
+  if (status.open) {
+    console.log(`   ℹ️  Zone ${zoneNumber} details: ${JSON.stringify(status)}`);
+  }
+});
+
+// Handle errors
+client.on('error', (error) => {
+  console.error('❌ Error:', error.message);
+});
+
+// Graceful shutdown
+process.on('SIGINT', async () => {
+  console.log('\n\n🛑 Shutting down gracefully...');
+  await client.stop();
+  process.exit(0);
+});
+
+// Start the client
+console.log('╔════════════════════════════════════════╗');
+console.log('║  DSC ITV2 Basic Zone Monitoring       ║');
+console.log('╚════════════════════════════════════════╝\n');
+
+client.start().catch((error) => {
+  console.error('Failed to start client:', error.message);
+  process.exit(1);
+});