EII Documentation
4.0
EII v: 4.0
Document Versions
1.5
1.0
EII 4.1
EII 4.0
  • What is EII?
    • Introduction to Edge Insights for Industrial
    • Overview
    • High Level Architecture
  • Getting Started
    • Minimum System Requirements
    • Install Edge Insights for Industrial
      • Step 1: Prepare the Target System
      • Step 2: Download and Copy the Edge Insights for Industrial .zip File to the Target System
      • Step 3: Extract the Edge Insights for Industrial Software
      • Step 4: Configure your Installation
      • Step 5: Install the Edge Insights for Industrial Software
        • Manually Install the Manageability Module
      • Troubleshooting
        • Restart Mode
        • Docker Image Pull Issue
      • Introduction to the edgesoftware CLI
        • Get Started with the edgesoftware CLI
        • Install Package Modules
        • Update the Package Modules
        • Export the Package for Installation
        • Uninstall the Packages
        • Summary
  • Advanced Guide
    • Install Edge Insights for Industrial from source code
      • Task 1: Install Prerequisites
        • Run the Prerequisites Script
        • Optional Steps
      • Task 2: Generate the Deployment and the Configuration Files
        • Use the Builder Script
        • Generate Consolidated Files for All Applicable Services of Edge Insights for Industrial
        • Generate Consolidated Files for a Subset of Edge Insights for Industrial Services
        • Generate Multi-instance Config Using the Builder
        • Generate Benchmarking Config Using Builder
      • Task 3: Build the Edge Insights for Industrial Stack
      • Task 4: Deploy EII Services
        • Docker compose Deployment
        • Kubernetes Deployment
        • Azure Manifest Deployment
      • List of EII Services
      • Adding New Services to EII Stack
    • DataStore Microservice
      • DataStore Configuration
        • InfluxDB
        • MinIO
      • Steps to Independently Build and Deploy DataStore Microservice
        • Steps to Independently Build the DataStore Microservice
        • Steps to Independently Deploy DataStore Microservice
        • Deploy DataStore Service without Config Manager Agent Dependency
        • Deploy DataStore Service with Config Manager Agent Dependency
    • Video Pipeline Analytics
      • Edge Video Analytics Microservice for Edge insights for Industrial (EII) Overview
        • Prerequisites
        • Run the Containers
        • Configuration
        • Steps to Independently Build and Deploy EdgeVideoAnalyticsMicroservice Service
        • Camera Configurations
        • Image Ingestion
        • Integrate Python UDF with EdgeVideoAnalyticsMicroservice Service
        • Running EdgeVideoAnalyticsMicroservice with multi-instance
        • Running EdgeVideoAnalyticsMicroservice with EII helm usecase
        • Running EdgeVideoAnalyticsMicroservice on a GPU device
        • Use Human Pose Estimation UDF with EdgeVideoAnalyticsMicroservice
      • EII UDFLoader Overview
        • Dependency Installation
        • Compilation
        • Installation
        • Running Unit Tests
      • EII Sample UDFs
      • User Defined Function (UDF)
      • Multimodal Data Visualization Microservice Overview
        • Prerequisites
        • Run the Containers
      • Multimodal Data Visualization Streaming
        • Steps to Independently Build and Deploy “Multimodal Data Visualization Streaming” Service
      • DataStore
    • Time Series Analytics
      • Telegraf Overview
        • Plugins
        • Steps to Independently Build and Deploy the Telegraf Service
        • Steps to Independently Build the Telegraf Service
        • Telegraf’s Default Configuration
        • Volume Mounting of Telegraf Configuration Files
        • MQTT Sample Configuration and the Testing Tool
        • Enable Message Bus Input Plugin in Telegraf
        • Advanced: Multiple Plugin Sections of EII Message Bus Input Plugin
        • Using Input Plugins
        • Enable Message Bus Output Plugin in Telegraf
        • Advanced: Multiple Plugin Sections of Message Bus Output Plugin
        • Run Telegraf Input Output Plugin in IPC Mode
        • To Add Multiple Telegraf Instances (Optional)
      • Overview of the Kapacitor
        • Introduction to the Point-Data Analytics(Time Series Data)
        • Steps to Independently Build and Deploy the Kapacitor Service
        • Troubleshooting
        • Time Series Python UDFs Development
      • DataStore
    • Export Services
      • Edge-to-Cloud Bridge for Microsoft Azure Overview
        • Prerequisites and Setup
        • Single-Node Azure IoT Edge Deployment
        • Configuration
        • Azure IoT Edge Simulator
        • Supported Edge Insights for Industrial Services
        • Additional Resources
      • OpcuaExport
        • Steps to Independently Build and Deploy the OpcuaExport Service
        • Configuration
        • Service Bring Up
        • OPCUA Client Apps
      • RestDataExport Service
        • Steps to Independently Build and Deploy RestDataExport Service
        • Configuration
        • HTTP GET API of RDE
        • Launch RestDataExport Service
        • Configure Environment Proxy Settings
        • API Documentation
    • EtcdUI Service
    • EII Tools
      • Time Series Benchmarking Tool
      • Video Benchmarking Tool
        • Run Video Benchmarking Tool with EdgeVideoAnalyticsMicroservice
      • DiscoverHistory Tool
        • Build and Run the DiscoverHistory Tool
        • Sample Select Queries
        • Multi-instance Feature Support for the Builder Script with the DiscoverHistory Tool
      • EmbPublisher
        • How to Integrate this Tool with Video or Time Series Use Case
        • Configuration of the Tool
        • Running the EmbPublisher in IPC Mode
      • EmbSubscriber
        • Prerequisites
        • Run the EmbSubscriber
        • Run the EmbSubscriber in IPC mode
      • GigEConfig Tool
        • Generating PFS (Pylon Feature Stream) File
        • Running GigEConfig Tool
      • HttpTestServer
        • Prerequisites for Running the HttpTestServer
        • Starting HttpTestServer
      • Develop Python User Defined Functions using Jupyter Notebook
        • Prerequisites for using Jupyter Notebook
        • Run Jupyter Notebook from Web Browser
        • Run Jupyter Notebook using Visual Studio Code
      • MQTT Publisher
        • Usage
      • NodeRedHttpClientApp
        • Configure NodeRed
        • Getting EII UDF Classifier result 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
      • EII TimeSeriesProfiler
        • Prerequisites
        • EII TimeSeriesProfiler Mode
        • EII TimeSeriesProfiler Configuration
        • Running TimeSeriesProfiler
      • EII Video Profiler
        • EII Video Profiler Prerequisites
        • EII Video Profiler Modes
        • EII Video Profiler Configuration
        • Run Video Profiler
        • Run VideoProfiler with EdgeVideoAnalyticsMicroservice
        • Run VideoProfiler in Helm Use Case
        • Optimize EII Video Pipeline by Analysing Video Profiler Results
        • Benchmarking with Multi-instance Config
    • EII Samples
      • Sample Apps
      • Run the Samples Apps
    • Web Deployment Tool
    • Ansible
      • Ansible based EII Prequisites setup, provisioning, build and deployment
      • Installing Ansible on Ubuntu {Control node}
      • Prerequisite Steps Required for all the Control/Worker Nodes
        • Generate SSH KEY for all Nodes
      • Adding SSH Authorized Key from Control Node to all the Nodes
        • Configure Sudoers file to Accept NO PASSWORD for sudo operation
      • Updating the Leader Information for Using Remote Hosts
      • Updating the EII Source Folder, Usecase and Proxy Settings in Group Variables
      • Remote Node Deployment
      • Execute Ansible Playbook from [EII_WORKDIR]/IEdgeInsights/build/ansible {Control node} to deploy EII services in control node/remote node
        • For Single Point of Execution
        • Deploying EII Using Helm in Kubernetes (k8s) Environment
    • Universal Wellpad Controller
      • 1.0 Introduction
        • 1.1 Purpose
        • 1.2 Scope
        • 1.3 System Requirements
      • 2.0 Release Notes
        • Feature list- supported in Universal Wellpad Controller -v4.0
        • Feature list- supported in Universal Wellpad Controller -v2.0
        • Feature list- supported in Universal Wellpad Controller-v1.5.1 (Hotfix Release)
        • Feature list- supported in Universal Wellpad Controller-v1.6.1 (Hotfix Release)
        • Feature list- supported in Universal Wellpad Controller-v1.6
        • Feature list- supported in Universal Wellpad Controller-v1.5
        • Feature list supported in Universal Wellpad Controller-v1.0
        • 2.1 Changes to Existing Features in latest release
        • 2.2 Unsupported or Discontinued Features in latest release
      • 3.0 Before Installation
        • 3.1 Universal Wellpad Controller for Oil and Gas Site
        • 3.2 Upstream Oil and Gas Facilities
        • 3.3 Understanding Universal Wellpad Controller Platform
      • 4.0 Installation Guide
        • 4.1 How to install Universal Wellpad Controller with Edge Insights for Industrial installer
      • 5.0 Deactivate Operating System Updates
        • 5.1 Deactivate Auto Update
      • 6.0 Container Configuration Settings
        • 6.1 Containers
        • 6.2 Modbus TCP Communication
        • 6.3 Modbus RTU Communication
        • 6.4 MQTT Bridge
        • 6.5 MQTT
        • 6.6 Sparkplug-Bridge
        • 6.7 Vendor Apps
        • 6.8 KPI App
      • 7.0 Site Configurations
        • 7.1 System Level Global Configuration
        • 7.2 How to Configure Site and Wellhead
        • 7.3 How to Configure Devices
        • 7.4 How to Configure Device points
        • 7.5 How to Add, Edit, or Delete a New Wellhead, Device, or point configurations
        • 7.6 KPI App Configuration
      • 8.0 Universal Wellpad Controller Modbus Operations
        • 8.1 Topic Format for Publishing/Subscribing
        • 8.2 Data Polling
        • 8.3 On-Demand Write
        • 8.4 On-Demand Read
        • 8.5 KPI Application
      • 9.0 Sparkplug-Bridge Operations
        • 9.1 App mode of communication
        • 9.2 App (virtual device) communication
        • 9.3 Modbus (real) device communication
        • 9.4 SparkPlug Messages
      • 10.0 Debugging steps
      • 11.0 Error Codes
      • 12.0 Steps to flash Low Frequency Mode BIOS
      • 13.0 Universal Wellpad Controller Gateway to Cloud Communication
        • 13.1 Architecture
        • 13.2 Installation and Configuration
        • 13.3 Monitor Data on Cloud
      • 14.0 RT Patch (Optional)
        • 14.1 Steps to Choose and Apply RT Kernel Patch
        • 14.2 Install Prerequisites
        • 14.3 Steps To Apply RT Kernel Patch
      • 15.0 Appendix for UWC files/folders
    • Intel® In-Band Manageability
      • Installing Intel® In-Band Manageability
      • Known Issues
    • Edge Insights for Industrial Uninstaller
    • Debug
      • Debugging Options
      • Troubleshooting Guide
  • Developer Reference
    • Message Bus Library
      • Message Bus
        • Dependency Installation
        • Compilation
        • Generating Documentation
        • Potential Compilation Issues
        • Packaging
        • Installation
        • Running Unit Tests
        • Configuration
        • Example Usage
        • Security
        • Known issues
        • Generation of python .whl file (Optional)
      • API Documentation
    • Config Manager Library
      • ConfigMgr Overview
        • ConfigMgr Installation
        • Compilation
        • Packaging
        • Install ConfigMgr with Python bindings, Go bindings, Examples, Test suits, and Debug Build
        • Interfaces
        • Publisher Interface
        • Overriding of Type and EndPoint
        • Broker Use Case
        • zmq_tcp Protocol Use Case
        • zmq_ipc Protocol usecase
        • Running Examples
        • Running Unit Tests
        • Creation of grpc .zip file (Optional)
        • Generation of python .whl file (Optional)
      • API Documentation
  • Release Notes
    • EII 4.0.0
      • Features
      • Known Issues
    • Open EII v3.0.1
      • Fixes
      • Known Issues
    • Open EII v3.0
      • New Features
      • Dropped Features
      • Known Issues
  • Glossary of Terms
    • General Terminology
    • Security-Related Terminology
  • Security
    • Provisioning
      • Generating Keys and Certificates
    • Start Up and Run Time
      • Accessing Secrets
    • Certificate Revocation
EII Documentation
  • 4.0 »
  • Search

© Copyright (c) 2023 Intel Corporation.

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