Welcome to FogLAMP’s documentation!

• Introduction to FogLAMP
  • Typical Use Cases
  • Architectural Overview
  • No-code/Low-code Development
• Quick Start Guide
  • Supported Platforms
  • Installing FogLAMP
    • Using the package repository to install FogLAMP
      • Ubuntu or Debian
    • Installing FogLAMP downloaded packages
    • Firewall Configuration
    • Checking package installation
    • Run with PostgreSQL
    • Using Docker Containerizer to install FogLAMP
      • Ubuntu 20.04
  • Starting and stopping FogLAMP
  • Troubleshooting FogLAMP
  • Running the FogLAMP GUI
    • FogLAMP Dashboard
  • Managing Data Sources
    • Adding Data Sources
    • Configuring Data Sources
    • Enabling and Disabling Data Sources
  • Viewing Data
    • Displaying A Graph
      • Adjusting The Timeframe
      • Viewing Multiple Assets
      • Non-graphical Data
    • Download Data
    • Most Recent Data
  • Sending Data to Other Systems
    • Adding Data Destinations
    • Configuring Data Destinations
    • Enabling and Disabling Data Destinations
    • Failure to Send Data
    • Using the OMF plugin
  • OMF End Points
    • PI Web API OMF Endpoint
    • AVEVA Data Hub
    • Edge Data Store OMF Endpoint
    • PI Connector Relay
    • OSIsoft Cloud Services
  • Configuration
    • Basic
    • Asset Framework
    • Authentication
    • Cloud
    • Connection
    • Formats & Types
  • Naming Scheme
  • Asset Framework Hierarchy Rules
  • OMF Hints
    • Number Format Hints
    • Integer Format Hints
    • Type Name Hints
    • Type Hint
    • Tag Name Hint
    • Source Hint
    • Datapoint Specific Hint
    • Asset Framework Location Hint
    • Unit Of Measure Hint
    • Minimum Hint
    • Maximum Hint
    • Interpolation
    • Adding OMF Hints
  • Numeric Data Types
    • Configuring Numeric Data Types
    • Detecting the Data Type Mismatch Problem
    • Recovering from the Data Type Mismatch Problem
    • Further Troubleshooting
  • Linked Types
  • OMF Version Support
  • Backing up and Restoring FogLAMP
  • Troubleshooting and Support Information
  • Package Updates
    • Installing Updates
  • Package Uninstallation
    • Debian Platform
    • Red Hat Platform
• Processing Data
  • Why Use Filters?
  • What Can Be Done?
  • Where Can it Be Done?
    • Adding a South Filter
      • Reordering Filters
      • Editing Filter Configuration
    • Adding Filters To The North
    • Graphical Pipeline Development
      • Adding A Pipeline
      • Plugin Interaction
      • Adding Filters
      • Reordering Filters
      • Accessing An Existing Pipeline
      • Canvas Action Bar
    • Pipeline Branching
  • Some Useful Filters
    • Scale
    • Metadata
    • Delta
    • Rate
• FogLAMP Architecture
  • FogLAMP Core
  • Storage Layer
  • South Microservices
  • North Microservices
  • Filters
  • Event Service
  • Set Point Control Service
  • REST API
  • Graphical User Interface
• Buffering & Storage
  • Configuring The Storage Plugin
    • SQLite Plugin Configuration
    • PostgreSQL Plugin Configuration
  • PostgreSQL Installation
    • Installing A PostgreSQL Server
      • Ubuntu Install
      • Red Hat Install
    • Using a Remote PostgreSQL Server
  • Storage Management
    • Purge Task
    • System Purge Task
• Additional Services
  • Bucket Storage Service
    • Limitations
    • Indexing
    • API
      • Adding a bucket
        • Error Responses
      • Retrieving Bucket Contents
        • Error Responses
      • Matching Bucket Attributes
        • Error Responses
      • Updating Bucket Attributes
        • Error Responses
      • Deleting a Bucket
        • Error Responses
  • Notifications Service
    • Notification Data Sources
      • Reading Data
      • Statistics Data
      • Audit Data
    • Notifications
      • Notification Rules
      • Notification Types
        • One shot
        • Toggle
        • Retriggered
      • Notification Delivery
    • Installing the Notification Service
      • Installing Notification Service Package
    • Starting The Notification Service
    • Configuring The Notification Service
    • Using The Notification Service
      • Add A Notification
        • Notification Log
      • Editing Notifications
      • Statistics Rate Example
      • Audit Data Example
