PiScan/client
Ezra Taimuty-Loomis e1e629af3a
Refactoring of build environment and additional scripts for convenience (#6)
* cmake refactors

* Namespace refactors

* Some more env changes

* Tweaks for clean build

* Added install target

* Scripts to run server as service

* Added testing support

* Travis

* Squashed commit of the following:

commit b4273a76dc2ef1a44592ebd9127843dc4fa55718
Author: Ezra Taimuty-Loomis <etaimutyloomis@gmail.com>
Date:   Sun Aug 23 13:20:51 2020 -0400

    build fixes

commit cb5f7267a174c5ad9904976a1f6c5a376a18d801
Author: Ezra Taimuty-Loomis <etaimutyloomis@gmail.com>
Date:   Sun Aug 23 13:08:05 2020 -0400

    Update .travis.yml

commit 733df23a582751c3595a32d34d87e0fb24995108
Author: Ezra Taimuty-Loomis <etaimutyloomis@gmail.com>
Date:   Sun Aug 23 13:05:17 2020 -0400

    Update CMakeLists.txt

commit d2e4355b5dd4bf91c60b8d6a4418e317a9d3b711
Author: Ezra Taimuty-Loomis <etaimutyloomis@gmail.com>
Date:   Sun Aug 23 13:01:27 2020 -0400

    specify ubuntu dists

commit 34503b3ddfaff695efd22d8b3f7d8a5986651c6b
Author: Ezra Taimuty-Loomis <etaimutyloomis@gmail.com>
Date:   Sun Aug 23 12:53:00 2020 -0400

    cmake and dependencies

commit fd85af7b55bc78871717f2b70d4fe912c9beb59d
Author: Ezra Taimuty-Loomis <etaimutyloomis@gmail.com>
Date:   Sun Aug 23 12:08:13 2020 -0400

    cmake fixes

commit 90abbacd0ca8e08507a22f62ddbe713a5a1a901c
Author: Ezra Taimuty-Loomis <etaimutyloomis@gmail.com>
Date:   Sun Aug 23 11:49:58 2020 -0400

    Update .travis.yml

* Versioning and client migration

* Configure audio lib defaults

* Rules for config directory spec

* Build script changes

* Fix travis

* Fix readme
2020-12-31 15:12:58 -05:00
..
img Refactoring of build environment and additional scripts for convenience (#6) 2020-12-31 15:12:58 -05:00
py Refactoring of build environment and additional scripts for convenience (#6) 2020-12-31 15:12:58 -05:00
README.md Refactoring of build environment and additional scripts for convenience (#6) 2020-12-31 15:12:58 -05:00

README.md

PiScan Client

This is the client program used to control the PiScan software Currently, this repo contains only the cross-platform Python GUI client. Goals for the future include an Android client and an iOS client.

Python GUI

This client is compatible with any system that has a desktop interface supported by Qt (Windows, macOS, Linux) To use it, clone this repo in a directory of your choice, then navigate to the py directory.

First, install the prerequisites:

pip3 install -r requirements.txt

Then you can run it from there:

python3 ./client.py

For the time being, the script needs to be run from the py directory, otherwise it will not be able to locate its resource files and fail to run.

The following command options are available: -l: Bypasses the connect dialog and connects to PiScan on localhost -a <host>: Specify the address of the system where PiScan is running (e.g. localhost). Using this option bypasses the connection dialog. -p <port>: Specify the port to use if it's other than the default (1234). Only necessary in conjunction with -a -w: Starts client maximized with title bar hidden. Intended to be used on a Raspberry Pi with a 3.5inch display

Interface

Connecting

The connect dialog will appear on opening, if an address wasn't already specified. Here you can specify an address and port, which by default are localhost and 1234. Connection dialog

Once you hit the Connect button it will attempt to connect to PiScan. Once successful, you will be presented with the scanner screen.

Scanning

Scanner screen Scanner hold

Buttons:

  • Scan: resumes scanning from a paused state
  • Hold: pauses scanning on the currently active channel or whatever channel the scanner is currently checking
  • Manual: opens a dialog to manually tune to a frequency
  • Settings is disabled; it's a placeholder for functionality that hasn't been implemented

Right sidebar:

  • The squelch slider's range is set by the PiScan it's connected to. By default, the value will be in dBm
  • The gain slider sets the tuner gain. The default it automatic gain, but can be set in a range of 0-50
  • The grey button left of the sliders will collapse/open the sidebar, to hide the sliders when they are not needed

Manual Entry

The dialog gives a text field to enter a frequency in MHz, as well as a drop down containing the modulations supported by the connected PiScan instance. Clicking Tune will request PiScan to tune to the manual channel you specified. If all the parameters are valid, it will hold and monitor the manual channel. enter image description here