Page tree
Skip to end of metadata
Go to start of metadata

SmartServer 3.1 and prior releases

For SmartServer 3.1 or prior, see Defining Datapoint Properties (Release 3.1) in the Documents Archive area. 

This section consists of the following:

Displaying Datapoint Properties

Note: Click the Expand button (  ) for a better view of this widget. 

Viewing Unconfigured Datapoints

To view the unconfigured datapoints, click the Action button () on the Datapoint Properties widget and select the Show Unconfigured Datapoints action.

 

The unconfigured datapoints appear on the Datapoint Properties widget displaying the following:

  • Device type – the device type name

  • Block name – the block name

  • Block index – blocks with the same type are sequentially numbered, starting at 0 for the first block

  • Datapoint XIF name – the datapoint name

  • Datapoint type – the datapoint type name
  • Monitored – indicates that monitoring is configured for the datapoint

  • Logged – indicates that logging is configured for at least one log for the datapoint

  • Alarmed – indicates that at least one alarm or warning is configured for the datapoint

Each heading has a Sort button (). When clicked, the datapoint list is sorted in forward or reverse order by the selected heading.

Hiding Unconfigured Datapoints

To hide the unconfigured datapoints, click the Action button () on the Datapoint Properties widget and select the Hide Unconfigured Datapoints action.

The unconfigured datapoints no longer appear.

Viewing / Hiding Total Datapoint Properties Parameters

To view the total datapoint properties parameters, click the Show Total Datapoint Properties Parameters button () located at the top, right part of the Datapoint Properties widget.

Doing so displays the following information:

  • Total Monitoring Traffic Indicator – displays the calculated packets per second for monitoring traffic; keep this number below 40 for optimal performance.
  • Total Logged Bytes – displays the estimated logged bytes per day

  • Data Annual Log Size – displays the estimated log size after one year in bytes (B)

Operational Considerations

If at any time your logged datapoints exceeds 8 GB, system performance will be degraded and operational failures may occur. With SmartServer 3.2 and higher, configurable parameters for annual log size warnings and errors are defined in the com.echelon.cms.global.cfg file. The warning default is 7 GB and the error default is 8 GB. A warning message will appear if you specify logging parameters that will cause the calculated data log size to exceed these parameters.

To hide the total datapoint properties parameters, click the Hide Total Datapoint Properties Parameters button () located at the top, right part of the Datapoint Properties widget.

Doing so hides the total datapoint properties parameters information from the Datapoint Properties display.

Viewing / Hiding Datapoints in the Datapoint Browser

By default, all of the datapoints are configured to be displayed in the Datapoint Browser widget.

If you want to hide datapoints so they do not appear in the Datapoint Browser, click the Hide Datapoint button () for selected datapoint(s).

Doing so changes the selected datapoint(s) to a hidden status as shown for the SC100-MP devices types below.

Click the Show Datapoint button () to display selected, hidden datapoint(s) in the Datapoint Browser widget.

Setting Filters

You can set filters on the Datapoint Properties widget to refine information that is displayed.

  1. To set a filter, click the Set Filter button () on the Datapoint Properties widget.



    The Set Filters view appears.



  2. Select the Driver type (i.e., All, BACnet, IAP, LON, Modbus) from the list of dropdown options. 



  3. Click the plus sign ( ) to add filters.



  4. Set any additional filters (i.e., Segment Controller, Device Type Name, Block Name, Block Index, Datapoint Name). 



  5. Click APPLY FILTERS.

    The results below show the block name filter results for "LON" Driver and "VAV" Device Type Name.



    The Reset Filters button () clears the filter settings, and the Cancel button () clears selected filters.

Editing Datapoint Properties

  1. To edit datapoint properties, click the Action button () and then select the Edit action.



    The Edit Datapoint Properties view appears.



Go to the following sections to edit datapoint properties: INFO, MONITORING AND LOGGING CONFIGURATION, ALARM TYPE CONFIGURATIONPRESET DEFINITIONS, or LOCALIZATION.

Note: Using presets and localization in datapoints is optional. A datapoint can have presets only, localization only, both presets and localization, or neither. When both presets and localization are used, the presets map are typically configured based on the localization value. Therefore, when an update is received, the value needs to be localized first before mapping to a preset string. And, when a preset string is entered, the map value needs to be transformed using the revert transformation rule to get the native value. 

