node-alarmdecoder - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

package.json

 {
   "name": "node-alarmdecoder",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Node.JS client for listening and parsing AlarmDecoder events over ser2sock",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -11,4 +11,2 @@ # node-alarmdecoder
 
-**Documentation is Work In Progress**
-
 Installation
@@ -25,121 +23,131 @@ ------------
 * 'disconnected' - You shall know
-* 'zoneChanged' - Zone status has been changed. Scroll down to output example. 
-"state": 1 = movement started, door opened or there's a fire, 0 = movement stopped, door closed or no more fire, yay!
-Example in case of Front Door is opened:
-```json
-{
-  "zone": {
-    "name": "Front Door",
-    "type": "contact"
+* 'zoneChanged' - Zone status has been changed (movement, door open/close, fire on/off)
+* 'keypadMessage' - Keypad message events / panel status
+
+And one method:
+* enterCode(code) - You can use this to arm/disarm your panel with the code specified
+
+## Events
+
+### zoneChanged(data)
+```javascript
+data = {
+  zone: {
+    name: 'Zone name',
+    type: 'Zone type' // one of movement, contact, fire
   },
-  "state": 1
+  state: 0/1 // 0 = closed (movement stopped, door closed, fire off), 1 = opened (movement began, door opened, fire on)
 }
 ```
-* 'keypadMessage' - Keypad message events / panel status bits. To be documented.
 
-And currently one method:
-* enterCode(code) - You can use this to arm/disarm your panel with the code specified
+### keypadMessage(data)
+```javascript
+data = {
+  message: 'Secure System Before Arming',
+  numeric: '000', //  Numeric Code: This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures. 
+  bits: {
+    Ready: false,
+    'Armed Away': false,
+    'Armed Home': false,
+    'Backlight on': false,
+    Programming: false,
+    Beeps: 0,
+    'Zone bypassed': 0,
+    'AC power': true,
+    'Chime enabled': false,
+    'Alarm occured': false,
+    'Alarm on': false,
+    'Battery low': false,
+    'Entry delay off': false,
+    Fire: false,
+    'System issue': false,
+    'Watching perimeter': false,
+    'Error report': false,
+    'Device mode': 'DSC'
+  }
+}
+```
 
-## Usage example
+## Example code
 ```javascript
-const AlarmDecoder = require('node-alarmdecoder');
-const myAlarm = new AlarmDecoder('alarmdecoder', 10000, {
-  '00:01': {
-    name: 'Front Door',
-    type: 'contact'
-  },
-  '00:02': {
-    name: 'Hallway',
-    type: 'motion'
-  },
-  '00:03': {
-    name: 'Livingroom',
-    type: 'motion'
-  },
-  '00:04': {
-    name: 'Yard door',
-    type: 'contact'
-  },
-  '00:05': {
-    name: 'Garage',
-    type: 'fire'
-  },
+const alarmDecoder = require('node-alarmdecoder');
+const config = { 
+  ip: 'alarmdecoder', 
+  port: 10000,
+  zones: {
+    // 'expander:channel': { name: 'String', type: '{contact/motion/fire}' }
+    '00:01': {
+      name: 'Front Door',
+      type: 'contact'
+    },
+    '00:02': {
+      name: 'Hallway',
+      type: 'motion'
+    },
+    '00:03': {
+      name: 'Living room',
+      type: 'motion'
+    },
+    '00:04': {
+      name: 'Dining room',
+      type: 'motion'
+    },
+    '00:05': {
+      name: 'Yard door',
+      type: 'contact'
+    },
+    '00:06': {
+      name: 'Yard door 2',
+      type: 'contact'
+    },
+    '00:07': {
+      name: 'Hallway II',
+      type: 'motion'
+    }
   // ... more zones
+  }
+};
+
+const myAlarm = new alarmDecoder(config.ip, config.port, config.zones);
+
+myAlarm.events.on('connected', () => console.log('Connected'));
+myAlarm.events.on('disconnected', () => console.log('Disconnected'));
+myAlarm.events.on('zoneChanged', (data) => {
+  if (data.zone.type === 'motion') {
+    console.log('Movement' + (data.state ? '' : ' ended') + ' at ' + data.zone.name);
+  } else if (data.zone.type === 'fire') {
+    console.log('FIRE ' + (data.state ? 'ON' : 'OFF') + ' @ ' + data.zone.name);
+  } else if (data.zone.type === 'contact') { 
+    console.log(data.zone.name + (data.state ? ' opened' : ' closed'));
+  }
 });
 
-myAlarm.events.on('connected', () => console.log('connected'));
-myAlarm.events.on('disconnected', () => console.log('disconnected'));
-myAlarm.events.on('zoneChanged', (data) => console.log('zone Change', data));
-myAlarm.events.on('keypadMessage', (data) => console.log('keypadMessage', data));
+let lastMsg = '';
+myAlarm.events.on('keypadMessage', (data) => {
+  let str = JSON.stringify(data);
+  if (lastMsg !== str) { // log only changes
+    lastMsg = str;
+    console.log('Keypad: ' + data.message);
+  }
+});
+
 // myAlarm.enterCode('0000');
 ```
-### Output of example
+### Output of example code
 ```
-zone Change {
-  zone: {
-    name: 'Hallway',
-    type: 'motion'
-  },
-  state: 1
-} // movement in Hallway
-
-keypadMessage { numeric: '000',
-  bits:
-   { Ready: false,
-     'Armed Away': false,
-     'Armed Home': false,
-     'Backlight on': false,
-     Programming: false,
-     Beeps: 0,
-     'Zone bypassed': 0,
-     'AC power': true,
-     'Chime enabled': false,
-     'Alarm occured': false,
-     'Alarm on': false,
-     'Battery low': false,
-     'Entry delay off': false,
-     Fire: false,
-     'System issue': false,
-     'Watching perimeter': false,
-     'Error report': false,
-     'Device mode': 'DSC' },
-    message: 'Secure System Before Arming' }
-
-zone Change {
-  zone: {
-    name: 'Hallway',
-    type: 'motion'
-  },
-  state: 0
-} // no more movement in Hallway II
-
-keypadMessage { numeric: '000',
-  bits:
-   { Ready: true,
-     'Armed Away': false,
-     'Armed Home': false,
-     'Backlight on': false,
-     Programming: false,
-     Beeps: 0,
-     'Zone bypassed': 0,
-     'AC power': true,
-     'Chime enabled': false,
-     'Alarm occured': false,
-     'Alarm on': false,
-     'Battery low': false,
-     'Entry delay off': false,
-     Fire: false,
-     'System issue': false,
-     'Watching perimeter': false,
-     'Error report': false,
-     'Device mode': 'DSC' },
-    message: 'System Is Ready To Arm' }
-
-zone Change {
-  zone: {
-    name: 'Front Door',
-    type: 'contact'
-  },
-  state: 1
-} // front door opened
+Keypad: System Is Ready To Arm
+Movement at Hallway II
+Keypad: Secure System Before Arming
+Movement ended at Hallway II
+Keypad: System Is Ready To Arm
+Front Door opened
+Keypad: Secure System Before Arming
+Front Door Closed
+Keypad: System Is Ready To Arm
+// myAlarm.enterCode('0000');
+Keypad: Exit Delay In Progress
+Keypad: System Is Armed In Away Mode
+// myAlarm.enterCode('0000');
+Keypad: System Disarmed No Alarm Memory
+Keypad: System Is Ready To Arm
 ```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14112

increased by22%

Number of package files

7

increased by16.67%

Lines of code

370

increased by28.92%

Number of lines in readme file

152

increased by5.56%

No dependency changes