nymea Integration for Home Assistant

Overview

The nymea integration allows you to connect your nymea:core system (including Maveo devices) to Home Assistant. This integration enables you to control and monitor nymea-compatible smart home devices directly from Home Assistant.

Supported Devices

• Maveo Stick: Garage door opener with open/close control and status monitoring
• Maveo Sensor: Temperature and humidity sensor
• Aqara Weather Sensor: Temperature, humidity, and atmospheric pressure sensor (via nymea:core)

Features

• Automatic Discovery: Devices are automatically discovered via Zeroconf/mDNS
• Push Notifications: Real-time status updates via WebSocket (no polling)
• Secure Pairing: Push-button authentication for secure device pairing
• Multiple Sensors: Support for temperature, humidity, pressure, battery, and signal strength sensors
• Garage Door Control: Full garage door control with opening/closing status

Installation

HACS (Recommended)

1. Open HACS in Home Assistant
2. Click on "Integrations"
3. Click the three dots in the top right corner and select "Custom repositories"
4. Add this repository URL: https://github.com/Mattes83/nymea
5. Select "Integration" as the category
6. Click "Add"
7. Find "nymea" in the integration list and click "Install"
8. Restart Home Assistant

Manual Installation

1. Download the nymea folder from this repository
2. Copy it to your Home Assistant's custom_components directory:

   <config_directory>/custom_components/nymea/
   

3. Restart Home Assistant

Setup

Prerequisites

• A running nymea:core system (e.g., Maveo Box)
• Network connectivity between Home Assistant and your nymea device
• Physical access to your nymea device for push-button pairing

Configuration

Automatic Discovery (Recommended)

1. Ensure your nymea device is on the same network as Home Assistant
2. Go to Settings → Devices & Services
3. Home Assistant should automatically discover your nymea device
4. Click Configure on the discovered device
5. Click Submit to proceed to pairing
6. Within 30 seconds, press the yellow button on the back of your Maveo Box
7. The device will be added to Home Assistant

Manual Setup

If automatic discovery doesn't work:

1. Go to Settings → Devices & Services
2. Click the + Add Integration button
3. Search for "nymea"
4. Enter your nymea device details:
   • Host: IP address or hostname of your nymea device (e.g., 192.168.2.179)
   • Port: JSON-RPC port (default: 2222)
   • WebSocket Port: WebSocket notification port (default: 4444)
5. Click Submit
6. Within 30 seconds, press the yellow button on the back of your Maveo Box
7. The device will be added to Home Assistant

Configuration Parameters

Parameter	Description	Default	Required
Host	IP address or hostname of nymea device	-	Yes
Port	JSON-RPC TCP port for commands	2222	Yes
WebSocket Port	WebSocket port for notifications	4444	Yes

Entities

Once configured, the integration will create entities for all connected devices:

Cover Entities

• Garage Door (cover.maveo_stick): Control and monitor garage door state

Sensor Entities

Maveo Sensor:

• Temperature (°C)
• Humidity (%)

Aqara Weather Sensor:

• Temperature (°C)
• Humidity (%)
• Atmospheric Pressure (hPa)
• Battery Level (%)
• Signal Strength (%)

Maveo Stick:

• State (enum)

Binary Sensor Entities

Maveo Stick:

• Door Movement
• Maintenance Required
• Firmware Update Available
• Intruder Detected
• Connected Status
• Opened Status
• Light Status

Troubleshooting

Device Not Discovered

• Ensure your nymea device and Home Assistant are on the same network
• Check that mDNS/Zeroconf is enabled on your network (some routers block this)
• Try manual setup instead

Cannot Connect Error

• Verify the IP address and ports are correct
• Check that the nymea:core service is running on your device
• Ensure no firewall is blocking ports 2222 (JSON-RPC) and 4444 (WebSocket)
• Try pinging the device from Home Assistant: ping <device-ip>

Pairing Fails

• Ensure you press the yellow button within 30 seconds after clicking Submit
• Verify push-button authentication is enabled on your nymea device
• Try restarting the nymea:core service and attempt pairing again

Entities Not Updating

• Check the Home Assistant logs for connection errors
• Verify the WebSocket connection (port 4444) is not being blocked
• Restart the integration from Settings → Devices & Services → nymea

Viewing Logs

To enable debug logging for troubleshooting:

1. Add to your configuration.yaml:

   logger:
     default: info
     logs:
       custom_components.nymea: debug

2. Restart Home Assistant
3. Check logs in Settings → System → Logs

Removal

To remove the nymea integration:

1. Go to Settings → Devices & Services
2. Find the nymea integration
3. Click the three dots menu
4. Select Delete
5. Confirm the removal

All entities and devices will be removed from Home Assistant. This does not affect your nymea device configuration.

Support & Contribution

• Issues: Report bugs or request features on GitHub Issues
• Discussions: Ask questions in the Home Assistant Community Forum

License

This project is licensed under the MIT License.

Credits

• Based on the nymea:core project
• Integration template from Home Assistant developers
• nymea API implementation inspired by nymea-cli