SmartServer IoT Browser Help

The SmartServer IoT Browser Web page is a diagnostic tool for the SmartServer IoT. Use with caution as it is a work in progress tool and not intended to be used on a production site.

SmartServer User Guides and downloads

The Browser Web page provides the SmartServer data in a different format then the CMS, and has features that are not implemented in the CMS (for example, the Data Log view shows datapoint data logs for multiple datapoints and datapoints with fields on a single chart, and the Dashaboard View shows sample dashboard UI for the listed datapoints).

First configure the SmartServer with the CMS Web pages. You can then use the SmartServer IoT Browser Web page to monitor and control device datapoints and read the SmartServer configuration. The Browser Web page provides Views selected by the left-hand sidebar menu buttons. For example, the sidebar Planning button shows the Planning View which shows a naviagation tree in which you can navigate to a device or to the device's datapoints.

Many of the textboxes like the Dashboard Datapoint textbox are dropdown textboxes (combo-boxes), delete the text and click the textbox to see the dropdown list

Adding Devices and configuring the SmartServer

Setup your SmartServer with the CMS (adding devices, datapoint properties, schedules, data log, and alarms) and then you can use the Browser Web page to monitor and control datapoints.

Issue with using multiple WebSocket Web pages

The Browser Web pages uses WebSockets like the CMS Web pages and so only one Web Socket Web pages should be opened at a time for a given user otherwise the Web pages may interfere with each other, see Known Issues below

The Dashboard and Favorite DPs view are the primary way to look at a subset of datapoints from one or more devices. Datapoints are added to the Favorite DPs view using the Planning or Datapoints view and checking the datapoint FAV checkbox.

Typical Use Cases

See up and down devices - go to Planning View to see navigation tree and which context has problem devices, device summary shown in Web page footer
Look at a device's datapoints
- Planning View - go to the Planning View, navigate to a device or a device's datapoint
- Device View - go to Devices View, use device list or filter on devices, and then click on Menu "..." button for specific device and select Show Dashboard or Show Datapoints.
- Datapoint View - go to Devices View, use the "Get DPs by Filter" and specify device name, device type, or datapoint names>.
Look at at a subset of datapoints from one device or multiple devices
- Planning View
  - In the tree, click on a device or datapoint to see the datapoint table.
  - Check the datapoint FAV checkbox for the datapoints you want to see.
  - Continue to go to check FAV checkbox for any additional datapoints as needed
  - Click the FAV Dashboard button to see a dashboard of the selected datapoints
  - Go to the Favorite DPs view to remove or save the Favorite list to the CMS
- Datapoints View
  - go to Datapoints View
  - use Get DPs by Filter button to see list of datapoints
  - check the FAV checkbox for all datapoints you want to look at later. Keep changing filter and checking the Datapoint checkboxes for datapoints you want to look at
  - Once done go to Favorite DPs View to see list. You can save the Favorite DPs list to the CMS favorites so that you can access these same datapoints later.
  - Look at CMS Favorite Datapoints list - Go to Favorite DPs view and click the FAVs Menu to see all Favorites in CMS.
Chart Datapoints
- Dashboard View - charts scalar datapoints on individual charts
- Data Log View - charts scalar and structured datapoints on a single chart
- To get logs for device
  - Go to Planning view and click on device in the tree and click the "Logs" button
  - Go to Devices view and click on device's action menu "..." and click the "Show Data Logs" button
  - Go to Data Logs view and type in device name and click the "Get" button
- To get logs for specific datapoint
  - Go to Planning view expand tree and click on datapoint in the tree and click the "Logs" button followed by clicking "Get" button
  - Go to Datapoints or Favortie DPsview and click on datapoint's action menu "..." and click the "Show Data Logs" button
  - Go to Data Logs view and type in datapoint instance path or XIF datapoint path and click the "Get" button. For example:
    - Sensor1/Lamp/0/nvoLampFb
    - Sensor1/*/*/nvoLampFb
    - Sensor1/Lamp/0/nvoLampFb,Controller/Lamp/0/nviLampFb
    - xifname:Sensor1/Lamp/0/nvoLampFb
    - xifname:Sensor1/*/*/nvoLampFb
    - xifname:Sensor1/Lamp/0/nvoLampFb,Controller/Lamp/0/nviLampFb
