Skip to content

Commit

Permalink
Merge pull request #1 from Mediatek-Cloud/develop
Browse files Browse the repository at this point in the history
整理並更改路徑名稱、複製到中文版
  • Loading branch information
evenchange4 committed Apr 16, 2015
2 parents a3ac9d2 + 7f1fd51 commit af8bee7
Show file tree
Hide file tree
Showing 214 changed files with 3,528 additions and 57 deletions.
1 change: 0 additions & 1 deletion content/en/5_mobile_application.md

This file was deleted.

2 changes: 1 addition & 1 deletion content/en/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# **MediaTek Cloud Sandbox Introduction**
# **MediaTek Cloud Sandbox introduction**

MediaTek Cloud Sandbox(MCS) offers you the data and device management services commonly needed during the development and pre-commercial testing of Wearables and IoT devices. It frees you from having to develop your own cloud infrastructure to support prototype development.

Expand Down
39 changes: 19 additions & 20 deletions content/en/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,31 @@
# Summary

* [Introduction](README.md)
* [Key Concepts](key_concept/README.md)
* [Key concepts](key_concept/README.md)
* [Tutorial](tutorial/README.md)
* [Getting Started](tutorial/getting_started.md)
* [Create your first product](tutorial/create_your_first_product.md)
* [Getting started](tutorial/getting_started.md)
* [Create your first prototype](tutorial/create_your_first_prototype.md)
* [Create your test device](tutorial/create_your_first_device.md)
* [Manage your device](tutorial/manage_your_device.md)
* [Manage test device](tutorial/manage_test_device.md)
* [Manage your profile](tutorial/manage_your_profile.md)
* [Implementing using LinkIt ONE (Aster 2502) development Board](tutorial/implementing_using_linkit_one.md)
* [Implementing using LinkIt ONE (Aster 2502) development board](tutorial/implementing_using_linkit_one.md)
* [Implementing using LinkIt Connect 7681 development board](tutorial/implementing_using_mt7681_development_board.md)
* [Using Notification](tutorial/setting_notification.md)
* [Managing Firmware](tutorial/managing_firmware.md)
* [Using notification](tutorial/setting_notification.md)
* [Managing firmware](tutorial/managing_firmware.md)
* [Connect device](tutorial/connect_device.md)
* [Create my michael device](tutorial/create_my_michael_device.md)
* [Setting User Privilege](tutorial/28_using_notification.md)
* [API References](api_references/README.md)
* [DataPoints](api_references/data_read_write.md)
* [upload DataPoint](api_references/uploaddatapoint.md)
* [retrieve DataPoint](api_references/retrievedatapoint.md)
* [Device Management](api_references/device_management.md)
* [retrieve device Information](api_references/retrievedeviceinfo.md)
* [register a device](api_references/registerdevice.md)
* [deregsiter a device](api_references/deactivatedevice.md)
* [get connection](api_references/getconnection.md)
* [Setting user privilege](tutorial/setting_user_privilege.md)
* [API references](api_references/README.md)
* [Datapoint](api_references/datapoint.md)
* [Upload datapoint](api_references/upload_datapoint.md)
* [Retrieve datapoint](api_references/retrieve_datapoint.md)
* [Device management](api_references/device_management.md)
* [Retrieve device information](api_references/retrieve_device_info.md)
* [Register a device](api_references/register_device.md)
* [Deregsiter a device](api_references/deactivate_device.md)
* [Get connection](api_references/get_connection.md)
* [Data channel format](api_references/data_channel_format.md)
* [Command server format](api_references/command_server_format.md)
* [Mobile Application](6_mobile_application/README.md)
* [Mobile application](mobile_application/README.md)
* [FAQ](faq/README.md)
* [Terms of Use](terms_of_use/README.md)
* [Terms of use](terms_of_use/README.md)

1 change: 0 additions & 1 deletion content/en/api_references/7681_data_d.md

This file was deleted.

1 change: 1 addition & 0 deletions content/en/api_references/7681_data_format.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 7681 Data format
2 changes: 1 addition & 1 deletion content/en/api_references/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# API References
# API references

MediaTek Cloud Sandbox (MCS) have exposed RESTful APIs allowing you to build applications and services that is able to make meaningful communications with MCS for DataPoint upload and retrieves as well as requesting MCS to make TCP socket commands. MCS also based on the communication data uploaded, especially for time-series based data, translate into visual charts for easier reading to the users.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# commandDevice
# Command device

### Description

Expand Down
2 changes: 1 addition & 1 deletion content/en/api_references/command_read_write.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Command Read Write
# Command read write
1 change: 0 additions & 1 deletion content/en/api_references/data_read_write.md

This file was deleted.

1 change: 1 addition & 0 deletions content/en/api_references/datapoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Datapoint
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# deregisterDevice
# Deregister device

## Description

Expand Down
2 changes: 1 addition & 1 deletion content/en/api_references/device_management.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Device Management
# Device management
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# getConnection
# Get connection


