Skip to content

Web App

Calin Crisan edited this page May 28, 2020 · 5 revisions

About

qToggleServer comes with a friendly user interface (also called frontend) which comes in the form of a progressive web application. It is designed to be used on smartphones, tablets and just as well on laptops/desktop machines.

This page is not intended as a manual for the app, but rather a very quick walk through fitted with screenshots.

Installing The App

Simply use your browser to access the IP address of your qToggleServer setup. By default it listens on port 8888, unless you have changed the server configuration or you're using a reverse proxy.

Being a progressive web app, don't expect to find it in Google Play Store or Apple's App Store. If you've set up a proper domain name with HTTPS access (qToggleOS makes it easier to do it), your smartphone should prompt you to add the app to home screen, meaning that it will also show up along your installed apps. Otherwise, manually add it to home screen using the browser menu.

Usage

The app should be fairly easy to use, once you're familiar with qToggle. You can go through the Basic Notions page for a crash course.

Login

Upon first visit, you should be prompted to install the app. Being a PWA, you'll simply have to add the app to homescreen. After having it installed, you can find it through your apps as well as uninstall it at any time.

When prompted for login for the first time, use admin with empty password.

⚠️ It is highly recommended that you set proper passwords in the Settings page of the app.

Dashboard

The dashboard section is probably where you'll spend most of your time when using qToggleServer. Here you can create panels and groups of panels:

In panel edit mode, you can add, move around, resize, remove and configure widgets:

Widgets usually require selecting one or more ports, whose values will be displayed and/or changed by the widget upon interaction:

Ports

The ports section is only accessible to administrators and allows adding, removing and configuring ports.

If you have slave devices management enabled in your qtoggleserver.conf (by default they are enabled), you'll have to first select the device whose ports you'll be editing. The first device in the list represents the hub (master device) itself.

Devices

The ports section is only accessible to administrators and allows adding, removing and configuring slave devices.

Settings

The ports section is only accessible to administrators and allows configuring the hub (master device) itself. You'll notice many similarities between the settings page and slave device page:

Updating

The web app is bundled with the qToggleServer package. This means that you'll get an app update whenever you update your qToggleServer installation.

Being a web app, the update process is taken care of automatically by your browser as soon as you reopen or refresh the app. You can either close it and reopen it or you can use the pull-to-refresh function to make sure your app is up-to-date.