This repository holds the firmware for a modified Crosley CR-9 radio/cassette player. The CR-9 is inspired by the Seeburg Wall-O-Matic 100 3W1, which were used as props in Lou's Cafe in BTTF part 1.
First things first: Why not go with a movie-accurate Seeburg?
- They are quite unsuitable for modification without major butchering. Ruining something that is a highly valued collector's item appeared inappropriate to me given the small role the prop plays in the movie. Leave it to the Jukebox crowd.
- There is no room for a speaker, and no way for a speaker to release sound to the outside. Usually, when originals are "converted" into mp3 players, people use external speakers - which I wanted to avoid. There are no speakers anywhere in Lou's Cafe.
- The entire enclosure is made of metal, including the back plate. WiFi is seriously impeded.
- They are expensive and often optically and mechanically in dire straits, given their age.
So, I decided to go with the Crosley CR-9 instead. Modification instructions are here.
Firmware features include
- Three modes of operation:
- Music Player for playing mp3 files stored on SD card; capacity 2000 tracks, organized in 20 folders, 100 tracks each
- basic audio streaming (ShoutCast ICY over HTTP; audio/mpeg only, maximum bitrate 128kbps; HTTPS not supported)
- Remote Mode: The Jukebox can remote control other music players through HA/MQTT
- Jog dials for track and stream selection, organized Jukebox-style (letter and number)
- advanced network-accessible Config Portal for setup (http://jb.local)
- wireless communication with Time Circuits Display; used for remote control through TCD keypad
- Home Assistant (MQTT) support. Used for remote-controlling the Jukebox, as well as for the Jukebox to control third-party HA/MQTT-aware media players in Remote Mode.
- built-in OTA installer for firmware updates
For information on installing or updating the firmware of your Jukebox, see here.
The following instructions only need to be followed once, on fresh Jukeboxes. They do not need to be repeated after a firmware update.
The first step is to establish access to the Jukebox's configuration website ("Config Portal"):
- Power up your Jukebox and wait a few seconds.
- Connect your computer or handheld device to the WiFi network "JB-AP".
- Navigate your browser to http://jb.local or http://192.168.4.1 to enter the Config Portal.
Your Jukebox 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 your Jukebox is unconfigured, it creates its own WiFi network named "JB-AP". This mode of operation is called "Access point mode" or "AP-mode". In this mode, computers/handhelds can connect to your Jukebox in order to access the Config Portal, but ways of communication end right here. There is no inter-prop-communication (BTTFN), no HA/MQTT and no streaming.
It is ok to leave it in AP-mode, predominantly if used stand-alone. To keep operating your Jukebox 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 Jukebox in AP-mode. These devices might think they are connected to the internet and therefore hammer the Jukebox 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 Jukebox can switch off WiFi to save power. See here.
In this case, you can connect your Jukebox to your home WiFi network. This allows for inter-prop-communication (BTTFN) and HA/MQTT. If your home WiFi has internet access, streaming is possible.
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 Jukebox reboots and tries to connect to your selected WiFi network.
More...
If there are several APs with identical SSID nearby, the Jukebox will connect to the first one found which might not be the nearest/strongest. It is therefore recommended to select a specific AP by its BSSID (AP's MAC address). You can either manually find out your AP's BSSID and enter it or have it filled out automatically: Click "Scan for networks", then "Show all". If you click on an AP, its BSSID will be copied into BSSID field in the form below. To see which AP is which, hover over the name to see its BSSID as a tooltip.
Your Jukebox 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, hold the bottom knob for 5 seconds while fake-power is off; static IP data will be deleted and the device will return to DHCP after rebooting.
If the Jukebox fails to connect, it falls back to AP-mode. You can trigger another connection attempt by holding the middle knob for 2 seconds while fake-power is off.
In this case and with no Time Circuits Display at hand, keep your Jukebox operating in AP-mode.
If you have a TCD, you can connect your Jukebox to the TCD's own WiFi network:
After completing WiFi setup, your Jukebox is ready for use; you can also continue configuring it to your personal preferences through the Config Portal.
The "Config Portal" is the Jukebox'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 "JB-AP".
- Navigate your browser to http://jb.local or http://192.168.4.1 to enter the Config Portal.
- (For proper operation, please disconnect your computer or handheld from JB-AP when you are done with configuring your Jukebox. These devices can cause high network traffic, resulting in severe performance penalties.)
-
Connect your handheld/computer to the same (WiFi) network to which the Jukebox is connected, and
-
navigate your browser to http://jb.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://jb.local fails due to a name resolution error, you need to find out the Jukebox' IP address: While fake power is off, press the middle button ("Jog dial 1") and listen, the IP address will be spoken out loud. Then, on your handheld or computer, navigate to http://a.b.c.d (a.b.c.d being the IP address as read out loud by the Jukebox) in order to enter the Config Portal.
A full reference of the Config Portal is here.
The Jukebox is basically a music player or a remote control for external Music Players. It is controlled by three knobs. These knobs are called "Power button", "Jog dial 1" and "Jog dial 2". All three can be turned as well as pressed.
Buttons can be pressed or held. Pressing means pressing and releasing the button within less than 2 seconds. Holding a button means holding it pressed-down for 2 seconds or longer.
The top-most knob ("Power button") is used for fake-power, mode switching and volume:
- Pressing the power button while the unit is fake-off switches fake-power on.
- Pressing the power button while the unit is fake-on switches between Music Player, streaming and Remote mode. The first press within 5 seconds announces the current mode, and following press advances the mode of operation.
- Holding it for 2 seconds while fake power is on fake-powers it off.
- Turning the knob adjusts the volume level.
The jog dials' functions differ depending on fake-power.
When fake-power is on:
Middle knob ("Jog dial 1"):
- Turning the knob selects the Jukebox letter
- pressing the knob stops, or starts play-back at the selected track/stream.
- holding the knob down for 2 seconds toggles "shuffle"
Bottom knob ("Jog dial 2"):
- Turning the knob selects the Jukebox number
- pressing the knob advances playback to the next track/stream unless letter or number have been changed and don't display the currently played track/stream, in which case pressing the button starts playback of the selected track (like the middle knob)
- holding the knob down for 2 seconds jumps back to the previous track/stream
When fake-power is off:
Middle knob ("Jog dial 1"):
- Pressing the knob briefly tells you the current IP address
- Holding the knob down for 2 seconds reconnects WiFi, or re-activates the WiFi AP when in power-save mode.
Bottom knob ("Jog dial 2"):
- Pressing the knob starts music folder selection:
- The current folder is displayed in the panel (A-K, 1-10)
- Turning the knob allows changing the music folder. Only folders that actually exist and contain music files can be selected.
- Pressing the knob again selects the currently lit folder and finalizes folder selection.
- Holding the knob down for 5 seconds deletes the static IP and WiFi AP password and, in case either was set, reboots; the top red light starts blinking after 2 seconds to warn
Here is a cheat sheet for printing or screen-use.
The Music Player plays mp3 files located on the SD card. The maximum bitrate is 128kpbs. An excellent utility to re-encode your MP3 files in batches is Adapter, available for Mac and Windows.
To be recognized, your mp3 files need to be organized in music folders named musicA through musicK and music1 through music10. The default folder number is musicA. The folder can be changed using the jog dial 2 as described above.
When copying tracks to the SD card, it is recommended to use the following naming scheme:
musicX/A_01_xxxx.mp3
musicX/A_02_xxxx.mp3
...
musicX/A_10_xxxx.mp3
musicX/B_01_xxxx.mp3
...
musicX/B-10_xxxx.mp3
...
musicX/K-10_xxxx.mp3
When the firmware finds a fresh music folder, it sorts the files alphabetically and renames them to an internally used format which has audio files named 000.mp3 through 099.mp3.
You can also add files to a music folder later; 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 new files will be added in alphabetical order.
By default, the tracks are played in order, starting at A-1, followed by A-2 and so on. By holding jog dial 1 you can toggle shuffle mode, in which mode the tracks are played in random order. Shuffle mode is saved and persistent.
Due to memory and CPU speed limitations, the streaming feature is, unfortunately, somewhat limited:
- Only MPEG-1, MPEG-2, MPEG 2.5 (Layer I, Layer II, Layer III a.k.a. MP3) at <= 128kbps are supported,
- only http (not https) is supported; however, many streams broadcast on both, so try http even if the links says https.
- a good WiFi and internet connection is required due to a small buffer.
The stream URLs are configured in the Config Portal under Streaming Settings.
Streams are selected like tracks in Music Player mode.
In Remote Mode, the Jukebox can control a remote HomeAssistant/MQTT-enabled music player.
The MQTT topics and messages for control are configured in the Config Portal under HA/MQTT Settings.
If the remote player supports a somewhat complete backchannel, track selection works just like in Music Player mode: Jog dials 1 and 2 select letter and number, pressing the button selects the chosen track and starts play-back. If there is no compatible backchannel, only "play", "stop", "next" and "prev" are supported through the jog dials.
Only SD/SDHC/SDXC cards up to 32GB are supported. Card needs to be FAT32-formatted (not exFAT). Transcend, Sandisk Ultra and Industrial, Verbatim Premium and Samsung Pro Endurance SDHC cards usually work fine. Some SD cards might not be recognized due to off-specs initialization quirks. SDUC cards are not supported.
The SD card must be inserted before powering up the device. It is not recognized if inserted while the Jukebox is running. Furthermore, do not remove the SD card while the device is powered.
Since the SD card on the control board is inaccessible after assembling the Jukebox, installing a microSD extension (like this one) is recommended.
The Jukebox's built-in sound effects can be substituted by your own sound files stored on the 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:
- "alarm.mp3". Played when the alarm sounds (triggered by a Time Circuits Display via BTTFN or MQTT);
- "volchg.mp3": Played when using the volume knob to change volume level when no other sound is played
The following sounds are time-sync'd to display action. If you decide to substitute these with your own, be prepared to lose synchronicity:
- "startup.mp3". Played when the Jukebox is connected to power and finished booting
Replacements can either be uploaded through the Config Portal or copied to the SD card’s root folder using a computer.
Uploading through the Config Portal works exactly like installing the sound-pack; on the main menu, click "Update & Upload". 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.
To delete a file from the SD card, upload a file whose name is prefixed with "delete-". For example: To delete "startup.mp3" from the SD card, upload a file named "delete-startup.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 "startup.mp3" from the SD card.
For technical reasons, the Jukebox must reboot after mp3 files are uploaded in this way.
The maximum bitrate for mp3 files is 128kbps.
The uploaded files are stored to the root folder of the SD card, so this way of uploading cannot be used to upload music for the Music Player.
The TCD can communicate with the Jukebox 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 Jukebox queries the TCD for some status data. Furthermore, the TCD's keypad can be used to remote-control the Jukebox.
BTTFN requires the props all to be connected to the same network, such as, for example, your home WiFi network, or the TCD acting as access point. 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.
To connect your Jukebox to the TCD, just enter the TCD's hostname - usually "timecircuits" - in the Hostname or IP address of TCD field in the Jukebox's Config Portal. On the TCD, no special configuration is required.
Afterwards, the Jukebox and the TCD can communicate wirelessly and
- the Jukebox can be remote controlled through the TCD's keypad (command codes 5xxx),
- the Jukebox queries the TCD for night mode, in order to react accordingly if so configured,
- the devices play time travel sequences in sync,
- the Jukebox plays an alarm-sequence when the TCD's alarm occurs.
| Command sequences | |
| Function | Code on TCD |
| Select Music Player mode | 5020 |
| Select Streaming Mode | 5021 |
| Select Remote Mode | 5022 |
| Select audio volume level (0-20) | 5300-5320 |
| Select music folder for Music Player (A-K:50-59, 1-10:60-69) | 5050-5069 |
| Shuffle off (for Music Player and Remote mode) | 5222 |
| Shuffle on (for Music Player and Remote mode) | 5555 |
| Go to track/stream A-1 | 5888 |
| Go to track/stream x-y (x=01-10 where 01=A; y=01-10) | 588xxyy |
| Say current IP address | 5090 |
| Reboot the device (**) | 5064738 |
| Toggle firmware update signals at power-up | 5053281 |
| Delete static IP address and AP WiFI password (**) | 5123456 |
Here is a cheat sheet for printing or screen-use.
By means of MQTT, the Jukebox can
- remote control MQTT-enabled music players, and
- be remote controlled through commands sent to bttf/hostname/cmd (default bttf/jb/cmd).
The Jukebox supports MQTT protocol versions 3.1.1 and 5.0.
This is explained here.
The Jukebox can be controlled through messages sent to topic bttf/hostname/cmd, by default bttf/jb/cmd. Supported commands are
MODE_MP: Switch to Music Player modeMODE_STREAM: Switch to streaming modeMODE_REMOTE: Switch to Remote ModePLAY: Start the Music Player or streaming, or send a "play" command to the remote controlled music playerSTOP: Stop the Music Player or streaming, or send a "stop" command to the remote controlled music playerNEXT: Jump to next track/stream, or send a "next" command to the remote controlled music playerPREV: Jump to previous track/stream, or send a "previous" command to the remote controlled music playerSHUFFLE_ON: Enables shuffle mode for Music Player or the remote controlled music playerSHUFFLE_OFF: Disables shuffle mode for Music Player or the remote controlled music playerFOLDER_x: Set folder for Music Player (x=A-K[I is skipped] or0-9; for exampleFOLDER_ForFOLDER_7)GOTO_x-y: Goto track/stream x-y (x=A-K, y=1-10; for exampleGOTO_A-10), or send "goto" command to remote controlled music playerVOLUME_SET_x: Set audio volume to x% (0-100).VOLUME_UP,VOLUME:DOWN: Increase/decrease audio volume a notch.POWER_CONTROL_ON: Take over Fake-Power control; POWER_xx commands now control Fake-Power.POWER_CONTROL_OFF: Release Fake-Power controlPOWER_ON,POWER_OFF: Switch Fake-Power on or off, respectively.NIGHTMODE_ON,NIGHTMODE_OFF: Switches night mode on/off. These commands are only executed if no TCD is connected through BTTFN, or the option Follow TCD night-mode is unchecked in the Config Portal.
MQTT requires a "broker" such as mosquitto, Cassandana, RabbitMQ, Ejjaberd, HiveMQ or EMQX, to name a few. For proper operation with low latency, running the broker on your local network is recommended.
The broker's address needs to be configured in the Config Portal. It can be specified by either domain or IP (IP preferred). 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, Bonjour) not supported; the machine running the broker must respond to PING (ICMP) echo requests. MQTT is disabled when your Jukebox is operated in AP-mode or when connected to the TCD run in AP-Mode (TCD-AP).
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 the middle knob for 2 seconds while fake-power is off, in which case the timers are restarted (ie WiFi is again switched off after timer expiration).
This procedure is also used to trigger a re-connection attempt in case your configured WiFi network was not available when the Jukebox 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 Jukebox, 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.
If a previous version of the Jukebox firmware is installed on your device, you can update easily using the pre-compiled binary. Enter the Config Portal, click on "Update & Upload", select the pre-compiled binary file ("jukebox-A10001986-Vx.xxx.bin") provided in the Release package, and click on Update.
Installing on a fresh ESP32...
If you are using a fresh ESP32, please go here and follow the instructions or - if you are a nerd and want to deal with source code, compilers'n'stuff - see jukebox-A10001986.ino for detailed build and upload information.After a firmware update, the red LED might blink for short while after reboot. 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. There will be a message in the Config Portal and a respective signal at startup when/if the sound-pack needs to be updated.
Installing the sound-pack requires an SD card.
The first step is to extract "sound-pack-jbXX.zip" (which is included in every Release package). It contains one file, named "JBA.bin".
Next, head to the Config Portal, click on "Update & Upload", select the "JBA.bin" file in the bottom file selector and click on Upload.
Alternative way
Alternatively, you can install the sound-pack the following way: - Using a computer, copy "JBA.bin" to the root directory of a FAT32 formatted SD card; - power down the Jukebox, - insert this SD card into the slot and - power up the Jukebox; the sound-pack will be installed automatically.This leads to the WiFi configuration page
This leads to the Settings page.
This leads to the Streaming Settings page.
This leads to the HomeAssistant/MQTT Settings page.
This leads to the firmware update and audio upload page.
To upload a new firmware, such as published in the Release packages, select the "jukebox-A10001986-Vx.xxx.bin" file as contained in the Release package in the top file selector and click Update.
You can also install the Jukebox's sound-pack on this page; download the sound-pack (which is included in every Release package), extract it and select the resulting JBA.bin file in the bottom file selector. Finally, click Upload. An SD card is required for this operation.
See also here.
Finally, this page is also for uploading replacement sound files to the SD card. Select an mp3 file in the bottom file selector and click Upload. (Maximum 16 files at a time.)
Through this page you can either connect your Jukebox to your local WiFi network or configure AP mode.
To connect your Jukebox 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 "Scan for Networks".
By default, the Jukebox requests an IP address via DHCP. However, you can also configure a static IP for the Jukebox 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 there are several APs with identical SSID nearby, the Jukebox will connect to the first one found, which might not be the one with the strongest signal. It is therefore recommended to select the nearest/strongest AP by its BSSID (AP's MAC address). You can either manually find out your AP's BSSID and enter it or have it filled out automatically: Click "Scan for networks", then "Show all". If you click on an AP, its BSSID will be copied into BSSID field in the form below. To see which AP is which, hover over the name to see its BSSID as a tooltip.
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 'jb'. 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://jb.local)
The hostname is also used in MQTT topic names: The command topic is bttf/hostname/cmd, the backchannel bttf/hostname/mpstatus.
If you have more than one Jukebox in your local network, please give them unique hostnames.
This setting applies to both AP-mode and when your Jukebox 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
By default, when your Jukebox creates a WiFi network of its own ("AP-mode"), this network is named "JB-AP". In case you have multiple Jukeboxs 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 "JB-AP-ABC". Characters A-Z, a-z, 0-9 and - are allowed.
By default, and if this field is empty, the Jukebox's own WiFi network ("JB-AP") will be unprotected. If you want to protect your Jukebox 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 Jukebox, hold the bottom knob for 5 seconds while fake-power is off; this deletes the WiFi password and reboots. The access point will start unprotected.
Here you can select one out of 11 channels or have the Jukebox 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 "Scan for Networks"),
- 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 Jukebox will, in Music Player mode, play typical Jukebox sound effects when playback is started and stopped, and between tracks.
If a TCD is connected via BTTFN or MQTT, the Jukebox visually signals when the TCD's alarm sounds. If you want the Jukebox to play an alarm sound, check this option. Note that the alarm sound is only played if no other sound is played back at the moment of the alarm.
If this option is checked, the Jukebox will will turn on the blue light in Night mode. Otherwise it will remain dark.
If you want to have your Jukebox to communicate with a Time Circuits Display wirelessly ("BTTF-Network"), enter the TCD's hostname - usually 'timecircuits' - or IP address here. Hostname is preferred because it makes the setup independent of the network environment.
If this option is checked and your TCD goes into night mode, the Jukebox will turn off it's menu illumination and reduce audio volume.
If this option is checked, the Jukebox will ignore time travels on the TCD. If unchecked, the Jukebox will "turn blue" during a temporal displacement.
If this is checked, secondary settings (eg. volume) 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 Jukebox. 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 Jukebox 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 Jukebox has rebooted, power it down, and swap the SD card for your new one.
- Power-up the Jukebox, 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 this option is checked, the Jukebox waits for fake-power on upon startup. If this option is unchecked, the Jukebox fake-powers on automatically.
The MQTT options HA controls Fake-Power at startup in combination with Wait for POWER_ON at startup can overrule this setting.
On this page the internet stream URLs are configured.
Due to memory and CPU speed limitations
- only MPEG-1, MPEG-2, MPEG 2.5 (Layer I, Layer II, Layer III a.k.a. MP3) at up to 128kbps are supported,
- only http (not https) is supported; however, many streams broadcast on both, so try http even if the published links says https.
If checked, the Jukebox 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 a 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. ".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.
This option enables the Jukebox's backchannel, used in Music Player mode. This option has nothing to do with the Jukebox remote-controlling other players, but rather remote-controlling the Jukebox itself.
The backchannel carries feedback and status information on the Music Player which can be used to comfortably remote-control the Jukebox's Music Player through HomeAssistant/MQTT. Note that this backchannel is only active in Music Player mode.
This option should be left unchecked if you do not intend to remote control your Jukebox through HA/MQTT.
Backchannel data is sent to bttf/hostname/mpstatus on every change. It can also be triggered at any point by sending MP_REQSTATUS to bttf/hostname/cmd. The hostname is configured on the WiFi Settings page, and defaults to jb. If you have more than one Jukebox, you must give them unique hostnames.
The data published on the backchannel is a JSON object, containing the following keys:
- S: State. Value can be "P" for playing, "I" for idle, and "O" for off/busy. In 'off' state, the Jukebox does not take commands.
- C: Current track. Value is a Jukebox term such as "C-8" as a string.
- L: Last track. This tells the remote control the last and highest possible track. Value is a Jukebox term such as "K-10" as a string.
- V: Volume. This is an integer as a string. If -1, volume control is unavailable. Otherwise 0-100.
- SH: Shuffle. This is an integer as a string, either "0" for 'off', or "1" for 'on'.
Example: {"S":"I","C":"D-8","V":"20","L":"K-10","SH":"0"}
This option selects whether HA should be in control of Fake-Power at startup or not. If this is checked, the Jukebox assumes HA has control of Fake-Power, overruling the built-in Fake-Power button. If this is unchecked, Fake-Power control remains with the button, and HA can take over only after sending POWER_CONTROL_ON.
If HA is configured to have Fake-Power control at startup (as per the option HA controls Fake-Power at startup), this option decides the state of Fake-Power at startup:
If this option is checked, the Jukebox waits for a POWER_ON command from HA/MQTT.
If this option is unchecked, the Jukebox starts without waiting.
If both this and the option HA controls Fake-Power at startup are checked, the Jukebox will switch Fake-Power on if a connection to the broker can't be established within 45 seconds after booting.
In "Remote Mode", the Jukebox can control an external media player by sending MQTT commands to pre-configured topics, and it expects feedback and status information on a backchannel.
The Jukebox knows two alternative addressing schemes for tracks:
- Jukebox numbering: Consists of a letter and a number, separated by space, underscore or dash(minus). The option Jukebox-style numbering includes letters I and O determines whether the remote player includes those letter or those are skipped.
- Track number: Is an actual number.
If track numbers are used, the conversion formula between letter/number track selection and the actual track number is (letter * 10) + (number - 1), where letter is A=0 and counted up to 9, and number is 1 through 10.
Insert in those fields the MQTT topics and messages ("payloads") for the commands to be sent the the remote player. Messages can be empty, if the topic contains the complete command. You can fill in plain strings or, for the message, also JSON objects.
For the 'goto' command, topic and/or message can contain placeholders which will be replaced accordingly:
{N}is a track number (without leading zeros){NNN}is a three digit track number (which will be between 0 and 99 only, but padded with leading zeros){NNNN}is a four digit track number (which will be between 0 and 99 only, but padded with leading zeros){JL}is the jukebox letter{JN}is the jukebox number (1-10){JNN}is the jukebox number with leading zero (01-10)
Examples:
If your player expects a JSON object and uses track numbers: {"goto":{N}}
If your player expects a JSON object and uses Jukebox numbering: {"goto":"{JL}-{JN}"}
If your player expects a plain string and uses Jukebox numbering: GOTO_{JL}_{JN}
If the topic for 'volume down' is not empty, it is assumed that 'volume up' and 'volume down' are in fact commands to increase/decrease the volume. If 'volume down' is empty, it is assumed that the command in 'volume up' is in fact 'volume set'. In that case, topic and/or message can contain placeholders which will be replaced accordingly:
{P}for volume percentage (0 - 100){F}for volume fraction (0.0 - 1.0)
Examples:
JSON, volume as fraction: {"volume":{F}}
Plain string, volume as percentage: VOLUME_{P}
For CircuitSetup/A10001986 props (TCD, Flux Capacitor, Dash Gauges, VSR), the values must be:
- Topics all set to bttf/XX/cmd (where XX is either tcd, fc, dg or vsr)
- Play:
MP_PLAY - Stop:
MP_STOP - Next:
MP_NEXT - Prev:
MP_PREV - Goto:
INJECT_888{NNN} - Volume up / down:
VOLUME_SET_{P}/ empty - Shuffle on:
MP_SHUFFLE_ON - Shuffle off:
MP_SHUFFLE_OFF
For a second, identical Jukebox, the values must be:
- Topics all set to bttf/XX/cmd (where XX is the hostname of the remote controlled Jukebox)
- Play:
PLAY - Stop:
STOP - Next:
NEXT - Prev:
PREV - Goto:
GOTO_{JL}_{JN} - Volume up / down:
VOLUME_SET_{P}/ empty - Shuffle on:
SHUFFLE_ON - Shuffle off:
SHUFFLE_OFF
In this section, the format of the remote player's feedback can be configured. The feedback must come as a JSON object:
For example: {"STATE":"PLAYING","VOLUME":"50"} or {"CURRENT":0,"FIRST":"0","LAST":"99"}
The feedback data can contain the following fields:
- State. Required. The Jukebox needs to know if the remote player is currently playing or stopped/idle. Enter the key, and value for "playing" here. The key is typically "state", and the value for 'playing' is often PLAYING or 1. If the value is left empty, the state is assumed being boolean (true meaning playing). The Jukebox also knows a state 'off'. This is optional, it can be left empty. If the 'off' state is transmitted, the Jukebox assumes that the player is off or in a state where it is not taking commands.
- Current track. Required. The transmitted value must be a track number (>= first track, see below) or a Jukebox numbering term (eg. B-7). If this information is not available, the Jukebox will only do "play", "stop", "next" and "prev" commands, the jog dials are off.
- First track. The transmitted value must be a number which is either 0 or 1. If the remote player does not send this over the backchannel, it can be substituted by entering
=0or=1. Not required for Jukebox numbering. - Last track. The transmitted value must be a number (>= first track) or a Jukebox numbering term (eg.
K-10). If the remote player does not send this over the backchannel, it can be substituted by entering =value, value being the highest Current Track can be (eg.=99or=K-10). - Volume. Optional. If the transmitted value contains a "." (dot), the value is interpreted as a fraction (0.0 - 1.0). Otherwise it is assumed to be a percentage (0 - 100). If the remote player does not support volume, leave the field empty.
- Shuffle mode. Optional. This is used to determine the current state for "shuffle" on the remote player. Enter the key and the value for "shuffle on". If the value is left empty, the transmitted data is assumed being boolean. If the remote player does not support shuffle, leave the key field empty.
The entered values for State and Shuffle mode are interpreted as strings. Leave the value fields empty if the information comes as boolean. (Writing "true" into the value field will not work if the transmitted data isn't a string.)
For CircuitSetup/A10001986 props (TCD, Flux Capacitor, Dash Gauges, VSR), the values must be:
- Topic: bttf/XX/mpstatus (where XX is either tcd, fc, dg or vsr)
- State key
S, value 'playing'P, value 'off'O(letter O) - Current track:
C - First track:
F - Last track:
L - Volume:
V - Shuffle: key
SH, value1.
For a second, identical Jukebox, the values must be:
- Topic: bttf/XX/mpstatus (where XX is the hostname of the remote controlled Jukebox)
- State key
S, value 'playing'P, value 'off'O(letter O) - Current track:
C - First track: unused, can be left empty
- Last track:
L - Volume:
V - Shuffle: key
SH, value1.
The red light at the top is used for the following signals:
| Blinking at 2Hz | Please wait, busy |
| 1 flash of 300ms | Music Player mode. Shown on startup and on mode changes |
| 2 flashes of 300ms | Streaming mode. Shown on startup and on mode changes |
| 3 flashes of 300ms | Remote mode. Shown on startup and on mode changes |
| 4 blinks, 1 second each | Alarm (from TCD via BTTFN/MQTT) |
| 3 long blinks, 3 short blinks, 3 long blinks (SOS in morse) | Error: Sound pack not installed or outdated |
| 2 brief blinks, 1 second pause, repeat | Error |
| 1 brief blink | OK |
| 1 second lit | No music available to play; no stream; no music on remote player |
| 1 second lit, 1 short blink | Shuffle mode is off, shown upon toggling shuffle mode |
| 1 second lit, 2 short blinks | Shuffle mode is on, shown upon toggling shuffle mode |
| Continuous very brief blinks | Warning that keeping the button held will delete static IP and AP-PW |
| 6 very quick blinks | Firmware update available; shown briefly at power-up (optional) |
Text & images: (C) Thomas Winischhofer ("A10001986"). See LICENSE. Source
Other props: Time Circuits Display ... Flux Capacitor ... SID ... Dash Gauges ... VSR ... Remote Control ... TFC