From 20c8c18098dc3c6e0fc1fea23b29c10a165f00de Mon Sep 17 00:00:00 2001 From: Philipp Schmitt Date: Sun, 6 Aug 2017 11:09:12 +0200 Subject: [PATCH] Add documentation for roomba platform (#3136) --- source/_components/vacuum.roomba.markdown | 49 ++++++++++++++++++ .../images/supported_brands/irobot_roomba.png | Bin 0 -> 4210 bytes 2 files changed, 49 insertions(+) create mode 100644 source/_components/vacuum.roomba.markdown create mode 100644 source/images/supported_brands/irobot_roomba.png diff --git a/source/_components/vacuum.roomba.markdown b/source/_components/vacuum.roomba.markdown new file mode 100644 index 00000000000..bad1e9a82f9 --- /dev/null +++ b/source/_components/vacuum.roomba.markdown @@ -0,0 +1,49 @@ +--- +layout: page +title: "iRobot Roomba" +description: "Instructions how to integrate your Wi-Fi enabled Roomba within Home Assistant." +date: 2017-08-04 20:43 +sidebar: true +comments: false +sharing: true +footer: true +logo: irobot_roomba.png +ha_category: Hub +ha_release: 0.51 +--- + +The `roomba` component allows you to control your [Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx). + +

+This platform has only been tested with an iRobot Roomba 980, but should work find +with any Wi-Fi enabled Roomba like the 690, 890 or the 960. +

+ +To add your roomba vacuum to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +vacuum: + - platform: roomba + name: My Roomba + host: IP_ADDRESS_OR_HOSTNAME + username: BLID + password: PASSWORD +``` + +Configuration variables: + +- **host** (*Required*): Hostname or IP address of the Roomba. +- **username** (*Required*): Username (BLID). +- **password** (*Required*): Password. +- **certificate** (*Optional*): Path to your certificate store (Default: `/etc/ssl/certs/ca-certificates.crt`) +- **continuous** (*Optional*): Whether to operate in continuous mode (Default: `True`). + +

+The Roomba's MQTT server only allows a single connection. Enabling continuous +mode will force the App to connect via the cloud to your Roomba. [More info here](https://github.com/NickWaterton/Roomba980-Python#firmware-2xx-notes) +

+ +### Retrieving your credentials + +Please refer to [here](https://github.com/NickWaterton/Roomba980-Python#how-to-get-your-usernameblid-and-password) or [here](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) to retrieve both the BLID (username) and the password. diff --git a/source/images/supported_brands/irobot_roomba.png b/source/images/supported_brands/irobot_roomba.png new file mode 100644 index 0000000000000000000000000000000000000000..aeabd8c459d8a5ad21b3463eab4450784b487492 GIT binary patch literal 4210 zcmaJ_c|4Ts+aDxbj?!c+VW?DQv73oTc8Vru5J}S*jA6zsN@PeWTPZ?^B%w6+t+6DI zwM5#+(qb(#ii0d+_&wuy>U}?-_wCFdGxu}Pb$!3reO=%CzMkia!8lk;ODai%Kp<&b z8w*DeNQecD!^AfN-?>QfQQ$|BY3a&zqIxsW;^{=tAusA_qN;5G-iPQ&#Cx5iJtG=} zKq8tXtSi&i{s@Xd4S?YVHn8A;K)@RWGDZgn;t6CTQ}r~_heR=fOx4yyR7qYY5Ep%W zgnghn(U)WsLMJ+fIA94OWCGF)f4Vfs)4LPuNG5DC-P*EclO(NfhxXzRfd+Hh@Ms5TO%r-woy zRR8%v05-apH_Fk%>K`uP$^_!eWCo((@Uv&n!p`c#sB|B=HWG=1BXr<8I#9p@$~Z@1 z;)9_ShWbwg3nGI+Cj~M|REnwq5r3K*#592bk^XlH0fE0@DU5&81SAX|j1Pos!w`Zc z{WP?<|98`XfM3=OrX%rx;{AVt8Q61yM7Sf7K@Fl4fWmpJ3#bB7=5!*SNu^_{RR5n@ z#Q0K~RE94#P}SUgJ!`6(_ILt`BADE}?qzR}vZXMXcnX1NYheNba9|{o7s^l@X?e&% z$I8%L-#}a2(!fa9!qV)Jm6`S-b2FVoMutCqEvST`03wC?)7R^luP)-Zz5+o61Om(! zL^|mV(aVZX4NzTQIEwW9SS)^v_m8jFZ)4H1{H-q>2nH@F@Bb?I&nZAdg5fXm0vEsJ zPow~vrvu_{3hU1Vfi?}=S{%X#zx$dIT7ttVw}tmSjfc%tU=D3mtBg>r5OUnX(!fgc9d+BLB zI#-kXL-x`0GF}OFGXW=tBV)VrNq)iuY@rb`-wY{iah`X~cGmIs zUSIWzr5{Q4Fi^b8AmZTt5Sz*qTuw((VM0ADRJ`J|vq-CqD*cXMp$wb;< z@vQC#dc$H?qGGXIE-K%wXu+Sh^{-aigwV(pyQbF1Ygm2jebkj&k7DT`CsgD4V(}{b zHf*0Oa}5fLY8%?erMBe8f&hR2AD61+Gnyn?#NOtyrbdJ#rp^2CiaIVfKd!!uIqa#D zO1UJAU}%2CP=LACiTH+L#7 z=2l4%n%s~tWNG7D5_33JQO+H=k4iH6Z?Fl=WYK6*50mQ~45Qr%2Hy>1A0(7_Qn#gdTePaCAW0d zCy_Zv6Khyh+gfBlZtMY3`t+*60eLWdi{XkMsVJKVa4G!BlE6Q z-Q4tGZ1HRECUd!aapUJD(4;@w!Hx!|U@Nbez9qArGfl2L?=jHZS>oryvgg)z* zuR?nNX>PBS|JS0LU%t>?3`{ez<~^>l7!#Dl_Us@qH(?*CVJ(3y837@7H%_|aQ%&?n zS3e3T=O^?h`1$QRwX#`Bm(P~09ld{RIUI$lX3H)b2rHmXPquoJ9xD($LlX>)PW2&J z0*vHG*K44xnFWRAaEA|4UohYA+X=VIWFfO7i@4q&TRn_dV;hLZN&6%e(3kF8i=G&% z$8r|CmsSbxhI^A-~BBJg~5`_;L#A%rmXu5V&H=fV$L3wFOM{YITgpcF?4X!Dg_Lwd;N%k)L_v&*z#p zO||W0YXBum`>1%k7(=MM0TXds^v6ocM443|`w%ypCRwWj#2{J*{XE;J6Bl*H=k~6` z1Zw6D)9M$;Dxs0frGKs$V{{JO#mx&bYGjFAo2~vl_`|WItnWj_*|zhotEnJ-sM9viJLlx~XGo$SB-sQ<=Lop0+RaI6o$?J;nxUtR(`5Sugx z5=uP7xiRM`?>+R@ypdxuhs82%$(~bfEP)`eZ+z}#Wc@aXA_lJF%V3pH-zqJ^SKo11Nn^OaoBAq(P3x z>#goZYnn-kY+1_mb`PA>>77ll?e-+Mh9o5Dn)<)nENqj1AFIVwC zfqLdVxMbM?xoI{3r{ww#?K;Wb2Q@5l42JHph^KG$u`2!1!Ir~atSCaMUN4_v62T*H zkNE?<31~!MZ@UqVx|^cOku9?|w+2uk1WUYCGUkyHs-k0u+SEay1$}b8S0;T)ZHvF! zT)McRCw+ZfSYvj}3oIWupujz_-u6YcGFJf`xujj`xH`~?Saf_R!oySnGObI~y$2*u z6WJ;?(J0rhL(9$vC^T&gGMDn%L6;zKEeG|e1$AI!#SmgzV9o&$aADcAHWEAwP*3}X z47O57J?>5MG)-7=57K*INsGC>qZ6f)8nDjWlTu$us*T5-kEmPRX?9ozfIeFwvn(}y zS<6|+;O(3&ZOT-@7wZ4EojZIv)BrbF=~-N3rBElLc<3POscd@A_cERYw{KfuT}so_ z*T)M2h8XUXwCJ@3&$<^Flbo7{aPwPsl|pVS7@n(JPOInUi!&bO{Gg%$Vy)%y z$$82#6LyWw37*vQfl6Bs^@lKEHPxqLp6*`io?OzYHPD^OV%rYO_ExsS;O^eED?ISp z-4cFijC-3raNknaIP+p*LFR(VE*7-5t}k;xB_mR^H!(5c;pF!=qq|Gu+zr424E=K- zUI~+0IJ39z7<@UbIy7#gKc<}S?9M$+BhSNTWSShXTcV}NlV)0fxHAmF%FS0-OQ}K+ zw$U^T$lmv>&@x_$P^%lulu3cs6vn09Fe z-9a4N2Pe(`_CW~{a$`9zC^I!EJRakbhw|jQ;F1IL`>m9qE_Gk(XfV;En%JYr0 zd*Rs`hT%!}lI0SZZs|9DXbsdTV&1UsPj{EtU57(GDv!;v<(0=V&VSS8L3bMmKg0gz j$>9GyJAgaZHYkAXZ-Z4`w2~YIZvkvA9W08>PDTC){mX^3 literal 0 HcmV?d00001