fuchsia.hardware.power.battery

Added: HEAD

PROTOCOLS

Battery

Defined in fuchsia.hardware.power.battery/battery.fidl

Protocol representing the Battery (acting as the Fuel Gauge).

This protocol focuses on reading the chemical telemetry of the cell pack. Charging operations are managed separately via fuchsia.hardware.power.charger/Charger.

GetSpec

Returns the spec immediately.

Request

<EMPTY>

Response

NameType
payload Battery_GetSpec_Result

GetStatus

Returns the status immediately.

Request

<EMPTY>

Response

NameType
payload Battery_GetStatus_Result

Watch

Hanging get for status updates. See fuchsia.hardware.power.source/Source.Watch for semantics.

Request

NameType
interest Status
wake_on Status
lease fuchsia.power.system/LeaseToken

Response

NameType
payload Battery_Watch_Result

STRUCTS

Battery_GetSpec_Response

Defined in fuchsia.hardware.power.battery/battery.fidl

FieldTypeDescriptionDefault
spec Spec No default

Battery_GetStatus_Response

Defined in fuchsia.hardware.power.battery/battery.fidl

FieldTypeDescriptionDefault
status Status No default

Battery_Watch_Response resource

Defined in fuchsia.hardware.power.battery/battery.fidl

FieldTypeDescriptionDefault
status Status No default
wake_lease fuchsia.power.system/LeaseToken No default

ENUMS

ChargeStatus flexible

Type: uint32

Defined in fuchsia.hardware.power.battery/battery.fidl

High-level charging status for clients.

NameValueDescription
1
2
3
4

HealthStatus flexible

Type: uint32

Defined in fuchsia.hardware.power.battery/battery.fidl

Battery health status.

NameValueDescription
1
2
3
4
5
6
7
8

TABLES

Spec

Defined in fuchsia.hardware.power.battery/battery.fidl

Static hardware characteristics of the battery pack.

OrdinalFieldTypeDescription
source_spec fuchsia.hardware.power.source/Spec

Base spec from the underlying power source.

design_capacity_uah uint32

Design capacity in microamp-hours.

design_voltage_uv uint32

Design voltage in microvolts.

chemistry string

Battery chemistry description.

Status

Defined in fuchsia.hardware.power.battery/battery.fidl

Dynamic status of the battery pack telemetry.

OrdinalFieldTypeDescription
source_status fuchsia.hardware.power.source/Status

Base status from the underlying power source.

charge_status ChargeStatus

High-level charging status.

level_percent float32

Battery level percentage (0.0 to 100.0).

remaining_capacity_uah uint32

Remaining capacity in microamp-hours.

full_charge_capacity_uah uint32

Full charge capacity in microamp-hours.

health HealthStatus

Battery health status.

temperature_mc int32

Temperature in milli-Celsius.

cycle_count uint32

Number of charge cycles.

time_remaining zx/Duration

Estimated time remaining until empty or full.

UNIONS

Battery_GetSpec_Result strict

Defined in fuchsia.hardware.power.battery/battery.fidl

OrdinalVariantTypeDescription
response Battery_GetSpec_Response
err fuchsia.hardware.power.source/Error
framework_err internal

Battery_GetStatus_Result strict

Defined in fuchsia.hardware.power.battery/battery.fidl

OrdinalVariantTypeDescription
response Battery_GetStatus_Response
err fuchsia.hardware.power.source/Error
framework_err internal

Battery_Watch_Result strict resource

Defined in fuchsia.hardware.power.battery/battery.fidl

OrdinalVariantTypeDescription
response Battery_Watch_Response
framework_err internal

SERVICES

Service

Defined in fuchsia.hardware.power.battery/battery.fidl

NameTypeTransport
battery fuchsia.hardware.power.battery/Battery Channel
power_source fuchsia.hardware.power.source/Source Channel