teslausb

Intro

You can configure a Raspberry Pi Zero W so that your Tesla thinks it's a USB drive and will write dashcam footage to it. Since it's a computer:

Scripts running on the Pi can automatically copy the clips to an archive server when you get home.
The Pi can hold both dashcam clips and music files.
The Pi can automatically repair filesystem corruption produced by the Tesla's current failure to properly dismount the USB drives before cutting power to the USB ports.

Improvements

This fork contains the following improvements compared to the upstream cimryan/teslausb:

Supports Tesla firmware 2019.x
Supports saving more than one hour of recordings
Supports exporting the recordings as a CIFS share
Optional hotspot to access recordings while on the go
Supports automatically syncing music from a CIFS share folder
Supports using the Tesla API to keep the car awake during archiving
Status indicator while running
Easier and more flexible way to specify sizes of camera and music disks
Support for Gotify, IFTTT and AWS SNS in addition to Pushover for notifications

Installing

It is recommended to use the prebuilt image and one step setup instructions to get started, as the instructions below may be outdated.

If you've never worked with Raspberry Pi before, don't know what a Windows share is, or just want to see what this is all about, check out this YouTube video:

Note that archiving the clips can take from seconds to hours depending on how many clips you've saved and how strong the WiFi signal is in your Tesla. If you find that the clips aren't getting completely transferred before the car powers down after you park or before you leave you can use the Tesla app to turn on the Climate control. This will send power to the Raspberry Pi, allowing it to complete the archival operation.

Alternatively, you can provide your Tesla account credentials and VIN in TeslaUSB's settings, which will allow it to use the Tesla API to keep the car awake while the files transfer. Instructions are available in the one step setup instructions

Contributing

You're welcome to contribute to this repo by submitting pull requests and creating issues. For pull requests, please split complex changes into multiple pull requests when feasible, use one commit per pull request, and try to follow the existing code style.

Prerequisites

Assumptions

You park in range of your wireless network.
Your wireless network is configured with WPA2 PSK access.

Hardware

Required:

Raspberry Pi Zero W: Adafruit or Amazon

Note: Of the many varieties of Raspberry Pi available only the Raspberry Pi Zero and Raspberry Pi Zero W can be used as simulated USB drives. It may be possible to use a Pi Zero with a USB Wifi adapter to achieve the same result as the Pi Zero W but this hasn't been confirmed.
A Micro SD card, at least 16 GB in size, and an adapter (if necessary) to connect the card to your computer.
A mechanism to connect the Pi to the Tesla. Either:
- A USB A/Micro B cable: Adafruit or Amazon, or
- A USB A Add-on Board if you want to plug your Pi into your Tesla like a USB drive instead of using a cable: Amazon, or
- A PCB kit if you want the lowest profile possible and you're able to solder: Sparkfun

Optional:

A case. The "Official" case: Adafruit or Amazon. There are many others to choose from. Note that the official case won't work with the USB A Add-on board or the PCB kit.
USB Splitter if you don't want to lose a front USB port. The Onvian Splitter has been reported working by multiple people on reddit.

Software

Download: Raspbian Stretch Lite

NOTE: it is highly recommended that you use the prebuilt teslausb image instead and follow the one step headless setup process.

Download and install: Etcher

MacOS: After downloading and attempting to open Etcher, you may get a security warning. Go to System Preference -> Security and Privacy -> General and click allow. If Etcher complains that it cannot write the image, start the program using sudo from the terminal using the command:

sudo /Applications/balenaEtcher.app/Contents/MacOS/balenaEtcher

Set up the Raspberry Pi

There are four phases to setting up the Pi:

Get the OS onto the Micro SD card.
Get a shell on the Pi.
Set up the archive for dashcam clips.
Set up the USB storage functionality.

There is a streamlined process for setting up the Pi which can currently be used if you plan to use Windows file shares, MacOS Sharing, or Samba on Linux for your video archive. Instructions.

