Web Commands - ResgreenGroup/Botway-Documentation GitHub Wiki
Current Location: Home -> BotWay Web Portal-> Web Commands
Summary
The BotWay Web Portal can direct commands to be sent to selected robots. These commands will appear in the "Buddy View" tab of BotWay Web. They are customizable in the BotWay "Settings" tab.
Managing Web Commands in BotWay
The table below displays the settings dialogue window in BotWay. Navigate to the "Web" tab to see the window shown. The dialogue window will display two sections. The top section lists known robot types. The bottom section allows for assigning buttons in the BotWay Web portal to those robot types. Select a robot type in the list from the top section of the window. Its existing commands will populate in the table below. If there are no created buttons, the table will be blank.
For the selected robot, you can manage web commands using the following options:
- ➕ Add – Create a new web command.
- ✏️ Edit – Modify an existing web command. Must have selected an existing command to do this.
- 🗑 Remove – Delete a web command.
When choosing to add or edit a command, provide the following details:
| Field | Description |
|---|---|
| Button Text | The label displayed on the button. |
| Command | The command executed when the button is pressed. |
| Permission | The required permission level to access this button. |
The text in the command field must be a properly formed command. For RGRobotix units, these commands must be properly formed JSON key-value pairs enclosed in curly braces. For other units, take care to properly form the command. BotWay will not check for errors. When the changes are saved in BotWay, the buttons in BotWay Web will automatically synchronize.
Open BotWay Web and verify the buttons have updated and that they work. All Robots regardless of type will have three buttons by default: route change, go, and stop.
Example Workflow
- Select a robot from the upper table.
- Click Add to create a new command or Edit to modify an existing one.
- Fill in the Button Text, Command, and Permission Level.
- Click OK to save your changes.
- Your updates will automatically reflect in BotWayWeb.