org.freedesktop.thermald: Thermal Daemon Reference Manual

org.freedesktop.thermald

Methods

SetCurrentPreference      (IN  s  new_pref);
SetUserMaxTemperature     (IN  s  zone_name,
                           IN  u  user_set_point_in_milli_degree_celsius);
SetUserPassiveTemperature (IN  s  zone_name,
                           IN  u  user_passive_control_in_milli_degree_celsius);
GetCurrentPreference      (OUT s  cur_pref);
AddSensor                 (IN  s  sensor_name,
                           IN  s  path);
AddVirtualSensor          (IN  s  sensor_name,
                           IN  s  dep_sensor_name,
                           IN  d  slope,
                           IN  d  intercept);
GetSensorCount            (OUT u  count);
GetSensorInformation      (IN  u  index,
                           OUT s  sensor,
                           OUT s  path,
                           OUT i  temp);
GetSensorTemperature      (IN  u  index,
                           OUT u  temperature);
GetZoneCount              (OUT u  count);
GetZoneInformation        (IN  u  index,
                           OUT s  zone,
                           OUT i  sensor_count,
                           OUT i  trip_count,
                           OUT i  bound);
GetZoneSensorAtIndex      (IN  u  zone_index,
                           IN  u  sensor_index,
                           OUT s  sensor_type);
GetZoneTripAtIndex        (IN  u  zone_index,
                           IN  u  trip_index,
                           OUT i  temp,
                           OUT i  trip_type,
                           OUT i  sensor_id,
                           OUT i  cdev_size,
                           OUT ai cdev_ids);
GetCdevCount              (OUT u  count);
GetCdevInformation        (IN  u  index,
                           OUT s  type,
                           OUT i  min_state,
                           OUT i  max_state,
                           OUT i  current_state);
AddZonePassive            (IN  s  zone_name,
                           IN  u  trip_point_temp,
                           IN  s  trip_point_sensor,
                           IN  s  trip_point_cdev);
DeleteZone                (IN  s  zone_name);
SetZoneStatus             (IN  s  zone_name,
                           IN  i  enable);
GetZoneStatus             (IN  s  zone_name,
                           OUT i  enable);
AddTripPoint              (IN  s  zone_name,
                           IN  u  trip_point_temp,
                           IN  s  trip_point_sensor,
                           IN  s  trip_point_cdev);
DeleteTripPoint           (IN  s  zone_name,
                           IN  u  trip_point_temp);
AddCoolingDevice          (IN  s  cdev_name,
                           IN  s  optional_path,
                           IN  i  min_state,
                           IN  i  max_state,
                           IN  i  inc_step);
UpdateCoolingDevice       (IN  s  cdev_name,
                           IN  s  optional_path,
                           IN  i  min_state,
                           IN  i  max_state,
                           IN  i  inc_step);
DisableCoolingDevice      (IN  s  cdev_name);
Reinit                    ();
Terminate                 ();

Description

Method Details

The SetCurrentPreference() method

SetCurrentPreference (IN  s new_pref);

The new preference can be one of:

PERFORMANCE: performance driven policy (ACPI: ACTIVE)
ENERGY_CONSERVE: Energy conservation "Quiet" mode (ACPI: PASSIVE)
DISABLE: Disable thermal daemon

IN s new_pref:

a string representing the selected preference

The SetUserMaxTemperature() method

SetUserMaxTemperature (IN  s zone_name,
                       IN  u user_set_point_in_milli_degree_celsius);

IN s zone_name:

IN u user_set_point_in_milli_degree_celsius:

The SetUserPassiveTemperature() method

SetUserPassiveTemperature (IN  s zone_name,
                           IN  u user_passive_control_in_milli_degree_celsius);

IN s zone_name:

IN u user_passive_control_in_milli_degree_celsius:

The GetCurrentPreference() method

GetCurrentPreference (OUT s cur_pref);

Returns the current preference

OUT s cur_pref:

The AddSensor() method

AddSensor (IN  s sensor_name,
           IN  s path);

IN s sensor_name:

IN s path:

The AddVirtualSensor() method

AddVirtualSensor (IN  s sensor_name,
                  IN  s dep_sensor_name,
                  IN  d slope,
                  IN  d intercept);