Editing Datapoint Properties Information

  1. From the INFO tab, edit datapoint properties as needed including the following:



    • Protocol – read-only field with LON, Modbus, BACnet, and IAP values

    • Device Type – read-only field with device type name

    • Datapoint Name – read-only field with fully qualified name with block name, block index, and datapoint name
    • Initial Value – initial value for inputs only. If localization is defined, the value should be a local value.

  2. Click the Show button () to view the value for the selected datapoint as shown in the example below.



  3. Set the Visible option. 

    Note: This option is related to the setting described in the Viewing / Hiding Datapoints in the Datapoint Browser section.

    1. With this option enabled, the datapoint is visible on the Datapoint Browser widget.
    2. With this option disabled, the datapoint is hidden on the Datapoint Browser widget.

  4. Set the Provision Initial Value option.
    1. With this option enabled, the initial value is written to the device when the device is provisioned.
    2. With this option disabled, writing the initial to the device is suppressed when the device is provisioned.

  5. Click UPDATE.

Editing Monitoring and Logging Configuration

  1. From the MONITORING AND LOGGING CONFIGURATION tab, set the parameters as needed including the following:

    Note: The Total Monitoring Traffic Indicator above the Datapoint Properties widget displays an estimate of the expected monitoring events per second (EPS) based on the current monitoring configuration. For optimal system operations, keep this number below 40 EPS on a quad core SmartServer IoT (Revision F or later), or 20 EPS on a dual core SmartServer IoT (Revisions A through E).
    • Monitored – enables (set to Yes) or disables (the default, set to No) monitoring. The SmartServer monitors updates for a datapoint when monitoring is enabled for the datapoint. For datapoints on BACnet, LON (using IMM), and Modbus devices, polling must also be enabled to periodically read the datapoint value. 

    • Monitoring Method – provides the ability to set the monitoring method as Event-Driven or Polled. These options are enabled when Monitored is set to Yes and disabled with Monitored is set to No. A Poll Interval should be specified if the Polled option is selected.

      Note: If Monitored is enabled and the Event-Driven option is selected, then LON (using DMM) and BACnet datapoints will use the Event-Driven monitoring method. For Modbus and IAP datapoints, the Polled option should always be selected for the monitoring method (Event-Driven does not apply).


      • Event Driven – enables LON driver support for a maximum receive time property, which specifies a maximum time period between received updates from a datapoint. The configuration of a receive timeout appears the same as the configuration of a poll interval for polled monitoring, which occurs on a periodic fixed interval. However, for a receive timeout, the SmartServer will only send a poll request for an event-driven datapoint if the receive timeout period expires without a received event-driven update or poll response from a previous poll request.

        The use-cases are as follows:

        • For a datapoint configured for event-driven monitoring with a configured poll interval where the datapoint never sends an update event, this case will result in periodic polling.
        • For a datapoint configured for event-driven monitoring with a configured poll interval where the datapoint sends a heartbeat at an interval less than the receive timeout, a poll will not occur until a heartbeat update is missed. 
        • For a datapoint configured for event-driven monitoring with a configured poll interval where the datapoint sends occasional update events with no heartbeat, this case will result in periodic polling except immediately after the datapoint sends an event-driven update. An occasional update event is an update event that occurs at intervals that are typically much longer than the heartbeat. For example, this could be the case for a motion detector with no heartbeat. The motion detector may be installed in an area with little activity and as a result the motion detector may only change state once every few hours. The motion detector will mostly be polled, but will provide an immediate update when motion is detected without any unnecessary poll requests.

      • Polled – enables (set to Yes) or disables (set to No) periodic background polling where the driver periodically polls the datapoint to retrieve the current value of the datapoint.

    • Logged – enables (set to Yes) or disables (set to No) logging. This setting is No if Monitored is No. The default is No

      • If Monitored is Yes, the following fields are available:

        • Poll Interval (Seconds) – the interval between periodic polls from the IAP server to the endpoint in fractional seconds.

          Note: The Poll Interval (Seconds) field is disabled with the Monitored is No and enabled when the Monitored is Yes. The default value is 150 seconds for a polled datapoint and null for an event-driven datapoint. The Poll Interval is triggered for any event-driven update or poll response when one of the event-driven options is selected.


        • Publish Interval (Heartbeat) – the maximum interval between updates from the IAP server to any IAP clients, similar to a heartbeat. You can specify a fractional value such as 0.2 seconds. For a datapoint configured for periodic polling, this is typically a multiple of the polling interval. For a datapoint not configured for periodic polling, the publish interval specifies the maximum interval between updates from the cached datapoint value.

          A datapoint update may be published more frequently than specified by the publish interval if either of the following conditions are met:

          • The datapoint is polled at a faster rate than the publish interval, and publishing is appropriate based on the minimum publish interval and minimum publish delta value.

          • The datapoint is updated by an event-driven update or an on-demand poll, and publishing is appropriate based on the minimum publish interval and minimum publish delta value.

        • Minimum Publish Interval (Delta Time Throttle) – minimum interval in seconds between updates from the IAP server to IAP clients. This is a time-based throttle that does not throttle or otherwise limit periodic updates based on a configured publish interval. 

        • Publish Minimum Delta Value (Delta Value Throttle) – minimum change from the last published value required to publish an update from the IAP server to IAP clients. You can specify a scalar value, or select Any Change (for any non-zero change) or Always (for all updates).
          • Any Change publishes data on any non-zero change subject to the publish timing requirements.
          • Always disables the delta value throttle, but does not override the delta time throttle if one is specified. 

      A scalar value specifies that a datapoint value will not be published if the difference between the new value and the last published value is less than the minimum publish delta value. When enabled, this is a datapoint delta, value-based throttle that does not throttle or otherwise limit periodic updates based on a configured publish interval. 

        • Expected Update Interval – expected average number of seconds between updates. If 0, updates are not expected and included in traffic estimation. You can specify as a fractional value such as 0.5 seconds. Set this parameter to the Min Publish Interval value if the Expected Update Interval is blank and the Min Publish Interval is changed. This value is used for traffic estimation only and does not otherwise impact monitoring.

      • If Monitored is Yes and Logged is Yes, the following fields are available:

        Operational Considerations

        Note: If at any time your log size exceeds 8 GB, system performance will be degraded and operational failures may occur. With SmartServer release 3.2 and higher, configurable parameters for annual log size warnings and errors are defined in the com.echelon.cms.global.cfg file. The warning default is 7 GB and the error default is 8 GB. A warning message will appear if you specify logging parameters that will cause the calculated data log size to exceed these parameters.

        • Log 1 Minimum Interval – the minimum interval in seconds between log entries. You can specify a fractional value such as 0.2 seconds, and also as a multiple of the Publish Interval if a Publish Interval greater than 0 is defined. The log interval specifies the minimum interval between log entries, where the first datapoint update after the log interval expires is logged with a timestamp. A datapoint update may be received as a response to a poll, an event-driven update, or a response to an on-demand read request. Periodic logging is disabled if the interval is not specified or is equal to 0. 

        • Log Minimum Delta Value (Delta Value Throttle) – minimum change from the last logged value (not the last received value unless the last received value is also the last logged value) required to log a datapoint update. The last logged value for each log is the last datapoint value logged for the specific log (1, 2, or 3). You can specify a scalar value or select Any Change (for any non-zero change) or Always (for all updates).
          • Any Change logs data on any non-zero change subject to the log timing requirements.
          • Always setting disables the delta value throttle.

            A scalar value specifies that a datapoint update will not be logged if the difference between the new value and the last logged value is less than the Log Minimum Delta Value. When enabled, this is a datapoint delta, value-based throttle. Log entries are not throttled based on value if the Log Minimum Delta Value is not Any Change or Always, unspecified, or equal to 0.  

        • Log 1 Expected Interval – the expected interval between logged values for log 1. The expected interval is only used for calculating estimates of log size growth per day or per year with no effect on whether or not a value is logged. For a datapoint configured for periodic polling, the default value for the log expected interval is the log interval.

        • Log 1 Retention Period – retention period for log 1. The default value is 14 days.

        • Log 2 Minimum Interval, Expected Interval, and Retention Period – same behavior as for log 1, applied to log 2. The Retention Period default value is 60 days. 

        • Log 3 Minimum Interval, Expected Interval, and Retention Period – same behavior as for log 1, applied to log 3. The Retention Period default value is 730 days. 


      •  If Monitored is Yes, Polled is Yes, Logged is Yes, the Poll Interval is greater than 0, and the Publish Interval is greater than 0, the following additional field is available (otherwise it is grayed out):

        • Log 1/2/3 Multiple – logging multiples for logs 1, 2, and 3. Each specifies a multiple of the Publish Interval for the minimum time between logged values. The default value is 0. When this value is set, the CMS updates the Log Interval value to equal the Multiple times the Monitoring Interval.

        • If the Poll Interval is less than the Publish Interval, the default value for the corresponding Log Interval is the Publish Interval times the Multiple minus 50% of the Poll Interval. 

        • If the Poll Interval is equal to or greater than the Publish Interval, the default value for the corresponding Log Interval is the Publish Interval times 80% times the Log Interval. 

          Example: If a datapoint is polled every 10 seconds and the multiple is 6, the datapoint value is logged at least every 60 seconds. If the multiple value is 0, the datapoint value is not logged for this log level. Any positive value specifies that the datapoint is logged for this log level. 


      • If Logged is Yes, and either Event-Driven monitoring is Yes with a defined Poll Interval, or Polled monitoring is Yes, then three Multiple values are displayed and enabled.
        • If the Multiple value is changed, the Minimum Interval value is updated to Multiple x Poll Interval.


      • If Logged is Yes, and either Event-Driven monitoring or Polled monitoring is Yes, then three Minimum Interval values are enabled.
        • If the Minimum Interval value is changed and a Multiple value is displayed, and the value is changed to a multiple of the Poll Interval, then the corresponding Multiple value will be updated with the new multiple.
        • If the value is changed to a value that is not an integer multiple of the Poll Interval, then the Multiple value will be cleared.

  2. Click UPDATE to return to the Datapoint Properties widget.

