The Device Observation Framework can also be installed without Docker as follows.
The Observation Framework must be installed on same machine as the Test Runner is deployed.
Test Runner is deployed as a service running inside a Docker container. The Observation Framework must be installed outside of Docker or Docker Desktop and run outside of the Docker from the windows command line. Make sure that the command line or PowerShell that is used for running OF is not inside the Docker or Docker Desktop.
There are a number of points in these instructions that will direct you to add the necessary path(s) to Windows System Variables under the PATH entry. You will need to add the Path(s) to the folder(s) that will contain the WAVE Test Suite files you will create, Python, Docker Desktop, ZBar and any others as noted in these instructions. This is so the system knows where to find them. There may be additional Paths necessary. When a command returns an error such as “file not found” check to see if the Path is in the Environment System Variables under “PATH”. If not, add the missing Path. To add to or modify the System Environment Variables.
- Follow the instructions in the various ReadMe files for Windows, not Unix/Linux or Mac OS X.
- Run all commands using Windows Terminal/PowerShell. Do not run them using Bash in a Linux terminal.
- If a command in Windows PowerShell/Terminal stalls or hangs up, use <Control + C> to gracefully exit.
- Search for “Edit System Environmental Variables” in the search bar. Click on it in the popup.
- Select “Environment Variables”
- Under “System variables” (lower box), select “Path”
- Then select Edit
- Select “New” and enter the desired Path.
- Select “New” again for each new path you wish to add.
- When done, close the Environment Variables screens AND the Windows PowerShell/Terminal, if you have it open, to ensure the Paths are updated.
The Observation Framework requires the 'zbar' bar code reader library to be installed. On Linux this will require a user with 'sudo' privilege, and on Windows with Administrator privilege.
For Windows download and run the Windows installer from:
https://sourceforge.net/projects/zbar/files/zbar/0.10/zbar-0.10-setup.exe/download
After installation of zbar, add the PATH to the system environment variables. Also install ffmpeg and add the PATH to the system environment variables. For adding PATH to the system environment variables see above "Updating System Environment for Windows".
For Mac OS X:
brew install zbar
brew install netcat
brew install ffmpeg
brew install portaudio
For Unix exact installations may vary for different Unix variants, see http://zbar.sourceforge.net/.
For Linux a typical installation is:
sudo apt-get install libzbar0
sudo apt-get install netcat
sudo apt-get install ffmpeg
sudo apt-get install portaudio19-dev python3-pyaudio
Clone this GitHub (i.e. https://github.com/cta-wave/device-observation-framework) to the same machine/VM as the Test Runner installation. OR Download the Zip file https://github.com/cta-wave/device-observation-framework/archive/refs/heads/main.zip and extract to your target folder. Both can also be found by clicking on the Code tab at the top of the Device Observation Framework landing page.
Prior to running the install script, python version 3.6 to 3.9 and pip version 3 must be installed and on the execution PATH.
On windows, add the Paths to Python to the system environment variables if they were not added during the installation.
Note: If your system uses python version 3.10 or greater you will have to downgrade to one of the supported versions mentioned above. Some of the python packages required by the observation framework are not supported in python version 3.10 or greater.
On Linux and Mac OS systems, prior to each user using the Observation Framework for the first time, run:
cd <full path to device-observation-framework>
./install.shOn Windows systems, prior to each user using the Observation Framework for the first time, run:
cd <full path to device-observation-framework>
install_win.batNote: Makes sure that the WindowsPowerShell is used for the above commands. The device-observation-framework folder may also be named device-observation-framework-main
It is important to download the correct Audio Mezzanine content.
The device observation framework requires the Audio Mezzanine files to compare with the recorded audio. The Audio Mezzanine content is not part of the repository and must be downloaded prior to running any audio observations.
The script always downloads the latest release of the Audio Mezzanine; if the user wants to download a previous release, then mezzanine_database.json can be modified manually to point to the required location.
To download the latest mezzanine content
Navigate to the audio_mezzanine folder and run:
sudo ./import_audio_mezzanine.shThe shell script creates a local copy of mezzanine_database.json. This json file contains the location of the mezzanine content that is then downloaded using download_mezzanine.py.
To download a previous mezzanine release
Edit mezzanine_database.json to point to the desired mezzanine location. The python script can then be run directly to download the content:
python3 download_mezzanine.pyThe "config.ini" file defines internal configurations for the Observation Framework. The configuration can be adjusted based on different set up and requirements, e.g. user configurable timeouts and thresholds.
To run Device Observation Framework enter:
cd device-observation-framework
python observation_framework.py --input <file>
OR
python3 observation_framework.py --input <file>
(n.b. Python version must be 3.6 or greater)e.g:
python observation_framework.py --input D:\device-observation-framework-main\recording_file_name.mp4IMPORTANT: Make sure that the WindowsPowerShell is used for the above commands on windows.
More information to run Device Observation Framework can be found here.