Skip to content

Device details

For each device, detailed information is available. The kind of information actually provided for a device depends on the device type, device usage and the configuration of your user interface.

To view detailed information on the device, click a device in the device list.

Device details

The device details are divided into tabs. The number of tabs is dynamic and depends on the available information, i.e. tabs are only displayed if the kind of information is available for the particular device.

Initially the Info tab is shown, which offers general information on a device and is available for each device.

Each device at least shows the following tabs: "Info", "Alarms", "Control", "Events", "Service monitoring", "Identity" (also see the tab list below).

The following tabs are the most common ones, each described in detail in a separate section:

Tab Description
Info Provides general information on a device. Available for each device.
Child Devices Lists devices being connected to the current device.
Measurements Provides a default visualization of numeric data provided by the device in the form of charts.
Alarms Provides information on the alarms for a device. See also "Working with alarms". Available for each device.
Configuration Allows manual configuration of device parameters and settings entered in a text format. See also "Configuration Repository for binary configuration".
Control Displays operations being sent to a device. Also refer to "Working with operations". Available for each device.
Network Displays network information for a device.
Software Manages firmware of a device and software installed on a device.
Events Displays events related to a device, helpful for low-level troubleshooting. Also refer to "Troubleshooting devices". Available for each device.
Location Shows the location of a device, if available.
Logs Allows requesting log information for a device.
Service monitoring Allows the service monitoring of machines. See also "Monitoring services". Available for each device.
Shell Enables you to interact with remote devices via a command prompt.
Tracking Shows the movement of a device, if available.
Identity Displays identities recorded for a particular device. Available for each device.

Note

Potential individual tabs, which you do not find listed here, may be described in a different context and therefore somewhere else in the IoT Extension documentation. Use the Search function to switch to the relevant sections.

Below the name, a list of breadcrumbs is displayed. If the device is part of an asset hierarchy (such as a group), you can use the breadcrumbs to easily navigate up that hierarchy. Since devices can be part of multiple hierarchies, several rows of breadcrumbs may be shown.

Depending of the type and usage of a device, further actions are provided in a context menu when clicking "More..." at the right of the top menu bar.

More

Details on these additional menu items are provided where required.

Info

The "Info" tab summarizes management-relevant device information in a dashboard.

Info

The information is provided on the following cards:

Card Description
Notes Provides optional notes to inform about current activities. Notes usually may only be edited by an administrator. To add or edit a note, click "Edit", enter your note or your modifications in the text box and save your edits by clicking the green checkmark at the right of the text box.
Device status Displays connection-relevant information.
Device and communication Shows a data point graph displaying realtime data on particular measurements. For details on data point graphs, refer to Using the Data Explorer in the Cockpit documentation.The following measurements may be shown here:
Data points:
c8y_Battery.level, c8y_SignalStrength.rssi, c8y_MemoryMeasurement.Used, c8y_CPUMeasurement.Workload, c8y_NetworkStatistics.Upload, c8y_SignalStrength.RCSP, c8y_SignalStrength.ber, c8y_SignalStrength.ECN0, c8y_NetworkStatistics.Download, c8y_MemoryMeasurement.TotalAlarms: c8y_UnavailabilityAlarmEvents: c8y_LocationUpdate
Device data Displays editable information on the device (name, type, ID, owner, last updated). The fields ID and "Last updated" cannot be edited. Moreover information on hardware (editable) and firmware (not editable) is displayed here if available.
Active, critical alarms Shows the active critical alarms for the device.
Groups assignment Displays the groups the device belongs to. Moreover you can add the device to groups here or unassign it from groups. For details on grouping devices see Grouping devices.
Location Shows the location of a device on a map as reported by the device or as manually set.

Child devices

The "Child devices" tab shows a list of devices connected to the currently displayed device. For example, if you look at a gateway, the tab lists all machines connected to the gateway.

For details provided in the child device list, refer to Viewing devices.

Measurements

The "Measurements" tab provides a default visualization of numeric data provided by the device in the form of charts. Charts are grouped into types of measurements, which can contain multiple graphs or "series". The screenshot below, for example, shows a chart for motion measurement including graphs for acceleration in the three dimensions, and a chart with modem statistics in the form of signal strength and bit error rate.

Measurements

If a chart contains graphs with different units, one Y-axis is rendered per unit. In the example above, motion measurements consist of three parameters with unit "meter per square second", so only one axis is rendered. Modem statistics consist of signal strength in decibel milliwatts and bit error rate in percent, so one axis is rendered for each graph.

To see detailed information about the measured values, hover over the chart. A tooltip will be displayed with detailed information on the measurement next to your cursor (the tooltip will "snap" to the closest measurement).

Time range and aggregation

By default, charts show the raw data of the last hour. To change the time range on the X-axis, open the "Last hour" dropdown menu at the top right and select a time range.

If you increase the time range, the value in the Aggregation field will automatically switch to "hourly" or "daily". The chart now shows ranges instead of individual raw data points. For "hourly", the chart will show a range of the minimum and maximum value measured in one hour. For "daily", the chart will show the minimum and maximum value measured over one day. Likewise, the tooltips will now show ranges of values instead of individual values.

This enables you to get an efficient overview over larger time periods. A graph will only show 5.000 data points per graph maximum to avoid overloading your desktop browser. If you select a fine focus resulting in more than 5.000 data points, a warning message will be shown: "Truncated data. Change aggregation or select shorter date range."

