Add Inovelli Blue Dimmer switch hardware documentation
This commit is contained in:
121
INOVELLI_BLUE_DIMMER_SWITCHES.md
Normal file
121
INOVELLI_BLUE_DIMMER_SWITCHES.md
Normal file
@@ -0,0 +1,121 @@
|
||||
# Inovelli Blue Series Dimmer Switch - Zigbee2MQTT Reference
|
||||
|
||||
This directory contains technical specifications for Inovelli Blue Series Dimmer Switch (VZM31-SN) when used with Zigbee2MQTT, organized by theme for selective context loading.
|
||||
|
||||
## Parameter Categories
|
||||
|
||||
### [Dimming & Ramp Control](inovelli/dimming-and-ramp.md)
|
||||
Properties controlling dimming speeds and ramp rates for both local (physical paddle) and remote (hub/automation) control.
|
||||
- **Properties**: dimmingSpeed*, rampRate*
|
||||
- **Use cases**: Fine-tuning dimming behavior, creating smooth lighting transitions
|
||||
|
||||
### [Brightness Levels](inovelli/brightness-levels.md)
|
||||
Properties defining brightness limits, default levels, and multi-tap brightness targets.
|
||||
- **Properties**: minimumLevel, maximumLevel, defaultLevel*, invertSwitch, brightnessLevelForDoubleTap*
|
||||
- **Use cases**: Setting brightness constraints, configuring default on levels, switch inversion
|
||||
|
||||
### [Power & Energy Monitoring](inovelli/power-monitoring.md)
|
||||
Properties for power measurement, reporting thresholds, and energy monitoring.
|
||||
- **Properties**: power, energy, activePowerReports, activeEnergyReports, periodicPowerAndEnergyReports
|
||||
- **Use cases**: Power consumption tracking, energy usage analytics, reporting intervals
|
||||
|
||||
### [LED Configuration](inovelli/led-configuration.md)
|
||||
Properties controlling LED strip colors and intensity for individual LEDs and global defaults, plus LED effects.
|
||||
- **Properties**: led_effect, individual_led_effect, ledColorWhen*, ledIntensityWhen*, defaultLed*
|
||||
- **Use cases**: LED notifications, status indicators, custom color schemes, animated effects
|
||||
|
||||
### [Switch Configuration](inovelli/switch-config.md)
|
||||
Properties defining switch type, operational modes, and hardware configuration.
|
||||
- **Properties**: switchType, buttonDelay, smartBulbMode, outputMode, powerType, ledBarScaling
|
||||
- **Use cases**: 3-way setup, smart bulb mode, non-neutral wiring, on/off mode
|
||||
|
||||
### [Protection & Safety](inovelli/protection-safety.md)
|
||||
Properties for device protection, temperature monitoring, and access control.
|
||||
- **Properties**: internalTemperature, overheat, localProtection, remoteProtection
|
||||
- **Use cases**: Child locks, overheat protection, disabling physical/remote control
|
||||
|
||||
### [Timers & Automation](inovelli/timers-automation.md)
|
||||
Properties for time-based automation features.
|
||||
- **Properties**: autoTimerOff, loadLevelIndicatorTimeout, doubleTapUpToParam55, doubleTapDownToParam56
|
||||
- **Use cases**: Auto-off timers, LED timeout, double-tap shortcuts
|
||||
|
||||
### [Advanced Features](inovelli/advanced-features.md)
|
||||
Properties for advanced configuration, bindings, and special modes.
|
||||
- **Properties**: fanControlMode, singleTapBehavior, auxSwitchUniqueScenes, bindingOffToOnSyncLevel
|
||||
- **Use cases**: Fan control, scene control, firmware updates, custom behaviors
|
||||
|
||||
## Quick Property Lookup
|
||||
|
||||
| Property | Category |
|
||||
|----------|----------|
|
||||
| dimmingSpeedUpRemote, dimmingSpeedUpLocal | Dimming & Ramp |
|
||||
| dimmingSpeedDownRemote, dimmingSpeedDownLocal | Dimming & Ramp |
|
||||
| rampRateOffToOnRemote, rampRateOffToOnLocal | Dimming & Ramp |
|
||||
| rampRateOnToOffRemote, rampRateOnToOffLocal | Dimming & Ramp |
|
||||
| minimumLevel, maximumLevel | Brightness Levels |
|
||||
| defaultLevelLocal, defaultLevelRemote | Brightness Levels |
|
||||
| invertSwitch, stateAfterPowerRestored | Brightness Levels |
|
||||
| brightnessLevelForDoubleTapUp, brightnessLevelForDoubleTapDown | Brightness Levels |
|
||||
| autoTimerOff | Timers & Automation |
|
||||
| loadLevelIndicatorTimeout | Timers & Automation |
|
||||
| doubleTapUpToParam55, doubleTapDownToParam56 | Timers & Automation |
|
||||
| power, energy | Power Monitoring |
|
||||
| activePowerReports, activeEnergyReports | Power Monitoring |
|
||||
| periodicPowerAndEnergyReports | Power Monitoring |
|
||||
| quickStartTime, quickStartLevel | Power Monitoring |
|
||||
| led_effect, individual_led_effect | LED Configuration |
|
||||
| ledColorWhenOn, ledColorWhenOff | LED Configuration |
|
||||
| ledIntensityWhenOn, ledIntensityWhenOff | LED Configuration |
|
||||
| defaultLed1-7ColorWhenOn/Off | LED Configuration |
|
||||
| defaultLed1-7IntensityWhenOn/Off | LED Configuration |
|
||||
| ledBarScaling, onOffLedMode | LED Configuration |
|
||||
| switchType, buttonDelay | Switch Configuration |
|
||||
| smartBulbMode, outputMode | Switch Configuration |
|
||||
| powerType, dimmingMode, relayClick | Switch Configuration |
|
||||
| higherOutputInNonNeutral | Switch Configuration |
|
||||
| internalTemperature, overheat | Protection & Safety |
|
||||
| localProtection, remoteProtection | Protection & Safety |
|
||||
| fanControlMode, singleTapBehavior | Advanced Features |
|
||||
| auxSwitchUniqueScenes, bindingOffToOnSyncLevel | Advanced Features |
|
||||
| deviceBindNumber, firmwareUpdateInProgressIndicator | Advanced Features |
|
||||
| doubleTapClearNotifications, fanLedLevelType | Advanced Features |
|
||||
|
||||
## Zigbee2MQTT Integration
|
||||
|
||||
These properties are exposed by Zigbee2MQTT and can be accessed in Home Assistant as:
|
||||
- **Entities**: `light.switch_name` (state, brightness)
|
||||
- **Sensors**: `sensor.switch_name_power`, `sensor.switch_name_energy`
|
||||
- **Numbers**: `number.switch_name_dimming_speed_up_remote`, etc.
|
||||
- **Selects**: `select.switch_name_switch_type`, etc.
|
||||
- **Actions**: `mqtt.publish` to set LED effects via `led_effect` and `individual_led_effect`
|
||||
|
||||
## Setting Properties
|
||||
|
||||
Properties can be set via:
|
||||
1. **Home Assistant UI**: Using the exposed number/select entities
|
||||
2. **Services**: Using `number.set_value` or `select.select_option`
|
||||
3. **MQTT**: Publishing directly to `zigbee2mqtt/[device_name]/set`
|
||||
|
||||
Example MQTT publish for LED effect:
|
||||
```yaml
|
||||
service: mqtt.publish
|
||||
data:
|
||||
topic: zigbee2mqtt/bedroom_switch/set
|
||||
payload: '{"led_effect": {"effect": "pulse", "color": 170, "level": 100, "duration": 255}}'
|
||||
```
|
||||
|
||||
## Source
|
||||
|
||||
- Official Inovelli documentation: https://help.inovelli.com/en/articles/8189241-blue-series-dimmer-switch-parameters
|
||||
- Zigbee2MQTT device definition: Model VZM31-SN
|
||||
|
||||
## Usage for LLM Agents
|
||||
|
||||
Each category file contains detailed property specifications including:
|
||||
- Property name as exposed by Zigbee2MQTT
|
||||
- Value range and units
|
||||
- Default value
|
||||
- Detailed description
|
||||
- Usage notes and Home Assistant examples
|
||||
|
||||
Load only the category files relevant to your current task to minimize context usage.
|
||||
Reference in New Issue
Block a user