iRobot Roomba i7+ Configuration using Rest980

[boelle (Bo Herrmannsen)]

the addon is there, i just get an error when i try to install

EDIT: step 1+3+4 done

as for step 3 i have only copied the vacuum folder to config folder
step 4 i have just installed rest980 and php-nginx. the step does not explain how to configure

the config looks like this for nginx:

an i assume that is ok since i uploaded to /config/vacuum

rest980_ config:

and i guess that i only need to update pass and blid from step 2

EDIT AGAIN: i found a windows based guide on how to get BLID and password and have updated the docker image config

Does that mean i can skip step 2?

[Syrius (Jeremy)]

Sorry all - was on vacation hence the lack of responding.

@fergalom

Have got my 2 floors working perfect now, thank you!

glad its working!

@fergalom

One question, I’m not clear how the map will change using the sate switch without having a manual selector on Lovelace or some additional code?

yeah it would need some additional code to get it working properly - will need some magic to get the logging to the right files and matching the background to the floor selected.

@patrick.scheidegger

SOLVED: Figured it out. A full restart of the server helped to clear things out and it worked.

The trusty have you tried turning it off and on again trick

@JeroenDeckers

Just have some time again working on this project.

what permissions are configured on this folder? does docker have the abillity to read/write to this folder? perhaps try setting full perms and work back

@finalbillybong1

struggling to find that correct url to call to clean a specfic room using the room ID’s

perform an example clean from the HA App and then navigate to -
http://<ip or fqdn of docker host>:<rest980port>/api/local/info/state
the content of the “lastcommand” section will be the body of the HTTP POST Command that you will use to initiate this request

The actual POST URL is
http://<ip or fqdn of docker host>:<rest980port>/api/local/action/cleanroom (this is the same as rest_command.vacuum_clean)

@JayArr84

i have a problem with roombapw Docker Image :

make sure your trying to pair a new handset, which should just be holding the home button, not both buttons.

@birdman

Any help would be very much appreciated…!

user_pmapv_id is bascially a timestamp of the map version - this is constantly changing and for some reason rest980 dosent seem to obtain this correctly. However you dont actually need to send this anymore review the lastest vacuum.log file for changes needed.

@sinkovcm

will this configuration also work with iRobot Braava jet moping robot?

not completley - there is underpinning missing attributes in rest980 for the braava. if i had one i would probably be fixing this myself - but unfortunatly i dont

@henry8866

top left corner should be where the base located, not sure why it is not connected with the vacuumed area

yeah it does that sometimes… i did add an attribute in the image.php file to exclude a defined number of initial entries in the file - this might help your case?

@boelle

clicking install gives this error: The command ‘/bin/sh -c npm install’ returned a non-zero code: 1

This appears to be linked to an NPM issue. It is affecting the node:alpine image from which roomapw is using - I have switched it over to node:boron and it now builds for me - try and see if this now works for you

@boelle

Does that mean i can skip step 2?

if you have the BLID/PW then you have completed step two - not skipped it

[boelle (Bo Herrmannsen)]

@Syrius

Sorry all - was on vacation hence the lack of responding.

We all need that, its just with the pandemic we get lots of it at home :-/

Did i get step 3 and 4 right?

currently getting roomdetails as in step 5… once that is done should secrets.yaml and vacuum.yaml just be placed in the vacuum folder?

i guess yes

EDIT: vacuum_notify: notify.mobile_app_xxxxxxx # You can also use a notify group here

what do i replace xxxxxxx with? and how do i find what to replace with?

EDIT2:

@Syrius

This appears to be linked to an NPM issue. It is affecting the node:alpine image from which roomapw is using - I have switched it over to node:boron and it now builds for me - try and see if this now works for you

yep works now, since i got the info via windows i dont need it but others might.

EDIT3:

vacuum.yaml what do we need to change in that one? i guess only parts where we see the list of rooms but i could be wrong. what i have in mind is the # Input Boolean section. It does have most of what i need except an office so i can remove those i dont need

EDIT4: floor.png and walls.png… can they be the same file? i have made a floorplan for the picture elemens thing on the front page. since that is made to scale (i spend hours with a messure tape to get it right) i thought that it would be perfect for this also. its made in svg (with inkscape) so i just need to save as png and mark the white as transparent?? OR as i just found out… maybe just have floor.png but do the floors need to be transparent? or ?

EDIT5: i copied over the example lovelace.yaml and i got this:

