MercedesME 2020 Home Assistant Integration

If you encounter issues, set the logging level to debug for the mbapi2020 component in your Home Assistant configuration:

logger:
  default: warn
  logs:
    custom_components.mbapi2020: debug

To minimize the risk of your Mercedes-Benz account being blocked by the service, follow these best practices:

1. Use a dedicated account: Create a separate Mercedes-Benz user account specifically for Home Assistant.
2. Invite the account to the vehicle: The primary vehicle owner should invite the new HA-MB account to access the vehicle (up to six additional users are allowed per vehicle).
3. Avoid simultaneous use: Use the account exclusively in Home Assistant OR in the official Mercedes-Benz tools, but do not use both at the same time.

Note on Geofencing: Certain features like geofencing data are only available to the primary user. If your Home Assistant setup requires geofencing, you must use the primary user account in HA and use secondary accounts for the official mobile apps.

You can manage optional settings via the Options dialog in Home Assistant under Configuration > Integrations.

Available configuration keys:

• Excluded Cars: A comma-separated list of VINs to exclude from integration.
• PIN: The Security PIN required to execute special services. Set this up using your Mercedes-Benz mobile app.
• Disable Capability Check: (North America only) When enabled, the component will skip checking the car's capabilities.
• Debug Save Messages: When enabled, all relevant received messages are saved into the component's messages folder.

The Client maintains a dictionary of Car objects, keyed by their VIN or FIN. Data is ingested through _build_car, which handles both full data loads (REST) and incremental updates (WebSocket/Push).

Key behaviors:

• Exclusion: If a car's VIN is in excluded_cars, it is ignored.
• Data Modes: Data is categorized as pull (from REST) or push (from WebSocket).
• Attribute Mapping: The client maps raw JSON attributes to structured CarAttribute objects for various components like Odometer, Tires, Windows, Electric, and Precond.
• Synthetic Data: For REST data, if windowStatusOverall is missing, the client creates a synthetic status to ensure entity consistency.

The Client uses an on_data handler to process various message types received via WebSocket. When a message arrives, the client identifies the msg_type and performs specific actions, often returning an acknowledgment command to the server.

Supported message types include:

• vepUpdates: Triggers _process_vep_updates and returns an acknowledgment with the received sequence_number.
• vehicle_status_updates: Triggers _process_vehicle_status_updates.
• apptwin_command_status_updates_by_vin: Processes command status updates.
• assigned_vehicles: Processes assigned vehicle information.
• data_change_event: Acknowledges data changes.
• user_data_update, user_picture_update, user_pin_update, etc.: Various user-related updates that require sequence number acknowledgments.

Diagnostic sensors are hidden by default in Home Assistant; check the Devices page to view them.

• Car: Monitors API communication. Attributes: full_update_messages_received, partital_update_messages_received, last_message_received, last_command_type, last_command_state, last_command_error_code, last_command_error_message.
• RCP_Features: Shows true if extended configuration (like interior lighting) is available. Note: Users on versions < 0.6 may require re-authentication to enable this. Attribute: rcp_supported_settings (List of remote configuration options).

The integration provides lock entities.

• Lock (Physical): Requires PIN setup in the Mercedes-Benz mobile app. If the PIN is not configured in the integration options, the lock will prompt for it during use.
• Lock (Sensor): Monitors the status of various entry points. Internal value is doorlockstatusvehicle.
  • 0: vehicle unlocked
  • 1: vehicle internal locked
  • 2: vehicle external locked
  • 3: vehicle selective unlocked

Attributes include: decklidstatus, doorStatusOverall, doorLockStatusOverall, doorlockstatusgas, doorlockstatusvehicle, doorlockstatusfrontleft, doorlockstatusfrontright, doorlockstatusrearright, doorlockstatusrearleft, doorlockstatusdecklid, doorstatusrearleft, doorstatusfrontright, doorstatusrearright, doorstatusfrontleft, rooftopstatus, sunroofstatus, engineHoodStatus.

You can control vehicle functions using the following buttons and switches:

Buttons

• Flash light
• Preclimate start
• Preclimate stop

Switches

• AuxHeat: Start/Stop the auxiliary heating of the car.
• Preclimate: Start/Stop the preclimate function of the car.