Creating entities from data points - Industrial IoT 4.4.2.4

Industrial IoT Plugin Guide 4.4.2.4

Applies to
Industrial IoT 4.4.2.4
Last updated
2022-10-12
Content type
Guides > Plugin and extension guides
Language
English
Product
Industrial IoT
Version
4.4

In Security Center, you can create an entity that aggregates data points from multiple devices or multiple data points on a single device. This is useful when you want to monitor numerous components from a single device or consolidate data points from multiple devices.

What you should know

All Industrial IoT plugins support entities.

Procedure

  1. From the Config Tool home page, open the Plugins task.
  2. Select an Industrial IoT plugin role from the entity browser and click the Entities tab.
  3. Click Add entity ().
    The Add entities dialog box opens.
  4. Enter the following information:
    Name
    Enter a name for the entity.
    Type
    The device template that you want to apply to the device. These templates are created on the Entity types page of the plugin, and are used to apply custom states, data points, and actions to a device.
    NOTE: If you select None, you must manually add the custom states, data points, and events to the entity in Security Center.
  5. Click Add.

Results

The entity is displayed in the entity browser, nested under the plugin role that it is related to.

Example

Example 1: A device that has many components

You have a lighting controller that controls 100 light fixtures. Each light fixture is in a different room of a building. Each light fixture has an ON / OFF switch.

You want to monitor which light fixtures are ON and which are OFF from Security Desk maps.

Do the following:

  • Create a device named LightController01.
  • Create 100 data points named LightSwitchn, where n is a unique number to identify the switch, such as LightSwitch001, LightSwitch002, LightSwitch100. Select the type Boolean for the ON and OFF states.
  • Create an entity named LightFixturen, where n is a unique number; such as: LightFixture001, LightFixture002, LightFixture100.
  • Add each LightSwitch data point to the corresponding LightFixture entity. For example: Add LightSwitch001 to LightFixture001.
  • Place each light fixture entity on the floor map of your building.

You can now see which lights are ON and which are OFF on the map.

Example 2: A device that has many components, each component has multiple inputs

You have a lighting controller that controls 100 light fixtures. Each light fixture is in a different room of a building. Each light fixture has a dimmer switch that also turns the light on and off.

You want to monitor the light fixtures from Security Desk maps so that you can see which are OFF, which lights are ON, and how bright or dim the lights are.

Do the following:
  • Create a device named LightController02.
  • Create two data points for each light fixture, for a total of 200 data points.
    • 100 data points named LightSwitchn, where n is a unique number to identify the switch, such as LightSwitch101, LightSwitch102, LightSwitch200. Select the type Boolean for the ON and OFF states.
    • 100 data point named DimmerSwitchn, where n is a unique number, such as DimmerSwitch101, DimmerSwitch102, DimmerSwitch200. Select the type Integer, where 0 is no light and 100 is full brightness.
  • Create an entity named LightFixturen, where n is a unique number; such as: LightFixture101, LightFixture102, LightFixture200.
  • Add each LightSwitch data point and each DimmerSwitch data point to the corresponding LightFixture entity. For example: Add LightSwitch101 and DimmerSwitch101 to LightFixture101.
  • Place each LightFixture entity on the floor map of your building.

You can now see on the floor map which lights are ON and which are OFF.

Example 3: Create an entity from numerous sensors

You want to create a weather station that collects data from temperature, humidity, air pressure, and wind speed sensors at a site. You want to see all of the data collected at the weather station on your Security Desk map.

Do the following:

  • Create a device named WeatherStationMontreal.
  • Create the following four data points:
    • Temperature of the type INT16.
    • Humidity of the type UINT.
    • AirPressure of the type UINT.
    • Wind speed of the type UINT.
  • Create an entity named WeatherStationMontreal and add all four data points to it.
  • Place the WeatherStationMontreal entity on the map in the Map Designer task.

You can now monitor the weather in Montreal from your map in Security Desk.

Example 4: Monitor multiple sensors from a single dashboard

You have multiple sensors located along a gas pipeline that crosses the country. Each sensor measures the speed of the gas flowing through the pipe. You want to monitor the flow of gas along the entire length of the pipeline.

Create the following:

  • A device named GasSensorn for each sensor, where n is a unique number that identifies the sensor.
  • A data point named GasFlow of the type a INT16.
  • An entity named GasFlowingInPipeline01 and add all of the GasSensor devices.
  • A dashboard for the GasFlowingInPipeline01 entity.

The dashboard shows the speed of gas at each sensor.