they should be there as i saved the vacum.yaml and secrets.yaml to the vacuum folder
also the maintaince items do not work

i can click to create but its the same when back

all items should be installed

EDIT6

when trying to create the service items it says the service is not there (in lower left corner)
but i did install the broker with default settings (ie i did not change anything just did the install)

EDIT 7

copy of the 2 yaml files to /config/ did not change anything
vacuum.yaml #################################### iRobot Vacuum Package################## - Pastebin.com
secrets.yaml #################################### Secrets################################ - Pastebin.com
image.php <?php//error_reporting(E_ALL);//ini_set('display_errors', 1);// ADJUST T - Pastebin.com

EDIT8:
http://xxxxxx/api/states/sensor.rest980 gives me an 401: Unauthorized
http://xxxxxx/image.php gives me a lot of “funny chars” but i get these error lines: Notice: Undefined offset: -1 in /config/vacuum/image.php on line 57Warning - Pastebin.com

[boelle (Bo Herrmannsen)]

So i’m somewhere between step 8 and 9 but at a loss what i have done wrong. Since its not working i must have screwed up at some point

did i provide enough info to figure it? if not let me know

EDIT1:

i changed the config for the mqtt brooker to allow anonymous
ie anonymous: true

now its down to this:

so the red colored error is gone

http://xxxxxx/api/states/sensor.rest980 gives me an 401: Unauthorized
http://xxxxxx/image.php gives me a lot of “funny chars” but i get these error lines: https://pastebin.com/G3r0gagk

so those did not change

[rrenovato (Rafael Renovato)]

Hi Everyone - I’m new to HA and don’t have much programming experience. I love this integration and got it to work with my Roomba i3+. However, most of the status displays as “unavailable” but I am able to connect to my roomba and also start, pause, and also dock it. Here’s a screenshot for reference. Any ideas what else I need to do to get this to work? Thanks in advance!

[Syrius (Jeremy)]

@boelle

Did i get step 3 and 4 right?

yep looks good.

@boelle

secrets.yaml and vacuum.yaml

no, secrets.yaml file should already exist in your config directory (next folder up) and for vacuum.yaml - you need to configure your HA enviornment to support packages (part of step 6)

@boelle

what do i replace xxxxxxx with? and how do i find what to replace with?

if you have the iphone app installed and working, navigate to Developer Tools, and on the Services tab, enter notify.mobile_app and if its configured, the name should be displayed for your device.

@boelle

EDIT4: floor.png and walls.png… can they be the same file?

you only need walls if your using fill mode.

@boelle

so i just need to save as png and mark the white as transparent?? OR as i just found out… maybe just have floor.png but do the floors need to be transparent?

for floors, nothing needs to be transparent. if you want to use fill mode, then you duplicate the floors file and make the floors transparent

the end result is layered

• walls
• robot lines
• floors

so the result is a nice looking map

@boelle

EDIT5: i copied over the example lovelace.yaml and i got this:

this wont work until you have the packages configued so all these entities actually exist.

@boelle

i can click to create but its the same when back

do you have MQTT discovery enabled?

@boelle

when trying to create the service items it says the service is not there (in lower left corner)

as above, need packages configued.

@boelle

copy of the 2 yaml files to /config/ did not change anything
vacuum.yaml #################################### iRobot Vacuum Package################## - Pastebin.com

refer above.

@boelle

http://xxxxxx/api/states/sensor.rest980 gives me an 401: Unauthorized
http://xxxxxx/image.php gives me a lot of “funny chars” but i get these error lines:

these errors will go away once packages is configured.

@boelle

i changed the config for the mqtt brooker to allow anonymous

can you show your config for MQTT ?

@rrenovato

Any ideas what else I need to do to get this to work?

have you followed the instructions here?

[boelle (Bo Herrmannsen)]

@Syrius

you need to configure your HA enviornment to support packages (part of step 6)

sorry for being a noob, but how is that done?

@Syrius

if you have the iphone app installed

only android here

@Syrius

you only need walls if your using fill mode.

so i can get away with just the overlay_image?

[boelle (Bo Herrmannsen)]

@Syrius

do you have MQTT discovery enabled?

i dont know, i just installed mqtt broker

[Syrius (Jeremy)]

@boelle

sorry for being a noob, but how is that done?

its described in the link to the packages page… for simplicirty try the following

in your config directory, create a new folder called packaged and put the vacuum.yaml in this folder.
edit configuration.yaml add the following

homeassistant:
  <existing stuff>
  packages: !include_dir_named packages

