Valetudo/backend/lib/robots/dreame/DreameUtils.js

const Logger = require("../../Logger");

const UINT8_MASK = 0b00000000000000000000000011111111;

/**
 * Dreame stores all three configurables of their mop docks in a single PIID as one int
 * This int consists of three ints like so (represented here as an 32 bit int because js bitwise operations use those):
 *
 * XXXXXXXXWWWWWWWWPPPPPPPPOOOOOOOO
 *
 * where
 * - X is nothing
 * - W is the water grade (wetness of the mop pads)
 * - P is the pad cleaning frequency (apparently in m² plus 0 for "after each segment")
 * - O is the operation mode (mop, vacuum & mop, vacuum)
 *
 */

class DreameUtils {
    /**
     *
     * @param {number} input
     * @return {MOP_DOCK_SETTINGS}
     */
    static DESERIALIZE_MOP_DOCK_SETTINGS(input) {
        return {
            operationMode: input >>> 0 & UINT8_MASK,
            padCleaningFrequency: input >>> 8 & UINT8_MASK,
            waterGrade: input >>> 16 & UINT8_MASK
        };
    }

    /**
     *
     * @param {MOP_DOCK_SETTINGS} settings
     * @return {number}
     */
    static SERIALIZE_MOP_DOCK_SETTINGS(settings) {
        let result = 0 >>> 0;

        result |= (settings.waterGrade & UINT8_MASK);
        result <<= 8;

        result |= (settings.padCleaningFrequency & UINT8_MASK);
        result <<= 8;

        result |= (settings.operationMode & UINT8_MASK);

        return result;
    }

    /**
     * 
     * @param {string} str
     * @return {MISC_TUNABLES}
     */
    static DESERIALIZE_MISC_TUNABLES(str) {
        let arr = [];
        try {
            arr = JSON.parse(str);

            if (!Array.isArray(arr)) {
                Logger.warn("Deserialized dreame misc tunables are not an array");

                arr = [];
            }
        } catch (e) {
            Logger.warn("Failed to deserialize dreame misc tunables.");
        }

        const result = {};

        arr.forEach(elem => {
            result[elem.k] = elem.v;
        });

        return result;
    }

    /**
     *
     * @param {MISC_TUNABLES} obj
     * @return {string}
     */
    static SERIALIZE_MISC_TUNABLES_SINGLE_TUNABLE(obj) {
        const arr = [];

        Object.entries(obj).forEach(([k, v]) => {
            arr.push({k: k, v: v});
        });

        return JSON.stringify(arr[0]);
    }

    /**
     * 
     * @param {number} input
     * @return {AI_SETTINGS}
     */
    static DESERIALIZE_AI_SETTINGS(input) {
        return {
            obstacleDetection: !!(input & 0b00000010),
            obstacleImages: !!(input & 0b00000100),
            petObstacleDetection: !!(input & 0b00010000),
        };
    }

    /**
     * @param {AI_SETTINGS} input
     * @return {number}
     */
    static SERIALIZE_AI_SETTINGS(input) {
        let serializedValue = 0;

        serializedValue |= input.obstacleDetection ? 0b00000010 : 0;
        serializedValue |= input.obstacleImages ? 0b00000100 : 0;
        serializedValue |= input.petObstacleDetection ? 0b00010000 : 0;

        return serializedValue;
    }
}

/**
 * @typedef {object} AI_SETTINGS
 * @property {boolean} obstacleDetection
 * @property {boolean} petObstacleDetection
 * @property {boolean} obstacleImages
 */

/**
 * @typedef {object} MOP_DOCK_SETTINGS
 * @property {number} padCleaningFrequency
 * @property {number} operationMode
 * @property {number} waterGrade
 */

/**
 * @typedef {object} MISC_TUNABLES
 *
 * @property {number} [AutoDry]
 * @property {number} [CleanType]
 * @property {number} [FillinLight]
 * @property {number} [FluctuationConfirmResult]
 * @property {number} [FluctuationTestResult]
 * @property {number} [HotWash]
 * @property {number} [LessColl] 
 * @property {number} [MaterialDirectionClean]
 * @property {number} [MeticulousTwist]
 * @property {number} [MonitorHumanFollow]
 * @property {number} [MopScalable]
 * @property {number} [PetPartClean]
 * @property {number} [SmartAutoMop]
 * @property {number} [SmartAutoWash]
 * @property {number} [SmartCharge]
 * @property {number} [SmartDrying]
 * @property {number} [SmartHost]
 * @property {number} [StainIdentify]
 * @property {number} [SuctionMax]
 * @property {number} [LacuneMopScalable]
 * @property {number} [MopScalable2]
 * @property {number} [CarpetFineClean]
 * @property {number} [SbrushExtrSwitch]
 * @property {number} [MopExtrSwitch]
 * @property {number} [ExtrFreq]
 * 
 */

module.exports = DreameUtils;