- To get logs for group of datapoint - use Datapoints or Favorite Dps views to build up list of datapoints and then click the view "Data Logs" button

Browser Layout

Header
- Shows SmartServer CMS version and The SmartServer IoT Browser Web page version
- EPS - Events per second, same as shown in CMS Web page
- CPU - Same as shown in CMS Web page, but only opening up a CMS Web page will start the CPU updates
- ? - help button
- Logout button - Log out of the SmartServer
Sidebar Menu (left side of web page) - This is where you select which view you want to look at
Main Workspace - This is where you do most of your work
Footer - provides device status (only updated when you first start Web page or when you click Refresh all in the Planning View)

Browser Views (Sidebar Menu Buttons)

Planning - Provides a navigation tree (Similar to CMS Planning Widget, but this Web page also shows devices and device datapoints)
- The Planning View is made up of navigation tree pane on the left and a details pane on the right
- The Planning View Navigation tree shows the number of devices applied to a specific node (to a specific Planning context) and will show a status icon if any devices are down or un-provisioned.
  - Show All Devices or Hide All Devices button - this button is used to shows or hide all the devices in the tree
  - Context nodes
    - Campus node - when clicked will show devices assigned to the campus context
    - Building Node - when clicked will show devices assigned to the campus context
    - Floor Node - when clicked will shows the floor floor-plan with all room and area shapes and devices assigned to this floor
    - Room Node - when clicked will shows the floor floor-plan with the room shape for this specific room and all devices assigned to this floor
    - Area Node - when clicked will shows the floor floor-plan with the area shape for this specific area and all devices assigned to this floor
  - Devices node
    - Clicking Node - Shows info for all devices
    - Color Status Icons
      - No color status icon will be shown if all devices for a given tree node are provisioned and are up and running
      - Yellow - At least one provisioned device is down
      - Red - All provisioned devices are down
      - Blue - At least one unprovisioned (or provisioning device)
  - Device node
    - Clicking Node - Shows all datapoints
    - Color Status Icons
      - Green - device is UP (normal)
      - Red - Device is down
      - Blue - Device is unprovisioned (or provisioning)
    - Dashboard button is used to show a dashboard for the Device's datapoints
    - FAV Dashboard button is used to show a dashboard for the datapoints that have been added to the FAV list
      1. Allows you to see datapoints from different devices
    - Logs button is used to see the data logs for this device's datapoints
    - Datapoints button is used to show Device's datapoints in Datapoint View
    - DP Info button is used to show how the devices datapoints are used by the Smartserver (e.g., schedules, alarms, data log and Node-RED)
    - Test button is used to verify communication to a device (supported for all protocols like LON, BACnet and Modbus)
    - Wink button is only supported for LON devices (not all LON devices support Wink) so the Wink button is enabled for LON devices and disabled for other devices
    - Properties checkbox - used to show datapoint properties for all the device's datapoints.
      - Not all properties in the Datapoint Properties view show up in the datapoint table
      - The datapoint table shows Monitoring, presets and localization properties but doesn't show Logging and alarming properties
      - Click Menu button then Show Properties button to see the Datapoint Properties View for this these specific datapoints
    - Re-Suscribe button - click this button if poll is checked but datapoints are updating
    - Refresh button is used to refresh the datapoint properties
    - Fav checkbox - Allows you to add or remove the spefic datapoint from the FAV Datapoints list
    - Menu - Provides access to information specifically for this datapoint
  - Datapoints node
    - Clicking Node - Shows datapoint info
    - Dashboard button is used to show a dashboard for only this datapoints
    - FAV Dashboard button is used to show a dashboard for the datapoints that have been added to the FAV list
      1. Allows you to see datapoints from different devices
    - Logs button is used to see the data logs for this datapoints
    - Datapoints button is used to show this datapoint in Datapoint View
    - DP Info button is used to show how the devices datapoints are used by the Smartserver (e.g., schedules, alarms, data log and Node-RED)
    - Properties checkbox - used to show datapoint properties for this specific datapoint.
      - Not all properties in the Datapoint Properties view show up in the datapoint table
      - The datapoint table shows Monitoring, presets and localization properties but doesn't show Logging and alarming properties
      - Click Menu button then Show Properties button to see the Datapoint Properties View for this these specific datapoints
    - Fav checkbox - Allows you to add or remove this datapoint from the FAV Datapoints list
    - Menu - Provides access to information specifically for this datapoint
