W0CHP-PiStar-Dash -- A Custom and Enhanced Pi-Star Dashboard

This is my very highly modified and customized fork of MW0MWZ’s Pi-Star software, and I call it “W0CHP-PiStar-Dash”. There are so many large changes, divergences and new features, it merited my own fork/version.

The Rules and Caveats – IMPORTANT

I really don’t want to regret publishing my open source software, only to be bombarded by inept hams who need hand-holding. I don’t have the time, patience nor desire to help the clueless. So PLEASE, do not ask me for support. This is my personal code, that I offer as a gift to power-users and hackers.
- Anyone asking for support will be ignored, and very likely, torn a new asshole and mocked on this website for not following simple instructions.
- Do NOT ask for support for W0CHP-PiStar-Dash on any official or unofficial Pi-Star support page/forum/medium/etc. This is not Andy’s (MW0MWZ) Pi-Star software! Users found doing so will be relentlessly mocked on this website.
- Don’t believe me?
Running my version of the Pi-Star dashboard is for the initiated, talented and self-motivated. It is NOT for casual, clueless users/hams.
The ONLY person who supports this code, is YOU. Yes, you will need to figure shit out if/when things go awry; on your own.
This code/project is a moving target, has bugs (like any code does) and can be unstable. It also consumes more system resources due to the myriad improvements.
Issue / Bug Tracker and Pull Requests / Patches:
- DO NOT ASK FOR SUPPORT. Repo and issue tracker access is for developers/hackers and contributors only!
- The issue tracker is NOT for:
  1. Support requests
  2. Feature requests
  3. Other bullshit not germane to bugs, issues, etc.
I do, depending on my mood and availability, offer limited support via ham radio on XLX493 ; Module E. Other users will also be happy to help! A direct DMR conference to this module/room is bridged with BrandMeister and TGIF Networks: Simply call TalkGroup 3170603.

Read This Entire Fucking Page

I cannot stress this enough. Just read the rules above again, and read the entire page.. It’s informative and you’ll learn how to install it, restore the old dashboard, etc. I took the time to write it in order to help you. So read it. This web page is the only form of support I offer (aside from being on XLX493 ; Module E periodically).

Continue & Display Full Content…

Table of Contents:

Installing `W0CHP-PiStar-Dash`

Now that you’ve been adequately informed of the rules, caveats and the risks, here’s how to install W0CHP-PiStar-Dash…

You need to have a Pi-Star hotspot running at least v4.1.6!¹

Make a backup of your configuration if you wish – just in case.
Open an SSH session to your Pi-Star instance.

Run this to familiarize yourself with the available options/arguments:²

curl -Ls https://w0chp.net/WPSD-Install | sudo env NO_SELF_UPDATE=1 bash -s -- -h

You will be presented with…

[i] W0CHP PiStar-Dash Installer Command Usage:

  -h,   --help                  :  Display this help text.


  -id,  --install-dashboard     :  Install W0CHP dashboard.


  -idc  --install-dashboard-css :  Install W0CHP dashboard,
                                   WITH custom stylesheet.

  -rd,  --restore-dashboard     :  Restore original dashboard.


  -s,   --status                :  Display current install; original,
                                   or W0CHP installations.

When ready to install, run the above command again with the option/argument you wish…e.g:
```
curl -Ls https://w0chp.net/WPSD-Install | sudo env NO_SELF_UPDATE=1 bash -s -- -id
```
(…to install the dashboard without the W0CHP custom CSS)
When the installer completes, refresh your dashboard home page to see the changes.

You must run the aforementioned commands with the exact syntax. Note the spaces and extra -- (dashes), etc. Otherwise, the commands will fail.

Updating `W0CHP-PiStar-Dash`

Once you install W0CHP-PiStar-Dash, it will automatically be kept up-to-date with any new features/versions/etc. This is made possible via the native, nightly Pi-Star updating process.³

You can also manually invoke the update process via the dashboard admin section (Admin -> Update), or by command line:

sudo pistar-update

Uninstalling `W0CHP-PiStar-Dash`

Super-simple…

Run:

curl -Ls https://w0chp.net/WPSD-Install | sudo env NO_SELF_UPDATE=1 bash -s -- -rd

…And the original Pi-Star Dashboard will be restored.

Installation Demo Video

See how easy it is to install…

Features, Enhancements and Omissions (not an exhaustive list)

Functionality Features

