mirror of
https://github.com/Telecominfraproject/wlan-docs.git
synced 2026-03-20 03:41:38 +00:00
GitBook: [2.0.0] 4 pages and 6 assets modified
This commit is contained in:
Chris Busch
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.15.03-pm.png
Normal file
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.15.03-pm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 144 KiB |
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.17.59-pm.png
Normal file
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.17.59-pm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.21.07-pm.png
Normal file
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.21.07-pm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.24.00-pm.png
Normal file
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.24.00-pm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 47 KiB |
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.25.29-pm.png
Normal file
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.25.29-pm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.25.50-pm.png
Normal file
BIN
.gitbook/assets/screen-shot-2021-07-28-at-5.25.50-pm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
@@ -12,7 +12,8 @@
|
||||
* [Provisioning](provisioning/README.md)
|
||||
* [Data Model Introduction](provisioning/data-model-introduction.md)
|
||||
* [Creating a Configuration](provisioning/creating-a-configuration.md)
|
||||
* [User Interface](user-interface.md)
|
||||
* [User Interface](user-interface/README.md)
|
||||
* [Devices View](user-interface/devices-view.md)
|
||||
* [API](api.md)
|
||||
* [Monitoring](monitoring/README.md)
|
||||
* [ELK Integration](monitoring/elk-integration.md)
|
||||
|
||||
@@ -1,46 +0,0 @@
|
||||
---
|
||||
description: OpenWiFi 2.0
|
||||
---
|
||||
|
||||
# User Interface
|
||||
|
||||
Release 2.0 uses a Single-Page Application \(SPA\) as an example user interface built using React to demonstrate several interactions using the northbound OpenAPI.
|
||||
|
||||
### Login to OpenWiFi SDK
|
||||
|
||||
|
||||
|
||||
Default username is: tip@ucentral.com and password is: openwifi
|
||||
|
||||
### Devices
|
||||
|
||||
Upon login the first page presented is a Devices table. This table reflects all discovered and managed devices known by the OpenWiFi SDK.
|
||||
|
||||
|
||||
|
||||
Devices table indicates device Connected or Disconnected state in the first column with green and red respectively.
|
||||
|
||||
Certificate column indicates invalid, valid with mismatch serial, or valid device certificate identity state as red crossed seal, yellow seal and green seal respectively.
|
||||
|
||||
Serial Number column links to the device record.
|
||||
|
||||
Compatible model, Tx, Rx, and connected IP Address present basic information of the device type and its connection.
|
||||
|
||||
Three final columns provide Details \(also obtained by selecting the serial number\), Wi-Fi Analysis presenting current Wi-Fi associations and their performance and Refresh commands.
|
||||
|
||||
### Displaying Associations
|
||||
|
||||
From the Devices table, second from right column icon the WiFi Analysis may be accessed. This may also be accessed within the Device View page of a single record along the top right of Statistics section.
|
||||
|
||||
|
||||
|
||||
Within the WiFi Analysis page, all active associations are displayed with the ability to view approximately the last 30 minutes of data reported from the Access Point.
|
||||
|
||||
For each association the device MAC address, mode of connection and SSID are displayed. This will include end devices as well as Wi-Fi infrastructure such as WDS and Mesh associations.
|
||||
|
||||
|
||||
|
||||
Associations have RSSI, Rx Rate & Bytes, Tx Rate & Bytes, MCS negotiated, Number Spatial Streams and IP Address information.
|
||||
|
||||
|
||||
|
||||
@@ -1,25 +1,46 @@
|
||||
---
|
||||
description: TIP Cloud SDK
|
||||
description: OpenWiFi 2.0
|
||||
---
|
||||
|
||||
# User Interface
|
||||
|
||||
## Navigating the UI
|
||||
Release 2.0 uses a Single-Page Application \(SPA\) as an example user interface built using React to demonstrate several interactions using the northbound OpenAPI.
|
||||
|
||||
TIP open source SDK offers a web based user interface supporting many common configurations. The web based interface uses the SDK north bound API.
|
||||
### Login to OpenWiFi SDK
|
||||
|
||||
It is possible to further extend functionality of the SDK user interface or to create other interfaces using the SDK API.
|
||||
|
||||
|
||||
### Log In
|
||||
Default username is: tip@ucentral.com and password is: openwifi
|
||||
|
||||
Default user account is `support@example.com` with password `support`.
|
||||
### Devices
|
||||
|
||||
If using the self-signed certificates provided in the open source distribution, it will be necessary to add an exception to the web browser for the following URLs:
|
||||
Upon login the first page presented is a Devices table. This table reflects all discovered and managed devices known by the OpenWiFi SDK.
|
||||
|
||||
* [https://wlan-ui.wlan.local/login](https://wlan-ui.wlan.local/login)
|
||||
* [https://wlan-ui-graphql.wlan.local/](https://wlan-ui.wlan.local/login)
|
||||
|
||||
|
||||
Devices table indicates device Connected or Disconnected state in the first column with green and red respectively.
|
||||
|
||||
Certificate column indicates invalid, valid with mismatch serial, or valid device certificate identity state as red crossed seal, yellow seal and green seal respectively.
|
||||
|
||||
Serial Number column links to the device record.
|
||||
|
||||
Compatible model, Tx, Rx, and connected IP Address present basic information of the device type and its connection.
|
||||
|
||||
Three final columns provide Details \(also obtained by selecting the serial number\), Wi-Fi Analysis presenting current Wi-Fi associations and their performance and Refresh commands.
|
||||
|
||||
### Displaying Associations
|
||||
|
||||
From the Devices table, second from right column icon the WiFi Analysis may be accessed. This may also be accessed within the Device View page of a single record along the top right of Statistics section.
|
||||
|
||||
|
||||
|
||||
Within the WiFi Analysis page, all active associations are displayed with the ability to view approximately the last 30 minutes of data reported from the Access Point.
|
||||
|
||||
For each association the device MAC address, mode of connection and SSID are displayed. This will include end devices as well as Wi-Fi infrastructure such as WDS and Mesh associations.
|
||||
|
||||
|
||||
|
||||
Associations have RSSI, Rx Rate & Bytes, Tx Rate & Bytes, MCS negotiated, Number Spatial Streams and IP Address information.
|
||||
|
||||
Further instructions available [here](../getting-started/controller.md).
|
||||
|
||||
|
||||
|
||||
|
||||
71
user-interface/devices-view.md
Normal file
71
user-interface/devices-view.md
Normal file
@@ -0,0 +1,71 @@
|
||||
---
|
||||
description: OpenWiFi 2.0 SDK
|
||||
---
|
||||
|
||||
# Devices View
|
||||
|
||||
Each device presents Metrics and Health check data to the Gateway. Devices view displays this information in the following organization:
|
||||
|
||||
* Status
|
||||
* Configuration
|
||||
* Logs
|
||||
* Health
|
||||
* Commands
|
||||
* Statistics
|
||||
* Command History
|
||||
|
||||
|
||||
|
||||
### Status
|
||||
|
||||
Connection status reflects the Gateway to Device current communications status.
|
||||
Uptime and Last Contact reflect communication state.
|
||||
Load indicates processing load on the device.
|
||||
Memory Used indicates free memory on the device.
|
||||
|
||||
|
||||
|
||||
|
||||
### Configuration
|
||||
|
||||
Device UUID, Serial Number, MAC Address and Device Type are displayed.
|
||||
Last configuration update date and timestamp reflects the last time a "configure" action completed on the device.
|
||||
Password may be set and device notes may be added.
|
||||
|
||||
|
||||
|
||||
### Logs
|
||||
|
||||
Log history of the device is presented within Logs. Expand the tile selecting the down arrow.
|
||||
|
||||
|
||||
|
||||
### Health
|
||||
|
||||
Health score is an active tile reflecting the device health out of a score reported by the device to Gateway. Health metrics are configured on the device based on chosen data model options. When the device falls out of 100%, this tile changes to red. Expanding the tile will present all health reports. Those with less than 100% score will contain reasons for the result from this interface.
|
||||
|
||||
|
||||
|
||||
### Commands
|
||||
|
||||
Commands tile provides a number of administrative actions for the user:
|
||||
|
||||
| Command | Action |
|
||||
| :--- | :--- |
|
||||
| Reboot | Warm Restart remote device |
|
||||
| Firmware Upgrade | Initiate firmware upgrade process |
|
||||
| WiFi Scan | Initiate remote scan of surrounding Wi-Fi |
|
||||
| Connect | Initiate an rTTY Remote Shell session |
|
||||
| Blink | Set LEDs to On, Off or Blinking state |
|
||||
| Trace | Initiate a remote Packet Capture |
|
||||
| Factory Reset | Hard Reset remote device - destroys device local config |
|
||||
| Configure | Upload Device Configuration |
|
||||
|
||||
|
||||
|
||||
### Statistics
|
||||
|
||||
|
||||
|
||||
### Command History
|
||||
|
||||
Reference in New Issue
Block a user