BotWay Getting Started - ResgreenGroup/Botway-Documentation GitHub Wiki
Current Location Home -> Getting Started
This page is a guide to configuring BotWay for the first time. It describes the process of logging in, uploading a map image, making tags, and making routes. The next set of introductory instructions for configuring BotWay can be found on the Level 2 Page.
For information on installing BotWay and supporting software see BotWay Installation and Setup Guide
Double click on the BotWay.jar file. BotWay should be completely unconfigured and look like the following image.
Image: Completely new instance of BotWay
Open the "files" dropdown menu from the main toolbar and click the "Login" option. The default password for Admin is RGGI!! The login process is shown in the following images.
Image: Opening the "files" menu.
Image: Logged into BotWay.
Open the "Files" menu and select the "Settings" option. In the window that appears, click the folder icon in the "map" section to open a file browser. Acceptable Image formats are .png, .bitmap, .gif, and .jpg. A full description of everything in the settings window can be found on the Settings Page. The following images show the settings dialogue window and the map file browser.
Image: Settings window.
Image: Map file browser.
Image: BotWay with a map uploaded.
The user must be logged in as Admin to make changes. Click the "edit" button in the top left corner of the map display in the green map display toolbar. This reveals the "Save," "Cancel," and "Options" buttons. Click on the "Options" button, then click the "Tags" option from the menu that appears to open the tag creation and deletion dialogue window. Enter the IDs of tags that need to be created or deleted, then click "Add" or "Remove." Multiple IDs can be entered into the window at once as long as they are separated by commas, separated by spaces, or placed on their own lines.
The tag dialogue window recognizes number ranges. Rather than manually entering every number between 1 and 100, use a hyphen. Entering the text 1-100 will result in the creation or deletion of 100 tags with the IDs of every whole number between 1 and 100. In addition, the numbers can have prefixes or suffixes in the form of letters or words: The hyphen will work just as well for the range of RED001LEFT-RED150LEFT. In this case, 150 tags will be created, each beginning with RED and ending with LEFT. When entering a range of IDs, use a colon to specify a step amount other than 1. For example: if the text "1-100:3" is used, tags 1, 4, 7, 10, 13, 16, etc. will be created instead of the normal range.
When the tags are created, they appear on the map display in the top left corner. In order to interact with the tags, click the "Move Tag" toggle in the top right of the map display toolbar or press "alt + t". Hold "alt" and right click a tag to change its visibility: clicking once makes the tag translucent and removes the tag ID. Clicking twice renders the tag invisible but will still show the blue crosshair when hovering over it in "move tag" mode. Clicking three times reverts to full visibility. A full description of tags and their function in BotWay can be found on the Tags Page. The following images show the process of tag creation.
Image: Putting BotWay into Edit Mode.
Image: Tag dialog window.
Image: Tags placed on BotWay Map..
Routes are lookup tables. Each route contains a set of commands to be carried out at specific tags. When a mobile robot gets to a tag, it reports its route and its tag to BotWay or its internal computer. A lookup is performed to get the command associated with that route and tag. This means that tags can tell the mobile robot to do different things depending on which route the robot is on. Log in as admin, click the "edit" button, click the "options" button that appears, and select "routes" from the dropdown menu. This will open the route creation dialogue window as shown below.
Image: Route editor window.
Click on the "Add Route" button. A new dialogue window should appear that asks for the route name, mobile robot type, and first tag. Fill this information in, then click the "Ok" button. This will add a new route to the route list on the left sidebar and show a new line in the route table. Click on the line in the route table, then add new lines below it by clicking the "Insert Below" button. Highlight a column of cells in several lines and click the "Insert Below" button to add multiple lines at a time. The process should look like the following 2 images.
Image: Route editor with new route dialogue window.
Image: Route Editor new route with empty lines.
When a cell is selected, the information in the whole row for that cell will appear in the sidebar on the right of the route table. The information in the route, tag, robot, delay, and jump columns will be in the top-right of the sidebar and the command will be in the bottom-right. selecting a column of cells across multiple rows will only populate the fields that all selected rows have in common and leave the other fields blank.
To make a command from scratch, toggle the "Add Missing Keys" circle next to the "COMMAND" header. Go down the list and assign values to any keys that require them. Clicking in the value section should open a dropdown with all valid values for that key. Input custom values by clicking into the value field, typing the custom value, clicking the "enter" key, and clicking into another value field. If "enter" is not pressed, the custom value will not be saved. The mobile robot does not require every key in each command. If a key is not needed, leave the value field blank. A filled-out route will look like the following image. For a more detailed description of routes, go to the routes page.
Image: Route Editor with a filled-in route.