## Description
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# registerDevice
# Register device

## Description

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# retrieveDataPoint
# Retrieve datapoint

## Description

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# retrieveDeviceInfo
# Retrieve device information

## Description

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# uploadDataPoint
# Upload datapoint

## Description

Expand Down
2 changes: 1 addition & 1 deletion content/en/faq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Currently, the time-zone is bind to your user profile timezone. Youcan change yo

Please click [here](http://mcs.mediatek.com/iot/mobile/android) or scan the QR code below to download the APK:

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/mobileapp_android.png)
![](../images/mobileapp_android.png)

The mobile app currently offers for Android only.

Expand Down
File renamed without changes.
1 change: 1 addition & 0 deletions content/en/mobile_application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Mobile application
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Mobile Application
# Mobile application

Mobile Application

Expand All @@ -7,7 +7,7 @@ Please click [here](http://mcs.mediatek.com/iot/mobile/android) or scan the QR c

(If you already installed previous version, you need to un-install the previous version and install the new version again.)

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/mobileapp_android.png)
![](../images/mobileapp_android.png)

The mobile app currently offers for Android only.

Expand All @@ -19,7 +19,7 @@ To install the app, you must have android v4.0 or above version, and open the ab

Once installed at first launch you will see the screen below:

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/Mobile/01.png)
![](../images/Mobile/01.png)


**Please note:**
Expand All @@ -29,15 +29,15 @@ Do not use login using labs@mediatek.com option. This feature is still under dev

Once logged in, you will be able to see devices that are created and belongs to you

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/3.png)
![](../images/3.png)

You can also click on any of your devices to see the device detail:

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/4.png)
![](../images/4.png)

For controller data channel you can fire commands, for data channel it shows the last datapoint. Mobile does not support for viewing history record in charts. For this current version, you will need to manually refresh the display by click on the upper right corner drop down menu and select "refresh"

There is a Plus-in-circle icon allows you to add new devices. Please note, the new devices funcion is currently not available. For Smart Connection you can use this feature to add LinkIt Connect 7681. For full instruction please refer to [2.Tutorial 2.7 Implementing using Linkit Connect 7681 development board](https://mcs.mediatek.com/v2console/supports/implementing_using_mt7681_development_board)

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/Mobile/04.png)
![](../images/Mobile/04.png)

2 changes: 1 addition & 1 deletion content/en/terms_of_use/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Terms of Use
# Terms of use


MediaTek Cloud Sandbox provides your essential cloud services to help building your applications in the world of Internet of Things. Your registration and use of our service and website is subject to the agreement of terms of use.
Expand Down
1 change: 0 additions & 1 deletion content/en/tutorial/create_my_michael_device.md

This file was deleted.

56 changes: 56 additions & 0 deletions content/en/tutorial/create_your_first_prototype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Create your first protptype

![](../images/content_img/content_img-08.jpg)

## How to create a prototype step by step


Step 1. Click Development on the top menu bar.

Step 2. Click Create button to create a new prototype.


![](../images/screenshot/screen_shot-01.jpg)



Step 3. Enter the Prototype name, version, and select chip type, industry and Click Save button. Your Prototype is created.

Step 4. Click Detail button of the prototype just created.


![](../images/screenshot/screen_shot-02.jpg)


After your prototype is created, you can start to set the data channel, notification, user privilege, create and view test devices in the prototype detail page.



Step 5. Click Add in the data channel tab.

![](../images/screenshot/screen_shot-03.jpg)



Step 6. Select the Data Channel type. eg, Controller, Display, or Hybrid. And Click Add button.

![](../images/screenshot/screen_shot-04.jpg)


Step 7. Enter the Data Channel name, Id, description and select Data type.


Step 8. Click Save button. And now you can start create test devices for the prototype!


![](../images/screenshot/screen_shot-05.jpg)


For more Data Channel and Data Type information and concept, please refer to the Key concept section for more detail.







2 changes: 1 addition & 1 deletion content/en/tutorial/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Getting Started
# Getting started

Here are the four steps to connect MediaTek Cloud Sandbox to your development and product lifecycle:

Expand Down
File renamed without changes.
12 changes: 6 additions & 6 deletions content/en/tutorial/managing_firmware.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
# Managing Firmware
# Managing firmware

MediaTek Clous Sandbox(MCS) enables the user to manage the firmware and provides firmware Over-The-Air (FOTA) update to the device.

To use the Firmware service, go to the **Firmware tab** in the Prototype detail page. You can see there is a Default Firmware indicating your current firmware and you can set it as other uploaded firmwares' prerequisite to be upraded.

Click **Add firmware** to first upload a new firmware,

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/firmware/fw01.JPG)
![](../images/firmware/fw01.JPG)

Enter the Firmware name, version, and select a firmware file to upload and click the Upload button.

