File: peripheral_battery_status.proto

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (65 lines) | stat: -rw-r--r-- 2,262 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
// Copyright 2013 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

syntax = "proto2";

option optimize_for = LITE_RUNTIME;

package power_manager;
option go_package = "go.chromium.org/chromiumos/system_api/power_manager_proto";

message PeripheralBatteryStatus {
  // Path of the battery sysfs.
  optional string path = 1;

  // Name of the peripheral device.
  optional string name = 2;

  // Battery level in range [0, 100]. Unset if the level is
  // unknown or the device is disconnected.
  optional int32 level = 3;

  enum ChargeStatus {
    // Status unknown, either permanently, or temporarily, e.g.,
    // due to a charger not being connected to chargable target.
    CHARGE_STATUS_UNKNOWN = 0;

    // Discharging may show up in normal operation of a device.
    // e.g., a powered stylus is always discharging if it is not
    // actually being charged.
    CHARGE_STATUS_DISCHARGING = 1;

    // Actively charging state, level is expected to rise.
    CHARGE_STATUS_CHARGING = 2;

    // Full will be returned if device is charging and at 100%
    CHARGE_STATUS_FULL = 3;

    // Not charging is equivalent to full if charger has decided
    // battery has reached maximum possible capacity, and there is
    // no error; level may not be 100% in this case.
    CHARGE_STATUS_NOT_CHARGING = 4;

    // Any health error will override charge status.
    CHARGE_STATUS_ERROR = 5;
  }

  // Charging status; peripherals may rarely expose a useful
  // status, primary usage is built-in peripheral chargers.
  optional ChargeStatus charge_status = 4;

  // Indicates if this is an active update, driven by udev (or other)
  // notification.
  //
  // The distinction is important for styluses and
  // other HID devices, as they will express their last known battery level
  // until a change, and a periodic poll (or powerd restart) that re-reads the
  // same value does not provide any new information, while a udev update
  // (even if the charge level is identical) does provide valid information
  // about the item.
  optional bool active_update = 5;

  // If present, contains the serial number of the battery, as a text field.
  optional string serial_number = 6;
}