Rivian Card for use in Home Assistant

A custom picture-elements YAML configuration with custom image layers to match the build of the Rivian vehicles.

Features

All features of this card are visual alerts in nature. The following list will go through what to expect from this HA card.

• Card Styles
  • Vehicle Door/Window Overview
  • Charging Session and Overview
• Supported Rivian Build Year Models:
  • R1T 2022/2023
  • R1S 2022/2023
• Vehicle State (icon and description):
  • Locked | Unlocked
  • Odometer
  • Home | Away
  • State of Charge (SoC)
  • Plugged In | Unplugged | Charging
• Overlays
  • Window Rolled Down
  • Exterior Door Open
    • front left (US: driver's door; Intl: passenger's door)
    • front right (US: passenger's door; Intl: driver's door)
    • rear left
    • rear right
  • Exterior Closure Open Visual (non-occupancy doors)
    • front trunk (eg. frunk)
    • charger door (only while plugged in)
    • gear tunnel (right and left)
    • tailgate
    • liftgate (r1s only)
    • tonneau cover (r1t - powered only)

Features which require additional Lovelace Frontend dependencies

• Pulsating Charge Status
• State of Charge Progress Bar

Examples

Vehicle State Card (Overhead)

• red circle and red outline indicates the vehicle is unlocked (insecure)
• icons and status indicators (top left to bottom right):
  • locked state
  • away from home (device tracker)
  • current state of charge and predicted mileage (flashes during charge session)
  • current odometer reading

• red circle and red outline indicates the vehicle is unlocked (insecure)
• icons and status indicators (top left to bottom right):
  • locked state
  • at home (device tracker)
  • current state of charge and predicted mileage
  • current odometer reading

Vehicle Charging State Card (side_charging_)

Installation

required minimum dependency on home-assistant-rivian v0.7.1 for global lock/unlock state sensor

1. Choose if you want to have additional dependencies on HACS Frontend components card_mod and Bar Card (install if desired).

   1a. [no dependencies] Copy the contents of rivian-r1t-state-card.yml into a picture-elements lovelace card.

   1b. [with additional dependencies] Copy the contents of rivian-r1t-state-card-dependencies.yml (R1T) or rivian-r1s-state-card-dependencies.yml (R1S) into a picture-elements lovelace card. Features included in this markup and not the other include: progress bar battery state of charge visual and a pulsating charging icon visual. All other features are same as the other markup

2. Modify the base R1T model based on your Rivian color (replace rt1-launch-green.png with rt1-rivian-blue.png).

   • For instance, if you want to have your Home Assistant Rivian model to match your a specific color of your choosing.
   • Base Model Colors Supported and have the following image file name schema https://github.com/tmack8001/ha-rivian-card/blob/main/src/images/<model>/<view_angle>/<shading>/<model>-<color-name>.png
     • Example Dark R1T Images (overhead)
       • rt1-launch-green.png
       • rt1-rivian-blue.png
       • rt1-el-cap-granite.png
       • rt1-la-silver.png
       • rt1-midnight.png
       • rt1-forest-green.png
       • rt1-compass-yellow.png
       • rt1-canyon-red.png
       • rt1-limestone.png
       • rt1-glacier-white.png
     • Example Dark R1S Images (overhead)
       • rt1-launch-green.png
       • rt1-rivian-blue.png
       • rt1-el-cap-granite.png
       • rt1-la-silver.png
       • rt1-midnight.png
       • rt1-forest-green.png
       • rt1-compass-yellow.png
       • rt1-canyon-red.png
       • rt1-limestone.png
       • rt1-glacier-white.png

3. Modify the template entity naming to reflect your vehicle's device entities naming convention.

example replacement below:

    entity: sensor.<vehicle_name__or__r1t__or__r1s>_soc_limit

    entity: sensor.r1t_soc_limit             # default integration naming (model / trim)
    entity: sensor.stormtrooper_soc_limit    # custom named device

Update Entity Naming

Note that the entity names used in this card's repository is setup to assume a brand new install of the home-assistant-rivian integration.

In doing so some older users of this Home Assistant integration aren't going to work out of the box. If you have used the Rivian (Unofficial) addon prior to v0.9.x, you will have to edit the entity names in the picture-element yaml to match the old entity names. See old and new entity names here: https://github.com/bretterer/home-assistant-rivian/releases/tag/0.9.0.

In addition to the above the base entity names used also assume no naming of the vehicle (added by Rivian in OTA release 2023-14-00 and support for this was added in the HA integration version 0.10.0). With this vehicle naming feature entity names within HomeAssistant will now default to be named after your vehicle making way for multiple vehicles (yay ultimate adventurers) as well as making it easier to find sensors in type ahead.

Entity naming structure is outlined below:

binary_sensor.<prefix>_<sensor_name>
sensor.<prefix>_<sensor_name>

where <prefix> by default and no vehicle naming would map to r1t and r1s respectfully, though if named these will default to your vehicle's set name according to Rivian's GetVehicle API response

<sensor_name> maps to the name of a specific sensor where some are documented in the home-assistant-rivian README.md

Credits and Contributions

Credit to genosonic for the initially provided Rivian images and card concept.

Credit to natespencer for their contributions to the rivian-charging-card.yml as well as large changes to the home-assistant-rivian integration.