Welcome to FogLAMP’s documentation!

• Introduction to FogLAMP
  • Typical Use Cases
  • Architectural Overview
  • No-code/Low-code Development
• Quick Start Guide
  • Installing FogLAMP
    • Using the package repository to install FogLAMP
      • Ubuntu or Debian
    • Installing FogLAMP downloaded packages
    • Checking package installation
    • Run with PostgreSQL
  • 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
    • Display Graph
    • Download Data
  • Sending Data to Other Systems
    • Adding Data Destinations
    • Configuring Data Destinations
    • Enabling and Disabling Data Destinations
    • Using the OMF plugin
  • PI Web API OMF Endpoint
  • Edge Data Store OMF Endpoint
  • AVEVA Data Hub OMF Endpoint
  • OSIsoft Cloud Services OMF Endpoint
  • PI Connector Relay
    • Naming Scheme
    • Asset Framework Hierarchy Rules
    • OMF Hints
  • Number Format Hints
  • Integer Format Hints
  • Type Name Hints
  • Type Hint
  • Tag Name Hint
  • Datapoint Specific Hint
  • Asset Framework Location Hint
  • Adding OMF Hints
  • Backing up and Restoring FogLAMP
  • Troubleshooting and Support Information
  • Package Uninstallation
    • Debian 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
  • 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
  • Installing A PostgreSQL server
    • Ubuntu Install
  • SQLite Plugin Configuration
  • 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
    • 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
• FogLAMP Control Features
  • Control Functions
    • Set Point
    • Operation
  • Control Paths
    • Edge Based Control
      • Data Substitution
      • Tuning edge control systems
    • End to End Control
  • 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
