@crestron/ch5-utilities

中文文档
2.19.0发布于 2026/08/25SEE LICENSE IN LICENSE.txtTypeScriptCommonJS近 30 天下载 6238

Crestron CH5公用事业

中文使用文档
文档目录26 节
  1. 目录
  2. 背景情况
  3. 设置
  4. 图标
  5. npm 运行开始
  6. npm 运行开始: 存档
  7. 将 shell-template.ch5z 重新命名为我的-project-v1.0.0.ch5z
  8. 将我的工程v1.0.0.ch5z文件部署到TMW
  9. npm 运行开始: 分布
  10. npm 运行开始:js
  11. npm 运行开始:js: archive
  12. npm 运行起始:js: 分布
  13. npm 运行发布: 本地
  14. 配置
  15. 工程Name
  16. 目录Name
  17. 输出目录
  18. 输出级别
  19. 增加的AppuiManifest参数
  20. 额外项目管理
  21. 控制系统
  22. 提示证书
  23. 编辑
  24. 设备类型
  25. 合同文件
  26. 许可证

CH5 公用事业 - 开始

与CH5组件图书馆一起实施的应用程序将使用的存档和分发设施.

目录

背景情况

图书馆的目的是履行三项职能:

  • 归档 - 创建可以手动或与工具一起分布的软件包
  • 分发 - 部署使用工具构建的软件包
  • 归档分发 - 上面两者的单一命令( d)

存档结果将是.ch5z包. 这里包含两个文件:

  • *.ch5 - 实际包装
  • * manifest.json - 描述.ch5文件的表单文件(项目名称、时间戳、散列和任何其他可选细节)

设置

安装所需的软件包 .

npm install

建设图书馆.

npm run build

发布ch5-用途库供本地使用.

npm link

图标

命令只用于开发,调试,测试目的.

在运行前,请确保对所有值进行适当的修改,以用于本地使用 config 变量在 start.ts。 。 。 .

npm 运行开始

运行 npm run start 将运行 存档并部署 基于配置的函数 src/start.ts 文档.

npm 运行开始: 存档

运行 npm run start:archive 将运行 归档 函数基于 src/start.ts 文件,来源Archive 应为未定义或空字符串.

将 shell-template.ch5z 重新命名为我的-project-v1.0.0.ch5z

运行 npm run start:archive 将会将 shell-template.ch5z 重命名为 my-project-v1.0.0.ch5z, sourceArchive 应该是 shell-template.ch5z 和 project 名字应该是我的项目v1.0.0.ch5z.

将我的工程v1.0.0.ch5z文件部署到TMW

运行 npx ch5-cli deploy -p -H 10.0.0.61 -t touchscreen my-project-v1.0.0.ch5z 将 ch5z 文件部署到 TSW .

npm 运行开始: 分布

运行 npm run start:distribute 将运行 分发 函数基于 src/start.ts 文档.

npm 运行开始:js

与 npm run start:js,但将运行捆绑的JS版本的图书馆(该版本在 build 目录 .

npm 运行开始:js: archive

与 npm run start:archive,但将运行捆绑的JS版本的图书馆(该版本在 build 目录 .

npm 运行起始:js: 分布

与 npm run start:distribute,但将运行捆绑的JS版本的图书馆(该版本在 build 目录 .

npm 运行发布: 本地

初始设置后,您可以使用此命令重建并发布库中的更改.

配置

方法 archiver 财务报告和审定财务报表 distributor 从 src/index.ts 期望获得类型配置 IConfigOptions。 。 。 .

下面我们描述每个财产、目的和可能的价值.

工程Name

要求.

项目名称将设定项目包名和明细表. 应根据交付的包裹设置.

默认值是 crestron-system。 。 。 .

目录Name

要求.

这是包含可交付品的目录的路径.

目前这是演示- 应用 Dint 目录 .

路径可以是绝对的,或者应该相对于指令在CLI中运行的地点.

输出目录

要求.

这是软件包文件会被复制到的路径 .

路径可以是绝对的,或者应该相对于指令在CLI中运行的地点.

输出级别

可选

这确定了所需的CLI记录水平.

可能的值是: quiet | normal | verbose。 。 。 .

增加的AppuiManifest参数

可选的.

这是一个按键值集,可用于在应用程序中设置额外的细节(在此情况下是show-app)显示的JSON文件.

额外项目管理

可选的.

这是一个密钥值集,可用于在工程显示的JSON文件中设置额外细节.

控制系统

要求.

这应该是部署软件包的设备的主机名或IP地址.

提示证书

这始终是真实的,因为效用总是会促使人们在《国家清单》中获得证书.

编辑

要求.

这是目标目录 controlSystemHost。 。 。 .

它必须相对 SFTP 根目录.

会的 display 用于演示应用,或 HTML 用于CCS.

设备类型

要求.

这一点应当根据 controlSystemHost,取决于你的目标 什么样的设备部署.

可能的值是: touchscreen | controlsystem | web。 。 。 .

合同文件

可选

合同编辑器配置文件的相对或绝对文件路径 。 文件必须有.cse2j扩展名.

许可证

版权(C)2018至今 Crestron Electronics, Inc. 版权所有. 不得以任何形式、机器复制本软件的任何部分 或自然的,未经克列斯特龙电子公司的明示书面同意. 使用此源代码必须遵守 Crestron 软件的条款 开发工具许可协议, 您根据该协议为此源代码发放许可 .

如果你不接受许可协议的条款, 您无权使用此软件。 就许可证而言, 请看您和Crestron的许可协议 http://www.crestron.com/sla (中文(简体) )。 。 。 .

版本与发布记录

@crestron/ch5-utilities 共发布 510 个版本,首次发布于 2019/06/05;过去 12 个月发布了 1 个版本。

版本发布日期距今
2.19.0latest2026/08/252 个月前
99.0.506latest-dev2021/07/315 年前
99.0.5052021/07/305 年前
99.0.5042021/07/295 年前
99.0.5032021/07/285 年前
99.0.5022021/07/275 年前

其他发布通道:latest-qe → 0.1.52,latest-dev → 99.0.506。

关于 @crestron/ch5-utilities 的常见问题

@crestron/ch5-utilities 是什么?

Crestron CH5公用事业

如何安装 @crestron/ch5-utilities?

在项目目录运行 npm install @crestron/ch5-utilities,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ch5-utilities,可以用 npx ch5-utilities 直接运行。

@crestron/ch5-utilities 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@crestron/ch5-utilities 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@crestron/ch5-utilities 可以商用吗?

@crestron/ch5-utilities 使用 SEE LICENSE IN LICENSE.txt 许可。许可条款写在包内的独立文件中,请阅读该文件确认可否商用。以上为概括,不构成法律意见,请以许可原文为准。

@crestron/ch5-utilities 的下载量有多少?

根据 npm 官方下载统计,@crestron/ch5-utilities 在 2026/10/11 – 2026/11/09 这 30 天内被下载 6,238 次,日均约 208 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@crestron/ch5-utilities 还在维护吗?

最新版本 2.19.0 发布于 2026/08/25(2 个月前);至今共发布 510 个版本,其中过去 12 个月发布了 1 个;首次发布于 2019/06/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。