• FogLAMP Control Features
  • Control Functions
    • Set Point
    • Operation
  • Control Paths
    • Edge Based Control
      • Data Substitution
      • Tuning edge control systems
    • End to End Control
  • API Control Invocation
    • Defining API Control Entry Points
    • Graphical User Interface
      • Adding A Control API Entry Point
  • Control Dispatcher Service
    • Forwarding Requests
    • Automation Scripts
      • Graphical Interface
        • Viewing & Editing Existing Scripts
        • Adding a Script
      • Step Conditions
    • Access Control Lists
      • Graphical Interface
        • Adding An ACL
        • Updating an ACL
    • Configuration
      • Server Configuration
      • Advanced Configuration
  • Control Pipelines
    • Mapping Rules
      • Data Types
    • Pipeline Connections
      • Pipeline Execution Models
    • Control Pipeline Management
      • Adding A Control Pipeline
• Plugin Documentation
  • FogLAMP South Plugins
    • ABB Ability Smart Cloud Service
      • See Also
    • AM2315 Temperature & Humidity Sensor
      • Wiring The Sensor
    • Armfield South Plugin
      • Configuration
        • Connection
        • Data
        • Digital Output 0
      • Asset Structure
      • Control Features
        • Pump Speed
        • User Analogue
        • Digital Outputs
    • Beckhoff TwinCAT
      • Adding AMS Route
      • Map Format
        • Example
        • Testing
      • See Also
    • Benchmark
      • See Also
    • CC2650 SensorTag
    • CoAP
    • Simple CSV Plugin
    • CSV Playback
      • Execution
      • Poll Vs Async
      • Behaviour under various modes
    • DHT11 (C version)
    • DHT11 (Python version)
    • Digiducer Vibration Sensor
      • See Also
    • DNP3 Master Plugin
      • DNP3 Out Station Testing
      • See Also
    • Data Translation DT9837 Series
      • See Also
    • Edge ML Plugin
      • Installation
        • Part 1: Get the video feed
        • Part 2: Start the Edge ML cluster
    • EtherIP South Plugin
      • Configuration Parameters
        • Tag Lists
          • Interacting With The List
        • Example Tag Lists
      • See Also
    • Expression South Plugin
      • Expression Support
      • See Also
    • Flir AX8 Thermal Imaging Camera
    • FLIR GW65 Vibration Sensors
      • Creating the GW65 South Service
      • Installing an MQTT Broker
    • South HTTP
      • JSON Payload
    • INA219 Voltage & Current Sensor
      • Wiring The Sensor
    • Lathe Simulation
      • Configuring the PLC
      • See Also
    • Modbus South Plugin
      • Configuration Parameters
        • Register Map
        • Example Maps
        • Function Codes
      • Set Point Control
      • Error Messages
      • See Also
    • South MQTT
      • Message Payload
      • See Also
    • MQTT Sparkplug B
      • Configuration
        • See Also
    • MQTT South with Payload Scripting
      • Limitations & Recommendations
      • Configuration
      • Object Policy
      • Timestamp Treatment
        • Time Format
      • Script Error Handling
      • Error Messages & Warnings
      • See Also
    • Observer South Plugin
      • Configuration Parameters
        • Connection
        • Authentication
        • Alarms
        • Data
        • Diagnoses
        • Spectral Data
        • Filtering
        • Asset Naming
        • Tuning
      • Historical Data
    • OPC/UA South Plugin
      • Subscriptions
        • Configuration examples
      • See Also
    • Person Detection Plugin
      • Installation
    • Person Detector Plugin
      • Installation
        • FAQs
    • PI Server South Plugin
      • Query Parameters
        • PI Data Archive Queries
        • PI Asset Framework Queries
        • Array of Queries
      • Principles of Operation
      • Recovery of Data from the PI Data Archive
      • Monitoring the Update Manager Queue
      • Meta Data Changes in the PI Server
        • Edits
        • Deletions
        • Creations
      • Performance Metrics
    • PI Web API south Plugin
      • Using the Plugin
    • Playback Plugin
      • Picking Columns
    • PT100 Temperature Sensor
      • Wiring The Sensor
    • Random
      • See Also
    • Random Walk
    • Enviro pHAT Plugin
    • RTSP Stream Capture Plugin
    • OPC UA Safe & Secure South Plugin
      • Basic Configuration
        • Handling Duplicate Browse Names
      • OPC UA Subscriptions
        • Subscription Filtering
      • OPC UA Advanced Configuration
        • Data Change Filter Errors
      • OPC UA Security Configuration
      • Control List
      • Subscriptions
        • Subscription Examples
      • Username Authentication
      • Certificate Management
        • Certificate Requirements
      • Self-Signed Certificates
        • Creating a Self-Signed Certificate
          • Private Key
          • Subject Attributes
          • Subject Alternative Name
          • x509v3 Extensions
            • Key Usage
            • Extended Key Usage
          • Encoding Options
          • CSR Options
          • Generating the Certificate and Private Key
          • Post-Processing the Certificate and Private Key
            • Converting the Certificate File
            • Converting the Private Key File
        • Importing the Certificate and Key Files
      • See Also
    • Siemens S7 PLC
      • Configuring the PLC
        • Assigning an IP Address
        • Enable PUT/GET operations
      • Using the Plugin
      • PLC Map
        • Interacting With The List
        • PLC Map Errors
      • See Also
    • Samotics4 South Plugin
      • Configuration Parameters
    • SenseHAT
    • Simple REST with Payload Scripting
      • Configuration
        • Default Configuration
        • Authentication
        • Data Selection
        • Script
        • Timestamps
      • Selection Method
        • ID Based
        • Time Based
      • Request URL Handling
      • Response Payload Handling
      • Timestamp Treatment
      • Script Error Handling
      • Integrating Inductive Automation’s Ignition Product
        • Ignition WebDev Code
      • Error Messages & Warnings
      • See Also
    • Sinusoid
      • See Also
    • Radiometric Data Capture for FLIR cameras
      • Configuration
      • Control
      • Data
    • Suez Water Cloud Service Plugin
      • Error Messages
    • System Information
    • Advantech USB-4704
    • Video4Linux
      • Asset Ingestion
      • See Also
    • South Webcam Media Plugin
      • Execution
      • See Also
  • FogLAMP North Plugins
    • AWS IoT North Plugin
    • AWS Redshift
      • Hints
    • Azure IoT Hub
      • JSON Payload
      • See Also
    • Azure Blob Storage
    • eDNA Historian
      • Configuration
        • Connection
        • Identifiers
        • Points
        • History
        • Service
      • eDNA Identifiers
        • Matching Predefined Points
    • Google Pub/Sub Plugin
      • See Also
    • Graphite
    • HarperDB
    • North HTTP
      • JSON Payload
    • North HTTP-C
      • Connection
      • Data
      • Tuning
      • Authentication
        • Header Fields
        • JSON Payload
        • Payload Script
        • Upstream Integration
      • Ignition Integration
    • InfluxDB Time Series Database
    • InfluxDB Cloud
    • Kafka Producer
      • Sending To Azure Event Hub
    • MQTT Publisher
      • Creation North
      • Topics
      • Message Payload
        • Payload Script
      • Control
      • See Also
    • Sparkplug B
    • OMF
      • OMF End Points
        • PI Web API OMF Endpoint
        • AVEVA Data Hub
        • Edge Data Store OMF Endpoint
        • PI Connector Relay
        • OSIsoft Cloud Services
      • Configuration
        • Basic
        • Asset Framework
        • Authentication
        • Cloud
        • Connection
        • Formats & Types
      • Naming Scheme
      • Asset Framework Hierarchy Rules
      • OMF Hints
        • Number Format Hints
        • Integer Format Hints
        • Type Name Hints
        • Type Hint
        • Tag Name Hint
        • Source Hint
        • Datapoint Specific Hint
        • Asset Framework Location Hint
        • Unit Of Measure Hint
        • Minimum Hint
        • Maximum Hint
        • Interpolation
        • Adding OMF Hints
      • Numeric Data Types
        • Configuring Numeric Data Types
        • Detecting the Data Type Mismatch Problem
        • Recovering from the Data Type Mismatch Problem
        • Further Troubleshooting
      • Linked Types
      • OMF Version Support
    • OPC UA Server North Plugin
      • Hierarchy Definition
        • Parsing of Full Paths
      • Control Map
    • North OPC UA Client
      • Certificate Management
        • Importing the Certificate and Key Files
        • Known Issue
    • PNG File Writer
      • See Also
    • Splunk Data Collector
    • ThingSpeak
  • FogLAMP Filter Plugins
    • Filter Plugin For Large Discharge (LD) Prediction In Centrifuge
      • 1. Setting up your artifacts
      • 2. Setting up bucket
      • 3. Setting up plugin configuration
        • See Also
    • Boon Amber Model Filter
      • Operational Principle
      • Configuration
        • Naming
        • Model Tuning
        • License
      • See Also
    • anomaly-injection Filter
    • Asset Filter
      • Asset Rules
      • Examples
        • Remove Assets From The Pipeline
        • Flatten Hierarchical Data
        • Changing Datapoint Names
        • Remove Named Datapoint From An Asset
        • Passing On A Subset Of Datapoints
        • Removing Image Data From Pipelines
        • Split an asset into multiple assets
        • Combining Rules
        • Regular Expression
        • Examples
      • See Also
    • Asset Join Filter Plugin
    • Asset Split Filter
    • Asset Validation Filter
      • Filter Configuration
      • See Also
    • AWS Redshift Hints Filter
    • Batch Label Filter Plugin
      • See Also
    • Bounds Filter
      • Configuration
        • Basic
        • Bounds
      • Bounds Data Format
    • Filter Plugin For Breakover Prediction
      • 1. Setting up your artifacts
      • 2. Setting up bucket
      • 3. Setting up plugin configuration
        • See Also
    • Change Filter
      • See Also
    • Change Detection Filter
      • Configuration Details
    • Conditional Labeling Filter
      • Expressions
      • Known Restrictions
      • See Also
    • CSV Writer
      • Execution
        • Part 1: Get some south service running
        • Part 2: Add the filter & attach to service
      • Modes
        • Periodic
        • Continuous
        • Cron style collection
      • Cascading CSV writer filter
      • Behaviour on restart and reconfigure
      • How data is rotated?
      • Decryption
    • Delta Filter
      • Important notes:
        • See Also
    • Down Sample Filter
      • See Also
    • Edge ML Filter Plugin
      • Installation
      • See Also
    • eDNA Hint Filter
      • EDNA Hint data
      • Macro substitution
      • Hints & Point Creation
      • See Also
    • Exponential Moving Average
    • Enumeration Filter
      • Filter Configuration
      • Operation
        • Match Failures
      • Example
      • See Also
    • Event Rate Filter
    • Expression Filter
      • Expressions
      • Known Restrictions
      • See Also
    • Fast Fourier Transform Filter
      • See Also
    • FFT2 Filter
    • Flir Validity Filter
    • Greyscale Filter
      • See Also
    • Bounding Box Filter Plugin
      • See Also
    • Image Resize Plugin
      • See Also
    • Inventory Filter
      • Filter Configuration
      • Filter Output
        • Data Sets
      • See Also
    • Log Filter
      • See Also
    • Metadata Filter
      • Macro Substitution
      • Example Metadata
      • See Also
    • Image Mirror Filter Plugin
      • See Also
    • Moving Measure Filter Plugin
      • Benefits and Aspects
        • High Level Structure of Plugin
          • 1. Sliding/Moving Window
          • 2. Weightage
          • 3. Measure
      • Configurations
    • Normalise Filter Plugin
      • See Also
    • OMF Hint Filter
      • OMF Hint data
      • Macro substitution
      • See Also
    • Python 2.7 Filter
      • Example
    • Python 3.5 Filter
      • Adding Python35 Filters
      • Example
      • Scripting Guidelines
        • Importing Python Packages
        • Use of Global Variables
        • File IO Operations
        • Threads within Python
        • Interaction with External Systems
        • Scripting Errors
          • Error Messages & Warnings
      • See Also
    • Rate Filter
      • See Also
    • Regex Filter
      • Regular Expressions
        • Examples
      • Replacement Text
      • See Also
    • Rename Filter
      • Example
      • See Also
    • Replace Filter
      • See Also
    • Root Mean Squared (RMS) Filter
      • See Also
    • Image Rotation Filter Plugin
      • See Also
    • Single Asset Semantic Model Filter
      • Configuration
        • Datapoints
        • Model
        • Reporting
      • See Also
    • Scale Filter
    • Scale Set Filter
      • List Interactions
        • Example
      • List Interactions
        • See Also
    • Sigma Data Cleansing Filter
      • See Also
    • Simple Python Filter
    • SparkplugB Hint Filter Plugin
      • See Also
    • Specgram Filter
      • See Also
    • Statistics Filter
      • See Also
    • Threshold Filter
      • Expressions
    • Vibration Features Filter
      • See Also
  • FogLAMP Notification Rule Plugins
    • Moving Average Rule
      • Data Source
    • DataAvailability Rule
    • Delta Rule
    • Flatline Notification Rule
    • Match Rule
    • Periodic Rule
    • Expression Rule
      • Time based expressions
    • Simple-Sigma Rule
    • Threshold Rule
      • Data Source
    • Watchdog Rule
  • FogLAMP Notification Delivery Plugins
    • Alert Notification
    • Amazon Alexa Notification
    • Asset Notification
    • Configuration Update
    • Control Dispatcher Notification
      • Trigger Values
        • Examples
          • Asset Based Control
          • Script Based Control
          • Broadcast Control
    • Custom Asset Notification
      • Store Configuration
    • Email Notifications
    • Google Chat
    • IFTTT Delivery Plugin
    • Jira Ticket Creation
      • Text Substitution
    • JSON Configuration Update
      • JSON Path
    • Management Poll Notification
      • Plugin Uses
    • Microsoft Teams Notification
    • MQTT Notification
    • Conditional Forwarding
    • Operation Notification
      • Trigger Values
    • Python 3 Script
      • Example Script
    • REST Notification
      • Connection
      • General
      • On Clear
      • On Trigger
    • Schedule Update
    • Set Point Control Notification
      • Trigger Values
    • Slack Messages
    • Telegram Messages
    • Zendesk Ticket Creation
      • Text Substitution
