teslamotors / light-show

Tesla Light Show
3.19k stars 388 forks source link

Tesla Light Show xLights Guide

Welcome to the Tesla Light Show xLights guide! You can create and run your own light shows on Tesla vehicles.

Running a custom show on a vehicle

A custom show can be run on a supported vehicle by loading it via a USB flash drive. Create and share your shows with others! A single show can be shared and run on any supported vehicle; they are not model-specific. The sequence data is stored in a .fseq file and the music comes from your choice of .mp3 or .wav.

Download a Show

Multiple light show repositories can be found online. A screenshot from TeslaLightShare.io is below.

Supported Vehicles

  • Model S (2021+)

  • Model 3

  • Model X (2021+)

  • Model Y

  • Running Software v11.0 (2021.44.25) or newer

    USB flash drive requirements

  • Must contain a base-level folder called "LightShow" (without quotation marks and case sensitive).

  • The LightShow folder must contain at least 2 files:

    • a show .fseq file
    • a show .mp3 or .wav file (wav is recommended)
  • The fseq filename must match the mp3/wav filenames

    • E.g., show1.fseq/show1.wav can exist with show2.fseq/show2.mp3
  • Multiple shows can be stored on 1 USB drive (2023.44.25+ Vehicle Software)

  • Must be formatted as exFAT, FAT 32 (for Windows), MS-DOS FAT (for Mac), ext3, or ext4. NTFS is currently not supported.

  • Must not contain a base-level TeslaCam folder.

  • Must not contain any map update or firmware update files.

    Running the custom light show on a vehicle

  • Insert the flash drive into one of the front USB, USB-C ports, or glovebox USB port, then wait a few seconds.

  • In Toybox, select Light Show and tap Schedule Show.

  • If the files on the USB flash drive meet the requirements, then the custom shows will be available to select from the drop-down menu.

Light Show Community

reddit.com/r/TeslaLightShow/

Debug

General Limitations of Custom Shows

Audio file requirements

You can use both the mp3 and wav format (.wav is recommended). Make sure the file is encoded with a sample rate of 44.1 kHz; less common 48 kHz files won't properly sync to the light show.

Getting started with the Tesla xLights project directory

  1. Visit xLights Downloads to download and install the xLights application.

  2. Download and unzip tesla_xlights_show_folder.zip, which is the Tesla xLights bare project directory.

    • It is recommended to keep the project directory structure as-is and leave all files in their default locations.
  3. Open the xLights application.

  4. IMPORTANT: In File > Preferences > Sequences > FSEQ Version, select "V2 Uncompressed".

  5. In File > Select Show Folder, navigate to and select the unzipped project directory, then select Open.

  6. Select the Layout tab to view the Tesla 3D vehicle model.

  7. Make sure that the 3D preview checkbox is selected.

  8. Select the Sequencer tab. For the best editing experience, only the timeline and House Preview are needed.

  9. Note that the official Tesla Model S .xmodel file includes the superset of lights and closures that are needed for all supported vehicles, and should be used to generate shows for all vehicle types. See light channel locations for information about where the lights are on each vehicle.

Opening the example sequence

An example sequence is provided that can be run on the vehicle and/or opened in xLights. These instructions cover how to open it in xLights.

  1. Follow the getting started instructions to set up the xLights project.
  2. Download and unzip the example light show: lightshow_example_1_elevator_music.zip or lightshow_example_2_Max_Carlisle_Auld_Lang_Syne_In_the_City.zip.
  3. In File > Open Sequence, navigate to the unzipped folder and select the lightshow.xsq example file, then select Open.
  4. In the Sequencer tab, double click groups in the timeline to reveal individual left / right control.

Creating a new sequence

  1. Follow the getting started instructions to set up the xLights project.

  2. Select File > New Sequence

  3. Select Musical Sequence

  4. Navigate to your chosen .wav or mp3 file, select it, then select Open. Note that .wav files may be hidden unless file type is set to xLights Audio Files.

  5. In the Wizard tab select Custom

  6. Change the Frame interval to 20ms then select OK.

    Note: any value between 15ms and 100ms is supported by the vehicle, but 20ms is recommended for nearly all use cases. The maximum show size limits do not depend on the frame interval.

  7. Select Quick Start and wait for the sequencer to load

  8. In the top left of the timeline, select "Group View" in the view selector. You can also choose "Old View" for the pre-update layout.

  9. If using the recommended "Group View", you can double click the light groups to reveal and hide individual left/right control. Placing light effects in the group object will activate both the left and right light

  10. If using the old view, double click on "GRP Tesla Model S" to view all channels

  11. For more information on the workflow of creating xLights sequences, please use existing online resources. The rest of these instructions contain Tesla-specific information for show creators.

