Name: serverless-language-translation
Owner: International Business Machines
Description: Create a communications channel using serverless technology to allow clients who speak different languages to seamlessly communicate with each other, built on Watson services.
Created: 2018-01-15 17:55:29.0
Updated: 2018-05-23 21:39:44.0
Pushed: 2018-05-23 21:39:48.0
Homepage: https://developer.ibm.com/code/patterns/deploy-serverless-multilingual-conference-room/
Size: 331
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
In this code pattern, we will create the workings for a multilingual chat room using OpenWhisk, Watson Text to Speech and Watson Language Translator. The MQTT messaging protocol is also leveraged, which allows each client to publish and subscribe to one or more channels. This repository contains a series of serverless functions which are called in sequence determined by the channel to which a message is submitted.
When the reader has completed this code pattern, they will understand how to:
To interact with the hosted offerings, the IBM Cloud CLI will need to be installed beforehand. The latest CLI releases can be found at the link here. An install script is maintained at the mentioned link, which can be executed with one of the following commands
c OSX
-fsSL https://clis.ng.bluemix.net/install/osx | sh
nux
-fsSL https://clis.ng.bluemix.net/install/linux | sh
wershell
New-Object Net.WebClient).DownloadString('https://clis.ng.bluemix.net/install/powershell')
After installation is complete, confirm the CLI is working by printing the version
v
And then install the “Cloud Functions” plugin with
lugin install Cloud-Functions -r Bluemix
If the IBM Cloud Cli was already installed, please make sure the Cloud Functions plugin is the latest version with
lugin update cloud-functions
Create the required IBM Cloud services.
For SMS integration, create the following third party services.
Each service can be provisioned with the following steps
Navigate to the IBM Cloud dashboard at https://console.bluemix.net/ and click the “Catalog” button in the upper right
Type in the name of the service and select the resulting icon
Select the pricing plan and click “Create”. If deploying on an IBM Lite account, be sure to select the free “Lite” plan
After being provisioned, the Watson IoT Platform service will need a bit of additional configuration, as we'll need to generate a set of credentials for connecting to the broker. We can do so by entering the IoT Platform dashboard, selecting “Devices” from the left hand menu, and then clicking the “Add Device” button.
Next, provide a device type and ID.
The next few tabs (Device Information, Groups, Security) can be left as is with the default settings.
Clicking the “Finish” button will register a device and generate a set of credentials that can be used to publish messages to the IoT Platform. Be sure to take note of the Device type and Device ID, and place both in the cfcreds.env file.
We'll need to generate a different set of credentials to be able to publish and subscribe to the MQTT Broker
We can do so by selecting the “Apps” option in the left hand menu. Then, click the “Generate API Key” button
We can leave the fields in the “Information” blank and click next. In the “Permissions” tab, we'll select the “Backend Trusted Application” role. Once this is selected, click “Generate Key”
The result will give us an API Key and Authentication Token. These can be supplied as the username and password for a MQTT client. To make setup a bit easier, place these values in the cfcreds.env file as IOT_API_KEY and IOT_APP_AUTH_TOKEN
At this point, the values IOT_ORG_ID, IOT_DEVICE_TYPE, IOT_DEVICE_ID, IOT_AUTH_TOKEN, and IOT_API_TOKEN should be in the cfcreds.env file. In this example, we used the npm mqtt.js package, which can be installed with npm install -g mqtt. And then, we can run a sample MQTT publish/subscribe command to confirm that the credentials are valid.
Subscribe to the MQTT broker in one tab
ce cfcreds.env
_sub -i "a:${IOT_ORG_ID}:test" -u "${IOT_API_KEY}" -P "${IOT_AUTH_TOKEN}" -h "${IOT_ORG_ID}.messaging.internetofthings.ibmcloud.com" -p 1883 -t "iot-2/type/${IOT_DEVICE_TYPE}/id/${IOT_DEVICE_ID}/evt/fromClient/fmt/json"
And then publish in another
ce cfcreds.env
_pub -i "a:${IOT_ORG_ID}:client_pub" -u "${IOT_API_KEY}" -P "${IOT_AUTH_TOKEN}" -h 'agf5n9.messaging.internetofthings.ibmcloud.com' -p 1883 -t "iot-2/type/${IOT_DEVICE_TYPE}/id/${IOT_DEVICE_ID}/evt/fromClient/fmt/json" -m '{
"d" : {
"sourceLanguage" : "en",
"payload" : "test",
"client": "client1"
}
Upload each “Action” to the Cloud Functions codebase with the following commands.
sk action create translateText translateText.js
sk action create sendSMS sendSMS.js
sk action create iotPub iotPub.py
sk action create handleIncomingSMS handleIncomingSMS.js
After each action is created, set or bind default credentials for the corresponding services.
st IBM Cloud native service credentials can be easily imported to a Cloud function using the "service bind" command
wsk service bind <service> <action_name>
sk service bind language_translator translateText
sk service bind language_translator handleIncomingSMS
edentials for the Watson IoT Platform and third party services can be set using the "update command"
wsk action update <action_name> -p <param_name> <param_value>
sk action update iotPub -p iot_org_id "${IOT_ORG_ID}" -p iot_device_id "${IOT_DEVICE_ID}" -p iot_device_type "${IOT_DEVICE_TYPE}" -p iot_auth_token "${IOT_AUTH_TOKEN}" -p iot_api_key "${IOT_API_KEY}"
sk action update sendSMS -p twilioNumber "${TWILIO_NUMBER}" -p twilioSid "${TWILIO_SID}" -p twilioAuthToken "${TWILIO_AUTH_TOKEN}" -p redisUsername "${REDIS_USER}" -p redisPassword "${REDIS_PASSWORD}" -p redisHost "${REDIS_HOST}" -p redisPort "${REDIS_PORT}"
sk action update handleIncomingSMS -p twilioNumber "${TWILIO_NUMBER}" -p twilioSid "${TWILIO_SID}" -p twilioAuthToken "${TWILIO_AUTH_TOKEN}" -p redisUsername "${REDIS_USER}" -p redisPassword "${REDIS_PASSWORD}" -p redisHost "${REDIS_HOST}" -p redisPort "${REDIS_PORT}"
Create Triggers to represent events.
sk trigger create audioMsgReceived
sk trigger create txtMsgReceived
sk trigger create SMSMsgReceived
sk trigger create msgTranslated
Create Rules, which execute actions when certain triggers are activated.
wsk rule create RULE_NAME TRIGGER_NAME ACTION_NAME
sk rule create handleTxtMessage txtMsgReceived translateText
sk rule create handleMQTTMessage mqttMsgReceived translateText
sk rule create publishtoIOT msgTranslated iotPub
sk rule create publishtoSMS msgTranslated sendSMS
Install the MQTT package/feed found in the openwhisk-package-mqtt-watson submodule here. This “feed” enables OpenWhisk to subscribe to one or more MQTT topics and invoke actions in response to incoming messages. To see more on how feeds work with IBM Cloud Functions, please visit these documents
After the Feed has been deployed send a MQTT message to the topic registered with the feed like so
ce cfcreds.env
_pub -i "a:${IOT_ORG_ID}:client_pub" -u "${IOT_API_KEY}" -P "${IOT_AUTH_TOKEN}" -h 'agf5n9.messaging.internetofthings.ibmcloud.com' -p 1883 -t "iot-2/type/${IOT_DEVICE_TYPE}/id/${IOT_DEVICE_ID}/evt/fromClient/fmt/json" -m '{
"d" : {
"sourceLanguage" : "en",
"payload" : "test",
"client": "client1"
}
As soon as this command is published, we should be able to see a series of actions and triggers being called in the Cloud Functions logs. These logs can be viewed by visiting https://console.bluemix.net/openwhisk/dashboard or by running bx wsk activation poll in a separate tab.
If all you need is the server side logic, you can stop here. But optionally, you can deploy the UI provided by https://github.com/IBM/language-translation-ui. Be sure to source the cfcreds.env file beforehand, as the UI expects the IOT_ORG_ID, IOT_DEVICE_TYPE, IOT_DEVICE_ID, IOT_AUTH_TOKEN, and IOT_API_TOKEN values to be set as environment variables
clone https://github.com/IBM/language-translation-ui
anguage-translation-ui
install
start
When the npm start command succeeds, you should be able to access the UI at http://127.0.0.1:8080
Flow:
MQTT message received as JSON object to topic iot-2/type/'${deviceType}/id/${orgId}/evt/${eventName}/fmt/json
nt: "client_1234",
oad: "hello",
ceLanguage: "en"
Trigger associated with topic forwards message payload/language to translator action.
Translator action passes message payload through a loop, where each item is a language that the original message will be translated to. After translation is complete, another trigger will be fired, which kicks off two other “publish” actions simultaneously.
One action publishes results to all MQTT clients
The other action looks up SMS subscriber numbers/language in Redis and sends them the result via Twilio.