• Developing Data Pipelines
  • Best Practices
    • Incremental Development
      • Sacrificial North System
    • OMF Specific Considerations
    • Examining Data
    • Examining Logs
    • Enabling and Disabling Filters
    • Scripting Plugins
      • Scripting Guidelines
      • Importing Python Packages
      • Use of Global Variables
      • File IO Operations
      • Threads within Python
      • Interaction with External Systems
      • Scripting Errors
• Monitoring
  • Introduction
  • Service State
  • Resources
    • Example
  • Database Disk Usage
  • Configuration Changes
    • Using Notifications
    • Sending To External Systems
    • Audit Log Data
  • Pipeline Data Flow
    • South Service Data Flow
    • North Service Data Flow
    • Statistics Mechanism
      • Monitor Low North Flow Rate
      • Detecting Fluctuating Flows
  • Data Quality
    • Failure Modes
      • Detecting Failure Modes
        • Out of Range Data
        • No Data Read
• Securing FogLAMP
  • Enabling HTTPS Encryption
  • Allow & Deny Lists
  • Requiring User Login
    • Failed Login Attempts
    • Changing Your Password
    • Password Policy
    • Password Rotation Mechanism
  • User Management
    • Adding Users
    • Update User Details
    • Changing User Roles
    • Reset User Password
    • Delete A User
  • Certificate Store
    • Generate a new auth certificates for user login