- In the main workspace you will see the floor plans or device. Devices show up in the floor plan as a round icon. Each Device icon represents one or more devices. The color denotes the status (green = normal). Clicking the device icon: For a single device, you will get the device menu. For multiple devices will show a list of devices (click specific device to see its device menu).
- In the Sites Navigation tree, if you click the floor, room and most areas nodes you will see the floor plans that you configured in the CMS.
- The planning Navigation Tree will show a status if any devices at that level are down, or un-provisioned. Clicking a device shape (a colored circle) in the right-hand pane will either open a device menu or a device list (if more than one device at the same location).
- Refresh All button will re-load the entire planning tree and gets a list of all devices.
- Refresh button only refreshes the device information.
Dashboard – Shows a datapoint dashboard View which is more like what you would want end-customers to see.
- First you need to select the datapoints from the one of the following views Planning, Devices, Datapoints or Favorite DPs before going to the Dashboard View
- The charts defaults to getting last 1 hour for a datapoint and getting live data (polling defaults to enable).
- Chart All Scalar Outputs checkbox - allows you to control whether scalar datapoints are charted or not.
- Charts with read/write datapoints will have a "..." button which can be used to write to the datapoints.
- Re-Subscribe button - use if datapoints don’t seem to update due to two WebSocket web pages being open at the same time for the same User login.
  - Doing so can affect other Web pages opened with this user login.
- Pause/Continue button - use to pause or re-start polling.
- refresh button - used to restart by first getting the current log data.
- Clear Chart button - clears the chart data.
- Advanced checkbox - shows advanced features
  - Log checkbox - used to enable or disable initially getting log data
  - 10 Min Log/1 Hour Log/1 Day Log dropdown - used to select how much log data to get when first starting
  - Duration dropdown - Used to select the duration of log + live data to keep, older data discarded
  - Poll Enabled checkbox - Default checked, enables or disables background polling
  - Stepline checkbox - When checked chart line shows a step line, otherwise it shows a trend line
  - Chart All Scalar Outputs checkbox - All Scalar Outputs and BACnet inputs are show in charts instead of datapoint table
  - Chart Tooltip checkbox - when checked a mouse tooltip will show up when hovering over a chart
  - Presets checkbox
    - when checked the chart tooltip will show the datapoint preset if it exists instead of the datapoint value
    - When unchecked the chart always shows the datapoint value
  - Decimal Places dropdown - limits the number of decimal places for a number greater than 1
    - all - no limits
    - none - makes the number into an integer
    - 1, 2, 3, 4 - number of decimal places
    - Click Refresh button to see change in charts
  - Save button - Used to save the Dashboard data into a file
    - Save Current Value button - save latest values for all datapoints
    - Save Current + Current button - saves the current value and if there is a chart is saves all the chart data
    - Close button - exits the dialog