• Plugin Documentation
  • FogLAMP South Plugins
    • ABB Ability Smart Cloud Service
    • AM2315 Temperature & Humidity Sensor
      • Wiring The Sensor
    • Beckhoff TwinCAT
      • Adding AMS Route
      • Map Format
        • Example
        • Testing
    • 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
    • DNP3 Master Plugin
      • DNP3 Out Station Testing
    • Data Translation DT9837 Series
    • Edge ML Plugin
      • Installation
        • Part 1: Get the video feed
        • Part 2: Start the Edge ML cluster
    • EtherIP South Plugin
      • Configuration Parameters
        • Map
        • Example JSON Map
    • Expression South Plugin
      • Expression Support
    • 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
    • Modbus South Plugin
      • Configuration Parameters
        • Register Map
        • Example Maps
        • Function Codes
      • Set Point Control
      • Error Messages
    • South MQTT
      • Message Payload
    • MQTT Sparkplug B
    • MQTT South with Payload Scripting
      • Limitations & Recommendations
      • Configuration
      • Object Policy
      • Timestamp Treatment
        • Time Format
      • Script Error Handling
      • Error Messages & Warnings
    • OPC/UA South Plugin
      • Subscriptions
        • Configuration examples
    • Person Detection Plugin
      • Installation
    • Person Detector Plugin
      • Installation
    • PI Web API south Plugin
      • Using the Plugin
    • Playback Plugin
      • Picking Columns
    • PT100 Temperature Sensor
      • Wiring The Sensor
    • Random
    • Random Walk
    • Enviro pHAT Plugin
    • OPC/UA Safe & Secure South Plugin
      • Subscriptions
        • Subscription examples
      • 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
    • Siemens S7 PLC
      • Configuring the PLC
        • Assigning an IP Address
        • Enable PUT/GET operations
      • Using the Plugin
      • Map Format
    • Samotics4 South Plugin
      • Configuration Parameters
    • SenseHAT
    • Simple REST with Payload Scripting
      • Configuration
      • Selection Method
        • ID Based
        • Time Based
      • Request URL Handling
      • Response Payload Handling
      • Timestamp Treatment
      • Script Error Handling
      • Error Messages & Warnings
    • Sinusoid
    • Radiometric Data Capture for FLIR cameras
      • Configuration
      • Control
      • Data
    • Suez Water Cloud Service Plugin
      • Error Messages
    • System Information
    • Advantech USB-4704
    • Video4Linux
      • Asset Ingestion
    • South Webcam Media Plugin
      • Execution
  • FogLAMP North Plugins
    • OMF
      • PI Web API OMF Endpoint
      • Edge Data Store OMF Endpoint
      • AVEVA Data Hub OMF Endpoint
      • OSIsoft Cloud Services OMF Endpoint
      • PI Connector Relay
        • Naming Scheme
        • Asset Framework Hierarchy Rules
        • OMF Hints
      • Number Format Hints
      • Integer Format Hints
      • Type Name Hints
      • Type Hint
      • Tag Name Hint
      • Datapoint Specific Hint
      • Asset Framework Location Hint
      • Adding OMF Hints
    • Azure IoT Hub
      • JSON Payload
    • Google Cloud Platform North Plugin
      • Prerequisites
        • Create GCP IoT Core Project
        • Download roots.pem
        • Create a Registry
        • Create a Device ID
        • Upload Your Certificates
        • Create Your North Task
    • Google Pub/Sub Plugin
    • Graphite
    • HarperDB
    • North HTTP
      • JSON Payload
    • North HTTP-C
      • Header Fields
      • JSON Payload
      • Payload Script
    • InfluxDB Time Series Database
    • InfluxDB Cloud
    • Kafka Producer
    • OPCUA Server
      • Hierarchy Definition
      • Control Map
    • PNG File Writer
    • Splunk Data Collector
    • ThingSpeak
  • FogLAMP Filter Plugins
    • Asset Filter
      • Asset Rules
    • Asset Split Filter
    • Change Filter
    • 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
    • Down Sample Filter
    • Edge ML Filter Plugin
      • Installation
    • Exponential Moving Average
    • Event Rate Filter
    • Expression Filter
      • Expressions
    • Fast Fourier Transform Filter
    • FFT2 Filter
    • Flir Validity Filter
    • Greyscale Filter
    • Log Filter
    • Metadata Filter
      • Example Metadata
    • Image Mirror Filter Plugin
    • OMF Hint Filter
      • OMF Hint data
    • 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
    • Rate Filter
    • Rename Filter
      • Example
    • Replace Filter
    • Root Mean Squared (RMS) Filter
    • Image Rotation Filter Plugin
    • Scale Filter
    • Scale Set Filter
      • Example
    • Sigma Data Cleansing Filter
    • Simple Python Filter
    • Specgram Filter
    • Statistics Filter
    • Threshold Filter
      • Expressions
    • Vibration Features Filter
  • FogLAMP Notification Rule Plugins
    • Threshold Rule
    • Moving Average Rule
    • Delta Rule
    • Periodic Rule
    • Expression Rule
    • Simple-Sigma Rule
    • Watchdog Rule
  • FogLAMP Notification Delivery Plugins
    • Amazon Alexa Notification
    • Asset Notification
    • Configuration Update
    • Control Dispatcher Notification
      • Trigger Values
    • 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
    • MQTT Notification
    • Conditional Forwarding
    • Operation Notification
    • Python 3 Script
      • Example Script
    • 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
• Securing FogLAMP
  • Enabling HTTPS Encryption
  • Requiring User Login
    • Changing Your Password
    • Password Rotation Mechanism
  • User Management
    • Adding Users
    • Changing User Roles
    • Reset User Password
    • Delete A User
  • Certificate Store
• Tuning FogLAMP
  • South Service Advanced Configuration
    • Tuning Buffer Usage
  • North Advanced Configuration
  • Health Monitoring
  • Scheduler
  • Storage
    • Choosing A Storage Plugin
      • Configuring Storage Plugins
      • sqlite Plugin Configuration
      • sqlitelb Configuration
      • postgres Configuration
      • sqlitememory Configuration
• Troubleshooting the PI Server integration
  • Log files
  • How to check the PI Web API is installed and running
  • Commands to check the PI WEB API
  • Error messages and causes
  • OMF Plugin Data
    • Managing Plugin Persisted Data
      • Enable Develop Features
      • Viewing Persisted Data
    • Understanding The OMF Persisted Data
  • Possible solutions to common problems
• Plugin Developer Guide
  • Plugins
    • Plugins in this version of FogLAMP
    • Installing New Plugins
  • Representing Data
  • Writing and Using Plugins
    • Common FogLAMP Plugin API
      • Plugin Information
      • Plugin Initialization
      • Plugin Shutdown
      • Plugin Reconfigure
    • Configuration Lifecycle
      • Discovery
  • 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
  • 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 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.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
• Glossary