.. _quickstart_index:

********
快速开始
********

本教程会用简单的示例来展示 |ZEUSIOT| 的大部分常用功能。可以快速了解到如何：

* 安装 |ZEUSIOT| 平台；
* 将设备接入平台；
* 定义告警规则、设备联动规则；
* 通过\ **设备调试**\ 来模拟上报数据；
* 配置产品，以复用属性、事件、服务、告警规则的定义。

..
  * 对接协议，以将设备的数据推送到平台；
  * 通过钉钉、邮件等方式推送告警、事件；
  * 配置数据源，以用于创建实时的数据展现；

为保持本教程的简洁，您仅会接入一个温度传感器和一个空调控制器。

* 温度传感器有以下要素：

  * 属性：温度。
  * 告警规则：温度过高。

* 空调控制器有以下要素：

  * 属性：电源状态。
  * 服务：制冷开机。

本教程最终将实现：

* 获取温度传感器的温度；
* 温度过高时发出告警；
* 在温度过高且空调关机时，让空调制冷开机。

.. contents::
  :local:

准备工作
========

需要有可访问的 |ZEUSIOT| 平台。最简单的是使用\ |live_demo|_\ 。也可以本地安装以进行更充分的体验。

使用在线 Demo
-------------

|live_demo| 的帐号信息如下：

* 全局超级管理员的用户名是 |demo_sadmin|，密码是 |demo_sadmin_pwd| ;
* 示例租户管理员的用户名是 |demo_tadmin|，密码是 |demo_tadmin_pwd| 。

为了使用\ |live_demo|\ 完成本示例，请用上面的示例租户管理员进行登录。

本地安装
--------

也可以参照\ :ref:`安装指南 <install_index>`\ 来本地安装 |ZEUSIOT| 平台。Linux 用户可用下面的命令来一键安装：

.. code-block:: bash
  
  #系统终端执行以下命令快速安装
  ## Centos7/Redhat7
  
  curl -L https://github.com/zmops/zeus-iot/raw/develop/docs/rhel/quick-install.sh | bash
  
  ## Ubuntu 20.04
  
  curl -L https://github.com/zmops/zeus-iot/raw/develop/docs/ubuntu/install.sh | bash

|ZEUSIOT| 平台的默认地址是 |local_url|，默认用户名是 |local_user| ，默认密码是 |local_pwd| 。

为了使用本地安装的环境完成本示例，请用上面的默认用户名登录即可。

步骤1：添加产品
===============

您会创建符合本教程目的的最简产品，请见下面的说明。产品的详细说明请见\ :ref:`产品配置 <product>`\ 。

步骤1.1：创建产品分类
---------------------

#. 进入\ **产品管理**\ →\ **产品分类**\ 列表页。点击\ **创建**\ 。
#. 填写产品分类的\ **名称**\ ，例如\ ``demo``\ 。点击\ **保存**\ 。
#. 创建的产品分类会列在\ **产品管理**\ →\ **产品分类**\ 里。

步骤1.2：创建产品的空框架
-------------------------

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。
#. 点击\ **创建**\ 以创建产品演示温度传感器。填写产品的必填字段，设置\ **产品ID**\ 为\ ``demo-temp``\ ，\ **产品名称**\ 为\ ``演示温度传感器``\ ，\ **产品分类**\ 为\ ``demo``\ ，\ **设备类型**\ 为\ ``直连设备``\ 。点击\ **保存**\ 。
#. 重复前一步，只是填写的属性略有不同，以创建产品演示空调控制器。设置\ **产品ID**\ 为\ ``demo-acc``\ ，\ **产品名称**\ 为\ ``演示空调控制器``\ 。
#. 上面新建的产品会列在\ **产品管理**\ →\ **产品**\ 里。

步骤1.3：添加产品属性
---------------------

* 给产品演示温度传感器创建属性温度。

  #. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击\ **产品名称**\ ``演示温度传感器``\ 进入产品详情页，点击顶部的\ **属性管理**\ ，再点击\ **创建**\ 。
  #. 设置\ **属性名称**\ 为\ ``温度``\ ，设置\ **标识符**\ 为\ ``temp``\ ，设置\ **来源类型**\ 为\ ``主动上报``\ ，设置\ **数据类型**\ 为\ ``小数``\ ，设置\ **单位**\ 为\ ``摄氏度/℃``\ 。点击\ **保存** \ 。

* 给产品演示空调控制器创建属性电源状态。

  #. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击\ **产品名称**\ ``演示空调控制器``\ 进入产品详情页，点击顶部的\ **属性管理**\ ，再点击\ **创建**\ 。
  #. 设置\ **属性名称**\ 为\ ``电源状态``\ ，设置\ **标识符**\ 为\ ``power_status``\ ，设置\ **来源类型**\ 为\ ``主动上报``\ ，设置\ **数据类型**\ 为\ ``字符``\ 。点击\ **保存** \ 。

步骤1.4：添加产品服务
---------------------

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击\ **产品名称**\ ``演示空调控制器``\ 进入产品详情页，点击顶部的\ **服务管理**\ ，再点击\ **创建**\ 。
#. 设置\ **服务名称**\ 为\ ``制冷开机``\ ，设置\ **标识符**\ 为\ ``power_on``\ ，设置\ **调用方式**\ 为\ ``异步``\ 。点击\ **保存** \ 。

