OEI Documentation
3.0.1
Open EII v: 3.0.1
Document Versions
4.1
4.0
3.0.1

Introduction:

  • Introduction to Open Edge Insights for Industrial
    • Terminology
      • General Terminology
      • Security-Related Terminology
  • Overview
  • Architecture
  • Minimum System Requirements
  • Run Open Edge Insights for Industrial
    • Install Open Edge Insights for Industrial from ESH
      • Task 1: Install Prerequisites
        • Run the Prerequisites Script
        • Optional Steps
      • Task 2: Generate Deployment and Configuration Files
        • Use the Builder Script
        • Generate Consolidated Files for All Applicable Services of Open Edge Insights for Industrial
        • Generate Consolidated Files for a Subset of Open Edge Insights for Industrial Services
        • Generate Multi-instance Config Using the Builder
        • Generate Benchmarking Config Using Builder
        • Add the Open Edge Insights for Industrial Services
        • Distribute the Open Edge Insights for Industrial Container Images
        • List of Open Edge Insights for Industrial Services
      • Task 3: Build and Run the Open Edge Insights for Industrial Video and Time Series Use Cases
        • Build the Open Edge Insights for Industrial Stack
        • Run Open Edge Insights for Industrial Services
        • Push the Required Open Edge Insights for Industrial Images to Docker Registry
    • Web Deployment Tool
    • Video Pipeline Analytics
      • Enable Camera-based Video Ingestion
      • Use Video Accelerators in Ingestion and Analytics Containers
        • To Run on the USB Devices
        • To Run on the MYRIAD Devices
        • To run on the HDDL Devices
        • To Run on Intel(R) Processor Graphics (GPU/iGPU)
    • Time Series Analytics
    • Open Edge Insights for Industrial Multi-node Cluster Deployment
      • With K8s Orchestrator
    • Open Edge Insights for Industrial Uninstaller
    • Debugging Options
    • Troubleshooting Guide
  • Release Notes
    • Open EII v3.0.1
      • Fixes
      • Known Issues
    • EII v2.6.3
      • Fixes
    • Open EII v3.0
      • New Features
      • Dropped Features
      • Known Issues
    • EII v2.6.2
      • Fixes
    • EII v2.6.1
      • Bug fixes
    • EII v2.6
      • Features
      • Known Issues
    • EII v2.5.3
      • Fixes
    • EII v2.5.2
      • Bug fixes
    • EII v2.5.1
      • Bug fix
    • EII v2.5
      • Features
  • Open EII 2.6 to 3.0 version migration guide
    • Open EII v3.0 Release Notes
      • New Features
      • Dropped Features
      • Known Issues
    • Changes from 2.6 to 3.0
      • Build Changes
        • Provisioning flow changes
        • Building use cases
      • Deployment Changes
        • Deployment using docker-compose.yml on single node
        • Deployment on k8s cluster using helm

Core Libraries:

  • Message Bus
    • Message Bus
      • Dependency Installation
      • Compilation
      • Generating Documentation
      • Potential Compilation Issues
      • Packaging
        • A Note on Alpine APK Packaging
      • Installation
        • Install Python Binding
        • Install Golang Binding
      • Running Unit Tests
      • Configuration
        • ZeroMQ IPC Configuration
        • ZeroMQ TCP Configuration
        • Additional ZeroMQ Configuration Properties
      • Example Usage
        • C Examples
        • Python Examples
        • Go Examples
        • Running Go Examples without Installing
        • Brokered Publish/Subscribe
      • Security
        • Using Only CurveZMQ Encryption
        • Using ZAP Authentication
        • Disabling Security
      • Known issues
      • Generation of python .whl file (Optional)
    • API Documentation
  • Open Edge Insights for Industrial Configuration Management
    • ConfigMgr
      • ConfigMgr Installation
        • Using System gRPC
      • Compilation
        • Generating Documentation
      • Packaging
        • A Note on Alpine APK Packaging
      • Install ConfigMgr with Python bindings, Go bindings, Examples, Test suits, and Debug Build
      • Interfaces
      • Publisher Interface
        • Subscriber Interface
        • Server Interface
        • Client Interface
      • Overriding of Type and EndPoint
      • Broker Usecase
      • zmq_tcp Protocol usecase
        • ZmqBroker (use case)
        • Subscriber
        • Publisher
      • zmq_ipc Protocol usecase
        • ZmqBroker
        • Subscriber Details
        • Publisher Details
        • Note “Endpoint” can be given in different ways
      • Running Examples
        • CPP Examples
        • Python Examples
        • Go Examples
      • Running Unit Tests
      • Creation of grpc .zip file (Optional)
      • Generation of python .whl file (Optional)
    • ETCD UI Service
    • API Documentation

Video Analytics Pipeline:

  • Working with Video Data
    • VideoIngestion Module
      • Configuration
        • Ingestor Config
      • VideoIngestion Features
        • Image Ingestion
        • UDF Configurations
        • Updating Security Context of VideoIngestion Helm Charts
        • Camera Configurations
        • RTSP Cameras
        • USB v4l2 Cameras
        • RealSense Depth Cameras
    • VideoAnalytics Module
      • Configuration
      • Update Security Context of VideoIngestion Helm Charts
    • Video Pipeline Analytics
      • Enable Camera-based Video Ingestion
      • Use Video Accelerators in Ingestion and Analytics Containers
        • To Run on the USB Devices
        • To Run on the MYRIAD Devices
        • To run on the HDDL Devices
        • To Run on Intel(R) Processor Graphics (GPU/iGPU)
    • Open EII UDFLoader
    • Open EII Sample UDFs
    • User Defined Function (UDF)
    • Native Visualizer Module
      • Steps to build and run visualizer
      • Using Labels
      • Metadata Structure
    • Web Visualizer Module
      • Steps to Build and Run Web Visualizer
      • Using Labels
        • Metadata Structure
    • ImageStore Module
      • Configuration
        • Detailed description on each of the keys used
    • InfluxDBConnector Module
      • Configuration
  • Working with Edge Video Analytics Microservice
    • Edge Video Analytics Microservice
      • Build the Base Image
      • Run the Base Image
      • Run EVAM in Open EII Mode

