diff --git a/apps/emqx_auto_subscribe/etc/emqx_auto_subscribe.conf b/apps/emqx_auto_subscribe/etc/emqx_auto_subscribe.conf index becc87516..a12b30fa1 100644 --- a/apps/emqx_auto_subscribe/etc/emqx_auto_subscribe.conf +++ b/apps/emqx_auto_subscribe/etc/emqx_auto_subscribe.conf @@ -1,4 +1,21 @@ +## When the device log in successfully, +## The auto-subscribe will complete the subscription for the device +## according to the preset topics list. +## Placeholders is supported. +## +## - ${clientid} +## - ${username} +## - ${host} +## - ${port} +## +## Subscription options can be set at the same time. +## Please refer to the official MQTT definition for these configuration items. +## - qos +## - rh +## - rap +## - nl +## auto_subscribe { topics = [ ## { diff --git a/apps/emqx_auto_subscribe/src/emqx_auto_subscribe_schema.erl b/apps/emqx_auto_subscribe/src/emqx_auto_subscribe_schema.erl index 917030266..7c034a8af 100644 --- a/apps/emqx_auto_subscribe/src/emqx_auto_subscribe_schema.erl +++ b/apps/emqx_auto_subscribe/src/emqx_auto_subscribe_schema.erl @@ -34,11 +34,22 @@ fields("auto_subscribe") -> ]; fields("topic") -> - [ {topic, sc(binary(), #{example => topic_example()})} - , {qos, sc(emqx_schema:qos(), #{default => 0})} - , {rh, sc(range(0,2), #{default => 0})} - , {rap, sc(range(0, 1), #{default => 0})} - , {nl, sc(range(0, 1), #{default => 0})} + [ {topic, sc(binary(), #{ + example => topic_example(), + desc => "Topic name, placeholders is supported. For example: " + ++ binary_to_list(topic_example())})} + , {qos, sc(emqx_schema:qos(), #{ + default => 0, + desc => "Quality of service. MQTT definition."})} + , {rh, sc(range(0,2), #{ + default => 0, + desc => "Retain handling. MQTT 5.0 definition."})} + , {rap, sc(range(0, 1), #{ + default => 0, + desc => "Retain as Published. MQTT 5.0 definition."})} + , {nl, sc(range(0, 1), #{ + default => 0, + desc => "Not local. MQTT 5.0 definition."})} ]. topic_example() ->