# pando-cloud

**Repository Path**: i3cloud/pando-cloud

## Basic Information

- **Project Name**: pando-cloud
- **Description**: pando open source iot cloud.
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2016-08-09
- **Last Updated**: 2023-12-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# pando-cloud  [![Build Status](https://travis-ci.org/PandoCloud/pando-cloud.svg)](https://travis-ci.org/PandoCloud/pando-cloud)  [![Coverage Status](https://coveralls.io/repos/PandoCloud/pando-cloud/badge.svg?branch=master&service=github)](https://coveralls.io/github/PandoCloud/pando-cloud?branch=master) 

PandoCloud是Pando物联网解决方案的云平台部分。

[English Document](docs/en/README.md)

## 什么是Pando？

Pando是一套完全开源的物联网解决方案。致力于帮助开发者快速创建自己的物联网应用。它包含了如下的工具，协议和类库：

* Pando Cloud
* [Pando Embeded Framework](https://github.com/PandoCloud/pando-embeded-framework)
* [Pando Protocol](https://github.com/PandoCloud/pando-protocol)
* Mobile SDK for [Android](https://github.com/PandoCloud/pando-android-sdk) and [IOS](https://github.com/PandoCloud/pando-ios-sdk)
* IoT Explorer APP FreeIOT for [Android](https://github.com/PandoCloud/freeiot-android) and [IOS](https://github.com/PandoCloud/freeiot-ios)
* IoT Kit [Tisan](https://github.com/tisan-kit)

## 设计理念

Pando的目的是为了提供一套可应用于实际生产环境的的物联网解决方案。它并不是一个简单的用于演示物联网服务的测试demo。下面列举了实现这套方案我们需要关注的一些关键点：

* **物联网**: 应该提供一套物联网应用场景的最佳实践。
* **可靠性**: 应该被充分的测试，并少有缺陷。
* **分布式**: 可以方便的部署在单机和集群环境中。
* **可用性**: 提供容错能力，灾备能力，自我修复机制等。
* **扩展性**: 必须是模块化，可插拔。
* **易用性**: 易于学习的开发和部署方式。
* **通用性**: 通用的设计和深度的业务抽象。
* **高性能**: 在硬件能耗和网络带宽使用上要尽量降低。
* **安全性**: 避免降低入侵和破解的风险。
* **伸缩性**: 轻松管理数千乃至数亿级的物联网设备。

## 系统架构

![architecture](docs/img/architecture.jpeg)

系统采用三层架构。

### 接入层
接入层提供了使用不同协议的设备的通信连接，包括但不局限于HTTP协议，XMPP协议，MQTT协议，COAP协议。 

设备注册，身份验证和设备发现使用HTTP协议。目前，我们支持使用MQTT协议与设备进行通信。

### 业务层
逻辑业务层用于实现整个物联网面相设备的相关业务，例如设备管理和API等。

* **registry**: 负责维护平台级的配置信息和元数据。
* **devicemanger**: 设备管理器用于管理设备和处理设备的数据请求，并保持、监视设备状态。
* **apiprovider**: 为应用程序扩展提供Restful API，并在设备状态发生变化时通知应用服务器。
* **controller**: 管理设备接入服务，并且将设备请求路由到正确的接入服务。

### 核心服务层 

我们的核心服务所选择的开源程序：

* **mongodb**: 用mongodb做为设备的数据存储引擎。
* **mysql**: 用MySql存储同类型设备的全局配置信息。
* **redis**: 使用redis提供缓存服务。
* **nsq**: 异步通信消息队列做为消息通知中心。
* **etcd**: 高可用的键值存储系统,主要用于共享配置和服务发现。
* **ELK**: elk日志分析系统即Logstash+ElasticSearch+Kibana4的组合简称，主要用于日志记录和分析。

## 技术参考

* [micro-services](http://martinfowler.com/articles/microservices.html)
* [12-factor apps](http://12factor.net/)
* [GoLang](http://golang.org)
* [MQTT](http://mqtt.org/)
* [Docker](http://www.docker.com/)
* [MySQL](http://www.mysql.com/)
* [MongoDB](https://www.mongodb.org/)
* [redis](http://redis.io/)
* [etcd](https://github.com/coreos/etcd)
* [nsq](http://nsq.io/)
* [ELK](https://www.elastic.co/products)

## 快速开始

[快速开始](docs/zh-cn/quick-start/README.md)介绍如何在自己的服务器或者pc机上单机部署pando物联网云。

## 开发应用
基于pando平台的物联网应用分为**设备端**和**应用服务器**。

* **设备端**负责实现数据流的传输和管理，须符合[pando物联网应用协议](https://github.com/PandoCloud/pando-protocol)；我们提供了[Pando嵌入式开发框架](https://github.com/PandoCloud/pando-embeded-framework)封装了协议的实现，并支持移植到不同的硬件平台。也可根据[设备接入接口文档](./docs/zh-cn/api-doc/device.md)自行实现设备端移植。
* **应用服务器**负责实现设备管理和交互的业务逻辑，并负责和用户终端（如手机，pc，微信等）进行交互。应用服务区器通过REST API访问Pando云平台的HTTP接口来实现对设备的操作，并通过向云平台注册回调URL接收设备的状态变化的事件通知。具体可参考[应用服务器接口文档](./docs/zh-cn/api-doc/application.md)。

## 贡献项目
pando物联网平台是完全开源免费的物联网解决方案，欢迎大家以各种形式贡献项目。

* **反馈问题**：我们鼓励通过[提交Issue](https://github.com/PandoCloud/pando-cloud/issues/new)的方式反馈您在使用中遇到的疑问或问题。
* **提出建议**：同样，可以通过[提交Issue](https://github.com/PandoCloud/pando-cloud/issues/new)向我们提供改进意见，同时可以通过加入我们的讨论QQ群（488074716）或者参加我们主办的线下物联网技术沙龙一起讨论。
* **贡献代码**：非常欢迎有能力的朋友一起参与Pando物联网平台的开发，一起构建开放、免费、开源的物联网解决方案。请按照[贡献流程](./docs/zh-cn/contribution/work-flow.md)参与项目开发。