Tp smapi

From ArchWiki
Revision as of 16:07, 13 April 2010 by Toad (Talk | contribs) (Workaround for Partially Supported Laptops)

Jump to: navigation, search

tp_smapi is a set of kernel modules that retrieves information from and conveys commands to the hardware of ThinkPad laptops. This information is presented through the /sys/devices/platform/smapi filesystem. Much like the /proc filesystem, you can read and write information to these files to get information about and send commands to the hardware. tp_smapi is highly recommended if you're using a ThinkPad laptop.

Supported Laptops

First check whether your laptop is supported. Thinkwiki has a comprehensive list of all supported Thinkpads. In case your TP does not support stop_threshold but only start_threshold please go here Tp_smapi#Workaround for Partially Supported Laptops

Installation

Install tp_smapi from AUR. After installing, add tp_smapi to your MODULES array. After a reboot, this will activate most of the drivers, represented through the /sys/devices/platform/smapi filesystem.

Features

Here are a couple of useful things you can do using tp_smapi. Please feel free to add your own.

Control Battery Charging

It's bad for most laptop batteries to hold a full charge for long periods of time. You should try to keep your battery in the 40-80% charged range, unless you need the battery life for extended periods of time.

General Way

tp_smapi lets you control the start and stop charging threshold to do just that. Run these commands to set these to good values:

echo 40 > /sys/devices/platform/smapi/BAT0/start_charge_thresh
echo 80 > /sys/devices/platform/smapi/BAT0/stop_charge_thresh

This will cause the battery to begin charging when it falls below 40% charge and stop charging once it exceeds 80% charge. This will extend the lifetime of your battery.

Note that when you remove and re-insert the battery, these thresholds may be reset to their default values. To work around this, create a script to set these values, and make this script run both at startup and when a battery is inserted. More specific instructions follow.

Create a script /usr/sbin/set_battery_thresholds:

#!/bin/bash
# set the battery charging thresholds to extend battery lifespan
echo 40 > /sys/devices/platform/smapi/BAT0/start_charge_thresh
echo 80 > /sys/devices/platform/smapi/BAT0/stop_charge_thresh

NB: if you let the battery discharge below 40%, you will get problems, since it is not charged anymore. A solution consists in setting only the parameter stop_charge_thresh and control manually the lower battery value.

Set it runnable:

[root ~]# chmod 744 /usr/sbin/set_battery_thresholds

Make this script run at startup by editing /etc/rc.local:

#... other rc.local stuff
/usr/sbin/set_battery_thresholds

Make it run when a battery is inserted. This requires that acpid is installed and running. Edit /etc/acpi/handler.sh:

#... other ACPI stuff
battery)
  case "$2" in
    BAT0)
      case "$4" in
        00000000)
        ;;
        00000001)
        /usr/sbin/set_battery_thresholds
        ;;
#... more ACPI stuff

More advanced script

In case you would like more sophisticated script, which would fasilitate changing the thresholds:

#!/bin/bash
#
# Bash script for setting the battery thresholds on ThinkPads using the tp_smapi interface.
# Written by Ignas Anikevicius (20/03/2010)

#HELP TEXT
if [ "x$1" == "x--help" -o "x$1" == "x-h" ]
then
  echo -e "
  WARNING!!! This script needs to be run as root in order to have effect!!!

  Possible options are:
    set_bat_thresh [BAT_N] [[LOWER] [UPPER]][--reset][-r] 
 
    [BAT_N] number of the battery (can be either 0 or 1). 

    LOWER - lower threshold.
    UPPER - upper threshold .
    [--reset] or [-r] sets the default thresholds. 

  execute to see this text:
    set_bat_thresh [--help][-h]
"
  exit 0
fi 

if [ ! -d /sys/devices/platform/smapi ]; then
  echo -e "\nSMAPI interface is NOT installed.\nPlease load the module.\n"
  exit 0; fi

#SETTING THRESHOLD VALUES
if [ "x$2" == "x--reset" -o "x$2" == "x-r" ]
then
  LOWER=96
  UPPER=100
else
  LOWER=$2
  UPPER=$3
fi

#VALUE TESTING
if [ ${LOWER} -ge ${UPPER} ]; then
  echo -e "\n  Please provide proper thresholds!!!  \n"
  exit 0
fi

#BATTERY NUMBER
BAT_N=$1
LOWER_F="/sys/devices/platform/smapi/BAT${BAT_N}/start_charge_thresh"
UPPER_F="/sys/devices/platform/smapi/BAT${BAT_N}/stop_charge_thresh"

#SETTING THE THRESHOLDS
echo ${LOWER} > ${LOWER_F}
echo ${UPPER} > ${UPPER_F} 

#ECHOING THE STUFF
echo -e "\nSetting battery thresholds for Battery ${BAT_N}:
  Threshold for charging to start: ${LOWER} 
  Threshold for charging to stop: ${UPPER} 
"
exit 0;

With this script to set a battery threshold is very simple, just type (if set_bat_thresh is the name of the script):

set_bat_thresh 0 40 80

Check whether settings were accepted

To check whether your settings were accepted check the output of the following:

cat /sys/devices/platform/smapi/BAT0/start_charge_thresh
cat /sys/devices/platform/smapi/BAT0/stop_charge_thresh

Protect the Hard Disk from Drops

tp_smapi includes a driver to read the accelerometer in your laptop to detect drops and other events that could cause damage to your hard drive. See the HDAPS page for more information on this useful feature.

Workaround for Partially Supported Laptops

For partially supported laptops you can still gain control over your battery although it requires a little experimentation. First check what is actually supported:

cat /sys/devices/platform/smapi/BAT0/start_charge_thresh
cat /sys/devices/platform/smapi/BAT0/stop_charge_thresh

If stop_charge_thresh is supported, your path is straightforward and does not require further explanation. If only start-charge_thresh is supported, you will need to edit /etc/acpi/handler.sh as mentioned above. The following works to stop charging your battery if it is less than 99% charged (as root):

echo 99 > /sys/devices/platform/smapi/BAT0/start_charge_thresh

To start charging your battery again, type the following (again as root):

echo 0 > /sys/devices/platform/smapi/BAT0/start_charge_thresh

See Also

tp_smapi on ThinkWiki