From 5d405842d2bcda8ae51afe95c4e77aac7e21e232 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Beye?= Date: Sat, 6 Sep 2025 15:28:40 +0200 Subject: [PATCH] refactor(MockRobot): Smurf for consistency --- .../robots/mock/{MockRobot.js => MockValetudoRobot.js} | 8 ++++---- ...MockAutoEmptyDockAutoEmptyIntervalControlCapability.js | 4 ++-- .../MockAutoEmptyDockManualTriggerCapability.js | 2 +- .../mock/capabilities/MockBasicControlCapability.js | 4 ++-- .../mock/capabilities/MockCarpetModeControlCapability.js | 4 ++-- .../capabilities/MockCarpetSensorModeControlCapability.js | 4 ++-- .../MockCollisionAvoidantNavigationControlCapability.js | 4 ++-- .../capabilities/MockConsumableMonitoringCapability.js | 4 ++-- .../mock/capabilities/MockCurrentStatisticsCapability.js | 4 ++-- .../mock/capabilities/MockDoNotDisturbCapability.js | 4 ++-- .../mock/capabilities/MockFanSpeedControlCapability.js | 4 ++-- .../mock/capabilities/MockGoToLocationCapability.js | 2 +- .../lib/robots/mock/capabilities/MockKeyLockCapability.js | 4 ++-- .../lib/robots/mock/capabilities/MockLocateCapability.js | 2 +- .../mock/capabilities/MockManualControlCapability.js | 4 ++-- .../robots/mock/capabilities/MockMapResetCapability.js | 2 +- .../mock/capabilities/MockMapSegmentationCapability.js | 2 +- .../robots/mock/capabilities/MockMappingPassCapability.js | 2 +- .../MockMopDockCleanManualTriggerCapability.js | 2 +- .../capabilities/MockMopDockDryManualTriggerCapability.js | 2 +- .../MockObstacleAvoidanceControlCapability.js | 4 ++-- .../capabilities/MockOperationModeControlCapability.js | 4 ++-- .../MockPendingMapChangeHandlingCapability.js | 2 +- .../capabilities/MockPersistentMapControlCapability.js | 4 ++-- .../MockPetObstacleAvoidanceControlCapability.js | 4 ++-- .../robots/mock/capabilities/MockSpeakerTestCapability.js | 2 +- .../capabilities/MockSpeakerVolumeControlCapability.js | 4 ++-- .../mock/capabilities/MockTotalStatisticsCapability.js | 2 +- .../capabilities/MockVoicePackManagementCapability.js | 4 ++-- .../mock/capabilities/MockWaterUsageControlCapability.js | 4 ++-- .../mock/capabilities/MockWifiConfigurationCapability.js | 4 ++-- .../robots/mock/capabilities/MockWifiScanCapability.js | 2 +- .../mock/capabilities/MockZoneCleaningCapability.js | 2 +- backend/lib/robots/mock/index.js | 2 +- .../_pages/development/building-and-modifying-valetudo.md | 2 +- frontend/readme.md | 2 +- util/generate_mqtt_docs.js | 4 ++-- 37 files changed, 60 insertions(+), 60 deletions(-) rename backend/lib/robots/mock/{MockRobot.js => MockValetudoRobot.js} (97%) diff --git a/backend/lib/robots/mock/MockRobot.js b/backend/lib/robots/mock/MockValetudoRobot.js similarity index 97% rename from backend/lib/robots/mock/MockRobot.js rename to backend/lib/robots/mock/MockValetudoRobot.js index 458e1d4f..e2041dae 100644 --- a/backend/lib/robots/mock/MockRobot.js +++ b/backend/lib/robots/mock/MockValetudoRobot.js @@ -9,7 +9,7 @@ const ValetudoRobot = require("../../core/ValetudoRobot"); const { MapLayer, PointMapEntity, ValetudoMap } = require("../../entities/map"); const stateAttrs = entities.state.attributes; -class MockRobot extends ValetudoRobot { +class MockValetudoRobot extends ValetudoRobot { /** * * @param {object} options @@ -71,7 +71,7 @@ class MockRobot extends ValetudoRobot { } getModelName() { - return "MockRobot"; + return "MockValetudoRobot"; } getModelDetails() { @@ -94,7 +94,7 @@ class MockRobot extends ValetudoRobot { getProperties() { const superProps = super.getProperties(); const ourProps = { - [MockRobot.WELL_KNOWN_PROPERTIES.FIRMWARE_VERSION]: Tools.GET_VALETUDO_VERSION() + [MockValetudoRobot.WELL_KNOWN_PROPERTIES.FIRMWARE_VERSION]: Tools.GET_VALETUDO_VERSION() }; return Object.assign( @@ -210,4 +210,4 @@ class MockRobot extends ValetudoRobot { } } -module.exports = MockRobot; +module.exports = MockValetudoRobot; diff --git a/backend/lib/robots/mock/capabilities/MockAutoEmptyDockAutoEmptyIntervalControlCapability.js b/backend/lib/robots/mock/capabilities/MockAutoEmptyDockAutoEmptyIntervalControlCapability.js index 4e959773..08e2b96b 100644 --- a/backend/lib/robots/mock/capabilities/MockAutoEmptyDockAutoEmptyIntervalControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockAutoEmptyDockAutoEmptyIntervalControlCapability.js @@ -1,12 +1,12 @@ const AutoEmptyDockAutoEmptyIntervalControlCapability = require("../../../core/capabilities/AutoEmptyDockAutoEmptyIntervalControlCapability"); /** - * @extends AutoEmptyDockAutoEmptyIntervalControlCapability + * @extends AutoEmptyDockAutoEmptyIntervalControlCapability */ class MockAutoEmptyDockAutoEmptyIntervalControlCapability extends AutoEmptyDockAutoEmptyIntervalControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockAutoEmptyDockManualTriggerCapability.js b/backend/lib/robots/mock/capabilities/MockAutoEmptyDockManualTriggerCapability.js index 5ae51421..4aec6711 100644 --- a/backend/lib/robots/mock/capabilities/MockAutoEmptyDockManualTriggerCapability.js +++ b/backend/lib/robots/mock/capabilities/MockAutoEmptyDockManualTriggerCapability.js @@ -2,7 +2,7 @@ const AutoEmptyDockManualTriggerCapability = require("../../../core/capabilities const Logger = require("../../../Logger"); /** - * @extends AutoEmptyDockManualTriggerCapability + * @extends AutoEmptyDockManualTriggerCapability */ class MockAutoEmptyDockManualTriggerCapability extends AutoEmptyDockManualTriggerCapability { /** diff --git a/backend/lib/robots/mock/capabilities/MockBasicControlCapability.js b/backend/lib/robots/mock/capabilities/MockBasicControlCapability.js index 1ba19a59..fc4bdf8a 100644 --- a/backend/lib/robots/mock/capabilities/MockBasicControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockBasicControlCapability.js @@ -3,12 +3,12 @@ const entities = require("../../../entities"); const stateAttrs = entities.state.attributes; /** - * @extends BasicControlCapability + * @extends BasicControlCapability */ class MockBasicControlCapability extends BasicControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockCarpetModeControlCapability.js b/backend/lib/robots/mock/capabilities/MockCarpetModeControlCapability.js index db136673..36df288e 100644 --- a/backend/lib/robots/mock/capabilities/MockCarpetModeControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockCarpetModeControlCapability.js @@ -1,12 +1,12 @@ const CarpetModeControlCapability = require("../../../core/capabilities/CarpetModeControlCapability"); /** - * @extends CarpetModeControlCapability + * @extends CarpetModeControlCapability */ class MockCarpetModeControlCapability extends CarpetModeControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockCarpetSensorModeControlCapability.js b/backend/lib/robots/mock/capabilities/MockCarpetSensorModeControlCapability.js index 38334299..046b4912 100644 --- a/backend/lib/robots/mock/capabilities/MockCarpetSensorModeControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockCarpetSensorModeControlCapability.js @@ -1,13 +1,13 @@ const CarpetSensorModeControlCapability = require("../../../core/capabilities/CarpetSensorModeControlCapability"); /** - * @extends CarpetSensorModeControlCapability + * @extends CarpetSensorModeControlCapability */ class MockCarpetSensorModeControlCapability extends CarpetSensorModeControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockCollisionAvoidantNavigationControlCapability.js b/backend/lib/robots/mock/capabilities/MockCollisionAvoidantNavigationControlCapability.js index 4bc1a052..8daa39c6 100644 --- a/backend/lib/robots/mock/capabilities/MockCollisionAvoidantNavigationControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockCollisionAvoidantNavigationControlCapability.js @@ -1,12 +1,12 @@ const CollisionAvoidantNavigationControlCapability = require("../../../core/capabilities/CollisionAvoidantNavigationControlCapability"); /** - * @extends CollisionAvoidantNavigationControlCapability + * @extends CollisionAvoidantNavigationControlCapability */ class MockCollisionAvoidantNavigationControlCapability extends CollisionAvoidantNavigationControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockConsumableMonitoringCapability.js b/backend/lib/robots/mock/capabilities/MockConsumableMonitoringCapability.js index 55f13d14..166f74dc 100644 --- a/backend/lib/robots/mock/capabilities/MockConsumableMonitoringCapability.js +++ b/backend/lib/robots/mock/capabilities/MockConsumableMonitoringCapability.js @@ -32,12 +32,12 @@ const MOCKED_CONSUMABLES = Object.freeze([ ]); /** - * @extends ConsumableMonitoringCapability + * @extends ConsumableMonitoringCapability */ class MockConsumableMonitoringCapability extends ConsumableMonitoringCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockCurrentStatisticsCapability.js b/backend/lib/robots/mock/capabilities/MockCurrentStatisticsCapability.js index d64ef18a..9429ed66 100644 --- a/backend/lib/robots/mock/capabilities/MockCurrentStatisticsCapability.js +++ b/backend/lib/robots/mock/capabilities/MockCurrentStatisticsCapability.js @@ -2,12 +2,12 @@ const CurrentStatisticsCapability = require("../../../core/capabilities/CurrentS const ValetudoDataPoint = require("../../../entities/core/ValetudoDataPoint"); /** - * @extends CurrentStatisticsCapability + * @extends CurrentStatisticsCapability */ class MockCurrentStatisticsCapability extends CurrentStatisticsCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockDoNotDisturbCapability.js b/backend/lib/robots/mock/capabilities/MockDoNotDisturbCapability.js index b3e50daf..2ffed5e1 100644 --- a/backend/lib/robots/mock/capabilities/MockDoNotDisturbCapability.js +++ b/backend/lib/robots/mock/capabilities/MockDoNotDisturbCapability.js @@ -2,12 +2,12 @@ const DoNotDisturbCapability = require("../../../core/capabilities/DoNotDisturbC const ValetudoDNDConfiguration = require("../../../entities/core/ValetudoDNDConfiguration"); /** - * @extends DoNotDisturbCapability + * @extends DoNotDisturbCapability */ class MockDoNotDisturbCapability extends DoNotDisturbCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockFanSpeedControlCapability.js b/backend/lib/robots/mock/capabilities/MockFanSpeedControlCapability.js index becaac50..9826d546 100644 --- a/backend/lib/robots/mock/capabilities/MockFanSpeedControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockFanSpeedControlCapability.js @@ -4,12 +4,12 @@ const ValetudoSelectionPreset = require("../../../entities/core/ValetudoSelectio const stateAttrs = entities.state.attributes; /** - * @extends FanSpeedControlCapability + * @extends FanSpeedControlCapability */ class MockFanSpeedControlCapability extends FanSpeedControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { let presets = [ diff --git a/backend/lib/robots/mock/capabilities/MockGoToLocationCapability.js b/backend/lib/robots/mock/capabilities/MockGoToLocationCapability.js index b8ee56b8..ddf045c3 100644 --- a/backend/lib/robots/mock/capabilities/MockGoToLocationCapability.js +++ b/backend/lib/robots/mock/capabilities/MockGoToLocationCapability.js @@ -3,7 +3,7 @@ const PathMapEntity = require("../../../entities/map/PathMapEntity"); const PointMapEntity = require("../../../entities/map/PointMapEntity"); /** - * @extends GoToLocationCapability + * @extends GoToLocationCapability */ class MockGoToLocationCapability extends GoToLocationCapability { /** diff --git a/backend/lib/robots/mock/capabilities/MockKeyLockCapability.js b/backend/lib/robots/mock/capabilities/MockKeyLockCapability.js index bc6793ee..4b95ba37 100644 --- a/backend/lib/robots/mock/capabilities/MockKeyLockCapability.js +++ b/backend/lib/robots/mock/capabilities/MockKeyLockCapability.js @@ -1,12 +1,12 @@ const KeyLockCapability = require("../../../core/capabilities/KeyLockCapability"); /** - * @extends KeyLockCapability + * @extends KeyLockCapability */ class MockKeyLockCapability extends KeyLockCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockLocateCapability.js b/backend/lib/robots/mock/capabilities/MockLocateCapability.js index b216974d..c7526362 100644 --- a/backend/lib/robots/mock/capabilities/MockLocateCapability.js +++ b/backend/lib/robots/mock/capabilities/MockLocateCapability.js @@ -2,7 +2,7 @@ const LocateCapability = require("../../../core/capabilities/LocateCapability"); const Logger = require("../../../Logger"); /** - * @extends LocateCapability + * @extends LocateCapability */ class MockLocateCapability extends LocateCapability { /** diff --git a/backend/lib/robots/mock/capabilities/MockManualControlCapability.js b/backend/lib/robots/mock/capabilities/MockManualControlCapability.js index faa98516..a54b7492 100644 --- a/backend/lib/robots/mock/capabilities/MockManualControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockManualControlCapability.js @@ -2,12 +2,12 @@ const ManualControlCapability = require("../../../core/capabilities/ManualContro const PointMapEntity = require("../../../entities/map/PointMapEntity"); /** - * @extends ManualControlCapability + * @extends ManualControlCapability */ class MockManualControlCapability extends ManualControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot * @class */ constructor(options) { diff --git a/backend/lib/robots/mock/capabilities/MockMapResetCapability.js b/backend/lib/robots/mock/capabilities/MockMapResetCapability.js index c57bb5d3..633d7e3d 100644 --- a/backend/lib/robots/mock/capabilities/MockMapResetCapability.js +++ b/backend/lib/robots/mock/capabilities/MockMapResetCapability.js @@ -1,7 +1,7 @@ const MapResetCapability = require("../../../core/capabilities/MapResetCapability"); /** - * @extends MapResetCapability + * @extends MapResetCapability */ class MockMapResetCapability extends MapResetCapability { /** diff --git a/backend/lib/robots/mock/capabilities/MockMapSegmentationCapability.js b/backend/lib/robots/mock/capabilities/MockMapSegmentationCapability.js index 6144033d..fc9707ad 100644 --- a/backend/lib/robots/mock/capabilities/MockMapSegmentationCapability.js +++ b/backend/lib/robots/mock/capabilities/MockMapSegmentationCapability.js @@ -2,7 +2,7 @@ const MapSegmentationCapability = require("../../../core/capabilities/MapSegment const ValetudoMapSegment = require("../../../entities/core/ValetudoMapSegment"); /** - * @extends MapSegmentationCapability + * @extends MapSegmentationCapability */ class MockMapSegmentationCapability extends MapSegmentationCapability { /** diff --git a/backend/lib/robots/mock/capabilities/MockMappingPassCapability.js b/backend/lib/robots/mock/capabilities/MockMappingPassCapability.js index 7b53d5bd..0e710f21 100644 --- a/backend/lib/robots/mock/capabilities/MockMappingPassCapability.js +++ b/backend/lib/robots/mock/capabilities/MockMappingPassCapability.js @@ -1,7 +1,7 @@ const MappingPassCapability = require("../../../core/capabilities/MappingPassCapability"); /** - * @extends MappingPassCapability + * @extends MappingPassCapability */ class MockMappingPassCapability extends MappingPassCapability { /** diff --git a/backend/lib/robots/mock/capabilities/MockMopDockCleanManualTriggerCapability.js b/backend/lib/robots/mock/capabilities/MockMopDockCleanManualTriggerCapability.js index 2bf18f8a..6b28519f 100644 --- a/backend/lib/robots/mock/capabilities/MockMopDockCleanManualTriggerCapability.js +++ b/backend/lib/robots/mock/capabilities/MockMopDockCleanManualTriggerCapability.js @@ -2,7 +2,7 @@ const entities = require("../../../entities"); const MopDockCleanManualTriggerCapability = require("../../../core/capabilities/MopDockCleanManualTriggerCapability"); /** - * @extends MopDockCleanManualTriggerCapability + * @extends MopDockCleanManualTriggerCapability */ class MockMopDockCleanManualTriggerCapability extends MopDockCleanManualTriggerCapability { /** diff --git a/backend/lib/robots/mock/capabilities/MockMopDockDryManualTriggerCapability.js b/backend/lib/robots/mock/capabilities/MockMopDockDryManualTriggerCapability.js index e87b7ed5..1ed95543 100644 --- a/backend/lib/robots/mock/capabilities/MockMopDockDryManualTriggerCapability.js +++ b/backend/lib/robots/mock/capabilities/MockMopDockDryManualTriggerCapability.js @@ -2,7 +2,7 @@ const entities = require("../../../entities"); const MopDockDryManualTriggerCapability = require("../../../core/capabilities/MopDockDryManualTriggerCapability"); /** - * @extends MopDockDryManualTriggerCapability + * @extends MopDockDryManualTriggerCapability */ class MockMopDockDryManualTriggerCapability extends MopDockDryManualTriggerCapability { /** diff --git a/backend/lib/robots/mock/capabilities/MockObstacleAvoidanceControlCapability.js b/backend/lib/robots/mock/capabilities/MockObstacleAvoidanceControlCapability.js index 753eb95e..b362c010 100644 --- a/backend/lib/robots/mock/capabilities/MockObstacleAvoidanceControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockObstacleAvoidanceControlCapability.js @@ -1,12 +1,12 @@ const ObstacleAvoidanceControlCapability = require("../../../core/capabilities/ObstacleAvoidanceControlCapability"); /** - * @extends ObstacleAvoidanceControlCapability + * @extends ObstacleAvoidanceControlCapability */ class MockObstacleAvoidanceControlCapability extends ObstacleAvoidanceControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockOperationModeControlCapability.js b/backend/lib/robots/mock/capabilities/MockOperationModeControlCapability.js index 20c515df..765a4020 100644 --- a/backend/lib/robots/mock/capabilities/MockOperationModeControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockOperationModeControlCapability.js @@ -4,12 +4,12 @@ const ValetudoSelectionPreset = require("../../../entities/core/ValetudoSelectio const stateAttrs = entities.state.attributes; /** - * @extends OperationModeControlCapability + * @extends OperationModeControlCapability */ class MockOperationModeControlCapability extends OperationModeControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { let presets = [ diff --git a/backend/lib/robots/mock/capabilities/MockPendingMapChangeHandlingCapability.js b/backend/lib/robots/mock/capabilities/MockPendingMapChangeHandlingCapability.js index 37710d6f..304ae875 100644 --- a/backend/lib/robots/mock/capabilities/MockPendingMapChangeHandlingCapability.js +++ b/backend/lib/robots/mock/capabilities/MockPendingMapChangeHandlingCapability.js @@ -1,7 +1,7 @@ const PendingMapChangeHandlingCapability = require("../../../core/capabilities/PendingMapChangeHandlingCapability"); /** - * @extends PendingMapChangeHandlingCapability + * @extends PendingMapChangeHandlingCapability */ class MockPendingMapChangeHandlingCapability extends PendingMapChangeHandlingCapability { /** diff --git a/backend/lib/robots/mock/capabilities/MockPersistentMapControlCapability.js b/backend/lib/robots/mock/capabilities/MockPersistentMapControlCapability.js index 71b0d77e..1cfd1c8b 100644 --- a/backend/lib/robots/mock/capabilities/MockPersistentMapControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockPersistentMapControlCapability.js @@ -1,12 +1,12 @@ const PersistentMapControlCapability = require("../../../core/capabilities/PersistentMapControlCapability"); /** - * @extends PersistentMapControlCapability + * @extends PersistentMapControlCapability */ class MockPersistentMapControlCapability extends PersistentMapControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockPetObstacleAvoidanceControlCapability.js b/backend/lib/robots/mock/capabilities/MockPetObstacleAvoidanceControlCapability.js index ae40f4ce..758100df 100644 --- a/backend/lib/robots/mock/capabilities/MockPetObstacleAvoidanceControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockPetObstacleAvoidanceControlCapability.js @@ -1,12 +1,12 @@ const PetObstacleAvoidanceControlCapability = require("../../../core/capabilities/PetObstacleAvoidanceControlCapability"); /** - * @extends PetObstacleAvoidanceControlCapability + * @extends PetObstacleAvoidanceControlCapability */ class MockPetObstacleAvoidanceControlCapability extends PetObstacleAvoidanceControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockSpeakerTestCapability.js b/backend/lib/robots/mock/capabilities/MockSpeakerTestCapability.js index 398a2436..76a4bbff 100644 --- a/backend/lib/robots/mock/capabilities/MockSpeakerTestCapability.js +++ b/backend/lib/robots/mock/capabilities/MockSpeakerTestCapability.js @@ -2,7 +2,7 @@ const Logger = require("../../../Logger"); const SpeakerTestCapability = require("../../../core/capabilities/SpeakerTestCapability"); /** - * @extends SpeakerTestCapability + * @extends SpeakerTestCapability */ class MockSpeakerTestCapability extends SpeakerTestCapability { /** diff --git a/backend/lib/robots/mock/capabilities/MockSpeakerVolumeControlCapability.js b/backend/lib/robots/mock/capabilities/MockSpeakerVolumeControlCapability.js index 3011cfde..cd039514 100644 --- a/backend/lib/robots/mock/capabilities/MockSpeakerVolumeControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockSpeakerVolumeControlCapability.js @@ -1,12 +1,12 @@ const SpeakerVolumeControlCapability = require("../../../core/capabilities/SpeakerVolumeControlCapability"); /** - * @extends SpeakerVolumeControlCapability + * @extends SpeakerVolumeControlCapability */ class MockSpeakerVolumeControlCapability extends SpeakerVolumeControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockTotalStatisticsCapability.js b/backend/lib/robots/mock/capabilities/MockTotalStatisticsCapability.js index 784fb5b4..0d7ae031 100644 --- a/backend/lib/robots/mock/capabilities/MockTotalStatisticsCapability.js +++ b/backend/lib/robots/mock/capabilities/MockTotalStatisticsCapability.js @@ -3,7 +3,7 @@ const TotalStatisticsCapability = require("../../../core/capabilities/TotalStati const ValetudoDataPoint = require("../../../entities/core/ValetudoDataPoint"); /** - * @extends TotalStatisticsCapability + * @extends TotalStatisticsCapability */ class MockTotalStatisticsCapability extends TotalStatisticsCapability { constructor(options) { diff --git a/backend/lib/robots/mock/capabilities/MockVoicePackManagementCapability.js b/backend/lib/robots/mock/capabilities/MockVoicePackManagementCapability.js index d055e373..8f993512 100644 --- a/backend/lib/robots/mock/capabilities/MockVoicePackManagementCapability.js +++ b/backend/lib/robots/mock/capabilities/MockVoicePackManagementCapability.js @@ -2,12 +2,12 @@ const ValetudoVoicePackOperationStatus = require("../../../entities/core/Valetud const VoicePackManagementCapability = require("../../../core/capabilities/VoicePackManagementCapability"); /** - * @extends VoicePackManagementCapability + * @extends VoicePackManagementCapability */ class MockVoicePackManagementCapability extends VoicePackManagementCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(options); diff --git a/backend/lib/robots/mock/capabilities/MockWaterUsageControlCapability.js b/backend/lib/robots/mock/capabilities/MockWaterUsageControlCapability.js index 682db933..4e787506 100644 --- a/backend/lib/robots/mock/capabilities/MockWaterUsageControlCapability.js +++ b/backend/lib/robots/mock/capabilities/MockWaterUsageControlCapability.js @@ -4,12 +4,12 @@ const WaterUsageControlCapability = require("../../../core/capabilities/WaterUsa const stateAttrs = entities.state.attributes; /** - * @extends WaterUsageControlCapability + * @extends WaterUsageControlCapability */ class MockWaterUsageControlCapability extends WaterUsageControlCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { let presets = [ diff --git a/backend/lib/robots/mock/capabilities/MockWifiConfigurationCapability.js b/backend/lib/robots/mock/capabilities/MockWifiConfigurationCapability.js index e04d2eba..d6042444 100644 --- a/backend/lib/robots/mock/capabilities/MockWifiConfigurationCapability.js +++ b/backend/lib/robots/mock/capabilities/MockWifiConfigurationCapability.js @@ -2,12 +2,12 @@ const ValetudoWifiStatus = require("../../../entities/core/ValetudoWifiStatus"); const WifiConfigurationCapability = require("../../../core/capabilities/WifiConfigurationCapability"); /** - * @extends WifiConfigurationCapability + * @extends WifiConfigurationCapability */ class MockWifiConfigurationCapability extends WifiConfigurationCapability { /** * @param {object} options - * @param {import("../MockRobot")} options.robot + * @param {import("../MockValetudoRobot")} options.robot */ constructor(options) { super(Object.assign({}, options, {networkInterface: "wlan0"})); diff --git a/backend/lib/robots/mock/capabilities/MockWifiScanCapability.js b/backend/lib/robots/mock/capabilities/MockWifiScanCapability.js index bff50a6e..dca248f1 100644 --- a/backend/lib/robots/mock/capabilities/MockWifiScanCapability.js +++ b/backend/lib/robots/mock/capabilities/MockWifiScanCapability.js @@ -6,7 +6,7 @@ function getRandomRSSI() { } /** - * @extends WifiScanCapability + * @extends WifiScanCapability */ class MockWifiScanCapability extends WifiScanCapability { async scan() { diff --git a/backend/lib/robots/mock/capabilities/MockZoneCleaningCapability.js b/backend/lib/robots/mock/capabilities/MockZoneCleaningCapability.js index 4b4669c1..2037d311 100644 --- a/backend/lib/robots/mock/capabilities/MockZoneCleaningCapability.js +++ b/backend/lib/robots/mock/capabilities/MockZoneCleaningCapability.js @@ -1,7 +1,7 @@ const ZoneCleaningCapability = require("../../../core/capabilities/ZoneCleaningCapability"); /** - * @extends ZoneCleaningCapability + * @extends ZoneCleaningCapability */ class MockZoneCleaningCapability extends ZoneCleaningCapability { async start(options) { diff --git a/backend/lib/robots/mock/index.js b/backend/lib/robots/mock/index.js index 9f759143..865516f1 100644 --- a/backend/lib/robots/mock/index.js +++ b/backend/lib/robots/mock/index.js @@ -1,3 +1,3 @@ module.exports = { - "MockRobot": require("./MockRobot") + "MockValetudoRobot": require("./MockValetudoRobot") }; diff --git a/docs/_pages/development/building-and-modifying-valetudo.md b/docs/_pages/development/building-and-modifying-valetudo.md index 06ca8700..f1ef357f 100644 --- a/docs/_pages/development/building-and-modifying-valetudo.md +++ b/docs/_pages/development/building-and-modifying-valetudo.md @@ -56,7 +56,7 @@ Setting embedded to `false` disables all functionality that assumes that Valetud For a list of possible values for `implementation` consult the robot implementations in [https://github.com/Hypfer/Valetudo/tree/master/backend/lib/robots](https://github.com/Hypfer/Valetudo/tree/master/backend/lib/robots). -Valetudo is also capable of running without a real robot. The `MockRobot` implementation provides a virtual robot +Valetudo is also capable of running without a real robot. The `MockValetudoRobot` implementation provides a virtual robot that has a few basic capabilities. It requires no further implementation specific configuration. The config key `robot` specifies the ValetudoRobot implementation Valetudo should use as well as some implementation-specific configuration parameters. diff --git a/frontend/readme.md b/frontend/readme.md index 5bbda893..bb82bfd7 100644 --- a/frontend/readme.md +++ b/frontend/readme.md @@ -7,6 +7,6 @@ This is the new Valetudo Frontend written in React As it's much easier to work with a real Valetudo instead of a mock server, this project uses `cra-build-watch` to allow us to do just that. See also: https://github.com/facebook/create-react-app/issues/1070 -To work on this, it is recommended to spin up a local Valetudo instance (e.g. by using the MockRobot implementation) +To work on this, it is recommended to spin up a local Valetudo instance (e.g. by using the MockValetudoRobot implementation) and then running `npm run watch` in this folder. That will start webpack watch. When it's done doing the initial build, you can reach the frontend in your browser. diff --git a/util/generate_mqtt_docs.js b/util/generate_mqtt_docs.js index 135259d3..243f42d9 100644 --- a/util/generate_mqtt_docs.js +++ b/util/generate_mqtt_docs.js @@ -1,5 +1,5 @@ /* eslint-disable */ -const MockRobot = require("../backend/lib/robots/mock/MockRobot"); +const MockValetudoRobot = require("../backend/lib/robots/mock/MockValetudoRobot"); const RobotMqttHandle = require("../backend/lib/mqtt/handles/RobotMqttHandle"); const MqttController = require("../backend/lib/mqtt/MqttController"); const CapabilityMqttHandle = require("../backend/lib/mqtt/capabilities/CapabilityMqttHandle"); @@ -136,7 +136,7 @@ ConsumableMonitoringCapabilityMqttHandle.prototype.genConsumableFriendlyName = ( class FakeMqttController extends MqttController { // @ts-ignore constructor() { - const robot = new MockRobot({config: fakeConfig, valetudoEventStore: eventStore}); + const robot = new MockValetudoRobot({config: fakeConfig, valetudoEventStore: eventStore}); robot.capabilities[ConsumableMonitoringCapability.TYPE].getProperties = () => { return {