BotWay Web Portal - ResgreenGroup/Botway-Documentation GitHub Wiki

Summary

BotWay web portal is a browser-based application that provides monitoring and featured control of BotWay. It can be viewed from any connected browser on any device. Use the portal to see status of all robots, change a robot's route, default a robot's laser view, change a job's status and more right from a mobile device with no need to be at the BotWay computer.

Using BotWay Web Portal

To connect with and use BotWay web Portal, your version of BotWay must be version 2.5.45 or later. To connect to BotWay Web Portal, open a web browser and type "http://x.x.x.x:3000" into the URL/search bar where x.x.x.x is the IP address of the BotWay computer. When connecting while on the same network as the BotWay computer, replace x.x.x.x with the IP address listed on the bottom banner in BotWay. When connecting from an outside network, replace x.x.x.x with the public outward-facing IP address of the BotWay computer.

Log in to BotWay web by clicking the "Login" option in the top banner and entering administrator credentials, then clicking enter. There are three sections in this portal. The Home screen allows for navigation to BotWay view, Buddy view, and Device view.

BotWay view will display all robot tiles and device tiles in the "Live View" tab and job queues and jobs in the "Job Queue(s)" tab.

Buddy view will allow for inspection of a single robot. A robot can be selected from the dropdown menu located at the top of the page. The tile will display the robot type, robot name, battery voltage, route, tag, and status. Below the status section is the "Extra Info" section that shows UUID, Battery voltage, last status, and error text. There is also a set of commands buttons that can be used to send the following commands to the robot:

  • The Route Dropdown List allows for selection of the route to be sent to the robot.
  • The "Send Route" button sends the route chosen in the dropdown list to the selected robot
  • "Go" sends the robot a go command. NOTE: This will command the robot to immediately go.
  • "Stop" sends the robot a stop command.
  • "Default Lasers" will change the banks used by both the front and rear safety lasers to a configurable setting.
  • "Direction Forward" will change the robot to a forward direction and cause it to use the forward facing tag reader and tape reader. Note: the robot should be stopped before changing direction.
  • "Direction Reverse" will change the robot to a reverse direction and cause it to use the rear facing tag reader and tape reader. Note: the robot should be stopped before changing direction.
  • "Pin Up" engages the actuator on the pin or hitch
  • "Pin Down" retracts the actuator on the pin or hitch.

Device View will allow for interaction with any devices connected to BotWay. These devices are visible in the devices tab on the left side of BotWay. When a button is selected, a virtual interface that represents the device will appear that allows the user to configure or activate it.