Skip to content

Commit cbd87f5

Browse files
authored
Release v4.2.0
2 parents d98deb9 + 70a0600 commit cbd87f5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+5648
-1451
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Exclude firmwares
2-
/Syntherrupter_Firmwares
2+
/Syntherrupter_Firmwares*
33

44
# Exclude zip files in root directory
55
/*.zip

Create_Release.cmd

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
del /q Syntherrupter_Firmwares
1+
rem del /q Syntherrupter_Firmwares
22
md Syntherrupter_Firmwares
33
rem Start Nextion Build VM.
4-
"C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" controlvm "Windows 7 Nextion VBox" poweroff
5-
"C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" snapshot "Windows 7 Nextion VBox" restore "Starting in 3 seconds..."
6-
"C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" startvm "Windows 7 Nextion VBox" --type headless
4+
rem "C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" controlvm "Windows 7 Nextion VBox" poweroff
5+
rem "C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" snapshot "Windows 7 Nextion VBox" restore "Starting in 3 seconds..."
6+
rem "C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" startvm "Windows 7 Nextion VBox" --type headless
77
rem copy ESP8266 binary to release folder. Usually no need for (re)compiling.
88
robocopy Syntherrupter_Lightsaber Syntherrupter_Firmwares Syntherrupter_Lightsaber.ino.generic.bin
99
rem Compile Tiva Firmware for all possible output numbers.
@@ -15,14 +15,14 @@ for %%i in (1,2,3,4,5,6) do (
1515
ren Syntherrupter_Firmwares\Syntherrupter_Tiva_1_Coils.bin Syntherrupter_Tiva_1_Coil.bin
1616
rem Build VM takes at least 20s to start, and at least 20s to compile one file. We assume that compiling the 6 Tiva firmwares take at least 20s. So... if no HMI file is there, the VM didn't start yet, or has already finished.
1717
cd Syntherrupter_Firmwares
18-
:waitforvm
19-
timeout /t 5
20-
if not exist "*.HMI" goto waitforvm
18+
rem :waitforvm
19+
rem timeout /t 5
20+
rem if not exist "*.HMI" goto waitforvm
2121
rem Build VM is configured to delete temporary HMI files after creation. wait until no HMI files are left.
22-
:loop
22+
rem :loop
2323
timeout /t 5
24-
if exist "*.HMI" goto loop
25-
"C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" controlvm "Windows 7 Nextion VBox" poweroff
26-
"C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" snapshot "Windows 7 Nextion VBox" restore "Starting in 3 seconds..."
24+
rem if exist "*.HMI" goto loop
25+
rem "C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" controlvm "Windows 7 Nextion VBox" poweroff
26+
rem "C:\Program Files\Oracle\VirtualBox\VBoxManage.exe" snapshot "Windows 7 Nextion VBox" restore "Starting in 3 seconds..."
2727
"C:\Program Files\WinRAR\winrar" a -afzip -m5 ..\Syntherrupter_Firmwares.zip
2828
cd ..

Documentation/Wiki/Custom MIDI Commands.md

+468-45
Large diffs are not rendered by default.

Documentation/Wiki/Envelopes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[Back to the wiki main page](README.md#readme)
44

5-
Syntherrupter comes with a bunch of envelopes included in its firmware. Envelopes allow you to modify the sound (soft & long, sharp & short, ...). I made some [forum posts](README.md#external-content) that go into greater detail.
5+
Syntherrupter comes with a bunch of envelopes included in its firmware. Envelopes allow you to modify the sound (soft & long, sharp & short, ...). Why? Check this out. Here's a demo of Pirates of the Carribean [with](https://soundcloud.com/user-754038701/pirates-of-the-carribean-jarrod-radnich-syntherrupter-v420-beta4) and [without](https://soundcloud.com/user-754038701/pirates-of-the-carribean-jarrod-radnich-no-envelope-syntherrupter-v420-beta4) envelopes. I also made some [forum posts](README.md#external-content) that go into greater detail.
66

77
The sound can be selected by the MIDI command "Program Change". In your MIDI software you can select it by changing the instrument of the channel. Program 0 is f.ex. called "Accoustic Grand Piano". Some MIDI softwares only list the name, others list the program number, too. Syntherrupter doesn't care about the name, since its programs don't match those labels. The meaning of each program for Syntherrupter is listed below.
88

Documentation/Wiki/Getting Started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Once you have the minimum viable setup, you can extend it by any combination of
3737
* Shielded encasing
3838
* Powerbank for standalone operation
3939
* [MIDI Input jack](HW/MIDI%20Input.md#readme)
40-
* [Lightsabers](HW/Lightsabers.md#readme)
40+
* [Lightsabers](HW/Lightsaber%20Receiver.md#readme)
4141

4242
## Firmware
4343

Documentation/Wiki/Minimum Viable Setup.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,19 @@ Everything else will connect to this board. How? Where? What pins? Beside the in
3333
## Display
3434

3535
### Introduction
36+
37+
Syntherrupter was originally designed as touch screen device. However, if you don't want a graphical user interface you can easily control it [via command line](https://github.com/MMMZZZZ/Syfoh#readme), too. In that case you really only need the Tiva board.
38+
3639
Syntherrupters UI is designed for a special touch display called "Nextion". They have their own microcontroller that runs the whole UI which makes development *a lot* easier. Assembly gets easier, too. No 40 pin flat-flex cable, only 5V supply and two data pins.
3740

38-
There are multiple display versions that can do the job. If you don't care and simply want to go with the recommended display from the recommended shop, click [here](https://www.itead.cc/nextion-nx8048k050.html) and you're good.
41+
There are multiple display versions that can do the job. If you don't care and simply want to go with the recommended display from the recommended shop, click [here](https://www.itead.cc/5-0-nextion-intelligent-series-hmi-resistive-capacitive-touch-display-without-enclosure.html) and you're good.
3942

4043
Btw. since they are resistive touch screens, they aren't affected by EMI like the capacitive screen of your smartpone.
4144

4245
You don't need a standalone interrupter? Well, you can run the user interface on the PC, too. In that case you don't need a display at all ([see below](#without-a-display)).
4346

4447
### Suitable Models
45-
Nextions ease of use comes at a cost. Litterally. These displays are rather expensive, starting at 64$ for the 5" version. Starting? Yes, there are actually 6 displays that are suitable for Syntherrupter:
48+
Nextions ease of use comes at a cost. Literally. These displays are rather expensive, starting at 64$ for the 5" version. Starting? Yes, there are actually 6 displays that are suitable for Syntherrupter:
4649

4750
* `NX8048T050_011R`: Nextion 5" Basic series ([Official shop: 65$](https://www.itead.cc/nextion-nx8048t050.html))
4851
* `NX8048T070_011R`: Nextion 7" Basic series ([Official shop: 75$](https://www.itead.cc/nextion-nx8048t070.html))
@@ -76,9 +79,12 @@ To keep things simple I won't write "Nextion or TJC display" every time but simp
7679

7780
### Without a display
7881

79-
The user interface can be run on a Windows PC. This requires an additional Serial to USB converter that connects to the same Pins as the Nextion display would ([see below](#wiring)).
82+
The user interface can be run on a Windows PC. Unlike the command line interface the GUI requires an additional Serial to USB converter that connects to the same Pins as the Nextion display would ([see below](#wiring)).
8083

81-
* Download, install and open the Nextion Editor. For firmwares up to v4.1.0 you need Nextion Editor v1.61.1 (Download as [ZIP (portable)](https://nextion.tech/download/nextion-setup-v1-61-1.zip) or [Installer](https://nextion.tech/download/nextion-setup-v1-61-1.exe)). Unfortunately each of their updates breaks compatibility... I'll keep this section updated.
84+
* Download, install and open the Nextion Editor.
85+
* For firmwares up to v4.1.3 you need Nextion Editor v1.61.1 (Download as [ZIP (portable)](https://nextion.tech/download/nextion-setup-v1-61-1.zip) or [Installer](https://nextion.tech/download/nextion-setup-v1-61-1.exe)).
86+
* For firmware versions 4.1.4 to 4.2.0-beta.5 you need Nextion Editor v1.62.1 which is not available for download anymore; Nextion wants to force people to use v1.63.x and newer. For the record, here are the broken links: [ZIP (portable)](https://nextion.tech/download/nextion-setup-v1-62-1.zip), [Installer](https://nextion.tech/download/nextion-setup-v1-62-1.exe). Workaround: download the "Source Code" zip file attached to the release and open the .HMI file that can be found in the extraced zip content under `Syntherrupter_Nextion/Syntherrupter_Nextion.HMI`. You can use pretty much any Nextion editor version but I'd recommend v1.63.3 (see next point). Once you opened the file in the editor, contine with the steps below.
87+
* For firmware versions 4.2.0-beta.6 and newer you need Nextion editor v1.63.3 (Download as [ZIP (portable)](https://nextion.tech/download/nextion-setup-v1-63-3.zip) or [Installer](https://nextion.tech/download/nextion-setup-v1-63-3.exe)).
8288
* Click "Debug" on the top right. A file dialog opens. Select the *Syntherrupter_Nextion_NX8048T050.tft* file from the release zip file.
8389
* A new window opens. At the bottom left select "User MCU Input" and then the COM port of the Serial to USB converter. Baud rate is 115200baud/s.
8490
* You may need to reset the Tiva.

Documentation/Wiki/Password Reset.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# Password Reset
22

3-
Forgot your password or need to reset it? Here's how you do it:
3+
Forgot your password or need to reset it? Here's how you do it.
4+
5+
## Firmware version 4.2.x
6+
7+
Use the [Sysex Commands](Custom%20MIDI%20Commands.md#system-exclusive-messages-sysex) to set a new password.
8+
9+
10+
## Firmware version 4.1.x
411

512
1. Download the [Tiva Password Recovery Firmware](https://github.com/MMMZZZZ/Syntherrupter/blob/Password-Recovery/Syntherrupter_Tiva-PW_REC.bin?raw=true).
613
1. Flash the firmware [like a normal update](Firmware%20Flashing.md#tiva-flashing).

Documentation/Wiki/README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,19 @@ Welcome to the Syntherrupter wiki. This is a collection of how-tos and documenta
1717

1818
The High Voltage Forum topic contains some subjects that haven't made their way into this wiki yet. Hence they're linked below.
1919

20-
* [My best MIDI sources](https://highvoltageforum.net/index.php?topic=1020.msg8661#msg8661)
20+
* [My best MIDI sources](https://highvoltageforum.net/index.php?topic=1020.msg8661#msg8661). Somewhat outdated but still useful I guess.
2121
* [A bunch of demo videos with a tesla coil](https://highvoltageforum.net/index.php?topic=1020.msg9299#msg9299). Thanks futurist! And just below that post you'll find a video from AstRii, too.
2222
* [What the n-tau parameter does to envelopes (ADSR)](https://highvoltageforum.net/index.php?topic=1020.msg8850#msg8850). Post is outdated, picture not.
2323
* [Envelope (ADSR) editor and looping](https://highvoltageforum.net/index.php?topic=1020.msg9082#msg9082)
2424
* [What is MIDI? What is ADSR? Is it the same?](https://highvoltageforum.net/index.php?topic=1020.msg9120#msg9120)
2525
* [In-depth explanation of note duty vs note ontime](https://highvoltageforum.net/index.php?topic=1020.msg8564#msg8564)
2626
* [AstRiis Syntherrupter build with 4 outputs](https://highvoltageforum.net/index.php?topic=1267.msg9292#msg9292)
27-
* If you happen to have a Nextion Intelligent Screen (Indicated by a P in the model number), or a TJC X series screen, you need to make changes to the Nextion source file. You need to modify [the sliders](https://highvoltageforum.net/index.php?topic=1020.msg9670#msg9670) and [the code for dark mode](https://highvoltageforum.net/index.php?topic=1020.msg9682#msg9682)
2827

2928
In addition, Mads Barnkob from [Kaizer Power Electronics](https://kaizerpowerelectronics.dk/) has a video series about his impressive Syntherrupter based show controller:
3029

3130
* [Tesla Coil Show Controller Project (Part 1 of 6)](https://www.youtube.com/watch?v=Ad2129sZv6w)
3231
* [Tesla Coil Show Controller - Programming Syntherrupter (Part 2 of 6)](https://www.youtube.com/watch?v=jQZj8DPNvJg)
3332
* [Tesla Coil Show Controller - 6 Optical Output Control Panel (Part 3 of 6)](https://www.youtube.com/watch?v=DCFt82_SrNI)
33+
* [Tesla Coil Show Controller - 6 Interrupters (Part 4 of 8)](https://www.youtube.com/watch?v=pOEmQ9KFFWY)
34+
* [Tesla Coil Show Controller - Syntherrupter Installation And MIDI Test (Part 5 of 8)](https://www.youtube.com/watch?v=JB4-n_mJty4)
3435
* *(Other parts will be added as soon as they're released)*

Documentation/Wiki/UI/Channel Settings.md

+5
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Set NRPs or send any MIDI command for the given MIDI channel. Note: Syntherrupte
1313
* [MIDI Command](#midi-command)
1414
* [Previous/Next Channel](#previousnext-channel)
1515
* [Return to MIDI Coil Settings](#return-to-midi-coil-settings)
16+
* [Sysex Commands](#sysex-commands)
1617

1718
## What you see
1819

@@ -45,3 +46,7 @@ The *Previous* (*Next*) button brings you to the previous (next) channel. This a
4546
### Return to MIDI Coil Settings
4647

4748
Leaving the page brings you back to the [MIDI Coil Settings](Coil%20Settings.md#readme).
49+
50+
## Sysex Commands
51+
52+
The changes on this page are channel specific and done via NRP commands. Thus there are no sysex commands needed/available.

0 commit comments

Comments
 (0)