Healthd develops more and more events, our clients use them as part of their diagnostic flow. However, our clients want to know if a certain event is supported or not so that they can decide to render an icon on the UI or not. Hence, we release an interface CrosHealthdEventService.IsEventSupported for our clients to query the event support status.
This document focuses on the following things:
This document assumes that OEMs/ODMs understand how to make changes to the Boxster config. If OEMs/ODMs have any trouble on this, please contact us.
Some commands help you debug the issue or have a quick try:
cros-health-tool event --help Use this command to check all possible event types.cros-health-tool event --category=$EVENT --check_supported Use this command to see if $EVENT is supported or not.Always supported.
Spec (Partners only): Chromebook, Convertible, Detachable, Chromeslate, Chromebox, Chromebase
Always supported. If any OEMs need to distinguish it with the USB, please reach out to us.
Supported only when form-factor is explicitly configured as one of the following:
You can run the following commands on your DUT:
cros_config /hardware-properties form-factor This is helpful to understand what the value of form-factor is.cros-health-tool event --category=lid --check_supported Use this to see if healthd reports the correct support status.To configure form-factor in Boxster, you can use the create_form_factor function defined in hw_topology.star to set it up.
Always supported.
Spec (Partners only): Chromebook, Convertible, Detachable, Chromeslate, Chromebox, Chromebase
Always supported.
Always supported. Chromebox may not have a speaker so the event may not be suitable, if OEMs want us to report it as non-supported, please reach out to us.
Spec (Partners only): Chromebook, Convertible, Detachable, Chromeslate, Chromebox, Chromebase
Supported only when has-audio-jack is explicitly configured as “true”.
You can run the following commands on your DUT:
cros_config /hardware-properties has-audio-jack This is helpful to understand what the value of has-audio-jack is.cros-health-tool event --category=audio_jack --check_supported Use this to see if healthd reports the correct support status.To configure has-audio-jack in Boxster, you can use create_audio function defined in hw_topology.star to set it up by filling up the headphone_codec value to non AUDIO_CODEC_UNKNOWN. Because as long as there is a headphone codec, the audio jack is supported. So we transform this into has-audio-jack in chromeos-config.
Supported only when has-sd-reader is explicitly configured as “true”.
You can run the following commands on your DUT:
cros_config /hardware-properties has-sd-reader This is helpful to understand what the value of has-sd-reader is.cros-health-tool event --category=sd_card --check_supported Use this to see if healthd reports the correct support status.To configure has-sd-reader in Boxster, you can use the create_sd_reader function defined in hw_topology.star to set it up.
Not supported by the new event interface. Since there are no users at this moment. Please reach out to us if you need network events.
Supported only when form-factor is explicitly configured as one of the following:
You can run the following commands on your DUT:
cros_config /hardware-properties form-factor This is helpful to understand what the value of form-factor is.cros-health-tool event --category=keyboard_diagnostic --check_supported Use this to see if healthd reports the correct support status.To configure form-factor in Boxster, you can use the create_form_factor function defined in hw_topology.star to set it up.
Supported only when form-factor is explicitly configured as one of the following:
You can run the following commands on your DUT:
cros_config /hardware-properties form-factor This is helpful to understand what the value of form-factor is.cros-health-tool event --category=touchpad --check_supported Use this to see if healthd reports the correct support status.To configure form-factor in Boxster, you can use create_form_factor function defined in hw_topology.star to set it up.
Always supported.
Supported only when has-touchscreen is explicitly configured as “true”.
You can run the following commands on your DUT:
cros_config /hardware-properties has-touchscreen This is helpful to understand what the value of has-touchscreen is.cros-health-tool event --category=touchscreen --check_supported Use this to see if healthd reports the correct support status.To configure has-touchscreen in Boxster, you can use create_screen function defined in hw_topology.star to set it up, in this case, you should fill the touch parameter as True.
Supported only when stylus-category is explicitly configured as “internal”, which means it's a “garaged stylus”.
You can run the following commands on your DUT:
cros_config /hardware-properties stylus-category This is helpful to understand what the value of stylus-category is.cros-health-tool event --category=stylus_garage --check_supported Use this to see if healthd reports the correct support status.To configure stylus-category in Boxster, you can use the create_stylus function defined in hw_topology.star to set it up.
Supported only when stylus-category is explicitly configured as “internal” or “external”.
You can run the following commands on your DUT:
cros_config /hardware-properties stylus-category This is helpful to understand what the value of stylus-category is.cros-health-tool event --category=stylus --check_supported Use this to see if healthd reports the correct support status.To configure stylus-category in Boxster, you can use the create_stylus function defined in hw_topology.star to set it up.