Californium框架处理自定义CoAP选项：Shelly设备openHAB2绑定问题

我之前在对接Shelly设备的CoIoT接口时遇到过完全一样的问题——Californium因为不识别自定义的3332选项，导致响应被Matcher忽略，观察回调根本触发不了。下面是我当时解决这个问题的完整方案：

1. 定义Shelly专属的CoAP自定义选项类 #

Californium默认只处理标准CoAP选项，我们需要为Shelly的3332选项创建一个自定义的Option子类，让框架能识别它：

import org.eclipse.californium.core.coap.Option;

public class ShellyCoIoTHeaderOption extends Option {
    public static final int SHELLY_OPTION_ID = 3332;

    public ShellyCoIoTHeaderOption() {
        super(SHELLY_OPTION_ID);
    }

    public ShellyCoIoTHeaderOption(byte[] value) {
        super(SHELLY_OPTION_ID, value);
    }

    @Override
    public String toString() {
        return "Shelly-CoIoT-Header(" + SHELLY_OPTION_ID + "): " + new String(getValue());
    }
}

2. 在应用启动时注册自定义选项 #

把这个选项注册到Californium的OptionNumberRegistry里，这样框架解析数据包时就不会把它标记为"Unknown"了：

import org.eclipse.californium.core.coap.OptionNumberRegistry;

// 建议在应用初始化阶段执行这段代码
static {
    try {
        // 参数说明：选项ID、对应的Option类、是否为关键选项、是否允许重复、最小长度、最大长度
        OptionNumberRegistry.register(
            ShellyCoIoTHeaderOption.SHELLY_OPTION_ID,
            ShellyCoIoTHeaderOption.class,
            false,
            false,
            0,
            65535
        );
    } catch (IllegalArgumentException e) {
        // 如果选项已经注册过就忽略异常
        logger.debug("Shelly CoIoT option already registered", e);
    }
}

3. 调整观察请求代码（可选但重要） #

根据Shelly的CoIoT规范，部分设备可能要求观察请求携带特定标识，你可以在请求中主动添加3332选项，同时确保观察请求的格式符合要求：

CoapClient client;
CoapObserveRelation relation;

public void start() {
    client = new CoapClient("coap://192.168.1.1:5683/cit/d");

    // 构建符合Shelly要求的观察请求
    CoapRequest observeRequest = new CoapRequest(Code.GET);
    observeRequest.setURI("coap://192.168.1.1:5683/cit/d");
    observeRequest.setObserve(); // 标记为观察请求
    // 如果设备要求请求中携带3332选项（比如设备ID），可以在这里添加
    // observeRequest.addOption(new ShellyCoIoTHeaderOption("SHSW-21#559F55#1".getBytes()));

    // 发送观察请求并处理回调
    relation = client.observe(observeRequest, new CoapHandler() {
        @Override
        public void onLoad(CoapResponse response) {
            String content = response.getResponseText();
            logger.debug("NOTIFICATION: " + content);
            // 现在可以正常读取3332选项的值了
            Option shellyOption = response.getOptions().getOption(ShellyCoIoTHeaderOption.SHELLY_OPTION_ID);
            if (shellyOption != null) {
                logger.debug("Shelly Device ID: " + new String(shellyOption.getValue()));
            }
        }

        @Override
        public void onError() {
            logger.warn("OBSERVING FAILED (press enter to exit)");
        }
    });

    // 测试GET请求（可选）
    client.get(new CoapHandler() {
        @Override
        public void onLoad(CoapResponse response) {
            String content = response.getResponseText();
            logger.debug("RESPONSE 3: " + content);
        }

        @Override
        public void onError() {
            logger.warn("FAILED");
        }
    });
}

额外排查点 #

如果注册选项后仍然出现"Ignoring unmatchable piggy-backed response"日志，建议用Wireshark抓包检查：

• 观察请求的Token是否和Shelly响应的Token一致
• Shelly是否返回了带有Observe选项的响应（标准CoAP观察要求响应携带此选项）

如果Shelly的响应确实没有携带Token，你可能需要自定义Californium的Matcher实现，允许空Token的响应匹配观察请求，但这种情况在Shelly设备中比较少见。

内容的提问来源于stack exchange，提问作者Markus