Pigeon Agents Development Environment Setup - DatasmithSA/Pigeon-Voice-Training GitHub Wiki
After acquiring all the prerequisites mentioned under Development System Requirements, you will need to start installing and setting up the development environment. After acquiring and setting up a development PC with Windows, install and configure the rest of the components:
- WiFi:
- Setup a WiFi router, taking into account the SSID, wireless key, encryption etc.
- Connect your development machine to the Wiresless network provided by your WiFi router.
- Ports: open the following ports on your development machine's Windows Firewall and any other firewall present between your development machine and devices:
- 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)
- Database Setup:
- Install Microsoft SQL Server
- Restore the PigeonVoice.bak database onto Microsoft SQL Server, using Microsoft SQL Server Management Studio.
- Create a Login on Microsoft SQL Server that will grant the Pigeon Voice Server access to the database.
- Pigeon Voice Server:
- Installation: follow the steps as outlined in the Installation procedure to install the Pigeon Voice Server.
- Configuration: follow the steps as outlined in the Configuration procedure to configure at the very least the connection string to the database.
- Visual Studio: install your preferred version of Microsoft Visual Studio that is compatible with development targeting the .NET Framework 4.5. You maybe required to install the .NET Framework 4.5 prior to installing Visual Studio 2017.
- Voice Console: will need to be installed either by yourself if you are a certified Vocollect partner, or alternatively by a a Vocollect certified partner.
- Voice Console database: Create an empty database on Microsoft SQL Server that will be used by Voice Console.
- Install Voice Console: Run the Voice Console installer, pointing it to its SQL Server database created in the previous step.
- Configure Voice Console:
- Voice Engine: Import Voice Client or Voice Catalyst that will be installed on the voice devices, which will also be executing the Task or Voice Application.
- Operator: Create an Operator which you will load and use on the voice device.
- Task/Voice Application: import the Task or Voice Application that has been provided to you by either Vocollect (in case of Voice Direct) or the custom one developed by you/your Vocollect certified partner.
- Task Package: create a Task Package for the Task/Voice Application which will provide the configuration.
- Host: set the hostname or IP address of the Pigeon Voice Server on the Task Package. The Task/Voice Application will be connecting to this IP address when connecting to the Pigeon Voice Server.
- LUTHost: hostname or IP address of the Pigeon Voice Server that is listening for LUT message requests.
- ODRHost: hostname or IP address of the Pigeon Voice Server that is listening for ODR message requests.
- Ports: set the Pigeon Voice Server's ports on the Task Package for the Task/Voice Application to connect to:
- LUTPort: port of the Pigeon Voice Server on which it is listening to for LUT message requests.
- ODRPort: port of the Pigeon Voice Server on which it is listening to for ODR message requests. /images/voice-console/Voice-Console-Task-Package.png
- Device Profile: create a Device Profile by entering the WiFi router connection details i.e. SSID, wireless key, encryption type etc.
- Voice Console IP Address/Hostname: set Voice Console's global IP address or hostname that the devices will be connecting to when connecting to Voice Console. /images/voice-console/Voice-Console-Edit-Hostname-For-All-Devices.png
- Load Device Profile: load the device profile to a Vocollect Voice device using the serial or USB cable.
- Wait for the device to reboot and ensure it is connected to the wireless network and Voice Console.
- Load the Operator and Task Package on the device. This will serve as confirmation that the device has authenticated to the Wireless network and can connect to Voice Console running on your development PC.