步骤1.5：添加产品告警规则
-------------------------

#. 进入\ **产品管理**\ →\ **产品**\ 列表页。点击\ **产品名称**\ ``演示温度传感器``\ 进入产品详情页，点击顶部的\ **告警规则**\ ，再点击\ **创建**\ 。
#. 设置\ **告警名称**\ 为\ ``温度过高``\ ，设置\ **告警级别**\ 为\ ``高级``\ ，设置\ **启用告警规则**\ 为\ ``启用``\ ，设置\ **触发条件**\ 为满足下列\ ``任意``\ 条件：\ ``属性`` ``温度`` ``最新值`` ``>`` ``30``\ 。点击\ **保存** \ 。

步骤2：添加设备
===============

为了简洁，您会通过平台页面来手动添加设备。请见下面的说明。详细的说明请见\ :ref:`设备配置 <device>`\ 。

步骤2.1：创建设备组
-------------------

#. 进入\ **设备管理**\ →\ **设备组**\ 列表页。点击\ **创建**\ 。
#. 设置\ **设备组名**\ 为\ ``演示设备组``\ 。点击\ **保存** \ 。
#. 创建的设备组会列在\ **设备管理**\ →\ **设备组**\ 里。

步骤2.2：创建设备
-----------------

* 创建设备温度传感器01。

  #. 进入\ **设备管理**\ →\ **设备**\ 列表页。点击\ **创建**\ 。
  #. 设置\ **设备ID**\ 为\ ``device_temp01``\ ，设置\ **设备名称**\ 为\ ``温度传感器01``\ ，设置\ **产品**\ 为\ ``演示温度传感器``\ 。点击\ **保存** \ 。

* 创建设备空调控制器01。

  #. 进入\ **设备管理**\ →\ **设备**\ 列表页。点击\ **创建**\ 。
  #. 设置\ **设备ID**\ 为\ ``device_acc01``\ ，设置\ **设备名称**\ 为\ ``空调控制器01``\ ，设置\ **产品**\ 为\ ``演示空调控制器``\ 。点击\ **保存** \ 。

步骤3：配置设备告警规则/联动规则
================================

若需要添加\ *设备独有*\ 的告警规则或跨设备的联动规则，可以如下操作：

#. 进入\ **设备管理**\ →\ **设备**\ 列表页，点击\ **设备名称**\ ``温度传感器01``\ 进入设备详情页，点击顶部的\ **告警规则**\ ，再点击\ **创建**\ 。
#. 设置\ **告警名称**\ 为\ ``温度01过高开启空调01``\ ，设置\ **告警级别**\ 为\ ``提示``\ ，设置\ **启用**\ 为\ ``启用``\ ；
#. 设置\ **触发条件**\ 为满足下列\ ``所有``\ 条件：\ ``温度传感器01`` ``属性`` ``温度`` ``最新值`` ``>`` ``26``\ ，\ ``空调控制器01`` ``属性`` ``电源状态`` ``最新值`` ``=`` ``off``\ ；
#. 设置\ **执行动作**\ 为：\ ``空调控制器`` ``制冷开机``\ 。
#. 点击\ **保存** \ 。

.. note::
  关于 **联动规则** 与 **告警规则** 之间的关系：如果一条联动规则的触发条件包含多个设备，那么每个设备的告警规则里也都能看到该条联动规则。

步骤4：连接设备
===============

为了简洁，您会在下一步用\ **设备调试**\ 来实现。真实连接设备的详细说明请见开发指南里的\ :ref:`设备接入协议 <protocol>`\ 。

步骤5：触发告警规则&联动规则
============================

为了触发前面定义的告警规则和联动规则，您可使用\ :ref:`设备调试 <simulator>`\ 来模拟上报数据。告警规则与联动规则的触发逻辑是相同的。

* 触发联动规则：

  #. 进入\ **设备管理**\ →\ **设备调试**\ 。
  #. 在顶部\ **设备**\ 下拉框内选择\ ``空调控制器01``\ 。在左侧会显示已选设备的所有属性，勾选\ ``电源状态``\ 并输入\ ``off``\ ，点击\ **上报属性**\ 。此时在该设备详情页的\ **属性**\ 内可以看到最新的属性值。
  #. 在顶部\ **设备**\ 下拉框内选择\ ``温度传感器01``\ 。在左侧会显示已选设备的所有属性，勾选\ ``温度``\ 并输入\ ``26.1``\ ，点击\ **上报属性**\ 。此时在该设备详情页的\ **属性**\ 内可以看到最新的属性值。
  #. 此时会自动触发联动规则\ ``温度01过高开启空调01``\ 。在\ **告警管理**\ →\ **告警记录**\ 内可以看到该条记录。

* 触发告警规则：

  #. 进入\ **设备管理**\ →\ **设备调试**\ 。
  #. 在顶部\ **设备**\ 下拉框内选择\ ``温度传感器01``\ 。在左侧会显示已选设备的所有属性，勾选\ ``温度``\ 并输入\ ``30.1``\ ，点击\ **上报属性**\ 。此时在该设备详情页的\ **属性**\ 内可以看到最新的属性值。
  #. 此时会自动触发联动规则\ ``温度过高``\ 。在\ **告警管理**\ →\ **告警记录**\ 内可以看到该条记录。

..

  步骤6：配置展示数据源
  =====================

..
  继续阅读