Sputter comes bundled with optional Home Assistant support that can seamlessly create new entities in Home Assistant for discovered drives. Once enabled, any time Sputter publishes measurements (after requests, or on a schedule) you’ll be able to immediately see updated values right in Home Assistant.

Configuration

To enable the Home Assistant support, you’ll need to first set up MQTT support.

Once you have MQTT configured, enable the Home Assistant integration with the EnableHomeAssistant option:

  {
    "MQTT": {
        // MQTT configuration trimmed for brevity
        "EnableHomeAssistant": true
    }
}
  
  # bash
export MQTT__EnableHomeAssistant="true"

You can then customize the HA behaviour with a few extra options in the HomeAssistant object:

  {
    "MQTT": {
        "HomeAssistant": {
            "DeviceArea": "Office",
            "ExtendedDriveInfo": true,
            "SingleDeviceMode": true,
            "OverrideManufacturer": true,
            "EnableAllSensors": true,
            "ExpireAfter": 600
        }
    }
}
  
  # bash
export MQTT__HomeAssistant__DeviceArea="Office"
export MQTT__HomeAssistant__ExtendedDriveInfo="true"
export MQTT__HomeAssistant__SingleDeviceMode="true"
export MQTT__HomeAssistant__OverrideManufacturer="true"
export MQTT__HomeAssistant__EnableAllSensors="true"
export MQTT__HomeAssistant__ExpireAfter="600"

Since that’s a lot, here’s a quick guide on what each of these options means in practice:

OptionDefault ValueNotes
DeviceAreanullIf you set this value, all the sensors created will be auto-assigned to the specified area in Home Assistant. If you don’t set this, you can still set the device’s area in Home Assistant itself.
ExtendedDriveInfofalseEnabling this option will also attempt to include any additional information about the drive in the sensor in Home Assistant. For example, this will include the manufacturer name and software version if available.
SingleDeviceModefalseBy default, Sputter will create a device in Home Assistant for each monitored drive. If you turn this on, it will instead create a single “Sputter” device and add all the drives as sensors on that one device instead.
OverrideManufacturerfalseIf enabled, this will replace the “Manufacturer” of the created HA sensor with Sputter instead of the drive manufacturer (or nothing, if not detected)
EnableAllSensorsfalseBy default, only the temperature sensor will be auto-enabled in Home Assistant. If you enable this option, other sensors/states (like the Healthy state) will also be enabled by default.
ExpireAfternullIf set, this is the number of seconds after which Home Assistant will mark a sensor entity as “Unavailable”. Note that this can cause oddities when Sputter first starts up/takes its first measurement, but should “level out”