ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

Home Assistant AfterShip 集成 Remove tracking 动作(aftership.remove_tracking)使用指南

Home Assistant AfterShip 集成 Remove tracking 动作(aftership.remove_tracking)使用指南 Home Assistant AfterShip 集成 Remove tracking 动作aftership.remove_tracking使用指南【免费下载链接】home-assistant.io:blue_book: Home Assistant User documentation项目地址: https://gitcode.com/GitHub_Trending/ho/home-assistant.ioaftership.remove_tracking是 Home Assistant 中 AfterShip 集成提供的动作action用于从你的 AfterShip 账户中移除一个跟踪号使其不再出现在 Home Assistant 的包裹跟踪传感器中。本文以官方动作文档为主体结合集成文档与仓库渲染机制完整讲解该动作的界面操作步骤、YAML 调用方式、参数说明及与aftership.add_tracking的配合用法。动作概览这个动作做什么Remove tracking移除跟踪动作会从 AfterShip 账户中删除一个跟踪号。删除后该包裹的投递状态将不再由 AfterShip 集成作为传感器数据展示在 Home Assistant 中。该动作具有以下关键特征不支持目标targets与许多面向实体的动作不同调用该动作时你不会被提示选择区域、设备、实体或标签。你只需要直接提供两个参数——承运商标识Slug和跟踪号Tracking number。操作对象是账户级数据它操作的是 AfterShip 账户中的跟踪记录而非 Home Assistant 本地实体因此不存在entity_id一类字段。动作的核心元数据定义在 aftership.remove_tracking.markdown 的 front matter 中domain: aftership、action: aftership.remove_tracking并在related_actions中声明了关联动作aftership.add_tracking。前置条件AfterShip 集成与 API Key在使用该动作之前需要先完成 AfterShip 集成的配置。根据 AfterShip 集成文档注册 AfterShip 账户并进入 API Key 管理页面复制已有 Key 或生成一个新的 Key。套餐要求文档明确指出AfterShip 已从 Forever Free 计划中移除 Tracking API 功能Essentials 计划也不再提供因此使用该集成目前至少需要Pro 计划。在 Home Assistant 中通过配置流程config flow填入 API Key 完成接入。集成安装后会创建一个传感器其传感器数值表示未处于Delivered状态的包裹数量各状态的包裹数量则以属性attributes形式提供。remove_tracking动作正是维护这份数据的重要入口之一——当你不再需要跟踪某个包裹时用它把该跟踪号清理掉。集成文档还特别说明该集成通过 AfterShip 公开 REST API 获取数据但集成本身与 AfterShip 无附属关系not affiliated。在界面UI中使用该动作如果你习惯用可视化方式构建自动化与脚本Home Assistant 会引导你一步步完成动作配置无需编写 YAML见 actions/ui_header.md。在界面中添加aftership.remove_tracking动作的具体步骤进入设置Settings 自动化与场景Automations scenes。打开已有的自动化或脚本或选择创建自动化Create automation 创建新自动化Create new automation。如果是新建自动化在When触发条件部分添加一个触发器脚本不需要触发器它们在被其他内容调用时运行。在Then do执行动作部分选择添加动作Add action。在搜索框中搜索并选择AfterShip: Remove tracking。填写Slug承运商和Tracking number跟踪号两个字段。点击保存Save。由于该动作不支持 targets界面不会出现选择区域、设备、实体或标签的步骤表单聚焦于两个必要参数配置非常直接。界面中的选项选项说明必填Slug要移除的跟踪记录对应的承运商slug例如usps或fedex是Tracking number要移除的跟踪号是在 YAML 中使用该动作如果你直接编写 YAML或希望确切了解 Home Assistant 底层行为可以使用 YAML 方式调用见 actions/yaml_header.md。动作的完整引用名为aftership.remove_tracking一个基础示例如下action: aftership.remove_tracking data: slug: usps tracking_number: 123456789这段配置会从你的 AfterShip 账户中移除跟踪号123456789对应承运商usps。YAML 中的选项字段类型说明必填slugstring要移除的跟踪记录对应的承运商slug例如usps或fedex是tracking_numberstring要移除的跟踪号是注意与aftership.add_tracking不同remove_tracking的两个参数均为必填。添加跟踪时 Slug 可以留空让 AfterShip 自动检测承运商但移除时必须明确指定承运商与跟踪号因为该动作没有 自动检测 的回退机制——它需要精确定位要删除的记录。结合仓库理解文档的渲染与参数机制本仓库中的动作文档使用了多个 Jekyll 插件将 Markdown 中的选项声明渲染为规范的参数表格与说明这些机制直接决定了上面参数表的呈现方式plugins/options_ui.rb解析options_uiLiquid 块读取 YAML 映射为每个选项生成带 Required/Optional 徽标的标签与描述。文档中Slug、Tracking number均标记为 required即来源于此块的required: true。plugins/options_yaml.rb复用ConfigurationBlock将options_yaml块中的type、required、description渲染为面向 YAML 读者的参数引用这也是本文参数表中type: string的直接来源。plugins/example.rb将{% example %}块内的 YAML 内容转义后以语法高亮代码块形式展示即上文 基础示例 代码块的渲染来源。从源码结构可以推断options_ui与options_yaml两块共享同一套config-vars样式体系因此同一动作的界面版与 YAML 版参数说明在视觉与信息结构上保持一致。立即试运行Tools Actions如果你想在不编写任何 YAML 的情况下验证该动作的实际效果可以打开设置Settings 工具Tools 动作Actions搜索aftership.remove_tracking填写字段后点击执行动作Perform action见 actions/try_it.md。执行后你可以观察 AfterShip 传感器数据是否随之更新以此确认移除是否生效。关联动作与 Add tracking 成对使用该文档在 front matter 中声明了关联动作aftership.add_tracking二者构成包裹跟踪生命周期的闭环Add trackingaftership.add_tracking.markdown向 AfterShip 账户添加新的跟踪号使投递状态开始在 Home Assistant 中展示。它支持可选参数slug留空时由 AfterShip 自动检测承运商和title包裹的自定义友好名称。Remove tracking本文主题移除跟踪号使其不再展示。典型使用场景是自动化中先用add_tracking接入新包裹待包裹送达或不再需要跟踪后再用remove_tracking清理记录保持传感器数据整洁。二者的界面操作入口设置 自动化与场景 添加动作 搜索 AfterShip与 YAML 书写方式完全一致区别仅在于参数集合add_tracking的tracking_number必填、slug/title可选而remove_tracking的slug与tracking_number均为必填。排查与帮助如果动作执行后没有达到预期效果建议从以下角度排查确认集成已正确配置且 API Key 有效且当前 AfterShip 套餐包含 Tracking API 功能需 Pro 及以上。确认slug与实际跟踪记录使用的承运商标识完全一致如usps、fedex大小写敏感的参数需与 AfterShip 侧记录匹配。确认tracking_number与待移除记录完全一致移除操作是精确匹配而非模糊查找。可以先在Tools Actions中手动执行一次验证参数后再放入自动化或脚本。社区中还可以借助 AI 助手如 ChatGPT、Claude 等以自然语言描述需求由其协助解释该动作或推荐合适的动作写法。【免费下载链接】home-assistant.io:blue_book: Home Assistant User documentation项目地址: https://gitcode.com/GitHub_Trending/ho/home-assistant.io创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表