YoC组件开发系列三: YoC YMAL规范(一)-阿里云开发者社区

开发者社区> 平头哥芯片开放社区> 正文
登录阅读全文

YoC组件开发系列三: YoC YMAL规范(一)

简介: 一、前言 YoC物联网操作系统是基于组件化开发,所有的组件用YAML文件统一管理。利用YAML简洁丰富的数据形态,可以方便的对组件的C文件和H文件进行结构化管理。CDK和yoctools都支持去YAML文件的支持,可以利用YAML脚本对整个系统进行组件结构化管理和维护。 YAML里的语法众多,但在YoC YAML语法只是用到了其中的一部分,为了防止开发者滥用不支持的YAML语法,我们定义了YoC YAML语法规范,CDK和yoctools都必须遵循YoC YAML语法。

一、前言
YoC物联网操作系统是基于组件化开发,所有的组件用YAML文件统一管理。利用YAML简洁丰富的数据形态,可以方便的对组件的C文件和H文件进行结构化管理。CDK和yoctools都支持去YAML文件的支持,可以利用YAML脚本对整个系统进行组件结构化管理和维护。 YAML里的语法众多,但在YoC YAML语法只是用到了其中的一部分,为了防止开发者滥用不支持的YAML语法,我们定义了YoC YAML语法规范,CDK和yoctools都必须遵循YoC YAML语法。

二、YAML简介
YAML 是 "YAML Ain't a Markup Language"(YAML 不是一种标记语言)的递归缩写。在开发的这种语言时,YAML 的意思其实是:"Yet Another Markup Language"(仍是一种标记语言)。 YAML 的语法和其他高级语言类似,并且可以简单表达清单、散列表,标量等数据形态。它使用空白符号缩进和大量依赖外观的特色,特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲(例如:许多电子邮件标题格式和YAML非常接近)。 YAML 的配置文件后缀为 .yml,如:runoob.yml 。

基本语法
大小写敏感
使用缩进表示层级关系
缩进不允许使用tab,只允许空格
缩进的空格数不重要,只要相同层级的元素左对齐即可
'#'表示注释
数据类型
YAML 支持以下几种数据类型:

对象:键值对的集合,又称为映射(mapping)/ 哈希(hashes) / 字典(dictionary)
数组:一组按次序排列的值,又称为序列(sequence) / 列表(list)
纯量(scalars):单个的、不可再分的值
三、YoC YAML语法
YoC YAML语法主要包括一下六个部分, 具体语法会在YoC YAML规范介绍二详细介绍。

组件定义
说明文档
描述文件
存储约定
硬件信息
Chip 组件
Board 组件
Solution 组件
组件配置
组件变量
内置变量
配置项变量
组件分类
Board类别
Chip类别
Solution类别
Common类别
组件编译选项作用域
四、YoC组件管理
YoC组件利用YAML脚本来管理该组件的C文件和H文件。 以KV组件为例,其主要有三部分组成:

C文件和H文件
README说明文档
package.yaml文件
.
├── block.c
├── cli_kvtool.c
├── include
│ ├── aos
│ │ └── kv.h
│ ├── block.h
│ └── kvset.h
├── kv_aos.c
├── kvset.c
├── package.yaml
└── README.md

package.yaml文件里的

第一部分: 基础信息

name: kv # <必选项> 包名称 (符合C语言变量命名规则),长度少于等于64字节
version: v7.4.y # <必选项> 组件版本号
description: 一个以Key-Value方式进行持久化存储的轻量级组件 # <必选项> 建议至少20字以上
type: common # <必选项> 组件类型,为:solution, chip, board, common, sdk
tag: 核心模块 # <可选项> 组件分类,缺省值: ''
keywords: # <可选项> 标签,会影响到组件被搜索的效果,合理的标签很重要

  • filesystem

license: Apache license v2.0 # <可选项> 源代码的许可证,要确保所有代码、文件的许可证不冲突。如:MIT,Apache license v2.0,BSD

