Table Of Content

Plugin diskfree

Purpose

The diskfree plugin is used to monitor the space (available, used, free) on filesystems.

Dependencies

There is no dependency.

Plugin configuration

There is no global configuration options for this plugin.

Create the domogik devices

Domogik device type : diskfree.disk_usage

2 parameters are needed for a domogik device creation:

Key Type Description
device string The path to monitor on the filesystem. Example : /home
interval number The time in minutes between each time the filesystem space is monitored

Start the plugin

You can now start the plugin (start button) and use the created domogik devices.

Set up your widgets on the user interface

You can now place the widgets of your devices features on the user interface.

Development informations

Timeout on sensors

The timeout is set to 0 for all sensors : as the interval between 2 checks is a global parameter, we can’t set a proper default timeout. If needed, the timeout should be set manually by the user for this plugin.

How it the disk space data calculated ?

The plugin just use the os.statvfs(path) function.

xPL messages

xpl-stat

The sensor.basic message is used:

xpl-stat
{
...
}
sensor.basic
{
type=<one of these values : total_space, free_space, used_space, percent_used>
device=<path>
current=<value>
}

xpl-trig

n/a

xpl-cmnd

n/a

Changelog

1.4

  • Fix utf-8 issue

1.3

  • Fix percent free sensor value
  • Add an advanced page
  • Fix tests related to other fixes

1.2, 1.1

  • Minor updates linked to Domogik 0.4

1.0

  • Adapt the plugin to Domogik 0.4

0.1

  • Plugin creation