@boelle

only android here

those might not work for android, dont have one to test. you might need to comment out after
NOTICE THIS IS VALID FOR IOS USERS ONLY!

@boelle

so i can get away with just the overlay_image?

yes

[Syrius (Jeremy)]

@boelle

i dont know, i just installed mqtt broker

you need to configure it as an intergration also i expect?

[boelle (Bo Herrmannsen)]

it was just discovered, only took a few restarts… and part of the configure was to enable discovery… so i expect this one to be ok now

[boelle (Bo Herrmannsen)]

@Syrius

for simplicirty try the following

i read the page, problem for new people is that there are so many options that we dont know what to start with

i now get the error (in notifications)

Component error: packages - Integration ‘packages’ not found.

2:14:33 – Home Assistant Supervisor (ERROR)

so now looking where to find that integration… tried hacs and the add-on store

[boelle (Bo Herrmannsen)]

i read the packages page again and i simply dont get it

i creates packages folder in /config and put the vacuum.yaml in there

and i added to configuration.yaml

[Syrius (Jeremy)]

ok, replace

packages: !include_dir_named packages

with

homeassistant:
  packages: !include_dir_named packages

[boelle (Bo Herrmannsen)]

still http://192.168.0.9:3003/image.php gives those funny chars

and http://192.168.0.9:8123/api/states/sensor.rest980 is a no go

So i guess we are close, its 3.22 in the morning so will have to crawl to bed

what could be missing? should the map not show up automatic or do i need to run a clean from within HA ?

Clickin the right box gives this:

and clicking the gear icon

will this be a live view of the cam on the roomba?

[Syrius (Jeremy)]

you will need to run a clean first for the log to populate so it can generate a map

once the clean has run, in the vacuum directoy there should be a vacuum.log file which has a listing of the coordinates which the roomba has been. check that this exists first and is populated

[birdman (Andrew Bird)]

@Syrius

user_pmapv_id is bascially a timestamp of the map version - this is constantly changing and for some reason rest980 dosent seem to obtain this correctly. However you dont actually need to send this anymore review the lastest vacuum.log file for changes needed.

“you don’t actually need this anymore” pointed me in the right direction - I had an old version vacuum.yaml (from an aborted attempt to make this work a few months ago). Grabbed the new one, threw all of my config stuff into it, restarted HA and I can now selectively clean rooms from the HA interface. Awesome, thanks heaps for all of your efforts!

[boelle (Bo Herrmannsen)]

think its starting to fill the map

but a black map while its cleaning?

EDIT: changed the angle in image.php to -90 as to do 90 degree counter clockwise
EDIT2: it was black due to being transparent

Now i just need to move the lines so they match with the floorplan

what is left and right in offset? ie negative and positive number, tried it but got confused

what could cause the lines to be generated very slowly? i’m close to have the start of the lines where they should but still need to have them rotated

[boelle (Bo Herrmannsen)]

do i assume correct that with no offset speced 0,0 is in the upper left corner and that X is left/right and y is up/down?

that would help greatly in understanding how to set the offset so i can move the lines so they match the floorplan

it did draw the green lines at some point but it does not seem to do it on every run even thou i delete the log before each try, making it a bit confusing if it works or not

http://192.168.0.9:8123/api/states/sensor.rest980 should that give an 401 error?

so the logs is being build, sometimes i do see green lines on top of the floorplann, but mostly i just see a loading image error instead of the floorplan

[Syrius (Jeremy)]

@boelle

EDIT2: it was black due to being transparent

correct, this gets layerted over the floor.png file

@boelle

what could cause the lines to be generated very slowly? i’m close to have the start of the lines where they should but still need to have them rotated

lines are generated based on the nav points in the vacuum.log file

@boelle

do i assume correct that with no offset speced 0,0 is in the upper left corner and that X is left/right and y is up/down?

in theory

@boelle

it did draw the green lines at some point but it does not seem to do it on every run even thou i delete the log before each try, making it a bit confusing if it works or not

the log should be deleted automaticlly based on the automations in place.

@boelle

so the logs is being build, sometimes i do see green lines on top of the floorplann, but mostly i just see a loading image error instead of the floorplan

if the log file is populated, then it will show the green lines, if the log file is blank, then you will get the error.

@boelle

http://192.168.0.9:8123/api/states/sensor.rest980 should that give an 401 error?

if you try access this directly, then yes 401 indicates unauthoried. in the top of the image.php file you need to define a token which is uses for authentication to get the stats from HA