fuchsia.thermal

PROTOCOLS

ClientStateConnector

Defined in fuchsia.thermal/client_state.fidl

Allows a client to connect a ClientStateWatcher to the thermal state of a given ClientType.

Connect

Connects a ClientStateWatcher to the thermal state of the specified ClientType.

A client may call this method and begin using the ClientStateWatcher client endpoint immediately.

If client_type does not exactly (case-sensitive) match with a client entry found in the central thermal configuration, then the request will fail. On failure, both the watcher server endpoint as well as the current ClientStateConnector connection will be terminated.

• client_type specifies the client-specific thermal state to which watcher should be connected. The value is valid iff it matches with a client entry found in the central thermal configuration.

• watcher is the server endpoint of a ClientStateWatcher channel that will be connected to the thermal state of client_type.

Request

Name	Type
client_type	ClientType
watcher	server_end:ClientStateWatcher

ClientStateWatcher

Defined in fuchsia.thermal/client_state.fidl

Allows a client to watch for changes to its thermal state.

This protocol cannot be connected to the service directly. Instead, the server endpoint of a ClientStateWatcher channel must be connected to the thermal state of the desired client type using the [ClientStateConnector.Connect'] method. The client endpoint of a ClientStateWatcher` channel is only useful after it has been connected in this way.

Watch

Watches for changes to a client's thermal state.

A client's thermal state is determined according to the central thermal configuration of its specific type. See the README.md for more details.

On a given connection, the first call will return immediately with the client's current thermal state. Subsequent Watch requests will only return a new state if the client's thermal state has changed. This follows the hanging get pattern.

• state is an unsigned integer representing the client's thermal state.

Request

<EMPTY>

Response

Name	Type
state	uint64

SensorManager

Defined in fuchsia.thermal/sensor_manager.fidl

Interface that manages interactions and the working state of thermal sensors.

ClearTemperatureOverride

Clears the temperature override set by SetTemperatureOverride. If no temperature override has been set, this interaction does nothing.

If a sensor with the given name is not found, ClearTemperatureOverrideError.SENSOR_NOT_FOUND is returned.

Request

Name	Type
name	fuchsia.hardware.temperature/SensorName

Response

Name	Type
payload	SensorManager_ClearTemperatureOverride_Result

Connect

Connects to the thermal sensor with the given name.

If any required arguments are not provided, ConnectError.INVALID_ARGUMENTS is returned.

If a sensor with the given name is not found, ConnectError.SENSOR_NOT_FOUND is returned.

Request

Name	Type
payload	SensorManagerConnectRequest

Response

Name	Type
payload	SensorManager_Connect_Result

ListSensors

Lists sensors that may be controlled and connected to by clients.

Request

<EMPTY>

Response

Name	Type
payload	SensorManager_ListSensors_Result

SetTemperatureOverride

Sets an override temperature for the sensor with name.

When an override temperature is set, internal thermal policies will use the override temperature. Temperature values retrieved from sensor connections vended by Connect will also receive the override temperature.

This interaction does not affect the thermal sensor itself. Clients who connect directly to the sensor without Connect will receive the real sensor value.

If a sensor with the given name is not found, SetTemperatureOverrideError.SENSOR_NOT_FOUND is returned.

Request

Name	Type
name	fuchsia.hardware.temperature/SensorName
override_temperature	float32

Response

Name	Type
payload	SensorManager_SetTemperatureOverride_Result

STRUCTS

SensorManager_ClearTemperatureOverride_Response

Defined in fuchsia.thermal/sensor_manager.fidl

<EMPTY>

SensorManager_Connect_Response

Defined in fuchsia.thermal/sensor_manager.fidl

<EMPTY>

SensorManager_ListSensors_Response

Defined in fuchsia.thermal/sensor_manager.fidl

Field	Type	Description	Default
sensors	vector<SensorInfo>		No default

SensorManager_SetTemperatureOverride_Response

Defined in fuchsia.thermal/sensor_manager.fidl

<EMPTY>

ENUMS

ClearTemperatureOverrideError flexible

Type: uint32

Defined in fuchsia.thermal/sensor_manager.fidl

Errors returned from calls to SensorManager.ClearTemperatureOverrideError.

Name	Value	Description
INTERNAL	1
SENSOR_NOT_FOUND	2

ConnectError flexible

Type: uint32

Defined in fuchsia.thermal/sensor_manager.fidl

Errors returned from calls to SensorManager.ConnectError.

Name	Value	Description
INTERNAL	1
INVALID_ARGUMENTS	2
SENSOR_NOT_FOUND	3

SetTemperatureOverrideError flexible

Type: uint32

Defined in fuchsia.thermal/sensor_manager.fidl

Errors returned from calls to SensorManager.SetTemperatureOverride.

Name	Value	Description
INTERNAL	1
SENSOR_NOT_FOUND	2

TABLES

SensorInfo

Defined in fuchsia.thermal/sensor_manager.fidl

Information about a sensor.

Ordinal	Field	Type	Description
1	name	fuchsia.hardware.temperature/SensorName

SensorManagerConnectRequest resource

Defined in fuchsia.thermal/sensor_manager.fidl

Ordinal	Field	Type	Description
1	name	fuchsia.hardware.temperature/SensorName	Required.
2	server_end	SensorServer	Required. The value that is set MUST match the type of sensor.

UNIONS

SensorManager_ClearTemperatureOverride_Result strict

Defined in fuchsia.thermal/sensor_manager.fidl

Ordinal	Variant	Type	Description
1	response	SensorManager_ClearTemperatureOverride_Response
2	err	ClearTemperatureOverrideError
3	framework_err	internal

SensorManager_Connect_Result strict

Defined in fuchsia.thermal/sensor_manager.fidl

Ordinal	Variant	Type	Description
1	response	SensorManager_Connect_Response
2	err	ConnectError
3	framework_err	internal

SensorManager_ListSensors_Result strict

Defined in fuchsia.thermal/sensor_manager.fidl

Ordinal	Variant	Type	Description
1	response	SensorManager_ListSensors_Response
3	framework_err	internal

SensorManager_SetTemperatureOverride_Result strict

Defined in fuchsia.thermal/sensor_manager.fidl

Ordinal	Variant	Type	Description
1	response	SensorManager_SetTemperatureOverride_Response
2	err	SetTemperatureOverrideError
3	framework_err	internal

SensorServer flexible resource

Defined in fuchsia.thermal/sensor_manager.fidl

The server end for a thermal sensor connection.

Ordinal	Variant	Type	Description
1	temperature	server_end:fuchsia.hardware.temperature/Device

CONSTANTS

Name	Value	Type	Description
MAX_THERMAL_LOAD	100	uint32	The maximum value of the normalized thermal load. This value bounds the width (and therefore also the precision) of the normalized thermal limiting range starting from 0. Trip points must be specified within this range.

ALIASES

Name	Value	Description
ClientType	string[8]	A string that represents the type of client using the protocol. ClientType is used as a parameter to ClientStateConnector.Connect to connect a ClientStateWatcher to the thermal state of the desired client type. A ClientType value should describe the type of subsystem a client represents and must exactly (case-sensitive) match with a client entry found in the central thermal configuration. Typical examples include "audio", "wifi", etc.