Website - FreeWaveTechnologies/ZumIQ GitHub Wiki

The device website provides a means to quickly view or change settings and upload files and firmware updates. It operates in two modes. By default, device settings cannot be changed directly.

Additional information on website use can be found in the ZumLink or ZumIQ User Manual.

NOTE: Many settings in the website are applicable only to the Z9-P/PC/PE radio products and will have no effect on the behavior of the ZIQ-P/PE Application Server.

• Pages

  • User Data - Drag and Drop Files
  • File Upload
  • System Info
  • Configuration
  • Network Diagnostics
  • Help
  • Logout

• Web CLI

  • Examples

In a browser, navigate to http://<device-ip-address>. The home page shows system information:

This page shows the contents of the /ptp directory.

NOTE: This is the same directory available in File Explorer when connected via a USB cable.

This page allows a user to upload a file to the /ptp directory.

NOTE: Files with specific recognized extensions will be processed automatically and do not appear in the directory. This includes configuration and firmware files, which are automatically applied (and may reboot the radio).

This page allows the user to explore settings organized by the device page. The pages are the same as in the CLI. This is simply a visual representation of each setting.

NOTE: The values on the System Info page are read-only. To change settings, you must use one of the following methods:

• Drag-and-Drop a config file onto the device folder in File Explorer.
• Use the ZumLink CLI via a serial connection through the USB port.
• Use the ZumLink CLI via an SSH connection over the network.
• Use the Configuration page.
• Use the Web CLI.

Configuration pages are very similar in appearance to the System Info pages. Unlike the read-only System Info pages, the Configuration pages allow modification of device settings.

Each page contains settings of three different types:

• free text entry boxes
• drop-down multiple-choice lists
• read-only parameters (such as diagnostic or identity parameters)

The settings are identical to those available in the CLI, and are described in detail in the ZumLink or ZumIQ User Manual.

NOTE: There is NO validation of user input in the website. Settings are validated by the device before being applied, but if invalid settings are sent to the device, there is no feedback to the user in the website at this time.

To change settings:

1. Navigate to the desired page
2. Edit the settings
3. Click the "Update" button

NOTE: Use caution when changing settings that can affect connection to the device, particularly those in Network or Radio Settings pages. Changes are applied immediately upon clicking the Update button.

This page displays network diagnostics information.

Download Support Bundle - Downloads a zip file containing various configuration, system diagnostics, and network diagnostics information. This is a snapshot of the status of the unit, and should be provided to FreeWave customer support if there are issues or questions regarding system performance.

Clear Stats - Clears several diagnostics counters.

Refresh Network Diagnostics - Scans the network and displays a list of all radios detected along with their diagnostics information. This may take some time to run. NOTE There must be a radio configured as a Gateway in the network for this feature to work.

Save Network Diagnostics - Exports diagnostics information to a file in JSON format.

Displays the help file. The content is the same as executing the "help" command from the CLI.

Logs out of the device.

The Z9-P/PC/PE and ZIQ-P/PE devices include a Web API that provides access to CLI commands via an HTTP query string.

The general form of the API usage is as follows:

    http://<IP Address>/cli/<CLI Command>

• The CLI Command after "http://<IP Address/cli/" is identical to a command one would type in at the ZumLink CLI prompt.
• The response will be in JSON format (See dumpFormat Json on the ZumLink CLI - Dump Format page)

NOTE: You will need to authenticate with the web server using basic authentication to get access to the Web CLI. All web access uses GET methods, even those used to change device state.

See the Web CLI Example for sample code.

NOTE: The IP address in the examples vary. Be sure to use the IP address of the specific unit you want to communicate with.

Get all pages

http://192.168.111.100/cli/pages

Responds with:

[{"RESPONSE": {"pages": ["system", "systemInfo", "radioSettings", "encryption", "dataPath", "localDiagnostics", "config", "services", "network", "networkStats", "ntp", "Com1", "Com2", "date", "snmp", "security", "runtimeEnvironment"]}, "RESULT": {"MESSAGE": "OK", "RESULT": 0}}]

Get system info

http://192.168.111.100/cli/systemInfo

Responds with:

[{"RESPONSE": {"pages": {"systemInfo": {"deviceName": "", "rteVersion": "FWT1060TB.68", "hopTableVersion": "SET0001HT", "deviceModel": "Z9-PE-DEV", "serialNumber": "4026711656", "resetInfo": "", "deviceFirmwareVersion": "FWT1060TB.68", "radioSerialNumber": "4026711656", "layoutHash": "529070878", "deviceId": "1", "rteTemplateVersion": "FWT1060TB.68", "licenses": "Custom Apps", "radioModelCode": "0", "radioModel": "AMT0100AA", "deviceConfiguration": "R1", "modelCode": "0", "radioFirmwareVersion": "FWT1040TA.11"}}}, "RESULT": {"MESSAGE": "OK", "RESULT": 0}}]

Get txPower

http://192.168.111.100/cli/txPower

Responds with:

[{"RESPONSE": {"pages": {"radioSettings": {"txPower": "27dbm"}}}, "RESULT": {"MESSAGE": "OK", "RESULT": 0}}]']

Set txPower

NOTE: When setting values, you must include the "=" between the parameters and the value in the URL, or URL encode the space:

http://192.168.111.100/cli/txPower=10dbm

or

http://192.168.111.100/cli/txPower%2010dbm

Responds with:

[{"RESPONSE": {"pages": {"radioSettings": {"txPower": "10dbm"}}}, "RESULT": {"MESSAGE": "OK", "RESULT": 0}}]