Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/developers/concepts/2-auth-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,16 @@ coScene 根据上述的权限体系和原则,在系统内为所有的资源预
1. 组织管理员:可以管理组织内的所有资源和权限
2. 成员:可以管理所有组织内成员有权限的数据
3. 只读成员:可以读取所有组织内成员有权限的数据
4. 外部人员:不是组织内的实际用户,可以通过邀请加入组织,访问被添加的项目

### 项目

1. 项目管理员:可以管理项目内所有资源和权限
2. 成员:可以管理项目内所有的数据
3. 只读成员:可以读取项目内所有的数据

当一个用户拥有项目的角色时,该用户项目内的角色会被优先使用。唯一的例外是组织管理员,组织管理员目前拥有最高的系统权限,能访问所有的项目,并且会忽略项目内的角色设置(如果有)。
当一个用户拥有项目的角色时,该用户项目内的角色会被优先使用。唯一的例外是组织管理员,组织管理员目前拥有最高的系统权限,能访问所有的项目。

各角色的操作权限如下:

![auth.png](./img/auth.png)
Binary file added docs/developers/concepts/img/auth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions docs/developers/s3/1-s3-authentication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
sidebar_position: 1
---

# S3 身份验证

了解如何使用 S3 进行身份验证,从而对组织内有权限的项目执行 S3 操作。

1. 进入项目概览-S3 连接页面,获取 Endpoint、Region、Bucket 等信息。

![pro-s3_1](./img/pro-s3_1.png)

2. 点击【我的访问秘钥】,前往个人设置-安全页面,管理个人的 S3 访问秘钥。

![pro-s3_2](./img/pro-s3_2.png)

3. 点击【创建访问秘钥】,输入备注信息后,创建 S3 访问秘钥。

![pro-s3_3](./img/pro-s3_3.png)

