signalk-shelly2
v2.0.2
Published
Signal K Plugin For Shelly Gen 2+ devices
Maintainers
Readme
signalk-shelly2
A Signal K plugin for integrating Shelly Gen 2+ smart devices into your Signal K server. This plugin automatically discovers Shelly devices on your network and provides real-time monitoring and control capabilities.
Overview
This plugin supports any Gen 2 or better Shelly device, automatically discovering them via mDNS and connecting via WebSocket for real-time data updates. It maps Shelly device components to appropriate Signal K paths, enabling seamless integration with your marine electronics system.
Features
- Automatic Device Discovery: Uses mDNS to automatically find Shelly devices on your network
- Real-time Updates: WebSocket connection for instant status updates
- Component Mapping: Maps Shelly components to Signal K electrical and environmental paths
- Device Control: Send PUT messages to control switches, lights, and other controllable components
- Reconnection Handling: Automatic reconnection
Supported Shelly Component Types
The plugin does not support specific Shelly devices, instead it supports the following Shelly component types:
Electrical Components
Switch- Basic on/off switches and relays →electrical.switchesLight- Light controllers →electrical.switchesRGB- RGB color lights →electrical.switchesRGBW- RGBW color lights with white channel →electrical.switches
Energy Monitoring
EM- Energy meter →electrical.energymeterEM1- Single-phase energy meter →electrical.energymeterPM1- Power meter →electrical.powermetervoltmeter- Voltage measurement →electrical.voltmeter
Environmental Sensors
Temperature- Temperature sensors →environmentHumidity- Humidity sensors →environmentSmoke- Smoke detectors →environment.smoke
Input/Output
Input- Digital inputs and sensorsDevicepower- Device power and battery status
Confirmed Device Support
Please report any devices you've tested so that I can add to the list. Please open a issue.
- Shelly 1 Gen4 (S4SW-001X16EU)
- Shelly Plus 1 Gen2 (SNSW-001X16EU, SNSW-001X15UL)
- Shelly Plus RGBW Gen2 (SNDC-0D4P10WW)
- Shelly Uni Plus Gen2 (SNSN-0043X)
- Shelly Ogemray Smart relay 25A (S3PB-O3AR000001)
Troubleshooting
If you do not see any data you expect, please open an issue. Turn on debug logging for the plugin, and you'll see a message in the log Initial device status retrieved successfully from... followed by JSON data. Please include that data in your issue.
License
Apache-2.0
Contributing
Contributions are welcome! Please feel free to submit issues and pull requests.
Author
Scott Bender ([email protected])
