This repository holds the most current firmware for a replica of the Voltage Systems Regulator ("VSR") known from the Delorean Time Machine, fully compatible with the CircuitSetup line of props. A kit is in the works and will possibly be available here; you can, however, make your own circuit boards using the files in the Electronics folder.
 |
|---|
| Click to watch the video |
Features include
- various display modes, selectable by buttons: Pushwheel values, temperature (from directly connected sensor, or from Time Circuits Display via BTTFN), or speed (from a CircuitSetup Time Circuits Display via BTTFN)
- Time Travel sequence, triggered by button, Time Circuits Display or via MQTT
- music player: Play mp3 files located on an SD card, controlled by buttons, Time Circuits Display keypad via BTTFN, or HA/MQTT
- SD card support for custom audio files for effects, and music for the Music Player
- advanced network-accessible Config Portal for setup (http://vsr.local, hostname configurable)
- wireless communication with Time Circuits Display; used for synchronized time travels, alarm, night mode, fake power, temperature display and remote control through keypad
- Home Assistant (MQTT) support
- built-in OTA installer for firmware updates and audio files
If a previous version of the VSR firmware is installed on your device, you can update easily using the pre-compiled binary. Enter the Config Portal, click on Update, select the pre-compiled binary file ("xxx.bin") provided in the Release package, and click on Update.
If you are using a fresh ESP32 board, please see vsr-A10001986.ino for detailed build and upload information, or, if you don't want to deal with source code, compilers and all that nerd stuff, go here and follow the instructions.
After a firmware update, the "wait" symbol might be shown a bit longer while booting. Do NOT unplug the device during this time.
The firmware comes with a sound-pack which needs to be installed separately. The sound-pack is not updated as often as the firmware itself. If you have previously installed the latest version of the sound-pack, you normally don't have to re-install it when you update the firmware. Only if the VSR briefly displays "ISP" during boot, a re-installation/update of the sound-pack is needed.
The first step is to extract "sound-pack-vrXX.zip" (which is included in the Release package). It contains one file, named "VSRA.bin".
Next, head to the Config Portal, click on Update, select the "VSRA.bin" file in the bottom file selector and click on Upload.
More...
Alternatively, you can install the sound-pack the following way:
- Using a computer, copy "VSRA.bin" to the root directory of a FAT32 formatted SD card;
- power down the VSR,
- insert this SD card into the slot and
- power up the VSR; the sound-pack will be installed automatically.
The following instructions only need to be followed once, on fresh VSRs. They do not need to be repeated after a firmware update.
The first step is to establish access to the VSR's configuration web site ("Config Portal") in order to configure your VSR:
- Power up the VSR and wait until it has finished booting.
- Connect your computer or handheld device to the WiFi network "VSR-AP".
- Navigate your browser to http://vsr.local or http://192.168.4.1 to enter the Config Portal.
Your VSR knows two ways of WiFi operation: Either it creates its own WiFi network, or it connects to a pre-existing WiFi network.
As long as the VSR is unconfigured, it creates its own WiFi network named "VSR-AP". This mode of operation is called "Access point mode", or "AP-mode". or "AP-mode". In this mode, computers/handhelds can connect to your VSR in order to access the Config Portal, but ways of communication end right here. There is no inter-prop-communication (BTTFN) and no HA/MQTT.
It is ok to leave it in AP-mode, predominantly if used stand-alone. To keep operating your VSR in AP-mode, simply do not configure a WiFi network connection as described below.
More...
Please do not leave computers/handhelds permanently connected to the VSR in AP-mode. These devices might think they are connected to the internet and therefore hammer your VSR with DNS and HTTP requests which might lead to disruptions.
If you wish for your device to remain in AP-mode, please select a suitable WiFi channel on the Config Portal's "WiFi Configuration" page. See here.
In AP-mode, the VSR can switch off WiFi to save power. See here.
In this case, you can connect your VSR to your home WiFi network. This allows for inter-prop-communication (BTTFN) and HA/MQTT.
Click on "WiFi Configuration" and either select a network from the top of the page or enter a WiFi network name (SSID), and enter your WiFi password. After saving the WiFi network settings, your VSR reboots and tries to connect to your selected WiFi network.
More...
Your VSR requests an IP address via DHCP, unless you entered valid data in the fields for static IP addresses (IP, gateway, netmask, DNS). If the device is inaccessible as a result of incorrect static IPs, wait until the VSR has completed its startup sequence, then hold all three buttons until "ADM" is displayed, then hold button "4C". After "RST" has been displayed, power-down the VSR. Upon power-up, the device is reset to DHCP.
If the VSR fails to connect, it falls back to AP-mode. You can trigger another connection attempt by holding button "10" in Admin button mode.
In this case and with no Time Circuits Display at hand, keep your VSR operating in AP-mode.
If you have a TCD, you can connect your VSR to the TCD's own WiFi network.
This setup is meant for cars, but suitable for any place with no WiFi network. See here for details.
After completing WiFi setup, your VSR is ready for use; you can also continue configuring it to your personal preferences through the Config Portal.
The "Config Portal" is the VSR's configuration web site.
 |
|---|
| The Config Portal's main page |
It can be accessed as follows:
- Connect your computer or handheld device to the WiFi network "VSR-AP".
- Navigate your browser to http://vsr.local or http://192.168.4.1 to enter the Config Portal.
- (For proper operation, please disconnect your computer or handheld from VSR-AP when you are done with configuring your VSR. These devices can cause high network traffic, resulting in severe performance penalties.)
-
Connect your handheld/computer to the same (WiFi) network to which your VSR is connected, and
-
navigate your browser to http://vsr.local
More...
Accessing the Config Portal through this address requires the operating system of your handheld/computer to support Bonjour/mDNS: Windows 10 version TH2 (1511) [other sources say 1703] and later, Android 13 and later; MacOS and iOS since the dawn of time.
If connecting to http://vsr.local fails due to a name resolution error, you need to find out your VSR's IP address: Hold all three buttons until "ADM" is displayed, release all buttons and afterwards hold button "9". Your VSR will display its current IP address (a. - b. - c. - d). Then, on your handheld or computer, navigate to http://a.b.c.d (a.b.c.d being the IP address as displayed on your VSR) in order to enter the Config Portal.
In the main menu, click on "Settings" to configure your VSR.
 |
|---|
| Click for full screenshot |
A full reference of the Config Portal is here.
By default, the display shows the value selected by the pushwheels, with slight fluctuations (which can be disabled in the Config Portal). Changing the pushwheels results in the display adapting to the new value, which is done smoothly (which also can be disabled in the Config Portal).
The three-digit display can be used for the pushwheel number, temperature or speed.
In order to display temperature, a temperature sensor needs to be connected to either your VSR or your Time Circuits Display (TCD), and in the latter case your VSR needs to be connected to the TCD via BTTFN.
In order to display speed, a TCD with either a GPS receiver or a rotary encoder for speed is required, and your VSR needs to be connected to the TCD via BTTFN.
Display modes are chosen by selecting the Operation button mode, and then holding a single button until two beeps are emitted from your VSR, as described below.
Buttons can be pressed, which means a brief press-and-release, or held, meaning pressing and holding the button for 2 seconds.
There are four button modes: Light ("LGT"), Operation ("OPR"), Music Player ("MUS") and Admin ("ADM"). In order to select a button mode, two or three buttons must be held simultaneously until the display shows the selected mode.
 | Light mode |
 | Operation mode |
 | MusicPlayer mode |
 | Admin mode |
In this mode, the buttons light up when briefly pressed, and stay lit after holding a button. At the next press, the light will go off again. This mode is only for playing with the lights, the buttons have no other function.
| Brief press | Hold | |
 | Trigger time travel | Display mode: Pushwheel number |
 | Play "key3.mp3" on SD | Display mode: Temperature |
 | Play "key6.mp3" on SD | Display mode: Speed |
| Brief press | Hold | |
| Previous song | Disable shuffle mode |
| Play/Stop | Enable shuffle mode |
| Next song | Go to song #0 |
| Brief press | Hold | |
| Volume up | Display IP address |
| Volume down | Re-enable WiFi or re-try to connect to WiFi |
| Delete static IP and AP password |
Here is a cheat sheet for printing or screen-use. (Note that MacOS' preview application has a bug that scrambles the links in the document. Acrobat Reader does it correctly.)
To trigger a "time travel" stand-alone, select the Operation button mode, and press "9".
You can also connect a dedicated time travel button to your VSR; the button must connect "TT" to "3.3V" on the "Time Travel" connector. Pressing this button briefly will trigger a time travel.
Other ways of triggering a time travel are available if a Time Circuits Display is connected.
As mentioned above, your VSR can display temperature. The temperature value can come from either a connected temperature sensor, or from the TCD - if the latter has a sensor connected and is connected to your VSR via BTTFN.
The following sensor types are supported for direct (i2c) connection to your VSR:
- MCP9808 (address 0x18 - non-default),
- BMx280 (0x77),
- SI7021,
- SHT40 (0x44),
- SHT45 (0x44),
- TMP117 (0x49),
- AHT20/AM2315C,
- HTU31D (0x41 - non-default),
- MS8607,
- HDC302x (0x45 - non-default)
All of those are readily available on breakout boards from Adafruit or Seeed (Grove); the links in above list lead to tested example products.
The sensor needs to be wired as follows:
| Sensor PCB | VSR control board |
| GND or "-" | GND |
| VIN or 5V or "+" | 5V |
| SDA (SDI on BME280) |
SDA |
| SCL (SCK on BME280) |
SCL |
For longer cables, ie >50cm (>20in), I recommend using a twisted pair cable, and to connect it as follows:
Important: The VSR control board delivers and drives the i2c bus on 5V. Most sensors operate on 3.3V. Therefore, you cannot connect the chips directly to the VSR control board without a level-shifter. This goes for the power supply as well as the i2c bus signals (SDA, SCL). I only use readily available sensor breakout boards that include level-shifters.
Your VSR can also display speed, provided a TCD is connected through BTTFN, and the TCD has either a GPS receiver, or a rotary encoder configured for speed. Please see here for more information.
Preface note on SD cards: For unknown reasons, some SD cards simply do not work with this device. For instance, I had no luck with Sandisk Ultra 32GB and "Intenso" cards. If your SD card is not recognized, check if it is formatted in FAT32 format (not exFAT!). Also, the size must not exceed 32GB (as larger cards cannot be formatted with FAT32). Transcend, Sandisk Industrial, Verbatim Premium and Samsung Pro Endurance SDHC cards work fine in my experience.
The SD card, apart from being required for installing of the sound-pack, can be used for substituting built-in sound effects and for music played back by the Music player. Also, it is strongly recommended to store secondary settings on the SD card to minimize Flash Wear.
Note that the SD card must be inserted before powering up the device. It is not recognized if inserted while the VSR is running. Furthermore, do not remove the SD card while the device is powered.
The VSR's built-in sound effects can be substituted by your own sound files on a FAT32-formatted SD card. These files will be played back directly from the SD card during operation, so the SD card has to remain in the slot.
Your replacements need to be put in the root (top-most) directory of the SD card, be in mp3 format (128kbps max) and named as follows:
- "startup.mp3". Played when the VSR is connected to power and has finished booting;
- "ttstart.mp3"/"ttend.mp3". Played at the beginning/the end of a time travel sequence. (The "humm" sound cannot be substituted.)
- "alarm.mp3". Played when the alarm sounds (triggered by a Time Circuits Display via BTTFN or MQTT);
- "button.mp3", "buttonl.mp3", "button_bad.mp3": Button click sounds.
The firmware supports some additional user-provided sound effects, which it will load from the SD card. If the respective file is present, it will be used. If that file is absent, no sound will be played.
- "key1.mp3" - "key9.mp3": Will be played when you type 800x (x being 1, 3, 4, 6, 7 or 9) or 850x (1-9) on the TCD (connected through BTTFN). Additionally, "key3.mp3"/"key6.mp3" will be played when you press "10" or "4C" in Operation button mode
The seemingly odd numbering of the 800x range is because of synchronicity with other props, especially the TCD and its keymap where the Music Player occupies keys 2, 5, 8. Likewise, 8002, 8005 and 8008 control the VSR's Music Player (prev, play/stop, next).
Those files are not provided here. You can use any mp3, with a bitrate of 128kpbs or less.
Replacements and custom sounds can either be copied to the SD card using a computer, or uploaded through the Config Portal.
Uploading through the Config Portal works exactly like installing the sound-pack; on the main menu, click "UPDATE". Afterwards choose one or more mp3 files to upload using the bottom file selector, and click "UPLOAD". The firmware will store the uploaded mp3 files on the SD card.
In order to delete a file from the SD card, upload a file whose name is prefixed with "delete-". For example: To delete "key3.mp3" from the SD card, upload a file named "delete-key3.mp3"; the file's contents does not matter, so it's easiest to use a newly created empty file. The firmware detects the "delete-" part and, instead of storing the uploaded file, it throws it away and deletes "key3.mp3" from the SD card.
For technical reasons, the VSR must reboot after mp3 files are uploaded in this way.
Please remember that the maximum bitrate for mp3 files is 128kbps. Also note that the uploaded file is stored to the root folder of the SD card, so this way of uploading cannot be used to upload songs for the Music Player.
The firmware contains a simple music player to play mp3 files located on the SD card.
In order to be recognized, your mp3 files need to be organized in music folders named music0 through music9. The folder number is 0 by default, ie the player starts searching for music in folder music0. This folder number can be changed in the Config Portal or through the TCD keypad (805x).
The names of the audio files must only consist of three-digit numbers, starting at 000.mp3, in consecutive order. No numbers should be left out. Each folder can hold up to 1000 files (000.mp3-999.mp3). The maximum bitrate is 128kpbs.
Since manually renaming mp3 files is somewhat cumbersome, the firmware can do this for you - provided you can live with the files being sorted in alphabetical order: Just copy your files with their original filenames to the music folder; upon boot or upon selecting a folder containing such files, they will be renamed following the 3-digit name scheme (as mentioned: in alphabetic order). You can also add files to a music folder later, they will be renamed properly; when you do so, delete the file "TCD_DONE.TXT" from the music folder on the SD card so that the firmware knows that something has changed. The renaming process can take a while (11 minutes for 1000 files in bad cases). Mac users are advised to delete the ._ files from the SD before putting it back into the control board as this speeds up the process. While the renaming is in progress, the VSR's display shows how many files are still left to be processed.
To start and stop music playback, press button "10" while in MusicPlayer button mode. Pressing "9" jumps to the previous song, pressing "4C" to the next one. (The same can be achieved by entering codes on the TCD's keypad: 8002 = previous song, 8005 = play/stop, 8008 = next song).
By default, the songs are played in order, starting at 000.mp3, followed by 001.mp3 and so on. Holding button "10" enables Shuffle mode, button "9" disables Shuffle mode. Holding "4C" restarts the player at song number 0. The power-up Shuffle mode can be set up in the Config Portal.
See here and here for a list of controls of the music player.
While the music player is playing music, other sound effects are disabled/muted. Initiating a time travel stops the music player. The TCD-triggered alarm will, if so configured, sound and stop the music player.
The TCD can communicate with the VSR wirelessly, via the built-in "Basic-Telematics-Transmission-Framework" over WiFi. It can send out information about a time travel and an alarm, and the VSR queries the TCD for speed, temperature and some other data. Furthermore, the TCD's keypad can be used to remote-control the VSR.
 |
|---|
| Click to watch the video |
BTTFN requires the props all to be connected to the same network, such as, for example, your home WiFi network. BTTFN does not work over the Internet.
More...
The term "WiFi network" is used for both "WiFi network" and "ip subnet" here for simplicity reasons. However, for BTTFN communication, the devices must be on the same IP subnet, regardless of how they take part in it: They can be connected to different WiFi networks, if those WiFi networks are part of the same ip subnet.
In order to connect your VSR to the TCD using BTTFN, just enter the TCD's IP address or hostname in the IP address or hostname of TCD field in the VSR's Config Portal. On the TCD, no special configuration is required.
Afterwards, the VSR and the TCD can communicate wirelessly and
- play time travel sequences in sync,
- both play an alarm-sequence when the TCD's alarm occurs,
- the VSR can be remote controlled through the TCD's keypad (command codes 8xxx),
- the VSR queries the TCD for temperature and GPS speed for display,
- the VSR queries the TCD for fake power and night mode, in order to react accordingly if so configured,
- the VSR's Time Travel button can trigger a synchronized Time Travel on all BTTFN-connected devices, just like if that Time Travel was triggered through the TCD.
You can use BTTF-Network and MQTT at the same time.
| Function | Code on TCD |
| Select pushwheel display mode | 8010⏎ |
| Select temperature display mode | 8011⏎ |
| Select speed display mode | 8012⏎ |
| Set volume level (00-19) | 8300⏎ - 8319⏎ |
| Set brightness level (00-15) | 8400⏎ - 8415⏎ |
| Music Player: Play/Stop | 8005⏎ |
| Music Player: Previous song | 8002⏎ |
| Music Player: Next song | 8008⏎ |
| Music Player: Select music folder (0-9) | 8050⏎ - 8059⏎ |
| Music Player: Shuffle off | 8222⏎ |
| Music Player: Shuffle on | 8555⏎ |
| Music Player: Go to song 0 | 8888⏎ |
| Music Player: Go to song xxx | 8888xxx⏎ |
| Play "key1.mp3" | 8001⏎ / 8501⏎ |
| Play "key2.mp3" | 8502⏎ |
| Play "key3.mp3" | 8003⏎ / 8503⏎ |
| Play "key4.mp3" | 8004⏎ / 8504⏎ |
| Play "key5.mp3" | 8505⏎ |
| Play "key6.mp3" | 8006⏎ / 8506⏎ |
| Play "key7.mp3" | 8007⏎ / 8507⏎ |
| Play "key8.mp3" | 8508⏎ |
| Play "key9.mp3" | 8009⏎ / 8509⏎ |
| Display current IP address | 8090⏎ |
| Reboot the device1 | 8064738⏎ |
| Delete static IP address and WiFi-AP password1 |
8123456⏎ |
1: Not supported through HA/MQTT INJECT command
Here is a cheat sheet for printing or screen-use. (Note that MacOS' preview application has a bug that scrambles the links in the document. Acrobat Reader does it correctly.)
Note that a wired connection only allows for synchronized time travel sequences, no other communication takes place. A wireless connection over BTTFN/WiFi is much more powerful and therefore recommended over a wired connection.
For a connection by wire, connect GND and GPIO on the VSR's "Time Travel" connector to the TCD like in the table below:
| VSR | TCD with control board >=1.3 | TCD with control board 1.2 |
| GND of "Time Travel" connector | GND of "Time Travel" connector | GND of "IO14" connector |
| TT of "Time Travel" connector | TT OUT of "Time Travel" connector | IO14 of "IO14" connector |
Do not connect 3V3 to the TCD!
Next, head to the Config Portal and set the option TCD connected by wire. On the TCD, the option [TT-OUT] "signals Time Travel" must be checked.
More...
You can connect both the TCD and a button to the TT connector. However, the button should not be pressed when the option TCD connected by wire is set, as it might yield unwanted results. Also, note that the button connects to IO13 and 3_3V (not GND!).
The VSR supports MQTT protocol versions 3.1.1 and 5.0 for the following features:
The VSR can be controlled through messages sent to topic bttf/vsr/cmd. Supported commands are
- TIMETRAVEL: Start a time travel
- DISPLAY_PW: Set display mode to "pushwheels"
- DISPLAY_TEMP: Set display mode to "temperature"
- DISPLAY_SPEED: Set display mode to "speed"
- MP_PLAY: Starts the Music Player
- MP_STOP: Stops the Music Player
- MP_NEXT: Jump to next song
- MP_PREV: Jump to previous song
- MP_SHUFFLE_ON: Enables shuffle mode in Music Player
- MP_SHUFFLE_OFF: Disables shuffle mode in Music Player
- MP_FOLDER_x: x being 0-9, set folder number for Music Player
- PLAYKEY_x: Play keyX.mp3 (from SD card), X being in the range from 1 to 9.
- STOPKEY: Stop playback of keyX file. Does nothing if no keyX file is currently played back.
- INJECT_x: See immediately below.
This command allows remote control of the VSR through HA/MQTT in the same way as through the TCD keypad by injecting commands into the VSR command queue (hence the name). Commands are listed here; nearly all are supported. For example:
To set volume level to 10 (8310), issue the following command: INJECT_8310
To play "key2.mp3" (8502), issue INJECT_8502
To select the 'music1' folder (8051), issue INJECT_8051
If both TCD and VSR are connected to the same broker, and the option Publish time travel and alarm events is checked on the TCD's side, the VSR will receive information on time travel and alarm and play their sequences in sync with the TCD. Unlike BTTFN, however, no other communication takes place.
MQTT and BTTFN can co-exist. However, the TCD only sends out time travel and alarm notifications through either MQTT or BTTFN, never both. If you have other MQTT-aware devices listening to the TCD's public topic (bttf/tcd/pub) in order to react to time travel or alarm messages, use MQTT (ie check Publish time travel and alarm events). If only BTTFN-aware devices are to be used, uncheck this option to use BTTFN as it has less latency.
MQTT requires a "broker" (such as mosquitto, EMQ X, Cassandana, RabbitMQ, Ejjaberd, HiveMQ to name a few).
The broker's address needs to be configured in the Config Portal. It can be specified either by domain or IP (IP preferred, spares us a DNS call). The default port is 1883. If a different port is to be used, append a ":" followed by the port number to the domain/IP, such as "192.168.1.5:1884".
If your broker supports protocol version 3.1.1, stick with 3.1.1. Version 5.0 has no advantages, but more overhead.
If your broker does not allow anonymous logins, a username and password can be specified.
Limitations: TLS/SSL not supported; ".local" domains (MDNS) not supported; server/broker must respond to PING (ICMP) echo requests. For proper operation with low latency, it is recommended that the broker is on your local network. MQTT is disabled when your VSR is operated in AP-mode or when connected to the TCD run in AP-Mode (TCD-AP).
If your VSR, along with a Time Circuits Display, is mounted in a car, the following network configuration is recommended:
- Run your TCD in car mode;
- disable WiFi power-saving on the TCD by setting Power save timer to 0 (zero) in the "AP-mode settings" section on the WiFi Configuration page.
Enter the Config Portal on the VSR, click on Setup and
- enter 192.168.4.1 into the field IP address or hostname of TCD under BTTFN settings;
- click on Save.
After the VSR has restarted, re-enter the VSR's Config Portal (while the TCD is powered and in car mode) and
- click on WiFi Configuration,
- select the TCD's access point name in the list at the top ("TCD-AP"; if there is no list, click on "WiFi Scan") or enter TCD-AP into the Network name (SSID) field; if you password-protected your TCD's AP, enter this password in the password field. Leave all other fields empty,
- click on Save.
In order to access the VSR's Config Portal in your car, connect your handheld or computer to the TCD's WiFi access point ("TCD-AP"), and direct your browser to http://vsr.local ; if that does not work, go to the TCD's keypad menu, press ENTER until "BTTFN CLIENTS" is shown, hold ENTER, and look for the VSR's IP address there; then direct your browser to that IP by using the URL http://a.b.c.d (a-d being the IP address displayed on the TCD display).
This "car setup" can also be used in a home setup with no local WiFi network present.
The Config Portal offers an option for WiFi power saving for AP-mode (ie when the device acts as an access point). This option configures a timer after whose expiration WiFi is switched off; the device is no longer transmitting or receiving data over WiFi.
The timer can be set to 0 (which disables it; WiFi is never switched off; this is the default), or 10-99 minutes.
After WiFi has been switched off due to timer expiration, it can be re-enabled by holding button "10" in Admin button mode, in which case the timers are restarted (ie WiFi is again switched off after timer expiration).
Holding "10" in Admin button mode also triggers a re-connection attempt in case your configured WiFi network was not available when the VSR was trying to connect, see here.
Flash memory has a somewhat limited lifetime. It can be written to only between 10.000 and 100.000 times before becoming unreliable. The firmware writes to the internal flash memory when saving settings and other data. Every time you change settings, data is written to flash memory.
In order to reduce the number of write operations and thereby prolong the life of your VSR, it is recommended to use a good-quality SD card and to check Save secondary settings on SD in the Config Portal; secondary settings are then stored on the SD card (which also suffers from wear but is easy to replace). See here for more information.
This leads to the WiFi configuration page
This leads to the Settings page.
This leads to the HomeAssistant/MQTT Settings page.
This leads to the firmware and audio update page.
In order to upload a new firmware binary (such as the ones published here in the install/ folder), select that image file in the top file selector and click "Update".
You can also install the VSR's sound-pack on this page; download the current sound-pack, extract it and select the resulting VSRA.bin file in the bottom file selector. Finally, click "Upload". Note that an SD card is required for this operation.
Note that either a firmware or audio data can be uploaded at once, not both at the same time.
Finally, this page is also for uploading custom or replacement sound files to the SD card. Select an mp3 file in the bottom file selector and click upload. (Requires firmware 1.15 or later. Maximum 16 files at a time.)
Through this page you can either connect your VSR to your local WiFi network, or configure AP mode.
In order to connect your VSR to your WiFi network, all you need to do is either to click on one of the networks listed at the top or to enter a Network name (SSID), and optionally a password (WPAx). If there is no list displayed, click on "WiFi Scan".
By default, the VSR requests an IP address via DHCP. However, you can also configure a static IP for the VSRC by entering the IP, netmask, gateway and DNS server. All four fields must be filled for a valid static IP configuration. If you want to stick to DHCP, leave those four fields empty. If you connect your VSR to your Time Circuits Display acting as access point ("TCD-AP"), leave these all empty.
Checking this box (and clicking SAVE) deletes the currently saved WiFi network (SSID and password as well as static IP data) and reboots the device; it will restart in "access point" (AP) mode. See here.
The device's hostname in the WiFi network. Defaults to 'vsr'. This also is the domain name at which the Config Portal is accessible from a browser in the same local network. The URL of the Config Portal then is http://hostname.local (the default is http://vsr.local).
If you have more than one VSR in your local network, please give them unique hostnames.
This setting applies to both AP-mode and when your VSR is connected to a WiFi network.
Number of times the firmware tries to reconnect to a WiFi network, before falling back to AP-mode. See here
Number of seconds before a timeout occurs when connecting to a WiFi network. When a timeout happens, another attempt is made (see immediately above), and if all attempts fail, the device falls back to AP-mode. See here
By default, when your VSR creates a WiFi network of its own ("AP-mode"), this network is named "VSR-AP". In case you have multiple VSRs in your vicinity, you can have a string appended to create a unique network name. If you, for instance, enter "-ABC" here, the WiFi network name will be "VSR-AP-ABC". Characters A-Z, a-z, 0-9 and - are allowed.
By default, and if this field is empty, the VSR's own WiFi network ("VSR-AP") will be unprotected. If you want to protect your VSR access point, enter your password here. It needs to be 8 characters in length and only characters A-Z, a-z, 0-9 and - are allowed.
If you forget this password and are thereby locked out of your VSR, select Admin button mode, and hold "4C"; "RST" will be displayed, and your WiFi password is deleted. Then power-down and power-up your VSR and the access point will start unprotected.
Here you can select one out of 11 channels, or have the VSR choose a random channel for you. The default channel is 1. Preferred are channels 1, 6 and 11.
WiFI channel selection is key for a trouble-free operation. Disturbed WiFi communication can lead to disrupted sequences, packet loss, hanging or freezing props, and other problems. A good article on WiFi channel selection is here.
If a WiFi Scan was done (which can be triggered by clicking "WiFI Scan"),
- a list of networks is displayed at the top of the page; click "Show All" to list all networks including their channel;
- a "proposed channel" is displayed near the "WiFi channel" drop-down, based on a rather simple heuristic. The banner is green when a channel is excellent, grey when it is impeded by overlapping channels, and when that banner is red operation in AP mode is not recommended due to channels all being used.
The channel proposition is based on all WiFi networks found; it does not take non-WiFi equipment (baby monitors, cordless phones, Bluetooth devices, microwave ovens, etc) into account.
See here.
If this option is checked, the display follows pushwheel changes smoothly, ie in several steps. If this is unchecked, the display follows the pushwheels immediately.
If this option is checked, the displayed pushwheel value slightly and randomly fluctuates. If this option is unchecked, the pushwheel value is statically displayed, without any fluctuations.
If this is checked, the VSR briefly shows the current button mode upon power-up.
If this is checked, the button lights permanently reflect the current button mode, except for light mode.
If other props are connected, they might bring their own time travel sound effects. In this case, you can uncheck this to disable the VSR's own time travel sounds. Note that this only covers sounds played during time travel, not other sound effects.
If a TCD is connected via BTTFN or MQTT, the VSR visually signals when the TCD's alarm sounds. If you want the VSR to play an alarm sound, check this option.
This selects the brightness level for the LED display.
Enter the number of minutes until the Screen Saver should become active when the VSR is idle.
The Screen Saver, when active, disables all lights and the display, until
- a button on the VSR pressed,
- the time travel button is briefly pressed (the first press when the screen saver is active will not trigger a time travel),
- on a connected TCD, a destination date is entered (only if TCD is wirelessly connected) or a time travel event is triggered (also when wired).
The music player will continue to run.
Selects the current music folder, can be 0 through 9.
This can also be set/changed through a TCD keypad via BTTFN (8050 - 8059). Such a change will be saved immediately.
When checked, songs are shuffled when the device is booted. When unchecked, songs will be played in order.
Shuffle mode can be changed at any time through the VSR's buttons in MusicPlayer button mode or via TCD (8222/8555); however, a change through buttons or TCD is not saved.
If this is checked, the LED display is switched off in night mode. Otherwise, it will be dimmed.
Selects between Fahrenheit and Celsius for temperature display. This setting is used for temperature both from a sensor connected to the VSR as well as temperature transmitted by a TCD.
This offset, which can range from -3.0 to 3.0, is added to the sensor measurement, in order to compensate sensor inaccuracy or suboptimal sensor placement. This offset is only applied to a value read from a sensor connected to the VSR, and ignored when temperature is transmitted from a TCD; the TCD has its own Offset setting which is applied to the temperature reading before transmission.
If you want to have your VSR to communicate with a Time Circuits Display wirelessly ("BTTF-Network"), enter the TCD's hostname - usually 'timecircuits' - or IP address here.
If you connect your VSR to the TCD's access point ("TCD-AP"), the TCD's IP address is 192.168.4.1.
If this option is checked, and your TCD goes into night mode, the VSR will disable or dim the display and the button lights, and reduce its audio volume.
If this option is checked, and your TCD is equipped with a fake power switch, the VSR will also fake-power up/down. If fake power is off, the VSR will be dark and it will ignore all input from buttons.
If the VSR is connected to a TCD through BTTFN, this option allows to trigger a synchronized time travel on all BTTFN-connected devices when pressing "9" in Operation button mode, or pressing the Time Travel button, just as if the time travel was triggered by the TCD. If this option is unchecked, these actions only trigger a time travel sequence on the VSR.
If this is checked, the VSR ignores network-wide (BTTFN, MQTT) time travels. After all, the VSR is never shown in the movies during a time travel, so its behavior is uncertain. If you don't like the made-up time travel sequence, check this option.
Check this if you have a Time Circuits Display connected by wire. Note that a wired connection only allows for synchronized time travel sequences, no other communication takes place.
While you can connect both a button and the TCD to the "time travel" connector on the VSR, the button should not be pressed when this option is set, as it might yield unwanted effects.
Do NOT check this option if your TCD is connected wirelessly (BTTFN, MQTT).
Usually, the TCD signals a time travel with a 5 second lead, in order to give a prop a chance to play an acceleration sequence before the actual time travel takes place. Since this 5 second lead is unique to CircuitSetup props, and people sometimes want to connect third party props to the TCD, the TCD has the option of skipping this 5 second lead. If that is the case, and your VSR is connected by wire, you need to set this option.
If your VSR is connected wirelessly, this option has no effect.
If this is checked, secondary settings (volume, brightness, button mode) are stored on the SD card (if one is present). This helps to minimize write operations to the internal flash memory and to prolong the lifetime of your VSR. See Flash Wear.
Apart from Flash Wear, there is another reason for using an SD card for settings: Writing data to internal flash memory can cause delays of up to 1.5 seconds, which interrupt sound playback and have other undesired effects. The VSR needs to save data from time to time, so for a smooth experience without unexpected and unwanted delays, please use an SD card and check this option.
It is safe to have this option checked even with no SD card present.
If you want copy settings from one SD card to another, do as follows:
- With the old SD card still in the slot, enter the Config Portal, turn off Save secondary settings on SD, and click "SAVE".
- After the VSR has rebooted, power it down, and swap the SD card for your new one.
- Power-up the VSR, enter the Config Portal, re-enable Save secondary settings on SD, and click "SAVE".
This procedure ensures that all your settings are copied from the old to the new SD card.
If checked, the VSR will connect to the broker (if configured) and send and receive messages via MQTT
The broker server address. Can be a domain (eg. "myhome.me") or an IP address (eg "192.168.1.5"). The default port is 1883. If different port is to be used, it can be specified after the domain/IP and a colon ":", for example: "192.168.1.5:1884". Specifying the IP address is preferred over a domain since the DNS call adds to the network overhead. Note that ".local" (MDNS) domains are not supported.
The firmware supports MQTT 3.1.1 and 5.0. There is no difference in features, so there is no advantage in selecting 5.0. This was implemented only for brokers that do not support 3.1.1.
The username (and optionally the password) to be used when connecting to the broker. Can be left empty if the broker accepts anonymous logins.
Text & images: (C) Thomas Winischhofer ("A10001986"). See LICENSE. Source: https://vsr.out-a-ti.me
Other props: Time Circuits Display ... Flux Capacitor ... SID ... Dash Gauges ... Remote Control ... TFC