Alarm system plugin for pimatic
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.gitignore
.travis.yml
Gruntfile.coffee
LICENSE
README.md
alarm-config-schema.coffee
alarm.coffee
device-config-schema.coffee
package.json

README.md

Build Status Version downloads

pimatic-alarm

pimatic-alarm is a pimatic plugin, that creates an alarm system based on the existing sensors and actuators defined in the pimatic installation.

The alarm system can switch all devices, that extend from SwitchActuator, e.g. lights or smoke alarms. The alarm can triggered by any of the devices, that extend from PresenceSensor or ContactSensor, e.g. HomeduinoRFPir or HomeduinoRFContactSensor.

Installation

To install the plugin just add the plugin to the config.json of pimatic:

{
  "plugin": "alarm"   
}

The plugin comes with two types of devices. The "AlarmSystem" is used to activate the alarm system. The "AlarmSwitch" can be used to manually trigger an alarm e.g. by rule. It can also disable an activated alarm.

Usage:

"devices": [
  {
    "id": "alarm_system",
    "name": "Alarm system",
    "class": "AlarmSystem"
  },
  {
    "id": "alarm_trigger",
    "name": "Alarm",
    "class": "AlarmSwitch"
  }
]

Note that you need at least one "AlarmSystem" device.

Configuration

To add devices to the alarm system, the configuration must be extended by adding a list of device ids to the attribute called "includes" of the alarm system device configuration. Example:

"devices": [
  {
    "id": "alarm_system",
    "name": "Alarm system",
    "class": "AlarmSystem",
    "includes": [
      "id_of_switch",
      "id_of_presenceSensor"
    ]
  }
]

Sponsoring

Do you like this plugin? Then consider a donation to support development.

PayPal donate button Flattr pimatic-alarm

Changelog

0.2.0

  • #3 moved list of included devices from plugin to alarm system device. It’s possible to have multiple alarm system devices now.

0.1.1

  • Use empty string as trigger for no alarm because trigger is shown in gui next to switch

0.1.0

  • #2 setting name of triggering device into variable
  • added alarm event

0.0.3

  • #1 switched from blacklist to whitelist

0.0.2

  • fixed version

0.0.1

  • Initial release