Create switch.xiaomi_vacuum #2771

jcastro · 2017-06-05T15:28:18Z

First revision

Description:

Pull request in home-assistant (if applicable): home-assistant/home-assistant#

First revision

rytilahti · 2017-06-05T15:45:29Z

source/_components/switch.xiaomi_vacuum

+The `xiaomi_vacuum`switch platforms allows you to control the state of your [Xiaomi Mi Robot Vacuum](http://www.mi.com/roomrobot/). 
+Current supported features are start and stop (go to dock).
+
+{% linkable_title Installation %}


The installation should be unnecessary as homeassistant downloads the dependencies.

rytilahti · 2017-06-05T15:46:05Z

source/_components/switch.xiaomi_vacuum

+INFO:mirobo.vacuum:  IP 192.168.8.1: Xiaomi Mi Robot Vacuum - token: b'ffffffffffffffffffffffffffffffff'
+```
+
+If the value is as shown above, the vacuum has already been connected and it needs a reset.


If the value is full of ffs?

yes, at least is what I experienced when running the commands. Is it not clear enough, maybe?

rytilahti · 2017-06-05T15:46:40Z

source/_components/switch.xiaomi_vacuum

+```
+
+Configuration variables:
+- **name** (*Required*): The name of your robot


Name is not required at the moment, should it be?

wasn't sure about the required ones, will change it to optional then!

rytilahti · 2017-06-05T15:47:12Z

source/_components/switch.xiaomi_vacuum

@@ -0,0 +1,47 @@
+The `xiaomi_vacuum`switch platforms allows you to control the state of your [Xiaomi Mi Robot Vacuum](http://www.mi.com/roomrobot/). 


Platform not platforms.

Tweaks in the copy

rytilahti · 2017-06-05T16:00:51Z

source/_components/switch.xiaomi_vacuum

+This token is only attainable before the device has been connected over the app to your local wifi.
+
+In order to fetch the token, reset the robot, connect to its the network its announcing (rockrobo-XXXX)
+and run the following command:


I'm wondering if this part is too vague (for users who do not know how to access the virtualenv/environment of homeassistant), but can't directly think of how to write it out in a nicer manner.

rytilahti · 2017-06-05T16:01:40Z

source/_components/switch.xiaomi_vacuum

+INFO:mirobo.vacuum:  IP 192.168.8.1: Xiaomi Mi Robot Vacuum - token: b'ffffffffffffffffffffffffffffffff'
+```
+
+If the value is as shown above, full of ffs, the vacuum has already been connected and it needs a reset.


"full of ffs" sounds weird. Maybe it'd be better to rewrite it in a more user-friendly manner?
edit: other than these two things, I think it's fine from my side.

rytilahti · 2017-06-05T16:08:10Z

One more note, all documentation needs an information table, see https://github.com/home-assistant/home-assistant.github.io/blob/current/source/_components/neato.markdown

jcastro · 2017-06-05T16:09:47Z

@rytilahti oh great, thanks for letting me know! will add it in a bit!

jcastro · 2017-06-05T16:32:21Z

@fabaff would you mind pointing me on the right direction to know where I should upload and what sizes and formats should the component image be like?

Sorry I need to ask for this but I've tried searching for example "telldus_tellstick.png" which is one of the current Switch components in the whole repository and I couldn't find the image, so I'm a bit lost on where I should upload it

fabaff · 2017-06-05T20:37:45Z

Images for brands are located in source/images/supported_brands. PNG is preferred because it allows a transparent background. Size doesn't really matter as the images will be scaled anyway. Something between 200px and 400px usually works well.

jcastro · 2017-06-05T20:52:57Z

@fabaff thanks! I tried to upload a new image but it says I have no permissions. I'm attaching it here in case you can do it?

Tweaks on info table

Landrash · 2017-06-07T05:49:02Z

File name is wrong for this documentation.

jcastro · 2017-06-07T08:14:46Z

@Landrash thanks for letting me know! I checked other switches and I followed same naming conventions. Would you mind telling me what's wrong in the file name?

Changed filename to .markdown

Landrash · 2017-06-07T14:59:38Z

@jcastro Filename of the documentation needed to end with .markdown. Changed it for you.

Landrash

Seems to be some information missing but looks good in general.

Landrash · 2017-06-07T14:59:09Z

source/_components/switch.xiaomi_vacuum.markdown

+and run the following command:
+
+```
+mirobo discover


There seems to be some part missing on how the end users obtains this software.

trisk · 2017-06-05T21:19:18Z

source/_components/switch.xiaomi_vacuum

+{% linkable_title Getting started %}
+
+To be able to communicate with the vacuum one needs to have its IP address as well as an encryption token.
+This token is only attainable before the device has been connected over the app to your local wifi.


You must retrieve the token before using the mobile app to connect the device to your wireless network.

trisk · 2017-06-05T21:20:06Z

source/_components/switch.xiaomi_vacuum

+```
+
+In order to fetch the token, reset the robot, connect to its the network its announcing (rockrobo-XXXX)
+and run the following command:


In order to fetch the token, reset the vacuum following the instructions in the manual. Then, connect to its built-in wireless network (**rockrobo-XXXX**) with a computer that has the [python-mirobo](https://github.com/rytilahti/python-mirobo) package installed. Run the following command:

trisk · 2017-06-05T21:26:05Z

source/_components/switch.xiaomi_vacuum

+```
+
+If the value is exactly as shown above, meaning a lot of f letters, then the vacuum has already been connected and it needs a reset.
+


The token is the value between the single quotes. If the value is exactly as shown above (`ffffffffffffffffffffffffffffffff`), the vacuum was previously configured and it needs to be reset to obtain a valid token.

Landrash · 2017-06-08T12:01:24Z

source/_components/switch.xiaomi_vacuum.markdown

+and run the following command:
+
+```bash
+mirobo discover


No information is provided on what needs to be installed for this command to be available.

In order to fetch the token, reset the vacuum following the instructions in the manual. Then, connect to its built-in wireless network (**rockrobo-XXXX**) with a computer that has the [python-mirobo](https://github.com/rytilahti/python-mirobo) package installed. Run the following command:

balloob · 2017-07-07T04:45:14Z

Please address the comments by Landrash.

trisk · 2017-07-08T03:27:48Z

source/_components/switch.xiaomi_vacuum.markdown

+{% linkable_title Getting started %}
+
+To be able to communicate with the vacuum one needs to have its IP address as well as an encryption token.
+This token is only attainable before the device has been connected over the app to your local wifi.


This sentence would be clearer as:
You must retrieve the token from the device before using the mobile app to connect it to your wireless network.

trisk · 2017-07-08T03:28:00Z

source/_components/switch.xiaomi_vacuum.markdown

+and run the following command:
+
+```bash
+mirobo discover


In order to fetch the token, reset the vacuum following the instructions in the manual. Then, connect to its built-in wireless network (**rockrobo-XXXX**) with a computer that has the [python-mirobo](https://github.com/rytilahti/python-mirobo) package installed. Run the following command:

trisk · 2017-07-08T03:28:54Z

source/_components/switch.xiaomi_vacuum.markdown

+INFO:mirobo.vacuum:  IP 192.168.8.1: Xiaomi Mi Robot Vacuum - token: b'ffffffffffffffffffffffffffffffff'
+```
+
+If the value is exactly as shown above, meaning a lot of f letters, then the vacuum has already been connected and it needs a reset.


The token is the value between the single quotes. If the value is exactly as shown above (`ffffffffffffffffffffffffffffffff`), the vacuum was previously configured and it needs to be reset to obtain a valid token.

bramkragten · 2017-07-09T17:51:27Z

@jcastro Could you also take this PR in the documentation?

home-assistant/core#8416

Here are the services and fields:

xiaomi_vacuum_command:
  description: Send command to the vacuum.
  fields:
    command:
      description: Command to execute
      example: 'set_dnd_timer'
    params:
      description: Parameters for the command
      example: '[22,0,6,0]'

xiaomi_vacuum_set_fanspeed:
  description: Set the fanspeed.
  fields:
    fanspeed:
      description: Fanspeed, between 0 and 100
      example: '60'

xiaomi_vacuum_remote_control_start:
  description: Start remote control of the vacuum. You can then move it with xiaomi_vacuum_move_remote_control.

xiaomi_vacuum_remote_control_stop:
  description: Stop remote control mode of the vacuum.

xiaomi_vacuum_remote_control_move:
  description: Remote control the vacuum, make sure you first set it in remote control mode. With xiaomi_vacuum_start_remote_control.
  fields:
    velocity:
      description: Speed, between -0.3 - 0.3
      example: '0.2'
    rotation:
      description: Rotation, between -180 degrees and 180 degrees
      example: '90'
    duration:
      description: Duration of the movement?
      example: '1500'

xiaomi_vacuum_remote_control:
  description: Remote control the vacuum, only makes one move and then stops.
  fields:
    velocity:
      description: Speed, between -0.3 - 0.3
      example: '0.2'
    rotation:
      description: Rotation, between -180 degrees and 180 degrees
      example: '90'
    duration:
      description: Duration of the movement?
      example: '1500'

jcastro

some changes

Update, collaboration from other users

Added WIP token instructions based on some reading

jcastro · 2017-07-09T19:59:33Z

@bramkragten sure, will add it!

jcastro · 2017-07-09T20:27:58Z

@bramkragten umm I'm a bit lost on how to structure it, mostly because I'm not too much into entities, attributes, services, etc... do you think a table like the ones here would be ok? https://home-assistant.io/components/media_player.plex/

bramkragten · 2017-07-09T20:30:51Z

@jcastro yeah, that would work fine!

Landrash

Looks good and will be merged since parent PR has been merged.

Landrash · 2017-07-10T07:38:36Z

@jcastro Want me to merge this as as and you'll create a new one for the services?

Spelling

jcastro · 2017-07-10T08:56:27Z

@Landrash sure, sounds good!

rytilahti · 2017-07-10T19:29:27Z

Thank you @jcastro for doing the leg work and thanks @Landrash for comments and for the merge!

Create switch.xiaomi_vacuum

851021d

First revision

jcastro mentioned this pull request Jun 5, 2017

Add component for xiaomi robot vacuum (switch.xiaomi_vacuum) home-assistant/core#7913

Merged

6 tasks

rytilahti reviewed Jun 5, 2017

View reviewed changes

jcastro added 2 commits June 5, 2017 17:51

Update switch.xiaomi_vacuum

72e0439

Tweaks in the copy

Update switch.xiaomi_vacuum

e54762b

rytilahti reviewed Jun 5, 2017

View reviewed changes

jcastro added 2 commits June 5, 2017 18:14

Update switch.xiaomi_vacuum

d4027c6

Update switch.xiaomi_vacuum

030e0b8

fabaff added the new-integration This PR adds documentation for a new Home Assistant integration label Jun 5, 2017

Update switch.xiaomi_vacuum

3a21acf

Tweaks on info table

Changed filename to .markdown

8dac663

Changed filename to .markdown

Landrash requested changes Jun 7, 2017

View reviewed changes

Update switch.xiaomi_vacuum.markdown

c4c714f

trisk suggested changes Jun 7, 2017

View reviewed changes

Landrash requested changes Jun 8, 2017

View reviewed changes

trisk reviewed Jul 8, 2017

View reviewed changes

trisk suggested changes Jul 8, 2017

View reviewed changes

jcastro commented Jul 9, 2017

View reviewed changes

Update switch.xiaomi_vacuum.markdown

d62a144

Update, collaboration from other users

Update switch.xiaomi_vacuum.markdown

14eafbf

Added WIP token instructions based on some reading

bramkragten mentioned this pull request Jul 9, 2017

Add services to Xiaomi vacuum (switch.xiaomi_vacuum) home-assistant/core#8416

Closed

2 tasks

Fix spelling and formatting

cc5288d

Landrash approved these changes Jul 10, 2017

View reviewed changes

Update switch.xiaomi_vacuum.markdown

3dba205

Spelling

Landrash merged commit c7d4a93 into home-assistant:next Jul 10, 2017

		@@ -0,0 +1,47 @@
		The `xiaomi_vacuum`switch platforms allows you to control the state of your [Xiaomi Mi Robot Vacuum](http://www.mi.com/roomrobot/).

		```

		If the value is exactly as shown above, meaning a lot of f letters, then the vacuum has already been connected and it needs a reset.

Uh oh!

Create switch.xiaomi_vacuum #2771

Create switch.xiaomi_vacuum #2771

Uh oh!

Conversation

jcastro commented Jun 5, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rytilahti Jun 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rytilahti commented Jun 5, 2017

Uh oh!

jcastro commented Jun 5, 2017

Uh oh!

jcastro commented Jun 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fabaff commented Jun 5, 2017

Uh oh!

jcastro commented Jun 5, 2017

Uh oh!

Landrash commented Jun 7, 2017

Uh oh!

jcastro commented Jun 7, 2017

Uh oh!

Landrash commented Jun 7, 2017

Uh oh!

Landrash left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

balloob commented Jul 7, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bramkragten commented Jul 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jcastro left a comment

Choose a reason for hiding this comment

Uh oh!

jcastro commented Jul 9, 2017

Uh oh!

jcastro commented Jul 9, 2017

Uh oh!

bramkragten commented Jul 9, 2017

Uh oh!

Landrash left a comment

Choose a reason for hiding this comment

Uh oh!

rytilahti Jun 5, 2017 •

edited

Loading

jcastro commented Jun 5, 2017 •

edited

Loading

bramkragten commented Jul 9, 2017 •

edited

Loading