Giter Club home page Giter Club logo

pimatic-xmpp's Introduction

pimatic-xmpp

beta stadium !

This plugin provides an xmpp aka jabber messaging system for pimatic. ####Features

  • Send messages to users
  • Reveive commands from users

###Service dependencies

The plugin needs a valid user account on any xmpp service.

  • You can use a public jabber/xmpp service
  • or install a local service on your pimatic server like ejabberd

For the raspberry pi there are several guides to install an ejabberd service.

###Installation

package manager:

cd ./pimatic-xmpp
npm install pimatic-xmpp 

manually: Extract the plugin content in your pimatic plugin directory:

cd <PATH-TO-PIMATIC>/node_modules/
git clone https://github.com/treban/pimatic-xmpp.git

This plugin depends on node-xmpp-client.

After cloning the git repository change in to the plugin directory and install the xmpp-client over the npm package manager.

cd ./pimatic-xmpp
npm install node-xmpp-client 

###Configuration

You can load the plugin by adding following in the config.json from your pimatic server:

{
  "plugin": "xmpp",
  "user": "[email protected]",
  "password": "secretpw",
  "adminId": "[email protected]",
  "defaultId": "[email protected]",
  "keepaliveInterval": 5
}

The config item adminId is the access controle for receiving messages.

Only messages from this user will be accepted.

###Usages ####Provided predicates The messaging system provides a received event.

received "do action" 

####Provided actions The messaging system provides a send event.

send chat tojid:"[email protected]" message:"triggerd event has occurred"

####Chat client

The messaging system implements a chat bot which answers questions. Following commands are predefiend:

Built-in commands:

  • help

Available events:

  • "created predicates"

###ToDoList

  • list devices
  • possibility to interact with devices

pimatic-xmpp's People

Contributors

treban avatar

Watchers

James Cloos avatar Marcus Wittig 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.