Clicking "Realtime" will enable realtime user interface updates of the graphs as new data flows into the system from the connected devices.

You can influence the graphical display and axes limits by setting up so-called "KPIs", see the Administration Guide.

Measurement format

In order to see measurement graphs, the device has to send measurements in a specified fragment format.

"fragment_name" : { "serie_name" : { "value" : ... "unit" : ... } }

Example:

"c8y_SpeedMeasurement": { "Speed": { "value": 1234, "unit": "km/h" } }

Fragment_name and serie_name can be replaced by different valid json property names, but no whitespaces and special characters like [ ],* are allowed. The structure has to be exactly as above, two-level deep json object.

Alarms

The "Alarms" tab provides information on the alarms of a device. Refer to Working with alarms for further information on alarms.

Configuration

The text configuration, available in the "Configuration" tab of a device, allows you to configure the parameters and initial settings of your device in a text format.

To manually add or edit a device configuration, follow these steps:

  1. Open the details for your desired device.
  2. Click the "Configuration" tab.
  3. In the text field you can add or edit the device configuration as desired.
  4. Click "Save" to save your edits.

Alternatively, you can work with configuration snapshots.

Control

The "Control" tab lists the operations being sent to a device.

Network

In the "Network" tab network settings can be configured for the device.

Software

The "Software" tab allows you to manage and update the firmware of a device and the software installed on a device.

To install a new firmware, click "Install firmware", then select a firmware image from the "Firmware repository" and click "Install".

Similarly, to install a software on the device, click "Install software", select a software package from the "Software repository" and click "Install".

Installing software and firmware usually includes a restart of the device. To monitor the progress of an installation, visit the "Control" tab.

To remove a software from a device, hover over a particular software package and click the "Delete" button.

Events

The "Events" tab displays events related to a device. This enables low-level troubleshooting of a device.

Location

The "Location" tab by default shows the location of a device on a map and as coordinates, as reported by the device. For devices that do not report a location you may manually set the location. Simply place the "pin" in the correct place of the displayed map.

The "Location" tab also shows when a device contains c8y_Position property. When you send a new c8y-position event, you can set the same c8y-Position fragment on the device and it will automatically mark its position on the map.

Logs

In the "Logs" tab you can request log information from devices. Log information can be filtered according to date ranges, log type, keywords and the maximum number of lines to transfer.

In the "Logs" tab, click "Request log file" at the right of the top menu bar.

In the upcoming window, specify the following settings for the log information:

  • A date and time range.
  • The type of log. The supported logs listed are usually device-specific.
  • An optional text to filter the log. For example, if you enter "Users", only lines including the term "Users" will appear in the returned log information.
  • The maximum number of lines to be returned (counted from the end). The default value is 1000.

Click "Request" log to request the specified log information for the device.

Note

Requesting a log from a device may take some time.

After the log has been transferred from the device to IoT Extension, it will be listed on the screen. The entry in the list includes the requested log time range.

Click on the entry in the list to show the log information in the screen.

When hovering over an entry, the "Download" and "Delete" buttons appear. Click the "Download" button to download the log excerpt to your local PC. Click the "Delete "button to delete the log file.

Service monitoring

In addition to connection monitoring, IoT Extension offers a separate service monitoring for machines.

Shell

The device shell enables you to interactively work with remote devices. Many industrial devices support some form of command language, be it AT commands for modems, CSV-style commands for many tracking devices or elaborate scripting mechanisms such as Tixi TiXML. In the shell, you can send commands in the respective language of the device and interactively view the results of the commands.

The "Shell" tab presents a command prompt to enter commands.

In the command prompt you can enter arbitrary command text. To send the command text to the device, click "Execute". This button only is activated if the device is online.

Click "View history" at the right of the top menu bar to display a list of the previously executed commands. By default, the last three commands are visible. The list displays status, date and text of a command. Clicking a list item reveals the result of the command (provided it has been executed).

For your convenience, IoT Extension provides several frequently used commands for some devices. Click "Get predefined commands" at the right of the top menu bar to open a window containing a list of available pre-defined commands. Select the command of your choice and click "Use", to copy the command to the command prompt, or "Execute", to execute the command straight away. You may also add new commands here for re-use.

Tracking

Devices can record the history of their movements in IoT Extension. This movements may be viewed in the "Tracking" tab.

Note that the "Tracking" tab only shows up when a device contains c8y_Position property.

In the dropdown list at the top right you can select a time period (or specify one by selecting Custom from the list) and visualize the movements of the device during this period. Movements are shown as red lines in the map.

Next to the map, the individual recordings with their time are listed ("location update events"). When you click a recording, a "pin" on the map will show the location at the time of the recording.

Depending on the type of device and the integration into IoT Extension, you can configure device-side geo-fencing and motion detection.

Note

When this feature is activated and the device is compatible, Cell ID information can be used to determine the position of the device. Currently, the services from Combain and Google are supported. The user can see the tracks based on both data, or filter out GPS based data or Cell ID based data.

Identity

IoT Extension can associate devices and assets with multiple external identities. For example, devices can often be identified by the IMEI of their modem, by a micro-controller serial number or by an asset tag. The Identity tab lists all the identities recorded for a particular device.

This is useful, for example, when you have non-functional hardware and need to replace the hardware without losing the data that was recorded. Just connect the new hardware to your account and modify the identity entry of the old hardware, to contain the identity of the new hardware.

Any questions left?

Ask the community


Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.


Last update: May 9, 2022