-
Notifications
You must be signed in to change notification settings - Fork 102
Software Installation
Installation steps depend on your host OS:
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 & 11: The correct driver is automatically installed.
Windows 8.1: The driver must be manually installed as follows:
- Download and install Zadig
- Connect Greaseweazle via USB
- Start Zadig
- Select "List all devices" from the Options pull-down menu
- Select "Greaseweazle" in the dropdown list
- Select "USB Serial (CDC)" as the driver
- 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:
- FluxMyFluffyFloppy (Frank Bopple)
- GreaseweazleGUI (Don Mankin)
Greaseweazle tools are installed as a Python 3 package from the command line.
To install Python 3 and Xcode tools:
$ xcode-select --install
$ brew install python
Recent versions of Homebrew Python require you to install Greaseweazle into
a virtual environment. This is very simple to do. For example, to install
into a folder called greaseweazle in your home directory, and activate it
in your current shell session:
$ mkdir greaseweazle
$ python3 -m venv greaseweazle
$ source greaseweazle/bin/activate
Note that the activate command will be required before using the
virtual environment in any new shell session.
To install the latest Greaseweazle release into your Python environment (virtual or otherwise):
$ python3 -m pip install git+https://github.com/keirf/greaseweazle@latest
When you connect Greaseweazle it will automatically appear as a /dev/cu.usbmodem device.
To test correct connection to Greaseweazle hardware:
$ gw info
Greaseweazle tools are installed as a Python 3 package from the command line.
To install Python 3 and C compiler on Ubuntu and other Debian-derived Linux:
$ sudo apt install gcc python3-pip python3-dev python3-venv
$ python3 -m pip install setuptools_scm
Recent Linux distributions require you to install Greaseweazle into
a virtual environment. This is very simple to do. For example, to install
into a folder called greaseweazle in your home directory, and activate it
in your current shell session:
$ mkdir greaseweazle
$ python3 -m venv greaseweazle
$ source greaseweazle/bin/activate
Note that the activate command will be required before using the
virtual environment in any new shell session.
To install the latest Greaseweazle release into your Python environment (virtual or otherwise):
$ python3 -m pip install git+https://github.com/keirf/greaseweazle@latest
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) before connecting the Greaseweazle:
$ sudo cp scripts/49-greaseweazle.rules /etc/udev/rules.d/.
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).