This guide will cover the web interface available via an ESP32 chip used as either the Attenuator or Wireless Adapter devices, and is capable of controlling some operations of your Proton Pack and Neutrona Wand.
Before proceeding, it is worth noting that the ESP32 device is only capable of operating on the 2.4GHz band for WiFi communications. While it does support the 801.11b/g/n networking standards, any computer/phone/tablet which connects to this device via external WiFi network, or will be connected via the private WiFi network on this device as a client, must support the 2.4GHz band. For secured networks, only the WPA2 standard is allowed (joining an open networks is not supported nor advised).
Connectivity options include either a private WiFi network from the device, and the ability to join an external WiFi network. For the latter this may be your home network or a cellular hotspot, though this is subject to some factors which are environmental or vendor-specific.
It should be clearly stated that the ESP32 is a low-power consumer device and will not have the same range and features as a true wireless access point. When used at home or a controlled environment it should respond in a satisfactory manner. Though when used in a crowded (read: convention) environment the signal may become lost or overwhelmed by competing RF devices. When possible, configure the device to connect to a stronger, stable wireless network as a client rather than relying on the built-in access point as this may improve the range and performance of the web-based interface.
- For Android devices offering a cellular hotspot, these devices may utilize a feature called "Client Isolation Mode" which will prevent hotspot clients from seeing each other. Unless you can disable this option (via a rooted device) you will not be able to reach the web UI via the hotspot network.
- For iOS devices offering a cellular hotspot, please make sure that the "Maximize Compatibility" option is enabled. This will ensure your device offers the 2.4GHz radio and will be seen by the ESP32 device.
If you have forgotten the password to your device's private WiFi network, you can load the special Attenuator-ESP32-Reset.bin firmware by following the "Forgot Your WiFi Password" section of the ATTENUATOR_FLASHING guide.
As of the 5.2.2 firmware release a special debug option is available when using the hardware as an Attenuator, or if a momentary switch is installed between pin D4 and GND on the ESP32 controller. While powering on the device, push down on the main dial on the Attenuator (or press the momentary switch), and the device will bypass any stored password for local WiFi. This will bypass setting of a password for the built-in WiFi network, allowing the "ProtonPack_" network to run without WPA2 security. This should only be done as a last resort to regain access to the device if the password is forgotten or another technical issue may be preventing access!
Please see the ATTENUATOR_FLASHING guide for details on compiling and/or uploading software to your Wireless Adapter controller.
In order to view the state of the pack and control it remotely, the Proton Pack and ESP32 devices must be physically connected and have been sychnronized via the built-in software. On the ESP32 are 2 on-board LEDs which will show the current status:
- The onboard red LED indicates the device is powered and should be accessible via the private WiFi network.
- A second onboard LED will be lit blue to indicate when the device has successfully synchronized with the Proton Pack.
Additionally, when using the device as an Attenuator, the topmost LED on that device will be lit as purple until pack synchronization has completed. If using the "standalone" firmware the top LED will remain lit as red.
When using the ESP32 controller for either the Attenuator or Wireless Adapter, it will offer a default, private WiFi network (access point) which begins with the pattern "ProtonPack_NNNN" where the NNNN is unique to each ESP32's WiFi network interface, and this will be secured with a default password of "555-2368".
Once connected, your computer/phone/table should be assigned an IP address starting from "192.168.1.100" with a subnet of "255.255.255.0". Please remember that if you intend to have multiple Attenuator/Wireless devices connect via this private WiFi network you will be assigned a unique IP address for each client device (eg. phone, tablet, or computer).
A web-based user interface is available at http://192.168.1.2 to view the state of your Proton Pack and Neutrona Wand, and to manage specific actions. The available sections are described below.
Note: As of the latest 5.3.x release a new mDNS feature allows the device to respond to a localized name regardless of the WiFi network. In your browser simply navigate to http://<SSID>.local where the "SSID" is the same name as the private access point. This SSID is now user-customizable using the "Attenuator Settings" page shown below.
The equipment status will reflect the current state of your Proton Pack and Neutrona Wand and will update in real-time as you interact with those devices. This information is available as either a text-based or graphical display, or both if you prefer (set via Attenuator Preferences).
When using the graphical display, most components of the Proton pack and Neutrona Wand are represented by color-coded overlays on the component will may be affected by runtime actions:
- The top of the display will indicate the mode (Standard = Mode Original, Upgraded = Super Hero) along with the year theme (V1.9.8x or V2.0.2x).
- When the Ion Arm switch is engaged for Mode Original, the overlay for the Ion Arm will be green to indicate a ready state. When in Super Hero mode this overlay will be green when the Proton Pack is powered on.
- When the Proton Pack is powered on:
- The Powercell, Booster Tube, and Cyclotron overlays will be green as their default state.
- When the Cyclotron is in a normal state the overlay will be green. It will change to yellow then red as it goes through the pre-warning and overheat states. During venting the overlay will be blue to indicate the recovery period.
- The color state of the Booster Tube is linked to the "Output" text value which is the voltage measured at the Proton Pack PCB (in volts, but displayed as Gev). During high power draw events such as smoke generation the voltage can drop briefly, and will be reflected as a red overlay when that value is below 4.2V
- When the Neutrona Wand is powered on, the overlay above the Activate/Intensify portion of the gun box will indicate if the barrel is retracted (red) or extended (green).
- The current power level for the Neutrona Wand will be indicated by the "L-#" beside the barrel.
- The type of firing mode will be displayed below the Neutrona Wand and will be color coded via the barrel. Color intensity increases with the power level.
- Proton Stream: Red (includes Spectral modes)
- Plasm System: Green (incl. for 1989 theme)
- Dark Matter Gen.: Blue
- Particle System: Orange
- Settings: Gray
- When using the power-detection feature with a stock Haslab Neutrona Wand the default stream will be Proton with a power level of 5. Instead of the stream type being displayed, there will be a wattage value displayed as Gigawatts (GW).
- If the Ribbon Cable is removed, a warning icon will appear over that component to indicate an alarm state.
- When the Cyclotron lid is removed a radiation exposure warning will be displayed at the bottom of the CRT display.
Note: When using the text-based display, if you see a "—" (dash) beside the labels it can indicate a potential communication issue. Simply refresh the page and/or check your WiFi connection to the device. In rare cases you may need to do a reboot of the ESP32 device via the admin tab.
Special thanks and credit to fellow cosplayer Alexander Hibbs (@BeaulieuDesigns87) from the South Carolina Ghostbusters, who created the amazingly detailed Proton Pack and Neutrona Wand technical illustration, available as a printed poster or digital image. He has graciously provided a version of his design to make the new graphical interface.
This section allows full control of the system (overall) volume, effects volume, and music volume along with the ability to mute/unmute all devices. The current volume levels will be shown and updated in real-time whether adjusted via the web UI, the pack, or the wand.
For playback of music you can use the improved navigation controls:
| Indicator | Track Action |
|---|---|
| ◀◀ | Previous |
| ▢ ▶ | Start/Stop |
| ▮▮ ▶ | Pause/Resume |
| ▶▶ | Next/Skip |
You may also jump directly to a specific track for playback via the selection field (switching immediately if already playing, otherwise that track will be started via the Start/Stop button).
By default, only the track numbers are known to the audio device as all music tracks must begin at value "500" per the naming convention used by the GPStar controller software. However, as of the 5.x release it is possible to add a track listing to the ESP32 device's memory so that user-friendly song names can be displayed. See the Attenuator Settings described below for more information.
Controls will be made available on a per-action or per-state basis.
Shown here, the pack and wand are both in an Idle state while in the "Super Hero" operation mode which allows the pack to be turned on/off remotely. The options to remotely vent or to "Attenuate" are only enabled when the devices are in a specific state.
Vent: This can only be triggered remotely when in the "Super Hero" mode and while the Pack State is "Powered".
Attenuate: When firing, the Cyclotron State must be either "Warning" or "Critical" to enable this button.
These provide a web interface for managing options which are accessed via the LED or Config EEPROM menus. The settings are divided into 3 sections: Pack, Wand, and Smoke. The features available via these sections will be covered in-depth later in this document.
These links allow you to change or control aspects of the available devices in lieu of the EEPROM menu.
- Update ESP32 Firmware - Allows you to update the ESP32 firmware using Over-the-Air updates. See the ATTENUATOR_FLASHING guide for details
- Secure Device WiFi- Allows changing of the default password for the private WiFi network
- Change WiFi Settings - Provides an optional means of joining an existing, external WiFi network for access of your device
- Restart/Resync - Allows a remote restart of the software by performing a reboot ONLY of the ESP32 device
At the bottom of the screen is a timestamp representing the date of the software build for the ESP32 firmware, along with the name of the private WiFi network offered by the current device. If connected to an external WiFi network the current IP address and subnet mask will be displayed.
Set options related specifically to the Attenuator, such as when the vibration motor or buzzer may be used to provide physical feedback during operation.
Note: If you installed the Frutto Technology electronics into your DIY or GPStar Attenuator shell and found that the top and lower LEDs are displaying the wrong colors, you can use the "Invert" option to put the 3 lights into the correct order.
NEW in 5.x - The ability to add a user-friendly track listing has been integrated into the UI. Song titles may be entered as 1 entry per line, in the order by which they are numbered on your microSD card. The text is limited by bytes (max 2,000) not the number of lines, so to fit more entries into this text box you may need to use shorter song titles. This list of songs will be matched to each track number (starting from "500_" per the required numbering scheme). This data is stored only within the ESP32 device and is only visible/used by the track selection field in the Music Navigation area.
Set options related specifically to the Proton Pack. Options such as the color/saturation sliders will only take effect if you have installed the Frutto Technology powercell and cyclotron lid light kits. Similarly, the Video Game mode option will have no effect on the stock Haslab LEDs.
Reminder: The ability to update settings or save to EEPROM will be disabled so long as the pack and wand are running. Turn off all physical toggles to set these devices to an idle state before adjusting settings. Refresh the page to get the latest values for preferences.
📝 Note: When changing options such as the count of LEDs in use for a device, or some options such as the Operation Mode, a full power-cycle of the equipment is required after saving to EEPROM.
Set options related specifically to the Neutrona Wand.
Reminder: The ability to update settings or save to EEPROM will be disabled so long as the pack and wand are running. Turn off all physical toggles to set these devices to an idle state before adjusting settings. Refresh the page to get the latest values for preferences.
📝 Note: When changing options such as the count of LEDs in use for a device, a full power-cycle of the equipment is required after saving to EEPROM.
Adjust overall smoke effects (toggle on/off) and adjust per-level effects. Naturally, these options will have no effect on operation without a smoke kit installed.
Reminder: The ability to update settings or save to EEPROM will be disabled so long as the pack and wand are running. Turn off all physical toggles to set these devices to an idle state before adjusting settings. Refresh the page to get the latest values for preferences.
It is possible to have your device join an existing WiFi network which may provide a more stable network connection.
- Access the "Change WiFi Settings" page via http://192.168.1.2/network URL to make the necessary device modifications.
- Enable the external WiFi options and supply the preferred WiFi network name (SSID) and WPA2 password for access.
- Optionally, you may specify an IP address, subnet mask, and gateway IP if you wish to use static values. Otherwise, the ESP32 will obtain these values automatically from your chosen network via DHCP.
- Save the changes, which will cause the device to reboot and attempt to connect to the network (up to 3 tries).
- Return to the URL above to observe the IP address information. If the connection was successful, an IP address, subnet mask, and gateway IP will be shown.
- While connected to the same WiFi network on your computer/phone/tablet, use the IP address shown to connect to your device's web interface.
Use of an unsecured WiFi network is not supported and not recommended.
The web UI is built as a single-page application, using single HTML pages for the interface elements and performing actions using an API layer. These API endpoints are available for use if you wish to build your own interface. They pass data in JSON format though the exact structure is not described here at this time.
The following URI's will serve the informational/maintenance pages as shown previously in this guide:
GET / - Standard Index/Landing Page
GET /network - External WiFi Settings Page
GET /password - WiFi Password Update Page
GET /settings/attenuator = Attenuator Settings Page
GET /settings/pack - Pack Settings Page
GET /settings/wand - Wand Settings Page
GET /settings/smoke - Smoke Settings Page
GET /style.css - Common Stylesheet
GET /common.js - Common JavaScript
GET /index.js - Index Page JavaScript
For real-time updates, the built-in web server offers a special URI /ws to support WebSockets. When connected to that endpoint, the ESP32 device will "push" any relevant information direct to clients in real-time. Note that this data may be in the form of a JSON object or just a plain string, so check the contents of the text data carefully before usage.
The following URI's are API endpoints available for managing actions within your devices. You may use these to create your own UI or control your pack/wand via other hardware devices. For instance, you can monitor the /status endpoint for changes, or use the volume/music endpoints to create your own jukebox interface. All data should use the application/json content type for sending or receiving of data. Where applicable for body data to be sent to the device a footnote describes where to find a sample of the JSON payload.
GET /status - Obtain all current equipment status (pack + wand)
DELETE /restart - Perform a software restart of the ESP32 controller
PUT /pack/on - Turn the pack on (subject to system state)
PUT /pack/off - Turn the pack onf (subject to system state)
PUT /pack/attenuate - Cancel pack overheat via "attenuation"
PUT /pack/vent - Perform manual vent (subject to system state)
PUT /pack/lockout/start - Perform manual lockout (subject to system state)
PUT /pack/lockout/cancel - Cancel manual lockout (subject to system state)
PUT /volume/toggle - Toggle mute for all devices
PUT /volume/master/up - Increase system (master) volume
PUT /volume/master/down - Decrease system (master) volume
PUT /volume/effects/up - Increase effects volume
PUT /volume/effects/down - Decrease effects volume
PUT /volume/music/up - Increase music volume
PUT /volume/music/down - Decrease music volume
PUT /music/startstop - Toggle music playback via start/stop
PUT /music/pauseresume - Toggle music playback via resume/pause
PUT /music/next - Move to next track
PUT /music/prev - Move to previous track
PUT /music/loop - Toggle looping of current track
PUT /music/select?track=[INTEGER] - Select a specific music track (Min Value: 500)
GET /wifi/settings - Returns the current external WiFi settings
PUT /wifi/update - Save new/modified external WiFi settings
Body: Send same JSON body as returned by /wifi/settings
GET /config/device - Obtain the current (local) device settings
PUT /config/device/save - Saves attenuator settings
Body: Send same JSON body as returned by /config/pack
GET /config/pack - Obtain the current pack equipment settings
PUT /config/pack/save - Saves pack settings for evaluation
Body: Send same JSON body as returned by /config/pack
GET /config/wand - Obtain the current wand equipment settings
PUT /config/wand/save - Saves wand settings for evaluation
Body: Send same JSON body as returned by /config/wand
GET /config/smoke - Obtain the current pack/wand smoke settings
PUT /config/smoke/save - Saves smoke settings for evaluation
Body: Send same JSON body as returned by /config/smoke
WARNING: Only call these API's as necessary as these cause write cycles to the EEPROM!
PUT /eeprom/all - Stores all current preferences to pack/wand EEPROMs (eg. smoke settings)
PUT /eeprom/pack - Stores current pack preferences to pack EEPROM
PUT /eeprom/wand - Stores current wand preferences to wand EEPROM