diff --git a/.gitbook/assets/screen-shot-2021-03-28-at-1.25.04-pm.png b/.gitbook/assets/screen-shot-2021-03-28-at-1.25.04-pm.png new file mode 100644 index 0000000..fe34de5 Binary files /dev/null and b/.gitbook/assets/screen-shot-2021-03-28-at-1.25.04-pm.png differ diff --git a/.gitbook/assets/screen-shot-2021-03-28-at-1.32.36-pm.png b/.gitbook/assets/screen-shot-2021-03-28-at-1.32.36-pm.png new file mode 100644 index 0000000..abce94e Binary files /dev/null and b/.gitbook/assets/screen-shot-2021-03-28-at-1.32.36-pm.png differ diff --git a/.gitbook/assets/screen-shot-2021-03-28-at-12.49.50-pm.png b/.gitbook/assets/screen-shot-2021-03-28-at-12.49.50-pm.png new file mode 100644 index 0000000..36db39f Binary files /dev/null and b/.gitbook/assets/screen-shot-2021-03-28-at-12.49.50-pm.png differ diff --git a/.gitbook/assets/screen-shot-2021-03-28-at-12.50.28-pm.png b/.gitbook/assets/screen-shot-2021-03-28-at-12.50.28-pm.png new file mode 100644 index 0000000..348ad60 Binary files /dev/null and b/.gitbook/assets/screen-shot-2021-03-28-at-12.50.28-pm.png differ diff --git a/user-interface/README.md b/user-interface/README.md index cb263be..f3f6ddb 100644 --- a/user-interface/README.md +++ b/user-interface/README.md @@ -1,4 +1,23 @@ +--- +description: TIP SDK +--- + # User Interface -Navigating the UI +## Navigating the UI + +TIP open source SDK offers a web based user interface supporting many common configurations. The web based interface uses the SDK API. It is possible to further extend functionality of the SDK user interface or to create other interfaces using the SDK API. + +### Log In + +Default user account is `support@example.com` with password `support`. + +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: + +* [https://wlan-ui.wlan.local/login](https://wlan-ui.wlan.local/login) +* [https://wlan-ui-graphql.wlan.local/](https://wlan-ui.wlan.local/login) + + + +![TIP SDK Login Screen](../.gitbook/assets/screen-shot-2021-03-28-at-12.50.28-pm.png) diff --git a/user-interface/dashboard.md b/user-interface/dashboard.md index 96f5121..56b4ecb 100644 --- a/user-interface/dashboard.md +++ b/user-interface/dashboard.md @@ -1,2 +1,77 @@ +--- +description: Cloud SDK Default Landing Page +--- + # Dashboard +The TIP Cloud SDK is organized into main components organized along the top of the screen. + +![Cloud SDK User Interface Top Navigation](../.gitbook/assets/screen-shot-2021-03-28-at-1.25.04-pm.png) + +Dashboard is the default landing page for the user interface. +Network enables management of Access Points and display of Client Devices status. +Profiles enables template based management of all provisioning parameters. +System enables Manufacturer OUI Updates, Firmware Updates, Auto-Provisioning and Client Block List. +Users enables configuration of local user accounts of the Cloud SDK. + +Alarm indicates an error condition has occurred with one or multiple Access Points. Consult the Network tab. +Gear icon to LogOut. + +### Dashboard Components + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ComponentDescription
Access Point +

Total Provisioned Access Points

+

In Service Access Points ( Actively Reporting )

+

With Clients ( Actively Reporting and with Associated Wi-Fi Devices )

+
Client Devices +

Total Associated as a numeric total of associated Wi-Fi clients

+

5GHz as a numeric total of associated Wi-Fi clients over 5GHz

+

2GHz as a numeric total of associated Wi-Fi clients over 2GHz

+
Usage Information24 Hour Report of total bandwidth Upstream and Downstream across all Access + Points
Inservice APs24 Hour line graph of Actively Reporting Access Points
Client Devices24 Hour line graph of Associated Wi-Fi Client Devices
Traffic24 Hour line graph of Total Traffic Upstream and Downstream
AP VendorsPie Chart graph of AP Vendors by Organizational Unique Identifier
Client VendorsPie Chart graph of Client device Vendors by Organizational Unique Identifier
+ +![Cloud SDK Dashboard](../.gitbook/assets/screen-shot-2021-03-28-at-1.32.36-pm.png) + + +