Ewe-Tasker Documentation Release 2.0
Total Page:16
File Type:pdf, Size:1020Kb
ewe-tasker Documentation Release 2.0 gsi-upm Apr 27, 2018 Learn more about Ewetasker: 1 What is Ewetasker? 3 1.1 Ewetasker for users............................................3 2 Channels 5 2.1 List of channels..............................................5 3 Getting started 9 3.1 First glance into Ewetasker.......................................9 3.2 Tutorial I: Installation..........................................9 3.3 Tutorial II: Installing Ewetasker Android App.............................. 11 3.4 Tutorial III: Creating Rules....................................... 16 3.5 Tutorial IV: Connecting Channels.................................... 19 3.6 Tutorial V: Creating Components.................................... 21 3.7 Tutorial VI: Creating CMS Content................................... 23 3.8 Tutorial VII: Loading Videos to Chromecast.............................. 26 3.9 Tutorial VIII: Testing Created Rules................................... 28 3.10 Tutorials Advanced............................................ 31 4 API REST 35 4.1 To create a new rule........................................... 35 4.2 To get the channels available....................................... 35 4.3 To evaluate the rules created....................................... 36 5 Architecture 39 5.1 Modules................................................. 39 6 Ewetasker Demos 43 6.1 Emotion Aware.............................................. 43 6.2 Smart Robot Assistant for an Office................................... 43 6.3 Contextual and Semantic Content Management for Intelligent offices................. 43 6.4 Multievent and Multiaction Task Automation Platform......................... 43 i ii ewe-tasker Documentation, Release 2.0 Ewetasker is an emotion aware automation platform based on semantic ECA (Event-Condition-Action) rules. It is capable of enable semantic automation rules in a smart environment allowing the user to configure his own automation rules in an easy way. Learn more about Ewetasker: 1 ewe-tasker Documentation, Release 2.0 2 Learn more about Ewetasker: CHAPTER 1 What is Ewetasker? Nowadays we are surrounded by smart devices whose goal is to make our lives easier. However, the configuration and the adaptation of them to the users becomes a problem when the number of involved devices increase. For this reason, Ewetasker provides a task automation platform for controlling and configurating smart devices. 1.1 Ewetasker for users Ewetasker web application provides an easy way to automate tasks in smart environments. Through its interface its is possible to parameterize the features of a smart device by creating channels following the EWE ontology. Channels define devices which can generate Events (sensors), provide Actions (actuators) or both. Once having the channels, Ewetasker allows users to create automation rules. This rules are defined as an “Event-Condition-Action” (ECA) rules. When they are triggered by an event, Ewetasker generates a response with the corresponding Action. To make the most out of Ewetasker, its neccesary to install the Ewetasker Android App. It allows to manage events and actions of channels like Bluetooth, WiFi or Presence. This smartphone application is available in Google Play store. 3 ewe-tasker Documentation, Release 2.0 In this documentation we are going to introduce this framework, detailing the global architecture of the project and explaining each module functionality. Finally, we will make a tutorial to know its working and its functions since the installation until using it. A demo video about Ewetasker is available here. 4 Chapter 1. What is Ewetasker? CHAPTER 2 Channels In this part we are going to see the list of channels developed to control events and perform actions in a smart place. Some channels must be activated before use them, in these cases, go to Tutorials section. 2.1 List of channels 2.1.1 Device Audio It represents the audio volume in a smartphone and works as an actuator. To use this channel it is necessary to install the Ewetasker Android app. Actions: Silence, Vibration, Normal. 2.1.2 Bluetooth It represents the bluetooth connection in a smartphone and works as a sensor. To use this channel it is necessary to install the Ewetasker Android app. Events: Turn On, Turn Off. 2.1.3 Calendar It represents the smartphone Calendar application and works as a sensor. To use this channel it is necessary to install the Ewetasker Android app. Using the app, it can read the events noted in Google Calendar app and throw an event when the appointment starts. Events: Event Start. 2.1.4 Chromecast It represents a Google Chromecast device and works as an actuator. To use this channel it is necessary to install the Ewetasker Proxy Server. It can reproduce videos on a smart tv connected to the Chromecast device. It is necessary to upload videos before reproduce them following the Tutorial steps. Actions: Welcome, Play Video.mobile or to call someone. 5 ewe-tasker Documentation, Release 2.0 2.1.5 CMS It represents the custom Content Management System and works as an actuator. To use this channel and reproduce the content, it is necessary to install the Ewetasker Android app. It can reproduce content generated using EwetaskerCMS web application. To learn how to create CMS content, please follow the Tutorial steps. Actions: Show. 2.1.6 Door It represents a connected door lock able to unlock the door, so it works as an actuator. To use this channel it is necessary to install the Ewetasker Android app. Actions: Open Door. 2.1.7 Empatica It represents a smart band able to extract emotions and stress level through the captured biometric data, so it works as a sensor. To use this channel it is necessary to install the Ewetasker Android app. Events: Eda High Level, Eda Low Level, Temperature High Level, Temperature Low Level, Bvp High Level, Bvp Low Level. 2.1.8 Hue Light It represents a Philips Hue smart light and it works as an actuator. It allows to switch on and off the light and set the bulb brightness.To use this channel it is necessary to install the Ewetasker Proxy Server and add plugs in Components page before use it. Actions: Turn On, Turn Off, Set Brightness. 2.1.9 Led Strip It represents a led strip and it works as an actuator. It allows to switch on and off the led strip and set the led brightness and the RGB color. It allows to switch on and off the light and set the bulb brightness.To use this channel it is necessary to install the Ewetasker Proxy Server. Actions: Switch On, Switch Off, Set Led Brightness, Set RGB. 2.1.10 Notification It represents a smartphone notification and works as an actuator. It allows to show a message in the smartphone navbar. To use this channel it is necessary to install the Ewetasker Android app. Actions: Show. 2.1.11 Plug It represents a Tp-link Smart Wifi Plug and it works as an actuator. It allows to switch on and off the smart plug. To use this channel it is necessary to install the Ewetasker Proxy Server and add plugs in Components page before use it. Actions: Turn On, Turn Off. 2.1.12 Presence Sensor It represents a presence sensor. It uses Estimote Beacons and Stickers to know user position in a smart place. To use this channel it is necessary to install the Ewetasker Android app and add beacons in Components page before use it. Events: Presence Detected At Distance Less Than, Presence Not Detected In Time, Presence Detected At Distance Greater Than. 6 Chapter 2. Channels ewe-tasker Documentation, Release 2.0 2.1.13 Robot MiP It represents a robot MiP and works as an actuator. It allows to control the moments and sounds of a Woowee MiP Robot. To use this channel it is necessary to install the Ewetasker Proxy Server. Actions: Action. 2.1.14 Telegram It represents a Telegram chat bot and it can work as an actuator and as a sensor. It allows to control some features of Ewetasker Web application and to send and to receive messages from Ewetasker. To use this channel it is necessary to install the Telegram Android app and follow the Tutorial steps. Actions: Send Message. Events: Event Command. 2.1.15 Toast Notification It represents an android toast notification and works as an actuator. It allows to show a message in the smartphone. To use this channel it is necessary to install the Ewetasker Android app. Actions: Show. 2.1.16TV It represents a Smart TV and works as an actuator. It allows to control the TV state. Actions: Turn ON, Turn STANDBY, Turn OFF. 2.1.17 Twitter It represents Twitter social network and works as an actuator. It allows to post a tweet with our Twitter account. To use this channel it is necessary to conect Ewetasker with Twitter folowing the Tutorial. Actions: Post Tweet. 2.1.18 WiFi It represents the smartphone WiFi module and it can work as an actuator and as a sensor. To use this channel it is necessary to install the Ewetasker Android app. Events: Turn ON, Turn OFF. Actions: Turn ON, Turn OFF. 2.1. List of channels 7 ewe-tasker Documentation, Release 2.0 8 Chapter 2. Channels CHAPTER 3 Getting started 3.1 First glance into Ewetasker The quickest way of exploring the possibilities offered by Ewetasker is accessing this demo. There you can discover the channels designed for your smart devices, how to create rules to control their functions and test their working in real time. Some channels have been developed to control a few common smart devices like smart TV, smart lights, or presence sensors. 3.2 Tutorial I: Installation Ewetasker installation is based in docker containers, so it is required to have docker installed. For docker installation in Ubuntu, visit this link. First of all, you need to clone the repositories: $ git clone http://lab.cluster.gsi.dit.upm.es/ewetasker/ewetasker.git ewe-tasker $ cd ewe-tasker Then, you have the option of setting up the environment variables following the advanced tutorial but it is not necessary to use the application.