Welcome to FogLAMP’s documentation!

• Quick Start Guide
  • Introduction to FogLAMP
  • Installing FogLAMP
    • Installing FogLAMP packages
    • Checking package installation
  • 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 Connector Relay
      • PI Web API OMF Endpoint
      • EDS OMF Endpoint
      • OCS OMF Endpoint
  • Backing up and Restoring FogLAMP
  • Troubleshooting and Support Information
• Processing Data
  • 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
  • Southbound Microservices
  • Northbound Microservices
  • Filters
  • Event Engine
  • REST API
  • Graphical User Interface
• FogLAMP Plugins
  • South Plugins
  • North Plugins
  • Filter Plugins
  • Notification Rule Plugins
  • Notification Delivery Plugins
• 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
• Notifications Service
  • Notifications
    • Notification Rules
    • Notification Types
      • One shot
      • Toggle
      • Retriggered
    • Notification Delivery
  • Installing the Notification Service
    • Building 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
• Plugin Developer Guide
  • Plugins
    • Plugins in this version of FogLAMP
    • Installing New Plugins
  • Writing and Using Plugins
    • Common FogLAMP Plugin API
      • Plugin Information
      • Plugin Initialization
      • Plugin Shutdown
    • Plugin Reconfigure
  • South Plugins
    • Polled Mode
      • Plugin Poll
    • Async IO Mode
      • Plugin Start
      • Async Handler
    • 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
    • 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
    • The OMF Plugin
      • OMF Plugin Configuration
      • Changing the OMF Plugin Configuration
      • Data in the PI System
  • Storage Plugins
    • Data and Metadata
    • Common Elements for Storage Plugins
• REST API Developers Guide
  • The FogLAMP REST API
    • Introducing the FogLAMP REST API
      • Port Usage
      • Infrastructure
  • 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
      • ping
        • GET ping
      • statistics
        • GET statistics
        • GET statistics/history
  • User API Reference
    • Browsing Assets
      • asset
        • GET all assets
        • GET asset readings
        • GET asset reading
        • GET asset reading summary
        • GET timed average asset reading
• Building FogLAMP
  • Building Developers Guide
    • Introduction
      • What Is FogLAMP?
        • FogLAMP Positioning in an IoT and IIoT Infrastructure
      • FogLAMP Features
    • Building FogLAMP
      • FogLAMP Platforms
        • General Requirements
      • Building FogLAMP
        • Build Pre-Requisites
        • Obtaining the Source Code
        • Selecting the Correct Version
        • Building FogLAMP
        • Testing FogLAMP from the Build Environment
        • Now I Want to Stop FogLAMP!
      • Appendix: Setting the PostgreSQL Database
      • Appendix: Building FogLAMP on CentOS
        • Pre-Requisites
        • Building and Installing C++ 5.4
        • Installing PostgreSQL 9.6
        • Installing SQLite3
        • Changing to the PostgreSQL Engine
        • Building FogLAMP
        • Further Notes
    • FogLAMP Installation
      • Installing FogLAMP from a Build
        • Installing FogLAMP in a Different Destination Directory
        • Environment Variables
        • The setenv.sh Script
        • The foglamp.service Script
      • Installing the Debian Package
        • Obtaining and Installing the Debian Package
        • Upgrading or Downgrading FogLAMP
        • Uninstalling the Debian Package
    • Testing FogLAMP
      • First Checks: FogLAMP Status
      • Hello, Foggy World!
        • The FogLAMP REST API
          • Useful Tools
        • Hello World!
      • Hello from the Southern Hemisphere of the FogLAMP World
        • fogbench: a Brief Intro
        • Data Coming from South
      • Checking What’s Inside FogLAMP
        • Feeding East/West Applications
      • Sending Greetings to the Northern Hemisphere
        • The OMF Translator
        • Preparing the PI System
        • Setting the OMF Translator Plugin
        • Sending Data to the PI System
    • FogLAMP Utilities and Scripts
      • foglamp
        • Starting FogLAMP
        • Safe Mode
        • Stopping FogLAMP
        • If FogLAMP Does Not Stop
        • Checking the Status of FogLAMP
        • Resetting FogLAMP
    • FogLAMP Tasks
      • Purge
        • Purge Schedule
        • Purge Configuration
  • Building and using FogLAMP on Raspbian
  • Building and using FogLAMP on RedHat/CentOS
  • Install FogLAMP on Red Hat/CentOS using the RPM package
    • Installation on Red Hat
    • Installation on CentOS
  • Build of FogLAMP on Red Hat/CentOS
    • Build and use FogLAMP with PostgreSQL for Red Hat/CentOS
• Version History
  • FogLAMP v1
    • 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
  • Download/Clone from GitHub
• 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
  • Kerberos authentication on RedHat/CentOS
• Plugin Documentation
  • FogLAMP South Plugins
    • AM2315 Temperature & Humidity Sensor
      • Wiring The Sensor
    • CC2650 SensorTag
    • CoAP
    • Simple CSV Plugin
    • DHT11 (C version)
    • DHT11 (Python version)
    • DNP3 Master Plugin
      • DNP3 Out Station Testing
    • Enviro pHAT Plugin
    • Expression South Plugin
      • Expression Support
    • Flir AX8 Thermal Imaging Camera
    • South HTTP
    • INA219 Voltage & Current Sensor
      • Wiring The Sensor
    • Modbus South Plugin
      • Configuration Parameters
        • Register Map
        • Example Maps
    • MQTT Sparkplug B
    • OPC/UA South Plugin
      • Subscriptions
        • Configuration examples
    • Playback Plugin
      • Picking Columns
    • PT100 Temperature Sensor
      • Wiring The Sensor
    • Random
    • Random Walk
    • SenseHAT
    • Sinusoid
    • System Information
    • Advantech USB-4704
    • Beckhoff TwinCAT
      • Map Format
        • Example
        • Testing
    • Digiducer Vibration Sensor
  • FogLAMP North Plugins
    • 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
    • North HTTP
    • North HTTP-C
    • Kafka Producer
    • OPCUA Server
    • ThingSpeak
    • InfluxDB Time Series Database
    • Splunk Data Collector
  • FogLAMP Filter Plugins
    • Asset Filter
      • Asset Rules
    • Change Filter
    • Delta Filter
    • Expression Filter
      • Expressions
    • Fast Fourier Transform Filter
    • Flir Validity Filter
    • Metadata Filter
      • Example Metadata
    • Python 2.7 Filter
      • Example
    • Python 3.5 Filter
      • Example
    • Rate Filter
    • Root Mean Squared (RMS) Filter
    • Scale Filter
    • Scale Set Filter
      • Example
    • Threshold Filter
      • Expressions
    • Down Sample Filter
    • Exponential Moving Average
    • Event Rate Filter
    • Simple Python Filter
    • Statistics Filter
    • Vibration Features Filter
  • FogLAMP Notification Rule Plugins
    • Moving Average Rule
    • Expression Rule
  • FogLAMP Notification Delivery Plugins
    • Amazon Alexa Notification
    • Asset Notification
    • Email Notifications
    • Google Chat
    • IFTTT Delivery Plugin
    • Python 3.5 Script
      • Example Script
    • Slack Messages
    • Telegram Messages
    • Conditional Forwarding