Full M17 Protocol Support.
Full APRSGateway Support: Selectable APRS Data Sharing with specific modes.
Full DGId Support.
Selectable DMR Roaming Beacon Support: Network or Interval Mode (or disabled).
“Live Caller” screen; similar to a “virtual Nextion screen”; displays current caller information in real-time.
Current/Last Caller Details on Main Dashboard (name/location, when available).
YSF/NXDN/P25 link managers gives the ability to change links/rooms on-the-fly, rather than going through the large (and slow) configuration page.
XLX Hosts are now searchable/selectable in DMR Master selection in configuration page.
“XLX DMR Link Manager” allows fast switching of XLX reflectors and modules, as well as unlinking from modules to “pause” traffic.
Searchable drop-downs for massive host lists in configuration/admin pages. E.g. D-Star Refs., YSF Hosts, XLX Hosts, DMR Hosts, etc.
BrandMeister Manager revamps galore:
- Now displays connected actual talk group names.
- Reflector functionality removed per BrandMeister’s announcement.
- Connected dynamic talk groups now display idle-timeout time (due to no TX).
- Added ability to mass-drop your static talk groups; and mass re-add the previously linked static talk groups.
- Added ability to batch add/delete up to 5 static talk groups at a time (for now)
TGIF Manager; now displays connected actual talk group names. (NOTE: Since TGIF has moved to a new platform with no API available, this currently does not work until TGIF’s API is made available.)
“Instant Mode Manager” added to admin page; allows you to instantly pause or resume selected radio modes. Handy for attending nets, quieting a busy mode, to temporarily eliminate “mode monopolization”, etc.
“System Manager” added to admin page; allows you to instantly:
- Disable / Enable the intrusive and slow Pi-Star Firewall.
- Disable / Enable Cron, in order to prevent updates and Pi-Star services restarting during middle-of-the-night/early AM operation.
- Enable / Disable Pi-Star Remote and Pi-Star Watchdog
Ability to configure POCSAG hang-time from the config page.

User Interface / Design Features

Updated user interface elements galore, styling, wider, bigger, updated fonts, etc.
Country-of-origin flags for callsigns.
Improved and graphical CSS/color styling configuration page; easily change the look and feel of the dashboard.
User-Configurable number of displayed Last Heard dashboard rows (defaults to 40, and 100 is the maximum).
User-Configurable font size for most of the pertinent dashboard information.
Reorganized and sectioned configuration page for better usability.
System process status reorganized into clean grid pattern, with more core service status being displayed.
User-Configurable 24 or 12 hour time display across the dashboard.
Connected FCS and YSF reflector names and numerical ID both displayed in dashboard left panel.
Additional hardware, radio and system information displayed in top header; which can be toggled.
Admin page split up into logical sub-sections/sub-pages, in order to present better feedback messages when making changes.
- Note: Last-Heard and other dynamic tables are hidden in the admin sections by default, allowing users to focus on the tasks-at-hand and their outputs. The Last-Heard data can be toggled in these areas, however.

Features in Official Pi-Star Which are Intentionally Omitted in `W0CHP-PiStar-Dash`

Upgrade notice/nag in header (unnecessary and a hacky implementation). This has been replaced by my own unobtrusive dashboard update notifier; displayed in the upper-right hand side of the top header.
“GPS” link in Call Sign column of dashboard (superfluous and unreliable).
Selectable Call Sign link to either QRZ.com or RadioID.com (both services suck, and the implementation of this feature is poor and unintuitive. Left the original function linking to QRZ.com).
CPU Temp. in header; when CPU is running “cool” or “normal” recommended temps, the cell background is no longer colored green. Only when the CPU is running beyond recommended temps, is the cell colored orange or red.
No reboot/shutdown nag screen/warning from admin page (Superfluous; you click it, it will reboot/shutdown without warning.).
Yellow DMR Mode cell in left panel when there’s a DMR network password/login issue (poor/inaccurate and taxing implementation, and can confuse power users that utilize my Instant Mode Manager, where the default cell is amber colored for paused modes [color is user-configurable].). Instead, the actual network name is highlighted in red when there’s a login issue (courtesy of F1RMB’s excellent code).

Notes about CSS, and custom CSS you may have previously applied