- Writing to datapoints in the table if there is no Send button then pressing the enter key after you changed the number will send the new value to the SmarServer
Devices– shows device list based on Device Filter.
- Get Devices By Filter button - gets information for the listed devices based on a filter.
- Refresh All button - gets information for all devices.
- Refresh button - gets information for the listed devices
- Test All button - causes SmartServer to test all provisioned devices while Web page is up and showing Devices View
- Show Network Addresses button - shows the Devices Domain/Subnet/Node IDs for all devices which is usefull for troubleshooting.
Datapoints – similar to CMS Datapoint Browser Widget (DBW)
- FAV checkbox - used to add datapoint to Favorite DPs view.
- Dashboard button - shows you the dashboard view for the listed datapoints.
- Data Logs button - populates Data Log View Datapoint list.
- Clear button - clears all the Datapoints from the list.
- Get BrowserFav button - gets the last "BrowserFav" CMS Favorite (that you must create first with Save BrowserFav)
- Save BrowserFav button - saves the datapoint list to the CMS Favorites list.
- FAVs Menu button - shows you the list of CMS Favorites and allows you to get or append the favorites datapoints.
- Clear button - clears all the Datapoints from the list.
- Poll - checkbox enables background on-demand polling by the Browser Web page at the rate specified
  - Web page will poll no faster than 10 datapoints every two seconds.
- On Demand - does a one time on-demand get of the datapoint values.
- FAVs Menu - shows you the list of CMS Favorites and allows you to get or append the favorites datapoints.
- Clear button - clears all the Datapoints from the list.
- Re-Subscribe button - use if datapoints don’t seem to update due to two WebSocket web pages being open for the same User login.
  - Doing so can affect other Web pages opened with this user login.
Caution: Priorities are not updated every poll request, use the Refresh button to update poll rates. If datapoints don't seem to be updating see Known Issues.
Favorite DPs– Used to show a subset of datapoints.
- Use Datapoint View or CMS FAVs to select datapoints to view.
- Dashboard button button - shows you the dashboard view for the listed datapoints.
- Data Logs button - populates Data Log View Datapoint list.
- Clear button - clears all the Datapoints from the list.
- Get BrowserFav button - gets the last "BrowserFav" CMS Favorite (that you must create first with Save BrowserFav)
- Save BrowserFav button - Saves the datapoint list to the CMS Favorites list.
- FAVs Menu button - Shows you the list of CMS Favorites and allows you to get or append the favorites datapoints.
- Clear button - clears all the Datapoints from the list.
- Poll button - checkbox enables background on-demand polling by the Browser Web page at the rate specified
  - Web page will poll no faster than 10 datapoints every two seconds.
- On Demand button - does a one time on-demand get of the datapoint values.
- FAVs Menu button - shows you the list of CMS Favorites and allows you to get or append the favorites datapoints.
- Clear button - clears all the Datapoints from the list.
- Re-Subscribe button - use if datapoints don’t seem to update due to two WebSocket web pages being open for the same User login.
  - Doing so can affect other Web pages opened with this user login.
Caution: Priorities are not updated every poll request, use the Refresh button to update poll rates. If datapoints don't seem to be updating see Known Issues.
Show DP Info – Shows how a datapoint or a devices datapoint is used in the SmartServer.
- The device is selected in Planning or Device Widget, individual datapoints are selected in Datapoint or Favorite DPs.
- Datapoint Information: Current value, Datapoint Properties(or DLA), Schedules, alarms, connections and Node-RED
Active Alarms – shows active alarms only.
- Once you see an active alarm you can look at Alarm Definitions
Data Logs - Shows Table and Chart for logged or live data
- Displays scalar (single line) and structured (one line for each field) datapoints
- Click the Empty Datapoint textbox to see a list of datapoint requests, and click Empty Duration textbox to see list of durations
- Datalog support three modes
  - log + log - Get log data and if Poll checkbox checked continue getting new log data
    - If Duration textbox incudes "thru" then polling is disabled even if Poll checkbox checked, to restart uncheck and recheck Poll checkbox
  - log + live - Get log data and if Poll checkbox checked then gets live data
    - If Duration textbox incudes "thru" then polling is disabled even if Poll checkbox checked, to restart uncheck and recheck Poll checkbox
  - live only - Get live data if Poll checkbox checked
