docs: Fix and update MQTT docs

Author: Hypfer

backend/lib/mqtt/capabilities/MapSegmentationCapabilityMqttHandle.js

@@ -58,6 +58,7 @@ class MapSegmentationCapabilityMqttHandle extends CapabilityMqttHandle {
             helpText: "This handle accepts a JSON object identical to the one used by the REST API.\n\n" +
                 "Simply use the Map in the Valetudo UI, select the desired segments and iterations and then long-press the button that would start the action.<br/>\n" +
                 "This will open a modal containing the copy-pasteable payload.\n\n" +
+                "\n**Note:** Not all firmwares support customOrder.\n\n" +
                 "Sample payload:\n\n" +
                 "```json\n" +
                 JSON.stringify({

backend/lib/robots/mock/capabilities/MockOperationModeControlCapability.js

@@ -15,7 +15,8 @@ class MockOperationModeControlCapability extends OperationModeControlCapability
         let presets = [
             new ValetudoSelectionPreset({name: entities.state.attributes.PresetSelectionStateAttribute.MODE.MOP, value: 0}),
             new ValetudoSelectionPreset({name: entities.state.attributes.PresetSelectionStateAttribute.MODE.VACUUM, value: 1}),
-            new ValetudoSelectionPreset({name: entities.state.attributes.PresetSelectionStateAttribute.MODE.VACUUM_AND_MOP, value: 2})
+            new ValetudoSelectionPreset({name: entities.state.attributes.PresetSelectionStateAttribute.MODE.VACUUM_AND_MOP, value: 2}),
+            new ValetudoSelectionPreset({name: entities.state.attributes.PresetSelectionStateAttribute.MODE.VACUUM_THEN_MOP, value: 3}),
         ];
         super({
             robot: options.robot,

docs/_pages/integrations/mqtt.md

@@ -144,8 +144,8 @@ settings page.
 - [Obstacle Avoidance (`switch.mqtt`)](#obstacleavoidanceenabled)
 - [Pet Obstacle Avoidance (`switch.mqtt`)](#petobstacleavoidanceenabled)
 - [Play locate sound (`button.mqtt`)](#locatelocate)
-- [Reset <CONSUMABLE-MINUTES> Consumable (`button.mqtt`)](#resettheconsumableconsumable-minutesreset)
-- [Reset <CONSUMABLE-PERCENT> Consumable (`button.mqtt`)](#resettheconsumableconsumable-percentreset)
+- [Reset &lt;CONSUMABLE-MINUTES&gt; Consumable (`button.mqtt`)](#resettheconsumableconsumable-minutesreset)
+- [Reset &lt;CONSUMABLE-PERCENT&gt; Consumable (`button.mqtt`)](#resettheconsumableconsumable-percentreset)
 - [Speaker volume (`number.mqtt`)](#speakervolumevalue)
 - [Status Flag (`sensor.mqtt`)](#statusflagflag)
 - [Total Statistics Area (`sensor.mqtt`)](#totalstatisticsareaarea)
@@ -324,7 +324,7 @@ Home Assistant components controlled by this property:
 
 Home Assistant components controlled by this property:
 
-- Reset <CONSUMABLE-MINUTES> Consumable ([`button.mqtt`](https://www.home-assistant.io/integrations/button.mqtt/))
+- Reset &lt;CONSUMABLE-MINUTES&gt; Consumable ([`button.mqtt`](https://www.home-assistant.io/integrations/button.mqtt/))
 
 
 
@@ -359,7 +359,7 @@ Home Assistant components controlled by this property:
 
 Home Assistant components controlled by this property:
 
-- Reset <CONSUMABLE-PERCENT> Consumable ([`button.mqtt`](https://www.home-assistant.io/integrations/button.mqtt/))
+- Reset &lt;CONSUMABLE-PERCENT&gt; Consumable ([`button.mqtt`](https://www.home-assistant.io/integrations/button.mqtt/))
 
 
 
@@ -558,6 +558,9 @@ This handle accepts a JSON object identical to the one used by the REST API.
 Simply use the Map in the Valetudo UI, select the desired segments and iterations and then long-press the button that would start the action.<br/>
 This will open a modal containing the copy-pasteable payload.
 
+
+**Note:** Not all firmwares support customOrder.
+
 Sample payload:
 
 ```json
@@ -624,7 +627,7 @@ This handle allows setting the mode. It accepts the preset payloads specified in
 
 - Read topic: `<TOPIC PREFIX>/<IDENTIFIER>/OperationModeControlCapability/preset`
 - Set topic: `<TOPIC PREFIX>/<IDENTIFIER>/OperationModeControlCapability/preset/set`
-- Data type: [enum](https://homieiot.github.io/specification/#enum) (allowed payloads: `mop`, `vacuum`, `vacuum_and_mop`)
+- Data type: [enum](https://homieiot.github.io/specification/#enum) (allowed payloads: `mop`, `vacuum`, `vacuum_and_mop`, `vacuum_then_mop`)
 
 {% include alert.html type="warning" content="Some information contained in this document may not be exactly what is sent or expected by actual robots, since different vendors have different implementations. Refer to the table below.
 

util/generate_mqtt_docs.js

@@ -323,16 +323,24 @@ class FakeMqttController extends MqttController {
             this.addedConsumables.push(handle.friendlyName);
         }
 
-        let title = handle.friendlyName;
+        const baseTitle = handle.friendlyName;
+        let titleSuffix = "";
+
         if (handle instanceof CapabilityMqttHandle) {
-            title += ` (\`${handle.capability.getType()}\`)`;
+            titleSuffix = ` (\`${handle.capability.getType()}\`)`;
         } else if (handle instanceof RobotStateNodeMqttHandle) {
-            title += ` (\`${handle.getInterestingStatusAttributes()[0].attributeClass}\`)`;
+            titleSuffix = ` (\`${handle.getInterestingStatusAttributes()[0].attributeClass}\`)`;
         } else if (handle instanceof PropertyMqttHandle) {
-            title += ` (\`${handle.topicName}\`)`;
+            titleSuffix = ` (\`${handle.topicName}\`)`;
         }
-        const anchor = this.generateAnchor(title);
-        markdown += `${"#".repeat(markdownLevel)} ${title} <a id="${anchor}" />` + "\n\n";
+        
+        const unescapedFullTitle = baseTitle + titleSuffix;
+        const anchor = this.generateAnchor(unescapedFullTitle);
+        
+        const escapedBaseTitle = baseTitle.replace(/</g, "&lt;").replace(/>/g, "&gt;");
+        const finalDisplayTitle = escapedBaseTitle + titleSuffix;
+
+        markdown += `${"#".repeat(markdownLevel)} ${finalDisplayTitle} <a id="${anchor}" />` + "\n\n";
 
         let homieType = "Handle";
         const attributes = [];
@@ -361,7 +369,7 @@ class FakeMqttController extends MqttController {
             attributes.push(`capability: [${handle.capability.getType()}](/pages/usage/capabilities-overview.html#${this.generateAnchor(handle.capability.getType())})`);
         }
         markdown += `*${attributes.join(", ")}*` + "\n\n";
-        
+
         if (handle.constructor.OPTIONAL === true) {
             markdown += `**Note:** This is an optional exposed capability handle and thus will only be available via MQTT if enabled in the Valetudo configuration.\n\n`;
         }
@@ -490,10 +498,16 @@ class FakeMqttController extends MqttController {
                 if (component.componentType === "vacuum") {
                     component.friendlyName = "Vacuum";
                 }
-                markdown += "- " + (component.friendlyName ?? component.name ?? component.componentId) +
-                    ` ([\`${component.componentType}.mqtt\`](https://www.home-assistant.io/integrations/${component.componentType}.mqtt/))\n`;
-                const compTitle = (component.friendlyName ?? component.name ?? component.componentId) + ` (\`${component.componentType}.mqtt\`)`;
-                hassComponentAnchors[compTitle] = anchor;
+
+                const componentBaseName = (component.friendlyName ?? component.name ?? component.componentId);
+                const componentSuffix = ` ([\`${component.componentType}.mqtt\`](https://www.home-assistant.io/integrations/${component.componentType}.mqtt/))`;
+                const componentIndexSuffix = ` (\`${component.componentType}.mqtt\`)`;
+                
+                const escapedComponentBaseName = componentBaseName.replace(/</g, "&lt;").replace(/>/g, "&gt;");
+                markdown += "- " + escapedComponentBaseName + componentSuffix + "\n";
+                
+                const hassComponentIndexKey = escapedComponentBaseName + componentIndexSuffix;
+                hassComponentAnchors[hassComponentIndexKey] = anchor;
             }
             markdown += "\n";
         }
@@ -515,7 +529,7 @@ class FakeMqttController extends MqttController {
         return {
             markdown: markdown,
             anchors: {
-                title: title,
+                title: finalDisplayTitle,
                 anchor: anchor,
                 children: childAnchors
             },