• Tuning FogLAMP
  • Setting Log Level
  • Configuration Manager Cache
  • South Service Advanced Configuration
    • Performance Counters
    • Ingest Rate Monitoring
    • Fixed Time Polling
    • Tuning Buffer Usage
    • Reading Latency
  • North Advanced Configuration
    • Performance Counters
  • Health Monitoring
  • Scheduler
    • Startup Ordering
  • Storage
    • Choosing A Storage Plugin
      • Configuring Storage Plugins
      • sqlite Plugin Configuration
      • sqlitelb Configuration
      • postgres Configuration
      • sqlitememory Configuration
    • Performance Counters
  • Purge
    • Purge System
    • Purge Process
  • Using Performance Counters
    • Sampling
    • Identifying bottlenecks
    • Removing Monitors
    • Cautions
• Troubleshooting the PI Server integration
  • Complex Types vs. Linked Types
    • Complex Types
    • Linked Types
    • Understanding Types when upgrading FogLAMP
  • Log files
    • Information Messages
      • Types, Elements and Links
      • Containers
        • Containers with Linked Types
        • Containers with Complex Types
      • Created vs. Confirmed
    • Tracing File
  • How to confirm that PI Web API is installed and running
    • Commands to check PI Web API
  • Error Messages and Causes
    • Loss of Connection to the PI Web API Server
    • HTTP Code 409: Processing cannot continue until data archive errors are corrected
    • HTTP Code 409: The supplied container overlaps with a different existing container
      • Complex Types
      • Linked Types
      • Repair Procedure
    • HTTP Code 409: One or more PI Points could not be created
    • PI License Expired or Limit Exceeded
  • OMF Plugin Persisted Data
    • Managing Plugin Persisted Data
      • Enable Developer Features
      • Viewing Persisted Data
    • Understanding The OMF Persisted Data
      • Linked Type Persisted Data
      • Complex Type Persisted Data
  • Possible Solutions to Common Problems
    • Recreate PI Server objects and resend data to the same AF Hierarchy
    • Recreate PI Server objects and resend data to the same AF Hierarchy
    • Resend Data with Data Duplication
    • Resend Data without Data Duplication
