Skip to content

Latest commit

 

History

History
97 lines (63 loc) · 3.86 KB

README.md

File metadata and controls

97 lines (63 loc) · 3.86 KB

Edge Oscilloscope

The Edge Oscilloscope is an example application that can be downloaded for free from Siemens Industry Online Support (SIOS): https://support.industry.siemens.com/cs/us/en/view/109808369

Installation

First, download the Edge Oscilloscope app from SIOS. Unzip the file, and extract the .app file. Import the .app file into your IE Management Catalog via the + Import Application button in top-right of the Catalog page. Once imported into the Catalog, install the Edge Oscilloscope app onto your Edge Device.

If needed, you can modify the configuration file template during installation:

Configuration Template

NOTE: databus credentials must be set this way.

Configuration

With the exception of databus settings, all configuration of the Oscilloscope can be done from the web interface of the app. The available configuration parameters are shown in the config.json file of the app, e.g.:

{
    "parameters": {
        "sampling_rate": 48000,
        "plot_gain": 0.0000305,
        "plot_width": 0.5,
        "plot_points": 1000,
        "metadata_topic": "ie/m/j/simatic/v1/cs-mqtt-gtw/dp/r"
    },
    "databus": {
        "databus_host": "ie-databus",
        "databus_port": 1883,
        "databus_username": "edge",
        "databus_password": "edge",
        "metadata_qos": 1,
        "streaming_qos": 2
    }
}

Connections

After (re-)starting the Oscilloscope, the initial screen will be blank because no Connection has been selected:

No Connection

Select a Connection from the drop-down list:

Connection Selected

If no Connections are found, make sure you've specified the right Metadata Topic and that your databus credentials are correct. Additionally, make sure that data is actually being published on that Metadata Topic. This can be confirmed in Flow Creator, for example:

Check Metadata

Plot Settings

Once you've selected a Connection, you can adjust the plot settings in the configuration pane. For example, to adjust the vertical scale of the plot, change the Plot Height parameter and click Update:

Plot Height

Similarly, to adjust the horizontal resolution of the plot, you can adjust the horizontal scale via the Plot Width parameter or the number of distinct datapoints shown via the Plot Points parameter:

Plot Resolution

Operation

Once operational, you can simply monitor any signals of interest using the real-time waveform visualization (line chart) or use the audio recorder functionality in the bottom right to capture the signals into a .wav audio file.

Recording

To begin recording, click Start; this will create a pop-up alert informing you that the recording is active:

Start Recording

Once you've collected sufficient data, click Stop to end the recording and Download to send the captured signals to your PC as a .wav file:

Download Recording

If you don't wish to download the recording, simply Clear it and begin again.

NOTE: to limit active memory consumption of the Oscilloscope, recordings are limited to 50MB each. Any recording that runs longer than 50MB will be automatically split into multiple files. In this case, on Download, all recordings will be downloaded together as a single .zip archive.

Retrieve Files

In case you want to retrieve older recordings, you can visit the App Management tab of the Edge Device and see a full list of previous recordings:

Retrieve Files

NOTE: to limit storage / disk usage of the Oscilloscope, the total number of recordings persisted on the disk is limited to 100 files (i.e., 5GB maximum).