mirror of https://github.com/Hypfer/Valetudo.git
56 lines
1.3 KiB
JavaScript
56 lines
1.3 KiB
JavaScript
const Capability = require("./Capability");
|
|
const NotImplementedError = require("../NotImplementedError");
|
|
|
|
/**
|
|
* @template {import("../ValetudoRobot")} T
|
|
* @extends Capability<T>
|
|
*/
|
|
class ZoneCleaningCapability extends Capability {
|
|
/**
|
|
* @abstract
|
|
* @param {object} options
|
|
* @param {Array<import("../../entities/core/ValetudoZone")>} options.zones
|
|
* @param {number} [options.iterations]
|
|
* @returns {Promise<void>}
|
|
*/
|
|
async start(options) {
|
|
throw new NotImplementedError();
|
|
}
|
|
|
|
/**
|
|
* @returns {ZoneCleaningCapabilityProperties}
|
|
*/
|
|
getProperties() {
|
|
return {
|
|
zoneCount: {
|
|
min: 1,
|
|
max: 1
|
|
},
|
|
iterationCount: {
|
|
min: 1,
|
|
max: 1
|
|
}
|
|
};
|
|
}
|
|
|
|
getType() {
|
|
return ZoneCleaningCapability.TYPE;
|
|
}
|
|
}
|
|
|
|
ZoneCleaningCapability.TYPE = "ZoneCleaningCapability";
|
|
|
|
module.exports = ZoneCleaningCapability;
|
|
|
|
/**
|
|
* @typedef {object} ZoneCleaningCapabilityProperties
|
|
*
|
|
* @property {object} zoneCount
|
|
* @property {number} zoneCount.min
|
|
* @property {number} zoneCount.max
|
|
*
|
|
* @property {object} iterationCount
|
|
* @property {number} iterationCount.min
|
|
* @property {number} iterationCount.max
|
|
*/
|