Deploy Rokid/docs to github.com/Rokid/docs.git:gh-pages

.gitignore

@@ -0,0 +1,14 @@
+*~
+_book
+sftp-config.json
+.DS_Store
+EnableVoice/rokid-vsvy-sdk-docs/
+
+node_modules
+yarn.lock
+.idea/
+5-enableVoice/rokid-vsvy-sdk-docs/rookie-guide/rookie-guide.md
+5-enableVoice/rokid-vsvy-sdk-docs/rookie-guide/rookie-guide.md
+5-enableVoice/rokid-vsvy-sdk-docs/yodaosSystem/yimo/README.md
+5-enableVoice/rokid-vsvy-sdk-docs/yodaosSystem/yimo/README.md
+5-enableVoice/rokid-vsvy-sdk-docs/rookie-guide/images/ximalyaurl.jpg

1-GetStarted/enable-rokid-voice.md

@@ -0,0 +1,99 @@
+# 开始接入Rokid语音
+
+## 文档结构
+- [Rokid语音接入介绍](#rokid语音接入介绍)
+- [开始接入](#开始接入)
+- [完善您的产品](#完善您的产品)
+- [支持](#支持)
+
+## Rokid语音接入介绍
+Rokid语音接入能够为配有麦克风和扬声器的联网硬件设备开启若琪所提供的智能语音交互能力。用户可以直接使用语音让搭载若琪的设备播放音乐、查天气、播报新闻，以及其他技能（Skills）所提供的各种服务。
+
+## Rokid语音接入与Rokid技能
+当您的设备接入若琪后，即可使用众多丰富有趣的Rokid公有技能，也可以为您的设备创建个性化的私有技能。通过[开始开发Rokid技能](./rokid-skill-kit-introduction.md)了解更多。
+
+## 开始接入
+
+### 1. 注册设备
+#### 设备信息
+在「开发者社区-->语音接入」中注册您的设备，并完善设备名称、设备图片、设备分类及描述。
+
+#### 认证文件
+您需要为您的设备创建一个认证文件，以获取接入若琪的权限。具体方法请查看[获取认证文件](/2-RokidDocument/2-EnableVoice/get-the-certification-file.md)。
+
+### 2. 为您的产品接入Rokid语音能力
+
+#### ① 给您的Rokid ALL in ONE 全栈开发套件刷写代码
+
+- 请参见 [ALL in ONE 开发板 AMLOGIC 905D android代码编译烧写教程](/2-RokidDocument/2-EnableVoice/Rokid-Devkit-905D-Android-Doc.md)
+
+#### ② 在您的产品中接入Rokid SDK
+Rokid开发者社区SDK包含Siren、Speech、NLP、ASR、TTS几大模块。
+
+- Siren：拾音模块，接收HAL的音频数据，算法处理，滤波；
+- TTS：文字转语音；
+- Speech和ASR：都是语音转文字，不同的是Speech专门处理Siren的语音事件。
+
+通过[Rokid SDK 接入指南](/2-RokidDocument/2-EnableVoice/rokid-sdk-tutorial.md)，了解如何快速在您的产品中接入Rokid SDK。
+
+#### 和您的设备做一次互动
+您可以创建一个[开始创建第一个技能：我要喝咖啡](/2-RokidDocument/1-SkillsKit/skill-sample-coffee.md)，并将您的设备添加到此技能的测试设备列表中，就可以与设备进行互动啦。
+
+#### 与开发者分享您的方案
+在成功为您的设备开启若琪语音交互能力之后，别忘了到Rokid讨论区与大家分享您接入若琪的心得哦。
+
+### 3. 更多配置
+
+在提供以上基础能力之外，我们还提供了更多的自定义配置。
+
+#### 核心技能接入
+
+核心技能是由Rokid提供的预装技能，在接入若琪之后，您便可以直接使用这些技能，无需额外开发。
+您也可以在「语音服务-服务接入-核心技能接入」中对您的设备是否接入这些技能进行配置。
+
+#### 设备热词
+添加设备热词，可以提高本类型设备上ASR语音语音识别的准确率。当设备接收到语音时，ASR语音识别会优先命中热词。**每个设备最多可以添加10组热词，每组热词最多500个，每个词最长不超过16个字。**
+
+##### 1.为您的设备添加全局热词
+您添加热词组，不与任何技能关联时，则将作为全局热词处理，即该类型的设备使用任意技能时语音识别都会优先命中热词。
+
+**操作步骤：** 创建热词组为其命名，并添加热词的内容，保存后即可。
+
+
+##### 2.为您的设备添加技能热词
+当您的设备在使用特定技能的特定句式时，需要用到热词，则需要将热词组与相应技能的具体词表进行关联。
+
+可关联的技能包括：该类型设备接入的核心技能、该类型设备接受授权的私有技能、该类型设备上开启的所有公有技能。
+
+**操作步骤：** 例如，该类型设备在使用一个相册技能时，需要提高「下页」、「下一页」这类向后翻页操作的语音识别准确率。
+- 第一步，创建热词组 [向后翻页] 并添加「下页」、「下一页」这两个热词。
+- 第二步，在关联技能列表选择【相册】技能
+- 第三步，在【相册】词表中选择并关联向后翻页的词表-next
+- 第四步，选择热词组 [向后翻页] ，并点击保存。
+
+
+
+#### 拦截器
+
+拦截器可以允许开发者在进入若琪NLP匹配之前或者在若琪NLP处理完成后结果为空时将请求进行拦截，拦截到开发者自己的HTTPS拦截器。
+您可以在「语音服务-服务接入-拦截器」中对此功能进行配置，详细请了解[拦截器接口文档](/3-ApiReference/rokid-interceptor.md)。
+
+#### 私有技能接入
+
+>私有属性的技能无法向所有用户开放，仅针对经过技能开发者授权的企业或个人的特定类型的设备开放。用户需要在被授权的设备上才能够使用私有技能。
+
+当有开发者（包括您自己）向您授权其开发的私有技能后，您可以在「语音服务-服务接入-私有技能接入」的列表中对这些技能进行如下配置：
+
+- 启用/禁用：为当前设备启用或禁用被授权的私有技能。
+- 取消授权：取消指定私有技能对您设备的授权。
+
+## 完善您的产品
+以下文档将帮助您打造出优秀的语音交互产品。
+
+- [Rokid 语音产品硬件设计指南](/2-RokidDocument/2-EnableVoice/rokid-hardware-design-guide.md)：为您提供由Rokid总结的硬件方案设计指南。
+- [Rokid 硬件交互设计指南](/2-RokidDocument/2-EnableVoice/rokid-hardware-ux-design-guidelines.md)：为您提供硬件交互的设计参考。
+
+## 支持
+
+- [Rokid讨论区](https://developer-forum.rokid.com/)
+

1-GetStarted/rokid-skill-kit-introduction.md

@@ -0,0 +1,128 @@
+## 开始开发Rokid技能
+为搭载Rokid解决方案的设备开发有趣的技能。
+
+## 文档结构
+
+- [当前支持的技能种类](#1-当前支持的技能种类)
+- [创建一个技能](#2-创建一个技能)
+- [分享您的技能](#3-分享您的技能)
+- [快速开始](#快速开始)
+- [模板工程](#模板工程)
+- [支持](#支持)
+
+
+## 什么是Rokid技能开发工具
+Rokid开发者社区所提供的语音方案为用户准备了各种不同场景下的应用，比如音乐、天气、新闻、百科等等，我们将他们称之为：**技能（Skills）**。
+
+Rokid技能开发工具可以帮助您创建各种各样的Rokid技能，以此触达所有搭载Rokid语音方案设备背后的终端用户，向他们提供各种有趣的服务，比如：
+
+- 问一些具体的问题（“若琪，明天杭州会不会下雨。”）
+- 玩语音小游戏（“若琪，我要玩文字猜谜。”）
+- 控制智能家居设备（“若琪，把卧室的灯打开。”）
+- 播放新闻摘要（“若琪，播放最新的新闻。”）
+
+Rokid技能开发工具包含开发工具、文档、以及丰富的示例代码，能够帮助开发者以最快的速度完成技能的开发。在Rokid沉淀的经验之上，专注于更富有创造性的工作。
+
+## 1 当前支持的技能种类
+不同种类的技能可以用来面对不同的业务场景，这是您在开始创建技能时就需要思考的问题。Rokid技能开发工具提供2个维度的4种技能，分别是：
+
+- 不同开放性的技能
+    - 公开技能
+    - 私有技能
+- 不同类型的技能
+    - 自定义技能
+    - 预定义技能
+
+### 1.1 不同开放性的技能
+首先，你需要决定是将技能开放给所有搭载Rokid方案的设备，还是仅授权您自己的产品或其他指定产品使用。
+
+#### ① 公开技能
+公开属性的技能将会对所有搭载Rokid语音解决方案的设备开放，用户可以通过技能商店轻松开启您开发的技能。
+
+#### ② 私有技能
+私有属性的技能无法向所有用户开放，仅针对经过你授权的企业或个人的特定类型的设备开放。用户需要在被授权的设备上才能够使用你的技能。
+
+另外，当选择私有技能时，可以选择创建本地技能，允许开发者收到语义解析的结果后调用设备中的apk。这在为拥有大量本地应用的设备开发技能时特别有用。
+
+### 1.2 不同类型的技能
+#### ① 自定义技能
+如果你面对的是复杂的语音交互场景，你需要选择`自定义技能`。该类型的技能需要你对`语音交互`进行自定义。
+具体来说，你需要定义：
+
+- 技能可处理的具体需求。我们将这些需求称之为`意图`。举例来说，以下都可以被视为某个技能中的一个意图：
+
+    - 播放音乐
+    - 查询天气
+    - 播放新闻
+    - 其他任何你能想到的一个具体动作
+
+- 用户达成一个意图所有可能的对话方式，我们称之为`用户语句`。用户语句决定了一个用户与你技能之间的交互方式，举例：
+
+    - “给我放一首歌”(这句话对应了**播放音乐**这个意图)
+    - “杭州今天天气怎么样”（这句话对应了**查询天气**这个意图）
+    - “今天有什么新闻”（这句话对应了**播放新闻**这个意图）
+
+- 技能理解用户语句并将其转换为意图，有时还需要`词表`的帮助。比如：
+
+    - 理解“给我放一首**歌**”，需要拥有**歌曲库**词表
+    - 理解“**杭州今天**天气怎么样”，需要拥有**城市**和**日期**词表
+    - 理解“**今天**有什么新闻”，需要拥有**日期**词表
+
+- 此外，Rokid还需要通过`入口词`来分辨用户是在和你的技能进行语音交互。用户需要使用含有入口词的语句来唤起你的技能。比如，你为你的音乐技能设定的入口词为“Rokid音乐”。
+
+完成以上定义后，用户就可以用如下语句与你的技能进行交互了：
+>用户：“若琪，让**Rokid音乐**给我放一首歌”
+
+Rokid将会理解用户的请求，并将**播放音乐**这个意图发送给你的技能。
+
+只要你在`语音交互`中预制了充分的用户语句、词表和意图，并且通过代码在后端服务实现这些意图，自定义技能就能够最大限度的满足你预期的用户需求。这种技能最灵活，但也因为需要配置`语音交互`，而较为复杂。
+
+#### ② 预定义技能
+如果你想创建一个听音乐这样的内容类技能，或是能够开关灯、调节空调温度这样用于智能家居设备的技能，你可以考虑使用`预定义技能`。该类型的技能的`语音交互`将由Rokid定义且不断更新，你仅需要在后端服务中直接实现对应的`意图`即可。
+预定义技能不完全依赖入口词唤起，因此对用户会更加友好。比如用户可以直接说：“若琪，把房间的灯打开。”来使用您创建的智能家居技能。
+
+*该类型的技能还在准备中，将在后续开放。*
+
+## 2 创建一个技能
+在定义完技能种类、技能名称、技能入口词等关键信息之后，你还需要做以下工作，来完成一个技能的创建。
+
+### 2.1 设计您的技能
+一个好的技能离不开出色的语音交互，这需要您对自然语言、人类对话的基本原理有简单的理解。请阅读[Rokid语音交互指南](../2-RokidDocument/1-SkillsKit/rokid-voice-interaction-guidelines.md)以了解如何设计出色的语音交互体验。
+
+当您创建一个自定义技能时，您需要通过[定义语音交互](../2-RokidDocument/1-SkillsKit/define-voice-interaction.md)将用户请求与您的服务能处理的意图关联起来，并通过定义合理的[用户语句](../2-RokidDocument/1-SkillsKit/define-voice-interaction.md#用户输入的数据)让您的技能能够准确识别用户的各种意图。
+
+### 2.2 为您的技能搭建后端服务
+你可以将您的服务部署在自建或其他任何云端服务器中。
+
+当您在为技能编写后端代码时，请参考我们的[技能协议文档](../3-ApiReference/cloud-app-development-protocol_cn.md)。
+
+在技能的语音交互定义完成、后端服务部署成功之后，你便可以开始对您的技能进行测试了。
+
+### 2.3 将您的技能提交审核
+一旦您完成了上述步骤，就可以准备将您的技能提交至Rokid技能商店，与所有的Rokid用户分享您的技能了。
+
+在此之前，技能需要通过Rokid的审核，您需要：
+
+- 充分测试您的技能
+- 完善技能的发布信息
+- 完善技能的隐私合规内容
+
+技能提交审核之后，需要耐心等待一段时间。审核完成之后您会收到来自Rokid的通知邮件。
+
+## 3 分享您的技能
+在技能成功通过审核之后，别忘了到[Rokid讨论区](https://developer-forum.rokid.com/)与大家分享过您的技能。
+
+## 快速开始
+- [创建第一个技能：我要喝咖啡](../2-RokidDocument/1-SkillsKit/skill-sample-coffee.md)
+
+## 模板工程
+- [Rokid示例技能](https://github.com/Rokid/rokid-skill-sample)
+
+## 支持
+- [Rokid讨论区](https://developer-forum.rokid.com/)
+
+
+
+
+
+

10-bspguide-eng/SUMMARY.md

@@ -0,0 +1,30 @@
+# Summary
+
+* [Rokid Kamino18 Universal Install Guide V2.5](README.md)
+* [General Description](general_description\README.md)
+  * [Purpose](general_description\purpose.md)
+  * [Range](general_description\range.md)
+* [Kamino18 Platform Introduction](kamino18_platform_introduction\README.md)
+  * [K18 Chip Diagram](kamino18_platform_introduction\k18_chip_diagram.md)
+  * [Smart Speaker Solution Introduction](kamino18_platform_introduction\smart_speaker_solution_introduction.md)
+  * [K18 Dev3.0 Board Introduction](kamino18_platform_introduction\k18_dev30_board_introduction.md)
+* [Software Folder Structue and Compiling Method](software_folder_structue_and_compiling_method\README.md)
+  * [Software Folder Structure](software_folder_structue_and_compiling_method\software_folder_structure.md)
+  * [Compiling Environment](software_folder_structue_and_compiling_method\compiling_environment.md)
+  * [Code Compile](software_folder_structue_and_compiling_method\code_compile.md)
+* [PINMUX and GPIO Setup](pinmux_and_gpio_setup\README.md)
+  * [MCU Domain PINMUX Setup](pinmux_and_gpio_setup\mcu_domain_pinmux_setup.md)
+  * [ARM Domain PINMUX Setup](pinmux_and_gpio_setup\arm_domain_pinmux_setup.md)
+  * [GPIO Setting](pinmux_and_gpio_setup\gpio_setting.md)
+* [Flash Partition and File System Management](flash_partition_and_file_system_management\README.md)
+  * [Partition Setup](flash_partition_and_file_system_management\partition_setup.md)
+  * [File System Setup](flash_partition_and_file_system_management\file_system_setup.md)
+* [Image Burning](image_burning\README.md)
+  * [Image Location](image_burning\image_location.md)
+  * [Image Burning Tool Utilization for Linux PC](image_burning\image_burning_tool_utilization_for_linux_pc.md)
+  * [Image Burning Tool Utilization for Windows PC](image_burning\image_burning_tool_utilization_for_windows_pc.md)
+  * [Image Burning Tool Utilization for Factory](image_burning\image_burning_tool_utilization_for_factory.md)
+* [SN and Seed Burning](sn_and_seed_burning.md)
+* [Network Setup](network_setup\README.md)
+  * [Network Setup through BT](network_setup\network_setup_through_bt.md)
+* [Q&A](q&a.md)