• Plugin Developer Guide
  • Plugins
    • Plugins in this version of FogLAMP
    • Installing New Plugins
  • Representing Data
  • Writing and Using Plugins
    • General Guidance
    • Common FogLAMP Plugin API
      • Plugin Information
      • Plugin Initialization
      • Plugin Shutdown
      • Plugin Reconfigure
    • Configuration Lifecycle
      • Types
        • List
        • Key/Value List
        • Lists of Objects
      • Properties
      • Management
      • Discovery
      • Writing Audit Trail
      • Permissions
  • Persisting Data
    • Restoring Persisted Data
    • Persisting Data
    • Viewing Persisted Data
  • South Plugins
    • Polled Mode
      • Plugin Poll
    • Async IO Mode
      • Plugin Start
      • Async Data Callback
    • Set Point Control
      • Enable Control
      • Control Entry Points
        • Write Entry Point
        • Operation Entry Point
    • A South Plugin Example In Python: the DHT11 Sensor
      • The Hardware
      • The Software
      • The Plugin
      • Building FogLAMP and Adding the Plugin
      • Using the Plugin
  • South Plugins in C
    • Polled Mode
      • Plugin Poll
      • Plugin Poll Returning Multiple Values
    • Async IO Mode
      • Plugin Register Ingest
      • Plugin Start
    • Set Point Control
      • Enable Control
      • Control Entry Points
        • Write Entry Point
        • Operation Entry Point
    • A South Plugin Example In C/C++: the DHT11 Sensor
      • The Software
      • The Plugin
      • Building FogLAMP and Adding the Plugin
  • C++ Support Classes
    • Reading
    • Configuration Category
    • Logger
  • Hybrid Plugins
  • North Plugins
    • Python Plugins
      • The plugin_info call
        • Configuration
      • The plugin_init call
      • The plugin_send call
      • The plugin_shutdown call
      • Reconfiguration
      • Payload Handling
    • C/C++ Plugins
      • The plugin_info entry point
      • The plugin_init entry point
      • The plugin_send entry point
      • The plugin_shutdown entry point
      • The plugin_register entry point
    • Set Point Control
  • Storage Plugins
    • Data and Metadata
    • Common Elements for Storage Plugins
  • Filter Plugins
    • Configuration
    • C++ Filter Plugin API
      • Plugin Information
      • Plugin Initialise
      • Plugin Ingest
      • Plugin Reconfigure
      • Plugin Shutdown
      • C++ Helper Class
    • C++ Filter Example
      • Plugin Interface
      • Filter Class
      • Filter Class Implementation
    • Python Filter API
      • Plugin Information
      • Plugin Initialisation
      • Plugin Ingestion
      • Plugin Reconfigure
      • Plugin Shutdown
    • Python Filter Example
  • Notification Delivery Plugins
    • Configuration
    • Notification Delivery Plugin API
      • Plugin Information
      • Plugin Initialise
      • Plugin Delivery
      • Plugin Reconfigure
      • Plugin Shutdown
  • Storage Service And Plugins
    • Use of JSON
      • Requirements
      • Implementation Language
        • Language Choice Reasons
        • Library Choice
    • Classes of Data Stored
    • Common Data Access Methods
    • Readings Data Access
      • Reading Creation
      • Managing Blocked Retrievals
      • Bypassing Database Storage
      • Reading Retrieval
      • Reading Removal
    • Storage Plugin
      • Entry Points
      • Plugin Error Handling
      • Plugin API Header File
      • Plugin Support
      • Plugin Information
      • Plugin Initialisation
      • Plugin Common Insert
      • Plugin Common Retrieve
      • Plugin Common Update
      • Plugin Common Delete
      • Plugin Reading Append
      • Plugin Reading Fetch
      • Plugin Reading Retrieve
      • Plugin Reading Purge
      • Plugin Release
      • Plugin Error Retrieval
      • Plugin Shutdown
      • Encoding Query Predicates in JSON
        • Aggregation
        • Grouping
        • Sorting
        • Limit
        • Creating Time Series Data
        • Joining Tables
        • JSON Predicate Schema
      • Controlling Returned Values
        • Returning Limited Set of Columns
        • Formatting Columns
      • Return JSON Document Content
  • Plugin Packaging
    • Common files
    • C based Plugins
      • Examples of filename along with content
      • Common Additional Libraries Package
    • Python based Plugins
      • Examples of filename along with content
    • Building A Package
  • Testing Your Plugin
    • Initial Testing
    • C/C++ Common Faults
    • Running Under a Debugger
      • Running a Service Under the Debugger
      • Running a Task Under the Debugger
      • Running the Storage Service Under the Debugger
    • Using strace
    • Memory Leaks and Corruptions
    • Python Plugin Info
  • Developing with Windows Subsystem for Linux (WSL2)
    • Preparing the Development Environment
      • Installing Windows Subsystem for Linux (WSL2)
        • Some Useful Features of WSL2
      • Preparing the Linux Distribution for FogLAMP
      • Installing FogLAMP
      • Installing Visual Studio Code
    • Starting the Linux Distribution
      • Starting syslog
      • Starting Nginx
      • Starting FogLAMP
      • Starting FogLAMP GUI
    • Configuring Visual Studio Code
      • Installing Extensions
      • Configuring your Workspace
        • Code Editor Configuration: c_cpp_properties.json
        • Build Configuration: tasks.json
        • Debugger Configuration: launch.json
    • Known Problems
    • References
