Skip to content

Jeedom plugin allows connecting Snips voice assistant with Jeedom platform.

License

Notifications You must be signed in to change notification settings

shadsnob/snips-jeedom-plugin

 
 

Repository files navigation

MIT License Version

snips-jeedom-plugin

This is the official Snips plugin designed for Jeedom home automation platform.

This plugin comes with an user-friendly visual interface, which allows Jeedom user to bind their connected device action with Snips voice assistant.

User Guide

Please reach Snips Dev Center for the user documentation.

Installation

From Jeedom Plugin Market

Manual Installation

Step 1

Clone this repository onto your target device holding Jeedom platform:

git clone https://github.com/snipsco/snips-jeedom-plugin.git

Step 2

Move plugin to Jeedom plugin directory:

sudo mv snips-jeedom-plugin/ /var/www/html/plugins/snips/

Step 3

Change permission to 775:

sudo chmod -R 775 /var/www/html/plugins/snips/

Change user group to www-data:

sudo chgrp -R www-data /var/www/html/plugins/snips/

Change ownership to www-data:

sudo chown -R www-data /var/www/html/plugins/snips/

Step 4

Open Jeedom plugin management page, select snips. Then activate plugin and install dependancy.

Once the daemon is successfully launched, Snips plugin is ready to fly.

Setup Jeedom Developing Environment

Pré-requis

Docker need to be installed on your OS.

Note: setp 1-2 can be done by the script dev_script/docker_setup.sh

Step 1

Get the mariadb image at tag 10.1.37 (Not the latest):

docker pull mariadb:10.1.37

Create the local container for mysql:

sudo docker run \
    --name jeedom-mysql \
    -v ${SHELL_FOLDER}/../.docker/mysql:/var/lib/mysql \
    -e MYSQL_ROOT_PASSWORD=root \
    -d mariadb:10.1.37

--name: container name. -v: mount host volume to a container directory. -e: set environment variable (root password). -d: run the container as a daemon.

Step 2

Get the latest jeedom image:

docker pull jeedom/jeedom

Create the local container for jeedom:

sudo docker run \
    --name jeedom-server \
    --link jeedom-mysql:mysql \
    --privileged \
    -v ${SHELL_FOLDER}/../.docker/server:/var/www/html \
    -e ROOT_PASSWORD=root \
    -p 9080:80 \
    -p 9022:22 jeedom/jeedom

--name: container name. --link: link to jeedom database container. --privileged: assign real root permission to root user. -v: mount a host directory to a container directory. -e: set environment variable (root password). -p: map host port to a contain port.

Step 3

Access localhost:9080 to install.

DB Parameters Value
host See comment [1]
port 3306
user root
pass root
name jeedom

[1]

To get the database ip address, looking into the MariaDB container

docker exec -it jeedom-mysql /bin/bash

Check the hosts binding

more /etc/hosts

Working Mechanism

Contributing

Please see the Contribution Guidelines.

Copyright

This library is provided by Snips as Open Source software. See LICENSE for more information.

About

Jeedom plugin allows connecting Snips voice assistant with Jeedom platform.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 61.5%
  • JavaScript 32.6%
  • Shell 5.3%
  • CSS 0.6%