Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Victor committed Dec 13, 2016
1 parent 1a00615 commit 28bc5c3
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 17 deletions.
8 changes: 4 additions & 4 deletions recipes/conversation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This module provides Node.js code to get your Raspberry Pi to talk. It uses [Wat
## How It Works
- Listens for voice commands
- Sends audio from the microphone to the Watson Speech to Text Service - STT to transcribe [Watson Speech to Text](https://www.ibm.com/watson/developercloud/speech-to-text.html)
- Parses the text looking for the attention word
- Parses the text looking for the attention word
- Once the attention word is recognized, the text is sent to [Watson Conversation](https://www.ibm.com/watson/developercloud/conversation.html) to generate the response.
- The response is sent to [Watson Text to Speech](https://www.ibm.com/watson/developercloud/text-to-speech.html) to generate the audio file.
- The robot talks back the response through using the Alsa tools
Expand All @@ -24,7 +24,7 @@ Check out [this instructable] (http://www.instructables.com/id/Build-a-Talking-R
- [IBM TJBot](http://ibm.biz/mytjbot) - You can 3D print or laser cut the robot

##Build
Get the sample code and go to the application folder.
Get the sample code and go to the application folder. Please see this [instruction on how to clone](https://help.github.com/articles/cloning-a-repository/) a repository.

cd recipes/conversation

Expand All @@ -40,7 +40,7 @@ Set the audio output to your audio jack. For more audio channels, check the [con

amixer cset numid=3 1
// This sets the audio output to option 1 which is your Pi's Audio Jack. Option 0 = Auto, Option 2 = HDMI. An alternative is to type sudo raspi-config and change the audio to 3.5mm audio jack.

Update the Config file with your Bluemix credentials for all three Watson services.

edit config.js
Expand Down Expand Up @@ -74,7 +74,7 @@ The default voice of TJBot is set to a male voice (`en-US_MichaelVoice`) but you
// en-US_AllisonVoice
// en-US_LisaVoice
// en-US_MichaelVoice (the default)

# Dependencies List

- Watson Developer Cloud - [Watson Speech to Text](https://www.ibm.com/watson/developercloud/speech-to-text.html), [Watson Conversation](https://www.ibm.com/watson/developercloud/conversation.html), and [Watson Text to Speech](https://www.ibm.com/watson/developercloud/text-to-speech.html).
Expand Down
14 changes: 7 additions & 7 deletions recipes/sentiment_analysis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Check out [this instructable] (http://www.instructables.com/id/Make-Your-Robot-R
- [IBM TJBot](http://ibm.biz/mytjbot) - You can 3D print or laser cut the robot

##Build
Get the sample code and go to the application folder.
Get the sample code and go to the application folder. Please see this [instruction on how to clone](https://help.github.com/articles/cloning-a-repository/) a repository.

cd recipes/sentiment_analysis

Install Dependencies
Expand All @@ -32,7 +32,7 @@ Add your Bluemix Tone Analyzer credentials

edit config.js
enter your Watson Tone Analyzer username, password and version.

Since this module will be sourcing the text from Twitter, you will need valid [Twitter developer credentials](https://apps.twitter.com/) in the form of a set of consumer and access tokens/keys.

Add your Twitter credentials
Expand All @@ -56,7 +56,7 @@ If you have problems with the setup, please refer to [Adafruit's Neopixel on Ras
##Running

Start the application

sudo node sentiment.js

> Note the sudo command. Root user access is required to control the NeoPixel LEDs.
Expand All @@ -69,7 +69,7 @@ Doesn't your Pi show the right color? No worries, we can fix it. The LED library
Reboot and confirm no "snd" modules are running by executing the command "lsmod".

lsmod

## Customization
The default sentiment keyword is set to 'happy' but you can change it from config.js:

Expand All @@ -85,7 +85,7 @@ The default behaviour of the module assigns the following colors to sentiments.
| Joy | Yellow |
| Fear | Green |
| Disgust | Blue |
| Sadness | Magenta |
| Sadness | Magenta |

You can change this mapping by editing `sentiment.js` to add your favorite colors. Note that colors are specified using the hexademical format.

Expand All @@ -94,7 +94,7 @@ You can change this mapping by editing `sentiment.js` to add your favorite color
var blue = 0x0000ff ;
var yellow = 0xffff00 ;
var magenta = 0x00ffff ;

function processEmotion(emotion){
console.log("Current Emotion Around " + searchkeyword + " is ", emotion.tone_id);
if (emotion.tone_id == "anger"){
Expand Down
11 changes: 5 additions & 6 deletions recipes/speech_to_text/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Check out [this instructable] (http://www.instructables.com/id/Use-Your-Voice-to
- [IBM TJBot](http://ibm.biz/mytjbot) - You can 3D print or laser cut the robot

##Build
Get the sample code and go to the application folder.
Get the sample code and go to the application folder. Please see this [instruction on how to clone](https://help.github.com/articles/cloning-a-repository/) a repository.

cd recipes/speech_to_text

Install ALSA tools (required for recording audio on Raspberry Pi)
Expand Down Expand Up @@ -61,7 +61,7 @@ Start the application

> Note the `sudo` command. Root user access is required to control the NeoPixel LEDs.
Now talk to your microphone to change the color of the LED.
Now talk to your microphone to change the color of the LED.
Say "Turn the light blue" to change the light to blue. You can try other colors: yellow, green, orange, purple, magenta, red, blue, aqua, white). You can either say "Turn the light on" or "Turn the light off"!

Doesn't your Pi show the right color? No worries, we can fix it.
Expand All @@ -75,11 +75,11 @@ Reboot and confirm no "snd" modules are running by executing the command "lsmod"
lsmod

##Customization
You can add new colors to your color palette in stt.js. TJBot uses a NeoPixel RGB LED, which means it can show any combination of red, green, and blue.
You can add new colors to your color palette in stt.js. TJBot uses a NeoPixel RGB LED, which means it can show any combination of red, green, and blue.

We have hidden a disco party for you. Find the code for disco party in stt.js and uncomment the code. Now you can ask TJ to show you the disco lights by saying "Let's have a disco party"!

Try implementing your own TJBot party and share it with us #TJBot!
Try implementing your own TJBot party and share it with us #TJBot!

Once ready to move on, try the next recipe to [make TJBot respond to emotions using Watson](../sentiment_analysis).

Expand All @@ -91,4 +91,3 @@ Once ready to move on, try the next recipe to [make TJBot respond to emotions us

## Contributing
See [CONTRIBUTING.md](../../CONTRIBUTING.md).

0 comments on commit 28bc5c3

Please sign in to comment.