4. 复制访问秘钥 ID 和访问秘钥,用于后续 S3 操作。例如,使用 [AIStor Client(mc)](https://docs.min.io/enterprise/aistor-object-store/reference/cli/) 工具进行 S3 身份验证:

```bash
mc alias set coscene <endpoint> <access-key-id> <secret-access-key>
```

注意:**个人的 S3 访问秘钥可对组织内有权限的所有项目执行操作,仅用于个人使用,不建议分享给他人。**
70 changes: 70 additions & 0 deletions docs/developers/s3/2-s3-operations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
sidebar_position: 2
---

# S3 操作

在项目中,通过 S3 可对记录、资源进行上传、下载等操作。

## 存储路径

1. **记录**

记录中的文件在 S3 对应 Bucket 中的路径为 `records/<record-id>/files/<file-name>`。

例如,记录的 ID 为 `123456`,文件名为 `example.txt`,则文件的路径为 `records/123456/files/example.txt`。

![s3-record](./img/s3-record.png)

2. **资源**

资源中的文件在 S3 对应 Bucket 中的路径为 `files/<file-name>`。

例如,资源中文件名为 `example.txt`,则文件的路径为 `files/example.txt`。

![s3-resource](./img/s3-resource.png)

## 操作示例
以 [AIStor Client(mc)](https://docs.min.io/enterprise/aistor-object-store/reference/cli/) 工具为例。假设项目 Bucket 为 `coscene.01`,记录的 ID 为 `123456`,文件名为 `example.txt`,S3 配置的别名为 `coscene`。

### 列出文件

1. 列出记录中的文件

```bash
mc ls coscene/coscene.01/records/123456/files/
```

2. 列出资源中的文件

```bash
mc ls coscene/coscene.01/files/
```

### 上传文件

1. 上传文件到记录中:

```bash
mc put example.txt coscene/coscene.01/records/123456/files/
```

2. 上传文件到资源中:

```bash
mc put example.txt coscene/coscene.01/files/
```

### 下载文件

1. 从记录中下载文件

```bash
mc get coscene/coscene.01/records/123456/files/example.txt .
```

2. 从资源中下载文件

```bash
mc get coscene/coscene.01/files/example.txt .
```
9 changes: 9 additions & 0 deletions docs/developers/s3/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "S3 存储",
"position": 4,
"collapsible": true,
"link": {
"type": "generated-index",
"slug": "/category/s3"
}
}
Binary file added docs/developers/s3/img/pro-s3_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/developers/s3/img/pro-s3_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/developers/s3/img/pro-s3_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/developers/s3/img/s3-record.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/developers/s3/img/s3-resource.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 8 additions & 7 deletions docs/viz/1-about-viz.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 1

## 如何进行进入可视化界面

在记录中,点击【播放记录】或直接点击文件进入可视化界面
在记录中,点击【播放记录】进入可视化界面

![viz-1-1.png](./img/viz-1-1.png)

Expand Down Expand Up @@ -96,14 +96,15 @@ sidebar_position: 1
![viz-1-12.png](./img/viz-1-12.png)

以下是该区域的功能介绍:
1. 创建一刻】按钮,用于选择「一刻」的起止点
1. 创建一刻:在关键时间段创建「一刻」,用于快速定位和回放该时间段的内容
2. 显示文件播放的开始时间、结束时间和持续时间
3. 当前进度时间戳
3. 当前播放的时间点
4. 暂停及前进后退按钮
5. 循环播放按钮
6. 倍速播放按钮
7. 播放画质选项按钮
8. 绝对相对时间切换按钮
5. 播放步长:调整暂停时的前进/后退时长
6. 循环播放按钮
7. 倍速播放按钮
8. 一刻:一刻在时间轴上以蓝色矩形表示
9. 可播时间段:可播时间段是指在时间轴上可以播放的时间段,以浅蓝色矩形表示

---

Expand Down
46 changes: 46 additions & 0 deletions docs/viz/4-panel/9-raw-messages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
sidebar_position: 9
---

# 原始消息面板

在数据源中查看指定的消息路径。

当该路径有新消息进入时,折叠树会自动更新并只显示最新消息。您可以根据需要展开或收起各个键,展开/收起的状态在回放时也会被保留。

![raw-messages_1.png](../img/raw-messages_1.png)

## 设置

| 字段 | 说明 |
| --- | --- |
| 字体大小 | 文本显示的字体大小 |

## 快捷方式

### 对比模式
通过显示字段的新增(绿色)、删除(红色)和修改(黄色)来对比消息,分为两类:

- `上一条消息` – 对比指定消息路径的连续消息
- `自定义` – 对比指定时间点不同 topic 的消息

![raw-messages_2.png](../img/raw-messages_2.png)
![raw-messages_3.png](../img/raw-messages_3.png)

### 展开全部
单击消息路径旁边的图标可展开或折叠显示消息中的所有嵌套字段。

| 展开全部 | 收起全部 |
| --- | --- |
| ![raw-messages_5.png](../img/raw-messages_5.png) | ![raw-messages_4.png](../img/raw-messages_4.png) |

### 逐帧查看
当消息数量较多时,可使用该功能逐条查看消息。
通过点击按钮,或选中面板后使用快捷键 `上箭头` 和 `下箭头` 查看。

![raw-messages_6.png](../img/raw-messages_6.png)

### 复制消息
点击【复制消息】按钮,将当前主题消息复制到剪贴板

![raw-messages_7.png](../img/raw-messages_7.png)
Binary file added docs/viz/img/raw-messages_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/viz/img/raw-messages_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/viz/img/raw-messages_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/viz/img/raw-messages_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/viz/img/raw-messages_5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/viz/img/raw-messages_6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/viz/img/raw-messages_7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/viz/img/viz-1-12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions i18n/en/code.json
Original file line number Diff line number Diff line change
Expand Up @@ -575,6 +575,9 @@
"home.catalogue.openapi": {
"message": "OpenAPI Platform"
},
"home.catalogue.s3": {
"message": "S3 Storage"
},
"home.catalogue.use-case": {
"message": "Use Cases"
},
Expand Down
4 changes: 4 additions & 0 deletions i18n/en/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@
"message": "OpenAPI",
"description": "The label for category 开放平台 OpenAPI in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.S3 存储": {
"message": "S3 Storage",
"description": "The label for category S3 存储 in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.组织和团队": {
"message": "Organization and Team",
"description": "The label for category 组织和团队 in sidebar tutorialSidebar"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,16 @@ Based on the above permission system and principles, the coScene platform predef
1. Organization Administrator: Can manage all resources and permissions within the organization
2. Member: Can manage all data within the organization that members have permission to
3. Read-only Member: Can read all data within the organization that members have permission to
4. External User: Not an actual user within the organization, can join the organization by invitation and access the projects added by the organization

### Project

1. Project Administrator: Can manage all resources and permissions within the project
2. Member: Can manage all data within the project
3. Read-only Member: Can read all data within the project

When a user has a role in a project, the user's role within the project will be prioritized. The only exception is the organizational administrator, who currently has the highest system permission, can access all projects, and will ignore the role settings within the project (if any).
When a user has a role in a project, the user's role within the project will be prioritized. The only exception is the organizational administrator, who currently has the highest system permission, can access all projects.

The operation permissions for each role are as follows:

![auth.png](./img/auth.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
sidebar_position: 1
---

# S3 Authentication

Learn how to use S3 authentication to perform S3 operations on projects within your organization that you have permissions for.

1. Go to the Project Overview - S3 connection page to obtain information such as Endpoint, Region, and Bucket.

![pro-s3_1](./img/pro-s3_1.png)

2. Click on [My access key] to navigate to the Personal settings - Security page and manage your personal S3 access keys.

![pro-s3_2](./img/pro-s3_2.png)

3. Click on [Create access key], enter a description, and create your S3 access key.

![pro-s3_3](./img/pro-s3_3.png)

4. Copy the Access Key ID and Secret Access Key for subsequent S3 operations. For example, use the [AIStor Client(mc)](https://docs.min.io/enterprise/aistor-object-store/reference/cli/) tool for S3 authentication:

```bash
mc alias set coscene <endpoint> <access-key-id> <secret-access-key>
```

Note: **Your personal S3 access keys can perform operations on all projects within the organization that you have permissions for. These keys are for personal use only and should not be shared with others.**
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
sidebar_position: 2
---

# S3 Operations

In a project, you can perform operations such as uploading and downloading records and resources through S3.

## Storage Paths

1. **Records**

The path of files in records within the corresponding S3 bucket is `records/<record-id>/files/<file-name>`.

For example, if the record ID is `123456` and the file name is `example.txt`, the file path would be `records/123456/files/example.txt`.

![s3-record](./img/s3-record.png)

2. **Resources**

The path of files in resources within the corresponding S3 bucket is `files/<file-name>`.

For example, if the file name in resources is `example.txt`, the file path would be `files/example.txt`.

![s3-resource](./img/s3-resource.png)

## Operation Examples
Using the [AIStor Client(mc)](https://docs.min.io/enterprise/aistor-object-store/reference/cli/) tool as an example. Assume the project bucket is `coscene.01`, the record ID is `123456`, the file name is `example.txt`, and the S3 configuration alias is `coscene`.

### List Files

1. List files in a record

```bash
mc ls coscene/coscene.01/records/123456/files/
```

2. List files in resources

```bash
mc ls coscene/coscene.01/files/
```

### Upload Files

1. Upload a file to a record:

```bash
mc put example.txt coscene/coscene.01/records/123456/files/
```

2. Upload a file to resources:

```bash
mc put example.txt coscene/coscene.01/files/
```

### Download Files

1. Download a file from a record

```bash
mc get coscene/coscene.01/records/123456/files/example.txt .
```

2. Download a file from resources

```bash
mc get coscene/coscene.01/files/example.txt .
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The data visualization interface presents device data in an intuitive visual man

## How to Enter the Visualization Interface

In a Record, click **Play** or directly click the file to enter the visualization interface.
In a Record, click **Play** to enter the visualization interface.

![viz-1-1-Eng](./img/viz-1-1-Eng.png)

Expand Down Expand Up @@ -99,9 +99,10 @@ The functions in this area include:
2. Display of the start time, end time, and duration of file playback
3. Current progress timestamp
4. **Pause** and **forward**/**backward** buttons
5. **Loop playback** button
6. **Playback speed** button
7. **Playback quality** button
8. **Absolute**/**Relative** time toggle button
5. **Playback Step**:Adjust the forward/backward duration when paused
6. **Loop playback** button
7. **Playback speed** button
8. **Moment**:A moment is represented by a blue rectangle on the timeline
9. **Playable Time Range**:The playable time range is represented by a light blue rectangle on the timeline

---
Loading