BotWay Web Portal - ResgreenGroup/Botway-Documentation GitHub Wiki
Current Location: Home->BotWay Web Portal
Summary
BotWay web portal is a browser-based application that provides monitoring and featured control of BotWay. BotWay Web needs to be loaded onto the computer that is running BotWay and an autorun needs to be setup to initialize it, but after it is running, any web browser can be used to interact with the BotWay instance it is connected to. BotWay Web has three modules: one for interacting with robots, one for interacting with job queues, and one for interacting with devices. Use BotWay to create new buttons in BotWay Web by logging in as an administrator in BotWay, going into the settings menu, navigating to the web tab, and managing button commands there.
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.
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 section for commands to be sent to the robot. The following commands are permanent:
- 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. Through BotWay, the user can define other commands to send to the robot from BotWayWeb. In this way, BotWayWeb can serve as a fully customizable command "remote control". Reference the Web Commands page for instructions on creating and managing web commands.
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.