Tour of the portal¶
A quick map of the web portal: the top menu, the map of all your locations, a single location's page, and where everything else lives. The other pages in this section cover each area in detail.
The top menu¶
The menu runs across the top of every page:
| Item | What it opens |
|---|---|
| Whisker.io™ logo | The map of your locations |
| My Devices | The map of your locations (see below) |
| Dashboards | Your dashboards. See Dashboards |
| Alerts | Alerts and everything about who gets notified, in tabs: Alerts, Alert Notes, Alert History, Alert Schedules, Alert Contacts. See Alerts |
| Restaurant IoT™ | The FoodSafe module. Only for accounts that use it |
| Tanks | Every tank in your account. Only if you have tanks. See Tanks and flow meters |
| Flow Meters | Every flow meter in your account. Only if you have flow meters |
| Control Panel | Your account, your own details, users, roles, reports and the audit log. Not shown to View Only users. See Administration |
| App Settings → Temperature | Choose Celsius (°C) or Fahrenheit (°F). Every temperature in the portal (readings, alert thresholds, graphs) follows your choice |
| Log Out | Signs you out |
The Alert History tab is shown only to people in the View Alert History role (see Roles and permissions). Partner accounts also show their logo in the menu.
Note
The Dashboards page has a shorter menu of its own, without Alerts, Tanks or Flow Meters. Click My Devices to get back to the full menu.
On a phone, the menu is hidden while a location's Map/HMI page is open, to leave room for the screen. Use your browser's Back button to leave the page.
The map of your locations (My Devices)¶
My Devices opens your account's home page: every location on one map. The Map and Table buttons under the account name switch between a map and a list of the same locations.
Reading the map¶
Each location's marker shows its current status:
| Marker | Meaning |
|---|---|
| Green circle with a check | No open issues |
| Red triangle with an exclamation mark | One or more active issues or alerts |
| Blue circle with a slash | Status unknown: nothing has reported yet (usual for a new location) |
When locations are close together at the current zoom, they merge into a numbered cluster bubble: green if every location in it is OK, red if all have issues, amber if mixed. Zoom in to separate them.
Statuses refresh every five minutes, so a wall display doesn't need reloading.
The map toolbar¶
| Control | What it does |
|---|---|
| New Location | Shows "Click anywhere on the map to create a new location." Click the spot and the Create New Location dialog opens. Only for the Add/Edit Locations role |
| Center Map → Address/Coordinates | Moves the map to an address (1600 Penn Ave, Washington), a place (Hollywood) or coordinates (41.88,-87.62) |
| Center Map → Show All Locations | Zooms out to show every location |
| Center Map → Location → … | Jumps to one location and opens its tooltip |
| Filter by name | Shows only locations whose name matches what you type |
The Create New Location dialog shows the chosen spot's Lat/Long: and Timezone:, and asks for a Name: and who can view and edit the location (see Roles and permissions). Click Create.
Opening a location¶
- Click a location's marker. Its tooltip opens.
- Click the location name to open the location's page. If the name is plain text rather than a link, you don't hold the location's view role.
- If the location has issues, click Go To Issues List for the Complete List of Issues without leaving the map.
- The gear next to the name (for people who can modify the location) opens Edit Location.
The Table view¶
Table lists the same locations with their status, name (a link, if you can view the location), coordinates and time zone. Use the search box, and the Status: filter (No Issues, Any Issues, All). Click a status icon to see that location's issues. The table is easier than the map when you have many locations.
A location's page¶
Opening a location shows, from top to bottom:
- Breadcrumb: account name › location name. The account name takes you back to the map; the gear opens Edit Location.
-
Map/HMI, Tables and Alerts buttons, for three views of the location:
View Contents Map/HMI The main working view, with its own row of tabs (below) Tables A table of every device's latest readings, grouped by product type, with snoozing and the Download History export Alerts The alerts at this location. See Alerts -
In Map/HMI, a row of tabs:
Tab Contents Map The location's own map, with markers for its hubs and devices. Drag them to where the equipment really is Flow Meters, Tanks, Pumps Tables for that kind of equipment. Each tab appears only if the location has it one tab per HMI The location's HMI screens, each with a gear for its settings + Creates a new HMI (needs the Create HMI role) History Who changed what at this location -
Configured Products on the left: a tree of Location → Hub → Device → Channel, each row with a status icon (click it for that item's issues) and a gear for its settings. Add Product adds new equipment. You drag channels from this tree onto HMI screens.
Locations and HMIs covers working with a location, and Devices and channels covers equipment settings.
Dashboards¶
Dashboards are boards of live gauges and trend graphs built from any channels in your account, whatever their location. The location page is organized around places; a dashboard is organized around a question, such as "all freezer temperatures" or "tank levels across the region". See Dashboards.