Grocy项目中的Grocycode编码规范解析

Grocy项目中的Grocycode编码规范解析

grocy ERP beyond your fridge - Grocy is a web-based self-hosted groceries & household management solution for your home 项目地址: https://gitcode.com/gh_mirrors/gr/grocy

什么是Grocycode

Grocycode是Grocy项目设计的一种特殊编码格式，主要用于在系统中唯一标识各类实体对象。这种编码可以被扫描设备识别，也可以手动输入，为库存管理、任务追踪等场景提供了便捷的引用方式。

编码结构详解

Grocycode采用分层结构设计，由以下几个部分组成：

1. 标识前缀：固定为"grcy"，作为Grocycode的识别标记
2. 实体类型：使用小写字母表示，如"p"代表产品，"b"代表电池，"c"代表家务
3. 对象ID：纯数字组成，表示该实体在系统中的唯一标识符
4. 额外数据（可选）：根据不同实体类型可能有不同含义

各部分之间使用双冒号"::"作为分隔符，形成完整的编码字符串。

实体类型详解

目前Grocycode支持三种主要实体类型：

1. 产品编码(Product)

格式：grcy:p:<产品ID>[:<库存ID>]

特点：

• 可以包含可选的库存ID
• 用于精确追踪特定批次的库存
• 示例：grcy:p:13:60bf8b5244b04表示ID为13的产品，特定库存批次为60bf8b5244b04

2. 电池编码(Battery)

格式：grcy:b:<电池ID>

特点：

• 目前没有定义额外字段
• 用于追踪电池使用周期和更换记录

3. 家务编码(Chore)

格式：grcy:c:<家务ID>

特点：

• 目前没有定义额外字段
• 用于标记和追踪定期家务任务

编码的视觉表示

Grocycode支持多种条码格式的视觉编码：

1. DataMatrix二维码：

   • 推荐格式
   • 占用空间小
   • 识别率高，特别适合非平面表面

2. Code128一维码：

   • 兼容性较好
   • 适合简单场景

虽然理论上可以使用QR码等其他格式，但DataMatrix在空间利用率和识别率方面表现更优，是Grocy项目的推荐选择。

实际应用建议

1. 扫描设备选择：

   • 建议使用支持DataMatrix的2D扫描器
   • 确保设备正确配置了键盘模拟模式
   • 注意检查双冒号等特殊字符是否能正确输入

2. 编码内容注意事项：

   • 仅包含可键盘输入的字符
   • 避免使用特殊符号
   • 保持编码简洁

3. 系统集成：

   • Grocycode可以在任何需要输入条码的地方使用
   • 支持直接引用系统内部属性
   • 可用于精确追踪特定库存条目或电池

通过合理使用Grocycode，可以显著提升Grocy系统的使用效率，特别是在库存管理和任务追踪方面。这种编码设计既考虑了机器识别的便利性，也兼顾了人工输入的可行性，是Grocy项目中一个实用而精巧的设计。

grocy ERP beyond your fridge - Grocy is a web-based self-hosted groceries & household management solution for your home 项目地址: https://gitcode.com/gh_mirrors/gr/grocy