Skip to content

Commit

Permalink
完成中文版
Browse files Browse the repository at this point in the history
  • Loading branch information
eraser333 committed May 23, 2024
1 parent fbb6ba6 commit 1649828
Show file tree
Hide file tree
Showing 155 changed files with 4,406 additions and 2,575 deletions.
4 changes: 2 additions & 2 deletions content.en/docs/device/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ weight: 999
# How to contribute
## Reporting a bug

File bugs in the [Github Issue Tracker](https://github.com/Horacehxw/Ziggo-CaaS-Switch/issues). Please follow these guidelines:
File bugs in the [Github Issue Tracker](https://github.com/mobisense/Ziggo-CaaS-Switch/issues). Please follow these guidelines:

- Search existing issues first, make sure yours hasn't already been reported.
- Consider enabling debug mode so that you can provide as much details as possible when reporting the issue.
Expand All @@ -31,7 +31,7 @@ If you want to start contributing to the project's code, please follow these gui
- The top post of the pull request should contain a full, self-contained explanation of the feature: what it does, how it does it, with examples of usage and screenshots. Also explain why you want to add this - what problem does it solve. Do not simply add a text `Implement feature #4345` , because the information there will most likely be outdated or confusing (multiple discussions and opinions). The pull request needs to be self-contained.
- Bug fixes are always welcome.
- A good way to easily start contributing is to pick and work on a good first issue. We try to make these issues as clear as possible and provide basic info on how the code should be changed, and if something is unclear feel free to ask for more information on the issue.
- Before adding a new feature, ask about it in the [Github Issue Tracker](https://github.com/Horacehxw/Ziggo-CaaS-Switch/issues) , or check if existing discussions exist to make sure the new functionality is desired.
- Before adding a new feature, ask about it in the [Github Issue Tracker](https://github.com/mobisense/Ziggo-CaaS-Switch/issues) , or check if existing discussions exist to make sure the new functionality is desired.
- Pull requests that make many changes using an automated tool, like for spell fixing, styling, etc. will not be accepted.
- Pull requests that address multiple issues will most likely stall and eventually be closed. This is because we might be fine with one of the changes but not with others and untangling that kind of pull request is too much hassle both for maintainers and the person who submitted it. So most of the time someone gives up and the PR gets closed. So please keep the pull request focused on one issue.
- **Do not mark your reviewer's comments as "resolved"**. If you do that, the comments will be hidden and the reviewer will not know what are the pending issues in the pull request. Only the reviewer should resolve the comments.
2 changes: 1 addition & 1 deletion content.en/docs/device/testbed/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ All test projects generally follow two phases:
## Device Parameter Settings and Deployment

Switch software and hardware code is available in the repository [ZIGGO-Caas-Switch](https://github.com/Horacehxw/Ziggo-CaaS-Switch), use the main branch.
Switch software and hardware code is available in the repository [ZIGGO-Caas-Switch](https://github.com/mobisense/Ziggo-CaaS-Switch), use the main branch.

TSNPerf's software and hardware code are in this repository.

Expand Down
4 changes: 2 additions & 2 deletions content.en/docs/switch/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ bookCollapseSection: true
<h3 align="center">
<a href="http://tns.thss.tsinghua.edu.cn/ziggo/">Project Page</a> |
<a href="https://ieeexplore.ieee.org/document/10228980">Paper</a> |
<a href="https://github.com/Horacehxw/Ziggo-CaaS-Switch">ZIGGO-CaaS-Switch</a> |
<a href="https://github.com/Horacehxw/Ziggo-Evaluation-Toolkit">ZIGGO-Device</a>
<a href="https://github.com/mobisense/Ziggo-CaaS-Switch">ZIGGO-CaaS-Switch</a> |
<a href="https://github.com/mobisense/Ziggo-Evaluation-Toolkit">ZIGGO-Device</a>
</h3>

</h3>
Expand Down
4 changes: 2 additions & 2 deletions content.en/docs/switch/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ weight: 400
# How to contribute
## Reporting a bug

File bugs in the [Github Issue Tracker](https://github.com/Horacehxw/Ziggo-CaaS-Switch/issues). Please follow these guidelines:
File bugs in the [Github Issue Tracker](https://github.com/mobisense/Ziggo-CaaS-Switch/issues). Please follow these guidelines:

- Search existing issues first, make sure yours hasn't already been reported.
- Consider enabling debug mode so that you can provide as much details as possible when reporting the issue.
Expand All @@ -31,7 +31,7 @@ If you want to start contributing to the project's code, please follow these gui
- The top post of the pull request should contain a full, self-contained explanation of the feature: what it does, how it does it, with examples of usage and screenshots. Also explain why you want to add this - what problem does it solve. Do not simply add a text `Implement feature #4345` , because the information there will most likely be outdated or confusing (multiple discussions and opinions). The pull request needs to be self-contained.
- Bug fixes are always welcome.
- A good way to easily start contributing is to pick and work on a good first issue. We try to make these issues as clear as possible and provide basic info on how the code should be changed, and if something is unclear feel free to ask for more information on the issue.
- Before adding a new feature, ask about it in the [Github Issue Tracker](https://github.com/Horacehxw/Ziggo-CaaS-Switch/issues) , or check if existing discussions exist to make sure the new functionality is desired.
- Before adding a new feature, ask about it in the [Github Issue Tracker](https://github.com/mobisense/Ziggo-CaaS-Switch/issues) , or check if existing discussions exist to make sure the new functionality is desired.
- Pull requests that make many changes using an automated tool, like for spell fixing, styling, etc. will not be accepted.
- Pull requests that address multiple issues will most likely stall and eventually be closed. This is because we might be fine with one of the changes but not with others and untangling that kind of pull request is too much hassle both for maintainers and the person who submitted it. So most of the time someone gives up and the PR gets closed. So please keep the pull request focused on one issue.
- **Do not mark your reviewer's comments as "resolved"**. If you do that, the comments will be hidden and the reviewer will not know what are the pending issues in the pull request. Only the reviewer should resolve the comments.
4 changes: 2 additions & 2 deletions content.en/docs/tsnperf/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ weight: 300
<h3 align="center">
<a href="http://tns.thss.tsinghua.edu.cn/ziggo/">Project Page</a> |
<a href="https://ieeexplore.ieee.org/document/10228980">Paper</a> |
<a href="https://github.com/Horacehxw/Ziggo-CaaS-Switch">ZIGGO-CaaS-Switch</a> |
<a href="https://github.com/Horacehxw/Ziggo-Evaluation-Toolkit">ZIGGO-Device</a>
<a href="https://github.com/mobisense/Ziggo-CaaS-Switch">ZIGGO-CaaS-Switch</a> |
<a href="https://github.com/mobisense/Ziggo-Evaluation-Toolkit">ZIGGO-Device</a>
</h3>

![](figs/banner.jpg)
Expand Down
134 changes: 66 additions & 68 deletions content.zh/docs/device/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,110 +5,108 @@ bookCollapseSection: true
---
<div align="center">

# ZIGGO Device: A flexible and standard-compliant toolkit for TSN performance evaluation.
# ZIGGO Device: 一种灵活且符合标准的TSN性能评估工具包

</div>

<h3 align="center">
<a href="http://tns.thss.tsinghua.edu.cn/ziggo/">Project Page</a> |
<a href="https://ieeexplore.ieee.org/document/10228980">Paper</a> |
<a href="http://tns.thss.tsinghua.edu.cn/ziggo/">项目页面</a> |
<a href="https://ieeexplore.ieee.org/document/10228980">论文</a> |
<a href="https://github.com/Mobisense/Ziggo-CaaS-Switch">ZIGGO-CaaS-Switch</a> |
<a href="https://github.com/MobiSense/Ziggo-Device">ZIGGO-Device</a>
</h3>

![](figs/banner.jpg)

## Table of Contents
## 目录

- [ZIGGO Device: A flexible and standard-compliant toolkit for TSN performance evaluation.](#ziggo-device-a-flexible-and-standard-compliant-toolkit-for-tsn-performance-evaluation)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [ZIGGO Open Platform](#ziggo-open-platform)
- [Demo](#demo)
- [Features](#features)
- [Read before start](#read-before-start)
- [Getting Started](#getting-started)
- [System Design](#system-design)
- [Demo APP Tutorial](#demo-app-tutorial)
- [License and Citation](#license-and-citation)
- [TODO List](#todo-list)
- [Contributing](#contributing)
- [ZIGGO Device: 一种灵活且符合标准的TSN性能评估工具包](#ziggo-device-一种灵活且符合标准的tsn性能评估工具包)
- [目录](#目录)
- [简介](#简介)
- [ZIGGO 开放平台](#ziggo-开放平台)
- [演示](#演示)
- [功能](#功能)
- [开始前阅读](#开始前阅读)
- [快速入门](#快速入门)
- [系统设计](#系统设计)
- [演示应用教程](#演示应用教程)
- [许可和引用](#许可和引用)
- [待办事项](#待办事项)
- [贡献](#贡献)

## Introduction
## 简介

ZIGGO is a `flexible`, `standard-compliant`, and `control-function-virtualized` TSN switch platform ready for **industrial control**, **automotive electronics**, and other **time-sensitive applications**.
ZIGGO 是一个 `灵活``符合标准``控制功能虚拟化`TSN 交换机平台,适用于**工业控制****汽车电子**及其他**时间敏感应用**

This is the document for the ZIGGO Device. (We also offer [ZIGGO-CaaS-Switch](https://github.com/Mobisense/Ziggo-CaaS-Switch) that comply with the IEEE 802.1 TSN standard.) Our Device supports testing all standards-compliant switches.
这是 ZIGGO Device 的文档。(我们还提供符合 IEEE 802.1 TSN 标准的 [ZIGGO-CaaS-Switch](https://github.com/Mobisense/Ziggo-CaaS-Switch)。)我们的设备支持测试所有符合标准的交换机。

## ZIGGO Open Platform
## ZIGGO 开放平台

![](./demo-app.png)

The construction of the ZIGGO Open Platform consists of three levels: network device, management tools, and a Demo App:
ZIGGO 开放平台的构建包括三个层次:网络设备、管理工具和演示应用:

- The software and hardware projects, along with the development board startup [tutorial](/ziggo_book/docs/device/getting-started/), provide instructions for setting up an individual network device.
- 软件和硬件项目以及开发板启动[教程](/ziggo_book/zh/docs/device/getting-started/)提供了设置单个网络设备的说明。

- The [CNC User Manual](/ziggo_book/docs/device/cnc_manual/) and [Device User Manual](/ziggo_book/docs/device/ziggo_device_manual/) cover system configuration and management tools.
- [CNC 用户手册](/ziggo_book/zh/docs/device/cnc_manual/)[设备用户手册](/ziggo_book/zh/docs/device/ziggo_device_manual/)涵盖了系统配置和管理工具。

- Lastly, we offer a comprehensive [Demo App building tutorial](/ziggo_book/docs/device/testbed/) that instructs how to
collaboratively build a complete and functional Demo using network devices and
management tools.
- 最后,我们提供了一个全面的[演示应用构建教程](/ziggo_book/zh/docs/device/testbed/),指导如何使用网络设备和管理工具协作构建一个完整且功能齐全的演示应用。

## Demo
## 演示

We provide a demonstration video of the TSN switch. It demonstrates the superior performance of the `ZIGGO-CaaS-Switch` compared to the normal switch.
我们提供了 TSN 交换机的演示视频。视频展示了 `ZIGGO-CaaS-Switch` 相较于普通交换机的优越性能。

The left side of the picture is the ZYNQ development board we use, and the right side is the TSN display board we built.
图片左侧是我们使用的 ZYNQ 开发板,右侧是我们构建的 TSN 显示板。

[![Watch the video](figs/testbed.jpg)](https://cloud.tsinghua.edu.cn/f/b307da6840d84e5f9ff1/)
[![观看视频](figs/testbed.jpg)](https://cloud.tsinghua.edu.cn/f/b307da6840d84e5f9ff1/)

> Click the pic to watch the video! Or just click [here](https://cloud.tsinghua.edu.cn/f/b307da6840d84e5f9ff1/).
> 点击图片观看视频!或者点击[这里](https://cloud.tsinghua.edu.cn/f/b307da6840d84e5f9ff1/)
## Features
## 功能

* ZIGGO supports the simultaneous transmission of both `Information Technology (IT)` and `Operation Technology (OT)` data traffic with QoS guarantee.
* ZIGGO 支持同时传输 `信息技术(IT)``操作技术(OT)` 数据流量,并提供 QoS 保证。

* ZIGGO complies with IEEE standards `802.1AS`, `Qav`, `Qbv`, and `Qcc`.
* ZIGGO 符合 IEEE 标准 `802.1AS``Qav``Qbv` `Qcc`

* ZIGGO provides `Real-time` and `Deterministic` Ethernet transport
* ZIGGO 提供 `实时``确定性` 以太网传输

* ZIGGO achieve **Zero Packet Loss** , **Microsecond-level Latency** with **Nanosecond-level Jitter Gate Ability**.
* ZIGGO guarantee **Gigabit Throughput**.
* ZIGGO provide gate accuracy applicable to **All Ethernet Frame Sizes**.
* ZIGGO 实现 **零丢包****微秒级延迟** **纳秒级抖动门控能力**
* ZIGGO 保证 **千兆吞吐量**
* ZIGGO 提供适用于 **所有以太网帧大小** 的门控精度。

## Read before start
## 开始前阅读

Getting started with ZIGGO-CaaS-Switch/ZIGGO-Device is a ***pretty hard*** task. Users/developers need to have sufficient basic knowledge and be prepare to for a long periond of learning and debugging.
开始使用 ZIGGO-CaaS-Switch/ZIGGO-Device 是一个***相当困难***的任务。用户/开发者需要具备足够的基础知识,并准备好进行长时间的学习和调试。

Please refer to [basic_knowledge.md](/ziggo_book/docs/device/basic_knowledge/) to check if you have ability to use ZIGGO competently.
请参考 [basic_knowledge.md](/ziggo_book/zh/docs/device/basic_knowledge/) 以检查您是否有能力胜任 ZIGGO

## Getting Started
## 快速入门

Please refer to [required.md](/ziggo_book/docs/device/require/) to get prepared.
请参考 [required.md](/ziggo_book/zh/docs/device/require/) 进行准备。

After that, please refer to [getting_started.md](/ziggo_book/docs/device/getting-started/) for the build and run a single ZIGGO Device.
之后,请参考 [getting_started.md](/ziggo_book/zh/docs/device/getting-started/) 以构建并运行单个 ZIGGO Device

## System Design
## 系统设计

ZIGGO is implemented on ZYNQ-7000 SoC and exploits ZYNQ's both hardware and software programmability.
ZIGGO 实现于 ZYNQ-7000 SoC 上,并利用 ZYNQ 的硬件和软件可编程性。

![framework](figs/framework.jpg)
![框架](figs/framework.jpg)

We also provide more in-depth [documentation](/ziggo_book/docs/device/system-design/) explaining specific design principles for ZIGGO Device.
我们还提供了更深入的[文档](/ziggo_book/zh/docs/device/system-design/),解释 ZIGGO Device 的具体设计原则。

## Demo APP Tutorial
## 演示应用教程

We also provide a [testbed build document](/ziggo_book/docs/device/testbed/) that allows you to build a real-time Ethernet system using the ZIGGO swtich and Device.
我们还提供了一个[测试平台构建文档](/ziggo_book/zh/docs/device/testbed/),允许您使用 ZIGGO 交换机和设备构建实时以太网系统。

Through this platform, we can measure the `delay` and `jitter` of TSN time-critcial traffic, the switch's `gating capability`, `bandwidth guarantee` and `gating accuracy`.
通过该平台,我们可以测量 TSN 时间关键流量的 `延迟``抖动`、交换机的 `门控能力``带宽保证``门控精度`

Replacing ZIGGO CaaS switches with commercial TSN switches can also test its above capabilities.
用商业 TSN 交换机替换 ZIGGO CaaS 交换机也可以测试其上述能力。

## License and Citation
## 许可和引用

ZIGGO is released under a [MIT license](https://github.com/MobiSense/Ziggo-Device/blob/main/LICENSE.txt).
ZIGGO 根据 [MIT 许可](https://github.com/MobiSense/Ziggo-Device/blob/main/LICENSE.txt) 发布。

Please consider citing our papers if the project helps your research with the following BibTex:
如果该项目对您的研究有帮助,请考虑引用我们的论文,BibTex 如下:

```bibtex
@inproceedings{caas,
Expand All @@ -132,22 +130,22 @@ Please consider citing our papers if the project helps your research with the fo
doi={10.1109/ICDCS54860.2022.00072}}
```

## TODO List
## 待办事项

- [x] ZIGGO CaaS Switch Release
- [x] ZIGGO Device Release
- [x] ZIGGO Device Source Code
- [x] Tutorial for build a testbed
- [ ] Test Case for TSN
- [x] ZIGGO CaaS Switch 发布
- [x] ZIGGO Device 发布
- [x] ZIGGO Device 源代码
- [x] 搭建测试平台教程
- [ ] TSN 测试用例

> We will expand each test in the tutorial to multiple test cases to cover different edge cases and comprehensively test the performance of TSN switches.
> 我们将在教程中扩展每个测试到多个测试用例,以涵盖不同的边缘情况并全面测试 TSN 交换机的性能。
- [ ] Support Device List
- [ ] 支持设备列表

> At present, we have only tested our own Ziggo switches and are testing other commercial switches (such as Huawei ,H3C and NXP). We expect to maintain a list of test results in the future.
> 目前,我们仅测试了自己的 Ziggo 交换机,并正在测试其他商业交换机(如华为、H3C NXP)。我们预计将来维护一个测试结果列表。
## Contributing
## 贡献

Please see the [guide](/ziggo_book/docs/device/contributing/) for information on how to ask for help or contribute to the development of ZIGGO!
请参阅[指南](/ziggo_book/zh/docs/device/contributing/),了解如何寻求帮助或为 ZIGGO 的开发做出贡献!

> The development team will only answer questions on github issues and reject other forms of questions.
> 开发团队只会回答 GitHub 问题上的问题,拒绝其他形式的提问。
Loading

0 comments on commit 1649828

Please sign in to comment.