Plugin Developer Guide

• Plugins
  • Plugins in this version of Flir
  • Installing New Plugins
• Representing Data
• Writing and Using Plugins
  • General Guidance
  • Common Flir 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
• 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 Flir 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 Flir 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 Flir
    • Installing Flir
    • Installing Visual Studio Code
  • Starting the Linux Distribution
    • Starting syslog
    • Starting Nginx
    • Starting Flir
    • Starting Flir 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