BotWay First Time Installation and Setup - ResgreenGroup/Botway-Documentation GitHub Wiki

Current Location: Home->First Time Setup

If you are using a preconfigured Computer Image or Kiosk from RGGI it will be preconfigured already and tested. Otherwise, follow the instructions listed below.

Download Java 8 from Oracle

• This will require you to sign into an Oracle Account. This is normal for JRE installation. You can create an account for free!
• Run through the default installation procedure Image: Java Installation Screenshot

---

1. Download Mosquitto Broker from the link below
   • https://mosquitto.org/download/
   • Select the appropriate version (probably windows x64)
2. Install the Mosquitto broker software
   • No settings need to be changed
3. Open and edit the mosquitto.conf file
   • Usual location: C:\Program Files\mosquitto\
   • Open desired text editor in administrator mode.
   • We need to edit our file to have the following lines uncommented or added.
     • NOTE: The default file is very long but it is all commented out. You can choose to just copy and paste the settings below overwriting everything or just add the 7 lines below under the section titled Listeners

     • listener 1883 0.0.0.0
       protocol mqtt
       allow_anonymous true
       
       listener 9001
       protocol websockets
       socket_domain ipv4
       allow_anonymous true
       

   • Save this file
4. Open services (windows only) to restart the Mosquitto broker manually to get the updated configuration

Image: Screenshot of Services in Windows to confirm Mosquitto Broker is running

---

1. Download and install MQTT Explorer

   • https://github.com/thomasnordquist/MQTT-Explorer/releases/download/v0.3.5/MQTT-Explorer-Setup-0.3.5.exe

2. Start MQTT Explorer

   

   • Be sure to fill in a Name for the connection, the Host IP (if MQTT explorer is running on the same computer as Mosquitto Broker or your Custom Broker you can use localhost or 127.0.0.1 for the host address)

     • Hit connect

       • You should now be connected to your MQTT broker and see $SYS

       

       • All new MQTT messages, topics, etc will show up here in explorer.
       • You can select a topic by clicking on it to view more data. More extensive video guide for MQTT Explorer here:
         • http://mqtt-explorer.com/video.mp4

---

BotWay supports 3 access levels: Admin, Operator, and Monitor. Access Levels are used to limit access to settings and features based on login status. By default Botway starts with Monitor access.

The table below shows the privileges for each access level.

Privilege	Admin	Operator	Monitor (logged out)
Settings Menu	✔️	❌	❌
Show Monitor	✔️	✔️	❌
Send Go	✔️	❌	❌
Send Stop	✔️	❌	❌
Send Route	✔️	❌	❌
Take Robot Offline	✔️	❌	❌
Show Logs	✔️	❌	❌
Rename Robot/Device	✔️	❌	❌
Remove Robot/Device	✔️	❌	❌
Add Job	✔️	✔️	❌
Remove Job	✔️	✔️	❌
Set Job Status	✔️	✔️	❌
Set Job Priority	✔️	✔️	❌
Set Staging Status	✔️	✔️	❌
Tag Layout	✔️	❌	❌
Edit Tags	✔️	❌	❌
Edit Routes	✔️	❌	❌
Edit Buttons	✔️	❌	❌
Edit Triggers	✔️	❌	❌
Edit Cycles	✔️	❌	❌
Close BotWay	✔️	✔️	✔️

In order to change the default password, edit tags, triggers, etc you need to login as Admin. The login menu is located under File/Login. The default Admin password is RGGI!!

1. Select Login

2. Enter the Admin access level password

3. Check that Settings and Edit menu are now unlocked and accessible

4. Change the default Admin password by entering and confirming a new password under the Admin Login section and click OK to save it.

---

Note: A few properties, reserved for advanced settings, can only be change manually in the file. Only a qualified technician should edit the file directly.

Below is an explanation for each of the settings you can control from the settings menu.

• Logo Image
  • You can change the Logo that is displayed in the upper section of BotWay.
• Map Image
  • You can change the Map image that is displayed behind your Tags on the Dashboard Tab.
  • Instructions here: Changing Map Images
• Colors
  • You can change the Color of the text for Vehicles(robots) and Tags