• REST API Developers Guide
  • The FogLAMP REST API
    • Introducing the FogLAMP REST API
      • Port Usage
      • Infrastructure
  • REST API Users & Authentication
    • Authentication API
      • Login
      • Logout
    • Users
      • Add User
      • Get All Users
      • Update User
      • Change Password
      • Admin Update User
      • Delete User
  • Administration API Reference
    • Audit Trail
      • audit
        • GET Audit Entries
        • POST Audit Entries
    • Configuration Management
      • category
        • GET categor(ies)
        • GET category
        • GET category item
        • PUT category item
        • DELETE category item
        • POST category
    • Task Management
      • task
        • GET task
        • GET task latest
        • GET task by ID
        • Cancel task by ID
    • Other Administrative API calls
      • shutdown
      • restart
      • ping
        • GET ping
  • Statistics
    • GET statistics
    • GET statistics/history
    • GET statistics/rate
  • Asset Tacker
    • Deprecation
  • Repository Configuration
  • Update Packages
  • Working With Services
    • Service Status
      • Parameters
      • South and North Services
      • South Services
    • Service Types
      • Installed Service Types
      • Available Service Types
      • Install a Service Type
    • Creating A Service
    • Stopping and Starting Services
    • Deleting a Service
  • User API Reference
    • Browsing Assets
      • asset
        • GET all assets
        • GET asset readings
        • GET asset reading
        • GET asset reading summary
        • GET all asset reading timespan
        • GET asset reading timespan
        • GET timed average asset reading
  • Developer API Calls
    • Purge Readings
    • View Plugin Persisted Data
  • Grafana Examples
    • Show FogLAMP Status
    • Display Statistics
    • Graph Reading Data