Light Show Sequence Validator Script

A Python validator script is provided to help check if your custom light show sequence meets these limitations, without needing a Tesla vehicle.

For usage, run:

python validator.py lightshow.fseq

macOS users should use this command instead:

python3 validator.py lightshow.fseq

Expected output looks like:

> python validator.py lightshow.fseq
Found 2247 frames, step time of 20 ms for a total duration of 0:00:44.940000.
Used 16.45% of the available memory

Boolean Light Channels

Most lights available on the vehicle can only turn on or off instantly, which corresponds to 0% or 100% brightness of an 'Effect' in xLights.

The minimum on-time for boolean light channels to produce light is 15ms, although human eyes will have a hard time seeing anything this short! Minimum on-time or off-time of 100ms generally makes the show more pleasing to look at.

In this example, the Left Front Fog turns on and off 3x:

Ramping Light Channels

Some channels can have a slow ramp in the intensity during turn-on or turn-off, to create graceful visual effects: Channel Model S Model X Model 3/Y
Outer Main Beam Ramping Ramping Ramping on LED reflector headlights;
Boolean on LED projector headlights
Inner Main Beam Ramping Ramping Ramping
Signature Boolean Boolean Ramping
Channels 4-6 Ramping Ramping Ramping
Front Turn Boolean Boolean Ramping

To command a light to turn on or off and follow a ramp profile, place the effect with the corresponding keyboard shortcut:

Ramping Function xLights Effect Brightness Hotkey
Turn off; Instant 0% empty timeline
Turn off; 500 ms 10% W
Turn off; 1000 ms 20% S
Turn off; 2000 ms 30% X
Turn on; 500 ms 70% E
Turn on; 1000 ms 80% D
Turn on; 2000 ms 90% C
Turn on; Instant 100% F

The keyboard layout is designed to be easy to use. Note that the effect types are grouped into vertical keyboard rows and sorted by duration.

Other notes

Ramping light examples

Light Channel Locations

The following tables and images help show which channels are controlled on each car. Some vehicles have lights that do not exist, or have multiple lights driven by the same control output - see notes in Light channel mapping details for this information. Light Channel Name Identifier in image - Model S/X Identifier in image - Model 3/Y
Outer Main Beam 1 1
Inner Main Beam 2 2
Signature 3 3
Channel 4 4 4-6
Channel 5 5 4-6
Channel 6 6 4-6
Front Turn 7 7
Front Fog 8 8
Aux Park 9 9
Side Marker 10 10

Model 3/Y with LED reflector lamps


Model 3/Y with LED projector lamps


Model S with LED reflector lamps


Model S with LED projector lamps


Model X


Closures channels

In custom xLights shows, the following closures can be commanded: Channel Model S Model X Model 3/Y Supports Dance? Command Limit Per Show
Liftgate Yes Yes Only vehicles with power liftgate Yes 6
Mirrors Yes Yes Yes - 20
Charge Port Yes Yes Yes Yes 3
Windows Yes Yes Yes Yes 6
Door Handles Yes - - - 20
Front Doors - Yes - - 6
Falcon Doors - Yes - Yes 6

To command a closure to move in a particular manner, place an effect with the following keyboard shortcuts:

Closure Movement xLights Effect Brightness
Idle empty timeline
Open Q
Dance A
Close Z
Stop F

Definitions for closure movements:

Other notes

Closures Command Limitations

Closures Command xLights Notes

Closure Movement Durations

Closure Movement Approximate Duration (s)
Open Liftgate 14
Close Liftgate 4
Open Front Doors 22
Close Front Doors 3
Open Falcon Doors 20
Close Falcon Doors 8
Windows 4
Mirrors, Door Handles, Charge Port 2

Tips for platform-agnostic light shows

Light channel mapping recommendations

Light channel mapping details

Side Markers and Aux Park

Ramping Channels 4-6

Front Fog

Rear Fog

Tail lights and License Plate Lights

Converting old (pre-2022 holiday update) show files

All old .fseq files are fully compatible with the new light show update. You only need to convert old show files if you want to edit them with the refreshed XLights configuration.