evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add diagnostics to Teslemetry (#115195)

Browse source 
* Add diag

* Add diag and tests

* Fix redaction

* Add another energy redact

* Review Feedback

* Update snapshot

* Fixed the wrong integration

* Fix snapshot again

* Update tests/components/teslemetry/test_diagnostics.py

---------

Co-authored-by: G Johansson <goran.johansson@shiftit.se>
This commit is contained in:
Brett Adams 2024-04-13 04:27:38 +10:00 • committed by GitHub
parent bea4c52d10
commit b266224ccd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 364 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

46
homeassistant/components/teslemetry/diagnostics.py Normal file
View file

@ -0,0 +1,46 @@
"""Provides diagnostics for Teslemetry."""
from __future__ import annotations
from typing import Any
from homeassistant.components.diagnostics import async_redact_data
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from .const import DOMAIN
VEHICLE_REDACT = [
"id",
"user_id",
"vehicle_id",
"vin",
"tokens",
"id_s",
"drive_state_active_route_latitude",
"drive_state_active_route_longitude",
"drive_state_latitude",
"drive_state_longitude",
"drive_state_native_latitude",
"drive_state_native_longitude",
]
ENERGY_REDACT = ["vin"]
async def async_get_config_entry_diagnostics(
hass: HomeAssistant, config_entry: ConfigEntry
) -> dict[str, Any]:
"""Return diagnostics for a config entry."""
vehicles = [
x.coordinator.data for x in hass.data[DOMAIN][config_entry.entry_id].vehicles
]
energysites = [
x.coordinator.data for x in hass.data[DOMAIN][config_entry.entry_id].energysites
]
# Return only the relevant children
return {
"vehicles": async_redact_data(vehicles, VEHICLE_REDACT),
"energysites": async_redact_data(energysites, ENERGY_REDACT),
}

295
tests/components/teslemetry/snapshots/test_diagnostics.ambr Normal file
View file

@ -0,0 +1,295 @@
# serializer version: 1
# name: test_diagnostics
dict({
'energysites': list([
dict({
'backup_capable': True,
'battery_power': 5060,
'energy_left': 38896.47368421053,
'generator_power': 0,
'grid_power': 0,
'grid_services_active': False,
'grid_services_power': 0,
'grid_status': 'Active',
'island_status': 'on_grid',
'load_power': 6245,
'percentage_charged': 95.50537403739663,
'solar_power': 1185,
'storm_mode_active': False,
'timestamp': '2024-01-01T00:00:00+00:00',
'total_pack_energy': 40727,
'wall_connectors': dict({
'abd-123': dict({
'din': 'abd-123',
'wall_connector_fault_state': 2,
'wall_connector_power': 0,
'wall_connector_state': 2,
}),
'bcd-234': dict({
'din': 'bcd-234',
'wall_connector_fault_state': 2,
'wall_connector_power': 0,
'wall_connector_state': 2,
}),
}),
}),
]),
'vehicles': list([
dict({
'access_type': 'OWNER',
'api_version': 71,
'backseat_token': None,
'backseat_token_updated_at': None,
'ble_autopair_enrolled': False,
'calendar_enabled': True,
'charge_state_battery_heater_on': False,
'charge_state_battery_level': 77,
'charge_state_battery_range': 266.87,
'charge_state_charge_amps': 16,
'charge_state_charge_current_request': 16,
'charge_state_charge_current_request_max': 16,
'charge_state_charge_enable_request': True,
'charge_state_charge_energy_added': 0,
'charge_state_charge_limit_soc': 80,
'charge_state_charge_limit_soc_max': 100,
'charge_state_charge_limit_soc_min': 50,
'charge_state_charge_limit_soc_std': 80,
'charge_state_charge_miles_added_ideal': 0,
'charge_state_charge_miles_added_rated': 0,
'charge_state_charge_port_cold_weather_mode': False,
'charge_state_charge_port_color': '<invalid>',
'charge_state_charge_port_door_open': True,
'charge_state_charge_port_latch': 'Engaged',
'charge_state_charge_rate': 0,
'charge_state_charger_actual_current': 0,
'charge_state_charger_phases': None,
'charge_state_charger_pilot_current': 16,
'charge_state_charger_power': 0,
'charge_state_charger_voltage': 2,
'charge_state_charging_state': 'Stopped',
'charge_state_conn_charge_cable': 'IEC',
'charge_state_est_battery_range': 275.04,
'charge_state_fast_charger_brand': '<invalid>',
'charge_state_fast_charger_present': False,
'charge_state_fast_charger_type': 'ACSingleWireCAN',
'charge_state_ideal_battery_range': 266.87,
'charge_state_max_range_charge_counter': 0,
'charge_state_minutes_to_full_charge': 0,
'charge_state_not_enough_power_to_heat': None,
'charge_state_off_peak_charging_enabled': False,
'charge_state_off_peak_charging_times': 'all_week',
'charge_state_off_peak_hours_end_time': 900,
'charge_state_preconditioning_enabled': False,
'charge_state_preconditioning_times': 'all_week',
'charge_state_scheduled_charging_mode': 'Off',
'charge_state_scheduled_charging_pending': False,
'charge_state_scheduled_charging_start_time': None,
'charge_state_scheduled_charging_start_time_app': 600,
'charge_state_scheduled_departure_time': 1704837600,
'charge_state_scheduled_departure_time_minutes': 480,
'charge_state_supercharger_session_trip_planner': False,
'charge_state_time_to_full_charge': 0,
'charge_state_timestamp': 1705707520649,
'charge_state_trip_charging': False,
'charge_state_usable_battery_level': 77,
'charge_state_user_charge_enable_request': None,
'climate_state_allow_cabin_overheat_protection': True,
'climate_state_auto_seat_climate_left': False,
'climate_state_auto_seat_climate_right': True,
'climate_state_auto_steering_wheel_heat': False,
'climate_state_battery_heater': False,
'climate_state_battery_heater_no_power': None,
'climate_state_cabin_overheat_protection': 'On',
'climate_state_cabin_overheat_protection_actively_cooling': False,
'climate_state_climate_keeper_mode': 'off',
'climate_state_cop_activation_temperature': 'High',
'climate_state_defrost_mode': 0,
'climate_state_driver_temp_setting': 22,
'climate_state_fan_status': 0,
'climate_state_hvac_auto_request': 'On',
'climate_state_inside_temp': 29.8,
'climate_state_is_auto_conditioning_on': False,
'climate_state_is_climate_on': False,
'climate_state_is_front_defroster_on': False,
'climate_state_is_preconditioning': False,
'climate_state_is_rear_defroster_on': False,
'climate_state_left_temp_direction': 251,
'climate_state_max_avail_temp': 28,
'climate_state_min_avail_temp': 15,
'climate_state_outside_temp': 30,
'climate_state_passenger_temp_setting': 22,
'climate_state_remote_heater_control_enabled': False,
'climate_state_right_temp_direction': 251,
'climate_state_seat_heater_left': 0,
'climate_state_seat_heater_rear_center': 0,
'climate_state_seat_heater_rear_left': 0,
'climate_state_seat_heater_rear_right': 0,
'climate_state_seat_heater_right': 0,
'climate_state_side_mirror_heaters': False,
'climate_state_steering_wheel_heat_level': 0,
'climate_state_steering_wheel_heater': False,
'climate_state_supports_fan_only_cabin_overheat_protection': True,
'climate_state_timestamp': 1705707520649,
'climate_state_wiper_blade_heater': False,
'color': None,
'drive_state_active_route_latitude': '**REDACTED**',
'drive_state_active_route_longitude': '**REDACTED**',
'drive_state_active_route_miles_to_arrival': 0.039491,
'drive_state_active_route_minutes_to_arrival': 0.103577,
'drive_state_active_route_traffic_minutes_delay': 0,
'drive_state_gps_as_of': 1701129612,
'drive_state_heading': 185,
'drive_state_latitude': '**REDACTED**',
'drive_state_longitude': '**REDACTED**',
'drive_state_native_latitude': '**REDACTED**',
'drive_state_native_location_supported': 1,
'drive_state_native_longitude': '**REDACTED**',
'drive_state_native_type': 'wgs',
'drive_state_power': -7,
'drive_state_shift_state': None,
'drive_state_speed': None,
'drive_state_timestamp': 1705707520649,
'granular_access_hide_private': False,
'gui_settings_gui_24_hour_time': False,
'gui_settings_gui_charge_rate_units': 'kW',
'gui_settings_gui_distance_units': 'km/hr',
'gui_settings_gui_range_display': 'Rated',
'gui_settings_gui_temperature_units': 'C',
'gui_settings_gui_tirepressure_units': 'Psi',
'gui_settings_show_range_units': False,
'gui_settings_timestamp': 1705707520649,
'id': '**REDACTED**',
'id_s': '**REDACTED**',
'in_service': False,
'state': 'online',
'tokens': '**REDACTED**',
'user_id': '**REDACTED**',
'vehicle_config_aux_park_lamps': 'Eu',
'vehicle_config_badge_version': 1,
'vehicle_config_can_accept_navigation_requests': True,
'vehicle_config_can_actuate_trunks': True,
'vehicle_config_car_special_type': 'base',
'vehicle_config_car_type': 'model3',
'vehicle_config_charge_port_type': 'CCS',
'vehicle_config_cop_user_set_temp_supported': False,
'vehicle_config_dashcam_clip_save_supported': True,
'vehicle_config_default_charge_to_max': False,
'vehicle_config_driver_assist': 'TeslaAP3',
'vehicle_config_ece_restrictions': False,
'vehicle_config_efficiency_package': 'M32021',
'vehicle_config_eu_vehicle': True,
'vehicle_config_exterior_color': 'DeepBlue',
'vehicle_config_exterior_trim': 'Black',
'vehicle_config_exterior_trim_override': '',
'vehicle_config_has_air_suspension': False,
'vehicle_config_has_ludicrous_mode': False,
'vehicle_config_has_seat_cooling': False,
'vehicle_config_headlamp_type': 'Global',
'vehicle_config_interior_trim_type': 'White2',
'vehicle_config_key_version': 2,
'vehicle_config_motorized_charge_port': True,
'vehicle_config_paint_color_override': '0,9,25,0.7,0.04',
'vehicle_config_performance_package': 'Base',
'vehicle_config_plg': True,
'vehicle_config_pws': True,
'vehicle_config_rear_drive_unit': 'PM216MOSFET',
'vehicle_config_rear_seat_heaters': 1,
'vehicle_config_rear_seat_type': 0,
'vehicle_config_rhd': True,
'vehicle_config_roof_color': 'RoofColorGlass',
'vehicle_config_seat_type': None,
'vehicle_config_spoiler_type': 'None',
'vehicle_config_sun_roof_installed': None,
'vehicle_config_supports_qr_pairing': False,
'vehicle_config_third_row_seats': 'None',
'vehicle_config_timestamp': 1705707520649,
'vehicle_config_trim_badging': '74d',
'vehicle_config_use_range_badging': True,
'vehicle_config_utc_offset': 36000,
'vehicle_config_webcam_selfie_supported': True,
'vehicle_config_webcam_supported': True,
'vehicle_config_wheel_type': 'Pinwheel18CapKit',
'vehicle_id': '**REDACTED**',
'vehicle_state_api_version': 71,
'vehicle_state_autopark_state_v2': 'unavailable',
'vehicle_state_calendar_supported': True,
'vehicle_state_car_version': '2023.44.30.8 06f534d46010',
'vehicle_state_center_display_state': 0,
'vehicle_state_dashcam_clip_save_available': True,
'vehicle_state_dashcam_state': 'Recording',
'vehicle_state_df': 0,
'vehicle_state_dr': 0,
'vehicle_state_fd_window': 0,
'vehicle_state_feature_bitmask': 'fbdffbff,187f',
'vehicle_state_fp_window': 0,
'vehicle_state_ft': 0,
'vehicle_state_is_user_present': False,
'vehicle_state_locked': False,
'vehicle_state_media_info_audio_volume': 2.6667,
'vehicle_state_media_info_audio_volume_increment': 0.333333,
'vehicle_state_media_info_audio_volume_max': 10.333333,
'vehicle_state_media_info_media_playback_status': 'Stopped',
'vehicle_state_media_info_now_playing_album': '',
'vehicle_state_media_info_now_playing_artist': '',
'vehicle_state_media_info_now_playing_duration': 0,
'vehicle_state_media_info_now_playing_elapsed': 0,
'vehicle_state_media_info_now_playing_source': 'Spotify',
'vehicle_state_media_info_now_playing_station': '',
'vehicle_state_media_info_now_playing_title': '',
'vehicle_state_media_state_remote_control_enabled': True,
'vehicle_state_notifications_supported': True,
'vehicle_state_odometer': 6481.019282,
'vehicle_state_parsed_calendar_supported': True,
'vehicle_state_pf': 0,
'vehicle_state_pr': 0,
'vehicle_state_rd_window': 0,
'vehicle_state_remote_start': False,
'vehicle_state_remote_start_enabled': True,
'vehicle_state_remote_start_supported': True,
'vehicle_state_rp_window': 0,
'vehicle_state_rt': 0,
'vehicle_state_santa_mode': 0,
'vehicle_state_sentry_mode': False,
'vehicle_state_sentry_mode_available': True,
'vehicle_state_service_mode': False,
'vehicle_state_service_mode_plus': False,
'vehicle_state_software_update_download_perc': 0,
'vehicle_state_software_update_expected_duration_sec': 2700,
'vehicle_state_software_update_install_perc': 1,
'vehicle_state_software_update_status': '',
'vehicle_state_software_update_version': ' ',
'vehicle_state_speed_limit_mode_active': False,
'vehicle_state_speed_limit_mode_current_limit_mph': 69,
'vehicle_state_speed_limit_mode_max_limit_mph': 120,
'vehicle_state_speed_limit_mode_min_limit_mph': 50,
'vehicle_state_speed_limit_mode_pin_code_set': True,
'vehicle_state_timestamp': 1705707520649,
'vehicle_state_tpms_hard_warning_fl': False,
'vehicle_state_tpms_hard_warning_fr': False,
'vehicle_state_tpms_hard_warning_rl': False,
'vehicle_state_tpms_hard_warning_rr': False,
'vehicle_state_tpms_last_seen_pressure_time_fl': 1705700812,
'vehicle_state_tpms_last_seen_pressure_time_fr': 1705700793,
'vehicle_state_tpms_last_seen_pressure_time_rl': 1705700794,
'vehicle_state_tpms_last_seen_pressure_time_rr': 1705700823,
'vehicle_state_tpms_pressure_fl': 2.775,
'vehicle_state_tpms_pressure_fr': 2.8,
'vehicle_state_tpms_pressure_rl': 2.775,
'vehicle_state_tpms_pressure_rr': 2.775,
'vehicle_state_tpms_rcp_front_value': 2.9,
'vehicle_state_tpms_rcp_rear_value': 2.9,
'vehicle_state_tpms_soft_warning_fl': False,
'vehicle_state_tpms_soft_warning_fr': False,
'vehicle_state_tpms_soft_warning_rl': False,
'vehicle_state_tpms_soft_warning_rr': False,
'vehicle_state_valet_mode': False,
'vehicle_state_valet_pin_needed': False,
'vehicle_state_vehicle_name': 'Test',
'vehicle_state_vehicle_self_test_progress': 0,
'vehicle_state_vehicle_self_test_requested': False,
'vehicle_state_webcam_available': True,
'vin': '**REDACTED**',
}),
]),
})
# ---

23
tests/components/teslemetry/test_diagnostics.py Normal file
View file

@ -0,0 +1,23 @@
"""Test the Telemetry Diagnostics."""
from syrupy.assertion import SnapshotAssertion
from homeassistant.core import HomeAssistant
from . import setup_platform
from tests.components.diagnostics import get_diagnostics_for_config_entry
from tests.typing import ClientSessionGenerator
async def test_diagnostics(
hass: HomeAssistant,
hass_client: ClientSessionGenerator,
snapshot: SnapshotAssertion,
) -> None:
"""Test diagnostics."""
entry = await setup_platform(hass)
diag = await get_diagnostics_for_config_entry(hass, hass_client, entry)
assert diag == snapshot