Refactored VSHL into vshl-core and vshl-capabilities.

vshl-core: This API is responsible for request arbitration. Verbs exposed are

1. startListening
2. cancelListening
3. subscribe
4. enumerateVoiceAgents
5. setDefaultVoiceAgent Used by applications to subscribe to dialog, connection and auth states of underlying low level voiceagent bindings. Used by applications to trigger voice recognition routine of the underlying low level voiceagent binding.

vshl-capabilities: This API exposes publish and subscribe methods for all the speech framework domains/capabilities. For eg. navigation, phonecontrol etc. This API is used by apps and low level voice agent binding to subscribe and publish these capability messages whenever applicable. The code for this is agl-service-voice-high-capabilities repository.

This specific commit is for vshl-core API.

Change-Id: I1101db19b57ee918482a178843641b088508ac5d
Signed-off-by: Naveen Bobbili  <nbobbili@amazon.com>

7 files changed, 82 insertions, 251 deletions

diff --git a/conf.d/autobuild/agl/autobuild b/conf.d/autobuild/agl/autobuild
deleted file mode 100755
index 83097ab..0000000
--- a/conf.d/autobuild/agl/autobuild
+++ /dev/null
@@ -1,67 +0,0 @@
-#!/usr/bin/make -f
-# Copyright (C) 2015, 2016 "IoT.bzh"
-# Author "Romain Forlot" <romain.forlot@iot.bzh>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#	 http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-THISFILE  := $(lastword $(MAKEFILE_LIST))
-BUILD_DIR := $(abspath $(dir $(THISFILE)/../../../../..)/build)
-DEST      := ${BUILD_DIR}/target
-
-.PHONY: all clean distclean configure build package help update
-
-all: help
-
-help:
-	@echo "List of targets available:"
-	@echo ""
-	@echo "- all"
-	@echo "- clean"
-	@echo "- distclean"
-	@echo "- configure"
-	@echo "- build: compilation, link and prepare files for package into a widget"
-	@echo "- package: output a widget file '*.wgt'"
-	@echo "- install: install in your ${CMAKE_INSTALL_DIR} directory"
-	@echo ""
-	@echo "Usage: ./conf.d/autobuild/agl/autobuild package DEST=${HOME}/opt"
-	@echo "Don't use your build dir as DEST as wgt file is generated at this location"
-
-update: configure
-	@cmake --build ${BUILD_DIR} --target autobuild
-
-clean:
-	@([ -d ${BUILD_DIR} ] && make -C ${BUILD_DIR} clean) || echo Nothing to clean
-
-distclean:
-	@rm -rf ${BUILD_DIR}
-
-configure: ${BUILD_DIR}/Makefile
-
-build: configure
-	@cmake --build ${BUILD_DIR} ${BUILD_ARGS} --target all
-
-package: build
-	@mkdir -p ${BUILD_DIR}/$@/bin
-	@mkdir -p ${BUILD_DIR}/$@/etc
-	@mkdir -p ${BUILD_DIR}/$@/lib
-	@mkdir -p ${BUILD_DIR}/$@/htdocs
-	@mkdir -p ${BUILD_DIR}/$@/var
-	@cmake --build ${BUILD_DIR} --target widget
-	@mkdir -p ${DEST} && cp ${BUILD_DIR}/*wgt ${DEST}
-
-install: build
-	@cmake --build ${BUILD_DIR} --target install
-
-${BUILD_DIR}/Makefile:
-	@[ -d ${BUILD_DIR} ] || mkdir -p ${BUILD_DIR}
-	@[ -f ${BUILD_DIR}/Makefile ] || (cd ${BUILD_DIR} && cmake ${CONFIGURE_ARGS} ..)
diff --git a/conf.d/autobuild/linux/autobuild b/conf.d/autobuild/linux/autobuild
deleted file mode 100755
index 83097ab..0000000
--- a/conf.d/autobuild/linux/autobuild
+++ /dev/null
@@ -1,67 +0,0 @@
-#!/usr/bin/make -f
-# Copyright (C) 2015, 2016 "IoT.bzh"
-# Author "Romain Forlot" <romain.forlot@iot.bzh>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#	 http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-THISFILE  := $(lastword $(MAKEFILE_LIST))
-BUILD_DIR := $(abspath $(dir $(THISFILE)/../../../../..)/build)
-DEST      := ${BUILD_DIR}/target
-
-.PHONY: all clean distclean configure build package help update
-
-all: help
-
-help:
-	@echo "List of targets available:"
-	@echo ""
-	@echo "- all"
-	@echo "- clean"
-	@echo "- distclean"
-	@echo "- configure"
-	@echo "- build: compilation, link and prepare files for package into a widget"
-	@echo "- package: output a widget file '*.wgt'"
-	@echo "- install: install in your ${CMAKE_INSTALL_DIR} directory"
-	@echo ""
-	@echo "Usage: ./conf.d/autobuild/agl/autobuild package DEST=${HOME}/opt"
-	@echo "Don't use your build dir as DEST as wgt file is generated at this location"
-
-update: configure
-	@cmake --build ${BUILD_DIR} --target autobuild
-
-clean:
-	@([ -d ${BUILD_DIR} ] && make -C ${BUILD_DIR} clean) || echo Nothing to clean
-
-distclean:
-	@rm -rf ${BUILD_DIR}
-
-configure: ${BUILD_DIR}/Makefile
-
-build: configure
-	@cmake --build ${BUILD_DIR} ${BUILD_ARGS} --target all
-
-package: build
-	@mkdir -p ${BUILD_DIR}/$@/bin
-	@mkdir -p ${BUILD_DIR}/$@/etc
-	@mkdir -p ${BUILD_DIR}/$@/lib
-	@mkdir -p ${BUILD_DIR}/$@/htdocs
-	@mkdir -p ${BUILD_DIR}/$@/var
-	@cmake --build ${BUILD_DIR} --target widget
-	@mkdir -p ${DEST} && cp ${BUILD_DIR}/*wgt ${DEST}
-
-install: build
-	@cmake --build ${BUILD_DIR} --target install
-
-${BUILD_DIR}/Makefile:
-	@[ -d ${BUILD_DIR} ] || mkdir -p ${BUILD_DIR}
-	@[ -f ${BUILD_DIR}/Makefile ] || (cd ${BUILD_DIR} && cmake ${CONFIGURE_ARGS} ..)
diff --git a/conf.d/cmake/config.cmake b/conf.d/cmake/config.cmake
index 4e1a631..d932fd1 100644
--- a/conf.d/cmake/config.cmake
+++ b/conf.d/cmake/config.cmake
@@ -18,10 +18,10 @@
 
 # Project Info
 # ------------------
-set(PROJECT_NAME vshl)
+set(PROJECT_NAME vshl-core)
 set(PROJECT_VERSION "1.0")
-set(PROJECT_PRETTY_NAME "High Level Voice Service APIs")
-set(PROJECT_DESCRIPTION "Binding that provide voice services to AGL apps.")
+set(PROJECT_PRETTY_NAME "High Level Voice Service Core APIs")
+set(PROJECT_DESCRIPTION "Binding that provides core voice service arbitration API to AGL apps.")
 set(PROJECT_ICON "icon.png")
 set(PROJECT_AUTHOR "Naveen Bobbili")
 set(PROJECT_AUTHOR_MAIL "nbobbili@amazon.com")
@@ -165,7 +165,7 @@ set(WIDGET_TYPE application/vnd.agl.service)
 # This is the file that will be executed, loaded,
 # at launch time by the application framework.
 #
-set(WIDGET_ENTRY_POINT lib/afb-vshl.so)
+set(WIDGET_ENTRY_POINT lib/afb-vshl-core.so)
 
 # Optional dependencies order
 # ---------------------------
diff --git a/conf.d/project/etc/CMakeLists.txt b/conf.d/project/etc/CMakeLists.txt
index 3aacae6..3635ed0 100644
--- a/conf.d/project/etc/CMakeLists.txt
+++ b/conf.d/project/etc/CMakeLists.txt
@@ -19,7 +19,7 @@
 ##################################################
 # Control Policy Config file
 ##################################################
-PROJECT_TARGET_ADD(vshl-api-config)
+PROJECT_TARGET_ADD(vshl-core-api-config)
 
 	file(GLOB CONF_FILES "*.json")
 
diff --git a/conf.d/project/etc/vshl-api.json b/conf.d/project/etc/vshl-api.json
deleted file mode 100644
index 3f92f76..0000000
--- a/conf.d/project/etc/vshl-api.json
+++ /dev/null
@@ -1,96 +0,0 @@
-{
-  "$schema": "http://iot.bzh/download/public/schema/json/ctl-schema.json",
-  "metadata": {
-    "uid": "vshl",
-    "version": "1.0",
-    "api": "vshl",
-    "info": "High Level Voice Service APIs"
-  },
-
-  "onload": [{
-    "uid": "loadVoiceAgentsConfig",
-    "info": "Loading the information about voice agents managed by the high level voice service.",
-    "action": "plugin://vshl#loadVoiceAgentsConfig",
-    "args": {
-      "default": "VA-001",
-      "agents": [
-        {
-          "id": "VA-001",
-          "active": true,
-          "name": "Alexa",
-          "api": "alexa-voiceagent",
-          "wakewords": [
-            "alexa",
-            "computer",
-            "echo"
-          ],
-          "activewakeword": "alexa",
-          "description": "Alexa voice assistant by Amazon.",
-          "vendor": "Amazon.com Services Inc"
-        }
-      ]
-    }
-  }],
-
-  "plugins": [{
-    "uid": "vshl",
-    "info": "Plugin to handle high level voice service interface implementation",
-    "libs": [
-      "vshl-api.ctlso"
-    ]
-  }],
-
-  "events": [{
-      "uid": "alexa-voiceagent/voice_authstate_event",
-      "action": "plugin://vshl#onAuthStateEvent"
-    },{
-      "uid": "alexa-voiceagent/voice_connectionstate_event",
-      "action": "plugin://vshl#onConnectionStateEvent"
-    },{
-      "uid": "alexa-voiceagent/voice_dialogstate_event",
-      "action": "plugin://vshl#onDialogStateEvent"
-  }],
-
-  "controls": [{
-      "uid": "startListening",
-      "action": "plugin://vshl#startListening"
-    }, {
-      "uid": "cancelListening",
-      "action": "plugin://vshl#cancelListening"
-    }, {
-      "uid": "subscribe",
-      "action": "plugin://vshl#subscribe"
-    }, {
-      "uid": "enumerateVoiceAgents",
-      "privileges": "urn:AGL:permission:vshl:voiceagents:public",
-      "action": "plugin://vshl#enumerateVoiceAgents"
-    }, {
-      "uid": "setDefaultVoiceAgent",
-      "privileges": "urn:AGL:permission:vshl:voiceagents:public",
-      "action": "plugin://vshl#setDefaultVoiceAgent"
-    }, {
-      "uid": "guiMetadata/publish",
-      "privileges": "urn:AGL:permission:vshl:guiMetadata:public",
-      "action": "plugin://vshl#guiMetadataPublish"
-    }, {
-      "uid": "guiMetadata/subscribe",
-      "privileges": "urn:AGL:permission:vshl:guiMetadata:public",
-      "action": "plugin://vshl#guiMetadataSubscribe"
-    }, {
-      "uid": "phonecontrol/publish",
-      "privileges": "urn:AGL:permission:vshl:phonecontrol:public",
-      "action": "plugin://vshl#phonecontrolPublish"
-    }, {
-      "uid": "phonecontrol/subscribe",
-      "privileges": "urn:AGL:permission:vshl:phonecontrol:public",
-      "action": "plugin://vshl#phonecontrolSubscribe"
-    }, {
-      "uid": "navigation/publish",
-      "privileges": "urn:AGL:permission:vshl:navigation:public",
-      "action": "plugin://vshl#navigationPublish"
-    }, {
-      "uid": "navigation/subscribe",
-      "privileges": "urn:AGL:permission:vshl:navigation:public",
-      "action": "plugin://vshl#navigationSubscribe"
-  }]
-}
\ No newline at end of file
diff --git a/conf.d/project/etc/vshl-core-api.json b/conf.d/project/etc/vshl-core-api.json
new file mode 100644
index 0000000..f370a32
--- /dev/null
+++ b/conf.d/project/etc/vshl-core-api.json
@@ -0,0 +1,72 @@
+{
+  "$schema": "http://iot.bzh/download/public/schema/json/ctl-schema.json",
+  "metadata": {
+    "uid": "vshl-core",
+    "version": "1.0",
+    "api": "vshl-core",
+    "info": "High Level Voice Service Core APIs"
+  },
+
+  "onload": [{
+    "uid": "loadVoiceAgentsConfig",
+    "info": "Loading the information about voice agents managed by the high level voice service.",
+    "action": "plugin://vshl-core#loadVoiceAgentsConfig",
+    "args": {
+      "default": "VA-001",
+      "agents": [
+        {
+          "id": "VA-001",
+          "active": true,
+          "name": "Alexa",
+          "api": "alexa-voiceagent",
+          "wakewords": [
+            "alexa",
+            "computer",
+            "echo"
+          ],
+          "activewakeword": "alexa",
+          "description": "Alexa voice assistant by Amazon.",
+          "vendor": "Amazon.com Services Inc"
+        }
+      ]
+    }
+  }],
+
+  "plugins": [{
+    "uid": "vshl-core",
+    "info": "Plugin to handle high level voice service core API implementation",
+    "libs": [
+      "vshl-core-api.ctlso"
+    ]
+  }],
+
+  "events": [{
+      "uid": "alexa-voiceagent/voice_authstate_event",
+      "action": "plugin://vshl-core#onAuthStateEvent"
+    },{
+      "uid": "alexa-voiceagent/voice_connectionstate_event",
+      "action": "plugin://vshl-core#onConnectionStateEvent"
+    },{
+      "uid": "alexa-voiceagent/voice_dialogstate_event",
+      "action": "plugin://vshl-core#onDialogStateEvent"
+  }],
+
+  "controls": [{
+      "uid": "startListening",
+      "action": "plugin://vshl-core#startListening"
+    }, {
+      "uid": "cancelListening",
+      "action": "plugin://vshl-core#cancelListening"
+    }, {
+      "uid": "subscribe",
+      "action": "plugin://vshl-core#subscribe"
+    }, {
+      "uid": "enumerateVoiceAgents",
+      "privileges": "urn:AGL:permission:vshl-core:voiceagents:public",
+      "action": "plugin://vshl-core#enumerateVoiceAgents"
+    }, {
+      "uid": "setDefaultVoiceAgent",
+      "privileges": "urn:AGL:permission:vshl-core:voiceagents:public",
+      "action": "plugin://vshl-core#setDefaultVoiceAgent"
+    }]
+}
\ No newline at end of file
diff --git a/conf.d/wgt/config.xml.in b/conf.d/wgt/config.xml.in
index 0378f37..6d0690c 100644
--- a/conf.d/wgt/config.xml.in
+++ b/conf.d/wgt/config.xml.in
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<widget xmlns="http://www.w3.org/ns/widgets" id="@PROJECT_NAME@" version="@PROJECT_VERSION@">
+<widget xmlns="http://www.w3.org/ns/widgets" id="@PROJECT_NAME@" version="0.1">
   <name>@PROJECT_NAME@</name>
   <icon src="@PROJECT_ICON@"/>
   <content src="@WIDGET_ENTRY_POINT@" type="@WIDGET_TYPE@"/>
@@ -7,7 +7,7 @@
   <author>@PROJECT_AUTHOR@ &lt;@PROJECT_AUTHOR_MAIL@&gt;</author>
   <license>@PROJECT_LICENSE@</license>
   <feature name="urn:AGL:widget:provided-api">
-    <param name="vshl" value="ws" />
+    <param name="vshl-core" value="ws" />
   </feature>
   <feature name="urn:AGL:widget:required-binding">
     <param name="@WIDGET_ENTRY_POINT@" value="local" />
@@ -15,19 +15,8 @@
   <feature name="urn:AGL:widget:required-api">
     <param name="alexa-voiceagent" value="ws" />
   </feature>
-
-  <!-- HTML UI FOR TESTING -->
-  <feature name="urn:AGL:widget:provided-unit">
-    <param name="#target" value="test-ui" />
-    <param name="description" value="HTML UI for testing VSHL service" />
-    <param name="content.src" value="index.html" />
-    <param name="content.type" value="text/html" />
-    <param name="icon.src" value="@PROJECT_ICON@" />
-  </feature>
-  <feature name="urn:AGL:widget:required-binding">
-    <param name="#target" value="test-ui" />
-    <param name="windowmanager" value="ws" />
-    <param name="homescreen" value="ws" />
-    <param name="vshl" value="ws" />
+  <feature name="urn:AGL:widget:required-permission">
+    <param name="urn:AGL:permission:afm:system:widget:start" value="required" />
+    <param name="urn:AGL:permission::public:hidden" value="required" />
   </feature>
 </widget>
\ No newline at end of file