Due to its flexibility and extensibility (and its complexity behind the scenes), there’s a few ways of getting started with Sputter. The first choice is which tool you want to use: the CLI or the Server.

  • CLI: Standalone command-line-only utility to gather drive temperatures from all the supported sources and outputs them to the console, optionally also publishing the measurements to an MQTT server.
  • Server: Server application that runs a HTTP API that you can query to gather drive measurements and optionally publish those measurements to an MQTT server and/or to Home Assistant. Can also be configured to gather and publish measurements on a timer for automation.

Command-Line Interface (CLI)

Download the correct release from GitHub Releases, making sure to download the matching sputter-console-* file for your target platform/architecture of choice. Unzip the archive somewhere convenient and run sputter -h/sputter.exe -h to see the contextual help.

Running the CLI without any arguments will (by default) output all measurements (and states/sensors) for any local drives in a human-readable table format.

Sputter Server

You can run the server a few different ways but to keep things brief here, we’ll only cover the two simplest ones: Docker and natively.

Docker

There is a pre-built Docker image available on Quay.io. For example:

  docker run -it --rm -p 8080:8080 quay.io/sputter/server:0.0.1

If you now hit http://localhost:8080/measurements, Sputter will use the HWMon adapter to discover and measure any drives from your host system.

Native

To run the server, download the correct release from GitHub Releases, making sure to download the matching sputter-server-* file for your target platform/architecture of choice. Unzip the archive somewhere convenient, and run Sputter.Server/Sputter.Server.exe to start the server. Open your browser and hit `http://localhost:5000/measurements to get all the measurements for any local drives.

Windows Support

If you’re on Windows, none of the bundled adapters will be able to read your local system’s drive temperatures. You can, however, install a plugin using Sputter’s plugin system that will enable reading your local drive temperatures using the excellent LibreHardwareMonitor library.

You can download the plugin from the latest release, then install it as per the instructions for either the Command-Line Interface (CLI) or Server.