Giter Club home page Giter Club logo

pimatic-alarm's Introduction

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 switches on 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 "AlarmSwitch" can be used to manually trigger an alarm and the "AlarmSystem" is used to activate the alarm system.

Usage:

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

Note that you need at least the "AlarmSystem" device, because the default state of the alarm system is "off".

Configuration

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

"plugins": [
  {
    "plugin": "alarm",
    "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.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

pimatic-alarm's People

Contributors

michbeck100 avatar bstrebel avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.