Difference between revisions of "webCoRE"
(→Getting started) |
|||
| Line 3: | Line 3: | ||
The ''web Community's own Rule Engine'' (or for short, webCoRE) is a general rule engine for SmartThings. It works by allowing users to create scripts that are interpreted and executed by the SmartThings SmartApp, allowing for complex decisions. | The ''web Community's own Rule Engine'' (or for short, webCoRE) is a general rule engine for SmartThings. It works by allowing users to create scripts that are interpreted and executed by the SmartThings SmartApp, allowing for complex decisions. | ||
| − | webCoRE is currently in the [https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha Alpha phase of the software release lifecycle] which means it | + | |
| + | == Getting started == | ||
| + | |||
| + | {{warning|webCoRE is currently in the [https://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha Alpha phase of the software release lifecycle] which means it might be unstable. Crashes, bugs, and potentially data loss are expected. Anyone is welcome to try it out, but it should not be used for production purposes.}} | ||
| + | |||
| + | A few steps need to be completed befoure you can use webCoRE. First, webCoRE needs to be installed in your SmartThings account, then automations need to be configured. These are called [[Piston|pistons]] and will be detailed later. So let's start by installing webCoRE, please follow the 5 steps below. | ||
== Installing webCoRE == | == Installing webCoRE == | ||
| − | |||
You must complete all of these steps. | You must complete all of these steps. | ||
| − | # [[GitHub Install]] or [[Manual Install]] of webCoRE source code into the SmartThings Cloud | + | # [[GitHub Install]] or [[Manual Install]] of webCoRE source code into the SmartThings Cloud |
| − | # [[Enable webCoRE OAuth]] in the SmartThings cloud | + | # [[Enable webCoRE OAuth]] in the SmartThings cloud |
| − | # [[Install webCoRE]] in SmartThings mobile app | + | # [[Install webCoRE]] in the SmartThings mobile app |
| − | # [[Enabling webCoRE dashboard]] | + | # [[Enabling webCoRE dashboard]] |
# [[Enable webCoRE on Another Device]] | # [[Enable webCoRE on Another Device]] | ||
| − | == | + | == Understanding the basics == |
| + | webCoRE is comprised of three main components: | ||
| + | * the webCoRE child SmartApp (''webCoRE Piston'') | ||
| + | * the webCoRE parent SmartApp (''webCoRE'') | ||
| + | * the [https://en.wikipedia.org/wiki/HTML HTML] [[Dashboard|dashboard]] | ||
| − | == | + | == The webCoRE child SmartApp (''webCoRE Piston'') == |
| + | The webCoRE child SmartApp is also known as a [[Piston|piston]]. It is responsible for executing the automation script that the user creates and does the heavy lifting in the whole webCoRE ecosystem. It is directly managed by the webCoRE parent SmartApp, which can create, maintain, and delete a Piston. | ||
| − | == | + | == The webCoRE parent SmartApp (''webCoRE'') == |
| − | + | The wabCoRE parent SmartApp is the component responsible for managing the child SmartApp instances and their relationship with the Dashboard. It is the middle man that allows adding new Pistons, maintaining them, or deleting them. It is also responsible with the security of the whole ecosystem, allowing password secured access from the Dashboard. | |
| − | == | + | == The [https://en.wikipedia.org/wiki/HTML HTML] [[Dashboard|dashboard]] == |
| − | The | + | The Dashboard is an HTML interface for webCoRE that allows users to manage their webCoRE installation. It is the central hub to controlling webCoRE, allowing the user to create, modify, test, and delete Pistons. |
| − | |||
| − | |||
| − | + | == Creating your first piston == | |
| − | + | Once you finished the installation steps above, let's go ahead and create the first piston, the famous [[Hello World!|Hello World]]. | |
| − | [ | ||
Revision as of 14:13, 24 March 2017
Contents
General
The web Community's own Rule Engine (or for short, webCoRE) is a general rule engine for SmartThings. It works by allowing users to create scripts that are interpreted and executed by the SmartThings SmartApp, allowing for complex decisions.
Getting started
 Warning: | webCoRE is currently in the Alpha phase of the software release lifecycle which means it might be unstable. Crashes, bugs, and potentially data loss are expected. Anyone is welcome to try it out, but it should not be used for production purposes. |
A few steps need to be completed befoure you can use webCoRE. First, webCoRE needs to be installed in your SmartThings account, then automations need to be configured. These are called pistons and will be detailed later. So let's start by installing webCoRE, please follow the 5 steps below.
Installing webCoRE
You must complete all of these steps.
- GitHub Install or Manual Install of webCoRE source code into the SmartThings Cloud
- Enable webCoRE OAuth in the SmartThings cloud
- Install webCoRE in the SmartThings mobile app
- Enabling webCoRE dashboard
- Enable webCoRE on Another Device
Understanding the basics
webCoRE is comprised of three main components:
- the webCoRE child SmartApp (webCoRE Piston)
- the webCoRE parent SmartApp (webCoRE)
- the HTML dashboard
The webCoRE child SmartApp (webCoRE Piston)
The webCoRE child SmartApp is also known as a piston. It is responsible for executing the automation script that the user creates and does the heavy lifting in the whole webCoRE ecosystem. It is directly managed by the webCoRE parent SmartApp, which can create, maintain, and delete a Piston.
The webCoRE parent SmartApp (webCoRE)
The wabCoRE parent SmartApp is the component responsible for managing the child SmartApp instances and their relationship with the Dashboard. It is the middle man that allows adding new Pistons, maintaining them, or deleting them. It is also responsible with the security of the whole ecosystem, allowing password secured access from the Dashboard.
The HTML dashboard
The Dashboard is an HTML interface for webCoRE that allows users to manage their webCoRE installation. It is the central hub to controlling webCoRE, allowing the user to create, modify, test, and delete Pistons.
Creating your first piston
Once you finished the installation steps above, let's go ahead and create the first piston, the famous Hello World.