`IN s sensor_name`:
`IN s dep_sensor_name`:
`IN d slope`:
`IN d intercept`:

The GetSensorCount() method

GetSensorCount (OUT u count);

OUT u count:

The GetSensorInformation() method

GetSensorInformation (IN  u index,
                      OUT s sensor,
                      OUT s path,
                      OUT i temp);

`IN u index`:
`OUT s sensor`:
`OUT s path`:
`OUT i temp`:

The GetSensorTemperature() method

GetSensorTemperature (IN  u index,
                      OUT u temperature);

IN u index:

OUT u temperature:

The GetZoneCount() method

GetZoneCount (OUT u count);

OUT u count:

The GetZoneInformation() method

GetZoneInformation (IN  u index,
                    OUT s zone,
                    OUT i sensor_count,
                    OUT i trip_count,
                    OUT i bound);

`IN u index`:
`OUT s zone`:
`OUT i sensor_count`:
`OUT i trip_count`:
`OUT i bound`:

The GetZoneSensorAtIndex() method

GetZoneSensorAtIndex (IN  u zone_index,
                      IN  u sensor_index,
                      OUT s sensor_type);

IN u zone_index:

IN u sensor_index:

OUT s sensor_type:

The GetZoneTripAtIndex() method

GetZoneTripAtIndex (IN  u  zone_index,
                    IN  u  trip_index,
                    OUT i  temp,
                    OUT i  trip_type,
                    OUT i  sensor_id,
                    OUT i  cdev_size,
                    OUT ai cdev_ids);

`IN u zone_index`:
`IN u trip_index`:
`OUT i temp`:
`OUT i trip_type`:
`OUT i sensor_id`:
`OUT i cdev_size`:
`OUT ai cdev_ids`:

The GetCdevCount() method

GetCdevCount (OUT u count);

OUT u count:

The GetCdevInformation() method

GetCdevInformation (IN  u index,
                    OUT s type,
                    OUT i min_state,
                    OUT i max_state,
                    OUT i current_state);

`IN u index`:
`OUT s type`:
`OUT i min_state`:
`OUT i max_state`:
`OUT i current_state`:

The AddZonePassive() method

AddZonePassive (IN  s zone_name,
                IN  u trip_point_temp,
                IN  s trip_point_sensor,
                IN  s trip_point_cdev);

`IN s zone_name`:
`IN u trip_point_temp`:
`IN s trip_point_sensor`:
`IN s trip_point_cdev`:

The DeleteZone() method

DeleteZone (IN  s zone_name);

IN s zone_name:

The SetZoneStatus() method

SetZoneStatus (IN  s zone_name,
               IN  i enable);

IN s zone_name:

IN i enable:

The GetZoneStatus() method

GetZoneStatus (IN  s zone_name,
               OUT i enable);

IN s zone_name:

OUT i enable:

The AddTripPoint() method

AddTripPoint (IN  s zone_name,
              IN  u trip_point_temp,
              IN  s trip_point_sensor,
              IN  s trip_point_cdev);

`IN s zone_name`:
`IN u trip_point_temp`:
`IN s trip_point_sensor`:
`IN s trip_point_cdev`:

The DeleteTripPoint() method

DeleteTripPoint (IN  s zone_name,
                 IN  u trip_point_temp);

IN s zone_name:

IN u trip_point_temp:

The AddCoolingDevice() method

AddCoolingDevice (IN  s cdev_name,
                  IN  s optional_path,
                  IN  i min_state,
                  IN  i max_state,
                  IN  i inc_step);

`IN s cdev_name`:
`IN s optional_path`:
`IN i min_state`:
`IN i max_state`:
`IN i inc_step`:

The UpdateCoolingDevice() method

UpdateCoolingDevice (IN  s cdev_name,
                     IN  s optional_path,
                     IN  i min_state,
                     IN  i max_state,
                     IN  i inc_step);

`IN s cdev_name`:
`IN s optional_path`:
`IN i min_state`:
`IN i max_state`:
`IN i inc_step`:

The DisableCoolingDevice() method

DisableCoolingDevice (IN  s cdev_name);

IN s cdev_name:

The Reinit() method

Reinit ();

The Terminate() method

Terminate ();