This article describes the IoT Sensors widget of the Digital Twin module.
The IoT Sensors widget displays the list of sensors attached to your digital twin and allows you to interact with them.
This article will cover:
Markers and Elements
Sensors can be displayed in the 3D viewport in two modes. Choose between displaying icon-like markers or rendering the graphical element that the sensor is associated with.
Elements mode colorizes iModel elements that the sensors are attached to. If sensors are not attached to elements in the iModel, those sensors cannot be highlighted with elements.
Search
Allows you to search a sensor by name from the potentially long list. It is case-insensitive and supports partial strings.
Toolbar
- Show all sensors - Draw the sensors in the 3D viewport. Sensors displayed by clicking this button are governed by any sensor filters applied. When sensors are displayed, you can hover the cursor over them to display essential information about the sensor and its observations. Refer to the screenshot below.
- Hide all sensors - Hides sensors in the 3D viewport. Sensors hidden by clicking this button are governed by any sensor filters applied.
- Hide un-triggered sensors - Hides only the sensors whose alerts have not been triggered
- Focus mode - Grays out all elements in the model and makes them transparent. Colorizes only those elements whose alerts have been triggered.
- Show position displacements - Draws arrows in the model to indicate the magnitude and direction of displacement of Position ENH sensors
- Show heatmap - Colorizes the model, reality mesh, and terrain based on the severity of alerts or the range of values of the sensors
Sensor row buttons
Toggle visibility - Click on this button to control the visibility of the individual sensor
Sensor status - This button shows the current status of the sensor. Green indicates that the sensor is online and functioning. Red color indicates that the sensor is offline. Grey color indicates that the sensor has been archived. In addition to these colors, a flashing halo color around the button indicates that the sensor's alert has been triggered. The color of the halo indicates the severity of the alert.
Place sensor - Attach a sensor at a location by snapping on the graphical element, background map, terrain, reality data, or any other graphical object in the Digital Twin viewer. This tool saves the latitude, longitude, and elevation value in the sensor.
Remove sensor - Detach a sensor from its location. This tool clears the latitude, longitude, and elevation value from the sensor.
Group by Type
Sensors can be displayed either as a linear list or grouped by sensor type. Grouping by sensor type makes it easier to look at all sensors of a desired type.
When the sensors are grouped by type, you can use the buttons 'Collapse all types' and 'Expand all types' to collapse and expand the groups. This is useful when you have a large number of sensors of several types.
Grouping sensors by type allows you to show or hide all sensors of a type in a single shot by clicking on the 'Toggle visibility' button next to the sensor type row.
Show filters
Clicking the "Show Filters" icon" opens up a number of dropdown filtering options.
Filtering options include Connections, Devices, Sensor Type, Statuses, and Alerts.
You can select multiple filtering criteria together. Sensors that match all those criteria will be listed.
Filters can be cleared by clicking on the 'Clear all' button.
Sort
Sort the list of sensors by name, sensor type, status, observation values, or by the recent activity time.
Settings
You can control the display of sensors in the Settings panel.
Display Settings
- Marker size - Choose the size of icon-like markers.
Position Displacements
Draw displacement vectors from positional sensors such as Position ENH sensors in the form of 3D arrows.
- Enable – Click the toggle to display positional displacement vectors in the form of 3D arrows
- Arrow scale – Apply a scale factor to exaggerate small displacement values so that they can be observed easily
- Threshold levels – Segregate displacement values into ranges based on threshold values and define separate colors for each range
- Add new threshold – Add a new threshold level to define a new range of displacement values and give it a new color
Heatmap Display
Colorize the digital twin as a heatmap.
- Enable - Click the toggle to display the heatmap feature overlaid on the basemaps or digital twin, with color gradients per the severity of alerts or sensor data.
- Criteria - Select the dropdown to display the heatmap by Alert Priority or by Sensor Metrics.
When configuring the heatmap based on Alerts Priority, it will be based on the alert's severity related to each of the sensors displayed on the map. The screenshot below shows the options for that selection. Descriptions of these options are provided below the image.
- Color scheme - Choose to draw the heatmap with Blue-Red color palette or based on the alert colors
- Gradient mode - Choose to draw the color changes in steps of shades or as a smooth gradient
When configuring the heatmap based on Metrics, the heatmap display will need to be configured. The screenshot below shows the options for that selection. Descriptions of these options are provided below the image.
- Sensor Type - The Sensor Type selection requires the user to select the sensor for display. The "Isolate Display" button filters sensors to display only those of the sensor type selected.
- Metric Type - Select the metric from the dropdown. Available metrics will be dictated by the sensor type selected.
- Unit - Select the unit for visualization of the chosen metric.
- Color scheme - The color scheme for Heatmap by Metric is the Blue-Red color palette by default.
- Gradient mode - Choose to draw the color changes in stepped shading or as a smooth gradient.
The heatmap for any selected criteria will look similar to the screenshot below.
Timeline Slider
Use the timeline slider at the bottom of the 3D viewport to select a historical date and time of observations to display on the sensors. You can select the date and time either on the slider or by selecting it on the date-time picker as shown below.
When a historical date and time are selected, only the sensors that were present at that time are displayed in the list and in the viewport. Observations on those sensors also pertain to the selected date and time.
Note: The alerts are always based on current observations and the current state of the sensors.
Clicking on the 'Reset to Current' button resets the timeline to the current time and continues to report the latest observations on all sensors.
Options
The Options menu provides the following tools
Reload sensors
Reload the list of sensors and refresh their observation data
Elevate 2D sensors to 3D terrain
This tool finds the list of sensors that do not have their elevation value stored, projects them onto the 3D terrain, and stores the new elevation value in the sensor.
Place sensors by reference location
This tool allows you to automatically compute the 3D geo-location of sensors based on their saved Reference Location attributes. The screenshot below shows an example of such a sensor.
The tool prompts the user to select the geo-coordinate system and vertical datum used while entering Reference Location attributes in the sensors. An optional elevation correction offset can also be specified. The tool displays the geo-coordinate system and vertical datum of the iModel (this information cannot be altered). The two geo-coordinate systems and vertical datums are required for transforming Reference Location coordinates to the final Latitude/Longitude/Elevation coordinates. When the user clicks on the Proceed button, the tool iterates through the sensors that do not contain Location data, transforms the Reference Location coordinates to Latitude/Longitude/Elevation coordinates, and saves it in the Location fields of the sensor.