Next, select the compatible firmware of the fimrware you just uploaded.

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/firmware/fw02.jpg)
![](../images/firmware/fw02.jpg)

Choose the prerequisite firmware that are compatible for this firmware you've uploaded.

The default option is all firmware selected or you can specify your own selection by click on the limited firmware. Only the firmware listed in the prerequisite list can be upgraded using the firmware you've uploaded.

If you do not want to further proceed to directly pushing the firmware upgrade to test devices, you can stop here by clikc on the Done button, or to click on the Next button to push the firmware to devices.

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/firmware/fw03.JPG)
![](../images/firmware/fw03.JPG)

After selecting the devices you would like to upgrade, click the Push botton. You can also do this step by click on the first icon next to the firmware.

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/firmware/fw04.JPG)
![](../images/firmware/fw04.JPG)

The user can also upgrade the firmware of a device in the Device detail page. In the Device detail page, click on the frimware tab, and you will see the current using firmware and the firmware that the device can be upgraded to.

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/firmware/fw05.JPG)
![](../images/firmware/fw05.JPG)

Click on the **Upgrade** button next to the firmware that you want the device to be upgraded.

Expand Down
8 changes: 4 additions & 4 deletions content/en/tutorial/setting_notification.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Using Notification
# Using notification

The user can set the notification for a data channel when its value pass the limit of the defined range. The user will get email notification and the GCM notification using the mobile application.Please be noted that MCS currently only support notification for integer and float data channel type.


On the Prototype detail page, click on the **Notification** tab.

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/notification/not1.jpg)
![](../images/notification/not1.jpg)

CLick on the **Add notification** to enter the notification name and select the data channel you would like to set alert for. The rules include greater than, lower then, and equal to.

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/notification/not2.jpg)
![](../images/notification/not2.jpg)

Click Add button to save.

To have more than one data channel rules in a notification rule, all data channel rules need to be satisfied to trigger the notification(AND logic). The user can create separate notification rules to have the OR loigic.

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/notification/not3.jpg)
![](../images/notification/not3.jpg)

The test device will inherit all the notification rules from its parent prototype. The notification in the device cannot be editted and it will by default in on state.

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Setting User Privilege
# Setting user privilege


MediaTek Cloud Sandbox(MCS) allows the user to configure the access level for different prototypes and test devices. The user can find this setting in the **User Privivlege** tab in the Prototype detail or the Device detail pages.
Expand All @@ -13,12 +13,12 @@ MCS provides three roles:

As a prototype or device owner, or an administrator, you can add other registed MCS user to access the prototype or the test device by click on the privilege tab in the Prototype or Device detail pages.

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/UP/up01.JPG)
![](../images/UP/up01.JPG)


Click Add user to add other MCS registered user to access the prototype.

![](https://raw.githubusercontent.com/Mediatek-Cloud/MCS/master/graphics/UP/up02.JPG)
![](../images/UP/up02.JPG)

Enter the user email and select the rols as administrator or viewer, and click Save button.

Expand Down
38 changes: 38 additions & 0 deletions content/zh_TW/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# **MediaTek Cloud Sandbox introduction**

MediaTek Cloud Sandbox(MCS) offers you the data and device management services commonly needed during the development and pre-commercial testing of Wearables and IoT devices. It frees you from having to develop your own cloud infrastructure to support prototype development.

Using a RESTful API you collect data from your devices, which you can view in a powerful web-based dashboard that offers a range of display and graphing options. Then you can control your Wearables and IoT devices by issuing commands from the dashboard. In addition, a complementary smartphone app lets you review collected data and control your devices from anywhere.

![](images/content01.jpg)

MediaTek Cloud Sandbox lets you:

- Define Wearables and IoT prototype profiles and individual devices within a profile
- Push and Pull DataPoints between a device and the sandbox, using data types such as geo-location, temperature, humidity and more
- Remotely control your devices using state DataPoints, such as switch-state and more
- Visualize DataPoints graphically
- Receive notifications when DataPoints are collected or change
- Manage the life cycle of devices, as you would in your live implementation
- Manage and control remotely, using the complementary mobile app
- Create reports about prototypes, devices and collected data
- Perform FOTA firmware updates
- Control access to data and devices with granular security control

To support the use of these features, MediaTek Cloud Sandbox provides an API sandbox, API reference, FAQ and set of tutorials to ensure you can quickly get up to speed with the use of its features and facilities.


![](images/content_img/content_img-02.jpg)



MediaTek Cloud Sandbox is currently in closed-beta.




## **Prerequisites for Use**
To make use of MediaTek Cloud Sandbox you must:
1. [Register as a member of MediaTek Labs] (http://labs.mediatek.com/dpRegister/create)
2. [Sign-in to the MediaTek Cloud Sandbox] (http://mcs.mediatek.io/v2console)
3. Obtain a Device ID (API key) for each device added, for use in RESTful API calls
Loading

0 comments on commit af8bee7

Please sign in to comment.