# Full Goblocks config example with all available block types and options.

# The global section contains global config options.

global:
    # debug is a boolean indicating whether or not to pretty print the json
    # output. Note that this setting requires a restart in order to take
    # effect.
    debug: False
    # refresh_interval is a floating point number indicating the time interval
    # in seconds between when Goblocks sends an updated status line to i3bar.
    # Basically, it controls Goblocks' "frame rate". This value defaults to 1.
    # Note that this value also serves as the default update_interval value for
    # each block.
    refresh_interval: 1

# Below is the per-block configuration. The blocks are defined in a YAML array.

# Each block must have a type field indicating which status indicator to use for
# that block. Different status indicators can have different configuration
# fields.

# Each block may optionally have an update_interval field indicating the time
# interval in seconds between block updates. This is a floating point number,
# allowing for fractions of a second. Note that this interval does not affect
# the refresh rate of Goblocks' output; it only impacts the timing in which a
# block's info gets updated. If update_interval is omitted, then the
# refresh_interval value in the global section is used as the update_interval.

# Each block may optionally have a label field indicating a prefix string to
# prepend to the block's status text.

# If a block has an update_signal field, then that block will be updated and
# Goblocks refreshed when Goblocks receives an RTMIN signal offset by the given
# signal number. See the volume block config.
# For example, if update_signal is 1, then running 'pkill -RTMIN+1 goblocks'
# will cause Goblocks to update the block and refresh.
# The update_signal value must be 1 or greater.

# Blocks may optionally have a color field that specifies the default color of
# the block text, using the 6 digit hex RGB format (e.g. #00ff00 for green).

blocks:
    # The key block shows statuses of various toggled keys (caps lock, num lock,
    # etc.)
    - type: key
      update_interval: 3
      update_signal: 1
      # The key field is the key name to search for in the "xset q" output.
      key: Caps Lock
      # The key-text field is the text to display in the block.
      key-text: Caps
      # on-color and off-color indicate which colors to use when the given key
      # is on or off, respectively.
      on-color: "#ff0000"
      off-color: "#222222"

    # The disk block is an aggregate status of overall filesystem usage.
    - type: disk
      label: ": "
      # filesystems is a map of strings to floating point numbers. The strings
      # are the filesystems you want to check, and the numbers are the
      # critical usage percentages for those filesystems.
      filesystems:
          /: 90

    - type: load
      label: ": "
      crit_load: 4

    # The memory block displays available memory.
    - type: memory
      label: "M: "
      crit_mem: 1

    - type: temperature
      # cpu_temp_path is the path to the "hwmon" directory of the CPU
      # temperature info.
      cpu_temp_path: /sys/devices/platform/coretemp.0/hwmon
      crit_temp: 50

    - type: wifi
      label: ": "
      interface_name: wlp3s0
      crit_quality: 30

    - type: battery
      label: ": "
      # The battery number can be found in /sys/class/power_supply/
      battery_number: 0
      crit_battery: 20

    # The volume block currently supports Pulse or ALSA channels through amixer.
    # The amixer utility must be installed and in your $PATH.
    - type: volume
      update_interval: 60
      label: ": "
      update_signal: 1
      # mixer_device defines the device name to use. If omitted, the default
      # value is "default". Other possible values include "pulse".
      mixer_device: default
      # channel defines the volume channel to monitor. If omitted, the default
      # value is "Master".
      channel: Master

    - type: time
      update_interval: 0.5
      # The time_format value must be a string in Go's standard time format
      # (see https://golang.org/pkg/time/#pkg-constants).
      time_format: 2006-01-02 15:04:05