Topbar and Quick Actions
The gateway web UI features a topbar and a quick action bar at the bottom of the body that persist regardless of which screen you are on. This section serves as an index to identify where each icon leads.
Topbar — Home on the Left, Navigation on the Right
| No. | Icon | Name (Appears on hover) | Function | Details |
|---|---|---|---|---|
| ① | Logo | — | Takes you to Home (/ui/main). The adjacent text is the name of this gateway, used to distinguish boxes. | Home Screen |
| ② | fa-plug | Connect Protocol | Register new PLCs, OPC-UA, or MQTT. Start by selecting from the protocol cards. | Protocol Selection · Add New PLC Connection |
| ③ | fa-list | Connection List | Start, stop, and edit registered connections and their tags on a single screen. | Connection and Tag List |
| ④ | fa-cubes | Application | Start, stop, and view logs for Docker apps installed on the gateway. | Application Management |
| ⑤ | fa-sitemap | OPC UA Server | The OPC-UA tree provided by the gateway — exactly as seen by an external SCADA. | OPC UA Server |
| ⑥ | fa-database | Point Search | Search accumulated time series values by period, connection, or tag and export to CSV. | Point Search |
| ⑦ | fa-exclamation-triangle | Log | System logs. The red number above the icon indicates the number of errors today. | System Log |
| ⑧ | fa-project-diagram | No-code Flow | Node-RED — Read, process, and transmit tags. | Flow |
| ⑨ | fa-tachometer-alt | Advanced Dashboard | Opens the gateway's :3000 (Grafana) in a new window. | — |
| ⑩ | fa-cog | Setting | Modify app.properties via the browser. | Web UI Configuration |
| ⑪ | fa-book-open | Manual | Opens this documentation site (docs.kopens.io) in a new window. | — |
| ⑫ | fa-sign-out-alt | Logout | Ends the session. | Login |
⑨ and ⑪ open in new windows
Other links navigate within the same window. Since ⑨ is an external tool (Grafana by default), it may vary by site and will not open if 3000 is blocked by the firewall → Firewall — Exposed Ports.
Recommended Sequence for First-Time Users
- ② Connect Protocol — Select and register the PLC type to be used.
- ③ Connection List — Start collection and verify if values are being received.
- ⑤ OPC UA Server — Confirm how the data appears to an external SCADA.
- ⑧ No-code Flow — Process the incoming values or transmit them externally.
- ⑩ Setting — Refine policies such as MQTT, Sparkplug, and retention period.
Quick Actions — Bottom of the Body
These are located at the bottom of the body, not in the topbar. They appear at the bottom left when you scroll to the end of the page. The current S/W version and an "Upgrade Available" badge are displayed on the far right.
| No. | Icon | Action | Impact |
|---|---|---|---|
| ① | fa-projector | System Reboot | 🔴 Power cycles the OS — collection stops during this process. |
| ② | fa-repeat-1-alt | Restart Application | Restarts only the gateway applications. |
| ③ | fa-trash | Clean Temporary Files | Used when disk space is low. |
| ④ | fa-stopwatch | Backup | Packages configurations and data. |
| ⑤ | fa-file-alt | Download Logs | Package to be attached when making inquiries. |
| ⑥ | fa-microchip | O/S and Firmware Upgrade | 🔴 Highest risk. |
| ⑦ | fa-cloud-download | S/W Upgrade | Receives a new build from the download server. |
① and ⑥ affect the field
Reboots and firmware upgrades cause collection downtime. Determine acceptable downtime before proceeding. For the duration and precautions of each action, refer to Status Bar Quick Actions.
Additional Navigation by Screen
| Screen | Exclusive Functions |
|---|---|
Home (/ui/main) | Click cards to navigate to the respective screen. Click the red number on «System Error» to view logs. |
| Connection List | Use ▶ ◼ on cards to start/stop collection. Write values directly in the tag row. |
| OPC UA Server | Select a node in the tree to see details and charts on the right. NodeId can be copied. |
| Application | Click the port on a card to open the app in a new window. |
| System Log | Narrow down results using search conditions on the left; clear all from the top right. |
| Setting | A restart notification appears after saving changes. |
Quick Navigation by Objective
| Objective | Fastest Path |
|---|---|
| View only today's errors | Topbar ⑦ red number · or Home «System Error» |
| Check if PLC is currently connected | Topbar ③ → Connection icon on card (Green = Connected) |
| Find a value from a specific time yesterday | Topbar ⑥ → Search by period, connection, and tag → CSV |
| See how it appears to external SCADA | Topbar ⑤ |
| View currently running containers | Topbar ④ |
| Modify a single configuration line | Topbar ⑩ → Modify and Save → Quick Action ② to restart |
| Apply new build | Quick Action ⑦ (Only when badge is red) |
Learn More
- Home Screen — Understanding the cards
- Status Bar Quick Actions — Durations and precautions for the seven actions
- Edge Manual Home