Editing Datapoint Value Alarm Conditions

  1. From the ALARM TYPE CONFIGURATION tab, edit the parameters as needed including the following:



    • Alarm Name – a text field where you can enter a name for the alarm type definition. If defined, this name appears in the Alarm Type list.

      Note: Alarm Name must be unique across all alarm types and across all device types for handling alarm assignments.

    • Alarmed Yes/No – enables or disables alarm monitoring for the datapoint (this feature is available with SmartServer release 2.7 or higher).
    • High Warning and Low Warning – datapoint limits for triggering warnings, one for a high value warning and one for a low value warning.

    • High Alarm and Low Alarm – datapoint limits for triggering alarms, one for a high value alarm and one for a low value alarm. 

    • High Warning Preset and Low Warning Preset – datapoint presets for triggering warning alarms, one for a high-value warning alarm and one for a low-value warning alarm. (This setting requires Alarmed to be Yes; this feature is available with SmartServer release 2.8 or higher).

    • High Alarm Preset and Low Alarm Preset datapoint presets for triggering error alarms, one for a high-value error alarm and one for a low-value error alarm. (This setting requires Alarmed to be Yes; this feature is available with SmartServer release 2.8 or higher).

  2. Click UPDATE to return to the Datapoint Properties widget.

Using Preset Definitions

