diff --git a/docs/_pages/companion_apps/fun_games.md b/docs/_pages/companion_apps/fun_games.md index 8dcb8eaaacc..7a33c06cc35 100644 --- a/docs/_pages/companion_apps/fun_games.md +++ b/docs/_pages/companion_apps/fun_games.md @@ -7,7 +7,7 @@ order: 20 A small and rather hackish script, which takes a ValetudoMap JSON and renders it to a Minecraft World. -![image](./img/valetudo-minecraft-mapper.png) +image [https://github.com/Hypfer/Valetudo-Minecraft-Mapper](https://github.com/Hypfer/Valetudo-Minecraft-Mapper) diff --git a/docs/_pages/companion_apps/valeronoi.md b/docs/_pages/companion_apps/valeronoi.md index 5c65165de53..da218da29ed 100644 --- a/docs/_pages/companion_apps/valeronoi.md +++ b/docs/_pages/companion_apps/valeronoi.md @@ -7,7 +7,7 @@ order: 16 Valeronoi (Valetudo + Voronoi) is a companion for [Valetudo](https://valetudo.cloud) for generating WiFi signal strength maps. It visualizes them using a [Voronoi diagram](https://en.wikipedia.org/wiki/Voronoi_diagram). -![image](./img/valeronoi.png) +image For more information, check out [https://github.com/ccoors/Valeronoi](https://github.com/ccoors/Valeronoi) diff --git a/docs/_pages/companion_apps/valetudo_tray_companion.md b/docs/_pages/companion_apps/valetudo_tray_companion.md index 56d1bdbc29e..9d60bff87da 100644 --- a/docs/_pages/companion_apps/valetudo_tray_companion.md +++ b/docs/_pages/companion_apps/valetudo_tray_companion.md @@ -5,7 +5,7 @@ order: 15 --- # Valetudo Tray Companion -![image](https://user-images.githubusercontent.com/974410/156892054-01d113e8-17e3-4a6f-b931-3eb2b54756d4.png) +image Valetudo Tray Companion offers a tray icon, which on right-click provides you with a list of Valetudo instances on your network.
Clicking on one of them will open its Webinterface in your default browser. diff --git a/docs/_pages/general/getting-started.md b/docs/_pages/general/getting-started.md index 79c2bef0913..bb440bab30e 100644 --- a/docs/_pages/general/getting-started.md +++ b/docs/_pages/general/getting-started.md @@ -67,7 +67,7 @@ which will autodiscover Valetudo instances on your network. If you're using a computer running Microsoft Windows, you can also open the explorer and navigate to "Network" where your new robot should also be autodiscovered. -![image](https://user-images.githubusercontent.com/974410/127387044-da7e8c18-390f-40bc-88b1-3ff316e4e6cf.png) +image ## Now What? diff --git a/docs/_pages/general/supported-robots.md b/docs/_pages/general/supported-robots.md index 303983994f2..fd9da871c47 100644 --- a/docs/_pages/general/supported-robots.md +++ b/docs/_pages/general/supported-robots.md @@ -112,7 +112,7 @@ Don't assume any compatibility of consumables or other parts as well as rooting ### Xiaomi V1 - + The Xiaomi V1 is made by Roborock. It is sold as: - Xiaomi Mi Robot Vacuum @@ -140,7 +140,7 @@ If your robot is newer than that, full disassembly will be required. ### Xiaomi 1C - + The Xiaomi 1C is made by Dreame. It is sold as: - Mi Robot Vacuum-Mop @@ -169,7 +169,7 @@ If you only see weird characters on the UART, try `500000` instead of `115200` a ### Xiaomi 1T - + The Xiaomi 1T is made by Dreame. It is sold as: - Mi Robot Vacuum-Mop 2 Pro+ @@ -196,7 +196,7 @@ Note that that factory reset will also remove Valetudo meaning that you will hav ### Xiaomi P2148 - + The Xiaomi P2148 is made by Dreame. It is sold as: - Mijia Robot Vacuum-Mop Ultra Slim @@ -231,7 +231,7 @@ There is no reset button on this robot. Instead, press and hold the two buttons ### Xiaomi Vacuum-Mop P - + The Vacuum-Mop P is using the Viomi cloud stack but is actually made by 3irobotix.
There are three robots with different IDs under this name, and they're all 3irobotix CRL-200S inside.
@@ -265,7 +265,7 @@ While Valetudo works with their model firmwares, the recommended rooting procedu ### Xiaomi Vacuum-Mop 2 Ultra - + The Xiaomi Vacuum-Mop 2 Ultra is made by Dreame. It is sold as: - Mi Robot Vacuum-Mop 2 Ultra @@ -288,7 +288,7 @@ All warranty seals stay intact. ### Xiaomi X10 Plus - + The Xiaomi Robot Vacuum X10 Plus is made by Dreame. It is sold as: - Xiaomi Robot Vacuum X10 Plus @@ -311,7 +311,7 @@ All warranty seals stay intact. ### D9 - + The Dreame D9 is Dreame's first ever Lidar-based vacuum robot. It is sold as: - Dreame D9 @@ -335,7 +335,7 @@ All warranty seals stay intact. ### D9 Pro - + The Dreame D9 Pro is sold as: - Dreame D9 Pro @@ -360,7 +360,7 @@ All warranty seals stay intact. ### F9 - + The Dreame F9 is sold as: - Dreame F9 @@ -381,7 +381,7 @@ All warranty seals stay intact. ### L10 Pro - + The Dreame L10 Pro is sold as: - Dreame L10 Pro @@ -402,7 +402,7 @@ All warranty seals stay intact. ### Z10 Pro - + The Dreame Z10 Pro is sold as: - Dreame Z10 Pro @@ -424,7 +424,7 @@ All warranty seals stay intact. ### W10 - + The Dreame W10 is sold as: - Dreame W10 @@ -462,7 +462,7 @@ For that, follow these steps: ### W10 Pro - + The Dreame W10 Pro is sold as: - Dreame W10 Pro @@ -493,7 +493,7 @@ If you're rooting your W10 Pro, just run that command before setting up Valetudo ### L10s Ultra - + The Dreame L10s Ultra is sold as: - Dreame L10s Ultra @@ -514,7 +514,7 @@ All warranty seals stay intact. ### D10s Pro - + The Dreame D10s Pro is sold as: - Dreame D10s Pro @@ -538,7 +538,7 @@ All warranty seals stay intact. ### D10s Plus - + The Dreame D10s Plus is sold as: - Dreame D10s Plus @@ -566,7 +566,7 @@ MOVA apparently was a rather short-lived sub-brand(?) of Dreame ### MOVA Z500 - + The MOVA Z500 is made by Dreame. It is sold as: - MOVA Z500 @@ -590,7 +590,7 @@ All warranty seals stay intact. ### Roborock S5 - + The Roborock S5 is sold as: - Roborock S5 @@ -613,7 +613,7 @@ Note that segment support is only available starting with firmware version 2008 ### Roborock S6 - + The Roborock S6 is sold as: - Roborock S6 @@ -638,7 +638,7 @@ Rooting requires full disassembly. ### Roborock S6 Pure - + The Roborock S6 Pure is sold as: - Roborock S6 Pure @@ -662,7 +662,7 @@ Rooting requires full disassembly. ### Roborock S4 - + The Roborock S4 is sold as: - Roborock S4 @@ -686,7 +686,7 @@ Rooting requires full disassembly. ### Roborock S4 Max - + The Roborock S4 Max is sold as: - Roborock S4 Max @@ -710,7 +710,7 @@ Rooting requires full disassembly. ### Roborock S5 Max - + The Roborock S5 Max is sold as: - Roborock S5 Max @@ -731,7 +731,7 @@ Rooting requires full disassembly. ### Roborock S7 - + The Roborock S7 is sold as: - Roborock S7 @@ -755,7 +755,7 @@ The VibraRise mop module makes disassembly of this robot difficult and easy to m ### Roborock S7 Pro Ultra - + The Roborock S7 Pro Ultra is sold as: - Roborock S7 Pro Ultra @@ -775,7 +775,7 @@ Rooting requires full disassembly. ### Roborock Q7 Max - + The Roborock Q7 Max is sold as: - Roborock Q7 Max @@ -801,7 +801,7 @@ They're not a robot manufacturer. ### Viomi V6 - + The Viomi V6 is actually a 3irobotix CRL-200S inside. It is sold as: - Viomi Cleaning Robot @@ -825,7 +825,7 @@ It might be required to remove the battery but that can be done without touching ### Viomi SE - + The Viomi SE is actually a 3irobotix CRL-200S inside. It is sold as: - Viomi SE @@ -853,7 +853,7 @@ They're not a robot manufacturer.
### Conga 3290 - + The Conga 3290 is actually a 3irobotix CRL-200S inside. It is sold as: - Conga 3290 @@ -878,7 +878,7 @@ It might be required to remove the battery but that can be done without touching ### Conga 3790 - + The Conga 3790 is actually a 3irobotix CRL-200S inside. It is sold as: - Conga 3790 @@ -909,7 +909,7 @@ They're not a robot manufacturer.
### Proscenic M6 Pro - + The Proscenic M6 Pro is actually a 3irobotix CRL-200S inside. It is sold as: - Proscenic M6 Pro @@ -940,7 +940,7 @@ Apparently, the first thing to do with that was to release a line of vacuum robo ### Commodore CVR 200 - + The Commodore CVR 200 is actually a 3irobotix CRL-200S inside. It is sold as: - Commodore CVR 200 diff --git a/docs/_pages/general/why-not-valetudo.md b/docs/_pages/general/why-not-valetudo.md index ae2d4505282..6e3045efdc5 100644 --- a/docs/_pages/general/why-not-valetudo.md +++ b/docs/_pages/general/why-not-valetudo.md @@ -226,13 +226,13 @@ Valetudo does not feature any localization. Let me explain the reasoning behind First, consider this car radio in a car made for the german market: -![Bosch Car Radio](./img/car_radio.jpg) +Bosch Car Radio In fact, the radio is engineered by Bosch in Hildesheim. Still, the button isn't labeled `Karte`. Now, let's take a look at the Valetudo UI (Version 0.6.1): -![Valetudo 0.6.1 UI](./img/valetudo-ui.png) +Valetudo 0.6.1 UI Regarding overall complexity, it's comparable to the buttons on the radio. It's even easier to understand, because there are a lot more icons.
@@ -254,14 +254,14 @@ we can take a look at a non-exhaustive list of downsides of i18n: Now, let us look at another real-world example of i18n. -![Apple Shortcuts Example](./img/apple_shortcuts_example.png) +Apple Shortcuts Example This is a screenshot of Apple Shortcuts running on an iPhone set to the German locale. It is just a basic HTTP PUT with a JSON payload. For some reason however, "Header" as in "HTTP Header" was translated to "Überschrift" which means "Headline". Even worse, "Request body" became "Haupttext anfordern" which translated back to english means "(to) request the main text"??? -![Visual Studio 2017 Example](./img/visual_studio_2017_example.png) +Visual Studio 2017 Example This is another example. Here we have the Integrated Development Environment Visual Studio 2017 made by Microsoft attempting to open a project file that was created in an older version of Visual Studio. diff --git a/docs/_pages/installation/dreame.md b/docs/_pages/installation/dreame.md index 3832f2cb887..d04837f471c 100644 --- a/docs/_pages/installation/dreame.md +++ b/docs/_pages/installation/dreame.md @@ -47,13 +47,13 @@ just _highly recommended_ to avoid people breaking the connector by jamming in 2
If you know what you're doing, here's the relevant pinout for you (click me)
- +
On some dreames, the debug connector is rotated by 90°:
- +
while on others, it might be flipped backwards:
- +

If you don't know what you're doing and start bothering the support chat with questions on what to do with this pinout, @@ -78,7 +78,7 @@ Therefore, it's recommended to use this known-good image that has been tested on For this rooting method, you will first have to gain access to the 16-pin Dreame Debug Connector. For all round-shaped dreames, this means removing the top plastic cover with a pry tool or your fingers like so: -![How to open a Dreame](./img/how_to_open_a_dreame.jpg) +How to open a Dreame If your Dreame is the P2148 Ultra Slim, just remove the whole top cover.
If your Dreame is a D-shaped Mop such as the W10, simply take out the dustbin and open the rubber flap in front of that port. @@ -87,7 +87,7 @@ Once you have access to the debug port, plug in your [Dreame Breakout PCB](https connect your USB to Serial UART adapter to the SoC breakout on the PCB. **Make sure your adapter is set to 3.3V**. You will only need 3 wires for this connection: (GND, RX, and TX). -![Dreame Breakout PCB connected](./img/dreame_breakout_in_p2150.jpg) +Dreame Breakout PCB connected #### Phase 2: Logging in @@ -116,7 +116,7 @@ For logging in, use the user `root`. It will then ask for a password. To calculate the password use the full serial number of your robot, which can be found on the sticker below the dustbin. **Not the one on the bottom of the robot nor the one on the packaging. You'll have to take out the dustbin and look below it into the now empty space.** -![Dreame Dustbin Sticker](./img/dreame_dustbin_sticker.jpg) +Dreame Dustbin Sticker To get the password, use the following [Calculator](https://gchq.github.io/CyberChef/#recipe=Find_/_Replace(%7B'option':'Regex','string':'(%5C%5Cn%7C%5C%5Cr)'%7D,'',true,false,true,false)MD5()Find_/_Replace(%7B'option':'Regex','string':'$'%7D,'%20%20-%5C%5Cn',false,false,false,false)To_Base64('A-Za-z0-9%2B/%3D')&input=UDIwMDkwMDAwRVUwMDAwMFpN) or enter the full SN (all uppercase) into this shell command @@ -244,7 +244,7 @@ You can of course use any linux distribution you want, however, if you want to r Next, you have to gain access to the 16-pin Dreame Debug Connector. For most round-shaped dreames, this means removing the top plastic cover with a pry tool or your fingers like so: -![How to open a Dreame](./img/how_to_open_a_dreame.jpg) +How to open a Dreame If your Dreame is a D-shaped Mop such as the W10 Pro, simply take out the dustbin and open the rubber flap in front of that port. @@ -264,13 +264,13 @@ You should _really_ be using the PCB.

If you know what you're doing, here's the relevant pinout for you (click me)
- +
On some dreames, the debug connector is rotated by 90°:
- +
while on others, it might be flipped backwards:
- +

If you don't know what you're doing and start bothering the support chat with questions on what to do with this pinout, @@ -292,7 +292,7 @@ Download the latest stage1 dustbuilder livesuit image for your robot: and select that as the Image in the LiveSuit tool. -![Dreame Livesuit Stage1](./img/dreame_livesuit_stage1.png) +Dreame Livesuit Stage1 Follow these steps to enter fastboot: @@ -302,7 +302,7 @@ Follow these steps to enter fastboot: Plug the Breakout PCB into your robot. Make sure that the USB OTG ID Jumper is **NOT** set and plug a cable into the Micro USB port. -![Dreame Breakout PCB connected](./img/dreame_breakout_fel.jpg) +Dreame Breakout PCB connected 1. Press and hold the button on the PCB. 2. Then, press and hold the power button of the robot. Keep pressing the button on the PCB. @@ -312,7 +312,7 @@ the Micro USB port. The button LEDs of the robot should now be pulsing. With that, plug the USB cable into your computer. LiveSuit should now display this message box: -![Dreame Livesuit Msgbox](./img/dreame_livesuit_msgbox.png) +Dreame Livesuit Msgbox Click no. This should now have booted your robot into Fastboot. To verify that, open a new terminal and run `fastboot devices`. @@ -366,7 +366,7 @@ Here are the steps again: Plug the Breakout PCB into your robot. Make sure that the USB OTG ID Jumper is **NOT** set and plug a cable into the Micro USB port. -![Dreame Breakout PCB connected](./img/dreame_breakout_fel.jpg) +Dreame Breakout PCB connected 1. Press and hold the button on the PCB. 2. Then, press and hold the power button of the robot. Keep pressing the button on the PCB. @@ -376,7 +376,7 @@ the Micro USB port. The button LEDs of the robot should now be pulsing. With that, plug the USB cable into your computer. LiveSuit should now display this message box: -![Dreame Livesuit Msgbox](./img/dreame_livesuit_msgbox.png) +Dreame Livesuit Msgbox Click no. This should now have booted your robot into Fastboot. To verify that, open a new terminal and run `fastboot devices`. diff --git a/docs/_pages/installation/roborock.md b/docs/_pages/installation/roborock.md index ee51f0c8b8f..0a1391f0e7c 100644 --- a/docs/_pages/installation/roborock.md +++ b/docs/_pages/installation/roborock.md @@ -186,7 +186,7 @@ Just search for e.g., "s5 max disassembly". You likely won't have to disconnect all the wires going to the mainboard. It's enough to disconnect the ones at the front to be able to lift it in a position like this: -![S5e Mainboard FEL root](./img/s5e_mainboard_fel_root.jpg) +S5e Mainboard FEL root By the time you've reached the mainboard, you should've already received a link to download your rooted firmware package from the dustbuilder. @@ -200,7 +200,7 @@ roborock.vacuum.s5e_1566_fw.tar.gz 2022-12-02 15:08 26M Now, connect your USB Cable to the robot and your Laptop running Linux. Then, connect the battery. Do not turn on the robot yet. -![S5e Mainboard testpoint for FEL root](./img/s5e_board_with_testpoint_for_fel.jpg) +S5e Mainboard testpoint for FEL root Connect the marked TPA17 to GND using your jumper cable or paperclip. You can use anything that is GND. The marked SH1 for GND should be close enough to enable you to do the procedure without the help of another person. diff --git a/docs/_pages/integrations/home-assistant-integration.md b/docs/_pages/integrations/home-assistant-integration.md index 205af945c5a..5c8b02d05fd 100644 --- a/docs/_pages/integrations/home-assistant-integration.md +++ b/docs/_pages/integrations/home-assistant-integration.md @@ -71,7 +71,7 @@ For more features check out the [MQTT documentation](/pages/integrations/mqtt.ht **HACS requirements: [auto-entities](https://github.com/thomasloven/lovelace-auto-entities), [button-card](https://github.com/custom-cards/button-card).** -![image](./img/ha-lovelace-segments.png) +image Card configuration: ```yaml diff --git a/docs/assets/css/style.css b/docs/assets/css/style.css index d6eb7569bb0..4e323f14643 100644 --- a/docs/assets/css/style.css +++ b/docs/assets/css/style.css @@ -287,7 +287,9 @@ th{ color:#444 } img{ - max-width:100% + max-width: 100%; + height: auto; + aspect-ratio: auto; } header{ width:270px;