Skip to content

HS4 Events

Alex Corn edited this page Jun 5, 2022 · 3 revisions

As of version 2, the iRobot plugin registers triggers and actions for use with HS4 events.

Triggers

A new entry will be available under the trigger selection when creating an event in HS4: "iRobot: A robot is..."

Once you select this trigger option, you will be presented with three sub-options:

  • A robot begins/is navigating the space
  • A robot stops/is not navigating the space
  • A robot begins/is downloading a software update

Once you select one of these sub-options, you will be prompted to select a robot.

Navigating the Space

These triggers are convenience features intended to allow you to easily run events based on whether a robot is presently navigating your space. A robot is considered to be "navigating" if the robot's Status is "Cleaning", "Returning To Home Base", or "Mapping Run" and if its Job Phase is "Cleaning", "Returning to Home Base to Recharge", or "Finished, Returning To Home Base".

You could also think of these triggers as being called "a robot begins/is driving around your home".

These triggers are redundant in that they could be functionally created using standard HS4 "A device's value is..." triggers, but the combination of possible values to indicate a navigating robot would make such a trigger needlessly complex.

If used as a trigger (the first entry in an event, or the first entry after an "OR IF" block), then the "A robot begins/is navigating the space" trigger will be activated when the robot changes from not navigating to navigating. If used as a condition (after an "AND IF" block), then the trigger will pass only if the robot is currently navigating. The inverse is true for the other sub-option.

Downloading a Software Update

If used as a trigger (the first entry in an event, or the first entry after an "OR IF" block), then this trigger will be activated when the robot begins downloading a new software update. If used as a condition (after an "AND IF" block), then the trigger will pass only if the robot is currently downloading a software update.

After a software update is fully downloaded, the robot will reboot and the plugin will lose its connection to the robot.

Example Event

Actions

A new entry will be available under the action selection when creating an event in HS4: "iRobot Actions". Once you select this option, you will be prompted to select an action to perform on a robot.

Start Favorite Job

Once you select this action option, you will be prompted to select a robot and a favorite job. This won't work unless you've already saved a favorite job for that specific robot.

When the event is run, this action will start the selected favorite job (as long as the robot is connected and ready to start a new job).

Reboot Robot

Once you select this action option, you will be prompted to select a robot.

When the event is run, this action will reboot the selected robot (as long as the robot is connected).

Change Robot Setting

Once you select this action option, you will be prompted to select a robot, a setting to change, and what you want to change that setting to.

When the event is run, this action will change the selected setting to the selected value on the robot that you chose (as long as the robot is connected).

Example Event