Time-Series Analytics Pipeline:

  • Working with Time series Data
    • Kapacitor
      • Point Data (Time Series data) Analytics Overview
      • Starting the example
      • Purpose of Telegraf
      • Purpose of Kapacitor
      • Custom UDFs available in the udfs([WORK_DIR]/IEdgeInsights/Kapacitor/udfs) directory
      • Steps to configure the UDFs in Kapacitor
      • Steps to run the samples of multiple UDFs in a single task and multiple tasks using single UDF
      • Kapacitor input and output plugins
        • Purpose of plugins
        • Using input plugin
        • Using output plugin
        • Using input/output plugin with RFC UDF
    • Grafana Overview
      • Configuration
      • Run Grafana
        • Run Grafana in the PROD mode
        • Run Grafana in the DEV Mode
        • Execute Queries
        • Run Grafana for Video Use Cases
    • InfluxDBConnector Module
      • Configuration

Export Services:

  • Azure Bridge
    • Introduction
    • Prerequisites and Setup
      • Azure Cloud Setup
        • Setting up AzureML
        • Important
      • Development System Setup
    • Build and Push Open Edge Insights for Industrial Containers
    • Single-Node Azure IoT Edge Deployment
      • Step 1 - Provisioning
      • Step 2 - Configuring Open Edge Insights for Industrial
      • Step 3 - Configuring Azure IoT Deployment Manifest
      • Step 4 - Deployment
      • Helpful Debugging Commands
      • Final Notes
    • Configuration
      • Azure Bridge
      • ZeroMQ TCP Subscription Implications
      • ZeroMQ IPC Subscription Implications
      • Sample Open Edge Insights for Industrial ONNX UDF
      • Simple Subscriber
      • Open Edge Insights for Industrial ETCD Pre-Load
      • Azure Blob Storage
      • Azure Deployment Manifest
    • Azure IoT Edge Simulator
    • Supported Open Edge Insights for Industrial Services
    • Additional Resources
  • OpcuaExport Application
    • OpcuaExport
      • Configuration
      • Service Bring Up
      • OPCUA Client Apps
  • RestDataExport Service
    • Configuration
      • Prerequisites to Run RestDataExport to POST on HTTP Servers
    • HTTP GET API of RDE
      • Get the Classifier Results Metadata
        • Request to GET Metadata
      • Get Images Using the Image Handle
        • Request to GET Images
    • Launch RestDataExport Service
    • Configure Environment Proxy Settings

Additional Info:

  • Open EII Tools
    • Time Series Benchmarking Tool
    • Video Benchmarking Tool
    • DiscoverHistory Tool
      • Build and Run the DiscoverHistory Tool
        • Prerequisites
        • Run the DiscoverHistory tool in the PROD mode
        • Run the DiscoverHistory tool in the DEV Mode
        • Run the DiscoverHistory tool in the zmq_ipc Mode
      • Sample Select Queries
      • Multi-instance Feature Support for the Builder Script with the DiscoverHistory Tool
    • EmbPublisher
      • How to Integrate this Tool with Video/Time Series Use Case
      • Configuration of the Tool
      • Running EmbPublisher in IPC mode
    • EmbSubscriber
      • Prerequisites
      • Running EmbSubscriber
      • Run EmbSubscriber in IPC mode
    • GigEConfig Tool
      • Generating PFS (Pylon Feature Stream) File
      • Running GigEConfig Tool
        • Usage of GigEConfig tool
        • Execution of GigEConfig
    • HttpTestServer
      • Prerequisites for running the HttpTestServer
      • Starting HttpTestServer
    • Develop Python User Defined Functions using Jupyter Notebook
      • Prerequisites for using Jupyter Notebooks
      • Run Jupyter Notebook from web browsers
      • Run Jupyter Notebook using Visual Studio Code
    • MQTT publisher
      • Usage
    • NodeRedHttpClientApp
      • Configure NodeRed
      • Getting Open EII UDF Classifier results data to Node-RED Environment Using Node-RED HTTPClient
      • Sample Workflow
    • Software Trigger Utility for VideoIngestion Module
      • Software Trigger Utilily Prerequisites
      • Configuration file
      • Running Software Trigger Utility
      • Usage of Software Trigger Utility
    • Open EII TimeSeriesProfiler
      • Prerequisites
      • Open EII TimeSeriesProfiler modes
      • Open EII TimeSeriesProfiler configurations
      • Running TimeSeriesProfiler
    • Open EII Video Profiler
      • Open EII Video Profiler Prerequisites
      • Open EII Video Profiler Modes
      • Open EII Video Profiler Configurations
      • Run Video Profiler
      • Run VideoProfiler in Helm Use Case
      • Optimize Open EII Video Pipeline by Analysing Video Profiler Results
      • Benchmarking with Multi-instance Config
  • Open EII Samples
    • Sample Apps
      • Run the Samples Apps
  • Security
    • Provisioning
      • Generating Keys and Certificates
    • Start Up and Run Time
      • Accessing Secrets
    • Certificate Revocation
OEI Documentation
  • 3.0.1 »
  • Search

© Copyright (c) 2021 Intel Corporation.

Built with Sphinx using a theme provided by Read the Docs.
Open EII v: 3.0.1
Document Versions
4.1
4.0
3.0.1