WorkShop_AcademiesHacks

The Workshop I leaded from AcademiesHack hackathon

Overview

Create a DialogFlow Agent which accepts end-user's queries. It extracts keywords (for example, the country name) from those queries and populates those keywords into a Firebase database. Next on Linux, it extracts those keywords from Firebase and displays it on Google Earth.

TODO

Installation

Set-Up Dialog Flow

1. Go to the Dialog Flow Website. Click Sign in wih Google, and sign in.
2. In the Left Panel, click on Create Agent.
3. A new window would have appeared in the middle of the page, at the top click on Agent name, and give your agent a name.
4. Click on CREATE.
5. After it creates, click on Entities on the left side of the page.
6. Then click on Create Entity.
7. Give your Entity a name by clicking on Entity Name, I named mine recognizeMotor.
8. Make sure that Define Synonyms and Allow automated expansion are checked.
9. Click on the first Click here to edit entry box.
10. For Enter Reference value enter the keyword you're checking for, I named mine Motor
11. For Enter Synonym enter words synonymous to your keyword
12. Click Save, then navigate to Intents on the left side of the page.
13. Then click on CREATE INTENT.
14. Give your Intent a name by clicking on Intent Name, I named my intent activateMotor.
15. Click on Contexts, followed by ADD CONTEXT. Now, type in an Input Context, I named mine ask_for_motor.
16. Click on Actions and parameters, followed by ADD PARAMETERS AND ACTION.
17. Under PARAMETER NAME, give it a name, I named mine Motor.
18. Under ENTITY, type in your entity made before, so I typed in @recognizeMotor.
19. Under VALUE, type in your Parameter Name, so I typed in $Motor.
20. Click SAVE.
21. Under Training Phrases, followed by ADD TRAINING PHRASES, type in some Phrases your end users will say. For example Activate Motor (Make sure there is a motor, or somthing synonymous in each training phrase). Keep adding new training phrases, as your phrases get populated, DialogFlow will highlight the country names in yellow, if it doesnt double click the keyword.
22. Scroll down to Fulfillment, followed by ADD FULFILLMENT, then check the Enable webhook call for this intent.
23. Click on SAVE.
24. Click back on Intents, then Default Welcome Intent.
25. Under Contexts, leave the input context blank, for the output context type in the Input Context you set for your previous intent. For me it was ask_for_motor. (If you forgot the name of your input context, then click back on Intents, then your other Intent. You should see your input context there)
26. Still in the Default Welcome Intent, scroll down to Responses. Type in Hi! Tell me when you want to turn on the motor.
27. Click on Save.

Set-Up Firebase Database

1. Go to the Firebase Website. Click on Get Started and sign in to your Google Account.
2. Under Your projects using Firebase, click on the project with the name of your Dialog Flow Agent.
3. Under Discover Firebase, click on Get Started for the Database box.
4. Scroll down and click on Cloud Firestone. 5.Scroll down to Realtime Database and then click on Create database
5. On the top of the page, next to Database, make sure it says Realtime Databse, if it doesn't, click on the small downward facing triangle, and select Realtime Database.
6. Make sure, you are under the data section, if not just click on data.
7. You should see null, hover over that then click on the small plus icon.
8. For Name, type in a name, I named mine motor State
9. Set the Value to the value which will change, I set mine to false*.
10. Lastly, click on the Add button.
11. Copy your database URL, it should end with .firebaseio.com/.

DialogFlow and Firebase Fulfillment

1. Head back over to Dialog Flow.
2. On the left panel, click on Fulfillment
3. Enable the Inline Editor, by clicking the Enabled button.
4. Make sure you are under index.js.
5. Delete all the code currently in the Inline Editor, and replace it with this.
6. In the code, replace FIREBASEURL with your database URL. When you copy your Database URL, remove the HTTPS://. It should look something like this: ws://NAME.firebaseio.com/.
7. In the code, replace NAME with the broad name from your database. Mine looks like this: return admin.database().ref('motorState').transaction((location) => {.
8. In the code, replace NAMEOFINTENT to what your intent name is. Mine looks like this: intentMap.set('AskLocation', handleLocation);
9. In the code, replace every occurence of (PARAMETER) to the name of your (PARAMETER). Mine was Motor
10. Click on DEPLOY.
11. After it deployes, you can test it out. On the Try it now field, type in a greeting (like hi, hello etc). It will respond Hi! Tell me when you want to turn on the motor. (Or whatever you set it to before). Then say something containing your keyword. It will respond.

Linux Installation

Use the termial for the installation

Set-Up Firebase CLI

1. Install all updates
   sudo apt-get update
sudo apt-get upgrade
2. Install curl:
   
   sudo apt-get install curl
3. Install node.js:
   curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs
4. Install Firebase CLI:
   npm install -g firebase-tools
5. Log in to Firebase:
   firebase login
   When you run this command, it will ask if Firebase can collect ULI usage and error, just type Y
   Then it will open a window, there you log into your Google Account
6. Initialize your Firebase CLI:
   firebase init
   When you run this command, it will ask you which features to select, select all of them. To select click on space, and to go down click on the down key. Click enter when you finish selecting them all.
   

Next, it will ask you to set up a default Firebase project. Select the project which contains your database, from the Set Up Firebase Section.

After that, just keep clicking enter. Until it asks for what language to use.

Chose JavaScript when it askes for what language to use for Cloud Function.
Then, type y for when it askes if you want to use ESLint
Next, type Y when it askes to install dependencies.
After that, click enter when it askes to use your public directory.
Then, type y for when it askes to configure it as a single-page app.
Finally, click enter for when it asks about Storage Rules.

Download Google Earth

1. On Linux, open the browser and go to the Google Earth download page.
2. Download and install it, by using the default software install (or any other way to install it).

Editing Google Earth

1. Navigate to Google Earth folder: cd /opt/google/earth/pro
2. Edit drivers.ini file with Root privileges: sudo nano drivers.ini Between SETTINGS{ and CPUVertexBlendEfficiency = 1.2, type in the following: ;ViewSync settings
ViewSync/queryFile = /tmp/query.txt
ViewSync/send = true
   Click Ctrl-X
   Then Y to Save
3. drivers.ini should look like this.

Controlling Google Earth

1. Download Script: wget https://raw.githubusercontent.com/MyWorldRules/LGxVoiceControl/master/LGScript.sh
2. Edit Script nano LGScript.sh
   Use the arrow keys to go down to firebase database:get /BROADNAME/country > messages.txt. Replace BROADNAME with the Broad Name from the Firebase database.
   Click Ctrl-X
   Then Y to Save
3. Give execute permission to the script: chmod +x LGScript.sh
4. Open Google Earth
5. Run the script: ./LGScript.sh Note: The first time you run the file, you will get a error. From the second time onward there will be no error.
6. To stop the script, simply click Ctrl-C