Skip to content

About

❄️ Yun Portable Air Conditoner. 云空调,便携小空调,为你的夏日带去清凉!

Topics

Resources

Stars

3.5k stars

Watchers

25 watching

Forks

Latest commit

 

History

166 Commits

Folders and files

Repository files navigation

Air Conditioner

GitHub Pages

中文文档 | English Docs

云空调,便携小空调,为你的夏日带去清凉!


前世今生:云空调,便携小空调|云游君的小站

仓库 类型 链接
裸机 main ac.yunyoujun.cn
备用机 main ac.yyj.moe
样板房 空调房 https://www.yunyoujun.cn/air-conditioner-room/

Features

优势

  • 🕐 随时随地打开空调
  • 📱 便携
  • 🔋 低功耗(使用 HTML CSS 而非 Canvas 绘制)
  • 🔊 静音
  • 🎮 操作简单
  • 🔧 安装便捷

劣势

  • 💨 没有风

安装

npm 接入(推荐)

有构建工具的项目建议直接安装,便于管理版本和页面生命周期:

npm install @yunlefun-home/air-conditioner-widget
import { cdnAssets, mountAirConditioner } from '@yunlefun-home/air-conditioner-widget'

// 在客户端、DOM 就绪后执行;组件卸载时调用 widget.remove()。
const widget = mountAirConditioner(document.body, {
  ...cdnAssets,
  placement: 'top-right',
  enableAudio: false,
})

cdnAssets 将字体、音频和 Logo 固定到所安装 npm 包的同一版本;也可以使用包内资源自托管。支持 ESM、CommonJS 和 TypeScript,无需 React / Vue。

脚本接入(无需构建)

把下面的脚本放到博客或网站的全局模板中:

<script defer src="https://cdn.jsdelivr.net/npm/@yunlefun-home/air-conditioner-widget@0.4.3/dist/embed/embed.js" data-placement="top-right"></script>

机身固定在右上角,遥控器在右下角点击展开;支持触屏、键盘和 Esc 收起。改为 data-placement="top-left" 可安装在左侧,加上 data-audio="true" 可启用音效。字体与音频随脚本加载,无需 npm 包。

安装演示与复制代码提供固定版本的 jsDelivr 安装代码;自托管和 SPA 接入见完整安装说明。

iframe

<iframe height="740" src="https://ac.yunyoujun.cn"></iframe>

您可以快速为您的网站安装空调。

样板房:空调房

上门服务

自行部署

Vercel

从仓库根目录导入项目(Root Directory 保持默认)。vercel.json 指定网站构建命令 pnpm run react:build、输出目录 packages/react/dist,并为 /rc 等页面提供 SPA 回退。根目录的 pnpm build 用于构建组件库,不能作为网站部署命令。

Docker

部署时可使用以下环境变量进行配置自定义:

  • AC_NGINX_DOMAIN 指定域名
  • AC_NGINX_PORT 指定监听端口

腾讯云

使用 腾讯云 Webify 一键部署:

cloudbase

文档

说明书位于 docs,使用 VitePress 与 vitepress-theme-yunlefun。本地运行 pnpm docs:dev,独立构建运行 pnpm docs:build。

计划通过独立 Cloudflare Pages 项目使用 docs.ac.yunyoujun.cn,目前尚未确认绑定或上线;配置步骤见 文档部署说明。主站部署保持不变。

Dev

# 开发预览
# yarn dev
yarn start
# http://localhost:3000/

# 构建项目
yarn build
# ./build

环境变量

cp .env.example .env
# 关闭广告
VITE_DISABLE_ADSENSE=true

发布

@yunlefun-home/air-conditioner-core、@yunlefun-home/air-conditioner 与 @yunlefun-home/air-conditioner-widget 通过 GitHub Actions 的 npm 可信发布(OIDC)发版,无需 npm Token 或一次性密码,并自动附带来源证明(provenance)。

pnpm release

bumpp 同步更新版本、提交并推送 v* Tag,Release 工作流 随即检查、构建并按 core → vue → widget 的顺序发布。预发布版本(如 0.4.0-beta.1)发布到同名 dist-tag,已存在的版本会被跳过。也可在 Actions 中手动运行该工作流,发布当前分支上的版本。

补齐已有 Release 的 npm 包与 Home 插件时,可在修复后的分支手动运行 Release,并填写 release_tag(例如 v0.4.0)。工作流会核对根目录和四个包的版本与标签一致,再向已有 Release 上传插件;不会改写标签或重新上传 CuteAC App。普通推送与 PR 的 CI 同时运行单元测试,提前检查包版本一致性。

新包首次发布需先完成 npm 登录并发布,再配置可信发布。可运行 npm trust github @yunlefun-home/air-conditioner-widget --repository YunYouJun/air-conditioner --file release.yml --allow-publish。

首次使用前,需要在 npmjs.com 三个包的 Settings → Trusted publishing 中添加 GitHub Actions:仓库 YunYouJun/air-conditioner,工作流 release.yml。

v* Tag 的 Release 还会把 Yun Home 设备插件 air-conditioner.yunplugin 及其 SHA-256 上传到 GitHub Release。插件由 packages/home-plugin 构建:state.js 直接打包 core 的 reducer,在 Yun Home 的沙箱中运行,控件以 controls.json 声明,由宿主原生渲染。本地构建:

pnpm -C packages/home-plugin build

Todo

  • 空调
    • 能耗标签
    • 温度范围(16-31˚C)
    • 风 css
    • 音效
      • 按钮
      • 工作声
  • 适应系统的亮暗模式

Ref

Sponsors

About

❄️ Yun Portable Air Conditoner. 云空调,便携小空调,为你的夏日带去清凉!

Topics

Resources

Stars

3.5k stars

Watchers

25 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages