-
Notifications
You must be signed in to change notification settings - Fork 8
Add readme file for project3 #42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mar3kk
wants to merge
1
commit into
CreatorKit:dev
Choose a base branch
from
mar3kk:project3_readme
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
|  | ||
|
|
||
| # Project 3 - Relay controller | ||
|
|
||
| ## Introduction | ||
|
|
||
| In this project mobile app is used to controll the relay click inserted on Ci40. Ci40 acts as a constrained device that is connected to Creator Device Server in cloud. Mobile app uses device server REST API to update IPSO resource on Ci40. Once Ci40 gets notification about IPSO resource update it changes relay state according to received value and responds with operation status. | ||
|
|
||
| ## Steps | ||
| To complete these steps, refer to the [Getting Started](../GettingStarted.md) for detailed descriptions of each action. | ||
|
|
||
| * Get the code: Refer [this](../GettingStarted.md#getting-the-code) if you want to build from source or get pre-built binaries. | ||
| * [Boot](../GettingStarted.md#running-ci40-board) OpenWrt on Ci40 | ||
| * [Connect](../GettingStarted.md#connecting-ci40-to-the-internet) Ci40 to the Internet | ||
| * [Make](https://console.creatordev.io/) an Creator Account if You don't have it yet | ||
| * [Provision](https://github.com/CreatorKit/relay-gateway#app-provisioning) Ci40 to the Creator Device Server | ||
| * Run mobile application ([Android](https://github.com/CreatorKit/mobile_power_switch) or [iOS](https://github.com/CreatorKit/mobile_ios_power_switch)) and log in using Creator Account credentials | ||
| * Use mobile application to controll relay state on Ci40 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. controll => control |
||
|
|
||
| ## How it works | ||
| The Ci40 acts as a constrained device in this project. It connects to the Internet (over Ethernet and Wi-Fi) and registers as a client to Creator Device Server. It observes IPSO digital output resource and changes relay state when notification is received. | ||
|
|
||
| Mobile app controls the IPSO digital output resource. It uses Creator Device Server REST API to change the IPSO resource which is then propagated to app running on Ci40. | ||
|
|
||
| This project includes two applications | ||
|
|
||
| * [**Relay Gateway**](https://github.com/CreatorKit/relay-gateway): Runs on Ci40 and observes IPSO digital output resource registered by itself. Updates relay state as per the changes received. For more info, read [this](https://github.com/CreatorKit/relay-gateway/blob/master/README.md). | ||
| * **Mobile power switch** ([Android](https://github.com/CreatorKit/mobile_power_switch) or [iOS](https://github.com/CreatorKit/mobile_ios_power_switch)): Runs on phone and allows to control relay using switch. For more information please refer to [Android](https://github.com/CreatorKit/motion-sensor/blob/master/README.md) and [iOS]() apps docs. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
controll => control