Developer documentation

Welcome to the nymea developer documentation. Here you can find information related to the development for nymea.

Overview

The nymea daemon consists of three main modules:

• The nymea server
  • The nymea server namespace
  • The Rule Engine
  • The server classes
  • The Log Engine classes
• The nymea library
  • Types of libnymea
  • The Device Plugin API
  • Hardware resources available for plugins
  • Settings API of nymea
  • Global types of nymea (Type Utils)
  • The CoAP API

Write your own plugin

Here you can find some tutorials for developing and working with nymea:

• Set up the build environment
• Getting started
• The plugin JSON File
• CreateMethods and SetupMethods
• Tutorials

Client developers

• The API description
• Interfaces for DeviceClasses
• Paramtypes and the corresponding UI elements

Quicklinks

Overview of all classes and modules in nymea

• All nymea Classes
• All nymea Modules