- Chart features
  - show Tooltip - click on the chart to see datapoint value and time where mouse clicked
    - Tooltip shows up above upper-left hand corner of the chart
    - You may need to stop polling in order to see the tool tip
  - Zoom - press mouse left-hand button down and drag mouse
    - may need to pause polling first
    - To unzoom - Double-click left-hand mouse button
- Re-Subscribe button - use if datapoints don’t seem to update due to two WebSocket web pages being open for the same User login.
  - Doing so can affect other Web pages opened with this user login.
- Get button - used to get data logs
  - Disabled for "live only"
- Legend checkbox - used to select or un-select all chart lines
  - Clicking on Table header will sort table based on column
- DP sort button - sorts table based on Block/DP name
  - Clicking on Table header will sort table based on column
- Clear Log button - clears table and chart
  - If Poll checkbox checked then chart and table will show new logs or live datg
- Copy to Clipboar button - copies table data to Windows Clipboard
- Save button - saves table data to Windows download folder
- Stepline Chart checkbox - when checked shows chart lines as steplines (shows duration of at each level), otherwise shows trend
- Y-Axis show Min Max checkbox - shows chart Y-axis range as either 0-to-max values or min-to-max values
- Y-Axis Displayed radio buttons - Only shows up if Chart uses two axis, and is used to select which Y-axis to show
  - The chart may show two Y-axis if it is displaying more than one datapoint and one datapoint has a value of close to 1 and another close to 100. For example, SNVT_switch has two fields, a "state" with a value between 0 - 1 and a "value" with a value between 0 - 100 which causes the Chart to show two Y-axis so that you can see the transitions for both "state" and "value".
  - Display Types
    - Both Y1 and Y2 - shows all datapoints using two Y-axis
    - Y1 Only - only shows datapoints that use the Y1 axis
    - Y2 Only - only shows datapoints that use the Y2 axis
    - Single - shows all datapoints using a single Y-axis