From the PRESET DEFINITION tab, you can create, edit, and remove preset definitions.

Creating a Preset Definition

  1. From the PRESET DEFINITION tab, click the Create button ().



  2. Enter the preset name, value, and state. (Presets are based on the local values.)

  3. Click SAVE.

    The preset definition appears on the Edit Datapoint Properties view.



  4. Click UPDATE to return to the Datapoint Properties widget.

  5. Refresh your browser window (Ctrl-F5 in many browsers) to display the updated preset definition.

Editing a Preset Definition

  1. To edit an existing preset definition, click the Action button () for the desired preset definition and select the Edit Preset action.



    The Edit preset view appears.



  2. Edit the preset definition as needed.

  3. Click SAVE.

  4. Click UPDATE to return to the Datapoint Properties widget.

  5. Refresh your browser window (Ctrl-F5 in many browsers) to display the updated preset definition.

Copying a Preset Definition

  1. To copy an existing preset definition, click the Action button () for the desired preset definition and select the Copy Preset action action.



    The Copy preset view appears.



  2. Edit the preset definition as needed.

  3. Click SAVE.

  4. Click UPDATE to return to the Datapoint Properties widget.

  5. Refresh your browser window (Ctrl-F5 in many browsers) to display the updated preset definition.

Removing a Preset Definition

