mirror of
https://github.com/Telecominfraproject/wlan-docs.git
synced 2025-11-20 03:34:53 +00:00
GitBook: [#4] section drafts
This commit is contained in:
Chris Busch
@@ -4,11 +4,11 @@ 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.
|
||||
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`**
|
||||
|
||||
@@ -16,19 +16,19 @@ Default username is: **`tip@ucentral.com`** and password is: **`openwifi`**
|
||||
|
||||
A left side navigation menu provides direction to major feature or service settings.
|
||||
|
||||
|
||||
|
||||
|
||||
## Internationalization
|
||||
|
||||
OpenWiFi 2.0 SDK supports multiple languages. Simply select the desired language from the right drop down for pages to re-populate accordingly.
|
||||
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
@@ -38,19 +38,19 @@ 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.
|
||||
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.
|
||||
|
||||
@@ -58,9 +58,8 @@ Associations have RSSI, Rx Rate & Bytes, Tx Rate & Bytes, MCS negotiated, Number
|
||||
|
||||
OpenWiFi SDK provides visual indications on the overall health of the deployed Wi-Fi network. this includes Device Status for connected and non-connected devices. Device health indicating percentage of devices failing a health check. Distribution of devices by vendor in the network and by model.
|
||||
|
||||
|
||||
|
||||
|
||||
Additionally, verified certificates or serial mismatch certificates, number of Command actions from all Gateways to devices and devices with greater than 75% memory utilization, greater than 50% less than 75% memory and less than 50% utilization are displayed.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ description: OpenWiFi 2.0 SDK
|
||||
|
||||
Each device presents Metrics and Health check data to the Gateway. Devices view displays this information in the following organization:
|
||||
|
||||
* Status
|
||||
* Status 
|
||||
* Configuration
|
||||
* Logs
|
||||
* Health
|
||||
@@ -14,51 +14,50 @@ Each device presents Metrics and Health check data to the Gateway. Devices view
|
||||
* 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.
|
||||
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.
|
||||
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 |
|
||||
|
||||
|
||||
| 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 |
|
||||
|
||||
|
||||
|
||||
@@ -6,21 +6,20 @@ description: OpenWiFi SDK 2.0
|
||||
|
||||
Multiple events are recorded in the Command History tile. Each line item will have a Result, Details, and Delete action.
|
||||
|
||||
|
||||
|
||||
|
||||
When an rTTY session is executed, this is a displayed command history. Selecting the Result icons will display the Success or Fail of the command.
|
||||
|
||||
|
||||
|
||||
|
||||
Each provisioning event is reflected as a configure command history. To see the entire JSON payload and the result, including success or error with message, simply select Details to expand the dialog below with this data. A date and time in the third column indicates when the configure command was executed successfully.
|
||||
|
||||
|
||||
|
||||
|
||||
If a provisioning event has failed to complete, its command history for configure will show as pending.
|
||||
|
||||
|
||||
|
||||
|
||||
Remote packet capture is shown as the trace command history. When packet captures are persisted in the OpenWiFi SDK, they may be downloaded again through the cloud download icon.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -4,60 +4,60 @@ description: OpenWiFi 2.0 SDK
|
||||
|
||||
# Commands
|
||||
|
||||
Within the devices view, the Commands tile offers a number of features and administrative actions.
|
||||
Within the devices view, the Commands tile offers a number of features and administrative actions.\
|
||||
Each of these represent API calls exposed on the OpenAPI northbound interface from the SDK.
|
||||
|
||||
## Reboot
|
||||
|
||||
Selecting the Reboot action will prompt the below dialog. Options presented permit an immediate reboot or a scheduled reboot based on date and time.
|
||||
|
||||
|
||||
|
||||
|
||||
## Firmware Upgrade
|
||||
|
||||
Multiple methods exist to execute a remote Firmware Upgrade of a device. When selecting Firmware Upgrade via the Commands tile, a simple dialog to upgrade immediately or at a scheduled time is presented. Alternatively using the Firmware Management Service provides a complete solution including managed access to all TIP firmware images.
|
||||
|
||||
|
||||
|
||||
|
||||
## Wi-Fi Scan
|
||||
|
||||
OpenWiFi devices may perform channel scanning and return this neighbor and RF data to the SDK in an on demand or ongoing manner.
|
||||
|
||||
|
||||
|
||||
|
||||
### Wi-Fi Scan Results
|
||||
|
||||
Scan operations function over all channels. If 5GHz channels do not display in the returned results \( either via the UI or over API \) this indicates the device is configured in a DFS channel for which it may not return survey scans at this time.
|
||||
Scan operations function over all channels. If 5GHz channels do not display in the returned results ( either via the UI or over API ) this indicates the device is configured in a DFS channel for which it may not return survey scans at this time.
|
||||
|
||||
|
||||
|
||||
|
||||
## Connect
|
||||
|
||||
OpenWiFi enables remote connection to any managed device using rTTY encrypted shell session. Selecting Connect will cause a browser tab to open with the login session to current device.
|
||||
|
||||
|
||||
|
||||
|
||||
## Blink
|
||||
|
||||
To assist with remote identification of devices in the network, it is possible to turn the LED lights On, Off, of continuous blinking. This may be run on-demand or scheduled.
|
||||
|
||||
|
||||
|
||||
|
||||
## Trace
|
||||
|
||||
Trace feature enables a remote packet capture to occur on the managed device, over a specified period of time or amount of traffic, returning the "pcap" packet capture file locally to the OpenWiFi admin user.
|
||||
|
||||
|
||||
|
||||
|
||||
Once complete the user is asked to open or save the packet capture file locally.
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
## Factory Reset
|
||||
|
||||
It is possible to revert a device to initial out of box state from the OpenWiFi SDK. Sending a Factory Reset will remove all configuration on the device and optionally reset the discovered cloud stored as the 'Redirector' in the device configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
{% hint style="info" %}
|
||||
Note: When Redirector is not kept, devices will re-contact the Certificate Authority to re-discover their OpenWiFi cloud address
|
||||
@@ -67,5 +67,4 @@ Note: When Redirector is not kept, devices will re-contact the Certificate Autho
|
||||
|
||||
Prior to the introduction of OpenWiFi 2.0 Provisioning Service, device configuration is done through creation of the JSON provisioning file and either loading that file or applying its contents using the dialog presented via Configure. The same options exist when using the API directly.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -6,15 +6,15 @@ description: OpenWiFi 2.0 SDK
|
||||
|
||||
Each device page presents statistics in traffic terms per interface as a line graph of bandwidth over time.
|
||||
|
||||
|
||||
|
||||
|
||||
The generated image may be downloaded for offline use.
|
||||
|
||||
|
||||
|
||||
|
||||
Accessing Wi-Fi Analysis and Last Statistics may be found at the top right of Statistics tile.
|
||||
|
||||
|
||||
|
||||
|
||||
## Wi-Fi Analysis
|
||||
|
||||
@@ -24,7 +24,7 @@ Viewing associations, from the Associations table, and their use is important in
|
||||
|
||||
Each association is known by their MAC address or BSSID value. The mode of connection will indicate if an end user client device entering the "ap" or if a client is associated as "wds" or "mesh.
|
||||
|
||||
|
||||
|
||||
|
||||
The access point view of RSSI, Rx and Tx Rate, Modulation Coding Scheme and Number of Spatial Streams are exposed for each association.
|
||||
|
||||
@@ -34,5 +34,4 @@ Using the slider along the top, the last 15 to 30 minutes of performances data m
|
||||
|
||||
The option to view Latest Statistics is at time of the MVP release, intended to help the Community see on a per device basis how much, or how little depending on device configuration, is being sent to the OpenWiFi Gateway in terms of telemetry.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -10,13 +10,13 @@ Firmware management service integrates across all OpenWiFi Gateways deployed in
|
||||
|
||||
Firmware dashboard provides a single view for overall health of deployed device firmware. Latest firmware charts, device firmware version distribution, distribution of device by type and current connected devices.
|
||||
|
||||
|
||||
|
||||
|
||||
## Device Table
|
||||
|
||||
From the Devices table, any device with a newer firmware published by TIP OpenWiFi is indicated with a yellow icon. Selecting this icon presents the option to upgrade to latest or specify which firmware to use.
|
||||
|
||||
|
||||
|
||||
|
||||
When the upgrade has been sent successfully, a green Success dialog will display in the upper right on the screen. Devices with latest firmware version will show a green firmware icon in the Devices row.
|
||||
|
||||
@@ -26,11 +26,10 @@ Viewing the contents of Firmware Management Service is available from the left n
|
||||
|
||||
Once in Firmware, it is possible to search by device model for all known firmware revisions.
|
||||
|
||||
|
||||
|
||||
|
||||
If in the Device Table reference above, instead of selecting Upgrade to Latest, the specific URI location of any available firmware is found using the Firmware table.
|
||||
|
||||
Selecting Details will present information for any firmware row, including the URI which may be copied into the Choose Custom Firmware dialog prompt accordingly.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user