When using the -id option, the “normal” Pi-Star colors are used, and no CSS is installed. Any custom CSS you may have had, is removed but backed up. See bullet #4 below.
When using the -idc option, the W0CHP CSS is installed, and any of your custom CSS settings before installing the W0CHP dashboard, are backed up in the event you want to restore the official dashboard (see bullet #4). This is done because the CSS in the official Pi-Star is incompatible. You can still manually map/change your CSS back when running W0CHP-PiStar-Dash (see bullet #4 for details).
If you are already running W0CHP-PiStar-Dash, AND you have custom or W0CHP-PiStar-Dash CSS, no CSS changes, no matter which option you run this command with.
When using the -id option, your custom CSS settings are backed up (in the event you want to revert back to the official dashboard – see bullet #6), and the W0CHP dashboard uses the standard Pi-Star colors. This means that if you want your previous custom CSS applied to the W0CHP dashboard, you will need to manually customize your colors; You can reference the color values you had previously used, by viewing the backup file of your custom CSS…
```
 /etc/.pistar-css.ini.user
```
…the reason for bullets #4 and #1, is because the W0CHP dashboard is vastly different than the official upstream version (completely different CSS mappings). Since this is for my personal use, I haven’t added any logic to suck-in the user CSS values to the new mappings.
If you had customized CSS settings before installing the W0CHP dashboard, they will be restored when using the -rd option.
You can at any time start over and reset to the “normal” Pi-Star colors, by performing a CSS Factory Reset (Configuration -> Expert -> Tools -> CSS Tool).
If you’d like to start over with the custom W0CHP colors/CSS, you can copy/paste the following values into your /etc/pistar-css.ini.

Screenshots

Not all pages shown here. Note, that you can customize the colors to your preferences…

Main Dashboard

Main Admin Landing Page

BrandMeister Manager

Instant Mode Manager

System Manager

Live Caller Screen

ChangeLog

Displayed below, is a live ChangeLog, pulled from the source code repository upon page load. Displayed are the last 20 changes. For the full change history, you will want to browse the entire commit/change history.

8bfc5a996e - (4 days ago) * Minor: XLX DMR Manager current link display refresh tweak - Chipster (HEAD -> master)
mmdvmhost/xlx_dmr_manager.php | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

f7b26a15bb - (5 days ago) * Minor: ensure XLX DMR Link Manager auto-refreshes current XLX link - Chipster
mmdvmhost/xlx_dmr_manager.php | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)

eacf51fc7e - (6 days ago) * Minor: update incompat/conflicting software logic - Chipster
config/messages.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

4ff3d6adec - (7 days ago) * Minor: code cleanups - Chipster
index.php | 18 +++++++++---------
mmdvmhost/functions.php | 2 +-
2 files changed, 10 insertions(+), 10 deletions(-)

ed3307c871 - (10 days ago) * Minor: Warning message for incompatible/conflicting F1RMB installations. - Chipster
config/messages.php | 6 ++++++
1 file changed, 6 insertions(+)

c5587ea39b - (4 weeks ago) * Minor: Update BM repeater/hotspot URLs in config page - Chipster
admin/configure.php | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)

624910cc98 - (2 months ago) * Minor UI update: for SysInfor toggle; only hide HW info, but display radio status - Chipster
index.php | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

6abbaeb664 - (3 months ago) * Minor: TCXO freq. detection improvement - Chipster
mmdvmhost/functions.php | 33 ++++++++++++++++++---------------
1 file changed, 18 insertions(+), 15 deletions(-)

e0b4bdb38e - (3 months ago) * Minor: Improvements to XLX DMR Manager admin page (current link, etc.) - Chipster
mmdvmhost/xlx_dmr_manager.php | 17 +++++++++++------
1 file changed, 11 insertions(+), 6 deletions(-)

d77d587b62 - (3 months ago) * Minor: Improve and tweak modem detection routine and display - Chipster
mmdvmhost/functions.php | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

a9214ba214 - (3 months ago) * Minor: Improve and tweak modem detection routine and display - Chipster
index.php | 2 +-
mmdvmhost/functions.php | 6 ++++++
mmdvmhost/radioinfo.php | 7 ++-----
3 files changed, 9 insertions(+), 6 deletions(-)

e33959f794 - (3 months ago) * Minor: Improved free-form text/custom D-Sstar reflector value entry drop down - Chipster
admin/configure.php | 23 ++++++++++++++++++++++-
index.php | 23 ++++++++++++++++++++++-
2 files changed, 44 insertions(+), 2 deletions(-)

2947e54328 - (4 months ago) * Minor UI adjustments - likely unnoticable ;-) - Chipster
css/pistar-css.php | 10 +++-------
dstarrepeater/active_reflector_links.php | 12 ++++++------
dstarrepeater/active_starnet_groups.php | 4 ++--
dstarrepeater/ccs_connections.php | 4 ++--
dstarrepeater/datetime.php | 4 ++--
dstarrepeater/last_heard.php | 4 ++--
dstarrepeater/local_tx.php | 4 ++--
mmdvmhost/lh.php | 4 ++--
mmdvmhost/live_caller_backend.php | 4 ++--
mmdvmhost/live_caller_table.php | 4 ++--
mmdvmhost/localtx.php | 4 ++--
mmdvmhost/pages.php | 4 ++--
12 files changed, 29 insertions(+), 33 deletions(-)

