emqx_coap_schema.hocon 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. emqx_coap_schema {
  2. coap.desc:
  3. """The CoAP Gateway configuration.
  4. This gateway is implemented based on RFC-7252 and https://core-wg.github.io/coap-pubsub/draft-ietf-core-pubsub.html"""
  5. coap_connection_required.desc:
  6. """Enable or disable connection mode.
  7. Connection mode is a feature of non-standard protocols. When connection mode is enabled, it is necessary to maintain the creation, authentication and alive of connection resources"""
  8. coap_heartbeat.desc:
  9. """The gateway server required minimum heartbeat interval.
  10. When connection mode is enabled, this parameter is used to set the minimum heartbeat interval for the connection to be alive"""
  11. coap_notify_type.desc:
  12. """The Notification Message will be delivered to the CoAP client if a new message received on an observed topic.
  13. The type of delivered coap message can be set to:<br/>
  14. - non: Non-confirmable;<br/>
  15. - con: Confirmable;<br/>
  16. - qos: Mapping from QoS type of received message, QoS0 -> non, QoS1,2 -> con"""
  17. coap_publish_qos.desc:
  18. """The Default QoS Level indicator for publish request.
  19. This option specifies the QoS level for the CoAP Client when publishing a message to EMQX PUB/SUB system, if the publish request is not carried `qos` option. The indicator can be set to:<br/>
  20. - qos0, qos1, qos2: Fixed default QoS level<br/>
  21. - coap: Dynamic QoS level by the message type of publish request<br/>
  22. * qos0: If the publish request is non-confirmable<br/>
  23. * qos1: If the publish request is confirmable"""
  24. coap_subscribe_qos.desc:
  25. """The Default QoS Level indicator for subscribe request.
  26. This option specifies the QoS level for the CoAP Client when establishing a subscription membership, if the subscribe request is not carried `qos` option. The indicator can be set to:<br/>
  27. - qos0, qos1, qos2: Fixed default QoS level<br/>
  28. - coap: Dynamic QoS level by the message type of subscribe request<br/>
  29. * qos0: If the subscribe request is non-confirmable<br/>
  30. * qos1: If the subscribe request is confirmable"""
  31. }