nymea documentation

Welcome to the nymea documentation.

Overview

• Overview
  • About nymea
  • Contribute
  • Features
  • License
  • nymea in action

Users

• Installation
  • nymea:core
  • nymea:app
  • Getting started
• Usage
  • First steps
  • Connecting things
  • Configuration
  • Smart rules
  • Scripting
  • Advanced configuration
• Advanced usage
  • Publishing sensor values to nymea via MQTT

Developers

• Build environment
  • Currently supported versions
  • Import the repository key
  • Repository setup
• Environment variables
  • Runtime configuration
  • Integration plugins
  • Platform plugins
  • API keys plugins
  • Experience plugins
  • Z-Wave
  • Other
• Building nymea
  • Development workspace
  • Building natively
  • nymea-zigbee
  • nymea-gpio
  • libnymea-networkmanager
  • nymea-networkmanager
  • nymea-remoteproxy
  • nymea-mqtt
  • nymea
  • nymea-plugins
  • Cross-compiling
  • Installation
  • Setup
  • Building
  • Cleaning the build
  • Build output
  • Login into container
  • Cache
  • Delete the container
  • Deploy on target machine
  • Interacting with the containers
  • Building with Yocto
  • Example: build a QEMU/KVM image
• Developing with QtCreator
  • General steps for all nymea projects
  • Project specific options
  • Nymea
  • Nymea integration plugins
• Plugin development
  • Integration plugins
  • Platform plugins
  • Experience plugins
  • Update plugins
• Client development
  • JSON-RPC API
  • C++/Qt/QML
  • Command-line client
• Integrations
  • Getting started
  • Creating a new plugin
  • Thing classes
  • Things setup
  • The plugin code
  • The plugin JSON file
  • Interfaces
  • Building & testing
  • Submitting your plugin

Resources

• Resources
  • API Reference
    • Objects
    • Enums
    • Flags
    • Methods
    • Notifications
  • Interfaces
    • accesscontrol
    • account
    • alarm
    • alert
    • awning
    • barcodescanner
    • battery
    • blind
    • button
    • childlock
    • cleaningrobot
    • closable
    • closablesensor
    • co2sensor
    • colorlight
    • colortemperaturelight
    • conductivitysensor
    • connectable
    • cooling
    • cosensor
    • daylightsensor
    • dimmablelight
    • doorbell
    • electricvehicle
    • electricvehiclehlc
    • energymeter
    • energystorage
    • evcharger
    • evchargerac
    • evchargerdc
    • extendedawning
    • extendedblind
    • extendedclosable
    • extendedenergystorage
    • extendednavigationpad
    • extendedshutter
    • extendedsmartmeterproducer
    • extendedstatefulgaragedoor
    • fingerprintreader
    • firesensor
    • garagedoor
    • garagegate
    • gassensor
    • gateway
    • heating
    • heatpump
    • hlccharger
    • humiditysensor
    • impulsegaragedoor
    • inputtrigger
    • irrigation
    • light
    • lightsensor
    • longpressbutton
    • longpressmultibutton
    • media
    • mediacontroller
    • mediametadataprovider
    • mediaplayer
    • moisturesensor
    • multibutton
    • navigationpad
    • networkdevice
    • no2sensor
    • noisesensor
    • notifications
    • o2sensor
    • o3sensor
    • orpsensor
    • outputtrigger
    • phsensor
    • pm10sensor
    • pm25sensor
    • power
    • powerflowcontroller
    • powersocket
    • powerswitch
    • presencesensor
    • pressuresensor
    • sensor
    • shutter
    • simplebutton
    • simpleclosable
    • simplegaragedoor
    • simpleheatpump
    • simplemultibutton
    • smartgridheatpump
    • smartlock
    • smartmeter
    • smartmeterconsumer
    • smartmeterproducer
    • solarinverter
    • statefulgaragedoor
    • system
    • temperaturesensor
    • thermostat
    • update
    • useraccesscontrol
    • valve
    • venetianblind
    • ventilation
    • vibrationsensor
    • vocsensor
    • volumecontroller
    • waterlevelsensor
    • watersensor
    • weather
    • windspeedsensor
    • wirelessconnectable
  • Integrations
    • Integration Categories
    • Air Quality Index
    • alpha innotec
    • Amperfied
    • Anel
    • Avahi
    • aWATTar
    • B+G E-Tech
    • Bestel
    • Bimmerconnected
    • BluOS
    • Bose
    • Bosswerk
    • CoinMarketCap
    • Command Launcher
    • Daikin Airco
    • Date and Time
    • Daylight Sensor
    • Denon
    • DoorBird
    • Drexel und Weiss
    • dweet.io
    • Dynatrace
    • Easeex
    • Elgato
    • eQ-3
    • ESPSOmfy-RTS
    • EVBox
    • EVerest
    • fast.com
    • Flower Care
    • Fronius
    • Garadget
    • go-eCharger
    • GPIO
    • Home Connect
    • HTTP Commander
    • Huawei FusionSolar
    • iDM
    • inepro Metering
    • INRO
    • I²C devices
    • Keba
    • KNX
    • Kodi
    • KOSTAL Solar Electric
    • LG Smart TV
    • LIFX
    • Logilink
    • Mail Notification
    • MCP3008
    • mecElectronics
    • MENNEKES
    • Meross
    • Modbus Commander
    • MQTT client
    • my-PV
    • myStrom
    • Nanoleaf
    • Neato Botvac
    • Netatmo
    • Network Detector
    • Notify.Events
    • Nuki
    • One-Wire
    • OpenUV
    • OpenWeatherMap
    • OSDomotics
    • PC Electric
    • Philips Hue
    • PhoenixConnect
    • powerfox
    • Pushbullet
    • Remote SSH
    • Schrack
    • Senic
    • Senseair
    • Serial Port Commander
    • SG-Ready
    • Shelly
    • Simple heat pump
    • SMA
    • Solar-Log
    • SolaX Power Inverter
    • Somfy Tahoma
    • Sonos
    • spot-hinta
    • Stiebel Eltron
    • Sungrow Inverter
    • Sunposition
    • SunSpec
    • System Monitor
    • Tado
    • Tasmota
    • TCP Commander
    • Telegram
    • Tempo
    • Texas Instruments
    • Tmate
    • TP-Link Kasa
    • Tuya
    • UDP Commander
    • UniFi
    • UniPi
    • USB Relay
    • USB-RLY82
    • Wake-On-LAN
    • Wattsonic
    • webasto
    • WeMo
    • Where the ISS at
    • WS2812FX
    • Yamaha AV receiver
    • Z-Wave Fibaro
    • Z-Wave Generic
    • Z-Wave Qubino
    • Z-Wave Springs Window Fashions (Graber)
    • ZigBee Develco
    • ZigBee Eurotronic
    • ZigBee Generic
    • ZigBee Generic
    • ZigBee Gewiss
    • ZigBee Jung
    • ZigBee Lumi / Aqara / Xiaomi Mi
    • ZigBee Philips Hue
    • ZigBee SchneiderElectric
    • ZigBee TRÅDFRI
    • ZigBee Tuya

Company

• History
• Imprint