• Job Queue
  • Completed Rows represents the number of Completed Jobs to be displayed at the top of the job queue.
  • Colors can be set for the various Job statuses Queued, Active, Staged or Completed.
• Monitor
  • The Monitor Tab can be enabled or disabled by the Show Monitor setting.
  • Lines controls the maximum number of lines to keep in the monitor window before throwing away the oldest messages (does NOT affect logs)
• Logs
  • Status Log Lines and Error Log Lines controls how many lines are visible in the log windows. The actual Log files do NOT truncate.
• Login
  • You can change the passwords for each access level under the Login section. You must type the new password and confirm it.
  • The OK button will be greyed out if the new password and confirmation do NOT match.
  • More Information: Setting Access Level Passwords

1. "botway.properties" is an XML file used to control the configuration of Botway. Most items are controllable via the File/Settings menu in Botway.
   Direct editing of this file should only be done by qualified technicians.
   • If manually editing this file, make sure BotWay is closed before edits are made.
   • Example File Path: C:\Users\RGGI\Desktop\BotWay.V2.4.0\botway.properties
   • Default file:

   • <properties rev="1">
         <cheatCode>1</cheatCode>
         <monitor>true</monitor>
         <monitorLimit>300</monitorLimit>
         <statusLogDisplayLines>55</statusLogDisplayLines>
         <errorLogDisplayLines>55</errorLogDisplayLines>
         <zoom>0.89</zoom>
         <mainRightSplit>1128</mainRightSplit>
         <logo>images\Logo.png</logo>
         <image>images\layout-3a.png</image>
         <mapHeaderColor>-16776961</mapHeaderColor>
         <mapFooterColor>-10066330</mapFooterColor>
         <jobsCompletedRows>5</jobsCompletedRows>
         <jobsQueuedColor>-3355444</jobsQueuedColor>
         <jobsActiveColor>-16711936</jobsActiveColor>
         <jobsStagedColor>-3342592</jobsStagedColor>
         <jobsCompletedColor>-6710887</jobsCompletedColor>
         <asar>true</asar>
         <asarRows>2</asarRows>
         <asarColumns>8</asarColumns>
         <asarInColor>-3342388</asarInColor>
         <asarOutColor>-3355393</asarOutColor>
         <mqtt>
             <host>127.0.0.1</host>
             <port>1883</port>
         <user/>
         <pass/>
         </mqtt>
         <robotInfo>
         <robot>
             <type>AGV</type>
         </robot>
         <robot>
         <type>AMR</type>
         </robot>
         <robot>
         <type>BigBuddy</type>
         </robot>
         <robot>
         <type>PullBuddy</type>
         </robot>
         <robot>
         <type>LilBuddy</type>
         </robot>
         <robot>
         <type>Fred</type>
         </robot>
         </robotInfo>
         <deviceInfo>
         <devi ce>
         <type>Button</type>
         </device>
         <device>
         <type>StackLight</type>
         </device>
         <device>
         <type>LedBar</type>
         </device>
         <device>
         <type>Lift</type>
         </device>
         <device>
         <type>ProxSensor</type>
         </device>
         </deviceInfo>
     </properties> 
     

---

1. Create an image of your Tape/Map Layout in .png format.
   • Recommended resolution for map images should be 1250px x 700px, Botway will resize the image, while preserving its aspect ratio, to best fill the map space.
   • Example Map Below: -
2. Add the image to the images folder in your Botway folder.
   • Example File Path: C:\Users\RGGI\Desktop\BotWay.V2.4.0\images
     -
3. Change the map image under File/Settings in Botway to match your new map file name.
   • 
4. Click OK to load your new map file as the background image in Botway.
   • NOTE: You may need to re-adjust your Tag locations on screen after changing your background image.

---

1. Access the "botway.properties" file in your Botway folder
   • More Information Here: Changing Properties and Settings
   • Confirm or edit the IP address and Port listed under the tag
   • NOTE: If your Broker and Botway are located on the same computer the default address of 127.0.0.1 (localhost) may be used. Otherwise, you must change the "host" tag to your Broker computer's IP address.

   • <mqtt>
       <host>127.0.0.1</host>
       <port>1883</port>
       <user/>
       <pass/>
     </mqtt>
     

2. Save the file and restart Botway.
3. Look for the connection confirmation in the Monitor Tab