Integrations

Integration plugins connect nymea to external hardware devices and online services. Each plugin translates between nymea’s internal thing API and the device- or service-specific protocol.

• Getting started
  • Basic concepts
  • IDs and names
  • The plugin JSON file
  • The plugin code
  • Testing the plugin
• Creating a new plugin
  • QtCreator wizard (C++/Qt only)
  • Manual project creation
• Thing classes
  • Parameters
  • Settings
  • Setup
  • Events
  • Actions
  • States
  • Interfaces
  • Generic inputs and outputs
  • Browsing
• Things setup
  • Thing creation
  • User
  • Discovery
  • Automatic
  • Thing setup
  • JustAdd
  • Username and password
  • Display PIN
  • Enter PIN
  • Push button
  • OAuth
  • Examples
  • Create method “User” - setup method “JustAdd”
  • Create method “User” - setup method “UserAndPassword”
  • Create method “Discovery” - setup method “JustAdd”
  • Create method “User” - setup method “PushButton”
  • Create method “Auto” - setup method “JustAdd”
  • Create method “Discovery” - setup method “DisplayPin”
  • Create method “User” - setup method “OAuth”
  • Parent child relationships
  • System restarts
• The plugin code
  • A word on the environment
  • Introduction
  • IDs and names
  • Setup
  • Settings
  • Actions
  • Events
  • States
  • Discovery
  • Pairing
  • Username and Password authentication
  • Push button authentication
  • OAuth
  • DisplayPin
  • Browsing
• The plugin JSON file
  • Identification properties
  • Type properties
  • Type
  • Unit
  • Input type
  • Parameters
  • Plugin information
  • Vendor information
  • Thing classes
  • Create methods
  • Setup method
  • Events
  • Actions
  • States
  • Browsing
• Interfaces
• Building & testing
  • Building C++/Qt plugins
  • Using QtCreator
  • Manual compilation
  • Building Python plugins
  • Validating the JSON file
  • Building JS plugins
  • Loading the plugin in nymea
  • Debug categories
  • Troubleshooting
• Submitting your plugin
  • License
  • Metadata