No announcement yet.

iRobot HS4 Plugin Manual

This is a sticky topic.
  • Filter
  • Time
  • Show
Clear All
new posts

    iRobot HS4 Plugin Manual

    The iRobot plugin for HS4 enables owners of iRobot robot vacuums and mops to integrate their robots with HS4. Real-time robot status is brought into HomeSeer, along with the ability to directly control your robot from within HS4's UI and events. For example, you might create an event to start your robot when you double-tap on a wall switch, or send the robot home when a door unlocks. For those robots that require light to operate (900 series, i7, j7, s9) you could automatically turn on lights when the robot starts after sunset and turn them back off again when it finishes.

    This HS4 plugin communicates with your robots directly over the local network via WiFi, so no Internet connection is required for normal operation. However, an Internet connection is required for initial setup to authenticate with the iRobot cloud and retrieve your robots' passwords. Be advised that the robot can only support a single LAN connection at a time, so if the iRobot HS4 plugin is running, the iRobot mobile app will communicate with your robot via the iRobot cloud. As long as you have an Internet connection both on the robot and on your mobile device, you won't notice any difference in operation communicating with the robot via the cloud as opposed to directly over the local network. However, some operations (such as changing the robot's WiFi details) can only be done over a direct network connection, so in these cases you will need to temporarily disable the iRobot HS4 plugin to enable your mobile device to connect to the robot directly over the local network.

    Install the iRobot plugin from the HS4 plugin store. Once installed and running, go to the Manage Robots page by either selecting Plugins > iRobot > Manage Robots in the top menu, or go to the Devices page, click or tap on Add Device, then select iRobot. Once you're on the Manage Robots page, you will see an interface like this:
    Click image for larger version  Name:	Manage Robots.png Views:	0 Size:	54.9 KB ID:	1544988
    The Robots section at the top shows all robots currently being monitored by the iRobot plugin. Naturally, no robots will be shown immediately after you install the plugin for the first time. Click or tap on Discover Robots to attempt to auto-discover robots on your local network. Under normal circumstances, this should work properly and you should see all iRobot robots that are connected to the same network as your HS4 HomeTroller. However, this might not work reliably on some networks, and in this case you will need to manually get your robot's IP address from the iRobot mobile app. Go to Robot Settings, then Wi-Fi Settings, and tap on Robot Wi-Fi Details. The robot's IP address will be shown under the IP Address heading.

    You can add a robot to HS4 directly after auto-discovering it, but you will need the robot's password to do so. This password is unique to each robot and is different from your iRobot Cloud password. Most likely, you'll want to use the Cloud Add feature to add your robots.

    To use Cloud Add, enter your iRobot account email address and password in the appropriate fields under the Cloud Add heading, then press Login. The plugin will authenticate with the iRobot cloud, and if successful you will see all robots linked to your iRobot account listed below. Press the Add button next to a robot to open the Add Robot dialog, which will automatically be filled out with the robot's IP address, BLID, and password. If the robot couldn't be discovered on your network, then the IP address field will be blank and you will need to provide it manually by retrieving it from your iRobot mobile app as described above.

    This initial login process is the only time that the iRobot plugin connects to the iRobot cloud, and therefore this is the only time when an Internet connection is required.

    Using Your Robot in HS4
    Once your robot is set up in HS4, you'll find a new device created for it along with a few different device features.
    • Status - Shows the status of the robot
      • On Home Base - The robot is on its charging dock
      • Cleaning - The robot is currently on a cleaning job
      • Job Paused - The robot is on a job, but the job is currently paused
      • Off Base - The robot is off its charging dock and isn't running a job
      • Stuck - The robot is stuck and needs your help
      • Returning To Home Base - The robot is returning to its charging dock, but not as part of a job. Most likely you pressed the home button.
      • Emptying Bin - The robot is auto-emptying its bin (i, j, and s series), but not as part of a job. Most likely you pressed the Empty Bin button.
      • Mapping Run - The robot is on a mapping run
    • Job Phase - Shows what phase of a cleaning job the robot is currently doing
      • No Job - The robot is currently not on a job. This will always be the case when the Status is not Cleaning, Returning To Home Base, or Emptying Bin
      • Cleaning - The robot is actively cleaning your space
      • Charging - The robot is on its charging dock and recharging before it heads back out to resume cleaning ("Recharge and Resume"; 900, i, j, and s series)
      • Emptying Bin - The robot is currently auto-emptying its bin (i, j, and s series)
      • Returning to Home Base to Recharge - The robot's battery is low and it's making its way back to the charging dock to recharge before resuming cleaning
      • Finished, Returning To Home Base - The robot is finished cleaning and is making its way back to the charging dock, at which point the job will be complete
    • Battery - Shows the level of the robot's battery
    • Bin/Tank - Shows the status of the robot's dust bin (vacuums) or water tank (mops)
      • OK - The bin or tank is present and is OK
      • Full - The dust bin is full (vacuums)
      • Empty - The water tank level is low, or the tank is not present in the robot (mops)
      • Removed - The dust bin is not present in the robot (vacuums)
      • Lid Open - The water tank's lid is open (mops)
    • Pad - Shows the status of the attached mopping pad (mops only)
      • None - No pad is attached, or the attached pad was not recognized
      • Disposable Wet - A disposable wet mopping pad is attached
      • Disposable Dry - A disposable dry mopping pad is attached
      • Reusable Wet - A reusable (washable) wet mopping pad is attached
      • Reusable Dry - A reusable (washable) dry mopping pad is attached
    • Readiness - Shows whether the robot is ready to start or resume a job
      • This status is communicated from the robot as a numerical code; if the plugin receives a code that it doesn't recognize then it will display "Not Ready", otherwise it will display the specific scenario which renders the robot not ready
    • Error - Shows an error code if the robot encounters an error
    Click image for larger version  Name:	Roomba i7.png Views:	0 Size:	62.1 KB ID:	1544989

    Robot IP Addresses
    The plugin will attempt to automatically discover a robot's new IP address on your network if the IP changes, but auto-discovery isn't 100% reliable. For best reliability, it's recommended to configure your robot to use a static IP.

    Supported Robots
    All Wi-Fi connected iRobot robots are supported, but only these robots have been directly tested:
    • Roomba 890
    • Roomba i7 (with clean base)
    • Braava jet m6
    If the plugin isn't working properly with your robot, please go to the Manage Robots page, send a debug report, then create a new topic in this forum and include your report ID.

    Source Code
    This plugin is open source. Source code and previous releases can be found on GitHub.

    Tried to install this through the HS4 add plugin page; is it available as of yet?


      Still waiting on HST approval.


        Ok is it possible to install from git hub files or shall I wait


          You could manually install it from GitHub if you want, though there's quite a lot of files.
          • HSPI_IRobot.exe and HSPI_IRobot.exe.config go in the root HomeSeer folder
          • Create an iRobot folder under bin and put all the .dll files in there
          • Create an iRobot folder under html and put the .html file in there
          • Ignore install.txt; it's only used by the HS4 plugin updater
          Once all the files are in place, restart HS4 and the plugin should appear on the installed plugins page.

          I'm going to open a ticket with HST to see if there's anything on my end that's holding up approval.


            Thanks will try later tonight keep you posted


              this looks great been waiting for this plugin....