README.md 9.8 KB
Newer Older
K
Kaysar 已提交
1
<p align="left">
K
Kaysar 已提交
2
  <a href="https://iotsharp.io/">
K
Kaysar 已提交
3 4 5
    <img src="docs/static/img/logo_white.svg" width="360px" alt="IoTSharp logo" />
  </a>
</p>
麦壳饼's avatar
麦壳饼 已提交
6

麦壳饼's avatar
麦壳饼 已提交
7
[![Build status](https://ci.appveyor.com/api/projects/status/5o23f5vss89ct2lw/branch/master?svg=true)](https://ci.appveyor.com/project/MaiKeBing/iotsharp/branch/master)
麦壳饼's avatar
麦壳饼 已提交
8
![GitHub](https://img.shields.io/github/license/iotsharp/iotsharp.svg)
麦壳饼's avatar
麦壳饼 已提交
9 10 11
[![.NET Core build](https://github.com/IoTSharp/IoTSharp/actions/workflows/dotnet-build.yml/badge.svg)](https://github.com/IoTSharp/IoTSharp/actions/workflows/dotnet-build.yml)
[![pages-build-deployment](https://github.com/IoTSharp/IoTSharp/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/IoTSharp/IoTSharp/actions/workflows/pages/pages-build-deployment)
[![Building and Packaging](https://github.com/IoTSharp/IoTSharp/actions/workflows/dotnet-publish.yml/badge.svg)](https://github.com/IoTSharp/IoTSharp/actions/workflows/dotnet-publish.yml)
麦壳饼's avatar
麦壳饼 已提交
12 13 14
![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/maikebing/iotsharp?style=flat-square)
![Docker Pulls](https://img.shields.io/docker/pulls/maikebing/iotsharp)
![GitHub all releases](https://img.shields.io/github/downloads/iotsharp/iotsharp/total)
麦壳饼's avatar
麦壳饼 已提交
15 16 17
[![Total alerts](https://img.shields.io/lgtm/alerts/g/IoTSharp/IoTSharp.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/IoTSharp/IoTSharp/alerts/)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/IoTSharp/IoTSharp.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/IoTSharp/IoTSharp/context:javascript)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FIoTSharp%2FIoTSharp.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FIoTSharp%2FIoTSharp?ref=badge_shield)
麦壳饼's avatar
麦壳饼 已提交
18 19
[![star](https://gitee.com/IoTSharp/IoTSharp/badge/star.svg?theme=gvp)](https://gitee.com/IoTSharp/IoTSharp/stargazers)
[![fork](https://gitee.com/IoTSharp/IoTSharp/badge/fork.svg?theme=gvp)](https://gitee.com/IoTSharp/IoTSharp/members)
麦壳饼's avatar
麦壳饼 已提交
20

K
Kaysar 已提交
21

麦壳饼's avatar
麦壳饼 已提交
22
IoTSharp is an open-source IoT platform for data collection, processing, visualization, and device management.
麦壳饼's avatar
麦壳饼 已提交
23

麦壳饼's avatar
麦壳饼 已提交
24 25 26 27
## Here is a blessing for all users of this project
 * May you do good and not evil.
 * May you find forgiveness for yourself and forgive others.
 * May you share freely, never taking more than you give.
28

29

30
## What databases are supported?
麦壳饼's avatar
麦壳饼 已提交
31

32 33 34 35 36
 *  [PostgreSql](IoTSharp/appsettings.PostgreSql.json) The test environment is  PostgreSQL 11.3,Support for  sharding.
 *  [MySql](IoTSharp/appsettings.MySql.json) The test environment is MySQL 8.0.17,Support for  sharding.
 *  [Oracle](IoTSharp/appsettings.Oracle.json)  The test environment is  Oracle Standard Edition 12c Release 2 on CentOS , Support for  sharding.  See also: https://github.com/MaksymBilenko/docker-oracle-12c
 *  [SQLServer](IoTSharp/appsettings.SQLServer.json)  Microsoft SQL Server 2016 (RTM-GDR) (KB4019088) - 13.0.1742.0 (X64)   ,Support for  sharding
 *  [Sqlite](IoTSharp/appsettings.Sqlite.json) Support for  sharding
麦壳饼's avatar
麦壳饼 已提交
37
 *  [Cassandra](IoTSharp/appsettings.Cassandra.json)  
麦壳饼's avatar
麦壳饼 已提交
38

麦壳饼's avatar
麦壳饼 已提交
39 40 41 42 43 44 45 46 47 48
## What time series databases are supported??

 *  InfluxDB   
 *  IoTDB
 *  TDengine
 *  TimescaleDB
 *  PinusDB  
 *  Relational databases are also supported, either single tables or sharding.  


49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
## What EventBus Message Queue  are supported?

 *  RabbitMQ
 *  Kafka 
 *	InMemory 
 *	ZeroMQ 
 *	NATS 
 *	Pulsar 
 *	RedisStreams 
 *	AmazonSQS 
 *	AzureServiceBus 

## What EventBus Store are supported?
* PostgreSql,
* MongoDB,
* InMemory,
* LiteDB,
* MySql,
* SqlServer

麦壳饼's avatar
麦壳饼 已提交
69
## IoTShar Demo 
麦壳饼's avatar
麦壳饼 已提交
70 71 72 73 74 75
      
 - [IoTSharp front-end implemented using Angular](http://139.9.232.10:2927)
 - [IoTSharp front-end implemented using Vue3](http://demo.iotsharp.net)


##  IoTSharp cloud  
麦壳饼's avatar
麦壳饼 已提交
76
  https://cloud.iotsharp.net/
麦壳饼's avatar
麦壳饼 已提交
77

D
dd 已提交
78 79
## doc
  https://docs.iotsharp.net/
麦壳饼's avatar
麦壳饼 已提交
80

麦壳饼's avatar
麦壳饼 已提交
81
## How to deploy?
82

麦壳饼's avatar
麦壳饼 已提交
83 84 85
- [Deploy by Docker](https://docs.iotsharp.net/docs/tutorial-basics/deploy_by_docker)
- [Deploy to Linux](https://docs.iotsharp.net/docs/tutorial-basics/deploy_linux)
- [Deployed to Windows](https://docs.iotsharp.net/docs/tutorial-basics/deploy_win)
86

麦壳饼's avatar
麦壳饼 已提交
87
## How to configure?
麦壳饼's avatar
麦壳饼 已提交
88

麦壳饼's avatar
麦壳饼 已提交
89
- [AppSettings](https://docs.iotsharp.net/docs/tutorial-basics/appsettings) 
麦壳饼's avatar
麦壳饼 已提交
90 91 92

##  IoTSharp.SDKs

麦壳饼's avatar
麦壳饼 已提交
93 94 95
- IoTSharp.Sdk.Http   [![IoTSharp.Sdk.Http](https://img.shields.io/nuget/v/IoTSharp.Sdk.Http.svg)](https://www.nuget.org/packages/IoTSharp.Sdk.Http/)
- IoTSharp.Sdk.MQTT   [![IoTSharp.Sdk.MQTT](https://img.shields.io/nuget/v/IoTSharp.Sdk.MQTT.svg)](https://www.nuget.org/packages/IoTSharp.Sdk.MQTT/)

麦壳饼's avatar
麦壳饼 已提交
96
 
麦壳饼's avatar
麦壳饼 已提交
97 98 99

## IoTSharp-C-Client-Sdk

麦壳饼's avatar
麦壳饼 已提交
100
IoTSharp-C-client-Sdk is mqttt client, write by   c;
麦壳饼's avatar
麦壳饼 已提交
101

102
 [https://github.com/IoTSharp/IoTSharp.Sdks.MQTT-C](https://github.com/IoTSharp/IoTSharp.Sdks.MQTT-C)
麦壳饼's avatar
麦壳饼 已提交
103

104 105 106 107 108
## paho.mqtt.c's demo 

It' like IoTSharp-C-Client-Sdk, but is use paho.mqtt.c
 https://github.com/IoTSharp/IoTSharp.Edge.paho.mqtt.c

109
## IoTSharp for nanoFramework
110 111 112 113 114 115 116

IoTSharp.Edge.nanoFramework is a nanoFramework's mqtt client , it run on STM32 !

  https://github.com/IoTSharp/IoTSharp.Edge.nanoFramework

more info read https://www.cnblogs.com/MysticBoy/p/13159648.html
or click  https://www.nanoframework.net/
麦壳饼's avatar
麦壳饼 已提交
117

118
# IoTSharp for RTthread Package
麦壳饼's avatar
麦壳饼 已提交
119

120
https://github.com/IoTSharp/iotsharp-rtthread-package
麦壳饼's avatar
麦壳饼 已提交
121

麦壳饼's avatar
麦壳饼 已提交
122

麦壳饼's avatar
麦壳饼 已提交
123

124
IoTSharp's ecosystem
125

麦壳饼's avatar
麦壳饼 已提交
126 127 128
- MaiKeBing.CAP.ZeroMQ [![MaiKeBing.CAP.ZeroMQ](https://img.shields.io/nuget/v/MaiKeBing.CAP.ZeroMQ.svg)](https://www.nuget.org/packages/MaiKeBing.CAP.ZeroMQ/)
- MaiKeBing.CAP.LiteDB  [![MaiKeBing.CAP.LiteDB](https://img.shields.io/nuget/v/MaiKeBing.CAP.LiteDB.svg)](https://www.nuget.org/packages/MaiKeBing.CAP.LiteDB/)
- MaiKeBing.HostedService.ZeroMQ  [![MaiKeBing.HostedService.ZeroMQ](https://img.shields.io/nuget/v/MaiKeBing.HostedService.ZeroMQ.svg)](https://www.nuget.org/packages/MaiKeBing.HostedService.ZeroMQ/)
麦壳饼's avatar
麦壳饼 已提交
129
- IoTSharp.X509Extensions  [![IoTSharp.X509Extensions](https://img.shields.io/nuget/v/IoTSharp.X509Extensions.svg)](https://www.nuget.org/packages/IoTSharp.X509Extensions/)
130
- IoTSharp.EntityFrameworkCore.Taos   [![IoTSharp.EntityFrameworkCore.Taos](https://img.shields.io/nuget/v/IoTSharp.EntityFrameworkCore.Taos.svg)](https://www.nuget.org/packages/IoTSharp.EntityFrameworkCore.Taos/)
麦壳饼's avatar
麦壳饼 已提交
131 132
- IoTSharp.Sdk.Http   [![IoTSharp.Sdk.Http](https://img.shields.io/nuget/v/IoTSharp.Sdk.Http.svg)](https://www.nuget.org/packages/IoTSharp.Sdk.Http/)
- IoTSharp.Sdk.MQTT   [![IoTSharp.Sdk.MQTT](https://img.shields.io/nuget/v/IoTSharp.Sdk.MQTT.svg)](https://www.nuget.org/packages/IoTSharp.Sdk.MQTT/)
麦壳饼's avatar
麦壳饼 已提交
133
 
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
## Contributing

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/IoTSharp/IoTSharp/pulls)

If you would like to contribute, feel free to create a [Pull Request](https://github.com/IoTSharp/IoTSharp/pulls), or give us [Bug Report](https://github.com/IoTSharp/IoTSharp/issues/new).

### Contributors

This project exists thanks to all the people who contribute.

<a href="https://github.com/IoTSharp/IoTSharp/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=IoTSharp/IoTSharp" />
</a>

## Donation

This project is an  Apache 2.0 licensed open source project. In order to achieve better and sustainable development of the project, we expect to gain more backers. We will use the proceeds for community operations and promotion. You can support us in any of the following ways:

- [OpenCollective](https://opencollective.com/IoTSharp)
153
- 微信![二维码](docs/static/img/maikebing_wxpay.png)
154 155 156 157 158 159

We will put the detailed donation records on the below!


|                                                        | Name                                  | Stars | Donations | Message |
| ------------------------------------------------------------ | ------------------ | -------- | -------- | -------- |
麦壳饼's avatar
麦壳饼 已提交
160
| [![@iioter](https://avatars.githubusercontent.com/u/29589505?s=80&v=4)](https://github.com/iioter) | whd | ![GitHub User's stars](https://img.shields.io/github/stars/iioter?affiliations=OWNER%2CCOLLABORATOR%2CORGANIZATION_MEMBER&style=for-the-badge) | ¥1024 =120+100+292+512(码云共计四次) |  |
161 162
| [![@nnhy](https://avatars.githubusercontent.com/u/506367?s=80&v=4)](https://github.com/nnhy) | 大石头 | ![GitHub User's stars](https://img.shields.io/github/stars/nnhy?affiliations=OWNER%2CCOLLABORATOR%2CORGANIZATION_MEMBER&style=for-the-badge) |     ¥672=666+5(码云+公众号)     |            |
|  | 无敌飞行家 | ![GitHub User's stars](https://img.shields.io/github/stars/hehaoyu_2014?affiliations=OWNER%2CCOLLABORATOR%2CORGANIZATION_MEMBER&style=for-the-badge) | ¥5=5(公众号) |  |
麦壳饼's avatar
麦壳饼 已提交
163
| [![@davidzhu001](https://avatars.githubusercontent.com/u/9436230?s=80&v=4)](https://github.com/davidzhu001)   | 农民也很疯狂 |  ![GitHub User's stars](https://img.shields.io/github/stars/davidzhu001?affiliations=OWNER%2CCOLLABORATOR%2CORGANIZATION_MEMBER&style=for-the-badge)| ¥400=200+200 微信转账 | |
麦壳饼's avatar
麦壳饼 已提交
164
| [![@280780363](https://avatars.githubusercontent.com/u/20083278?s=80&v=4)](https://github.com/280780363)   | 谷草 |  ![GitHub User's stars](https://img.shields.io/github/stars/280780363?affiliations=OWNER%2CCOLLABORATOR%2CORGANIZATION_MEMBER&style=for-the-badge)| ¥88 微信转账 | |
麦壳饼's avatar
麦壳饼 已提交
165 166 167
|  | 匿名公司 |  | ¥1000=1000(微信转账) |  |
|  | *阵 |  | ¥50(微信转账) |  |
|  | *守 |  | ¥10(微信转账) | 加油iotsharp! |
168 169 170 171 172 173

## Community Support

If you encounter any problems in the process, feel free to ask for help via following channels. We also encourage experienced users to help newcomers.

- [![Discord Server](https://img.shields.io/discord/895689311612178442?color=%237289DA&label=IoTSharp&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/My6PaTmUvu)
174

175 176 177
| 公众号 |    [QQ群63631741](https://jq.qq.com/?_wv=1027&k=HJ7h3gbO)  |  微信群  |
| ------ | ---- | ---- |
| ![](docs/static/img/qrcode.jpg) | ![](docs/static/img/IoTSharpQQGruop.png) | ![企业微信群](docs/static/img/qyqun.jpg) |
麦壳饼's avatar
麦壳饼 已提交
178

179 180 181
## dotNET China

[![DotNetChina](https://images.gitee.com/uploads/images/2021/0309/134044_9c191d7b_974299.png)](https://gitee.com/dotnetchina/IoTSharp)
麦壳饼's avatar
麦壳饼 已提交
182