Skip to content

GetStartedUsing.md

Latest commit

 

History

History
46 lines (40 loc) · 3.53 KB

GetStartedUsing.md

File metadata and controls

46 lines (40 loc) · 3.53 KB

#I want to use it!

Awesome! Here are the steps to get started. There are three main components:

  • Online-hub : this web component will act as the UI to handle configurations easily on the fly. (I host mine in Azure)
  • Local-hub : A device hosts the local-hub and will act as the brain for the whole automation hub. This portion lives in your home and is always running.
  • Your devices : these are the components that will interact through the hub.

##Setup the Online-Hub (Azure instructions here) 0. Place the online-hub folder on your machine 0. To use the online-hub straight out of the box, create a new Github application. Take note of the Client ID and Client Secret you will need this for later.

  • You will need to enter http://localhost:3000 as the Homepage URL.
  • You will need to enter http://localhost:3000/auth/github/callback as the Authorization callback URL
  • If you do not have a Github account, please sign up for one.
  1. If you are on a Mac or Linux machine run sh install.sh, if you are on a PC run install.bat. This will install the node modules needed in all the right places and rename public_securityCredentials.js to securityCredentials.js.
  2. Update securityCredentials.js with your own information
  • Enter the Github Client ID and Client Secret from earlier.
  • Add a custom session secret that is used by the online-hub to save session data.
  • Add http://localhost:3000/auth/github/callback for the CALLBACK_URL.
  • Add your github username in the allowed users and a custom secret. If you want to add more than one, add another user.
  1. Your website should now be operational and viewable at http://localhost:3000!
  2. Feel free to customize the login page to your own design whims.

##Setup the Local-Hub (RPi2 instructions here) 0. Install Nodejs v0.10.28 on your local-hub machine 0. Place the local-hub folder on the machine 0. Open up a terminal or command line window 0. If you are on a Mac or Linux machine run sh install.sh, if you are on a PC run install.bat. This will install the node modules needed in all the right places and rename public_securityCredentials.js to securityCredentials.js. 0. Update securityCredentials.js with your own information

  • The contents of this file are used to connect to the various services / devices.
  • The required portion needs to match one of the users that you put in the online-hub securityCredentials.js. This setting allows only your local-hub to connect to the online-hub.
  • The optional portions are for connecting to devices/services
  1. Run the local-hub.js program using node local-hub.js
  2. Your local-hub is now setup!
  3. If you ever want to update the local-hub with the latest possible devices, the easiest way will be to copy and replace the files (don't delete since that will remove your securityCredentials javascript file.

##Use It 0. Go to a browser and enter your website's url 0. Login using the authentication method of your choice. (I used Github) 0. Add scenarios or devices using the buttons on the website.

  • Some devices will require IP Addresses. If this is the case, you can find your device's IP Address in your router's webpage.
  1. Any changes you make will automatically be sent to your local-hub!

##If you want to contribute to our device library or add your own devices, learn more in the Device Creation Guidelines

###Go Back