Skip to content

Commit bb9c639

Browse files
author
Marek Kubiczek
committed
Add readme file for project3
Signed-off-by: Marek Kubiczek <[email protected]>
1 parent 5c1d2d0 commit bb9c639

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ CreatorKit project is spread across couple of organizations :-
3434
CreatorKit as of now has following projects :-
3535
* [Project 1](projects/Project_1.md)
3636
* [Project 2](projects/Project_2.md)
37+
* [Project 3](projects/Project_3.md)
3738

3839
## Getting Started
3940
Please refer [Getting Started](GettingStarted.md) guide for detailed steps that describes how to get CreatorKit up and running.

projects/Project_3.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
![Creator Logo](../images/creatorlogo.png)
2+
3+
# Project 3 - Relay controller
4+
5+
## Introduction
6+
7+
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.
8+
9+
## Steps
10+
To complete these steps, refer to the [Getting Started](../GettingStarted.md) for detailed descriptions of each action.
11+
12+
* Get the code: Refer [this](../GettingStarted.md#getting-the-code) if you want to build from source or get pre-built binaries.
13+
* [Boot](../GettingStarted.md#running-ci40-board) OpenWrt on Ci40
14+
* [Connect](../GettingStarted.md#connecting-ci40-to-the-internet) Ci40 to the Internet
15+
* [Make](https://console.creatordev.io/) an Creator Account if You don't have it yet
16+
* [Provision](https://github.com/CreatorKit/relay-gateway#app-provisioning) Ci40 to the Creator Device Server
17+
* 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
18+
* Use mobile application to controll relay state on Ci40
19+
20+
## How it works
21+
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.
22+
23+
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.
24+
25+
This project includes two applications
26+
27+
* [**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).
28+
* **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.

0 commit comments

Comments
 (0)