第二部分:依赖信息

指定该组件依赖的组件及版本,版本支持条件比较,支持:>=v1.0, >v1.0, ==v1.0, <=v1.0, <v1.0, v1.0

未指定条件时,默认为 ==,如 v1.0 与 ==v1.0

sdk_chip: # <可选项> 该组件依赖sdk组件,合理的依赖才能保证组件能编译、使用

- sdk_chip_csky_dummy: v7.4.y

- sdk_chip_riscv_dummy: v7.4.y

depends: # <可选项> 该组件依赖其他的组件,合理的依赖才能保证组件能编译、使用

- minilibc: v7.2.0

- aos: >=v7.2.0

第四部分:编译连接信息

build_config: # <可选项> 编译配置项

include: # <可选项> 编译时,影响编译器的-I 参数 ,全局有效

- src # include 只能是该软件包下的目录,不能使用外部目录

internal_include: # <可选项> 编译时,影响编译器的-I 参数 ,组件内有效

- include

cflag: '' # <可选项> C 编译器所需要要的编译参数

cxxflag: '' # <可选项> CXX 编译器所需要要的编译参数

asmflag: '' # <可选项> 汇编器所需要要参数

define: # <可选项> 宏定义, 增加编译器的-D 选项,如:

XXX: 1 # -DXXX=1

AAA: 1 # -DAAA

STR: "abc" # -DSTR="abc"

libs: # 该组件中支持的二进制静态库,如:libxxx.a, libyyy.a

- xxx # -lxxx

- yyy # -lyyy

libpath: # 指定静态库所在的路径(相对于该组件路径)

- libs # -Llibs

build_config:
include:

- include

source_file: # <可选项> 指定参与编译的源代码文件,支持通配符,采用相对路径

- src/*.c # 例:组件 src 目录下所有的扩展名为 c 的源代码文件

source_file:

  • block.c
  • kvset.c
  • kv_aos.c
  • cli_kvtool.c ? <AOS_COMP_CLI>

第五部分:配置信息

def_config: # 组件的可配置项

CONFIG_DEBUG: y

CONFIG_PARAM_NOT_CHECK: y

CONFIG_CLI: y

第六部分:安装信息

install:

- dest: include/ # 安装的目的路径 dest是相对路径,通常是相对于YoC SDK 安装目录

source: # 安装源列表

- src/*.h # 支持通配符,相对路径

install:

  • dest: "include/"
    source:

    - "include/*.h"
    

第七部分:导出部分

export:

- dest: "<SOLUTION_PATH>/generated/data" # 安装的目的路径 dest是相对路径

source: # 安装源列表

- "bootimgs/boot"

- "bootimgs/tee"

- "bootimgs/mtb"

- "configs/config.yaml"

package.yaml脚本内容主要分为七个部分:

基础信息
包含对组件基本信息的描述,包含组件版本,功能缩写,标签以及License等信息。

依赖信息
包含对组件的版本依赖,没有就忽略该部分

编译链接信息
包换H文件目录的搜索路径和需要编译的C文件、以及库文件的搜索路径等。

配置信息
包括系统配置,用户配置宏定义,其以-Dxxxx的方式传入编译文件

安装信息(不用可忽略)
类似make install功能,包换安装的路径等。

导出信息(不用可忽略)
包含镜像文件导出信息等。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

分享:
平头哥芯片开放社区
使用钉钉扫一扫加入圈子
+ 订阅

芯片开放社区(Open Chip Community 简称OCC),是平头哥芯片基础设施的云端载体,提供开发中心、创芯空间、技术部落等互动版块,汇聚海量应用资源,助力芯片合作伙伴构建软硬融合的芯片生态。面向芯片企业,OCC以应用驱动芯片精准定义、以全栈技术支撑芯片敏捷开发;面向开发者,OCC以芯片生态降低IoT开发门槛、以1520体系加速IoT产品落地。

官方博客
官网链接