HELP WANTED - Documentation

[Lash-L]

We have a lot of commands (100+), and users frequently ask if it is possible to do various things.

https://python-roborock.readthedocs.io/en/latest/api_commands.html

That page contains all of the commands we have created, but we are missing a lot of information, as it takes a lot of time to fill out, and I would like to focus on programming and adding more features.

It takes no programming experience, so if you feel so called, we would appreciate any help filling out the templates for some of these commands on the documentation.

[Turiok]

Hi @Lash-L ,

My roborock S7 should be arrived 20 July. I found your project and I'm interested to participate.
My native language is French. Do you want multiple language or only English?
Other question, Why do you create the issue in this repository instead where the doc is https://github.com/humbertogontijo/python-roborock ?
It should be easier to check the code for parameters and information.

[Lash-L]

Issue was created here as that is where there is visibility. Multiple languages would be great, but I think getting a foundation of the docs in English first would be the priority(I'm also not sure how multi language works for read the docs)

[kapuranirudh]

Hi @Lash-L , can I also come in and help you in writing documentation for this I am Technical Writer by profession so I would like to know more about this product so that I do my best for you. Let me know, if there is anything you can share my email id: [email protected], rest I will check this https://github.com/humbertogontijo/python-roborock ?

[Lash-L]

Hi @Lash-L , can I also come in and help you in writing documentation for this I am Technical Writer by profession so I would like to know more about this product so that I do my best for you. Let me know, if there is anything you can share my email id: [email protected], rest I will check this https://github.com/humbertogontijo/python-roborock ?

This is the best place to start:

https://github.com/humbertogontijo/python-roborock/blob/main/roborock/roborock_typing.py

It has our commands and a few possible run arguments.

[shred86]

I'm trying to run python-roborock through the CLI to execute commands to better understand exactly what they do and what the commands return in order to help with adding to the documentation. However, when I try something like roborock command --device_id 12345 --cmd get_consumable, I'm getting AttributeError: 'str' object has no attribute 'name'. I've tried a few different commands listed in roborock_typing.py but not having any luck. I'm sure I'm screwing something simple up - any pointers?

[humbertogontijo]

@shred86 make sure to install latest pip install python-roborock==0.30.1 and run it with debug mode to see if we can get any other log pointing to where this exception happened using roborock -d command --device_id 12345 --cmd get_consumable

[shred86]

When I try pip install python-roborock==0.30.1, I get the following:

ERROR: Could not find a version that satisfies the requirement python-roborock==0.30.1 (from versions: 0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.1.6, 0.1.7, 0.1.8, 0.1.9, 0.1.10, 0.1.11.dev0, 0.2.2, 0.2.3, 0.3.0, 0.3.1, 0.4.0, 0.4.1, 0.4.2, 0.4.3, 0.4.4, 0.4.5, 0.4.6, 0.4.7, 0.4.8, 0.4.9, 0.4.10, 0.4.11, 0.4.12, 0.4.13, 0.4.14, 0.4.15, 0.4.16, 0.5.0, 0.5.1, 0.5.2, 0.5.3, 0.5.4, 0.5.5, 0.5.6, 0.5.7, 0.5.8, 0.5.9, 0.6.0, 0.6.1, 0.6.2, 0.6.3, 0.6.4, 0.6.5, 0.6.6, 0.6.7, 0.6.8, 0.6.9, 0.6.10, 0.6.11, 0.6.12, 0.6.13, 0.6.14, 0.6.15, 0.6.16, 0.6.17, 0.7.0, 0.7.1, 0.7.2, 0.7.3, 0.7.4, 0.7.5, 0.7.6, 0.7.7, 0.7.8, 0.8.0, 0.8.1, 0.8.2, 0.8.3, 0.9.0rc0, 0.9.0, 0.10.0, 0.10.1, 0.10.2, 0.10.3, 0.11.0, 0.12.0, 0.12.1, 0.13.0, 0.13.1, 0.13.2, 0.13.3, 0.13.4, 0.14.0, 0.14.1, 0.15.0, 0.16.0, 0.16.1, 0.17.0, 0.17.1, 0.17.3, 0.17.4, 0.17.5, 0.17.6, 0.17.7, 0.17.8, 0.18.0, 0.18.1, 0.18.2, 0.18.3, 0.18.4, 0.18.5, 0.18.6, 0.18.7, 0.18.8, 0.18.9, 0.18.10, 0.19.0, 0.20.0, 0.20.1, 0.20.2, 0.21.0, 0.21.1, 0.22.0, 0.23.0, 0.23.1, 0.23.2, 0.23.3, 0.23.4, 0.23.5, 0.23.6, 0.24.0, 0.24.1)
ERROR: No matching distribution found for python-roborock==0.30.1

Which is strange because I see 0.30.1 posted in pypi.

[humbertogontijo]

When I try pip install python-roborock==0.30.1, I get the following:

ERROR: Could not find a version that satisfies the requirement python-roborock==0.30.1 (from versions: 0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.1.6, 0.1.7, 0.1.8, 0.1.9, 0.1.10, 0.1.11.dev0, 0.2.2, 0.2.3, 0.3.0, 0.3.1, 0.4.0, 0.4.1, 0.4.2, 0.4.3, 0.4.4, 0.4.5, 0.4.6, 0.4.7, 0.4.8, 0.4.9, 0.4.10, 0.4.11, 0.4.12, 0.4.13, 0.4.14, 0.4.15, 0.4.16, 0.5.0, 0.5.1, 0.5.2, 0.5.3, 0.5.4, 0.5.5, 0.5.6, 0.5.7, 0.5.8, 0.5.9, 0.6.0, 0.6.1, 0.6.2, 0.6.3, 0.6.4, 0.6.5, 0.6.6, 0.6.7, 0.6.8, 0.6.9, 0.6.10, 0.6.11, 0.6.12, 0.6.13, 0.6.14, 0.6.15, 0.6.16, 0.6.17, 0.7.0, 0.7.1, 0.7.2, 0.7.3, 0.7.4, 0.7.5, 0.7.6, 0.7.7, 0.7.8, 0.8.0, 0.8.1, 0.8.2, 0.8.3, 0.9.0rc0, 0.9.0, 0.10.0, 0.10.1, 0.10.2, 0.10.3, 0.11.0, 0.12.0, 0.12.1, 0.13.0, 0.13.1, 0.13.2, 0.13.3, 0.13.4, 0.14.0, 0.14.1, 0.15.0, 0.16.0, 0.16.1, 0.17.0, 0.17.1, 0.17.3, 0.17.4, 0.17.5, 0.17.6, 0.17.7, 0.17.8, 0.18.0, 0.18.1, 0.18.2, 0.18.3, 0.18.4, 0.18.5, 0.18.6, 0.18.7, 0.18.8, 0.18.9, 0.18.10, 0.19.0, 0.20.0, 0.20.1, 0.20.2, 0.21.0, 0.21.1, 0.22.0, 0.23.0, 0.23.1, 0.23.2, 0.23.3, 0.23.4, 0.23.5, 0.23.6, 0.24.0, 0.24.1)
ERROR: No matching distribution found for python-roborock==0.30.1

Which is strange because I see 0.30.1 posted in pypi.

pip3 install python-roborock==0.30.1 maybe?

[shred86]

Ah, it's because I wasn't running Python 3.10+. Got the latest version of python-roborock installed and now it appears to be working! Thanks.

[kapuranirudh]

Hi @Lash-L : Sorry for my late reply, please check out this API document on Roborock, https://studio-ws.apicur.io/sharing/28b13a35-1dac-47eb-8ea2-40f4d2303545 (open on Chrome Browser).

This is for only 2 API commands right now /app_charge and /consumable

Rest I would be requiring the endpoints to test the same on Postman.

This is what I have understood so far and designed accordingly, hope I am on the right track, rest need guidance from you and others.