matterbridge-roborock-vacuum-plugin/dist/behaviors/roborock.vacuum/core/deviceCapabilityRegistry.js

Matterbridge Roborock Vacuum Plugin

import { DeviceModel } from '../../../roborockCommunication/models/index.js';
import { baseCleanModeConfigs, CleanModeDisplayLabel, smartPlanModeConfig, vacAndMopDeepModeConfig, vacFollowedByMopModeConfig, } from './cleanModeConfig.js';
/**
 * Registry mapping device models to their extra clean mode capabilities.
 *
 * === HOW TO ADD SUPPORT FOR YOUR DEVICE ===
 * Add a new entry with the device model and the list of extra modes it supports.
 * Example (device that only has VacFollowedByMop):
 *   [DeviceModel.MY_NEW_DEVICE]: [vacFollowedByMopModeConfig],
 *
 * === HOW TO ADD A NEW CLEAN MODE ===
 * 1. Add the label to CleanModeDisplayLabel in cleanModeConfig.ts
 * 2. Add the mode entry in CleanModeLabelInfo in cleanModeConfig.ts
 * 3. Create a new CleanModeConfig const in cleanModeConfig.ts and export it
 * 4. If the mode needs special handling, add a new handler in handlers/
 * 5. Register the handler in buildBehaviorConfig() in behaviorConfig.ts
 * 6. Add the mode to the relevant device entries below
 */
export const DEVICE_EXTRA_MODES = {
    [DeviceModel.QREVO_EDGE_5V1]: [smartPlanModeConfig, vacFollowedByMopModeConfig],
    [DeviceModel.QREVO_PLUS]: [smartPlanModeConfig, vacFollowedByMopModeConfig],
    [DeviceModel.QREVO_MAXV]: [smartPlanModeConfig, vacFollowedByMopModeConfig],
    [DeviceModel.Q10_S5_PLUS]: [vacFollowedByMopModeConfig, vacAndMopDeepModeConfig],
};
/**
 * Get the extra clean modes for a device beyond the base modes.
 * Returns an empty array if the device has no extra modes.
 */
export function getExtraModes(model) {
    return DEVICE_EXTRA_MODES[model] ?? [];
}
/**
 * Check if a device supports the Smart Plan clean mode.
 */
export function hasSmartPlan(model) {
    return getExtraModes(model).some((c) => c.label === CleanModeDisplayLabel.SmartPlan);
}
/**
 * Get all clean modes for a device: extra modes first, then base modes.
 */
export function getAllModesForDevice(model) {
    return [...getExtraModes(model), ...baseCleanModeConfigs];
}
/**
 * Get all known clean mode configs across all devices and base modes (deduped by mode number).
 * Useful for mode label lookups when the device model is not available.
 */
export function getAllKnownModeConfigs() {
    const allExtra = Object.values(DEVICE_EXTRA_MODES).flat();
    const uniqueByMode = new Map();
    for (const config of [...allExtra, ...baseCleanModeConfigs]) {
        if (!uniqueByMode.has(config.mode)) {
            uniqueByMode.set(config.mode, config);
        }
    }
    return [...uniqueByMode.values()];
}
//# sourceMappingURL=deviceCapabilityRegistry.js.map