If you'd like to host the archive using another technology or would like to set the Pi up, yourself, continue these instructions.

Get the OS onto the MicroSD card

These instructions tell you how to get Raspbian onto your MicroSD card. Basically:

Connect your Micro SD card to your computer.
Use Etcher to write the zip file you downloaded to the Micro SD card.

Note: you don't need to uncompress the zip file you downloaded.

Get a shell on the Pi

Follow the instructions corresponding to the OS you used to flash the OS onto the Micro SD card:

Windows: Instructions.
MacOS or Linux: Instructions.

Whichever instructions you followed above will leave you in a command shell on the Pi. Use this shell for the rest of the steps in these instructions.

Become root on the Pi

First you need to get into a root shell on the Pi:

sudo -i

You'll stay in this root shell until you run the "halt" command in the "Set up USB storage functionality" below.

Set up the archive for dashcam clips

Follow the instructions corresponding to the technology you'd like to use to host the archive for your dashcam clips. You must choose just one of these technologies; don't follow more than one of these sets of instructions:

Windows file share, MacOS Sharing, or Samba on Linux: Instructions.
SFTP/rsync: Instructions
Experimental: Google Drive, Amazon S3, DropBox, Microsoft OneDrive: Instructions

Optional: Allocate SD Card Storage

Indicate how much of the sd card you want to allocate to the car for recording dashcam footage and music by running this command:

 export camsize=<number or percentage>

For example, using export camsize=100% would allocate 100% of the space to recording footage from your car and would not create a separate music partition. export camsize=50% would allocate half of the space for a dashcam footage drive and allocates the other half to for a music storage drive, unless otherwise specified. If you don't set camsize, the script will allocate 90% of the total space to the dashcam by default. Size can be specified as a percentage or as an absolute value, e.g. export camsize=16G would allocate 16 gigabytes for dashcam footage. If you want limit music storage so it doesn't use up all the remaining storage after camera storage has been allocated, use export musicsize=<number or percentage> to specify the size. For example, if there is 100 gigabyte of free space, then

 export camsize=50%
 export musicsize=10%

would allocate 50 gigabytes for camera and 10 gigabytes for music, leaving 40 gigabytes free.

Note: since the car records about 5.5 gigabyte per hour, and throws away non-saved recordings after an hour, it is not very useful to make 'camsize' very large. In fact, it is better to use a relatively small size, so that teslausb has space to preserve recordings that are older than 1 hour, which would otherwise be discarded by the car. As an example, if your normal use case is driving to work in the morning, enabling Sentry while parked, and going back home in the evening, with the car reporting up to 10 Sentry events, then 16 GB is a good size to use. This allows the car to keep about 2 hours worth of Sentry mode recordings, in addition to the normal recordings. If you anticipate needing more space for saved recordings, for example if your car generally reports much more Sentry events, you manually save recordings a lot, or if you're going to be away from wifi for multiple days, then increase size as needed. In order for teslausb to preserve recordings older than an hour, there needs to be enough free space on the sd card, at least 'camsize' worth, preferably much more.

Optional: Configure push notification via Pushover, Gotify, IFTTT, or AWS SNS

If you'd like to receive a notification when your Pi finishes archiving clips follow these Instructions.

Optional: Configure a hostname

The default network hostname for the Pi will become teslausb. If you want to have more than one TeslaUSB devices on your network (for example you have more than one Tesla in your houseold), then you can specify an alternate hostname for the Pi by running this command:

 export TESLAUSB_HOSTNAME=<new hostname>

For example, you could use export TESLAUSB_HOSTNAME=teslausb-ModelX

Make sure that whatever you speicfy for the new hostname is compliant with the rules for DNS hostnames; for example underscore (_) is not allowed, but dash (-) is allowed. Full rules are in RFC 1178 at https://tools.ietf.org/html/rfc1178

Set up the USB storage functionality

