Add Windows support (#258)

* more info on the Wiki (to be added later)

Author: EmerickH

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ## [Unreleased]
 
+### Added
+- Windows support
+
 ### Changed
 - Switched from pyalsaaudio (ALSA) to pyaudio (PortAudio)
     - You might have to change the `input_device` in your config, but this name will stay forever (we are not planning any change).

README.md

@@ -1,6 +1,6 @@
 # AlexaPi (the new & awesome version) [![Gitter chat](https://badges.gitter.im/alexa-pi/Lobby.png)](https://gitter.im/alexa-pi/Lobby)
 
-This is a client for Amazon's Alexa service. It is intended and tested to run on a wide range of platforms, such as Raspberry Pi, Orange Pi, CHIP and ordinary Linux desktops.
+This is a client for Amazon's Alexa service. It is intended and tested to run on a wide range of platforms, such as Raspberry Pi, Orange Pi, CHIP and ordinary Linux or Windows desktops.
 
 ### Do you want to help out? Read the [Contribution Guide](CONTRIBUTING.md).
 
@@ -10,16 +10,16 @@ This is a client for Amazon's Alexa service. It is intended and tested to run on
 
 You will need:
 
-1. **A Linux box**
+1. **A Linux or Windows box**
     - a Raspberry Pi and an SD Card with a fresh install of Raspbian
     - or an Orange Pi with Armbian
-    - or pretty much any up-to-date Linux system
+    - or pretty much any up-to-date Linux/Windows system
 2. **Audio peripherals**
     - external speaker with 3.5mm Jack
     - USB Sound Dongle and microphone
-3. Other
-    - (optional) (Raspberry Pi) a push button connected between GPIO 18 and GND (configurable)
-    - (optional) (Raspberry Pi) a dual colour LED (or 2 single LEDs) connected to GPIO 24 & 25 (configurable)
+3. **Optional (only for Raspberry Pi)**
+    - a push button connected between GPIO 18 and GND (configurable)
+    - a dual colour LED (or 2 single LEDs) connected between GPIO 24 & 25 and GND (configurable)
 
 ## You wanna give it a try? Check out the [Installation Guide](https://github.com/alexa-pi/AlexaPi/wiki/Installation).
 

src/alexapi/playback_handlers/vlchandler.py

@@ -1,5 +1,6 @@
 import threading
 import logging
+import platform
 import vlc
 from .basehandler import BaseHandler, PlaybackAudioType
 
@@ -35,26 +36,31 @@ def on_setup(self):
 
 		parametersSpeech = parametersCommon
 
-		if self.__config['sound']['output']:
-			parametersSpeech.append('--aout=' + self.__config['sound']['output'])
+		if not platform.system() == 'Windows':
 
-			if self.__config['sound']['output_device']:
-				parametersSpeech.append('--alsa-audio-device=' + self.__config['sound']['output_device'])
+			if self.__config['sound']['output']:
+				parametersSpeech.append('--aout=' + self.__config['sound']['output'])
+
+				if self.__config['sound']['output_device']:
+					parametersSpeech.append('--alsa-audio-device=' + self.__config['sound']['output_device'])
 
 		self.vlc_instance = vlc.Instance(*parametersSpeech)
 		self.player = self.vlc_instance.media_player_new()
 
 		self.media_vlc_instance = self.vlc_instance
 		self.media_player = self.player
-		if self.__config['sound']['media_output']:
-			parametersMedia = parametersCommon
-			parametersMedia.append('--aout=' + self.__config['sound']['media_output'])
 
-			if self.__config['sound']['media_output_device']:
-				parametersMedia.append('--alsa-audio-device=' + self.__config['sound']['media_output_device'])
+		if not platform.system() == 'Windows':
+
+			if self.__config['sound']['media_output']:
+				parametersMedia = parametersCommon
+				parametersMedia.append('--aout=' + self.__config['sound']['media_output'])
 
-			self.media_vlc_instance = vlc.Instance(*parametersMedia)
-			self.media_player = self.media_vlc_instance.media_player_new()
+				if self.__config['sound']['media_output_device']:
+					parametersMedia.append('--alsa-audio-device=' + self.__config['sound']['media_output_device'])
+
+				self.media_vlc_instance = vlc.Instance(*parametersMedia)
+				self.media_player = self.media_vlc_instance.media_player_new()
 
 		if self.__config['sound']['default_volume']:
 			self.volume = self.__config['sound']['default_volume']
@@ -69,7 +75,11 @@ def on_play(self, item):
 			vlcInstance = self.media_vlc_instance
 			player = self.media_player
 
-		media = vlcInstance.media_new(item.url)
+		url = item.url
+		if platform.system() == 'Windows':
+			url = item.url.replace("file://", "")
+
+		media = vlcInstance.media_new(url)
 		player.set_media(media)
 
 		volume = self.volume

src/alexapi/triggers/pocketsphinxtrigger.py

@@ -1,6 +1,7 @@
 import os
 import threading
 import logging
+import platform
 
 from pocketsphinx import get_model_path
 from pocketsphinx.pocketsphinx import Decoder
@@ -43,7 +44,12 @@ def setup(self):
 
 		# Hide the VERY verbose logging information when not in debug
 		if logging.getLogger('alexapi').getEffectiveLevel() != logging.DEBUG:
-			ps_config.set_string('-logfn', '/dev/null')
+
+			null_path = '/dev/null'
+			if platform.system() == 'Windows':
+				null_path = 'nul'
+
+			ps_config.set_string('-logfn', null_path)
 
 		# Process audio chunk by chunk. On keyword detected perform action and restart search
 		self._decoder = Decoder(ps_config)

src/auth_web.py

@@ -83,5 +83,5 @@ def code(self, var=None, **params):		# pylint: disable=unused-argument
 
 ip = [(s.connect(('8.8.8.8', 53)), s.getsockname()[0], s.close()) for s in [socket.socket(socket.AF_INET, socket.SOCK_DGRAM)]][0][1]
 print("Ready goto http://{}:5050 or http://localhost:5050  to begin the auth process".format(ip))
-print("(Press Ctrl-C to exit this script once authorization is complete)")
+print("(Press Ctrl-C (or close this window on Windows) to exit this script once authorization is complete)")
 cherrypy.quickstart(Start())

src/debug.bat

@@ -0,0 +1,7 @@
+echo off
+title AlexaPi for Windows
+cls
+
+python main.py -d
+
+pause

src/requirements.txt

@@ -1,6 +1,6 @@
 requests>=2.13.0
 CherryPy>=10.1.1
-git+https://github.com/oaubert/python-vlc.git#egg=python-vlc
+python-vlc
 pyaudio>=0.2.10
 webrtcvad>=2.0.10
 pyyaml

src/scripts/setup.bat

@@ -0,0 +1,42 @@
+echo off
+title AlexaPi for Windows Installation
+cls
+
+SET mypath=%~dp0
+SET apath=%mypath:~0,-8%
+SET path=%path%;%mypath%\swigwin-AlexaPi
+
+echo -------------------------------------------
+echo Welcome in AlexaPi installation for Windows
+echo -------------------------------------------
+
+echo Installing dependencies:
+
+python -m pip install -r "%apath%requirements.txt"
+
+pause
+cls
+
+cd %apath%
+
+copy config.template.yaml config.yaml
+
+echo ######################################################################################################
+echo IMPORTANT NOTICE:
+echo You HAVE TO set up Amazon keys in the config.yaml file now
+echo ######################################################################################################
+pause
+
+start python.exe auth_web.py
+
+echo =====
+echo Done!
+echo =====
+pause
+cls
+echo ######################################################################################################
+echo IMPORTANT NOTICE:
+echo You may HAVE TO set up your system audio.
+echo See on our wiki
+echo ######################################################################################################
+pause

src/start.bat

@@ -0,0 +1,7 @@
+echo off
+title AlexaPi for Windows
+cls
+
+python main.py
+
+pause