Pigeon Agents Development System Requirements - DatasmithSA/Pigeon-Voice-Training GitHub Wiki
In order to get started with developing Pigeon Voice Agents, you will need the following prerequisites:
- Software Development: for simply coding the agents, you will need the following components:
- Windows PC: meeting the minimum system requirements for one of the above chosen versions of Microsoft Visual Studio:
- Microsoft Visual Studio 2017 System Requirements: https://docs.microsoft.com/en-us/visualstudio/productinfo/vs2017-system-requirements-vs:
- Operating System:
- Windows 10 version 1507 or higher: Home, Professional, Education, and Enterprise (LTSB and S are not supported)
- Windows Server 2016: Standard and Datacenter
- Windows 8.1 (with Update 2919355): Core, Professional, and Enterprise
- Windows Server 2012 R2 (with Update 2919355): Essentials, Standard, Datacenter
- Windows 7 SP1 (with latest Windows Updates): Home Premium, Professional, Enterprise, Ultimate
- Hardware Requirements:
- 1.8 GHz or faster processor. Dual-core or better recommended
- 2 GB of RAM; 4 GB of RAM recommended (2.5 GB minimum if running on a virtual machine)
- Hard disk space: up to 130 GB of available space, depending on features installed; typical installations require 20-50 GB of free space.
- Hard disk speed: to improve performance, install Windows and Visual Studio on a solid state drive (SSD).
- Video card that supports a minimum display resolution of 720p (1280 by 720); Visual Studio will work best at a resolution of WXGA (1366 by 768) or higher.
- Operating System:
- Microsoft Visual Studio 2017 System Requirements: https://docs.microsoft.com/en-us/visualstudio/productinfo/vs2017-system-requirements-vs:
- Microsoft SQL Server 2008, 2012 or 2014 (or better):
- Microsoft .NET Framework 4.5: which is required to install Visual Studio 2017
- Microsoft Visual Studio: that supports development with the .NET Framework 4.5:
- Visual Studio 2017 (recommended): https://www.visualstudio.com/vs/
- Visual Studio 2012, 2013 or 2015: https://www.visualstudio.com/vs/older-downloads/
- Pigeon Voice Server: Contact Datasmith for the latest version of Pigeon Voice Server.
- Pigeon Voice Database: a backup of the Pigeon Voice Server's database will be provided with the installer from Datasmith: PigeonVoice.bak. N.B. when requesting the database from the Datasmith, please request for a backup compatible with your version of Microsoft SQL Server e.g. 2008/2012 Express/Standard/Enterprise.
- Pigeon Voice SDK: can be copied/referenced from the Pigeon Voice Server's installation folder: "C:\Program Files (x86)\Datasmith\Pigeon Voice Server". You will need the following assemblies to be referenced in your project:
- Pigeon.Voice.SDK.dll
- Pigeon.Voice.SDK.WinForms.Base.dll
- Figlut Server Toolkit: an open-source toolkit used by the Pigeon Voice SDK, which can also be downloaded from the Github project https://github.com/PaulKolozsvari/Figlut-Suite or can be copied/referenced from the Pigeon Voice Server's installation folder. You will reference the the following DLL in your agent's project:
- Figlut.Server.Toolkit45.dll
- Figlut Server Toolkit Dependencies: the following dependent assemblies will need to be present in the same the same directory as the Figlut.Server.Toolkit45.dll in order for this toolkit to be run correctly.
- antlr.runtime.dll
- DotRas.dll
- Ical.Net.Collections.dll
- Ical.Net.dll
- Newtonsoft.Json.dll (version 8.0.3.19514)
- NodaTime.dll
- Renci.SshNet.dll
- Additional Requirements:
- Administrator rights are required to run the Pigeon Voice Server as a console application.
- Windows PC: meeting the minimum system requirements for one of the above chosen versions of Microsoft Visual Studio:
- Test/Debugging: for testing the debugging the Pigeon Voice Agents.
- Vocollect Voice Console: if you are a certified Vocollect partner, contact Vocollect for a copy of the latest Voice Console or alternatively, Contact Datasmmith or another certified Vocollect certified partner to:
- Install and configure the Voice Console for you.
- Provide you with a Voice Console trial license.
- Task/Voice Application: which will be the device voice application that you are aiming to integrate into a backend system (e.g. WMS). This could be Vocollect's Voice Direct Task/Voice Application or a custom Task/Voice Application developed by a Vocollect certified voice partner. Should the Task/Voice Application not be ready yet, you can still develop the Voice agents based a predefined technical specification as agreed upon between you and Vocollect certified partner. Once your agents have been developed, you can then request for the Task/Voice Application in order to perform integration testing.
- Vocollect Voice engine: the voice engine compatible to run the Task/Voice Application i.e. Vocollect Voice Client or Voice Catalyst.
- Vocollect Voice Device: a device compatible with the chosen Vocollect Voice engine.
- Network Requirements:
- WiFi Router providing 802.11 wireless connectivity between the voice device and your development PC.
- Ports: the following ports need to be opened on your network and on development PC. (N.B. the Pigeon Voice Server's default ports can be changed using the Pigeon Voice Manager)
- 80 (incoming): HTTP REST Service Port
- 15008 (incoming): TCP/IP LUT Port
- 15009 (incoming): TCP/IP ODR Port
- SMTP Ports:
- 21 (outgoing): Exchange SMTP Server Port (if using Microsoft Exchange for emails notifications)
- 587 (outgoing): GMail SMTP Server Port (if using GMail for GMail notifications)
- Vocollect Voice Console: if you are a certified Vocollect partner, contact Vocollect for a copy of the latest Voice Console or alternatively, Contact Datasmmith or another certified Vocollect certified partner to: