git.sur5r.net Git - i3/i3status/blob - src/print_battery_info.c

   1 // vim:ts=4:sw=4:expandtab
   2 #include <ctype.h>
   3 #include <time.h>
   4 #include <string.h>
   5 #include <stdlib.h>
   6 #include <stdio.h>
   7 #include <yajl/yajl_gen.h>
   8 #include <yajl/yajl_version.h>
   9
  10 #include "i3status.h"
  11
  12 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
  13 #include <sys/types.h>
  14 #include <sys/sysctl.h>
  15 #include <dev/acpica/acpiio.h>
  16 #endif
  17
  18 #if defined(__OpenBSD__)
  19 #include <sys/types.h>
  20 #include <sys/ioctl.h>
  21 #include <sys/fcntl.h>
  22 #include <machine/apmvar.h>
  23 #endif
  24
  25 #if defined(__NetBSD__)
  26 #include <fcntl.h>
  27 #include <prop/proplib.h>
  28 #include <sys/envsys.h>
  29 #endif
  30
  31 /*
  32  * Get battery information from /sys. Note that it uses the design capacity to
  33  * calculate the percentage, not the last full capacity, so you can see how
  34  * worn off your battery is.
  35  *
  36  */
  37 void print_battery_info(yajl_gen json_gen, char *buffer, int number, const char *path, const char *format, const char *format_down, const char *status_chr, const char *status_bat, const char *status_unk, const char *status_full, int low_threshold, char *threshold_type, bool last_full_capacity, bool integer_battery_capacity, bool hide_seconds) {
  38     char buf[1024];
  39     const char *walk, *last;
  40     char *outwalk = buffer;
  41     bool watt_as_unit = false;
  42     int full_design = -1,
  43         remaining = -1,
  44         present_rate = -1,
  45         voltage = -1,
  46         seconds_remaining = -1;
  47     float percentage_remaining = -1;
  48     charging_status_t status = CS_DISCHARGING;
  49
  50     static char batpath[512];
  51     sprintf(batpath, path, number);
  52     INSTANCE(batpath);
  53
  54 #if defined(LINUX)
  55     if (!slurp(batpath, buf, sizeof(buf))) {
  56         OUTPUT_FULL_TEXT(format_down);
  57         return;
  58     }
  59
  60     for (walk = buf, last = buf; (walk - buf) < 1024; walk++) {
  61         if (*walk == '\n') {
  62             last = walk + 1;
  63             continue;
  64         }
  65
  66         if (*walk != '=')
  67             continue;
  68
  69         if (BEGINS_WITH(last, "POWER_SUPPLY_ENERGY_NOW")) {
  70             watt_as_unit = true;
  71             remaining = atoi(walk + 1);
  72         } else if (BEGINS_WITH(last, "POWER_SUPPLY_CHARGE_NOW")) {
  73             watt_as_unit = false;
  74             remaining = atoi(walk + 1);
  75         } else if (BEGINS_WITH(last, "POWER_SUPPLY_CURRENT_NOW"))
  76             present_rate = abs(atoi(walk + 1));
  77         else if (BEGINS_WITH(last, "POWER_SUPPLY_VOLTAGE_NOW"))
  78             voltage = abs(atoi(walk + 1));
  79         /* on some systems POWER_SUPPLY_POWER_NOW does not exist, but actually
  80          * it is the same as POWER_SUPPLY_CURRENT_NOW but with μWh as
  81          * unit instead of μAh. We will calculate it as we need it
  82          * later. */
  83         else if (BEGINS_WITH(last, "POWER_SUPPLY_POWER_NOW"))
  84             present_rate = abs(atoi(walk + 1));
  85         else if (BEGINS_WITH(last, "POWER_SUPPLY_STATUS=Charging"))
  86             status = CS_CHARGING;
  87         else if (BEGINS_WITH(last, "POWER_SUPPLY_STATUS=Full"))
  88             status = CS_FULL;
  89         else if (BEGINS_WITH(last, "POWER_SUPPLY_STATUS=Discharging"))
  90             status = CS_DISCHARGING;
  91         else if (BEGINS_WITH(last, "POWER_SUPPLY_STATUS="))
  92             status = CS_UNKNOWN;
  93         else {
  94             /* The only thing left is the full capacity */
  95             if (last_full_capacity) {
  96                 if (!BEGINS_WITH(last, "POWER_SUPPLY_ENERGY_FULL") &&
  97                     !BEGINS_WITH(last, "POWER_SUPPLY_CHARGE_FULL"))
  98                     continue;
  99             } else {
 100                 if (!BEGINS_WITH(last, "POWER_SUPPLY_CHARGE_FULL_DESIGN") &&
 101                     !BEGINS_WITH(last, "POWER_SUPPLY_ENERGY_FULL_DESIGN"))
 102                     continue;
 103             }
 104
 105             full_design = atoi(walk + 1);
 106         }
 107     }
 108
 109     /* the difference between POWER_SUPPLY_ENERGY_NOW and
 110      * POWER_SUPPLY_CHARGE_NOW is the unit of measurement. The energy is
 111      * given in mWh, the charge in mAh. So calculate every value given in
 112      * ampere to watt */
 113     if (!watt_as_unit) {
 114         present_rate = (((float)voltage / 1000.0) * ((float)present_rate / 1000.0));
 115
 116         if (voltage != -1) {
 117             remaining = (((float)voltage / 1000.0) * ((float)remaining / 1000.0));
 118             full_design = (((float)voltage / 1000.0) * ((float)full_design / 1000.0));
 119         }
 120     }
 121
 122     if ((full_design == -1) || (remaining == -1)) {
 123         OUTPUT_FULL_TEXT(format_down);
 124         return;
 125     }
 126
 127     percentage_remaining = (((float)remaining / (float)full_design) * 100);
 128     /* Some batteries report POWER_SUPPLY_CHARGE_NOW=<full_design> when fully
 129      * charged, even though that’s plainly wrong. For people who chose to see
 130      * the percentage calculated based on the last full capacity, we clamp the
 131      * value to 100%, as that makes more sense.
 132      * See http://bugs.debian.org/785398 */
 133     if (last_full_capacity && percentage_remaining > 100) {
 134         percentage_remaining = 100;
 135     }
 136
 137     if (present_rate > 0 && status != CS_FULL) {
 138         float remaining_time;
 139         if (status == CS_CHARGING)
 140             remaining_time = ((float)full_design - (float)remaining) / (float)present_rate;
 141         else if (status == CS_DISCHARGING)
 142             remaining_time = ((float)remaining / (float)present_rate);
 143         else
 144             remaining_time = 0;
 145
 146         seconds_remaining = (int)(remaining_time * 3600.0);
 147     }
 148 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
 149     int state;
 150     int sysctl_rslt;
 151     size_t sysctl_size = sizeof(sysctl_rslt);
 152
 153     if (sysctlbyname(BATT_LIFE, &sysctl_rslt, &sysctl_size, NULL, 0) != 0) {
 154         OUTPUT_FULL_TEXT(format_down);
 155         return;
 156     }
 157
 158     integer_battery_capacity = true;
 159     percentage_remaining = sysctl_rslt;
 160     if (sysctlbyname(BATT_TIME, &sysctl_rslt, &sysctl_size, NULL, 0) != 0) {
 161         OUTPUT_FULL_TEXT(format_down);
 162         return;
 163     }
 164
 165     hide_seconds = true;
 166     seconds_remaining = sysctl_rslt * 60;
 167     if (sysctlbyname(BATT_STATE, &sysctl_rslt, &sysctl_size, NULL, 0) != 0) {
 168         OUTPUT_FULL_TEXT(format_down);
 169         return;
 170     }
 171
 172     state = sysctl_rslt;
 173     if (state == 0 && percentage_remaining == 100)
 174         status = CS_FULL;
 175     else if ((state & ACPI_BATT_STAT_CHARGING) && percentage_remaining < 100)
 176         status = CS_CHARGING;
 177     else
 178         status = CS_DISCHARGING;
 179
 180     full_design = sysctl_rslt;
 181 #elif defined(__OpenBSD__)
 182     /*
 183          * We're using apm(4) here, which is the interface to acpi(4) on amd64/i386 and
 184          * the generic interface on macppc/sparc64/zaurus, instead of using sysctl(3) and
 185          * probing acpi(4) devices.
 186          */
 187     struct apm_power_info apm_info;
 188     int apm_fd;
 189
 190     apm_fd = open("/dev/apm", O_RDONLY);
 191     if (apm_fd < 0) {
 192         OUTPUT_FULL_TEXT("can't open /dev/apm");
 193         return;
 194     }
 195     if (ioctl(apm_fd, APM_IOC_GETPOWER, &apm_info) < 0)
 196         OUTPUT_FULL_TEXT("can't read power info");
 197
 198     close(apm_fd);
 199
 200     /* Don't bother to go further if there's no battery present. */
 201     if ((apm_info.battery_state == APM_BATTERY_ABSENT) ||
 202         (apm_info.battery_state == APM_BATT_UNKNOWN)) {
 203         OUTPUT_FULL_TEXT(format_down);
 204         return;
 205     }
 206
 207     switch (apm_info.ac_state) {
 208         case APM_AC_OFF:
 209             status = CS_DISCHARGING;
 210             break;
 211         case APM_AC_ON:
 212             status = CS_CHARGING;
 213             break;
 214         default:
 215             /* If we don't know what's going on, just assume we're discharging. */
 216             status = CS_DISCHARGING;
 217             break;
 218     }
 219
 220     integer_battery_capacity = true;
 221     percentage_remaining = apm_info.battery_life;
 222
 223     /* Can't give a meaningful value for remaining minutes if we're charging. */
 224     if (status != CS_CHARGING) {
 225         seconds_remaining = apm_info.minutes_left * 60;
 226     }
 227 #elif defined(__NetBSD__)
 228     /*
 229      * Using envsys(4) via sysmon(4).
 230      */
 231     int fd, rval, last_full_cap;
 232     bool is_found = false;
 233     char *sensor_desc;
 234     bool is_full = false;
 235
 236     prop_dictionary_t dict;
 237     prop_array_t array;
 238     prop_object_iterator_t iter;
 239     prop_object_iterator_t iter2;
 240     prop_object_t obj, obj2, obj3, obj4, obj5;
 241
 242     asprintf(&sensor_desc, "acpibat%d", number);
 243
 244     fd = open("/dev/sysmon", O_RDONLY);
 245     if (fd < 0) {
 246         OUTPUT_FULL_TEXT("can't open /dev/sysmon");
 247         return;
 248     }
 249
 250     rval = prop_dictionary_recv_ioctl(fd, ENVSYS_GETDICTIONARY, &dict);
 251     if (rval == -1) {
 252         close(fd);
 253         return;
 254     }
 255
 256     if (prop_dictionary_count(dict) == 0) {
 257         prop_object_release(dict);
 258         close(fd);
 259         return;
 260     }
 261
 262     iter = prop_dictionary_iterator(dict);
 263     if (iter == NULL) {
 264         prop_object_release(dict);
 265         close(fd);
 266     }
 267
 268     /* iterate over the dictionary returned by the kernel */
 269     while ((obj = prop_object_iterator_next(iter)) != NULL) {
 270         /* skip this dict if it's not what we're looking for */
 271         if ((strlen(prop_dictionary_keysym_cstring_nocopy(obj)) == strlen(sensor_desc)) &&
 272             (strncmp(sensor_desc,
 273                      prop_dictionary_keysym_cstring_nocopy(obj),
 274                      strlen(sensor_desc)) != 0))
 275             continue;
 276
 277         is_found = true;
 278
 279         array = prop_dictionary_get_keysym(dict, obj);
 280         if (prop_object_type(array) != PROP_TYPE_ARRAY) {
 281             prop_object_iterator_release(iter);
 282             prop_object_release(dict);
 283             close(fd);
 284             return;
 285         }
 286
 287         iter2 = prop_array_iterator(array);
 288         if (!iter2) {
 289             prop_object_iterator_release(iter);
 290             prop_object_release(dict);
 291             close(fd);
 292             return;
 293         }
 294
 295         /* iterate over array of dicts specific to target battery */
 296         while ((obj2 = prop_object_iterator_next(iter2)) != NULL) {
 297             obj3 = prop_dictionary_get(obj2, "description");
 298
 299             if (obj3 &&
 300                 strlen(prop_string_cstring_nocopy(obj3)) == 8 &&
 301                 strncmp("charging",
 302                         prop_string_cstring_nocopy(obj3),
 303                         8) == 0) {
 304                 obj3 = prop_dictionary_get(obj2, "cur-value");
 305
 306                 if (prop_number_integer_value(obj3))
 307                     status = CS_CHARGING;
 308                 else
 309                     status = CS_DISCHARGING;
 310
 311                 continue;
 312             }
 313
 314             if (obj3 &&
 315                 strlen(prop_string_cstring_nocopy(obj3)) == 6 &&
 316                 strncmp("charge",
 317                         prop_string_cstring_nocopy(obj3),
 318                         6) == 0) {
 319                 obj3 = prop_dictionary_get(obj2, "cur-value");
 320                 obj4 = prop_dictionary_get(obj2, "max-value");
 321                 obj5 = prop_dictionary_get(obj2, "type");
 322
 323                 remaining = prop_number_integer_value(obj3);
 324                 full_design = prop_number_integer_value(obj4);
 325
 326                 if (remaining == full_design)
 327                     is_full = true;
 328
 329                 if (strncmp("Ampere hour",
 330                             prop_string_cstring_nocopy(obj5),
 331                             11) == 0)
 332                     watt_as_unit = false;
 333                 else
 334                     watt_as_unit = true;
 335
 336                 continue;
 337             }
 338
 339             if (obj3 &&
 340                 strlen(prop_string_cstring_nocopy(obj3)) == 14 &&
 341                 strncmp("discharge rate",
 342                         prop_string_cstring_nocopy(obj3),
 343                         14) == 0) {
 344                 obj3 = prop_dictionary_get(obj2, "cur-value");
 345                 present_rate = prop_number_integer_value(obj3);
 346                 continue;
 347             }
 348
 349             if (obj3 &&
 350                 strlen(prop_string_cstring_nocopy(obj3)) == 13 &&
 351                 strncmp("last full cap",
 352                         prop_string_cstring_nocopy(obj3),
 353                         13) == 0) {
 354                 obj3 = prop_dictionary_get(obj2, "cur-value");
 355                 last_full_cap = prop_number_integer_value(obj3);
 356                 continue;
 357             }
 358
 359             if (obj3 &&
 360                 strlen(prop_string_cstring_nocopy(obj3)) == 7 &&
 361                 strncmp("voltage",
 362                         prop_string_cstring_nocopy(obj3),
 363                         7) == 0) {
 364                 obj3 = prop_dictionary_get(obj2, "cur-value");
 365                 voltage = prop_number_integer_value(obj3);
 366                 continue;
 367             }
 368         }
 369         prop_object_iterator_release(iter2);
 370     }
 371
 372     prop_object_iterator_release(iter);
 373     prop_object_release(dict);
 374     close(fd);
 375
 376     if (!is_found) {
 377         OUTPUT_FULL_TEXT(format_down);
 378         return;
 379     }
 380
 381     if (last_full_capacity)
 382         full_design = last_full_cap;
 383
 384     if (!watt_as_unit) {
 385         present_rate = (((float)voltage / 1000.0) * ((float)present_rate / 1000.0));
 386         remaining = (((float)voltage / 1000.0) * ((float)remaining / 1000.0));
 387         full_design = (((float)voltage / 1000.0) * ((float)full_design / 1000.0));
 388     }
 389
 390     percentage_remaining =
 391         (((float)remaining / (float)full_design) * 100);
 392
 393     if (is_full)
 394         status = CS_FULL;
 395
 396     /*
 397      * The envsys(4) ACPI routines do not appear to provide a 'time
 398      * remaining' figure, so we must deduce it.
 399      */
 400     float remaining_time;
 401
 402     if (status == CS_CHARGING)
 403         remaining_time = ((float)full_design - (float)remaining) / (float)present_rate;
 404     else if (status == CS_DISCHARGING)
 405         remaining_time = ((float)remaining / (float)present_rate);
 406     else
 407         remaining_time = 0;
 408
 409     seconds_remaining = (int)(remaining_time * 3600.0);
 410 #endif
 411
 412     bool colorful_output = false;
 413
 414     if (status == CS_DISCHARGING && low_threshold > 0) {
 415         if (percentage_remaining >= 0 && strcasecmp(threshold_type, "percentage") == 0 && percentage_remaining < low_threshold) {
 416             START_COLOR("color_bad");
 417             colorful_output = true;
 418         } else if (seconds_remaining >= 0 && strcasecmp(threshold_type, "time") == 0 && seconds_remaining < 60 * low_threshold) {
 419             START_COLOR("color_bad");
 420             colorful_output = true;
 421         }
 422     }
 423
 424 #define EAT_SPACE_FROM_OUTPUT_IF_NO_OUTPUT()              \
 425     do {                                                  \
 426         if (outwalk == prevoutwalk) {                     \
 427             if (outwalk > buffer && isspace(outwalk[-1])) \
 428                 outwalk--;                                \
 429             else if (isspace(*(walk + 1)))                \
 430                 walk++;                                   \
 431         }                                                 \
 432     } while (0)
 433
 434     for (walk = format; *walk != '\0'; walk++) {
 435         char *prevoutwalk = outwalk;
 436
 437         if (*walk != '%') {
 438             *(outwalk++) = *walk;
 439             continue;
 440         }
 441
 442         if (BEGINS_WITH(walk + 1, "status")) {
 443             const char *statusstr;
 444             switch (status) {
 445                 case CS_CHARGING:
 446                     statusstr = status_chr;
 447                     break;
 448                 case CS_DISCHARGING:
 449                     statusstr = status_bat;
 450                     break;
 451                 case CS_FULL:
 452                     statusstr = status_full;
 453                     break;
 454                 default:
 455                     statusstr = status_unk;
 456             }
 457
 458             outwalk += sprintf(outwalk, "%s", statusstr);
 459             walk += strlen("status");
 460         } else if (BEGINS_WITH(walk + 1, "percentage")) {
 461             if (integer_battery_capacity) {
 462                 outwalk += sprintf(outwalk, "%.00f%s", percentage_remaining, pct_mark);
 463             } else {
 464                 outwalk += sprintf(outwalk, "%.02f%s", percentage_remaining, pct_mark);
 465             }
 466             walk += strlen("percentage");
 467         } else if (BEGINS_WITH(walk + 1, "remaining")) {
 468             if (seconds_remaining >= 0) {
 469                 int seconds, hours, minutes;
 470
 471                 hours = seconds_remaining / 3600;
 472                 seconds = seconds_remaining - (hours * 3600);
 473                 minutes = seconds / 60;
 474                 seconds -= (minutes * 60);
 475
 476                 if (hide_seconds)
 477                     outwalk += sprintf(outwalk, "%02d:%02d",
 478                                        max(hours, 0), max(minutes, 0));
 479                 else
 480                     outwalk += sprintf(outwalk, "%02d:%02d:%02d",
 481                                        max(hours, 0), max(minutes, 0), max(seconds, 0));
 482             }
 483             walk += strlen("remaining");
 484             EAT_SPACE_FROM_OUTPUT_IF_NO_OUTPUT();
 485         } else if (BEGINS_WITH(walk + 1, "emptytime")) {
 486             if (seconds_remaining >= 0) {
 487                 time_t empty_time = time(NULL) + seconds_remaining;
 488                 struct tm *empty_tm = localtime(&empty_time);
 489
 490                 if (hide_seconds)
 491                     outwalk += sprintf(outwalk, "%02d:%02d",
 492                                        max(empty_tm->tm_hour, 0), max(empty_tm->tm_min, 0));
 493                 else
 494                     outwalk += sprintf(outwalk, "%02d:%02d:%02d",
 495                                        max(empty_tm->tm_hour, 0), max(empty_tm->tm_min, 0), max(empty_tm->tm_sec, 0));
 496             }
 497             walk += strlen("emptytime");
 498             EAT_SPACE_FROM_OUTPUT_IF_NO_OUTPUT();
 499         } else if (BEGINS_WITH(walk + 1, "consumption")) {
 500             if (present_rate >= 0)
 501                 outwalk += sprintf(outwalk, "%1.2fW", present_rate / 1e6);
 502
 503             walk += strlen("consumption");
 504             EAT_SPACE_FROM_OUTPUT_IF_NO_OUTPUT();
 505         }
 506     }
 507
 508     if (colorful_output)
 509         END_COLOR;
 510
 511     OUTPUT_FULL_TEXT(buffer);
 512 }