Skip to content

Software Installation

Keir Fraser edited this page Apr 3, 2022 · 40 revisions

Installation steps depend on your host OS:

Windows

Greaseweazle is packaged as a Windows executable, hence there are no extra application components to download or install. Simply download the Greaseweazle host software, unzip, and run it in place from a CMD window.

Greaseweazle uses Microsoft's usbser.sys device driver. The steps to install the driver depend on your Windows OS version.

Windows 10: The correct driver is automatically installed.

Windows 7 & 8: The driver must be manually installed as follows:

  1. Download and install Zadig
  2. Connect Greaseweazle via USB
  3. Start Zadig
  4. Select "List all devices" from the Options pull-down menu
  5. Select "Greaseweazle" in the dropdown list
  6. Select "USB Serial (CDC)" as the driver
  7. Select "Install driver" or "Replace driver"

From now on Greaseweazle will automatically appear as a COM device (typically COM3). To test correct connection to Greaseweazle hardware:

gw info

After installing the Greaseweazle command-line tools, you may be interested in a Windows GUI wrapper. There are two available, maintained by third parties:

macOS

Greaseweazle tools are installed as a Python 3 package from the command line. For example, to install the latest release into a Python 3 environment:

python3 -m pip install git+https://github.com/keirf/greaseweazle@latest

Alternatively, download and unzip the source release and install from local tarball:

python3 -m pip install greaseweazle-tools-0.40/greaseweazle-0.40.tar.gz

When you connect Greaseweazle it will automatically appear as a /dev/cu.usbmodem device.

To test correct connection to Greaseweazle hardware:

gw info

Linux

Greaseweazle tools are installed as a Python 3 package from the command line. For example, to install the latest release into a Python 3 environment:

python3 -m pip install git+https://github.com/keirf/greaseweazle@latest

Alternatively, download and unzip the source release and install from local tarball:

python3 -m pip install greaseweazle-tools-0.40/greaseweazle-0.40.tar.gz

To make the Greaseweazle device accessible as a normal user, and to avoid conflicts with ModemManager under Ubuntu Linux, you need to add some udev rules (included in the release download):

sudo cp scripts/49-greaseweazle.rules /etc/udev/rules.d/.
sudo udevadm control --reload-rules && udevadm trigger

When you connect Greaseweazle it will automatically appear as a /dev/ttyACM device (typically /dev/ttyACM0). To test correct connection to Greaseweazle hardware:

gw info

If you install the Ubuntu udev rules, Greaseweazle should also appear as /dev/greaseweazle (this is a symlink to the correct ttyACM device).