Skip to content

Latest commit

 

History

History
110 lines (88 loc) · 7.17 KB

README.md

File metadata and controls

110 lines (88 loc) · 7.17 KB
Raw

Build An IoT Smart Home Automation System Using Thingworx

Dec 14th @ in5 - Hands-on Internet Of Things workshop with Etisalat Digital.

At this session, we’ll create a modular solution using Etisalat's Thingworx IoT Platform to automate home controls like lights, locks and cameras over the internet. We’ll show you how to set up hardware attached to remote edge devices to be monitored and controlled over the internet in real time, sync and model device data with the cloud and build a web-based user interface to aggregate our functions.

At the culmination of the workshop, you will have all the tools and know-how to build your own custom system from scratch in a matter of hours.

Summary of steps

(Watch the live stream on http://www.facebook.com/makesmartthings)

Get started on the Thingworx console

1. Open up your web browser & navigate to http://<server IP Address>:<server port>/Thingworx/Composer/
2. Set ProjectContext to 'AssemblyUsers'
3. Create a new Application Key bound to your username and store the KeyID in a safe place
4. Create a new Thing called SmartHomeSystem_<userid> (eg; SmartHomeSystem_01) with base template RemoteThingWithFileTransfer & two boolean properties - Lock & LED
5. (Optional) If you have Postman or CURL - test out the REST Api to access these properties by sending the following HTTP request
		http://<server IP Address>:<server port>/Thingworx/Things/SmartHomeSystem_<userid>/properties/LED
		HTTP Headers - appKey: <keyid> , Content-Type: application/json

Build your mashup

Mashup is a web application built on the Thingworx platform - drag and drop - no coding needed
1. Create a new mashup called SmartHomeDashboard_<userid>
2. Add labels and shapes for LED & Lock properties
3. In the Data tab, add SmartHomeSystem_<userid> object & the GetPropertyValues function - select MashupLoaded
4. Drag GetPropertyValues->AllData->LED and drop on the LED Shape->Data property to bind function.  Do the same for Lock.
5. Add Autorefresh widget - bind Refresh to GetPropertyValues (to refresh on a timer)
6. Create a new State definition called OnOffState_<userid> - add 2 values - 'true' & 'false' and set Display Value to 'ON' & 'OFF'.  Set 'ON' to a style with a green background color and 'OFF' to one with a red background color.
7. Add the State Definition to state formatting for the two shapes in the mashup for LED and Lock

Create a file repository

1. Create a new Thing called FileRepo_<userid> with base template FileRepository
2. Add a FileUpload widget to your mashup
3. Run the mashup and use the widget to upload an image file called 'Camera.jpg' to your repository
4. From FileRepo_<userid> - run the GetFileListingWithLinks service to view your file's details
5. Delete the FileUpload widget from the mashup

Display your uploaded file in your mashup

1. Add a Value Display widget to your mashup
2. In the Data tab, add FileRepo_<userid>->LoadImage service, select MashupLoaded
3. Add 'Camera.jpg' for the path parameter for LoadImage
4. Bind LoadImage->Content to Value Display->Data

Configure EMS on Raspberry Pi

1. In microserver directory - edit config.json with IP Address& port of server and AppKey. Also specify HTTP server settings as 127.0.0.1 and give a port number for that as well (eg; 8000, 8080, 8084).
2. Start wsems.exe
3. Try CURL on Pi with HTTP request (as done earlier) - instead of specifying the server IP Address, specify the local EMS HTTP server address - you can leave out the AppKey header this time (Test commands listed in Misc/curlcommands.txt)

Transfer files to Thingworx repository using EMS

1. Add autobind parameters for SmartHomeSystem_<userid> in config.json - specify HTTP server port
2. Create a directory under the microserver folder on the Pi called 'images'
3. Add 'images' as a virtual directory in config.json
		"auto_bind": [{"name": "SmartHomeSystem_01", "port": 8080}],
		"file": {"virtual_dirs": [{"images": "images"}]}
4. Copy an image called 'Camera.jpg' to the images folder
5. Restart wsems
6. In the Thingworx console, open SmartHomeSystem_<userid> and see if it is listed as connected (green icon in top left corner)
7. Search for & open the built-in FileTransferSubsystem thing in the console
8. Call the Copy service from FileTransferSubsystem - set targetRepo='FileRepo_<userid>', targetFile = 'Camera.jpg', targetPath = "/", sourceRepo = 'SmartHomeSystem_<userid>", sourcePath = 'images', sourceFile = 'Camera.jpg'
9. Run GetFileListing service on FileRepo_<userid> thing to see that file copied

Connect Pi camera, lock and LED

Circuit Diagram

Circuit Diagram


connect-camera

Camera Connection


Run Python Code for functions on Pi

1. Drag the python files under misc folder and drop them to the Desktop on the Pi.
2. Make sure that the circuit from the daigram above is connected (LED, servo lock and the camera)
3. To test out any of the python scripts, open the Terminal -> cd Desktop -> python <pythonfile>.py
4. LedOn.py and LEDOff.py scripts trigger the LED on the Pi.
5. DoorOpen.py and DoorClose.py scripts trigger the Servo on the Pi.
6. Camera.py enables the camera, takes a picture and saves the image in the images directory, located in the microserver directory. It also records the time the picture was taken as a timestamp.
7. RefreshLedLock.py runs everytime a service is called and autorefreshes the LED and Lock value.

Bind SmartHomeSystem thing using LUAScriptResource

1. Edit config.lua, add
		scripts.SmartHomeSystem_01 = {
  	  file = "thing.lua",
  	template = "SmartHomeTemplate"
		}
2. Add SmartHomeTemplate.lua to microserver directory/etc/custom/templates
3. Run luaScriptResource.exe in the microserver directory

Bind Edge Virtual Thing to Thingworx Remote Thing

1. In console, delete LED, lock properties in SmartHomeSystem_<userid> Thing
2. In properties, select Manage Bindings, add LED, Lock & Timestamp properties
3. In services, select Browse Remote Services, add CaptureImage, ToggleLED, ToggleLock, UpdateLedandLock functions - test them out in console to see if they work with Pi

Modify mashup to use bound Remote Thing functionality

1. In Data tab, add CaptureImage, ToggleLED, ToggleLock, UpdateLedandLock from SmartHomeSystem_<userid>, select MashupLoaded only for UpdateLedandLock
2. Bind UpdateLedandLock to Auto-refresh
3. Bind UpdateLedandLock->ServiceInvokeCompleted to GetPropertyValues (remove GetPropertyValues connection to Refresh)
4. Add buttons for toggling LED & lock, bind Clicked to ToggleLED & ToggleLock functions
5. Bind ToggleLock & ToggleLED ->ServiceInvokeCompleted to GetPropertyValues
6. Add timestamp label, bind to All Data->Timestamp from GetPropertyValues
7. In Data tab, add FileSubSystem->Copy service (with same parameters as above)
8. Bind CaptureImage->ServiceInvokeCompleted to the Copy service
9. Bind Copy->ServiceInvokeCompleted to LoadImage
10. Bind LoadImage->ServiceInvokeCompleted to GetPropertyValues (to retrieve timestamp)