User Tools

Site Tools


avadroid_configure

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
avadroid_configure [2025/12/28 07:14] robynavadroid_configure [2026/01/02 17:22] (current) robyn
Line 2: Line 2:
  
 ==== Configuring AvaDroid ==== ==== Configuring AvaDroid ====
 +== Pre Configure ==
  
-In your terminal ''cd ~/avadroid/<name>/bot/config'' Edit config.json .. ''nano config.json'' \\ \\ +In your terminal on the machine running docker (SSH or console) ''cd ~/avadroid/<name>/bot/config'', where <name> is the folder named after your AvaDroid. Edit config.json .. ''nano config.json'' \\ \\ 
 Find the section that looks like:  Find the section that looks like: 
-<code json>"Corrade": {+<code j>"Corrade": {
     "Address": "corrade",     "Address": "corrade",
     "Port": 1883,     "Port": 1883,
Line 13: Line 14:
     "Topic": "topic"     "Topic": "topic"
   },</code>   },</code>
-   +   
 +Change  ''"Address": "corrade"''  to  ''"Address": "<IP Number of the Host Docker is on>"'' \\  %%Example: "Address": "192.168.1.10" Note the quotation marks as this is a string variable. %% \\  
 +   
 +Change ''"Port": 1883''   to   ''"Port": <Port Number mapped in compose.yml>'' \\  %%Example: "Port": 17001 the MQTT Port. Note NO quotation marks as this is an Integer variable. %% \\   
 +     
 +Change ''"NPort": 54377''    to   ''"NPort": <Port Number mapped in compose.yml>'' \\ %%Example: "NPort": 19001 the Nucleus Port. Note NO quotation marks as this is an Integer variable. %% 
 +\\ 
  
 +Change ''"Group": "group"''   to   ''"Group": "<The group you create in Avatar configuration>"'' \\  %%Example: You created the group The_Mob and invited your AvaDroid Avatar to it so, the change will be "Group": "The_Mob" Note the quotation marks as this is a string variable. %% \\
 +
 +Change ''"Password": "password"''   to  ''"Password": "<Password you set in Corrade Setup>"'' \\
 +%%Example: "Password": "MyP@ssW0rd1" if you allocated MyP@ssW0rd1 as your your super secret password. Note the quotation marks as this is a string variable. %% \\ 
 +
 +Change ''"Topic": "topic"''   to   ''"Topic": "<The group you create in Avatar configuration>/<Password you set in Corrade Setup>"''\\
 +%%Example: as above "Topic": "The_Mob/MyP@ssW0rd1" Note the "/" between group and password. Note the quotation marks as this is a string variable. Note there is no "," at the end of this line. %% \\ 
 +
 +So, using the example the JSON code after you have edited it:
 +
 +<code>"Corrade": {
 +    "Address": "192.168.1.10",
 +    "Port": 17001,
 +    "NPort": 19001,
 +    "Group": "The_Mob",
 +    "Password": "MyP@ssW0rd1",
 +    "Topic": "The_Mob/MyP@ssW0rd1"
 +  },</code>
 +
 +\\ 
 +Now save the config.json file, in nano that is ''CNTL x, y, <enter>'' \\ \\
 +Return to the avadroid/<name> directory (folder) by in the terminal entering ''cd ..''  (back to bot) then ''cd ..'' back to <name>. You should be back in /home/<your user>/avadroid/<name>. Do a pwd command in terminal to confirm if you wish. \\
 +
 +In Terminal type ''docker compose down'' Wait until all removed \\ Then ''docker compose up -d'' wait until all up \\ Then ''docker logs <name>-avadroid'' where <name> is the name of your AvaDroid. \\  
 +
 +You should get a return where the important information starts with [MQTT]. \\
 +Example: 
 +<code>
 +[MQTT] Connected to broker.
 +[MQTT] Subscribed to: The_Mob/MyP@ssW0rd1/local,message,parcel,lure,dialog,permission,alert,command,
 +ownersay,collision, The_Mob/MyP@ssW0rd1
 +</code> \\
 +Connected to Broker. Confirms the IP address and Port is correct. \\
 +Subscribed to: ... Confirms the Group and Password is correct and lists the subscriptions. \\ \\ 
 +We are done here, time for a Coffee, next step is to hit the GUI and finish the setup.  \\
 +
 +[[first_use|First time GUI access.]]  
  
avadroid_configure.1766934871.txt.gz · Last modified: by robyn