Run these commands:

mkdir -p /root/bin
cd /root/bin
wget https://raw.githubusercontent.com/marcone/teslausb/main-dev/setup/pi/setup-teslausb
chmod +x setup-teslausb
./setup-teslausb

Run this command:
```
halt
```
Disconnect the Pi from the computer.

On the next boot, the Pi hostname will become teslausb, so future ssh sessions will be ssh pi@teslausb.local. If you specified your own hostname, be sure to use that name (for example ssh pi@teslausb-ModelX.local)

Your Pi is now ready to be plugged into your Tesla. If you want to add music to the Pi, follow the instructions in the next section.

Optional: Add music to the Pi

Note: If you set camsize to 100% then skip this step.

Connect the Pi to a computer. If you're using a cable be sure to use the port labeled "USB" on the circuitboard.

Wait for the Pi to show up on the computer as a USB drive.
Copy any music you'd like to the drive labeled MUSIC.
Eject the drives.
Unplug the Pi from the computer.
Plug the Pi into your Tesla.

Alternatively, you can configure the Pi to automatically copy from a CIFS share. To do this, define the "musicsharename" variable to point at a CIFS share and folder. The share currently must exist on the same server as the one where recordings will be backed up, and use the same credentials. The Pi will sync down ALL music it finds under the specified folder, so be sure there is enough space on the Pi's music drive. For example, if you have your music on a share called 'Music', and on that share have a folder called 'CarMusic' where you copied all the songs that you want to have available in the car, use export musicsharename=Music/CarMusic in the setup file.

Optional: Making changes to the system after setup

The setup process configures the Pi with read-only file systems for the operating system but with read-write access through the USB interface. This means that you'll be able to record dashcam video and add and remove music files but you won't be able to make changes to files on / or on /boot. This is to protect against corruption of the operating system when the Tesla cuts power to the Pi.

To make changes to the system partitions:

ssh pi@teslausb.
sudo -i
/root/bin/remountfs_rw

Then make whatever changes you need to. The next time the system boots the partitions will once again be read-only.

Optional: Using The Pi As A WiFi Access Point

To enable teslausb to act as a wifi access point with the given SSID and password, find this section in your teslausb_setup_variables.conf file and uncomment the exports. Remember to change the password to something that protects your Pi. You will not get access to the Internet but you will be able to ssh into your Pi, or access the recordings via Samba. Be careful when using this option: your AP_PASS setting is all that protects your Pi from someone remotely accessing it. To further add to the security, you may want to follow the items in the Security section that follows.

# SSID, so you can access it while on the road.
#export AP_SSID='TESLAUSB WIFI'
# Change this! The setup script will not accept the default 'password'
# Also note that the wifi password must be at least 8 characters.
#export AP_PASS='password'
# IP address is optional. The AP will give its clients IP addresses in the
# x.x.x.100-150 range so make sure you don't put the AP's IP address in
# that range.
#export AP_IP='192.168.66.1'

Security

As a little discussion of security for your Pi, please keep in mind the following items.

If WiFi Access Point is configured, the AP password needs to be worth while. Make it something better than Passw0rd, more than 8 characters. The longer the password the better. See here or here for password strength.
Change the password for the pi account. To do that, make the system RW and use the passwd command to change the password. To do that, follow the instructions below. The last command will reboot your Pi: (Starting at the pi sign-on)

   ssh pi@teslausb.local
   sudo -i
   cd bin
   ./remountfs_rw
   passwd pi
   reboot

Remember that the root user has a copy of your configuration file. Try the best you can to protect it. If your Pi is taken or car is stolen and you enabled the optional "use Tesla API to keep your car awake" feature, change your Tesla account password QUICKLY! Remember that if they don't have a "key" or your Tesla Account and Password, the car will not drive for them. Also consider activating a Drive Password on your Tesla. Its only 4 digits, but that's a lot of combinations to guess.

Alevale/teslausb