0a95e9f1bd - (4 months ago) * Minor: add GPL v3 license to all code. - Chipster
LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 674 insertions(+)

bacedf669c - (4 months ago) * Minor: When QTH is not available (.e.g. non-dmr modes), use Country as "location" field across the UI (live/current caller screens). - Chipster
mmdvmhost/live_caller_backend.php | 4 +++-
mmdvmhost/live_caller_table.php | 4 +++-
2 files changed, 6 insertions(+), 2 deletions(-)

145e1b1ba6 - (4 months ago) * Intermediate: MMDVMhost has been phasing out "Direct" DMR connecions in favor of DMRGateway by default. Ergo, the config page and resulting backend config changes reflect this new direction; plus, it addressses a bug where the MMDVMHost connection "Type" is misconfigured due to this new transition. Fixes #12. - Chipster
admin/configure.php | 171 ++++++++++++++++++++++++++--------------------------
1 file changed, 85 insertions(+), 86 deletions(-)

189a57af7f - (4 months ago) * Minor: fix section header colors in config page - Chipster
css/pistar-css.php | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)

faeabe901b - (4 months ago) * Minor: fix link color in hover cells - Chipster
css/pistar-css.php | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

c7834b450d - (4 months ago) * Intermediate: Added web-based file manager in "Admin->Expert->Tools" section. - Chipster
admin/expert/filemanager.php | 64 +
admin/expert/header-menu.inc | 1 +
admin/expert/tinyfilemanager.php | 3969 ++++++++++++++++++++++++++++++++++++++
3 files changed, 4034 insertions(+)

f2439a3cf5 - (4 months ago) * Minor: When DMR roaming beacons are anabled, display whether timed/vs. network-initiated beacons are being used. - Chipster
css/pistar-css-mini.php | 63 +++++++++++++++++++++++++---------------------
css/pistar-css.php | 1 -
mmdvmhost/repeaterinfo.php | 8 +++---
3 files changed, 40 insertions(+), 32 deletions(-)

Credits

Of course, most of the credit goes to the venerable and skilled, Andy Taylor, MW0MWZ, for creating the wonderful Pi-Star software in the first place.

Credit also goes to the awesome Daniel Caujolle-Bert, F1RMB, for creating his personal and customized fork of Pi-Star; as his fork was foundational and inspirational to my W0CHP-PiStar-Dash.

The USA callsign lookup fallback function uses a terrific API, callook.info, provided by Josh Dick, W1JDD.

The callsign-to-country flag GeoLookup code was adopted from xlxd… authored by Jean-Luc Deltombe, LX3JL; and Luc Engelmann, LX1IQ. I run an XLX(d) reflector, plus, I was able to adopt some of its code for W0CHP-PiStar-Dash, ergo, I am very grateful. The excellent country flag images are courtesy of Hampus Joakim Borgos.

Credit must also be given to to Kim Heinz Hübel, DG9VH, who arguably created the very first MMDVMHost dashboard, of which, spawned the entire Pi-Star concept.

Lastly, but certainly not least; I owe an enormous amount of gratitude toward a true gentleman, scholar and incredibly talented hacker…Jonathan Naylor, G4KLX; for the suite of MMDVM and related client tools. Pi-Star would have no reason to exist, without Jonathan’s incredible and prolific contributions and gifts to the ham community.

W0CHP-PiStar-Dash was not created for single-core and low-powered hardware; such as the first generation RPi Zero, etc. (armv6l). This software will run very slow on under-powered hardware. Please consider yourself warned. Also, please ignore all of the idiot hams on various support mediums saying, “anything more than a Pi Zero is overkill”. These ignoramuses have no idea what goes on under the hood in order to display meaningful info on the dashboard. Hint: it’s a lot, and it’s very resource-intensive. Ignore them…they are dumb and they have no idea what they are talking about. ↥
Piping to bash/shells/etc. from an online source is controversial (do a google search about it). However it’s convenient, and one can view & inspect the full & actual source code of the installer prior to piping to bash or installing. ↥
W0CHP-PiStar-Dash occasionally queries the git repository server in order to determine if updates are available. In the spirit of full-disclosure, I wanted to mention this. This is no different than how the official Pi-Star software functions (but doesn’t make this well-known). Additionally, every W0CHP-PiStar-Dash installation has a unique UUID generated for it; for web/repo-traffic capacity planning/analytics, as well as for troubleshooting purposes. You can find the unique UUID within the /etc/pistar-release file. ↥

Ver. # e1b9bb3 - Document last updated: 8/12/2022
[ Permanent Link ]