From the PRESET DEFINITION tab, click the Action button () for the desired preset definition and select the Remove Preset action.

The preset definition is automatically removed.

To remove multiple preset definitions, follow these steps:

  1. Click the checkmark for preset definitions to be removed (the checkmarks change from blue to yellow).

  2. Click the Delete button ().

  3. Click UPDATE to return to the Datapoint Properties widget.

  4. Refresh your browser window (Ctrl-F5 in many browsers) to display the updated preset definition.

Using Localization Settings

You can set the localization transformation rules to be used by a datapoint to get the native value through the Edit Datapoint Properties view using the following fields:

  • Multiplier
  • Offset
  • Precision
  • Units fields

Any simple data type, as well as any field in a structure or union, can be transformed.  Once any of the rules have been changed, click UPDATE and then refresh your browser window (Ctrl-F5 in many browsers) to display the updated localization rules.

The transformation value = ( input value [raw value] *  multiplier ) + offset with precision

Note: Precision rounds half-up values as shown in the following examples:

    • Calculated 80.456, with a precision value of 2, is rounded to 80.46.
    • Calculated 80.452, with a precision value of 2, is rounded to 80.45.
    • Calculated 80.995, with a precision value of 2, is rounded to 81.


To clear any localization transformation rules, click the Delete button (), then click UPDATE, and finally refresh your browser window (Ctrl-F5 in many browsers) to display the updated rules.

Copying Datapoint Properties

  1. To copy a datapoint property, click the Action button () on the Datapoint Properties widget and select the Copy action.



  2. Click the Datapoint field. A dropdown list appears.



  3. Select the datapoint property you want to copy.



  4. Click COPY. A confirmation dialog box appears.



  5. Click OK to make the copy.

Clearing Datapoint Properties

Clearing a Selected Datapoint Property

  1. To clear the monitoring, logging, and alarming properties of a selected datapoint property, click the Action button () on the Datapoint Properties widget and select the Clear action.



    A Confirmation box appears.



  2. Click OK to confirm the clear datapoint properties operation for the selected datapoint.

Clearing Selected Datapoint Properties

  1. To clear the monitoring, logging, and alarming properties of selected datapoint properties, click the checkmark for the datapoint properties to clear. The checkmark changes from blue to yellow.



  2. Click the Action button () on the Datapoint Properties widget and select the Clear Selected Datapoint Properties action.



    A Confirmation box appears.



  3. Click OK to confirm the clear datapoint properties operation for the selected datapoints.

Clearing All Datapoint Properties

  1. To clear the monitoring, logging, and alarming properties of all datapoint properties, click the Action button () on the Datapoint Properties widget and select the Clear All Datapoint Properties action.



    A Confirmation box appears.



  2. Click OK to confirm the clear datapoint properties operation for all selected datapoints.

Exporting Datapoint Properties

Exporting a Selected Datapoint Property

To export datapoint properties for a single datapoint, click the Action button () on the Datapoint Properties widget for the datapoint and select the Export action.

The CMS exports the datapoint properties to a DLA file.

Exporting Selected Datapoint Properties

  1. To export multiple datapoint properties, click the checkmark for the datapoints to be exported.

    The checkmark changes from blue to yellow.



  2. Click the Action button () on the Device Properties widget and select the Export Selected Datapoint Properties action.



    The CMS exports the selected datapoint properties to a DLA file.

Exporting All Datapoint Properties

To export all datapoint properties, click the Action button () on the Datapoint Properties widget and select the Export All Datapoint Properties action.

The CMS exports all of the datapoint properties to a DLA file.

Importing Datapoint Properties

  1. To import datapoint properties, click the Action button () on the Datapoint Properties widget and select the Import Datapoint Properties action.



  2. Select the DLA file to be imported from your computer by clicking on the DROP FILE HERE area or by placing the file in that area.



  3. Click IMPORT FILE.



    A message appears indicating that the file was loaded.



  • No labels