• Building FogLAMP
  • Building Developers Guide
    • Introduction
      • What Is FogLAMP?
        • FogLAMP Positioning in an IoT and IIoT Infrastructure
      • FogLAMP Features
    • Developers Toolkit
      • Choosing Developers Toolkit Version
      • Installation
        • Ubuntu or Debian
        • Developer Toolkit Package
        • Building Plugins
• Version History
  • FogLAMP v2
    • v2.6.0
    • v2.5.0
    • v2.4.0
    • v2.3.0
    • v2.2.0
    • v2.1.0
    • v2.0.1
    • v2.0.0
  • FogLAMP v1
    • v1.9.2
    • v1.9.1
    • v1.9.0
    • v1.8.2
    • v1.8.1
    • v1.8.0
    • v1.7.0
    • v1.6.0
    • v1.5.2
    • v1.5.1
    • v1.5.0
    • v1.4.1
    • v1.4.0
    • v1.3.1
      • Fixed Issues
    • v1.3
      • New Features
      • Known Issues
    • v1.2
      • New Features
      • Known Issues
    • v1.1.1
      • New Features
      • Known Issues
    • v1.1
      • New Features
      • Known Issues
    • v1.0
      • Features
      • Known Issues
• Downloads
  • Packages
• OMF Kerberos Authentication
  • Introduction
  • PI Server as the North endpoint
  • North plugin
  • FogLAMP server configuration
    • IP Address resolution of the KDC
    • Kerberos client configuration
    • Kerberos keytab file
    • Troubleshooting the Kerberos authentication
• FogLAMP Plugins
  • South Plugins
  • North Plugins
  • Filter Plugins
  • Notification Rule Plugins
  • Notification Delivery Plugins
  • Plugins Organized by Category
    • South
      • Plugin Utilising The MQTT Protocol
      • Electrical Plugins
      • Vibration Process Plugins
      • Plugins That Interact With PLCs
      • Plugins That Interact With Clouds
      • Image Data Plugins
      • Plugins That Provide Scripting
      • Computational Plugins
      • Data Simulation Plugins
    • North
      • Plugins That Interact With Clouds
      • Image Data Plugins
      • Plugins That Provide Scripting
    • Filters
      • Plugin Utilising The MQTT Protocol
      • Plugins That Process A Digital Signal
      • Vibration Process Plugins
      • Plugins That Compress Data
      • Plugins That Improve The Data Quality
      • Plugins That Augment Data
      • Plugins That Alter The Structure Of Data
      • OMF Plugins
      • Image Data Plugins
      • Plugins Used To Label Data
      • Plugin To Manipulate String Data
      • Plugins That Provide Scripting
      • Computational Plugins
      • Machine Learning Plugins
• Glossary