Schedules– shows all the schedules in a table.
- Refresh All will show all schedules,
- Refresh just refreshes the current selected schedule events
Device Types – Shows Device’s Device types
Datapoint Properties – Shows all Datapoint Properties for a specific Device Type (DLA settings)
Node-RED – shows which devices and datapoints are used in Node-RED IAP Input and IAP Output Nodes.
- Calculates estimated EPS usage by enabled flow tabs (doesn't take into account IAP Input nodes which are disabled unless the flow tab is disabled)
Service Pin Messages– LON Devices only - Shows Service pin messages received by SmartServer while in this view.
- This is useful if you want to check determine a devices UID (neuron ID) and program ID, or want to check network connectivity
API Tester – Used to test REST API requests (can’t be used to see WebSocket updates).
- All REST request require you to encode special characters before sending them to the SmartServer. The Browser API Tester tries to encode these characters but may not cover all situation and you may need to do the encoding prior to putting the command into the Request textbox.
- Encoding Examples:
  - *+utc>2021-03-11T09:00:00.000&utc<=2021-03-11T16:28:32.000
    Encoded:
    *+utc>2021-03-11T09:00:00.000%26utc<%3D2021-03-11T16:28:32.000
  - *+utc>2021-03-11T09:00:00.000&utc<=2021-03-11T16:28:32.000
    Encoded:
    *+utc>2021-03-11T09:00:00.000%26utc<%3D2021-03-11T16:28:32.000
- If your request doesn't work then it may be due to the request URI encoding.
  - You may need to uncheck the Encode Request String checkbox and do your own URL encoding by breaking up your request URI into substrings and encode the substrings using the String to Encode textbox and Encode button
  - If the built-in encoder is too strong, you may need to uncheck the Encode Request String checkbox and do your own encoding
- There is a link to the Parameters and Queries in the SmartServer IoT Developer's Guide included in the API Tester view.
- Click the Empty Request textbox to see a list of example REST commands.
  - You may need to modify them to make them work with your SmartServer and your devices.
- Advanced checkbox to do Put, Post or Deletes REST requests, and to see uri encoding functions
- Click the empty Advanced Request textbox to see examples PUT/POST/DELET request URIs. When you select one of the examples it will populate the Request and Payload textboxes with the appropriate values.
- Encode Request String checkbox
  - when checked the uri will have minimal encoding
  - when unchecked you will have to manually do then encoding
- Encode button - encodes the string in the String to Encode textbox, which is meant to be a substring of the uri
- To see WebSocket updates use the Web Browser (F12) debugger mode and look for “ws” and then look at the responses.
Licensing - Allows you to see current licenses, see available licenses, activate and revoke licenses.
- This is useful to get detailed information about Device Capacity and Maintenance Licenses

Troubleshooting and Known Issues

Datapoints don't seem to update in one of the following Views: Planning, Datapoint, Favorite DPs, Dashboard or Datalog (log + live, or live only);
This may be due to of the following:
1. This may occur if the PC/Laptop hiebernated or was put to sleep after logging in to the Browser Web page - log out and re-log in
2. More than one WebSocket Web page (CMS Web page or another Custom Web page) is open using the same login
  Workarounds: choose one
  1. Click the re-Subscribe Button - this can affect the other Web Browser Web page.
  2. Open the Browser Web page using a different user login
Datapoint priorities are incorrect
1. Datapoint priorities are not provided in the polling information so have to be polled at a slower rate
2. Click the refresh button to refresh priority information
3. Affects Planning, Dashboard, FAV Datapoints and Datapoint views
Data Log Chart Zoom doesn't always work
1. May need to pause polling first by unchecking the Poll checkbox
Dashboard Temperature and Light guage stop working (stuck at some value)
1. This issue doesn't happen immediately and may take some time
2. So far only seen with Firefox and not with Chrome
3. Workaround - go to another view and then back to the Dashboard view

Releases

1.25
- Works with SmartServer IoT 3.30.025 - older SmartServer versions may not work
- Added Licensing views
1.20
- Works with SmartServer IoT 3.10 and 3.20.121 - older SmartServer versions may not work
- Added feedback delay when writing to datapoints in order to reduce datapoint values flipping back and forth between new and old values.
- Planning view
  - Tree pane is now resizeable - click and drag lower-right hand corner
1.19
- Tested with SmartServer IoT 3.10 and 3.20.119 - older SmartServer versions may not work
- Fully support 3.20 REST and WebSocket API changes - request name changes
- Planning view
  - Added FAV Dashboard, select the datapoint you are interested in and click all FAV Dashboard to see a dashboard with all the favoorites datapoints
  - Added datapoint menu for easier navigation to other configuration information (i.e., data log, datapoint properties, schedules)
  - can now now see datapoint properties for this specific data point (use properties checkbox) or use Menu to see properties for device type
- Device view - Added Test All button which can be used to do a managed test on all provisioned devices
- Data log view - can now get logs for specific datapoint
- Added Node-RED View
- Add number of other major enhancements and bug fixes
1.17
- Tested with SmartServer IoT 3.10 and 3.20.114 - older SmartServer versions may not work
- Started supporting 3.20 REST and WebSocket API changes - request name changes
- Planning tree - added devices and datapoints to tree
- Device status changes show up automatically in Planning tree Devices status and Device status in Browser footer
1.09
- Tested with SmartServer IoT 3.10 - older SmartServer versions may not work
1.08
- Tested with SmartServer IoT 3.10 - older SmartServer versions may not work
- Dashboard shows 1 hour datalog followed by live data and you can now save the data
- Datalog - added "log + live" and "live only" modes
1.02 - First Release for CMS 3.10